Trilium offers advanced functionality through Scripts and
+ Promoted Attributes. To illustrate these features, we've prepared
+ several showcases available in the demo notes:
It's important to note that these examples are not natively supported
+ by Trilium out of the box; instead, they demonstrate what you can build
+ within Trilium.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/1_Day Notes_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/1_Day Notes_image.png
new file mode 100644
index 000000000..328e630a2
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/1_Day Notes_image.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Day Notes.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Day Notes.html
new file mode 100644
index 000000000..256701e23
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Day Notes.html
@@ -0,0 +1,102 @@
+
+
+
+
+
+
+
+ Day Notes
+
+
+
+
+
Day Notes
+
+
+
A common pattern in note-taking is that a lot of notes will be centered
+ around a certain date - e.g. you have some tasks which needs to be done
+ on a certain date, you have meeting minutes from a certain date, you have
+ your thoughts etc. and it all revolves around a date on which they occurred.
+ For this reason, it makes sense to create a certain "day workspace" which
+ will centralize all those notes relevant for a certain date.
+
For this, Trilium provides a concept of "day note". Trilium semi-automatically
+ generates a single note for each day. Under this note you can save all
+ those relevant notes.
+
Select an existing day note, and the menubar contains a calendar widget.
+ Select any day to create a note for that day.
+
+
+
+
This pattern works well also because of Cloning Notes functionality
+ - note can appear in multiple places in the note tree, so besides appearing
+ under day note, it can also be categorized into other notes.
+
Demo
+
+
+
+
You can see the structure of day notes appearing under "Journal" note
+ - there's a note for the whole year 2017, under it, you have "12 - December"
+ which then contains "18 - Monday". This is our "day note" which contains
+ some text in its content and also has some child notes (some of them are
+ from Task manager).
+
You can also notice how this day note has promoted attribute "weight"
+ where you can track your daily weight. This data is then used in Weight tracker.
+
Templates
+
Trilium provides template functionality,
+ and it could be used together with day notes.
+
You can define one of the following relations on the root of the journal
+ (identified by #calendarRoot label):
+
+
yearTemplate
+
monthTemplate
+
dateTemplate
+
+
All of these are relations. When Trilium creates a new note for year or
+ month or date, it will take a look at the root and attach a corresponding ~template relation
+ to the newly created role. Using this, you can e.g. create your daily template
+ with e.g. checkboxes for daily routine etc.
+
Date pattern
+
It's possible to customize the title of generated date notes by defining
+ a #datePattern label on a root calendar note (identified by #calendarRoot label).
+ Following are possible values:
+
+
{dayInMonthPadded} - {weekDay} day notes are named e.g. "24
+ - Monday"
+
{dayInMonthPadded}: {weekDay3} day notes are named e.g. "24:
+ Mon"
+
{dayInMonthPadded}: {weekDay2} day notes are named e.g. "24:
+ Mo"
+
{isoDate} - {weekDay} day notes are named e.g. "2020-12-24
+ - Monday"
+
{ordinal} is replaced with the ordinal date (e.g. 1st, 2nd,
+ 3rd) etc.
+
+
Month pattern
+
It is also possible to customize the title of generated month notes through
+ the #monthPattern attribute, much like #datePattern.
+ The options are:
+
+
{monthNumberPadded} results in a number like 09 for
+ September, and 11 for November
+
{month} results in the full month name (e.g. September or October)
+
{shortMonth3} is replaced with the first 3 letters of the
+ month, e.g. Jan, Feb, etc.
+
{shortMonth4} is replaced with the first 4 letters of the
+ month, e.g. Sept, Octo, etc.
+
+
The default is {monthNumberPadded} - {month}
+
+
Implementation
+
Trilium has some special support for day notes in the form of backend Script API -
+ see e.g. getDayNote() function.
+
Day (and year, month) notes are created with a label - e.g. #dateNote="2018-08-16" this
+ can then be used by other scripts to add new notes to day note etc.
+
Journal also has relation child:child:child:template=Day template (see
+ [[attribute inheritance]]) which effectively adds [[template]] to day notes
+ (grand-grand-grand children of Journal).
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Day Notes_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Day Notes_image.png
new file mode 100644
index 000000000..7623131d6
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Day Notes_image.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Task Manager.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Task Manager.html
new file mode 100644
index 000000000..449021026
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Task Manager.html
@@ -0,0 +1,86 @@
+
+
+
+
+
+
+
+ Task Manager
+
+
+
+
Task Manager manages outstanding (TODO) tasks and finished tasks (non-empty
+ doneDate attribute). Outstanding tasks are further categorized by location
+ and arbitrary tags - whenever you change tag attribute in the task note,
+ this task is then automatically moved to appropriate location.
+
Task Manager also integrates with day notes -
+ notes are cloned into
+ day note to both todoDate note and doneDate note (with prefix of
+ either "TODO" or "DONE").
+
Implementation
+
New tasks are created in the TODO note which has ~child:template
+ relation(see attribute inheritance)
+ pointing to the task template.
+
Attributes
+
Task template defines several promoted attributes -
+ todoDate, doneDate, tags, location. Importantly it also defines ~runOnAttributeChange relation
+ - event handler which is run on
+ attribute change. This script handles
+ when e.g. we fill out the doneDate attribute - meaning the task is done
+ and should be moved to "Done" note and removed from TODO, locations and
+ tags.
+
New task button
+
There's also "button" note which contains simple script which adds a button
+ to create new note (task) in the TODO note.
api.addButtonToToolbar({
+ title: 'New task',
+ icon: 'check',
+ shortcut: 'alt+n',
+ action: async () => {
+ // creating notes is backend (server) responsibility so we need to pass
+ // the control there
+ const taskNoteId = await api.runOnBackend(async () => {
+ const todoRootNote = await api.getNoteWithLabel('taskTodoRoot');
+ const {note} = await api.createNote(todoRootNote.noteId, 'new task', '');
+
+ return note.noteId;
+ });
+
+ // we got an ID of newly created note and we want to immediatelly display it
+ await api.activateNewNote(taskNoteId);
+ }
+});
+
CSS
+
In the demo screenshot above you may notice that TODO tasks are in red
+ color and DONE tasks are green.
+
This is done by having this CSS code note which
+ defines extra CSS classes:
span.fancytree-node.todo .fancytree-title {
+ color: red !important;
+}
+
+span.fancytree-node.done .fancytree-title {
+ color: green !important;
+}
+
This code note has #appCss
+ labelwhich is recognized by Trilium on startup and loaded as CSS into
+ the application.
+
Second part of this functionality is based in event handler described
+ above which assigns #cssClass label to the task to either "done"
+ or "todo" based on the task status.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Weight Tracker.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Weight Tracker.html
new file mode 100644
index 000000000..327c2110a
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Weight Tracker.html
@@ -0,0 +1,94 @@
+
+
+
+
+
+
+
+ Weight Tracker
+
+
+
+
By adding weight as a promoted attribute in
+ the template from which day notes are
+ created, you can aggregate the data and plot weight change over time.
+
Implementation
+
The Weight Tracker note in the screenshot above is of the type Render Note.
+ That type of note doesn't have any useful content itself. Instead it is
+ a placeholder where a script can
+ render its output.
+
Scripts for Render Notes are defined in a relation called ~renderNote.
+ In this example, it's the Weight Tracker's child Implementation.
+ The Implementation consists of two code notes that
+ contain some HTML and JavaScript respectively, which load all the notes
+ with a weight attribute and display their values in a chart.
+
To actually render the chart, we're using a third party library called
+ chart.jswhich is imported as an attachment, since it's not built into
+ Trilium.
+
Code
+
Here's the content of the script which is placed in a code note of
+ type JS Frontend:
How to remove the Weight Tracker button from the top bar
+
In the link map of the Weight Tracker, there is a note called Button.
+ Open it and delete or comment out its contents. The Weight Tracker button
+ will disappear after you restart Trilium.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Weight Tracker_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Weight Tracker_image.png
new file mode 100644
index 000000000..0167e759b
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Weight Tracker_image.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes.html
new file mode 100644
index 000000000..cda9d5777
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes.html
@@ -0,0 +1,148 @@
+
+
+
+
+
+
+
+ Attributes
+
+
+
+
+
Attributes
+
+
+
In Trilium, attributes are key-value pairs assigned to notes, providing
+ additional metadata or functionality. There are two primary types of attributes:
+
+
Labels: Simple key-value text records
+
Relations: Named links to other notes
+
+
These attributes play a crucial role in organizing, categorising, and
+ enhancing the functionality of notes.
+
+
+
+
Labels
+
Labels in Trilium can be used for a variety of purposes:
+
+
Metadata: Assign labels with optional values for categorization,
+ such as #year=1999, #genre="sci-fi", or #author="Neal Stephenson"
+
+
Configuration: Labels can configure advanced features
+ or settings
+
Scripts and Plugins: Used to tag notes with special metadata,
+ such as the "weight" attribute in the Weight Tracker
+
+
+
Labels are also searchable, enhancing note retrieval.
+
Common Labels for Advanced Configuration
+
+
disableVersioning: Disables automatic versioning,
+ ideal for large, unimportant notes like script libraries
+
versioningLimit: Used to limit the number
+ of revisions for a single note
+
calendarRoot: Marks the note as the root
+ for day notes. Only
+ one note should carry this label
+
archived: Hides notes from default search
+ results and dialogs
+
excludeFromExport: Excludes notes and their
+ subtrees from export operations
+
run: Specifies events to trigger scripts
+ (e.g., frontendStartup, hourly)
+
runAtHour: Defines specific hours for scripts
+ to run, used with #run=hourly
+
+
disableInclusion: Prevents a script from
+ being included in parent script executions
+
sorted: Automatically sorts child notes
+ alphabetically by title
+
top: Keeps the note at the top of its parent's
+ list, useful with sorted
+
+
hidePromotedAttributes: Hides certain attributes
+ in the note's display
+
readOnly: Sets the note to read-only mode,
+ applicable to text and code notes
+
autoReadOnlyDisabled: Disables automatic
+ read-only mode for large notes
+
appCss: Marks CSS notes used to modify Trilium’s
+ appearance
+
appTheme: Marks full CSS themes available
+ in Trilium's options
+
cssClass: Adds a CSS class to the note's
+ representation in the tree
+
iconClass: Adds a CSS class to the note's
+ icon, useful for distinguishing notes visually. See note icons
+
+
pageSize: Specifies the number of items
+ per page in note listings
template: Makes the note available as a
+ template
+
toc: Controls the visibility of the table
+ of contents
+
color: Defines the color of the note in
+ the tree and links
+
hideChildrenOverview: Hides child notes
+ in the parent note's editor
+
viewType: Sets the view of child notes (grid
+ or list)
+
+
Relations
+
Relations define connections between notes, similar to links.
+
Uses
+
+
Metadata Relationships: For example, linking a book note
+ to an author note
+
Scripting: Attaching scripts to events or conditions
+ related to the note
+
+
Common Relations
+
+
Event-based Relations: Such as runOnNoteCreation or runOnNoteChange,
+ which trigger scripts on specific actions
+
Other Relations: Include template, renderNote, widget,
+ and sharing-related relations
+
+
Multiplicity
+
Attributes in Trilium can be "multivalued", meaning multiple attributes
+ with the same name can coexist.
+
Attribute Definitions and Promoted Attributes
+
Special labels create "label/attribute" definitions, enhancing the organization
+ and management of attributes. For more details, see Promoted attributes.
+
Attribute Inheritance
+
Trilium supports attribute inheritance, allowing child notes to inherit
+ attributes from their parents. For more information, see Attribute inheritance.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Attribute Inheritance.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Attribute Inheritance.html
new file mode 100644
index 000000000..f07d3a74f
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Attribute Inheritance.html
@@ -0,0 +1,52 @@
+
+
+
+
+
+
+
+ Attribute Inheritance
+
+
+
+
+
Attribute Inheritance
+
+
+
1. Standard Inheritance
+
In Trilium, attributes can be automatically inherited by child notes if
+ they have the isInheritable flag set to true. This
+ means the attribute (a key-value pair) is applied to the note and all its
+ descendants.
+
Example Use Case
+
The archived 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.
+
2. Copying Inheritance
+
Copying inheritance differs from standard inheritance by using a child: 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.
+
How to Use
+
+
Syntax:#child:attributeName
+
+
Chained Inheritance: You can chain this inheritance, such
+ as #child:child:attributeName, where each child down the hierarchy
+ receives the appropriate attribute.
+
+
Example
+
If a parent note has the label #child:exampleAttribute, all
+ newly created child notes will inherit the #exampleAttribute label.
+ This can be useful for setting default properties for notes in a specific
+ section.
+
3. Template Inheritance
+
Attributes can also be inherited from templates.
+ 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.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes.html
new file mode 100644
index 000000000..bcbe365ce
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes.html
@@ -0,0 +1,71 @@
+
+
+
+
+
+
+
+ Promoted Attributes
+
+
+
+
+
Promoted Attributes
+
+
+
Promoted attributes are attributes which
+ are considered important and thus are "promoted" onto the main note UI.
+ See example below:
+
+
+
+
You can see the note having kind of form with several fields. Each of
+ these is just regular attribute, the only difference is that they appear
+ on the note itself.
+
Attributes can be pretty useful since they allow for querying and script
+ automation etc. but they are also inconveniently hidden. This allows you
+ to select few of the important ones and push them to the front of the user.
+
Now, how do we make attribute to appear on the UI?
+
Attribute definition
+
Attribute is always name-value pair where both name and value are strings.
+
Attribute definition specifies how should this value be interpreted
+ - is it just string, or is it a date? Should we allow multiple values or
+ note? And importantly, should we promote the attribute or not?
+
+
+
+
You can notice tag attribute definition. These "definition" attributes
+ define how the "value" attributes should behave.
+
So there's one attribute for value and one for definition. But notice
+ how definition attribute is Inheritable,
+ 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.
+
Inverse relation
+
Some relations always occur in pairs - my favorite example is on the family.
+ If you have a note representing husband and note representing wife, then
+ there might be a relation between those two of isPartnerOf.
+ This is bidirectional relationship - meaning that if a relation is pointing
+ from husband to wife then there should be always another relation pointing
+ from wife to husband.
+
Another example is with parent - child relationship. Again these always
+ occur in pairs, but in this case it's not exact same relation - the one
+ going from parent to child might be called isParentOf and the
+ other one going from child to parent might be called isChildOf.
+
Relation definition allows you to specify such "inverse relation" - for
+ the relation you just define you specify which is the inverse relation.
+ Note that in the second example we should have two relation definitions
+ - one for isParentOf which defines isChildOf as inverse
+ relation and then second relation definition for isChildOf which
+ defines isParentOf as inverse relation.
+
What this does internally is that whenever we save a relation which has
+ defined inverse relation, we check that this inverse relation exists on
+ the relation target note. Similarly, when we delete relation, we also delete
+ inverse relation on the target note.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes_image.png
new file mode 100644
index 000000000..ecb5f2d6d
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes_image.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Template.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Template.html
new file mode 100644
index 000000000..2fbb6b93a
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Template.html
@@ -0,0 +1,74 @@
+
+
+
+
+
+
+
+ Template
+
+
+
+
+
Template
+
+
+
A template in Trilium serves as a predefined structure for other notes,
+ referred to as instance notes. Assigning a template to a note brings three
+ main effects:
+
+
Attribute Inheritance: All attributes from the template
+ note are inherited by the instance
+ notes. Even attributes with #isInheritable=false are inherited
+ by the instance notes, although only inheritable attributes are further
+ inherited by the children of the instance notes.
+
Content Duplication: The content of the template note
+ is copied to the instance note, provided the instance note is empty at
+ the time of template assignment.
+
Child Note Duplication: All child notes of the template
+ are deep-duplicated to the instance note.
+
+
Example
+
A typical example would be a "Book" template note, which might include:
+
+
Promoted Attributes: Such as publication year, author,
+ etc. (see promoted attributes).
+
Outline: An outline for a book review, including sections
+ like themes, conclusion, etc.
+
Child Notes: Additional notes for highlights, summary,
+ etc.
+
+
+
+
+
Instance Note
+
An instance note is a note related to a template note. This relationship
+ means the instance note's content is initialized from the template, and
+ all attributes from the template are inherited.
+
To create an instance note through the UI:
+
+
+
+
For the template to appear in the menu, the template note must have the #template label.
+ Do not confuse this with the ~template relation, which links
+ the instance note to the template note. If you use workspaces,
+ you can also mark templates with #workspaceTemplate to display
+ them only in the workspace.
+
Templates can also be added or changed after note creation by creating
+ a ~template relation pointing to the desired template note.
+
Additional Notes
+
From a visual perspective, templates can define #iconClass and #cssClass attributes,
+ allowing all instance notes (e.g., books) to display a specific icon and
+ CSS style.
Additionally, see default note title for
+ creating title templates. Note templates and title templates can be combined
+ by creating a #titleTemplate for a template note.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes_image.png
new file mode 100644
index 000000000..ecb5f2d6d
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes_image.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Bulk actions.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Bulk actions.html
new file mode 100644
index 000000000..1def3fbf0
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Bulk actions.html
@@ -0,0 +1,27 @@
+
+
+
+
+
+
+
+ Bulk actions
+
+
+
+
+
Bulk actions
+
+
+
Execute script
+
For more complex scenarios, it is possible to type in a JavaScript expression
+ in order to apply the necessary changes.
+
To apply a suffix (- suffix in this example), to the note
+ title:
note.title = note.title + " - suffix";
+
To alter attributes of a note in a bulk action, such as setting the #shareAlias label
+ to the title of the note:
note.setLabel("shareAlias", note.title)
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes.html
new file mode 100644
index 000000000..9980080b6
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes.html
@@ -0,0 +1,52 @@
+
+
+
+
+
+
+
+ Code Notes
+
+
+
+
+
Code Notes
+
+
+
Trilium supports creating "code" notes, i.e. notes which contain some
+ sort of formal code - be it programming language (C++, JavaScript), structured
+ data (JSON, XML) or other types of codes (CSS etc.).
+
This can be useful for a few things:
+
+
computer programmers can store code snippets as notes with syntax highlighting
+
JavaScript code notes can be executed inside Trilium for some extra functionality
+
+
we call such JavaScript code notes "scripts" - see Scripts
+
+
+
+
JSON, XML etc. can be used as storage for structured data (typically used
+ in conjunction with scripting)
+
+
+
+
+
Extra languages
+
Trilium supports syntax highlighting for many languages, but by default
+ displays only some of them (to reduce the number of items). You can add
+ extra languages in Options -> Code notes.
+
Code blocks
+
An alternative to the code note is a "code block" - feature of a text
+ note which can add short snippets of code to the text editor. Starting
+ with TriliumNext v0.90.12, the code blocks also support syntax highlighting.
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes/Custom Widgets.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes/Custom Widgets.html
new file mode 100644
index 000000000..b6c3443bf
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes/Custom Widgets.html
@@ -0,0 +1,113 @@
+
+
+
+
+
+
+
+ Custom Widgets
+
+
+
+
+
Custom Widgets
+
+
+
It's possible to create custom widget in three possible locations where
+ you can display your custom content.
+
Positions are:
+
+
left-pane
+
+
center-pane
+
+
note-detail-pane - located within center-pane,
+ but specific to note (split)
+
right-pane
+
+
+
Example - word count widget
+
Create a code note of type JS frontend and give it a**#widget**label.
/*
+ * This defines a custom widget which displays number of words and characters in a current text note.
+ * To be activated for a given note, add label 'wordCount' to the note, you can also make it inheritable and thus activate it for the whole subtree.
+ *
+ * See it in action in "Books" and its subtree.
+ */
+const TPL = `
+ Word count:
+
+
+
+
+ Character count:
+
+`;
+
+class WordCountWidget extends api.NoteContextAwareWidget {
+ static get parentWidget() { return 'center-pane'; }
+
+ get position() { return 100; } // higher value means position towards the bottom/right
+
+ isEnabled() {
+ return super.isEnabled()
+ && this.note.type === 'text'
+ && this.note.hasLabel('wordCount');
+ }
+
+ doRender() {
+ this.$widget = $(TPL);
+ this.$wordCount = this.$widget.find('.word-count');
+ this.$characterCount = this.$widget.find('.character-count');
+ return this.$widget;
+ }
+
+ async refreshWithNote(note) {
+ const {content} = await note.getNoteComplement();
+
+ const text = $(content).text(); // get plain text only
+
+ const counts = this.getCounts(text);
+
+ this.$wordCount.text(counts.words);
+ this.$characterCount.text(counts.characters);
+ }
+
+ getCounts(text) {
+ const chunks = text
+ .split(/[\s-+:,/\\]+/)
+ .filter(chunk => chunk !== '');
+
+ let words;
+
+ if (chunks.length === 1 && chunks[0] === '') {
+ words = 0;
+ }
+ else {
+ words = chunks.length;
+ }
+
+ const characters = chunks.join('').length;
+
+ return {words, characters};
+ }
+
+ async entitiesReloadedEvent({loadResults}) {
+ if (loadResults.isNoteContentReloaded(this.noteId)) {
+ this.refresh();
+ }
+ }
+}
+
+module.exports = WordCountWidget;
+
After you make changes it is necessary to restart Trilium so that the
+ layout can be rebuilt.
+
Example screenshot
+
On the bottom you can see the resulting widget:
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes/Events.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes/Events.html
new file mode 100644
index 000000000..cb05cab4c
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes/Events.html
@@ -0,0 +1,66 @@
+
+
+
+
+
+
+
+ Events
+
+
+
+
+
Events
+
+
+
Script notes can be triggered by events. Note
+ that these are backend events and thus relation need to point to the "JS
+ backend" code note.
+
Global events
+
Global events are attached to the script note via label. Simply create
+ e.g. "run" label with some of these values and script note will be executed
+ once the event occurs.
+
+
run
+
+
frontendStartup - executes on frontend upon startup
+
mobileStartup - executes on mobile frontend upon startup
+
backendStartup - executes on backend upon startup
+
hourly - executes once an hour on backend
+
daily - executes once a day on backend
+
+
+
+
Entity events
+
Other events are bound to some entity, these are defined as relations -
+ meaning that script is triggered only if note has this script attached
+ to it through relations (or it can inherit it).
+
+
runOnNoteCreation - executes when note is created on backend
+
runOnNoteTitleChange - executes when note title is changed
+ (includes note creation as well)
+
runOnNoteContentChange - executes when note content is changed
+ (includes note creation as well).
+
runOnNoteChange - executes when note is changed (includes
+ note creation as well)
+
runOnNoteDeletion - executes when note is being deleted
+
runOnBranchCreation - executes when a branch is created. Branch
+ is a link between parent note and child note and is created e.g. when cloning
+ or moving note.
+
runOnBranchChange (since v0.62) - executes when a branch is
+ changed - either expanded status or prefix are changed.
+
runOnBranchDeletion - executes when a branch is delete. Branch
+ is a link between parent note and child note and is deleted e.g. when moving
+ note (old branch/link is deleted).
+
runOnChildNoteCreation - executes when new note is created
+ under this note
+
runOnAttributeCreation - executes when new attribute is created
+ under this note
+
runOnAttributeChange - executes when attribute is changed
+ under this note
+
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes/Script API.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes/Script API.html
new file mode 100644
index 000000000..377897aca
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes/Script API.html
@@ -0,0 +1,30 @@
+
+
+
+
+
+
+
+ Script API
+
+
+
+
+
Script API
+
+
+
Trilium offers a "Script API" that enables scripts to perform various
+ useful functions. There are two main APIs available:
Please note that the Script API is currently experimental and may undergo
+ changes in future updates.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes/Scripts.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes/Scripts.html
new file mode 100644
index 000000000..9b33c9310
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes/Scripts.html
@@ -0,0 +1,86 @@
+
+
+
+
+
+
+
+ Scripts
+
+
+
+
+
Scripts
+
+
+
Trilium supports creating code notes,
+ i.e. notes which allow you to store some programming code and highlight
+ it. Special case is JavaScript code notes which can also be executed inside
+ Trilium which can in conjunction with Script API provide
+ extra functionality.
+
Scripting
+
To go further I must explain basic architecture of Trilium - in its essence
+ it is a classic web application - it has these two main components:
+
+
frontend running in the browser (using HTML, CSS, JavaScript) - this is
+ mainly used to interact with the user, display notes etc.
+
backend running JavaScript code in node.js runtime - this is responsible
+ for e.g. storing notes, encrypting them etc.
+
+
So we have frontend and backend, each with their own set of responsibilities,
+ but their common feature is that they both run JavaScript code. Add to
+ this the fact, that we're able to create JavaScript [[code notes]] and
+ we're onto something.
+
Button use case
+
Let's take a look at our demo script (shipped with default Trilium database)
+ - Task manager. One of the things this script does is adding a button to
+ the Trilium interface which will allow user to easily add new Task (TODO
+ item).
+
+
+
+
First take a look at the red circle all the way on the top - this what
+ we want to achieve - new button in UI which will create new note representing
+ a task/todo item.
+
Red point below the first one marks the note type we have created for
+ this script - it's "JavaScript frontend". It's frontend because adding
+ button to UI is clearly frontend responsibility.
+
In the note content you can see the code which calls one of the API methods,
+ this one is specifically meant to add new buttons. Code needs to set few
+ button properties:
+
+
button title
+
icon which should appear on the button
+
optional shortcut under which you can trigger the button
+
most importantly "action" - what must happen when button is clicked
+
+
Action handler
+
Saving the note to the database is backend's responsibility, so we immediately
+ pass control to the backend and ask it to create a note. Once this is done,
+ we show the newly created note so that the user can set the task title
+ and maybe some attributes.
+
Script execution
+
So we have a script which will add the button to the toolbar. But how
+ can we execute it? One possibility is to click on "play" icon (marked by
+ red circle). The problem with this is that this UI change is time bound
+ by Trilium runtime so when we restart Trilium, button won't be there.
+
We need to execute it every time Trilium starts up, but we probably don't
+ want to have to manually click on play button on every start up.
+
The solution is marked by red circle at the bottom - this note has label#run=frontendStartup -
+ this is one of the "system" labels which Trilium understands. As you might
+ guess, this will cause all such labeled script notes to be executed once
+ Trilium frontend starts up.
+
(#run=frontendStartup does not work for Mobile frontend -
+ if you want to have scripts running there, give the script #run=mobileStartup label)
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes_image.png
new file mode 100644
index 000000000..21216c101
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes_image.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Configuration (config.ini or e.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Configuration (config.ini or e.html
new file mode 100644
index 000000000..9e904b284
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Configuration (config.ini or e.html
@@ -0,0 +1,47 @@
+
+
+
+
+
+
+
+ Configuration (config.ini or environment variables)
+
+
+
+
+
Configuration (config.ini or environment variables)
+
+
+
Trilium supports configuration via a file named config.ini and
+ environment variables. Please review the file named config-sample.ini in
+ the Notes repository to
+ see what values are supported.
+
You can provide the same values via environment variables instead of the config.ini file,
+ and these environment variables use the following format:
+
+
Environment variables should be prefixed with TRILIUM_ and
+ use underscores to represent the INI section structure.
+
The format is: TRILIUM_<SECTION>_<KEY>=<VALUE>
+
+
The environment variables will override any matching values from config.ini
+
+
For example, if you have this in your config.ini:
[Network]
+host=localhost
+port=8080
+
You can override these values using environment variables:
Then scan all environment variables for ones starting with TRILIUM_
+
+
Parse these variables into section/key pairs
+
Merge them with the config from the file, with environment variables taking
+ precedence
+
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Custom Request Handler.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Custom Request Handler.html
new file mode 100644
index 000000000..e0347fe2e
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Custom Request Handler.html
@@ -0,0 +1,95 @@
+
+
+
+
+
+
+
+ Custom Request Handler
+
+
+
+
+
Custom Request Handler
+
+
+
Trilium provides a mechanism for scripts 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. /trilium buy milk).
+
Create note from outside Trilium
+
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.
+
We'll start with creating a JavaScript backend code note containing:
const {req, res} = api;
+const {secret, title, content} = req.body;
+
+if (req.method == 'POST' && secret === 'secret-password') {
+ // notes must be saved somewhere in the tree hierarchy specified by a parent note.
+ // This is defined by a relation from this code note to the "target" parent note
+ // alternetively you can just use constant noteId for simplicity (get that from "Note Info" dialog of the desired parent note)
+ const targetParentNoteId = api.currentNote.getRelationValue('targetNote');
+
+ const {note} = api.createTextNote(targetParentNoteId, title, content);
+ const notePojo = note.getPojo();
+
+ res.status(201).json(notePojo);
+}
+else {
+ res.send(400);
+}
+
This script note has also following two attributes:
+
+
label #customRequestHandler with value create-note
+
+
relation ~targetNote pointing to a note where new notes should
+ be saved
+
+
Explanation
+
Let's test this by using an HTTP client to send a request:
Notice the /custom 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 customRequestHandlerlabel.
+ Value of this label then contains a regular expression which will match
+ the request path (in our case trivial regex "create-note").
+
Trilium will then find our code note created above and execute it. api.req, api.res are
+ set to request and
+ responseobjects from which we can get details of the request and also
+ respond.
+
In the code note we check the request method and then use trivial authentication
+ - keep in mind that these endpoints are by default totally unauthenticated,
+ and you need to take care of this yourself.
+
Once we pass these checks we will just create the desired note using
+ Script API.
+
Custom resource provider
+
Another common use case is that you want to just expose a file note -
+ in such case you create label customResourceProvider (value
+ is again path regex).
api.req and api.res are Express.js objects - you
+ can always look into its documentation for
+ details.
+
Parameters
+
REST request paths often contain parameters in the URL, e.g.:
http://my.trilium.org/custom/notes/123
+
The last part is dynamic so the matching of the URL must also be dynamic
+ - for this reason the matching is done with regular expressions. Following customRequestHandler value
+ would match it:
notes/([0-9]+)
+
Additionally, this also defines a matching group with the use of parenthesis
+ which then makes it easier to extract the value. The matched groups are
+ available in api.pathParams:
const noteId = api.pathParams[0];
+
Often you also need query params (as in e.g. http://my.trilium.org/custom/notes?noteId=123),
+ you can get those with standard express req.query.noteId.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Custom Resource Providers.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Custom Resource Providers.html
new file mode 100644
index 000000000..9caf7e390
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Custom Resource Providers.html
@@ -0,0 +1,63 @@
+
+
+
+
+
+
+
+ Custom Resource Providers
+
+
+
+
+
Custom Resource Providers
+
+
+
+
+
A custom resource provider allows any file imported into Trilium (images,
+ fonts, stylesheets) to be publicly accessible via a URL.
+
A potential use case for this is to add embed a custom font alongside
+ a theme.
+
Steps for creating a custom resource provider
+
+
+
Import a file such as an image or a font into Trilium by drag & drop.
+
Select the file and go to the Owned Attributes section.
+
Add the label #customResourceProvider=hello.
+
To test if it is working, use a browser to navigate to <protocol>://<host>/custom/hello (where <protocol> is
+ either http or https based on your setup, and <host> is
+ the host or IP to your Trilium server instance). If you are running the
+ TriliumNext application without a server, use http://localhost:37840 as
+ the base URL.
+
If everything went well, at the previous step the browser should have
+ downloaded the file uploaded in the first step.
+
+
Instead of hello, the name can be:
+
+
A path, such as fonts/Roboto.ttf, which would be accessible
+ via <host>/custom/fonts/Roboto.ttf.
+
As a more advanced use case, a regular expression to match multiple routes,
+ such as hello/.* which will be accessible via /custom/hello/1, /custom/hello/2, /custom/hello/world,
+ etc.
+
+
Using it in a theme
+
+
For example, if you have a custom font to be imported by the theme, first
+ upload a font file into Trilium and assign it the #customResourceProvider=fonts/myfont.ttf attribute.
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database.html
new file mode 100644
index 000000000..a9e261cd7
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database.html
@@ -0,0 +1,74 @@
+
+
+
+
+
+
+
+ Database
+
+
+
+
+
Database
+
+
+
Your Trilium data is stored in a SQLite database
+ which contains all notes, tree structure, metadata, and most of the configuration.
+ The database file is named document.db and is stored in the
+ application's default Data directory.
+
Demo Notes
+
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:
There are some cases in which you may want to restore the original demo
+ notes. For example, if you experimented with some of the more advanced
+ features and want to see the original reference, or if you simply want
+ to explore the latest version of the demo notes, which might showcase new
+ features.
+
You can easily restore the demo notes by using Trilium's built-in import
+ feature by importing them:
+
+
Download this .zip archive with
+ the latest version of the demo notes
+
Right click on any note in your tree under which you would like the demo
+ notes to be imported
+
Click "Import into note"
+
Select the .zip archive to import it
+
+
Manually Modifying the Database
+
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 SQLite Browser to
+ work directly on the database file.
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.
+
To delete the database, simply go to the data directory and
+ delete the document.db file (and any other files starting with document.db).
+
If you do not need to preserve any configurations that might be stored
+ in the config.ini file, you can just delete all of the data directory's contents
+ to fully restore the application to its original state. You can also review
+ the configuration file
+ to provide all config.ini values as environment variables instead.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/1_Manually altering the data.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/1_Manually altering the data.png
new file mode 100644
index 000000000..32a91fc2f
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/1_Manually altering the data.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/2_Manually altering the data.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/2_Manually altering the data.png
new file mode 100644
index 000000000..973cc4d6c
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/2_Manually altering the data.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/3_Manually altering the data.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/3_Manually altering the data.png
new file mode 100644
index 000000000..0ef3cef45
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/3_Manually altering the data.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/4_Manually altering the data.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/4_Manually altering the data.png
new file mode 100644
index 000000000..6f32f76ec
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/4_Manually altering the data.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/5_Manually altering the data.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/5_Manually altering the data.png
new file mode 100644
index 000000000..a6bbeaaf9
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/5_Manually altering the data.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/6_Manually altering the data.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/6_Manually altering the data.png
new file mode 100644
index 000000000..c6681695a
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/6_Manually altering the data.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the data.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the data.png
new file mode 100644
index 000000000..469899ebc
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the data.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database.html
new file mode 100644
index 000000000..cf8694a85
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database.html
@@ -0,0 +1,57 @@
+
+
+
+
+
+
+
+ Manually altering the database
+
+
+
+
+
Manually altering the database
+
+
+
There are some situations where modifying the SQLite database that Trilium
+ uses is desirable.
+
If you are doing any advanced development or troubleshooting where you
+ manually modify the database, you might want to consider creating backups
+ of your document.db file.
+
Modifying it internally using the SQL Console
+
The SQL Console is Trilium's built-in database editor.
Sometimes the SQL Console cannot be used (for example if the application
+ cannot start).
+
When making external modifications, consider closing the desktop application.
+ If modifying the server database, then stop the service or Docker container.
+
Using DB Browser for SQLite
+
DB Browser for SQLite is a cross-platform editor that can be used to alter
+ the database using a graphical user interface.
+
To do so:
+
+
In the main menu, select File → Open database… and navigate to the database
+ in the Data directory.
+
Select the Execute SQL tab.
+
Type in the desired SQL statement.
+
Press the "Play" button in the toolbar underneath the "Execute SQL" tab
+ (or F5 key).
+
Press "Write Changes" in the main toolbar.
+
Close the application or close the database.
+
+
+
+
+
Using the SQLite CLI
+
First, start the SQLite 3 CLI by specifying the path to the database:
sqlite3 ~/.local/share/trilium-data/document.db
+
+
In the prompt simply type the statement and make sure it ends with a ; character.
+
To exit, simply type .quit and enter.
+
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/1_SQL Console_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/1_SQL Console_image.png
new file mode 100644
index 000000000..6f32f76ec
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/1_SQL Console_image.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/2_SQL Console_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/2_SQL Console_image.png
new file mode 100644
index 000000000..0ef3cef45
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/2_SQL Console_image.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/3_SQL Console_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/3_SQL Console_image.png
new file mode 100644
index 000000000..c6681695a
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/3_SQL Console_image.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/SQL Console.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/SQL Console.html
new file mode 100644
index 000000000..c0d622b29
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/SQL Console.html
@@ -0,0 +1,54 @@
+
+
+
+
+
+
+
+ SQL Console
+
+
+
+
+
SQL Console
+
+
+
The SQL Console is Trilium's built-in database editor.
+
It can be accessed by going to the global menu →
+ Advanced → Open SQL Console.
+
+
+
+
Interaction
+
+
Hovering the mouse over one of the tables listed at the top of the document
+ will show the columns and their data type.
+
Only one SQL statement can be run at once.
+
To run the statement, press the
+ icon.
+
+
For queries that return a result, the data will displayed in a table.
+
+
+
+
+
+
Saved SQL console
+
SQL queries or commands can be saved into a dedicated note.
+
To do so, simply write the query and press the
+ button. Once saved, the note will appear in Day Notes.
+
+
The SQL expression will not be displayed by default, but it can still
+ be viewed by going to the note context menu and selecting Note source.
+
The expression cannot be modified. If needed, recreate it by copying the
+ statement back into the SQL console and then saving it again.
+
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/SQL Console_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/SQL Console_image.png
new file mode 100644
index 000000000..32a91fc2f
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/SQL Console_image.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Default Note Title.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Default Note Title.html
new file mode 100644
index 000000000..2ea1ab689
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Default Note Title.html
@@ -0,0 +1,66 @@
+
+
+
+
+
+
+
+ Default Note Title
+
+
+
+
+
Default Note Title
+
+
+
When a new note is created, its name is by default "new note". In some
+ cases, it can be desirable to have a different or even a dynamic default
+ note title.
+
For this use case, Trilium (since v0.52) supports #titleTemplate
+ label. 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
+ everywhere.
+
As an example use case, imagine you collect books you've read in a given
+ year like this:
+
+
2022 Books
+
+
Neal Stephenson: Anathem, 2008
+
Franz Kafka: Die Verwandlung, 1915
+
+
+
+
Now, to the parent note "2022 Books" you can assign label #titleTemplate="[Author name]: [Book title], [Publication year]".
+
And all children of "2022 Books" will be created with initial title "[Author
+ name]: [Book title], [Publication year]". There's no artificial intelligence
+ here, the idea is to just prompt you to manually fill in the pieces of
+ information into the note title by yourself.
+
Dynamic value
+
The value of #titleTemplate 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.
+
As an example, imagine you collect server outage incidents and write some
+ notes. It looks like this:
+
+
Incidents
+
+
2022-05-09: System crash
+
2022-05-15: Backup delay
+
+
+
+
You can automatize the date assignment by assigning a label #titleTemplate="${now.format('YYYY-MM-DD')}: " to
+ the parent note "Incidents". Whenever a new child note is created, the
+ title template is evaluated with the injected now object.
+
Second variable injected is parentNote,
+ an example could be #titleTemplate="${parentNote.getLabelValue('authorName')}'s literary works".
+
See also [[template]] which provides
+ similar capabilities, including default note's content.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/ETAPI (REST API).html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/ETAPI (REST API).html
new file mode 100644
index 000000000..d6272c05a
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/ETAPI (REST API).html
@@ -0,0 +1,40 @@
+
+
+
+
+
+
+
+ ETAPI (REST API)
+
+
+
+
+
ETAPI (REST API)
+
+
+
ETAPI is Trilium's public/external REST API. It is available since Trilium
+ v0.50.
+
The documentation is in OpenAPI format, available here.
+
trilium-py is a third-party
+ Python implementation for ETAPI client, you can use Python to communicate
+ with Trilium.
+
Authentication
+
All operations have to be authenticated using a token. You can get this
+ token either from Options -> ETAPI or programmatically using the /auth/login REST
+ call (see the spec):
GET https://myserver.com/etapi/app-info
+Authorization: ETAPITOKEN
+
Alternatively, since 0.56 you can also use basic auth format:
GET https://myserver.com/etapi/app-info
+Authorization: Basic BATOKEN
+
+
Where BATOKEN = BASE64(username + ':' + password) - this is
+ a standard Basic Auth serialization
+
Where username is "etapi"
+
And password is the generated ETAPI token described above.
+
+
Basic Auth is meant to be used with tools which support only basic auth.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Note Map.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Note Map.html
new file mode 100644
index 000000000..d6baa6ce8
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Note Map.html
@@ -0,0 +1,44 @@
+
+
+
+
+
+
+
+ Note Map
+
+
+
+
+
Note Map
+
+
+
Note map is a visualisation of connections between notes.
+
This provides an insight into a structure ("web") of notes.
Relation map is a similar concept, with
+ some differences:
+
+
note map is automatically generated while relation map must be created
+ manually
+
relation map is a type of note while a link map is just virtual visualization
+
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Note Map_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Note Map_image.png
new file mode 100644
index 000000000..2d41fd6c6
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Note Map_image.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Relation Map.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Relation Map.html
new file mode 100644
index 000000000..bb368d47f
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Relation Map.html
@@ -0,0 +1,95 @@
+
+
+
+
+
+
+
+ Relation Map
+
+
+
+
+
Relation Map
+
+
+
Relation map is a type of note which
+ visualizes notes and their relations. See
+ an example:
+
Development process demo
+
This is a basic example how you can create simple diagram using relation
+ maps:
+
+
+
+
And this is how you can create it:
+
+
+
+
We start completely from scratch by first creating new note called "Development
+ process" and changing its type to "Relation map". After that we create
+ new notes one by one and place them by clicking into the map. We also drag
+ relationsbetween notes and name them. That's all!
+
Items on the map - "Specification", "Development", "Testing" and "Demo"
+ are actually notes which have been created under "Development process"
+ note - you can click on them and write some content. Connections between
+ notes are called "relations".
+
Family demo
+
This is more complicated demo using some advanced concepts. Resulting
+ diagram is here:
+
+
+
+
This is how you get to it:
+
+
+
+
There are several steps here:
+
+
we start with empty relation map and two existing notes representing Prince
+ Philip and Queen Elizabeth II. These two notes already have "isPartnerOf"
+ relationsdefined.
+
+
There are actually two "inverse" relations (one from Philip to Elizabeth
+ and one from Elizabeth to Philip)
+
+
+
we drag both notes to relation map and place to suitable position. Notice
+ how the existing "isPartnerOf" relations are displayed.
+
now we create new note - we name it "Prince Charles" and place it on the
+ relation map by clicking on the desired position. The note is by default
+ created under the relation map note (visible in the note tree on the left).
+
we create two new relations "isChildOf" targeting both Philip and Elizabeth
+
+
now there's something unexpected - we can also see the relation to display
+ another "hasChild" relation. This is because there's a relation definition which
+ puts "isChildOf" as an "inverse"
+ relation of "hasChildOf" (and vice versa) and thus it is created automatically.
+
+
+
we create another note for Princess Diana and create "isPartnerOf" relation
+ from Charles. Again notice how the relation has arrows both ways - this
+ is because "isPartnerOf" definition specifies its inverse relation as again
+ "isPartnerOf" so the opposite relation is created automatically.
+
as the last step we pan & zoom the map to fit better to window dimensions.
+
+
Relation definitions mentioned above come from "Person template" note
+ which is assigned to any child of "My Family Tree" relation note. You can
+ play with the whole thing in the demo notes.
+
Details
+
You can specify which relations should be displayed with comma delimited
+ names of relations in displayRelations label.
+
Alternatively, you can specify comma delimited list of relation names
+ in hideRelations which will display all relations, except for
+ the ones defined in the label.
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing.html
new file mode 100644
index 000000000..05d85b480
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing.html
@@ -0,0 +1,142 @@
+
+
+
+
+
+
+
+ Sharing
+
+
+
+
+
Sharing
+
+
+
Trilium allows you to share selected notes as publicly accessible read-only
+ documents. This feature is particularly useful for publishing content directly
+ from your Trilium notes, making it accessible to others online.
+
Prerequisites
+
To use the sharing feature, you must have a server installation of
+ Trilium. This is necessary because the notes will be hosted from the server.
+
How to Share a Note
+
+
+
Enable Sharing: To share a note, toggle the Shared switch
+ within the note's interface. Once sharing is enabled, an URL will appear,
+ which you can click to access the shared note.
+
+
+
+
+
+
Access the Shared Note: The link provided will open the
+ note in your browser. If your server is not configured with a public IP,
+ the URL will refer to localhost (127.0.0.1).
+
+
+
+
+
+
Sharing a Note Subtree
+
When you share a note, you actually share the entire subtree of notes
+ beneath it. If the note has child notes, they will also be included in
+ the shared content. For example, sharing the "Formatting" subtree will
+ display a page with basic navigation for exploring all the notes within
+ that subtree.
+
+
+
+
Viewing All Shared Notes
+
You can view a list of all shared notes by clicking on "Show Shared Notes
+ Subtree." This allows you to manage and navigate through all the notes
+ you have made public.
+
Security Considerations
+
Shared notes are published on the open internet and can be accessed by
+ anyone with the URL. The URL's randomness does not provide security, so
+ it is crucial not to share sensitive information through this feature.
+
Password Protection
+
To protect shared notes with a username and password, you can use the #shareCredentials attribute.
+ Add this label to the note with the format #shareCredentials="username:password".
+ To protect an entire subtree, make sure the label is inheritable.
+
Advanced Sharing Options
+
Customizing the Appearance of Shared Notes
+
The default shared page is basic in design, but you can customize it using
+ your own CSS:
+
+
Custom CSS: Link a CSS code note to
+ the shared page by adding a ~shareCss 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 #shareHiddenFromTree label.
+
Omitting Default CSS: For extensive styling changes,
+ use the #shareOmitDefaultCss label to avoid conflicts with Trilium's
+ default stylesheet.
+
+
Adding JavaScript
+
You can inject custom JavaScript into the shared note using the ~shareJs relation.
+ This allows you to access note attributes or traverse the note tree using
+ the fetchNote() API, which retrieves note data based on its
+ ID.
Shared notes typically have URLs like http://domain.tld/share/knvU8aJy4dJ7,
+ where the last part is the note's ID. You can make these URLs more user-friendly
+ by adding the #shareAlias label to individual notes (e.g., #shareAlias=highlighting).
+ This will change the URL to http://domain.tld/share/highlighting.
+
Important:
+
+
Ensure that aliases are unique.
+
Using slashes (/) within aliases to create subpaths is not
+ supported.
+
+
Viewing and Managing Shared Notes
+
All shared notes are grouped under an automatically managed "Shared Notes"
+ section. From here, you can view, share, or unshare notes by moving or
+ cloning them within this section.
+
+
+
+
Setting a Custom Favicon
+
To customize the favicon for your shared pages, create a relation ~shareFavicon pointing
+ to a file note containing the favicon (e.g., in .ico format).
+
Sharing a Note as the Root
+
You can designate a specific note or folder as the root of your shared
+ content by adding the #shareRoot label. This note will be linked
+ when visiting [http://domain.tld/share](http://domain/share),
+ making it easier to use Trilium as a fully-fledged website. Consider combining
+ this with the #shareIndex label, which will display a list of
+ all shared notes.
+
Additional Options
+
+
Raw Note Sharing: Use the #shareRaw label
+ to share a note without any HTML wrapper.
+
Disallow Robot Indexing: Add the #shareDisallowRobotIndexing label
+ to prevent search engines from indexing the shared page by including a noindex, follow meta
+ tag and X-Robots-Tag: noindex header.
+
Shared Notes Index: For text notes with the #shareIndex label,
+ the content will display a list of all shared note roots.
+
+
Limitations
+
While the sharing feature is powerful, it has some limitations:
+
+
No Relation Map Support
+
+
Book Notes: Only show a list of child notes.
+
Code Notes: No syntax highlighting.
+
Static Note Tree
+
+
Protected Notes: Cannot be shared.
+
Include Notes: Not supported.
+
+
Some of these limitations may be addressed in future updates.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Shared notes/1_Serving directly the conte.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/1_Serving directly the conte.png
similarity index 100%
rename from src/public/app/doc_notes/en/User Guide/User Guide/Shared notes/1_Serving directly the conte.png
rename to src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/1_Serving directly the conte.png
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Shared notes/Serving directly the conte.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/Serving directly the conte.png
similarity index 100%
rename from src/public/app/doc_notes/en/User Guide/User Guide/Shared notes/Serving directly the conte.png
rename to src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/Serving directly the conte.png
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/Serving directly the content o.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/Serving directly the content o.html
new file mode 100644
index 000000000..d4198df0e
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/Serving directly the content o.html
@@ -0,0 +1,66 @@
+
+
+
+
+
+
+
+ Serving directly the content of a note
+
+
+
+
+
Serving directly the content of a note
+
+
+
+
+
When accessing a shared note, Trilium will render it as a web page. Sometimes
+ it's desirable to serve the content directly so that it can be used in
+ a script or downloaded by the user.
+
+
+
+
+
+
+
+
+
+
+
+ A note displayed as a web page (HTML)
+
+
+
+
+
+ A note displayed as a raw format
+
+
+
+
+
+
+
By adding an attribute to the note
+
+
Simply add the #shareRaw attribute and the note will always
+ be rendered raw when accessed from the share URL.
+
By altering the URL
+
+
Append ?raw to the URL to display a note in its raw format
+ regardless of whether the #shareRaw attribute is added on the
+ note.
A custom resource provider allows any file imported into Trilium (images,
- fonts, stylesheets) to be publicly accessible via a URL.
-
A potential use case for this is to add embed a custom font alongside
- a theme.
-
Steps for creating a custom resource provider
-
-
Import a file such as an image or a font into Trilium by drag & drop.
-
Select the file and go to the Owned Attributes section.
-
Add the label #customResourceProvider=hello.
-
To test if it is working, use a browser to navigate to <protocol>://<host>/custom/hello (where <protocol> is
- either http or https based on your setup, and <host> is
- the host or IP to your Trilium server instance). If you are running the
- TriliumNext application without a server, use http://localhost:37840 as
- the base URL.
-
If everything went well, at the previous step the browser should have
- downloaded the file uploaded in the first step.
-
-
Instead of hello, the name can be:
-
-
A path, such as fonts/Roboto.ttf, which would be accessible
- via <host>/custom/fonts/Roboto.ttf.
-
As a more advanced use case, a regular expression to match multiple routes,
- such as hello/.* which will be accessible via /custom/hello/1, /custom/hello/2, /custom/hello/world,
- etc.
-
-
Using it in a theme
-
For example, if you have a custom font to be imported by the theme, first
- upload a font file into Trilium and assign it the #customResourceProvider=fonts/myfont.ttf attribute.
-
-
-
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/Custom-widget image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/Custom-widget image.png
new file mode 100644
index 000000000..768dbdb6b
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/Custom-widget image.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/bookmark-folder.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/bookmark-folder.png
new file mode 100644
index 000000000..4cac45698
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/bookmark-folder.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/bookmarks.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/bookmarks.gif
new file mode 100644
index 000000000..2fdba3f03
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/bookmarks.gif differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/bookmarks.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/bookmarks.png
new file mode 100644
index 000000000..2d78ee1a1
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/bookmarks.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/button-script.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/button-script.png
new file mode 100644
index 000000000..466ff32ec
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/button-script.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/canvas-note-image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/canvas-note-image.png
new file mode 100644
index 000000000..4ad24adf4
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/canvas-note-image.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/chrome-trilium-web-clipper.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/chrome-trilium-web-clipper.png
new file mode 100644
index 000000000..f1ac0e4e0
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/chrome-trilium-web-clipper.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/code-note.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/code-note.png
new file mode 100644
index 000000000..3e85223d3
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/code-note.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/create-clone.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/create-clone.gif
new file mode 100644
index 000000000..88052f0ad
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/create-clone.gif differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/create-external-link.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/create-external-link.gif
new file mode 100644
index 000000000..2990fdf61
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/create-external-link.gif differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/create-link-to-note.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/create-link-to-note.gif
new file mode 100644
index 000000000..e2e2ab913
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/create-link-to-note.gif differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/custom-widget-image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/custom-widget-image.png
new file mode 100644
index 000000000..768dbdb6b
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/custom-widget-image.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/cut-to-subnote.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/cut-to-subnote.gif
new file mode 100644
index 000000000..69c7ce4dc
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/cut-to-subnote.gif differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/dark-theme.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/dark-theme.png
new file mode 100644
index 000000000..554fc628a
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/dark-theme.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/drag-and-drop.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/drag-and-drop.gif
new file mode 100644
index 000000000..ba86530c0
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/drag-and-drop.gif differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/error-logs-export-subtree.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/error-logs-export-subtree.png
new file mode 100644
index 000000000..3b9e7bf69
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/error-logs-export-subtree.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/error-logs-firefox-context.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/error-logs-firefox-context.png
new file mode 100644
index 000000000..f1dc1861a
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/error-logs-firefox-context.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/hide-archived.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/hide-archived.png
new file mode 100644
index 000000000..547891a6b
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/hide-archived.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/home-button.svg b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/home-button.svg
new file mode 100644
index 000000000..2136cb48d
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/home-button.svg
@@ -0,0 +1,18 @@
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/jump-to.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/jump-to.gif
new file mode 100644
index 000000000..9521c9a8e
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/jump-to.gif differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/markdown-export-note.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/markdown-export-note.gif
new file mode 100644
index 000000000..4162351fd
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/markdown-export-note.gif differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/markdown-export-subtree.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/markdown-export-subtree.gif
new file mode 100644
index 000000000..a4cf33796
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/markdown-export-subtree.gif differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/markdown-file-import.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/markdown-file-import.gif
new file mode 100644
index 000000000..1a3eba861
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/markdown-file-import.gif differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/markdown-inline-import.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/markdown-inline-import.gif
new file mode 100644
index 000000000..b7265c6e9
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/markdown-inline-import.gif differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/math.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/math.gif
new file mode 100644
index 000000000..810784d93
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/math.gif differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/mermaid.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/mermaid.png
new file mode 100644
index 000000000..1c48d2aa6
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/mermaid.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/mobile-smartphone.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/mobile-smartphone.png
new file mode 100644
index 000000000..43a04b896
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/mobile-smartphone.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/mobile-tablet.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/mobile-tablet.png
new file mode 100644
index 000000000..aa18da05a
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/mobile-tablet.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/move-note-with-keyboard.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/move-note-with-keyboard.gif
new file mode 100644
index 000000000..4f4227953
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/move-note-with-keyboard.gif differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/note-hoisting.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/note-hoisting.gif
new file mode 100644
index 000000000..1bc019284
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/note-hoisting.gif differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/note-icon-change.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/note-icon-change.png
new file mode 100644
index 000000000..b0133a689
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/note-icon-change.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/note-icon-gallery.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/note-icon-gallery.png
new file mode 100644
index 000000000..c0cb7f031
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/note-icon-gallery.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/note-map.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/note-map.png
new file mode 100644
index 000000000..ee7ef932a
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/note-map.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/note-revisions.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/note-revisions.png
new file mode 100644
index 000000000..d2bfe1d4c
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/note-revisions.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/promoted-attributes-queen.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/promoted-attributes-queen.png
new file mode 100644
index 000000000..3940c5239
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/promoted-attributes-queen.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/promoted-attributes.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/promoted-attributes.png
new file mode 100644
index 000000000..2e40dcbb6
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/promoted-attributes.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/protecting-note.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/protecting-note.gif
new file mode 100644
index 000000000..41f663532
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/protecting-note.gif differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/recent-notes.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/recent-notes.gif
new file mode 100644
index 000000000..2914db2b7
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/recent-notes.gif differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/relation-map-dev-process.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/relation-map-dev-process.png
new file mode 100644
index 000000000..20429151e
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/relation-map-dev-process.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/relation-map-family-demo.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/relation-map-family-demo.gif
new file mode 100644
index 000000000..b66dc05f4
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/relation-map-family-demo.gif differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/relation-map-family.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/relation-map-family.png
new file mode 100644
index 000000000..39788216a
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/relation-map-family.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/saved-search-image.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/saved-search-image.gif
new file mode 100644
index 000000000..6f9433b9f
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/saved-search-image.gif differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/saved-search.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/saved-search.gif
new file mode 100644
index 000000000..051b1cd6e
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/saved-search.gif differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/screenshot.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/screenshot.png
new file mode 100644
index 000000000..479906b1b
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/screenshot.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/share-multiple-notes-web.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/share-multiple-notes-web.png
new file mode 100644
index 000000000..434d44ef0
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/share-multiple-notes-web.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/share-single-note-web.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/share-single-note-web.png
new file mode 100644
index 000000000..c03697e67
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/share-single-note-web.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/share-single-note.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/share-single-note.png
new file mode 100644
index 000000000..4c1ea4297
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/share-single-note.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/shared-list.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/shared-list.png
new file mode 100644
index 000000000..1308b502c
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/shared-list.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/split.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/split.png
new file mode 100644
index 000000000..bb58e1834
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/split.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/steel-blue.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/steel-blue.png
new file mode 100644
index 000000000..9085c3d17
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/steel-blue.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/sync-config.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/sync-config.png
new file mode 100644
index 000000000..1c16d3267
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/sync-config.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/sync-in-progress.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/sync-in-progress.png
new file mode 100644
index 000000000..59dd79d29
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/sync-in-progress.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/sync-init.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/sync-init.png
new file mode 100644
index 000000000..8f0d7aa81
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/sync-init.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/task-manager.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/task-manager.png
new file mode 100644
index 000000000..e83574548
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/task-manager.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/template-create-instance-n.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/template-create-instance-n.png
new file mode 100644
index 000000000..b89f28afc
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/template-create-instance-n.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/template.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/template.png
new file mode 100644
index 000000000..be0a9f085
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/template.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/text-notes-formatting-bloc.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/text-notes-formatting-bloc.png
new file mode 100644
index 000000000..5414b9bc7
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/text-notes-formatting-bloc.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/text-notes-formatting-inli.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/text-notes-formatting-inli.png
new file mode 100644
index 000000000..5d18495f9
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/text-notes-formatting-inli.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/text-notes-image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/text-notes-image.png
new file mode 100644
index 000000000..d88b6dacc
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/text-notes-image.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/1_UI Elements_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/1_UI Elements_image.png
new file mode 100644
index 000000000..7a30a84df
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/1_UI Elements_image.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/1_Zen mode_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/1_Zen mode_image.png
similarity index 100%
rename from src/public/app/doc_notes/en/User Guide/User Guide/New Features/1_Zen mode_image.png
rename to src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/1_Zen mode_image.png
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/2_Zen mode_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/2_Zen mode_image.png
similarity index 100%
rename from src/public/app/doc_notes/en/User Guide/User Guide/New Features/2_Zen mode_image.png
rename to src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/2_Zen mode_image.png
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/3_Zen mode_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/3_Zen mode_image.png
similarity index 100%
rename from src/public/app/doc_notes/en/User Guide/User Guide/New Features/3_Zen mode_image.png
rename to src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/3_Zen mode_image.png
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/4_Zen mode_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/4_Zen mode_image.png
similarity index 100%
rename from src/public/app/doc_notes/en/User Guide/User Guide/New Features/4_Zen mode_image.png
rename to src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/4_Zen mode_image.png
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/5_Zen mode_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/5_Zen mode_image.png
similarity index 100%
rename from src/public/app/doc_notes/en/User Guide/User Guide/New Features/5_Zen mode_image.png
rename to src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/5_Zen mode_image.png
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/6_Zen mode_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/6_Zen mode_image.png
similarity index 100%
rename from src/public/app/doc_notes/en/User Guide/User Guide/New Features/6_Zen mode_image.png
rename to src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/6_Zen mode_image.png
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/7_Zen mode_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/7_Zen mode_image.png
similarity index 100%
rename from src/public/app/doc_notes/en/User Guide/User Guide/New Features/7_Zen mode_image.png
rename to src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/7_Zen mode_image.png
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Import & Export/Evernote.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Import & Export/Evernote.html
new file mode 100644
index 000000000..74b87bf62
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Import & Export/Evernote.html
@@ -0,0 +1,37 @@
+
+
+
+
+
+
+
+ Evernote
+
+
+
+
+
Evernote
+
+
+
Trilium can import ENEX files which are used by Evernote for backup/export.
+ One ENEX file represents content (notes and resources) of one notebook.
+
Export ENEX from Evernote
+
To export ENEX file, you need to have a legacy desktop version of
+ Evernote (i.e. not web/mobile). Right click on notebook and select export
+ and follow the wizard.
+
Import ENEX in Trilium
+
Once you have ENEX file, you can import it to Trilium. Right click on
+ some note (to which you want to import the file), click on "Import" and
+ select the ENEX file.
+
After importing the ENEX file, go over the imported notes and resources
+ to be sure the import went well, and you didn't lose any data.
+
Limitations
+
All resources (except for images) are created as note's attachments.
+
HTML inside ENEX files is not exactly valid so some formatting maybe broken
+ or lost. You can report major problems into Trilium issue tracker.
+ %%{WARNING}%%
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Import & Export/Markdown.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Import & Export/Markdown.html
new file mode 100644
index 000000000..aa9a810d5
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Import & Export/Markdown.html
@@ -0,0 +1,64 @@
+
+
+
+
+
+
+
+ Markdown
+
+
+
+
If you want to import just a chunk of markdown from clipboard, you can
+ do it from editor block menu:
+
+
+
+
File import
+
You can also import Markdown files from files:
+
+
single markdown file (with .md extension)
+
whole tree of markdown files (packaged into .zip archive)
+
+
Markdown files need to be packaged into ZIP archive because browser can't
+ read directories, only single files.
+
You can use e.g. 7-zip to package directory
+ of markdown files into the ZIP file
+
+
+
+
[[gifs/markdown-file-import.gif]]
+
+
+
+
Export
+
Subtree export
+
You can export whole subtree to ZIP archive which will have directory
+ structured modelled after subtree structure:
+
+
+
+
Single note export
+
If you want to export just single note without its subtree, you can do
+ it from Note actions menu:
+
+
+
+
Exporting protected notes
+
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.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Import & Export/OneNote.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Import & Export/OneNote.html
new file mode 100644
index 000000000..57c5d2f32
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Import & Export/OneNote.html
@@ -0,0 +1,99 @@
+
+
+
+
+
+
+
+ OneNote
+
+
+
+
+
OneNote
+
+
+
This page describes a method to migrate via EverNote Legacy, but this app is no longer available/working.
+
+
Prep Onenote notes for best compatibility
+
+
Remove Onenote Tags and replace with Emoji if possible (Onenote Tags will
+ get imported into trilium as an image which clutters the Trilium tree somewhat)
+
Make sure to use Onenote headings where applicable (These will be carried
+ over correctly into Trilium)
+
Remove extra whitespace in Onenote (Whitespace seems to be more noticible
+ in Trilium, so removing it now will make it look nicer in trilium)
+
If possible, try to avoid very long Onenote pages. Trilium works best
+ with shorter concise pages with any number of sub or (sub-sub...) pages.
+
Make sure numbered lists don't have unusual spaces between items in the
+ list (Sometimes the numbered list will start at 1 again in Trilum if there
+ is an extra space in the list in OneNote).
+
+
Migration Procedure
+
Import into Evernote from OneNote:
+
+
Install Evernote Legacy.
+ Current versions of Evernote do not have this functionality. (Requires
+ Evernote account, but import works without internet connection - be sure
+ to NOT sync notes to Evernote!).
+
In evernote navigate to File > Import > Onenote > Notebook >
+ Section > OK
+
+
If exporting all sections at a time, they will not be grouped in folders
+ - they will all be added to a single folder, but the order will be kept,
+ so you can re-group into folders after importing to Trilium
+
Export from Evernote
+
+
Right click on the created notebook in Evernote and choose "Export Notes…"
+
Use the default export format of .enex
+
+
Cleanup enex file (optional)
+
+
+
If the Onenote header (that is at the top of each Onenote page) is not
+ desired, you can use the following regex to remove them in a text editor
+ like VsCode:
In Trilium, right click on the root node and choose Import (all default
+ options should be fine).
+
Select the .enex file exported from Evernote
+
Be patient. Large .enex files may take a few minutes to process
+
Repeat import for each .enex file
+
+
Other importing notes:
+
+
Centered text in Onenote will be left-justified after importing into Trilium
+
Internal onenote links will obviously be broken, but the link still exists
+ so you can do a search in Trilium to find all onenote:// links and then
+ re-link to the proper Trilium page (there is no way to link to a paragraph
+ in trilium, so it's good to keep trilium pages short so links point to
+ a small chunk of information instead of a massive note)
+
Text colors, highlights, and formatting generally carries over well
+
Revision history will be lost, but any new revisions will be tracked in
+ Trilium
+
The structure of notes are not maintained exactly, so if you had sub-notes
+ in Onenote, you may have to re-arrange the notes accordingly (This is easy
+ since the order of the notes is preserved).
+
Evernote tags are created for each "section" in OneNote and these tags
+ are carried over to Trilium as attributes
+
+
If the tags are not desired, you can turn them off in the Evernote export
+ options.
+
+
+
If the "Created with OneNote" text is not desired, do a find/replace in
+ the enex files before importing to Trilium
+
Some links will be disabled (not clickable) when importing from enex.
+
Files, screenshots, and attachments are all preserved (This is the only
+ one-note export option that seems to preserve all of these).
+
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Keyboard Shortcuts.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Keyboard Shortcuts.html
new file mode 100644
index 000000000..589c817a3
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Keyboard Shortcuts.html
@@ -0,0 +1,127 @@
+
+
+
+
+
+
+
+ Keyboard Shortcuts
+
+
+
+
+
Keyboard Shortcuts
+
+
+
This is supposed to be a complete list of keyboard shortcuts. Note that
+ some of these may work only in certain contexts (e.g. in tree pane or note
+ editor).
+
It is also possible to configure most keyboard shortcuts in Options ->
+ Keyboard shortcuts. Using global: prefix, you can assign a shortcut
+ which will work even without Trilium being in focus (requires app restart
+ to take effect).
+
Note navigation
+
+
UP, DOWN - go up/down in the list of notes, CTRL-SHIFT-UP and CTRL-SHIFT-DOWN work
+ also from editor
+
LEFT, RIGHT - collapse/expand node
+
ALT+LEFT, ALT+RIGHT - go back / forwards in the
+ history
CTRL+. - scroll to current note (useful when you scroll away
+ from your note or your focus is currently in the editor)
+
BACKSPACE - jumps to parent note
+
ALT+C - collapse whole note tree
+
ALT+- (alt with minus sign) - collapse subtree (if some subtree
+ takes too much space on tree pane you can collapse it)
+
you can define a label#keyboardShortcut with
+ e.g. value Ctrl+I. Pressing this keyboard combination will
+ then bring you to the note on which it is defined. Note that Trilium must
+ be reloaded/restarted (Ctrl+R) for changes to be in effect.
SHIFT+click - multi select note which you clicked on
+
CTRL+C - copies current note (or current selection) into clipboard
+ (used for cloning
+
+
CTRL+X - cuts current (or current selection) note into clipboard
+ (used for moving notes)
+
CTRL+V - pastes note(s) as sub-note into current note (which
+ is either move or clone depending on whether it was copied or cut into
+ clipboard)
+
DEL - delete note / sub-tree
+
+
Editing notes
+
Trilium uses CKEditor 5 for the text notes and
+ CodeMirror 5 for code notes.
+ Check the documentation of these projects to see all their built-in keyboard
+ shortcuts.
+
+
ALT-F10 - bring up inline formatting toolbar (arrow keys <-,-> to
+ navigate, ENTER to apply)
+
ALT-F10 - again to bring up block formatting toolbar
+
ENTER in tree pane switches from tree pane into note title.
+ Enter from note title switches focus to text editor. CTRL+. switches
+ back from editor to tree pane.
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/1_Note Navigation_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/1_Note Navigation_image.png
new file mode 100644
index 000000000..2ea269012
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/1_Note Navigation_image.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/1_Workspace_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/1_Workspace_image.png
new file mode 100644
index 000000000..2401cf083
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/1_Workspace_image.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Bookmarks.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Bookmarks.html
new file mode 100644
index 000000000..10f58c90b
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Bookmarks.html
@@ -0,0 +1,32 @@
+
+
+
+
+
+
+
+ Bookmarks
+
+
+
+
+
Bookmarks
+
+
+
To easily access selected notes, you can bookmark them. See demo:
+
+
+
+
Bookmark folder
+
Space in the left panel is limited, and you might want to bookmark many
+ items. One possible solution is to bookmark a folder, so it shows its children:
+
+
+
+
To do this, you need to add a #bookmarkFolder label to the
+ note.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Note Hoisting.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Note Hoisting.html
new file mode 100644
index 000000000..7586b532d
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Note Hoisting.html
@@ -0,0 +1,30 @@
+
+
+
+
+
+
+
+ Note Hoisting
+
+
+
+
+
Note Hoisting
+
+
+
Hoisting is a standard outliner feature which allows you to focus on (or
+ "zoom into") a specific note and its subtree by hiding all parent and sibling
+ notes. Demo:
+
+
+
+
In addition to showing only this subtree, this also narrows both full
+ text search and “jump to note” to just
+ notes present in hoisted subtree.
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Note Navigation.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Note Navigation.html
new file mode 100644
index 000000000..a0244a94d
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Note Navigation.html
@@ -0,0 +1,48 @@
+
+
+
+
+
+
+
+ Note Navigation
+
+
+
+
+
Note Navigation
+
+
+
One of the Trilium's goals is to provide fast and comfortable navigation
+ between notes.
+
Backwards and forward
+
You can use alt-left and alt-right to move back and forward in history
+ of viewed pages.
+
This works identically to browser backwards / forwards, it's actually
+ using built-in browser support for this.
+
+
+
+
Jump to note
+
This is useful to quickly find and view arbitrary note - click on Jump to button
+ on the top or press CTRL-J. Then type part of the note name
+ and autocomplete will help you pick the desired note.
+
+
+
+
Recent notes
+
Jump to note also has the ability to show the list of recently viewed
+ / edited notes and quickly jump to it.
+
To access this functionality, click on Jump to button on the
+ top. By default, (when nothing is entered into autocomplete), this dialog
+ will show the list of recent notes.
+
Alternatively you can click on the "time" icon on the right.
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Note Navigation_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Note Navigation_image.png
new file mode 100644
index 000000000..2ea269012
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Note Navigation_image.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Search.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Search.html
new file mode 100644
index 000000000..65ff6856a
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Search.html
@@ -0,0 +1,158 @@
+
+
+
+
+
+
+
+ Search
+
+
+
+
+
Search
+
+
+
Local Search
+
Local search allows you to search within the currently displayed note.
+ To initiate a local search, press CTRL-F. 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.
+
Note Search
+
Note search enables you to find notes by searching for text in the title,
+ content, or attributes 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.
+
To search for notes, click on the magnifying glass icon on the toolbar
+ or press the CTRL-S keyboard shortcut.
+
Simple Note Search Examples
+
+
rings tolkien: Full-text search to find notes containing
+ both "rings" and "tolkien".
+
"The Lord of the Rings" Tolkien: Full-text search where "The
+ Lord of the Rings" must match exactly.
+
note.content *=* rings OR note.content *=* tolkien: Find
+ notes containing "rings" or "tolkien" in their content.
+
towers #book: Combine full-text and attribute search to find
+ notes containing "towers" and having the "book" label.
+
towers #book or #author: Search for notes containing "towers"
+ and having either the "book" or "author" label.
+
towers #!book: Search for notes containing "towers" and not
+ having the "book" label.
+
#book #publicationYear = 1954: Find notes with the "book"
+ label and "publicationYear" set to 1954.
+
#genre *=* fan: Find notes with the "genre" label containing
+ the substring "fan". Additional operators include *=* for "contains", =* for
+ "starts with", *= for "ends with", and != for "is
+ not equal to".
+
#book #publicationYear >= 1950 #publicationYear < 1960:
+ Use numeric operators to find all books published in the 1950s.
+
#dateNote >= TODAY-30: A "smart search" to find notes
+ with the "dateNote" label within the last 30 days. Supported smart values
+ include NOW +- seconds, TODAY +- days, MONTH +- months, YEAR +- years.
+
~author.title *=* Tolkien: Find notes related to an author
+ whose title contains "Tolkien".
+
#publicationYear %= '19[0-9]{2}': Use the '%=' operator to
+ match a regular expression (regex). This feature has been available since
+ Trilium 0.52.
+
+
Advanced Use Cases
+
+
~author.relations.son.title = 'Christopher Tolkien': Search
+ for notes with an "author" relation to a note that has a "son" relation
+ to "Christopher Tolkien". This can be modeled with the following note structure:
+
+
Books
+
+
Lord of the Rings
+
+
label: “book”
+
relation: “author” points to “J. R. R. Tolkien” note
+
+
+
+
+
People
+
+
J. R. R. Tolkien
+
+
relation: “son” points to "Christopher Tolkien" note
+
Christopher Tolkien
+
+
+
+
+
+
+
~author.title *= Tolkien OR (#publicationDate >= 1954 AND #publicationDate <= 1960):
+ Use boolean expressions and parentheses to group expressions. Note that
+ expressions starting with a parenthesis need an "expression separator sign"
+ (# or ~) prepended.
+
note.parents.title = 'Books': Find notes with a parent named
+ "Books".
+
note.parents.parents.title = 'Books': Find notes with a grandparent
+ named "Books".
+
note.ancestors.title = 'Books': Find notes with an ancestor
+ named "Books".
+
note.children.title = 'sub-note': Find notes with a child
+ named "sub-note".
+
+
Search with Note Properties
+
Notes have properties that can be used in searches, such as noteId, dateModified, dateCreated, isProtected, type, title, text, content, rawContent, ownedLabelCount, labelCount, ownedRelationCount, relationCount, ownedRelationCountIncludingLinks, relationCountIncludingLinks, ownedAttributeCount, attributeCount, targetRelationCount, targetRelationCountIncludingLinks, parentCount, childrenCount, isArchived, contentSize, noteSize,
+ and revisionCount.
+
These properties can be accessed via the note. prefix, e.g., note.type = code AND note.mime = 'application/json'.
Search syntax allows combining full-text search with attribute-based search
+ seamlessly. For example, tolkien #book contains:
+
+
Full-text tokens - tolkien
+
+
Attribute expressions - #book
+
+
+
Trilium detects the separation between full text search and attribute/property
+ search by looking for certain special characters or words that denote attributes
+ and properties (e.g., #, ~, note.). If you need to include these in full-text
+ search, escape them with a backslash so they are processed as regular text:
Three types of quotes are supported: single, double, and backtick.
+
Type Coercion
+
Label values are technically strings but can be coerced for numeric comparisons:
note.dateCreated =* '2019-05'
+
This finds notes created in May 2019. Numeric operators like #publicationYear >= 1960 convert
+ string values to numbers for comparison.
+
Auto-Trigger Search from URL
+
You can open Trilium and automatically trigger a search by including the
+ search url encoded string
+ in the URL:
+
http://localhost:8080/#?searchString=abc
+
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Tree Concepts.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Tree Concepts.html
new file mode 100644
index 000000000..227b78f98
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Tree Concepts.html
@@ -0,0 +1,46 @@
+
+
+
+
+
+
+
+ Tree Concepts
+
+
+
+
+
Tree Concepts
+
+
+
This page explains the basic concepts related to the tree structure of
+ notes in TriliumNext.
+
Note
+
A note is the central entity in TriliumNext. For more details, see Note.
+
Branch
+
A branch describes the placement of a note within the note tree. Essentially,
+ it is a tuple of parentNoteId and noteId, indicating
+ that the given note is placed as a child under the specified parent note.
+
Each note can have multiple branches, meaning any note can be placed in
+ multiple locations within the tree. This concept is referred to as "
+ cloning."
+
Prefix
+
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
+ the title slightly in one of those placements, you can use a prefix.
+
To edit a prefix, right-click on the note in the tree pane and select
+ "Edit branch prefix."
+
The prefix is not part of the note itself and is not encrypted when the
+ note is protected. This can be useful if you want part of the title to
+ remain visible in the tree for easier navigation, even when the note is
+ protected.
+
Subtree
+
A subtree consists of a particular note (the subtree root) and all its
+ children and descendants. Some operations, such as exporting, work on entire
+ subtrees.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Tree Manipulation.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Tree Manipulation.html
new file mode 100644
index 000000000..ebf0d1af7
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Tree Manipulation.html
@@ -0,0 +1,46 @@
+
+
+
+
+
+
+
+ Tree Manipulation
+
+
+
+
+
Tree Manipulation
+
+
+
This page explains how to manipulate the note tree in TriliumNext, focusing
+ on moving notes.
+
Drag and Drop
+
+ You can easily rearrange the note tree by dragging and dropping notes,
+ as demonstrated in the example above.
+
Keyboard Manipulation
+
+ Trilium offers efficient keyboard-based manipulation using the following
+ shortcuts:
+
+
CTRL-UP and CTRL-DOWN: Move the note up or down
+ in the order.
+
CTRL-LEFT: Move the note up in the hierarchy by changing
+ its parent to the note's grandparent.
+
CTRL-RIGHT: Move the note down in the hierarchy by setting
+ its parent to the note currently above it (this action is best understood
+ through a demo or hands-on experience).
+
LEFT and RIGHT: Expand and collapse a sub-tree.
+
+
Context Menu
+
You can also move notes using the familiar cut and paste functions available
+ in the context menu, or with the associated keyboard shortcuts: CTRL-C (
+ copy), CTRL-X (cut) and CTRL-V (paste).
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Workspace.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Workspace.html
new file mode 100644
index 000000000..ae0d97968
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Workspace.html
@@ -0,0 +1,58 @@
+
+
+
+
+
+
+
+ Workspace
+
+
+
+
+
Workspace
+
+
+
Workspace is a concept built up on top of note hoisting.
+ 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.
+
So far workspace consists of these features:
+
+
note hoisting - you can "zoom" into
+ a workspace subtree to focus only on the relevant notes
+
+
easy entering of workspace:
+
+
+
+
+
visual identification of workspace in tabs:
+
+
+
+
+
How to use workspaces
+
Let's say you have identified the workspaces and their subtrees. Define
+ on the root of this subtree following labels:
+
+
#workspace - Marks this note as a workspace, button to enter
+ the workspace is controlled by this
+
#workspaceIconClass - controls the box icon to be displayed
+ in the tree and tabs, example bx bx-home. See https://boxicons.com/
+
#workspaceCalendarRoot - 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.
+
#workspaceTemplate - 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.
+
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Workspace_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Workspace_image.png
new file mode 100644
index 000000000..ae10ee7cb
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Workspace_image.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note.html
new file mode 100644
index 000000000..0aef87f81
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note.html
@@ -0,0 +1,83 @@
+
+
+
+
+
+
+
+ Note
+
+
+
+
+
Note
+
+
+
Note is a central entity in Trilium. Main attributes of note are title
+ and content.
+
Note types
+
+
text note - this is default note
+ type which allows you to put rich text, images etc.
+
code note - some kind
+ of formal code, typically programming language (e.g. JavaScript) or data
+ structure (e.g. JSON)
file note - represents uploaded file (e.g. docx MS Word document).
+
render HTML note - this works as an output screen of attached scripts
+
+
saved search note - contains
+ saved search query and dynamically displays result of the search as its
+ sub-notes
+
relation map note
+ - visualizes notes and their relations
+
book note - displays its children
+ notes, useful for reading many short notes
+
mermaid - create diagrams and flowcharts using mermaid.js ↗
+
+
canvas note - allows hand drawn notes
+ and basic diagraming on an infinite canvas using excalidraw ↗
+
+
+
In Trilium there's no specific "folder" note type. Any note can have children
+ and thus be a folder.
+
Root note
+
There's one special note called "root note" which is root of the note
+ tree. All other notes are placed below it in the structure.
+
Tree structure
+
Importantly, note itself doesn't carry information on its placement in
+ note tree. See cloning for details.
+
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
+ can both have its own content and have children. "Leaf note" is a note
+ which doesn't have any children.
+
Deleting / undeleting notes
+
When you delete a note in Trilium, it is actually only marked for deletion
+ (soft-delete) - the actual content, title, attributes etc. are not deleted,
+ only hidden.
+
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.
+
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.
+
To be able to undelete a note, it is necessary that deleted note's parent
+ must be undeleted (otherwise there's no place where we can undelete it
+ to). This might become a problem when you delete more notes in succession
+ - the solution is then undelete in the reverse order of your deletion.
+
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 backup).
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/1_Export as PDF_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/1_Export as PDF_image.png
similarity index 100%
rename from src/public/app/doc_notes/en/User Guide/User Guide/New Features/1_Export as PDF_image.png
rename to src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/1_Export as PDF_image.png
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/1_Images_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/1_Images_image.png
new file mode 100644
index 000000000..0167e759b
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/1_Images_image.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/1_Right-to-left text notes_i.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/1_Right-to-Left Support_imag.png
similarity index 100%
rename from src/public/app/doc_notes/en/User Guide/User Guide/New Features/1_Right-to-left text notes_i.png
rename to src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/1_Right-to-Left Support_imag.png
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/2_Right-to-left text notes_i.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/2_Right-to-Left Support_imag.png
similarity index 100%
rename from src/public/app/doc_notes/en/User Guide/User Guide/New Features/2_Right-to-left text notes_i.png
rename to src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/2_Right-to-Left Support_imag.png
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/3_Right-to-left text notes_i.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/3_Right-to-Left Support_imag.png
similarity index 100%
rename from src/public/app/doc_notes/en/User Guide/User Guide/New Features/3_Right-to-left text notes_i.png
rename to src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/3_Right-to-Left Support_imag.png
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/4_Right-to-left text notes_i.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/4_Right-to-Left Support_imag.png
similarity index 100%
rename from src/public/app/doc_notes/en/User Guide/User Guide/New Features/4_Right-to-left text notes_i.png
rename to src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/4_Right-to-Left Support_imag.png
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Archived Notes.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Archived Notes.html
new file mode 100644
index 000000000..f7700bb24
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Archived Notes.html
@@ -0,0 +1,31 @@
+
+
+
+
+
+
+
+ Archived Notes
+
+
+
+
+
Archived Notes
+
+
+
Archived notes are notes which have archivedattribute -
+ either directly or inherited.
+
Such notes are then by default not shown in the autocomplete and in the
+ full text search.
+
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.
+
You can control whether archived notes are displayed in the note tree
+ with a setting:
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Attachments.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Attachments.html
new file mode 100644
index 000000000..269c272fc
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Attachments.html
@@ -0,0 +1,35 @@
+
+
+
+
+
+
+
+ Attachments
+
+
+
+
+
Attachments
+
+
+
A note in Trilium can own one or more attachments,
+ which can be either images or files. These attachments can be displayed
+ or linked within the note that owns them.
+
This can be especially useful to include dependencies for your scripts.
+ The Weight Tracker shows
+ how to use chartjs which is attached to
+ the script note.
+
Each note exclusively owns its attachments, meaning attachments cannot
+ be shared or linked from one note to another. If an attachment link is
+ copied to a different note, the attachment itself is duplicated, and the
+ copies are managed independently thereafter.
+
Attachments, especially image files, are the recommended method for embedding
+ visuals in notes. It is important to link image attachments within the
+ text of the owning note; otherwise, they will be automatically deleted
+ after a configurable timeout period if not referenced.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Cloning Notes.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Cloning Notes.html
new file mode 100644
index 000000000..0e367d375
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Cloning Notes.html
@@ -0,0 +1,128 @@
+
+
+
+
+
+
+
+ Cloning Notes
+
+
+
+
+
Cloning Notes
+
+
+
Motivation
+
Trilium's core feature is the ability to structure your notes into hierarchical
+ tree-like structure.
+
It is expected then that you'll have an elaborate and deep note hierarchy
+ - each subtree will represent a more refined and specialized view of your
+ knowledge base.
+
This is a pretty powerful approach, but it also carries a hidden assumption
+ that each "subtopic" is "owned" by one parent. I'll illustrate this with
+ an example - let's say my basic structure is this:
+
+
Technology
+
+
Programming
+
+
Kotlin
+
JavaScript
+
+
+
Operating systems
+
+
Linux
+
Windows
+
+
+
+
+
+
Now, I'm starting to learn about Bash and
+ would like to create notes related to this topic. But now I'm facing a
+ problem of where to categorize this. The issue here is that Bash is both
+ a programming language and a tool (shell) very much tied into Linux. It
+ seems it belongs to both of these, I can't (and don't want to) choose one
+ over the other.
+
Solution
+
The solution to the problem shown above is to allow notes to have multiple
+ parents.
+
I call these "clones", but that is a bit misleading - there's no original
+ and cloned note - the notes in both of the parents categories are identical.
+
Another misleading thing about "cloning" is that it suggests that a copy
+ of the note has been made. That's not really true, the note itself stays
+ in just one original, it is just referenced in multiple places in the tree
+ hierarchy. So changing it in one category changes it in all the others,
+ because they're all the same note.
+
Here's the final structure with cloning:
+
+
Technology
+
+
Programming
+
+
Kotlin
+
JavaScript
+
Bash
+
+
some sub-notes ...
+
+
+
+
+
Operating systems
+
+
Linux
+
+
Bash
+
+
some sub-notes ...
+
+
+
+
+
Windows
+
+
+
+
+
+
So now the "Bash" subtree appears on multiple locations in the hierarchy.
+ Both the Bash subtrees are the same and contain the same sub-categories
+ and notes.
+
Demo
+
+
+
+
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 CTRL+C
+ and CTRL+V keyboard shortcuts.
+
As seen in the demo, you can view the list of all available clones in
+ the "Note Paths" tab in the Ribbon toolbar.
+
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.
+
Prefix
+
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.
+
Deleting notes/clones
+
With clones, it might not be immediately obvious how deleting works.
+
If you try to delete a note, it works like this:
+
+
if the note has multiple clones, delete just this clone and leave the
+ actual note (and its other clones) as it is.
+
if this note doesn't have any other clones, delete the note
+
+
Run the whole process starting with 1. on all note's children notes
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Export as PDF.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Export as PDF.html
new file mode 100644
index 000000000..09b9418cc
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Export as PDF.html
@@ -0,0 +1,59 @@
+
+
+
+
+
+
+
+ Export as PDF
+
+
+
+
+
Export as PDF
+
+
+
+
+
+
+ Screenshot of the note contextual menu indicating the “Export as PDF”
+ option.
+
+
On the desktop application of Trilium it is possible to export a note
+ as PDF. On the server or PWA (mobile), the option is not available due
+ to technical constraints and it will be hidden.
+
To print a note, select the
+ button to the right of the note and select Export as PDF.
+
Afterwards you will be prompted to select where to save the PDF file.
+ Upon confirmation, the resulting PDF will be opened automatically using
+ the default/system application configured for PDFs.
+
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
+ report the issue. In this case, it's best to offer a sample note (click
+ on the
+ button, select Export note → This note and all of its descendants → HTML
+ in ZIP archive). Make sure not to accidentally leak any personal information.
+
Landscape mode
+
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 #printLandscape attribute
+ to it (see [missing note]).
+
Page size
+
By default, the resulting PDF will be in Letter format. It is possible
+ to adjust it to another page size via the #printPageSize attribute,
+ with one of the following values: A0, A1, A2, A3, A4, A5, A6, Legal, Letter, Tabloid, Ledger.
+
Keyboard shortcut
+
It's possible to trigger the export to PDF from the keyboard by going
+ to Keyboard shortcuts and assigning a key combination
+ for the exportAsPdf action.
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/Export as PDF_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Export as PDF_image.png
similarity index 100%
rename from src/public/app/doc_notes/en/User Guide/User Guide/New Features/Export as PDF_image.png
rename to src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Export as PDF_image.png
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Images.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Images.html
new file mode 100644
index 000000000..c86b64fe4
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Images.html
@@ -0,0 +1,50 @@
+
+
+
+
+
+
+
+ Images
+
+
+
+
+
Images
+
+
+
Trilium supports storing and displaying images. Supported formats are
+ JPEG, PNG and GIF.
+
An image can be uploaded in the form of note's attachment or
+ as a standalone note placed
+ into the note tree. Its
+ reference can be copied into a text note, in order to display it in the
+ text itself.
+
Uploading images
+
To add an image to the note, simply drag it from file explorer onto the
+ note editor inside Trilium and the image will be uploaded.
+
+
+
+
Alternatively you can click on block toolbar and then on "Insert image":
+
+
+
+
You can also copy and paste an image from web - the image will be (asynchronously)
+ downloaded and embedded.
+
Compression
+
Since Trilium isn't really meant to be primary storage for image data,
+ it attempts to compress and resize (with pretty aggressive settings) uploaded
+ images before storing them to the database. You may then notice some quality
+ degradation. Basic quality settings is available in Options -> Other.
+
If you want to save images in their original resolution, it is recommended
+ to save them as attachment to note (top-right "Note actions -> Import
+ files").
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Images_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Images_image.png
new file mode 100644
index 000000000..f8c5cf48f
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Images_image.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Links.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Links.html
new file mode 100644
index 000000000..d4ffe9633
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Links.html
@@ -0,0 +1,59 @@
+
+
+
+
+
+
+
+ Links
+
+
+
+
External links are done through CKEditor native links. To create an external
+ link, select text and press CTRL-K or wait for the "balloon"
+ to appear and click link icon there.
+
+
+
+
You can follow external link by either double clicking (will open new
+ tab/window) it or right clicking on them and choosing "Open in new tab".
+
Internal links to notes
+
Links to internal notes are created a bit differently. To create link
+ to note at current cursor position, press CTRL-L.
+
In the dialog you can see radio button to choose from different types
+ of linking:
+
+
link title mirrors the note's current title - this is sometimes also called
+ "reference link". Title of such links cannot be changed, instead it is
+ always mirroring the title of linked note. This way the link title is never
+ outdated
+
link title can be changed arbitrarily - this is the traditional hyperlink
+ - you link to a particular note and can choose the link title
+
+
+
+
+
You can follow the note link by double clicking it.
+
Alternatively if you only wish to quickly preview the content, you can
+ hover over the link and will see read only preview.
+
In-place linking
+
Trilium also provides "inline" linking - type @ and you'll
+ see an autocomplete, just type few characters from the desired note title,
+ press enter and you have a link.
+
Note map
+
Trilium provides a visualisation of incoming and outgoing links for a
+ particular note. See note map for
+ details.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Note Icons.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Note Icons.html
new file mode 100644
index 000000000..a1c6f62bc
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Note Icons.html
@@ -0,0 +1,32 @@
+
+
+
+
+
+
+
+ Note Icons
+
+
+
+
+
Note Icons
+
+
+
Icons are useful for distinguishing notes. At the technical level, they
+ are set by the iconClass attribute which adds
+ a CSS class to the note. For example #iconClass="bx bx-calendar" will
+ show a calendar instead of the default page or folder icon. Looking up
+ and remembering the css class names is not necessary. While editing a note,
+ click on the icon next to the title to bring up a chooser gallery:
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Note Revisions.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Note Revisions.html
new file mode 100644
index 000000000..e7db23875
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Note Revisions.html
@@ -0,0 +1,44 @@
+
+
+
+
+
+
+
+ Note Revisions
+
+
+
+
+
Note Revisions
+
+
+
Trilium supports seamless versioning of notes by storing snapshots ("revisions")
+ of notes at regular intervals.
+
Note Revisions Snapshot Interval
+
Time interval of taking note snapshot is configurable in the Options ->
+ Other dialog. This provides a tradeoff between more revisions and more
+ data to store.
+
To turn off note versioning for a particular note (or subtree), add disableVersioning
+ labelto the note.
+
Note Revision Snapshots Limit
+
The limit on the number of note snapshots can be configured in the Options
+ -> Other dialog. The note revision snapshot number limit refers to the
+ maximum number of revisions that can be saved for each note. Where -1 means
+ no limit, 0 means delete all revisions. You can set the maximum revisions
+ for a single note through the versioningLimit=X label.
+
The note limit will not take effect immediately; it will only apply when
+ the note is modified.
+
You can click the Erase excess revision snapshots now button
+ to apply the changes immediately.
+
Note revisions can be accessed through the button on the right of ribbon
+ toolbar.
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Protected Notes.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Protected Notes.html
new file mode 100644
index 000000000..83d355452
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Protected Notes.html
@@ -0,0 +1,109 @@
+
+
+
+
+
+
+
+ Protected Notes
+
+
+
+
+
Protected Notes
+
+
+
Trilium is designed to store a wide variety of data, including sensitive
+ information such as personal journals, credentials, or confidential documents.
+ To safeguard this type of content, Trilium offers the option to protect
+ notes, which involves the following measures:
+
+
Encryption: 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 database,
+ they won't be able to read your encrypted notes.
+
Time-limited access: 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),
+ the note is unloaded from memory, requiring you to re-enter your password
+ to access it again.
+
+
The session timeout is extended automatically while you're interacting
+ with the protected note, so if you're actively editing, the session remains
+ open. However, if you switch to an unprotected note, the session timer
+ starts, and the session expires after 10 minutes of inactivity unless you
+ return to the protected notes.
+
+
+
Protection scope: Protected notes ensure the confidentiality
+ of their content and partially their integrity. While unauthorized users
+ cannot read or edit protected notes, they can still delete or move them
+ outside of the protected session.
+
+
Using Protected Notes
+
By default, notes are unprotected. To protect a note, simply click on
+ the shield icon next to the note's title, as shown here:
+
+
+
+
What is Encrypted?
+
Trilium encrypts the data within protected notes but not their metadata.
+ Specifically:
+
Encrypted:
+
+
+
Note title
+
Note content
+
Images
+
File attachments
+
+
Not encrypted:
+
+
+
Note structure (i.e., it remains visible that there are protected notes)
The following steps outline how encryption and decryption work in Trilium:
+
+
The user enters a password.
+
The password is passed through the scrypt algorithm
+ along with a "password verification" salt to
+ confirm that the password is correct.
+
The password is then processed again through scrypt with an "encryption"
+ salt, which generates a hash.
+
+
Scrypt is used for key stretching to
+ make the password harder to guess.
+
+
+
The generated hash is used to decrypt the actual data encryption key.
+
+
The data encryption key is encrypted using AES-128 with
+ a random IV.
+
The data encryption key is randomly generated during the database initialization
+ and remains constant throughout the document’s lifetime. When the password
+ is changed, only this key is re-encrypted.
+
+
+
The data encryption key is then used to decrypt the actual content of
+ the note, including its title and body.
+
+
The encryption algorithm used is AES-128 with CBC mode,
+ where a unique IV is generated for each encryption operation and stored
+ with the cipher text.
+
+
+
+
Sharing Protected Notes
+
Protected notes cannot be shared in the same way as regular notes. Their
+ encryption ensures that only authorized users with the correct password
+ can access them.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Read-Only Notes.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Read-Only Notes.html
new file mode 100644
index 000000000..4bdf54fa8
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Read-Only Notes.html
@@ -0,0 +1,34 @@
+
+
+
+
+
+
+
+ Read-Only Notes
+
+
+
+
+
Read-Only Notes
+
+
+
Both text and code 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.
+
Setting Read-Only Mode with a Label
+
To set a note as read-only, add the readOnlylabel to
+ the note.
+
Automatic Read-Only Mode
+
For optimization purposes, Trilium will automatically set very large notes
+ to read-only. Displaying such lengthy notes in editing mode can slow down
+ performance, especially when editing is unnecessary.
+
If you want to ensure that a specific note remains editable regardless
+ of its size, you can add the autoReadOnlyDisabledlabel to
+ the note.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Right-to-Left Support.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Right-to-Left Support.html
new file mode 100644
index 000000000..b8a364d4a
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Right-to-Left Support.html
@@ -0,0 +1,61 @@
+
+
+
+
+
+
+
+ Right-to-Left Support
+
+
+
+
+
Right-to-Left Support
+
+
+
+
+
Trilium now has basic support for right-to-left text, but only for
+ Text note types (both editable and read-only).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Note that only the Text note type supports this.
+
The list of languages is configurable via the a new dedicated settings
+ page:
+
+
+
+
To select the corresponding language of the text, go to “Basic Properties”
+ and select your desired language.
+
+
+
+
Feel free to report any issues regarding right to left support.
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/Right-to-left text notes_i.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Right-to-Left Support_imag.png
similarity index 100%
rename from src/public/app/doc_notes/en/User Guide/User Guide/New Features/Right-to-left text notes_i.png
rename to src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Right-to-Left Support_imag.png
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Sorting Notes.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Sorting Notes.html
new file mode 100644
index 000000000..e70c16d24
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Sorting Notes.html
@@ -0,0 +1,68 @@
+
+
+
+
+
+
+
+ Sorting Notes
+
+
+
+
+
Sorting Notes
+
+
+
Sorting Notes
+
+
You can sort notes by right-clicking the parent note in the note tree
+ and selecting Advanced -> Sort notes by ... This will sort existing
+ notes, but will not automatically sort future notes added to this parent
+ note
+
+
Automatic/Permanent Sorting
+
+
Child notes can be automatically sorted by attaching specific labels to
+ the parent note:
+
+
#sorted: Enables sorting. Can optionally include the name
+ of the note's property/label for sorting criteria (details below).
+
#sortDirection: By default, sorting is ascending. Set this
+ to desc to sort in descending order.
+
#sortFoldersFirst: Notes with children will be sorted to
+ the top.
+
+
Sorting is done by comparing note properties or specific labels on child
+ notes. There are four sorting levels, with the first having the highest
+ priority. Lower priority levels are applied only if higher priority comparisons
+ result in equality.
+
+
Top Label Sorting: Child notes with the #top label
+ will appear at the top of the folder.
+
Bottom Label Sorting: (Introduced in Trilium 0.62) Child
+ notes with the #bottom label will appear at the bottom of the
+ folder.
+
Property/Label-Based Sorting: Sorting is based on the
+ parent note's #sorted label:
+
+
Default Sorting: If #sorted has no value,
+ notes are sorted alphabetically.
+
Property Sorting: If #sorted is set to title, dateModified,
+ or dateCreated, notes are sorted based on the specified property.
+
Label Sorting: If #sorted has any other value,
+ this value is treated as the name of a child note's label, and sorting
+ is based on the values of this label. For example, setting #sorted=myOrder on
+ the parent note and using #myOrder=001, #myOrder=002,
+ etc., on child notes.
+
+
+
Alphabetical Sorting: Used as a last resort when other
+ criteria result in equality.
+
+
All comparisons are made string-wise (e.g., "1" < "2" or "2020-10-10"
+ < "2021-01-15", but also "2" > "10").
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Themes.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Themes.html
new file mode 100644
index 000000000..de082d811
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Themes.html
@@ -0,0 +1,160 @@
+
+
+
+
+
+
+
+ Themes
+
+
+
+
+
Themes
+
+
+
Default Themes
+
Trilium comes with a couple pre-installed color themes, with the default
+ being a light theme. To switch to a dark theme or any other available theme,
+ navigate to the Options menu (accessible via the app icon in the top-left
+ corner), select the Appearance tab, and choose your preferred theme.
+
+
+
+
Creating Custom CSS Themes
+
Trilium supports custom user themes, allowing you to personalize the application's
+ appearance. To create a custom theme, follow these steps:
+
+
Create a CSS Code Note: Start by creating a new code note with
+ the CSS type.
+
Annotate with #appTheme:
+ Add the attribute#appTheme=my-theme-name to
+ your note, where my-theme-name is the name of your custom theme.
+
Define Your Styles: Write your custom CSS within the
+ note. Below is an example of a custom theme:
In the theme selection dropdown, you should see your custom theme listed
+ under the name you provided with the #appThemelabel.
+
Select your custom theme to activate it.
+
+
If you make changes to your theme, press CTRL-R to reload the
+ frontend and apply your updates.
+
Sharing and Importing Themes
+
Custom themes can be exported as .tar archives, which can be
+ shared with other users. However, be cautious when importing themes from
+ untrusted sources, as they may contain executable scripts that could pose
+ security risks.
+
An example user theme, Steel Blue, is available in the demo document.
+
+
+
+
Using Custom CSS for Specific Purposes
+
In addition to full themes, Trilium allows for custom CSS that isn't tied
+ to a theme. This can be particularly useful in scripting contexts, where
+ you might want to modify specific UI elements, such as changing the colors
+ of notes in the tree view.
+
Applying Custom CSS
+
To use custom CSS:
+
+
Create a CSS Code Note: Create a new code note with
+ the CSS type.
+
Add the appCss Label:
+ Annotate the note with the #appCsslabel.
+
Write Your CSS: Add your custom CSS rules to the note.
+
+
For example:
/* Custom CSS to style specific elements */
+.tree-item {
+ color: #ff6347; /* Change tree item color */
+}
+
When Trilium's frontend starts, all notes labeled with appCss are
+ automatically included in the style element of the HTML page.
+
After making changes, press CTRL-R to reload the frontend and
+ apply your new styles.
+
+
+
+
Styling Specific Notes in the Tree
+
To apply specific styles to certain notes in the tree:
+
+
Use the cssClass Attribute:
+ Add the cssClassattribute to
+ a note, and assign it a value representing the desired CSS class.
+
Define an iconClass: You
+ can also define a custom icon for a note using the iconClass attribute,
+ selecting from Box Icons or your own custom
+ classes.
+
+
For example, if you want to style notes of a specific type, such as notes
+ containing PNG images, you can target them with classes like type-image mime-image-png.
+
User-Provided Themes
+
A gallery of user-created themes is available, showcasing the variety
+ of customizations that the Trilium community has developed. For more information,
+ visit the Theme Gallery.
+
Asset Path Management
+
When referencing built-in assets like images in your custom themes or
+ CSS, you can avoid hardcoding version numbers by using the vX alias.
+ For example, instead of specifying /assets/v0.57.0-beta/images/icon-grey.png,
+ you can use /assets/vX/images/icon-grey.png to keep your theme
+ compatible with future versions of Trilium.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Themes/Theme Gallery.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Themes/Theme Gallery.html
new file mode 100644
index 000000000..dff449716
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Themes/Theme Gallery.html
@@ -0,0 +1,112 @@
+
+
+
+
+
+
+
+ Theme Gallery
+
+
+
+
+
Theme Gallery
+
+
+
These are user-created themes which were made publicly available:
+
Legacy Themes
+
These themes may or may not be compatible with the latest versions of
+ TriliumNext and are based on the original/legacy theme.
If you would like to add your theme to this gallery, write a new post
+ in 👐 Show and tell.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Themes/Theme Gallery_preview.jpg b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Themes/Theme Gallery_preview.jpg
new file mode 100644
index 000000000..5b2eb96ff
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Themes/Theme Gallery_preview.jpg differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Themes_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Themes_image.png
new file mode 100644
index 000000000..49df90730
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Themes_image.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/1_Global menu_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/1_Global menu_image.png
new file mode 100644
index 000000000..7a30a84df
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/1_Global menu_image.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Global menu.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Global menu.html
new file mode 100644
index 000000000..ef158829b
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Global menu.html
@@ -0,0 +1,51 @@
+
+
+
+
+
+
+
+ Global menu
+
+
+
+
+
Global menu
+
+
+
The position of the global menu differs based on which layout is selected
+ in settings:
+
+
For the vertical layout, the icon is in the top-left of the screen, in
+ the form of the Trilium icon.
+
For the horizontal layout, the icon is in the top-right of the screen,
+ in form of a hamburger menu icon.
+
+
+
+
+
+
+
+
+ The global menu in the vertical layout.
+
+
+
+
+
+ The global menu in the horizontal layout.
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Global menu_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Global menu_image.png
new file mode 100644
index 000000000..37a565d3f
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Global menu_image.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements_image.png
new file mode 100644
index 000000000..37a565d3f
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements_image.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Zen mode.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Zen mode.html
new file mode 100644
index 000000000..416a8075f
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Zen mode.html
@@ -0,0 +1,80 @@
+
+
+
+
+
+
+
+ Zen mode
+
+
+
+
+
Zen mode
+
+
+
+
+
+
+ Screenshot of Zen Mode activated on a Windows 11 system with native title
+ bar off and background effects on.
+
+
When Zen Mode is activated (pictured on the side), most of the user interface
+ of Trilium is hidden away in order to be able to focus on the content,
+ whether it's for reading or writing.
+
+
+ Screenshot of the Zen Mode option in the global menu.
+
+
Activating & deactivating
+
+
The Zen Mode can be activated by accessing the global menu and selecting
+ the “Zen Mode” option:
+
Aside from the global menu, it's also possible to activate this mode by
+ using a keyboard shortcut which is Alt+Z by default. Look for toggleZenMode in
+ the shortcut configuration.
+
Once Zen Mode is activated, all the UI elements of the application will
+ be hidden away, including the global menu. In that case, the Zen Mode can
+ be deactivated either by pressing the
+ icon in the top-right corner of the window or by pressing the keyboard
+ combination again.
+
Do note that, by design, activating or deactivating the Zen Mode applies
+ only to the current window. Restarting the application will also disable
+ the Zen Mode.
+
Moving the window around
+
+
If “Native title bar” is activated, then the operating system's default
+ title bar can be used to drag the window around. If deactivated, the window
+ can still be moved by dragging the mouse across the top part of the window
+ where the note titles are.
+
+
+ Screenshot of two notes side-by-side while Zen Mode is active, on Windows
+ 11 with background effects off.
+
+
Split windows and tabs
+
+
Tabs are completely hidden, however it's still possible to use keyboard
+ shortcuts such as firstTab (Ctrl+1 by default), secondTab (Ctrl+2
+ by default). There are also some newer shortcuts such as activateNextTab (Ctrl+Tab)
+ or activatePreviousTab (Ctrl+Shift+Tab) that allow easy navigation,
+ however make sure that they are configured properly in the settings.
+
For the split view of notes, there are no keyboard shortcuts at the time
+ of writing, but it's still possible to have them in Zen Mode by creating
+ the split while the Zen Mode is off and then reactivating it afterwards.
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/Zen mode_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Zen mode_image.png
similarity index 100%
rename from src/public/app/doc_notes/en/User Guide/User Guide/New Features/Zen mode_image.png
rename to src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Zen mode_image.png
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/Examples/Downloading responses from Goo.html b/src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/Examples/Downloading responses from Goo.html
new file mode 100644
index 000000000..4b4e8107d
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/Examples/Downloading responses from Goo.html
@@ -0,0 +1,61 @@
+
+
+
+
+
+
+
+ Downloading responses from Google Forms
+
+
+
+
+
Downloading responses from Google Forms
+
+
+
+
+
This tutorial showcases a basic integration with Google Forms, where we
+ are able to download the responses of a form using the “Link to Sheets"
+ functionality.
+
Note that the link will be publicly accessible to everyone (however the
+ link is in a hard-to-guess format such as https://docs.google.com/spreadsheets/d/e/2PACX-1vTA8NU2_eZFhc8TFadCZPreBfvP7un8IHd6J0SchrLLw3ueGmntNZjwRmsH2ZRcp1pJYDAzMz1FmFaj/pub?output=csv).
+ Make sure you are not accidentally publishing sensitive information.
+
Obtaining the CSV link
+
+
Open the Google Forms in a browser.
+
Select the “Responses” tab and click on “Link to Sheets”.
+
Select “Create a new spreadsheet” and press “Create”.
+
In Google Sheets, select File → Share → Publish to web.
+
In the “Publish to the web” screen, make sure the “Link” tab is selected
+ and instead of “Web page”, select “Comma-separated values (.csv)”.
+
Copy the given link which will be used for the upcoming script.
+
+
Creating the script
+
Create a “JS Frontend” script:
const CSV_URL = "https://docs.google.com/spreadsheets/d/e/2PACX-1vTiwooLV2whjCSVa49dJ99p_G3_qhqHHRqttMjYCJVfLXVdTgUSNJu5K0rpqmaHYF2k7Vofi3o7gW82/pub?output=csv";
+
+async function fetchData() {
+ try {
+ const response = await fetch(CSV_URL);
+ return await response.text();
+ } catch (e) {
+ api.showError(e.message);
+ }
+}
+
+const data = await fetchData();
+console.log(data);
+// Do something with the data.
+
Note that the data will be received as a string and there is no library
+ to do the CSV parsing for us. To do a very simple parsing of CSV:
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Scripting/Using promoted attributes .png b/src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/Examples/Using promoted attributes .png
similarity index 100%
rename from src/public/app/doc_notes/en/User Guide/User Guide/Scripting/Using promoted attributes .png
rename to src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/Examples/Using promoted attributes .png
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/Examples/Using promoted attributes to c.html b/src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/Examples/Using promoted attributes to c.html
new file mode 100644
index 000000000..e8e66b041
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/Examples/Using promoted attributes to c.html
@@ -0,0 +1,64 @@
+
+
+
+
+
+
+
+ Using promoted attributes to configure scripts
+
+
+
+
+
Using promoted attributes to configure scripts
+
+
+
+
+
A good use case of promoted attributes is to easily define the various
+ parameters a script might need, for example an input and output note if
+ it's processing data, or a checkbox to define a particular change in behavior
+ for the script.
+
+
+
+
Using check boxes to toggle flags
+
Instead of asking the user to modify a boolean value in the script, it's
+ much more intuitive to use a checkbox for it as a promoted attribute.
+
To do so, first define the promoted attribute:
#label:groupByExtension="promoted,alias=Group by extension,single,boolean"
This will work equally well in both front-end and back-end scripts.
+
Using relations to select notes
+
One common use case for a script is to read data from another note and
+ perhaps output its result in another note. To do so we need to define the
+ following promoted attributes:
Note that here we are using api.showError which is only available
+ for frontend notes. If you are writing a backend note, simply remove api.showError but
+ the user will no feedback on why the script did not execute properly.
+
Afterwards we can simply read the note and do something with it:
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/Frontend Basics.html b/src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/Frontend Basics.html
new file mode 100644
index 000000000..772e7a685
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/Frontend Basics.html
@@ -0,0 +1,103 @@
+
+
+
+
+
+
+
+ Frontend Basics
+
+
+
+
+
Frontend Basics
+
+
+
Frontend API
+
The frontend api supports two styles, regular scripts that are run with
+ the current app and note context, and widgets that export an object to
+ Trilium to be used in the UI. In both cases, the frontend api of Trilium
+ is available to scripts running in the frontend context as global variable api.
+ The members and methods of the api can be seen on the Script API page.
+
Scripts
+
Scripts don't have any special requirements. They can be run at will using
+ the execute button in the UI or they can be configured to run at certain
+ times using Attributes on
+ the note containing the script.
+
Global Events
+
This attribute is called #run and it can have any of the following
+ values:
+
+
frontendStartup - executes on frontend upon startup.
+
mobileStartup - executes on mobile frontend upon startup.
+
backendStartup - executes on backend upon startup.
+
hourly - executes once an hour on backend.
+
daily - executes once a day on backend.
+
+
Entity Events
+
These events are triggered by certain relations to
+ other notes. Meaning that the script is triggered only if the note has
+ this script attached to it through relations (or it can inherit it).
+
+
runOnNoteCreation - executes when note is created on backend.
+
runOnNoteTitleChange - executes when note title is changed
+ (includes note creation as well).
+
runOnNoteContentChange - executes when note content is changed
+ (includes note creation as well).
+
runOnNoteChange - executes when note is changed (includes
+ note creation as well).
+
runOnNoteDeletion - executes when note is being deleted.
+
runOnBranchCreation - executes when a branch is created. Branch
+ is a link between parent note and child note and is created e.g. when cloning
+ or moving note.
+
runOnBranchDeletion - executes when a branch is delete. Branch
+ is a link between parent note and child note and is deleted e.g. when moving
+ note (old branch/link is deleted).
+
runOnChildNoteCreation - executes when new note is created
+ under this note.
+
runOnAttributeCreation - executes when new attribute is created
+ under this note.
+
runOnAttributeChange - executes when attribute is changed
+ under this note.
+
+
Widgets
+
Conversely to scripts, widgets do have some specific requirements in order
+ to work. A widget must:
This guide will walk you through creating a basic widget inside Trilium.
+ By following these steps, you'll learn how to build a simple UI element
+ that interacts with the user.
+
Step 1: The Basic Widget Structure
+
To start, we'll create the most basic widget possible. Here's a simple
+ example:
class MyWidget extends api.BasicWidget {
+ get position() { return 1; }
+ get parentWidget() { return "left-pane"; }
+
+ doRender() {
+ this.$widget = $("");
+ return this.$widget;
+ }
+}
+
+module.exports = new MyWidget();
+
To implement this widget:
+
+
Create a new JS Frontend note in Trilium and paste in the code
+ above.
To verify that the widget is working, open the developer tools (Cmd + Shift + I)
+ and run document.querySelector("#my-widget"). If the element
+ is found, the widget is functioning correctly. If undefined is
+ returned, double-check that the note has
+ the #widgetattribute.
+
Step 2: Adding an UI Element
+
Next, let's improve the widget by adding a button to it.
After making this change, reload Trilium. You should now see a button
+ in the top-left corner of the left pane.
+
Step 3: Styling the Widget
+
To make the button more visually appealing and position it correctly,
+ we'll apply some custom styling. Trilium includes Box Icons,
+ which we'll use to replace the button text with an icon. For example the bx bxs-magic-wand icon.
+
Here's the updated template:
const template = ``;
+
Next, we'll adjust the button's position using CSS:
Reload the application one last time. When you click the button, a "Hello
+ World!" message should appear, confirming that your widget is fully functional.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/FAQ.html b/src/public/app/doc_notes/en/User Guide/User Guide/FAQ.html
new file mode 100644
index 000000000..32c4ed9ed
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/FAQ.html
@@ -0,0 +1,108 @@
+
+
+
+
+
+
+
+ FAQ
+
+
+
+
+
FAQ
+
+
+
Mac OS support
+
Originally, desktop builds of Trilium Notes has been available for Windows
+ & Linux, but there has been a considerable demand for macOS build.
+
So I made one, but I underestimated the differences and specifics of Mac
+ platform which seems to require special handling in several places. My
+ lack of knowledge and frankly willingness to learn & code Mac specific
+ functionality resulted in a current state where Trilium does not integrate well into the OS
+
%%{WARNING}%%.
+
macOS build is from now on considered "unsupported". I will strive to
+ keep it fundamentally functional, but I won't work on Mac specific features
+ or integrations. Note that this is more of an acknowledgment of an existing
+ state rather than sudden change of direction.
+
Of course, PRs are welcome.
+
Translation / localization support
+
Trilium is currently available only in English. Translation to other languages
+ is not planned in the near/medium term because it brings a significant
+ maintenance overhead. This decision might be revisited once Trilium stabilizes
+ into a more mature product.
+
For Chinese, there's an unofficial fork here.
+ Use at your own risk.
+
Multi user support
+
Common request is to allow multiple users collaborate, share notes etc.
+ So far I'm resisting this because of these reasons:
+
+
it's a huge feature, or rather a Pandora's box of collaboration features
+ like user management, permissions, conflict resolution, real-time editing
+ of a note by multiple people etc. This would be a huge amount of work.
+ Trilium Notes is project made mostly by one person in free time and that's
+ unlikely to change in the future.
+
given its size it would probably pivot the attention away from my main
+ focus which is a personal note-taking
+
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
+ scriptingsupport would be a XSS security hole, while with the single
+ user assumption it's an endless customizable tool.
+
+
How to open multiple documents in one Trilium instance
+
This is normally not supported - one Trilium process can open only a single
+ instance of a database. 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 data directory in
+ the TRILIUM_DATA_DIR environment variable and separate port
+ on TRILIUM_PORT environment variable. How to do that depends
+ on the platform, in Unix-based systems you can achieve that by running
+ command such as this:
You can save this command into a .sh script file or make an
+ alias. Do this similarly for a second instance with different data directory
+ and port.
+
Can I use Dropbox / Google Drive / OneDrive to sync data across multiple computers.
+
No.
+
These general purpose sync apps are not suitable to sync database files
+ which are open and being worked on by another application. The result is
+ that they will corrupt the database file, resulting in data loss and this
+ message in the Trilium logs:
+
+
SqliteError: database disk image is malformed
+
+
The only supported way to sync Trilium's data across the network is to
+ use a sync/web server.
+
Why database instead of flat files?
+
Trilium stores notes in a database 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.
+
Short answer is that file systems are simply not powerful enough for what
+ we want to achieve with Trilium. Using filesystem would mean fewer features
+ with probably more problems.
+
More detailed answer:
+
+
clones are what
+ you might call "hard directory link" in filesystem lingo, but this concept
+ is not implemented in any filesystem
+
filesystems make a distinction between directory and file while there's
+ intentionally no such difference in Trilium
+
files are stored in no particular order and user can't change this
+
Trilium allows storing note attributes which
+ could be represented in extended user attributes but their support differs
+ greatly among different filesystems / operating systems
+
Trilium makes links / relations between different notes which can be quickly
+ retrieved / navigated (e.g. for note map).
+ 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).
+
Filesystems are generally not transactional. While this is not completely
+ required for a note-taking application, having transactions make it way
+ easier to keep notes and their metadata in predictable and consistent state.
+
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Backup.html b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Backup.html
new file mode 100644
index 000000000..0bbd775ca
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Backup.html
@@ -0,0 +1,72 @@
+
+
+
+
+
+
+
+ Backup
+
+
+
+
+
Backup
+
+
+
Trilium supports simple backup scheme where it saves copy of the document on
+ these events:
+
+
once a day
+
once a week
+
once a month
+
before DB migration to newer version
+
+
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 backup directory placed in the data directory.
+
This is only very basic backup solution, and you're encouraged to add
+ some better backup solution - e.g. backing up the document to
+ cloud / different computer etc.
+
Note that synchronization provides also
+ some backup capabilities by its nature of distributing the data to other
+ computers.
+
Restoring backup
+
Let's assume you want to restore the weekly backup, here's how to do it:
+
+
find data directory Trilium uses - easy
+ way is to open "About Trilium Notes" from "Menu" in upper left corner and
+ looking at "data directory"
+
+
I'll refer to ~/trilium-data as data directory from now on
+
+
+
find ~/trilium-data/backup/backup-weekly.db - this is the
+ documentbackup
+
at this point stop/kill Trilium
+
delete ~/trilium-data/document.db, ~/trilium-data/document.db-wal and ~/trilium-data/document.db-shm (latter
+ two files are auto generated)
+
copy and rename this ~/trilium-data/backup/backup-weekly.db to ~/trilium-data/document.db
+
+
make sure that the file is writable, e.g. with chmod 600 document.db
+
+
start Trilium again
+
+
If you have configured sync then you need to do it across all members
+ of the sync cluster, otherwise older version (restored backup) of the document
+ will be detected and synced to the newer version.
+
Disabling backup
+
Although this is not recommended, it is possible to disable backup in config.ini in
+ the data directory:
[General]
+... some other configs
+# set to true to disable backups (e.g. because of limited space on server)
+noBackup=true
+
You can also review the configuration file
+ to provide all config.ini values as environment variables instead.
config.ini - instance level settings like port on which the
+ Trilium application runs
+
backup - contains automatically backup of
+ documents
+
log - contains application log files
+
+
Location
+
Easy way how to find out which data directory Trilium uses is to look
+ at the "About Trilium Notes" dialog (from "Menu" in upper left corner):
+
+
+
+
Here's how the location is decided:
+
Data directory is normally named trilium-data and it is stored
+ in:
+
+
/home/[user]/.local/share for Linux
+
C:\Users\[user]\AppData\Roaming for Windows Vista and up
+
/Users/[user]/Library/Application Support for Mac OS
+
user's home is a fallback if some of the paths above don't exist
+
user's home is also a default setup for [[docker|Docker server installation]]
+
+
If you want to back up your Trilium data, just backup this single directory
+ - it contains everything you need.
+
Changing the location of data directory
+
If you want to use some other location for the data directory than the
+ default one, you may change it via TRILIUM_DATA_DIR environment variable
+ to some other location:
Create a script to run with specific data directory
+
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 database instances
+ or "portable" installation.
+
To do this in unix based systems simply run trilium like this:
You can then save the above command as a shell script on your path for
+ convenience.
+
Fine-grained directory/path location
+
It's possible to configure e.g. backup and log directories separately,
+ with following environment variables:
+
+
TRILIUM_DOCUMENT_PATH
+
+
TRILIUM_BACKUP_DIR
+
+
TRILIUM_LOG_DIR
+
+
TRILIUM_ANONYMIZED_DB_DIR
+
+
TRILIUM_CONFIG_INI_PATH
+
+
+
If these are not set, default paths within the data directory will be
+ used.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Data directory_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Data directory_image.png
new file mode 100644
index 000000000..823c6ceac
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Data directory_image.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Desktop Installation.html b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Desktop Installation.html
new file mode 100644
index 000000000..bbfde843e
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Desktop Installation.html
@@ -0,0 +1,52 @@
+
+
+
+
+
+
+
+ Desktop Installation
+
+
+
+
+
Desktop Installation
+
+
+
To install Trilium on your desktop, follow these steps:
+
+
Download the Latest Release: Obtain the appropriate binary
+ release for your operating system from the latest release page on
+ GitHub.
+
Extract the Package: Unzip the downloaded package to
+ a location of your choice.
+
Run the Application: Launch Trilium by executing the trilium executable
+ found within the unzipped folder.
+
+
Startup Scripts
+
Trilium offers various startup scripts to customize your experience:
+
+
trilium-no-cert-check: Starts Trilium without
+ validating TLS certificates,
+ useful if connecting to a server with a self-signed certificate.
+
+
Alternatively, set the NODE_TLS_REJECT_UNAUTHORIZED=0 environment
+ variable before starting Trilium.
+
+
+
trilium-portable: Launches Trilium in portable
+ mode, where the data directory is created
+ within the application's directory, making it easy to move the entire setup.
+
trilium-safe-mode: Boots Trilium in "safe
+ mode," disabling any startup scripts that might cause the application to
+ crash.
+
+
Synchronization
+
For Trilium desktp users who wish to synchronize their data with a server
+ instance, refer to the Synchronization Guide for
+ detailed instructions.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Mobile Frontend.html b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Mobile Frontend.html
new file mode 100644
index 000000000..7faf59aba
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Mobile Frontend.html
@@ -0,0 +1,57 @@
+
+
+
+
+
+
+
+ Mobile Frontend
+
+
+
+
+
Mobile Frontend
+
+
+
Trilium (server edition) 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.
+
Mobile frontend is limited in features compared to full desktop frontend.
+ See below for more details on this.
+
Note that this is not an Android/iOS app, this is just mobile friendly
+ web page served on the server edition.
+
Screenshots
+
Mobile phone
+
+
+
+
Tablet
+
+
+
+
Limitations
+
Mobile frontend provides only some of the features of the full desktop
+ frontend:
+
+
it is possible to browse the whole note tree, read and edit all types
+ of notes, but you can create only text notes
+
reading and editing protected notes is
+ possible, but creating them is not supported
+
editing options is not supported
+
cloning notes is not supported
+
uploading file attachments is not supported
+
+
Forcing mobile/desktop frontend
+
Trilium decides automatically whether to use mobile or desktop frontend.
+ If this is not appropriate, you can use ?mobile or ?desktop query
+ param on login page (Note: you might need to log out).
+
Scripting
+
You can alter the behavior with scripts just
+ like for normal frontend. For script notes to be executed, they need to
+ have labeled #run=mobileStartup.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation.html b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation.html
new file mode 100644
index 000000000..827262152
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation.html
@@ -0,0 +1,80 @@
+
+
+
+
+
+
+
+ Server Installation
+
+
+
+
+
Server Installation
+
+
+
This guide outlines the steps to install Trilium on your own server. You
+ might consider this option if you want to set up synchronization or
+ use Trilium in a browser - accessible from anywhere.
+
Installation Options
+
There are several ways to install Trilium on a server, each with its own
+ advantages:
+
+
Recommended: Docker Installation -
+ Available for AMD64 and ARM architectures.
After setting up your server installation, you may want to configure settings
+ such as the port or enable TLS.
+ Configuration is managed via the Trilium config.ini file, which
+ is located in the data directory by default.
+ To begin customizing your setup, copy the provided config-sample.ini file
+ with default values to config.ini.
+
You can also review the configuration file
+ to provide all config.ini values as environment variables instead.
+
Config Location
+
By default, config.ini, the database,
+ and other important Trilium data files are stored in the data directory.
+ If you prefer a different location, you can change it by setting the TRILIUM_DATA_DIR environment
+ variable:
If you are running Trilium on localhost only or if authentication is handled
+ by another component, you can disable Trilium’s authentication by adding
+ the following to config.ini:
[General]
+noAuthentication=true
+
Reverse Proxy Setup
+
To configure a reverse proxy for Trilium, you can use either nginx or Apache.
+
nginx
+
Add the following configuration to your nginx setup to proxy
+ requests to Trilium:
[!WARNING] If you're using a SMB/CIFS share or folder as your Trilium
+ data directory, you'll need to
+ add the mount options of nobrl and noperm when mounting
+ your SMB share.
Optionally, edit the docker-compose.yml file to configure the
+ container settings prior to starting it. Unless configured otherwise, the
+ data directory will be ~/trilium-data and the container will
+ be accessible at port 8080.
+
Start the container:
+
Run the following command to start the container in the background:
docker compose up -d
+
Running without Docker Compose / Further Configuration
+
Pulling the Docker Image
+
To pull the image, use the following command, replacing [VERSION] with
+ the desired version or tag, such as v0.91.6 or just latest.
+ (See published tag names at https://hub.docker.com/r/triliumnext/notes/tags.):
docker pull triliumnext/notes:v0.91.6
+
Warning: Avoid using the "latest" tag, as it may automatically
+ upgrade your instance to a new minor version, potentially disrupting sync
+ setups or causing other issues.
+
Preparing the Data Directory
+
Trilium requires a directory on the host system to store its data. This
+ directory must be mounted into the Docker container with write permissions.
+
Running the Docker Container
+
Local Access Only
+
Run the container to make it accessible only from the localhost. This
+ setup is suitable for testing or when using a proxy server like Nginx or
+ Apache.
sudo docker run -t -i -p 127.0.0.1:8080:8080 -v ~/trilium-data:/home/node/trilium-data triliumnext/notes:[VERSION]
+
+
Verify the container is running using docker ps.
+
Access Trilium via a web browser at 127.0.0.1:8080.
+
+
Local Network Access
+
To make the container accessible only on your local network, first create
+ a new Docker network:
If you want to run your instance in a non-default way, please use the
+ volume switch as follows: -v ~/YourOwnDirectory:/home/node/trilium-data triliumnext/notes:<VERSION>.
+ It is important to be aware of how Docker works for volumes, with the first
+ path being your own and the second the one to virtually bind to. https://docs.docker.com/storage/volumes/ The
+ path before the colon is the host directory, and the path after the colon
+ is the container's path. More details can be found in the Docker Volumes Documentation.
The --user directive is unsupported. Instead, use the USER_UID and USER_GID environment
+ variables to set the appropriate user and group IDs.
+
Note on timezones
+
If you are having timezone issues and you are not using docker-compose,
+ you may need to add a TZ environment variable with the TZ identifier of
+ your local timezone.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Kubernetes server installation.html b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Kubernetes server installation.html
new file mode 100644
index 000000000..4a78feb28
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Kubernetes server installation.html
@@ -0,0 +1,54 @@
+
+
+
+
+
+
+
+ Kubernetes server installation
+
+
+
+
+
Kubernetes server installation
+
+
+
As Trilium can be run in Docker it also can be deployed in Kubernetes.
+ You can either use our Helm chart, a community Helm chart, or roll your
+ own Kubernetes deployment.
+
The recommended way is to use a Helm chart.
+
Root privileges
+
+
[!NOTE]
+ The Trilium container at this time needs to be run with root privileges.
+ It will swap to UID and GID 1000:1000 to run the node process
+ after execution though, so the main process doesn't run with root privileges.
+
+
The Trilium docker container needs to be run with root privileges. The
+ node process inside the container will be started with reduced privileges
+ (uid:gid 1000:1000) after some initialization logic. Please make sure that
+ you don't use a security context (PodSecurityContext) which changes the
+ user ID. To use a different uid:gid for file storage and the application,
+ please use the USER_UID & USER_GID environment
+ variables.
+
The docker image will also fix the permissions of /home/node so
+ you don't have to use an init container.
For more information on using Helm, please refer to the Helm documentation,
+ or create a Discussion in the TriliumNext GitHub Organization.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Manual server installation.html b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Manual server installation.html
new file mode 100644
index 000000000..48df65ee9
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Manual server installation.html
@@ -0,0 +1,58 @@
+
+
+
+
+
+
+
+ Manual server installation
+
+
+
+
+
Manual server installation
+
+
+
This page describes manually installing Trilium on your server. Note that this is a not well supported way to install Trilium, problems may appear, information laid out here is quite out of date. It is recommended to use either Docker or packaged build installation.
+
+
Requirements
+
Trilium is a node.js application. Supported (tested) version of node.js
+ is latest 14.X.X and 16.X.X. Trilium might work with older versions as
+ well.
+
You can check your node version with this command (node.js needs to be
+ installed):
node --version
+
If your Linux distribution has only an outdated version of node.js, you
+ can take a look at the installation instruction on node.js website, which
+ covers most popular distributions.
+
Dependencies
+
There are some dependencies required. You can see command for Debian and
+ its derivatives (like Ubuntu) below:
cd trilium
+
+# download all node dependencies
+npm install
+
+# make sure the better-sqlite3 binary is there
+npm rebuild
+
+# bundles & minifies frontend JavaScript
+npm run webpack
+
Run
cd trilium
+
+# using nohup to make sure trilium keeps running after user logs out
+nohup TRILIUM_ENV=dev node src/www &
+
The application by default starts up on port 8080, so you can open your
+ browser and navigate to http://localhost:8080 to
+ access Trilium (replace "localhost" with your hostname).
+
TLS
+
Don't forget to configure TLS which
+ is required for secure usage!
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/NixOS server installation.html b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/NixOS server installation.html
new file mode 100644
index 000000000..42a882596
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/NixOS server installation.html
@@ -0,0 +1,35 @@
+
+
+
+
+
+
+
+ NixOS server installation
+
+
+
+
+
NixOS server installation
+
+
+
This page describes configuring the Trilium module included in NixOS.
unpack the archive, e.g. using tar -xf -d trilium-linux-x64-server-[VERSION].tar.xz
+
+
cd trilium-linux-x64-server
+
+
./trilium.sh
+
+
you can open the browser and open http://[your-server-hostname]:8080 and
+ you should see Trilium initialization page
+
+
The problem with above steps is that once you close the SSH connection,
+ the Trilium process is terminated. To avoid that, you have two options:
+
+
Kill it (with e.g. CTRL-C) and run again like this: nohup ./trilium &.
+
Configure systemd to automatically run Trilium in the background on every
+ boot
+
+
Configure Trilium to auto-run on boot with systemd
+
+
After downloading, extract and move Trilium:
+
tar -xvf trilium-linux-x64-server-[VERSION].tar.xz
+sudo mv trilium-linux-x64-server /opt/trilium
+
+
Create the service:
+
sudo nano /etc/systemd/system/trilium.service
+
+
Paste this into the file (replace the user and group as needed):
+
[Unit]
+Description=Trilium Daemon
+After=syslog.target network.target
+
+[Service]
+User=xxx
+Group=xxx
+Type=simple
+ExecStart=/opt/trilium/trilium.sh
+WorkingDirectory=/opt/trilium/
+
+TimeoutStopSec=20
+# KillMode=process leads to error, according to https://www.freedesktop.org/software/systemd/man/systemd.kill.html
+Restart=always
+
+[Install]
+WantedBy=multi-user.target
+
+
Save the file (CTRL-S) and exit (CTRL-X)
+
Enable and launch the service:
+
sudo systemctl enable --now -q trilium
+
+
You can now open a browser to http://[your-server-hostname]:8080 and you
+ should see the Trilium initialization page.
+
+
Common issues
+
Outdated glibc
Error: /usr/lib64/libstdc++.so.6: version `GLIBCXX_3.4.21' not found (required by /var/www/virtual/.../node_modules/@mlink/scrypt/build/Release/scrypt.node)
+ at Object.Module._extensions..node (module.js:681:18)
+ at Module.load (module.js:565:32)
+ at tryModuleLoad (module.js:505:12)
+
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 server installation method.
+
TLS
+
Don't forget to configure TLS,
+ which is required for secure usage!
Fill the file with the context shown below, part of the setting show be
+ changed. Then you can enjoy your web with HTTPS forced and proxy.
+
# This part is for proxy and HTTPS configure
+server {
+ listen 443 ssl;
+ server_name trilium.example.net; #change trilium.example.net to your domain without HTTPS or HTTP.
+ ssl_certificate /etc/ssl/note/example.crt; #change /etc/ssl/note/example.crt to your path of crt file.
+ ssl_certificate_key /etc/ssl/note/example.net.key; #change /etc/ssl/note/example.net.key to your path of key file.
+ ssl_session_cache builtin:1000 shared:SSL:10m;
+ ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
+ ssl_ciphers HIGH:!aNULL:!eNULL:!EXPORT:!CAMELLIA:!DES:!MD5:!PSK:!RC4;
+ ssl_prefer_server_ciphers on;
+ access_log /var/log/nginx/access.log; #check the path of access.log, if it doesn't fit your file, change it
+
+ location / {
+ proxy_set_header Host $host;
+ proxy_set_header X-Real-IP $remote_addr;
+ proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+ proxy_set_header X-Forwarded-Proto $scheme;
+ proxy_set_header Upgrade $http_upgrade;
+ proxy_set_header Connection "upgrade";
+ proxy_pass http://127.0.0.1:8080; # change it to a different port if non-default is used
+ proxy_read_timeout 90;
+ proxy_redirect http://127.0.0.1:8080 https://trilium.example.net; # change them based on your IP, port and domain
+ }
+}
+# This part is for HTTPS forced
+server {
+ listen 80;
+ server_name trilium.example.net; # change to your domain
+ return 301 https://$server_name$request_uri;
+}
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/Multi-Factor Authentication.html b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/Multi-Factor Authentication.html
new file mode 100644
index 000000000..e48742fe5
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/Multi-Factor Authentication.html
@@ -0,0 +1,88 @@
+
+
+
+
+
+
+
+ Multi-Factor Authentication
+
+
+
+
+
Multi-Factor Authentication
+
+
+
Note: This feature has not been merged yet, so it is not available.
+
+
Multi-factor authentication (MFA) is a security process that requires
+ users to provide two or more verification factors to gain access to a system,
+ application, or account. This adds an extra layer of protection beyond
+ just using a password.
+
By requiring more than one verification method, MFA helps reduce the risk
+ of unauthorized access, even if someone has obtained your password. It’s
+ highly recommended for securing sensitive information stored in your notes.
+
Warning! OpenID and TOTP cannot be both used at the same time!
+
Log in with your Google Account with OpenID!
+
OpenID is a standardized way to let you log into websites using an account
+ from another service, like Google, to verify your identity.
+
Why Time-based One Time Passwords?
+
TOTP (Time-Based One-Time Password) is a security feature that generates
+ a unique, temporary code on your device, like a smartphone, which changes
+ every 30 seconds. You use this code, along with your password, to log into
+ your account, making it much harder for anyone else to access them.
+
Setup
+
TOTP
+
+
Start Trilium Notes normally.
+
Go to "Menu" -> "Options" -> "MFA"
+
Click the "Generate TOTP Secret" button
+
Copy the generated secret to your authentication app/extension
+
+
Set an environment variable "TOTP_SECRET" as the generated secret. Environment
+ variables can be set with a .env file in the root directory, by defining
+ them in the command line, or with a docker container.
# .env in the project root directory
+TOTP_ENABLED="true"
+TOTP_SECRET="secret"
Save the recovery codes. Recovery codes can be used once in place of the
+ TOTP if you loose access to your authenticator. After a rerecovery code
+ is used, it will show the unix timestamp when it was used in the MFA options
+ tab.
+
Load the secret into an authentication app like google authenticator
+
+
OpenID
+
Currently only compatible with Google. Other services like Authentik and Auth0 are planned on being added.
+
+
In order to setup OpenID, you will need to setup a authentication provider.
+ This requires a bit of extra setup. Follow these instructions to
+ setup an OpenID service through google.
+
Set an environment variable "SSO_ENABLED" to true and add the client ID
+ and secret you obtained from google. Environment variables can be set with
+ a .env file in the root directory, by defining them in the command line,
+ or with a docker container.
+
.env File
# .env in the project root directory
+SSO_ENABLED="true"
+BASE_URL="http://localhost:8080"
+CLIENT_ID=
+SECRET=
After you restart Trilium Notes, you will be redirected to Google's account
+ selection page. Login to an account and Trilium Next will bind to that
+ account, allowing you to login with it.
+
You can now login using your google account.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagram.html b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/Reverse proxy setup.html
similarity index 61%
rename from src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagram.html
rename to src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/Reverse proxy setup.html
index bbe5d76cc..2a0e9d453 100644
--- a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagram.html
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/Reverse proxy setup.html
@@ -3,14 +3,14 @@
-
+
- Mermaid Diagram
+ Reverse proxy setup
Configuring TLS is essential for server installation in
+ Trilium. This guide details the steps to set up TLS within Trilium itself.
+
For a more robust solution, consider using TLS termination with a reverse
+ proxy (recommended, e.g., Nginx). You can follow a guide like this for
+ such setups.
+
Obtaining a TLS Certificate
+
You have two options for obtaining a TLS certificate:
+
+
Recommended: Obtain a TLS certificate signed by a root
+ certificate authority. For personal use, Let's Encrypt is
+ an excellent choice. It is free, automated, and straightforward. Certbot
+ can facilitate automatic TLS setup.
+
Generate a self-signed certificate. This option is not recommended due
+ to the additional complexity of importing the certificate into all machines
+ connecting to the server.
+
+
Modifying config.ini
+
Once you have your certificate, modify the config.ini file
+ in the data directory to configure
+ Trilium to use it:
[Network]
+port=8080
+# Set to true for TLS/SSL/HTTPS (secure), false for HTTP (insecure).
+https=true
+# Path to the certificate (run "bash bin/generate-cert.sh" to generate a self-signed certificate).
+# Relevant only if https=true
+certPath=/[username]/.acme.sh/[hostname]/fullchain.cer
+keyPath=/[username]/.acme.sh/[hostname]/example.com.key
+
You can also review the configuration file
+ to provide all config.ini values as environment variables instead.
+
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
+ may differ. For Docker installations, ensure these paths are within a volume
+ or another directory accessible by the Docker container, such as /home/node/trilium-data/[DIR IN DATA DIRECTORY].
+
After configuring config.ini, restart Trilium and access the
+ hostname using "https".
+
Self-Signed Certificate
+
If you opt to use a self-signed certificate for your server instance,
+ note that the desktop instance will not trust it by default.
+
To bypass this, disable certificate validation by setting the following
+ environment variable (for Linux):
export NODE_TLS_REJECT_UNAUTHORIZED=0
+trilium
+
Trilium provides scripts to start in this mode, such as trilium-no-cert-check.bat for
+ Windows.
+
Warning: Disabling TLS certificate validation is insecure.
+ Proceed only if you fully understand the implications.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Synchronization.html b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Synchronization.html
new file mode 100644
index 000000000..2c2e28abf
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Synchronization.html
@@ -0,0 +1,112 @@
+
+
+
+
+
+
+
+ Synchronization
+
+
+
+
+
Synchronization
+
+
+
Trilium is an offline-first note-taking application that stores all data
+ locally on the desktop client. However, it also offers the option to set
+ up synchronization with a server instance, allowing multiple desktop clients
+ to sync with a central server. This creates a star-shaped topology:
+
+
+
+
In this setup, a central server (referred to as the sync server)
+ and multiple client (or desktop) instances synchronize with
+ the sync server. Once configured, synchronization is automatic and ongoing,
+ requiring no manual intervention.
+
Setting Up Synchronization
+
Security Considerations
+
Setting up the server securely is critical and can be complex. It is crucial
+ to use a valid TLS certificate (HTTPS)
+ rather than an unencrypted HTTP connection to ensure security and avoid
+ potential vulnerabilities.
+
Synchronizing a Desktop Instance with a Sync Server
+
This method is used when you already have a desktop instance of Trilium
+ and want to set up a sync server on your web host.
+
+
Server Deployment: Ensure your server instance is deployed
+ but uninitialized.
+
Desktop Configuration: Open your desktop instance, navigate
+ to Options -> Sync tab -> Sync configuration, and set the "Server
+ instance address" to your sync server's address. Click Save.
+
+
+
+
+
+
Testing Sync: Click the "Test sync" button to verify
+ the connection to the sync server. If successful, the client will start
+ pushing all data to the server instance. This process may take some time,
+ but you can continue using Trilium. Periodically check the server instance
+ to confirm when the sync is complete. Once finished, you should see the
+ login screen on the server.
+
+
Synchronizing a Desktop Instance from a Sync Server
+
This method is used when you already have a sync server and want to configure
+ a new desktop instance to sync with it.
Initial Configuration: When prompted, choose the option
+ to set up sync with a sync server.
+
+
+
+
+
+
Server Details: Configure the Trilium server address
+ and enter the correct username and password for authentication.
+
Finish Setup: Click the "Finish setup" button. If successful,
+ you will see the following screen:
+
+
+
+
+
Once synchronization is complete, you will be automatically redirected
+ to the Trilium application.
+
Proxy Configuration
+
Two proxy setups are supported:
+
+
Explicit Proxy Configuration: Set the proxy server in
+ Options / Sync. Only unauthenticated proxy servers are supported.
+
System Proxy Settings: If no proxy server is explicitly
+ configured, Trilium will use the system proxy settings.
+
+
Troubleshooting
+
Date/Time Synchronization
+
For successful synchronization, both client and server must have the same
+ date and time, with a tolerance of up to five minutes.
+
Certificate Issues
+
When using TLS, Trilium will verify the server certificate. If verification
+ fails (e.g., due to self-signed certificates or certain corporate proxies),
+ you can run the Trilium client with the NODE_TLS_REJECT_UNAUTHORIZED environment
+ variable set to 0:
export NODE_TLS_REJECT_UNAUTHORIZED=0
+
This will disable TLS certificate verification, significantly reducing
+ security and exposing the setup to MITM attacks. It is strongly recommended
+ to use a valid signed server certificate. Newer Trilium versions include
+ a script called trilium-no-cert-check.sh for this purpose.
+
Conflict Resolution
+
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 note revisions,
+ allowing data recovery if needed.
+
Hash Check
+
After each synchronization, Trilium computes a hash of all synced data
+ on both the client and the sync server. If there is a discrepancy, Trilium
+ will automatically initiate a recovery mechanism to resolve the issue.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Synchronization_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Synchronization_image.png
new file mode 100644
index 000000000..344262a9a
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Synchronization_image.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Upgrading TriliumNext.html b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Upgrading TriliumNext.html
new file mode 100644
index 000000000..234e0376a
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Upgrading TriliumNext.html
@@ -0,0 +1,45 @@
+
+
+
+
+
+
+
+ Upgrading TriliumNext
+
+
+
+
+
Upgrading TriliumNext
+
+
+
This document outlines the steps required to upgrade Trilium to a new
+ release version.
+
How to Upgrade
+
Trilium does not support built-in automatic upgrades; all updates must
+ be performed manually. The upgrade process varies depending on the installation
+ method:
Other Installations: Download the latest version from
+ the release page and
+ replace the existing application files.
+
+
Database Compatibility and Migration
+
Upon startup, Trilium will automatically migrate the database 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 backup that
+ is created prior to migration.
+
Sync Compatibility
+
The synchronization 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.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Web Clipper.html b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Web Clipper.html
new file mode 100644
index 000000000..517d1130f
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Web Clipper.html
@@ -0,0 +1,62 @@
+
+
+
+
+
+
+
+ Web Clipper
+
+
+
+
+
Web Clipper
+
+
+
+
+
+
Trilium Web Clipper is a web browser extension which allows user to clip
+ text, screenshots, whole pages and short notes and save them directly to
+ Trilium Notes.
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.
+
It's also possible to configure the server address
+ if you don't run the desktop application, or want it to work without the
+ desktop application running.
+
Username
+
Older versions of Trilium (before 0.50) required username & password
+ to authenticate, but this is no longer the case. You may enter anything
+ in that field, it will not have any effect.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Web Clipper_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Web Clipper_image.png
new file mode 100644
index 000000000..96d6ead20
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Web Clipper_image.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/Export as PDF.html b/src/public/app/doc_notes/en/User Guide/User Guide/New Features/Export as PDF.html
deleted file mode 100644
index f6d2e62c3..000000000
--- a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/Export as PDF.html
+++ /dev/null
@@ -1,55 +0,0 @@
-
-
-
-
-
-
-
- Export as PDF
-
-
-
-
-
Export as PDF
-
-
-
-
- Screenshot of the note contextual menu indicating the “Export as PDF”
- option.
-
-
On the desktop application of Trilium it is possible to export a note
- as PDF. On the server or PWA (mobile), the option is not available due
- to technical constraints and it will be hidden.
-
To print a note, select the
- button to the right of the note and select Export as PDF.
-
Afterwards you will be prompted to select where to save the PDF file.
- Upon confirmation, the resulting PDF will be opened automatically using
- the default/system application configured for PDFs.
-
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
- report the issue. In this case, it's best to offer a sample note (click
- on the
- button, select Export note → This note and all of its descendants → HTML
- in ZIP archive). Make sure not to accidentally leak any personal information.
-
Landscape mode
-
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 #printLandscape attribute
- to it (see Adding an attribute to a note).
-
Page size
-
By default, the resulting PDF will be in Letter format. It is possible
- to adjust it to another page size via the #printPageSize attribute,
- with one of the following values: A0, A1, A2, A3, A4, A5, A6, Legal, Letter, Tabloid, Ledger.
-
Keyboard shortcut
-
It's possible to trigger the export to PDF from the keyboard by going
- to Keyboard shortcuts and assigning a key combination
- for the exportAsPdf action.
-
-
-
-
-
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/Right-to-left text notes.html b/src/public/app/doc_notes/en/User Guide/User Guide/New Features/Right-to-left text notes.html
deleted file mode 100644
index 58ec7cb03..000000000
--- a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/Right-to-left text notes.html
+++ /dev/null
@@ -1,56 +0,0 @@
-
-
-
-
-
-
-
- Right-to-left text notes
-
-
-
-
-
Right-to-left text notes
-
-
-
Trilium now has basic support for right-to-left text, at note level.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Note that only the Text note type supports this.
-
The list of languages is configurable via the a new dedicated settings
- page:
-
-
-
-
To select the corresponding language of the text, go to “Basic Properties”
- and select your desired language.
-
-
-
-
Feel free to report any issues regarding right to left support.
-
-
-
-
-
-
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/Zen mode.html b/src/public/app/doc_notes/en/User Guide/User Guide/New Features/Zen mode.html
deleted file mode 100644
index 9792a7d32..000000000
--- a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/Zen mode.html
+++ /dev/null
@@ -1,73 +0,0 @@
-
-
-
-
-
-
-
- Zen mode
-
-
-
-
-
Zen mode
-
-
-
-
- Screenshot of Zen Mode activated on a Windows 11 system with native title
- bar off and background effects on.
-
-
When Zen Mode is activated (pictured on the side), most of the user interface
- of Trilium is hidden away in order to be able to focus on the content,
- whether it's for reading or writing.
-
-
- Screenshot of the Zen Mode option in the global menu.
-
-
Activating & deactivating
-
The Zen Mode can be activated by accessing the global menu and selecting
- the “Zen Mode” option:
-
Aside from the global menu, it's also possible to activate this mode by
- using a keyboard shortcut which is Alt+Z by default. Look for toggleZenMode in
- the shortcut configuration.
-
Once Zen Mode is activated, all the UI elements of the application will
- be hidden away, including the global menu. In that case, the Zen Mode can
- be deactivated either by pressing the
- icon in the top-right corner of the window or by pressing the keyboard
- combination again.
-
Do note that, by design, activating or deactivating the Zen Mode applies
- only to the current window. Restarting the application will also disable
- the Zen Mode.
-
Moving the window around
-
If “Native title bar” is activated, then the operating system's default
- title bar can be used to drag the window around. If deactivated, the window
- can still be moved by dragging the mouse across the top part of the window
- where the note titles are.
-
-
- Screenshot of two notes side-by-side while Zen Mode is active, on Windows
- 11 with background effects off.
-
-
Split windows and tabs
-
Tabs are completely hidden, however it's still possible to use keyboard
- shortcuts such as firstTab (Ctrl+1 by default), secondTab (Ctrl+2
- by default). There are also some newer shortcuts such as activateNextTab (Ctrl+Tab)
- or activatePreviousTab (Ctrl+Shift+Tab) that allow easy navigation,
- however make sure that they are configured properly in the settings.
-
For the split view of notes, there are no keyboard shortcuts at the time
- of writing, but it's still possible to have them in Zen Mode by creating
- the split while the Zen Mode is off and then reactivating it afterwards.
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/1_Book_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/1_Book_image.png
new file mode 100644
index 000000000..ba4e1dd7a
Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/1_Book_image.png differ
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book.html b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book.html
new file mode 100644
index 000000000..2a61adf21
--- /dev/null
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book.html
@@ -0,0 +1,47 @@
+
+
+
+
+
+
+
+ Book
+
+
+
+
+
Book
+
+
+
A Book Note in Trilium is a special type of note 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.
+
+
+
+
In the example above, the "node.js" note on the left panel contains several
+ child notes. The right panel displays the content of these child notes
+ as a single continuous document.
+
Features
+
Linear Display
+
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.
+
Grid View Option
+
Trilium also offers a "Grid View" option within the Book Note properties.
+ This view presents the child notes in a grid format, allowing for a more
+ visual navigation experience.
+
+
+
+
Switching between these views can be easily managed through the Book Note's
+ settings (or viewType attribute), allowing users to choose the
+ format that best suits their reading or navigation preferences.
+
+
+
+
+
\ No newline at end of file
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/Calendar View.html b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/Calendar View.html
index d64ff6f88..3cc762eaa 100644
--- a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/Calendar View.html
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/Calendar View.html
@@ -13,324 +13,353 @@
Calendar View
-
-
-
-
The Calendar view of Book notes will display each child note in a calendar
- that has a start date and optionally an end date, as an event.
-
Unlike other Book view types, the Calendar view also allows some kind
- of interaction, such as moving events around as well as creating new ones.
-
Creating a calendar
-
-
-
-
-
-
-
-
-
-
1
-
-
-
-
-
-
-
-
The Calendar View works only for Book note types. To create a new note,
- right click on the note tree on the left and select Insert note after,
- or Insert child note and then select Book.
-
-
-
-
-
2
-
-
-
-
-
-
Once created, the “View type” of the Book needs changed to “Calendar”,
- by selecting the “Book Properties” tab in the ribbon.
-
-
-
-
-
Creating a new event/note
-
-
Clicking on a day will create a new child note and assign it to that particular
- day.
+
+
+
+
+
+
The Calendar view of Book notes will display each child note in a calendar
+ that has a start date and optionally an end date, as an event.
+
Unlike other Book view types, the Calendar view also allows some kind
+ of interaction, such as moving events around as well as creating new ones.
+
Creating a calendar
+
+
+
+
+
+
+
+
+
+
+
1
+
+
+
+
+
+
+
+
The Calendar View works only for Book note types. To create a new note,
+ right click on the note tree on the left and select Insert note after,
+ or Insert child note and then select Book.
+
+
+
+
+
2
+
+
+
+
+
+
Once created, the “View type” of the Book needs changed to “Calendar”,
+ by selecting the “Book Properties” tab in the ribbon.
+
+
+
+
+
Creating a new event/note
+
-
You will be asked for the name of the new note. If the popup is dismissed
- by pressing the close button or escape, then the note will not be created.
+
Clicking on a day will create a new child note and assign it to that particular
+ day.
+
+
You will be asked for the name of the new note. If the popup is dismissed
+ by pressing the close button or escape, then the note will not be created.
+
+
+
It's possible to drag across multiple days to set both the start and end
+ date of a particular note.
+
+
+
+
Creating new notes from the calendar will respect the ~child:template relation
+ if set on the book note.
-
-
It's possible to drag across multiple days to set both the start and end
- date of a particular note.
-
-
-
-
Creating new notes from the calendar will respect the ~child:template relation
- if set on the book note.
-
-
Interacting with events
-
-
Hovering the mouse over an event will display information about the note.
-
-
-
-
Left clicking the event will go to that note. Middle clicking will open
- the note in a new tab and right click will offer more options including
- opening the note in a new split or window.
-
Drag and drop an event on the calendar to move it to another day.
-
The length of an event can be changed by placing the mouse to the right
- edge of the event and dragging the mouse around.
-
-
Configuring the calendar
-
The following attributes can be added to the book type:
-
-
-
-
-
-
-
-
-
Name
-
Description
-
-
-
-
-
#calendar:hideWeekends
-
-
When present (regardless of value), it will hide Saturday and Sundays
- from the calendar.
-
-
-
#calendar:weekNumbers
-
-
When present (regardless of value), it will show the number of the week
- on the calendar.
-
-
-
~child:template
-
-
Defines the template for newly created notes in the calendar (via dragging
- or clicking).
-
-
-
-
-
In addition, the first day of the week can be either Sunday or Monday
- and can be adjusted from the application settings.
-
Configuring the calendar events
-
For each note of the calendar, the following attributes can be used:
-
-
-
-
-
Name
-
Description
-
-
-
-
-
#startDate
-
-
The date the event starts, which will display it in the calendar. The
- format is YYYY-MM-DD (year, month and day separated by a minus
- sign).
-
-
-
#endDate
-
-
Similar to startDate, mentions the end date if the event spans
- across multiple days. The date is inclusive, so the end day is also considered.
- The attribute can be missing for single-day events.
-
-
-
#color
-
-
Displays the event with a specified color (named such as red, gray or
- hex such as #FF0000). This will also change the color of the
- note in other places such as the note tree.
-
-
-
#calendar:color
-
-
Similar to #color, but applies the color only for the event
- in the calendar and not for other places such as the note tree.
-
-
-
#iconClass
-
-
If present, the icon of the note will be displayed to the left of the
- event title.
-
-
-
#calendar:title
-
-
Changes the title of an event to point to an attribute of the note other
- than the title, either a label (e.g. #assignee) or a relation
- (e.g. ~for). See Advanced use-cases for more information.
-
-
-
#calendar:promotedAttributes
-
-
-
Allows displaying the value of one or more promoted attributes in the
- calendar like this:
-
-
Hovering the mouse over an event will display information about the note.
+
+
+
+
Left clicking the event will go to that note. Middle clicking will open
+ the note in a new tab and right click will offer more options including
+ opening the note in a new split or window.
+
Drag and drop an event on the calendar to move it to another day.
+
The length of an event can be changed by placing the mouse to the right
+ edge of the event and dragging the mouse around.
+
+
Configuring the calendar
+
+
The following attributes can be added to the book type:
+
+
+
+
+
+
+
+
+
Name
+
Description
+
+
+
+
+
#calendar:hideWeekends
+
+
+
When present (regardless of value), it will hide Saturday and Sundays
+ from the calendar.
+
+
+
#calendar:weekNumbers
+
+
+
When present (regardless of value), it will show the number of the week
+ on the calendar.
+
+
+
~child:template
+
+
+
Defines the template for newly created notes in the calendar (via dragging
+ or clicking).
+
+
+
+
+
In addition, the first day of the week can be either Sunday or Monday
+ and can be adjusted from the application settings.
+
Configuring the calendar events
+
+
For each note of the calendar, the following attributes can be used:
+
+
+
+
+
Name
+
Description
+
+
+
+
+
#startDate
+
+
+
The date the event starts, which will display it in the calendar. The
+ format is YYYY-MM-DD (year, month and day separated by a minus
+ sign).
+
+
+
#endDate
+
+
+
Similar to startDate, mentions the end date if the event spans
+ across multiple days. The date is inclusive, so the end day is also considered.
+ The attribute can be missing for single-day events.
+
+
+
#color
+
+
+
Displays the event with a specified color (named such as red, gray or
+ hex such as #FF0000). This will also change the color of the
+ note in other places such as the note tree.
+
+
+
#calendar:color
+
+
+
Similar to #color, but applies the color only for the event
+ in the calendar and not for other places such as the note tree.
+
+
+
#iconClass
+
+
+
If present, the icon of the note will be displayed to the left of the
+ event title.
+
+
+
#calendar:title
+
+
+
Changes the title of an event to point to an attribute of the note other
+ than the title, either a label (e.g. #assignee) or a relation
+ (e.g. ~for). See Advanced use-cases for more information.
+
+
+
#calendar:promotedAttributes
+
+
+
+
Allows displaying the value of one or more promoted attributes in the
+ calendar like this:
+
+
Allows using a different label to represent the start date, other than #startDate (e.g. #expiryDate).
- The label name must be prefixed with #. If the label is not
- defined for a note, the default will be used instead.
-
-
-
#calendar:endDate
-
-
Allows using a different label to represent the start date, other than #endDate.
- The label name must be prefixed with #. If the label is not
- defined for a note, the default will be used instead.
-
-
-
-
-
How the calendar works
-
- The calendar displays all the child notes of the book that have a #startDate.
- An #endDate can optionally be added.
-
If editing the start date and end date from the note itself is desirable,
- the following attributes can be added to the book note:
When not used in a Journal, the calendar is recursive. That is, it will
- look for events not just in its child notes but also in the children of
- these child notes.
-
Use-cases
-
Using with the Journal / calendar
-
It is possible to integrate the calendar view into the Journal with day
- notes. In order to do so change the note type of the Journal note (calendar
- root) to Book and then select the Calendar View.
-
Based on the #calendarRoot (or #workspaceCalendarRoot)
- attribute, the calendar will know that it's in a calendar and apply the
- following:
-
-
The calendar events are now rendered based on their dateNote attribute
- rather than startDate.
-
Interactive editing such as dragging over an empty era or resizing an
- event is no longer possible.
-
Clicking on the empty space on a date will automatically open that day's
- note or create it if it does not exist.
-
Direct children of a day note will be displayed on the calendar despite
- not having a dateNote attribute. Children of the child notes
- will not be displayed.
-
-
-
-
-
Using a different attribute as event title
-
By default, events are displayed on the calendar by their note title.
- However, it is possible to configure a different attribute to be displayed
- instead.
-
To do so, assign #calendar:title to the child note (not the
- calendar/book note), with the value being #name where name can
- be any label. The attribute can also come through inheritance such as a
- template attribute. If the note does not have the requested label, the
- title of the note will be used instead.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Using a relation attribute as event title
-
Similarly to using an attribute, use #calendar:title and set
- it to ~name where name is the name of the relation
- to use.
-
Moreover, if there are more relations of the same name, they will be displayed
- as multiple events coming from the same note.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Note that it's even possible to have a #calendar:title on the
- target note (e.g. “John Smith”) which will try to render an attribute of
- it. Note that it's not possible to use a relation here as well for safety
- reasons (an accidental recursion of attributes could cause the application
- to loop infinitely).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
#calendar:startDate
+
+
+
Allows using a different label to represent the start date, other than #startDate (e.g. #expiryDate).
+ The label name must be prefixed with #. If the label is not
+ defined for a note, the default will be used instead.
+
+
+
#calendar:endDate
+
+
+
Allows using a different label to represent the start date, other than #endDate.
+ The label name must be prefixed with #. If the label is not
+ defined for a note, the default will be used instead.
+
+
+
+
+
How the calendar works
+
+
+ The calendar displays all the child notes of the book that have a #startDate.
+ An #endDate can optionally be added.
+
If editing the start date and end date from the note itself is desirable,
+ the following attributes can be added to the book note:
When not used in a Journal, the calendar is recursive. That is, it will
+ look for events not just in its child notes but also in the children of
+ these child notes.
+
Use-cases
+
+
Using with the Journal / calendar
+
+
It is possible to integrate the calendar view into the Journal with day
+ notes. In order to do so change the note type of the Journal note (calendar
+ root) to Book and then select the Calendar View.
+
Based on the #calendarRoot (or #workspaceCalendarRoot)
+ attribute, the calendar will know that it's in a calendar and apply the
+ following:
+
+
The calendar events are now rendered based on their dateNote attribute
+ rather than startDate.
+
Interactive editing such as dragging over an empty era or resizing an
+ event is no longer possible.
+
Clicking on the empty space on a date will automatically open that day's
+ note or create it if it does not exist.
+
Direct children of a day note will be displayed on the calendar despite
+ not having a dateNote attribute. Children of the child notes
+ will not be displayed.
+
+
+
+
+
Using a different attribute as event title
+
+
By default, events are displayed on the calendar by their note title.
+ However, it is possible to configure a different attribute to be displayed
+ instead.
+
To do so, assign #calendar:title to the child note (not the
+ calendar/book note), with the value being #name where name can
+ be any label. The attribute can also come through inheritance such as a
+ template attribute. If the note does not have the requested label, the
+ title of the note will be used instead.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Using a relation attribute as event title
+
+
Similarly to using an attribute, use #calendar:title and set
+ it to ~name where name is the name of the relation
+ to use.
+
Moreover, if there are more relations of the same name, they will be displayed
+ as multiple events coming from the same note.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Note that it's even possible to have a #calendar:title on the
+ target note (e.g. “John Smith”) which will try to render an attribute of
+ it. Note that it's not possible to use a relation here as well for safety
+ reasons (an accidental recursion of attributes could cause the application
+ to loop infinitely).
Trilium supports Mermaid, which adds support for various diagrams such
+ as flowchart, sequence diagram, class diagram, state diagram, pie charts,
+ etc., all using a text description of the chart instead of manually drawing
+ the diagram.
Mermaid supports a different layout engine which supports slightly more
+ complex diagrams, called the Eclipse Layout Kernel (ELK).
+ Trilium has support for these as well, but it's not enabled by default.
+
In order to activate ELK for any diagram, insert the following YAML frontmatter
+ right at the beginning of the diagram:
Right click on any note on the note tree and select Insert child note → Geo Map (beta).
-
-
-
2
-
-
-
-
-
-
By default the map will be empty and will show the entire world.
-
-
-
-
-
Repositioning the map
-
-
Click and drag the map in order to move across the map.
-
Use the mouse wheel, two-finger gesture on a touchpad or the +/- buttons
- on the top-left to adjust the zoom.
-
-
The position on the map and the zoom are saved inside the map note and
- restored when visiting again the note.
-
Adding a marker using the map
-
-
-
-
-
-
-
-
-
-
1
-
-
-
To create a marker, first navigate to the desired point on the map. Then
- press the
- button on the top-right of the map.
-
If the button is not visible, make sure the button section is visible
- by pressing the chevron button (
- ) in the top-right of the map.
-
-
-
-
2
-
-
-
-
-
-
-
-
Once pressed, the map will enter in the insert mode, as illustrated by
- the notification.
-
Simply click the point on the map where to place the marker, or the Escape
- key to cancel.
-
-
-
-
3
-
-
-
-
-
-
-
Enter the name of the marker/note to be created.
-
-
-
4
-
-
-
-
-
-
-
Once confirmed, the marker will show up on the map and it will also be
- displayed as a child note of the map.
-
-
-
-
-
How the location of the markers is stored
-
The location of a marker is stored in the #geolocation attribute
- of the child notes:
-
-
-
-
This value can be added manually if needed. The value of the attribute
- is made up of the latitude and longitude separated by a comma.
-
Repositioning markers
-
It's possible to reposition existing markers by simply drag and dropping
- them to the new destination.
-
As soon as the mouse is released, the new position is saved.
-
If moved by mistake, there is currently no way to undo the change. If
- the mouse was not yet released, it's possible to force a refresh of the
- page (Ctrl+R or Meta+R) to cancel it.
-
Interaction with the markers
-
-
Hovering over a marker will display the content of the note it belongs
- to.
+
+
+
Creating a new geo map
+
+
+
+
+
+
+
+
+
+
+
1
+
+
+
+
+
+
Right click on any note on the note tree and select Insert child note → Geo Map (beta).
+
+
+
2
+
+
+
+
+
+
By default the map will be empty and will show the entire world.
+
+
+
+
+
Repositioning the map
+
-
Clicking on the note title in the tooltip will navigate to the note in
- the current view.
+
Click and drag the map in order to move across the map.
+
Use the mouse wheel, two-finger gesture on a touchpad or the +/- buttons
+ on the top-left to adjust the zoom.
-
-
Middle-clicking the marker will open the note in a new tab.
-
Right-clicking the marker will open a contextual menu allowing:
+
The position on the map and the zoom are saved inside the map note and
+ restored when visiting again the note.
+
Adding a marker using the map
+
+
+
+
+
+
+
+
+
+
+
1
+
+
+
To create a marker, first navigate to the desired point on the map. Then
+ press the
+ button on the top-right of the map.
+
If the button is not visible, make sure the button section is visible
+ by pressing the chevron button (
+ ) in the top-right of the map.
+
+
+
+
2
+
+
+
+
+
+
+
+
Once pressed, the map will enter in the insert mode, as illustrated by
+ the notification.
+
Simply click the point on the map where to place the marker, or the Escape
+ key to cancel.
+
+
+
+
3
+
+
+
+
+
+
+
Enter the name of the marker/note to be created.
+
+
+
4
+
+
+
+
+
+
+
Once confirmed, the marker will show up on the map and it will also be
+ displayed as a child note of the map.
+
+
+
+
+
How the location of the markers is stored
+
+
The location of a marker is stored in the #geolocation attribute
+ of the child notes:
+
+
+
+
This value can be added manually if needed. The value of the attribute
+ is made up of the latitude and longitude separated by a comma.
+
Repositioning markers
+
+
It's possible to reposition existing markers by simply drag and dropping
+ them to the new destination.
+
As soon as the mouse is released, the new position is saved.
+
If moved by mistake, there is currently no way to undo the change. If
+ the mouse was not yet released, it's possible to force a refresh of the
+ page (Ctrl+R or Meta+R) to cancel it.
+
Interaction with the markers
+
-
Opening the note in a new tab, split or window.
-
Opening the location using an external application (if the operating system
- supports it).
-
Removing the marker from the map, which will remove the #geolocation attribute
- of the note. To add it back again, the coordinates have to be manually
- added back in.
+
Hovering over a marker will display the content of the note it belongs
+ to.
+
+
Clicking on the note title in the tooltip will navigate to the note in
+ the current view.
+
+
+
Middle-clicking the marker will open the note in a new tab.
+
Right-clicking the marker will open a contextual menu allowing:
+
+
Opening the note in a new tab, split or window.
+
Opening the location using an external application (if the operating system
+ supports it).
+
Removing the marker from the map, which will remove the #geolocation attribute
+ of the note. To add it back again, the coordinates have to be manually
+ added back in.
+
+
-
-
-
Icon and color of the markers
-
-
-
-
The markers will have the same icon as the note.
-
It's possible to add a custom color to a marker by assigning them a #color attribute
- such as #color=green.
-
Adding the coordinates manually
-
In a nutshell, create a child note and set the #geolocation attribute
- to the coordinates.
-
The value of the attribute is made up of the latitude and longitude separated
- by a comma.
-
Adding from Google Maps
-
-
-
-
-
1
-
-
-
-
-
-
-
Go to Google Maps on the web and look for a desired location, right click
- on it and a context menu will show up.
-
Simply click on the first item displaying the coordinates and they will
- be copied to clipboard.
-
Then paste the value inside the text box into the #geolocation attribute
- of a child note of the map (don't forget to surround the value with a " character).
-
-
-
-
2
-
-
-
-
-
-
-
In Trilium, create a child note under the map.
-
-
-
-
-
-
3
-
-
-
-
-
-
And then go to Owned Attributes and type #geolocation=", then
- paste from the clipboard as-is and then add the ending " character.
- Press Enter to confirm and the map should now be updated to contain the
- new note.
-
-
-
-
-
Adding from OpenStreetMap
-
Similarly to the Google Maps approach:
-
-
-
-
-
-
-
-
-
-
1
-
-
-
-
-
-
Go to any location on openstreetmap.org and right click to bring up the
- context menu. Select the “Show address” item.
-
-
-
2
-
-
-
-
-
-
-
The address will be visible in the top-left of the screen, in the place
- of the search bar.
-
Select the coordinates and copy them into the clipboard.
-
-
-
-
3
-
-
-
-
-
-
Simply paste the value inside the text box into the #geolocation attribute
- of a child note of the map and then it should be displayed on the map.
-
-
-
-
-
Adding GPS tracks (.gpx)
-
Trilium has basic support for displaying GPS tracks on the geo map.
-
-
-
-
-
-
-
-
-
-
1
-
-
-
-
-
-
To add a track, simply drag & drop a .gpx file inside the geo map
- in the note tree.
-
-
-
2
-
-
-
-
-
-
In order for the file to be recognized as a GPS track, it needs to show
- up as application/gpx+xml in the File type field.
-
-
-
3
-
-
-
-
-
-
-
When going back to the map, the track should now be visible.
-
The start and end points of the track are indicated by the two blue markers.
-
-
-
-
-
-
-
Troubleshooting
-
Grid-like artifacts on the map
-
-
-
-
This occurs if the application is not at 100% zoom which causes the pixels
- of the map to not render correctly due to fractional scaling. The only
- possible solution i to set the UI zoom at 100% (default keyboard shortcut
- is Ctrl+0).
-
+
Icon and color of the markers
+
+
+
+
+
The markers will have the same icon as the note.
+
It's possible to add a custom color to a marker by assigning them a #color attribute
+ such as #color=green.
+
Adding the coordinates manually
+
+
In a nutshell, create a child note and set the #geolocation attribute
+ to the coordinates.
+
The value of the attribute is made up of the latitude and longitude separated
+ by a comma.
+
Adding from Google Maps
+
+
+
+
+
+
1
+
+
+
+
+
+
+
Go to Google Maps on the web and look for a desired location, right click
+ on it and a context menu will show up.
+
Simply click on the first item displaying the coordinates and they will
+ be copied to clipboard.
+
Then paste the value inside the text box into the #geolocation attribute
+ of a child note of the map (don't forget to surround the value with a " character).
+
+
+
+
2
+
+
+
+
+
+
+
In Trilium, create a child note under the map.
+
+
+
+
+
+
3
+
+
+
+
+
+
And then go to Owned Attributes and type #geolocation=", then
+ paste from the clipboard as-is and then add the ending " character.
+ Press Enter to confirm and the map should now be updated to contain the
+ new note.
+
+
+
+
+
Adding from OpenStreetMap
+
+
Similarly to the Google Maps approach:
+
+
+
+
+
+
+
+
+
+
1
+
+
+
+
+
+
Go to any location on openstreetmap.org and right click to bring up the
+ context menu. Select the “Show address” item.
+
+
+
2
+
+
+
+
+
+
+
The address will be visible in the top-left of the screen, in the place
+ of the search bar.
+
Select the coordinates and copy them into the clipboard.
+
+
+
+
3
+
+
+
+
+
+
Simply paste the value inside the text box into the #geolocation attribute
+ of a child note of the map and then it should be displayed on the map.
+
+
+
+
+
Adding GPS tracks (.gpx)
+
+
Trilium has basic support for displaying GPS tracks on the geo map.
+
+
+
+
+
+
+
+
+
+
1
+
+
+
+
+
+
To add a track, simply drag & drop a .gpx file inside the geo map
+ in the note tree.
+
+
+
2
+
+
+
+
+
+
In order for the file to be recognized as a GPS track, it needs to show
+ up as application/gpx+xml in the File type field.
+
+
+
3
+
+
+
+
+
+
+
When going back to the map, the track should now be visible.
+
The start and end points of the track are indicated by the two blue markers.
+
+
+
+
+
+
+
Troubleshooting
+
+
+
+
+
Grid-like artifacts on the map
+
+
This occurs if the application is not at 100% zoom which causes the pixels
+ of the map to not render correctly due to fractional scaling. The only
+ possible solution is to set the UI zoom at 100% (default keyboard shortcut
+ is Ctrl+0).