To set your preferred chat model, you'll want to enter the provider's
+ name here:
+
+
+
+
And to set your preferred embedding provider:
+
+
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/AI Provider Information/Anthropic.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/AI Provider Information/Anthropic.html
new file mode 100644
index 000000000..e69de29bb
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/AI Provider Information/Ollama/1_Installing Ollama_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/AI Provider Information/Ollama/1_Installing Ollama_image.png
new file mode 100644
index 000000000..821966b77
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/AI Provider Information/Ollama/1_Installing Ollama_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/AI Provider Information/Ollama/2_Installing Ollama_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/AI Provider Information/Ollama/2_Installing Ollama_image.png
new file mode 100644
index 000000000..7e585a751
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/AI Provider Information/Ollama/2_Installing Ollama_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/AI Provider Information/Ollama/3_Installing Ollama_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/AI Provider Information/Ollama/3_Installing Ollama_image.png
new file mode 100644
index 000000000..0a239f35c
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/AI Provider Information/Ollama/3_Installing Ollama_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/AI Provider Information/Ollama/4_Installing Ollama_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/AI Provider Information/Ollama/4_Installing Ollama_image.png
new file mode 100644
index 000000000..b5c4c2930
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/AI Provider Information/Ollama/4_Installing Ollama_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/AI Provider Information/Ollama/5_Installing Ollama_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/AI Provider Information/Ollama/5_Installing Ollama_image.png
new file mode 100644
index 000000000..0c02db50f
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/AI Provider Information/Ollama/5_Installing Ollama_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/AI Provider Information/Ollama/Installing Ollama.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/AI Provider Information/Ollama/Installing Ollama.html
new file mode 100644
index 000000000..39d9ee00d
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/AI Provider Information/Ollama/Installing Ollama.html
@@ -0,0 +1,45 @@
+
Ollama can be installed in a variety
+ of ways, and even runs within a Docker container.
+ Ollama will be noticeably quicker when running on a GPU (Nvidia, AMD, Intel),
+ but it can run on CPU and RAM. To install Ollama without any other prerequisites,
+ you can follow their installer:
+
+
+
+
+
+
+
+
+
+
After their installer completes, if you're on Windows, you should see
+ an entry in the start menu to run it:
+
+
+
+
Also, you should have access to the ollama CLI via Powershell
+ or CMD:
+
+
+
+
After Ollama is installed, you can go ahead and pull the models
+ you want to use and run. Here's a command to pull my favorite tool-compatible
+ model and embedding model as of April 2025:
Also, you can make sure it's running by going to http://localhost:11434 and
+ you should get the following response (port 11434 being the “normal” Ollama
+ port):
+
+
+
+
Now that you have Ollama up and running, have a few models pulled, you're
+ ready to go to go ahead and start using Ollama as both a chat provider,
+ and embedding provider!
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/AI Provider Information/Ollama/Installing Ollama_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/AI Provider Information/Ollama/Installing Ollama_image.png
new file mode 100644
index 000000000..cf5ee38d4
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/AI Provider Information/Ollama/Installing Ollama_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/AI Provider Information/OpenAI.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/AI Provider Information/OpenAI.html
new file mode 100644
index 000000000..e69de29bb
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/AI Provider Information_im.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/AI Provider Information_im.png
new file mode 100644
index 000000000..aa19e949d
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/AI Provider Information_im.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/Introduction.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/Introduction.html
new file mode 100644
index 000000000..b873f9ca9
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/Introduction.html
@@ -0,0 +1,161 @@
+
+
+ An example chat with an LLM
+
+
The AI / LLM features within Trilium Notes are designed to allow you to
+ interact with your Notes in a variety of ways, using as many of the major
+ providers as we can support.
+
In addition to being able to send chats to LLM providers such as OpenAI,
+ Anthropic, and Ollama - we also support agentic tool calling, and embeddings.
+
The quickest way to get started is to navigate to the “AI/LLM” settings:
+
+
+
+
Enable the feature:
+
+
+
+
+
Embeddings
+
Embeddings are important as it allows us to have an compact
+ AI “summary” (it's not human readable text) of each of your Notes, that
+ we can then perform mathematical functions on (such as cosine similarity)
+ to smartly figure out which Notes to send as context to the LLM when you're
+ chatting, among other useful functions.
+
You will then need to set up the AI “provider” that you wish to use to
+ create the embeddings for your Notes. Currently OpenAI, Voyage AI, and
+ Ollama are supported providers for embedding generation.
+
In the following example, we're going to use our self-hosted Ollama instance
+ to create the embeddings for our Notes. You can see additional documentation
+ about installing your own Ollama locally in Installing Ollama.
+
To see what embedding models Ollama has available, you can check out
+ this searchon their website, and then pull whichever one
+ you want to try out. As of 4/15/25, my personal favorite is mxbai-embed-large.
+
First, we'll need to select the Ollama provider from the tabs of providers,
+ then we will enter in the Base URL for our Ollama. Since our Ollama is
+ running on our local machine, our Base URL is http://localhost:11434.
+ We will then hit the “refresh” button to have it fetch our models:
+
+
+
+
When selecting the dropdown for the “Embedding Model”, embedding models
+ should be at the top of the list, separated by regular chat models with
+ a horizontal line, as seen below:
+
+
+
+
After selecting an embedding model, embeddings should automatically begin
+ to be generated by checking the embedding statistics at the top of the
+ “AI/LLM” settings panel:
+
+
+
+
If you don't see any embeddings being created, you will want to scroll
+ to the bottom of the settings, and hit “Recreate All Embeddings”:
+
+
+
+
Creating the embeddings will take some time, and will be regenerated when
+ a Note is created, updated, or deleted (removed).
+
If for some reason you choose to change your embedding provider, or the
+ model used, you'll need to recreate all embeddings.
+
Tools
+
Tools are essentially functions that we provide to the various LLM providers,
+ and then LLMs can respond in a specific format that tells us what tool
+ function and parameters they would like to invoke. We then execute these
+ tools, and provide it as additional context in the Chat conversation.
+
These are the tools that currently exist, and will certainly be updated
+ to be more effectively (and even more to be added!):
+
+
search_notes
+
+
Semantic search
+
+
+
keyword_search
+
+
Keyword-based search
+
+
+
attribute_search
+
+
Attribute-specific search
+
+
+
search_suggestion
+
+
Search syntax helper
+
+
+
read_note
+
+
Read note content (helps the LLM read Notes)
+
+
+
create_note
+
+
Create a Note
+
+
+
update_note
+
+
Update a Note
+
+
+
manage_attributes
+
+
Manage attributes on a Note
+
+
+
manage_relationships
+
+
Manage the various relationships between Notes
+
+
+
extract_content
+
+
Used to smartly extract content from a Note
+
+
+
calendar_integration
+
+
Used to find date notes, create date notes, get the daily note, etc.
+
+
+
+
When Tools are executed within your Chat, you'll see output like the following:
+
+
+
+
You don't need to tell the LLM to execute a certain tool, it should “smartly”
+ call tools and automatically execute them as needed.
+
Overview
+
Now that you know about embeddings and tools, you can just go ahead and
+ use the “Chat with Notes” button, where you can go ahead and start chatting!:
+
+
+
+
If you don't see the “Chat with Notes” button on your side launchbar,
+ you might need to move it from the “Available Launchers” section to the
+ “Visible Launchers” section:
+
+
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/Introduction_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/Introduction_image.png
new file mode 100644
index 000000000..5a8657faf
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/AI/Introduction_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/1_Metrics_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/1_Metrics_image.png
new file mode 100644
index 000000000..683789547
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/1_Metrics_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/1_Note Map (Link map, Tree m.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/1_Note Map (Link map, Tree m.png
new file mode 100644
index 000000000..a16316f82
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/1_Note Map (Link map, Tree m.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/2_Metrics_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/2_Metrics_image.png
new file mode 100644
index 000000000..08181d986
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/2_Metrics_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases.html
new file mode 100644
index 000000000..544ba81bd
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases.html
@@ -0,0 +1,17 @@
+
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/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/1_Day Notes_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/1_Day Notes_image.png
new file mode 100644
index 000000000..9e03a2375
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/1_Day Notes_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Day Notes.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Day Notes.html
new file mode 100644
index 000000000..2bfdb4108
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Day Notes.html
@@ -0,0 +1,152 @@
+
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 2025, under it, you have "03 - March"
+ which then contains "09 - Monday". This is our "day note" which contains
+ some text in its content and also has some child notes (some of them are
+ from 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.
+
Week Note and Quarter Note
+
Week and quarter notes are disabled by default, since it might be too
+ much for some people. To enable them, you need to set #enableWeekNote and #enableQuarterNote attributes
+ on the root calendar note, which is identified by #calendarRoot label.
+ Week note is affected by the first week of year option. Be careful when
+ you already have some week notes created, it will not automatically change
+ the existing week notes and might lead to some duplicates.
+
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
+
quarterTemplate (if #enableQuarterNote is set)
+
monthTemplate
+
weekTemplate (if #enableWeekNote is set)
+
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.
+
Migrate from old template usage
+
If you have been using Journal prior to version v0.93.0, the previous
+ template pattern likely used was ~child:template=.
+ To transition to the new system:
+
+
Set up the new template pattern in the Calendar root note.
+
Use Bulk Actions to remove child:template and child:child:template from
+ all notes under the Journal (calendar root).
+
Ensure that all old template patterns are fully removed to prevent conflicts
+ with the new setup.
+
+
Naming pattern
+
You can customize the title of generated journal notes by defining a #datePattern, #weekPattern, #monthPattern, #quarterPattern and #yearPattern attribute
+ on a root calendar note (identified by #calendarRoot label).
+ The naming pattern replacements follow a level-up compatibility - each
+ level can use replacements from itself and all levels above it. For example, #monthPattern can
+ use month, quarter and year replacements, while #weekPattern can
+ use week, month, quarter and year replacements. But it is not possible
+ to use week replacements in #monthPattern.
+
Date pattern
+
It's possible to customize the title of generated date notes by defining
+ a #datePattern attribute on a root calendar note (identified
+ by #calendarRoot label). Following are possible values:
+
+
{isoDate} results in an ISO 8061 formatted date (e.g. "2025-03-09"
+ for March 9, 2025)
+
{dateNumber} results in a number like 9 for the
+ 9th day of the month, 11 for the 11th day of the month
+
{dateNumberPadded} results in a number like 09 for
+ the 9th day of the month, 11 for the 11th day of the month
+
{ordinal} is replaced with the ordinal date (e.g. 1st, 2nd,
+ 3rd) etc.
+
{weekDay} results in the full day name (e.g. Monday)
+
{weekDay3} is replaced with the first 3 letters of the day,
+ e.g. Mon, Tue, etc.
+
{weekDay2} is replaced with the first 2 letters of the day,
+ e.g. Mo, Tu, etc.
+
+
The default is {dateNumberPadded} - {weekDay}
+
+
Week pattern
+
It is also possible to customize the title of generated week notes through
+ the #weekPattern attribute on the root calendar note. The options
+ are:
+
+
{weekNumber} results in a number like 9 for the
+ 9th week of the year, 11 for the 11th week of the year
+
{weekNumberPadded} results in a number like 09 for
+ the 9th week of the year, 11 for the 11th week of the year
+
{shortWeek} results in a short week string like W9 for
+ the 9th week of the year, W11 for the 11th week of the year
+
{shortWeek3} results in a short week string like W09 for
+ the 9th week of the year, W11 for the 11th week of the year
+
+
The default is Week {weekNumber}
+
+
Month pattern
+
It is also possible to customize the title of generated month notes through
+ the #monthPattern attribute on the root calendar note. The options
+ are:
+
+
{isoMonth} results in an ISO 8061 formatted month (e.g. "2025-03"
+ for March 2025)
+
{monthNumber} results in a number like 9 for September,
+ and 11 for November
+
{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}
+
+
Quarter pattern
+
It is also possible to customize the title of generated quarter notes
+ through the #quarterPattern attribute on the root calendar note.
+ The options are:
+
+
{quarterNumber} results in a number like 1 for
+ the 1st quarter of the year
+
{shortQuarter} results in a short quarter string like Q1 for
+ the 1st quarter of the year
+
+
The default is Quarter {quarterNumber}
+
+
Year pattern
+
It is also possible to customize the title of generated year notes through
+ the #yearPattern attribute on the root calendar note. The options
+ are:
+
+
{year} results in the full year (e.g. 2025)
+
+
The default is {year}
+
+
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="2025-03-09" this
+ can then be used by other scripts to add new notes to day note etc.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Day Notes_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Day Notes_image.png
new file mode 100644
index 000000000..fd89503ef
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Day Notes_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Task Manager.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Task Manager.html
new file mode 100644
index 000000000..26dbc620f
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Task Manager.html
@@ -0,0 +1,65 @@
+
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/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Task Manager_task-manager.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Task Manager_task-manager.png
new file mode 100644
index 000000000..f2c5c9f8c
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Task Manager_task-manager.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Weight Tracker.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Weight Tracker.html
new file mode 100644
index 000000000..7ffb54d73
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Weight Tracker.html
@@ -0,0 +1,73 @@
+
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/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Weight Tracker_image.png b/apps/server/src/assets/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/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Weight Tracker_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes.html
new file mode 100644
index 000000000..8474ade5f
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes.html
@@ -0,0 +1,44 @@
+
+
+
+
In Trilium, attributes are key-value pairs assigned to notes, providing
+ additional metadata or functionality. There are two primary types of attributes:
+
+
+
Labels can
+ be used for a variety of purposes, such as storing metadata or configuring
+ the behaviour of notes. Labels are also searchable, enhancing note retrieval.
+
For more information, including predefined labels, see Labels.
+
+
+
Relations define
+ connections between notes, similar to links. These can be used for metadata
+ and scripting purposes.
+
For more information, including a list of predefined relations, see
+ Relations.
+
+
+
These attributes play a crucial role in organizing, categorising, and
+ enhancing the functionality of notes.
+
Viewing the list of attributes
+
Both the labels and relations for the current note are displayed in the Owned Attributes section
+ of the Ribbon,
+ where they can be viewed and edited. Inherited attributes are displayed
+ in the Inherited Attributes section of the ribbon, where they can
+ only be viewed.
+
In the list of attributes, labels are prefixed with the # character
+ whereas relations are prefixed with the ~ character.
+
Multiplicity
+
Attributes in Trilium can be "multi-valued", meaning multiple attributes
+ with the same name can co-exist.
+
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/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Attribute Inheritance.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Attribute Inheritance.html
new file mode 100644
index 000000000..cb6de109d
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Attribute Inheritance.html
@@ -0,0 +1,50 @@
+
Inheritance refers to the process of having a label or
+ a relation shared across multiple
+ notes, generally in parent-child relations (or anywhere if using templates).
+
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.
+
To make an attribute inheritable, simply use the visual editor for
+ Labels or Relations.
+ Alternatively, the attribute can be manually defined where #myLabel=value becomes #myLabel(inheritable)=value when
+ inheritable.
+
As an example, 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.
+
Standard inheritance forces all the notes that are children (and sub-children)
+ of a note to have that particular label or relation. If there is a need
+ to have some notes not inherit one of the labels, then copying inheritance or template inheritance needs
+ to be used instead.
+
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.
+
If a parent note has the label #child:exampleAttribute, all
+ newly created child notes (one level deep) will inherit the #exampleAttribute label.
+ This can be useful for setting default properties for notes in a specific
+ section.
+
Similarly, for relations use ~child:myRelation.
+
Due to the way it's designed, copying inheritance cannot be used to cascade
+ infinitely within a hierarchy. For that use case, consider using either
+ standard inheritance or templates.
+
Chained inheritance
+
It is possible to define labels across multiple levels of depth. For example, #child:child:child:foo applied
+ to a root note would create:
+
+
#child:child:foo on the first-level children.
+
#child:foo on the second-level children.
+
#foo on the third-level children.
+
+
Similarly, use ~child:child:child:foo if dealing with relations.
+
Do note that same as simple copying inheritance, the changes will not
+ apply retroactively to existing notes in the hierarchy, it will only apply
+ to the newly created notes.
+
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/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Labels.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Labels.html
new file mode 100644
index 000000000..7dc0eb5a0
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Labels.html
@@ -0,0 +1,385 @@
+
A label is an attribute of a note
+ which has a name and optionally a value.
+
Common use cases
+
+
Metadata for personal use: Assign labels with optional
+ values for categorization, such as #year=1999, #genre="sci-fi",
+ or #author="Neal Stephenson". This can be combined with
+ Promoted Attributes to make their display more user-friendly.
+
Configuration: Labels can configure advanced features
+ or settings (see reference below).
+
Scripts and Plugins: Used to tag notes with special metadata,
+ such as the "weight" attribute in the Weight Tracker.
To create a label called myLabel with no value, simply type #myLabel.
+
To create a label called myLabel with a value value,
+ simply type #myLabel=value.
+
If the value contains spaces, then the text must be quoted: #myLabel="Hello world".
+
If the string contains quotes (regardless of whether it has spaces), then
+ the text must be quoted with apostrophes instead: #myLabel='Hello "world"'.
+
To create an inheritable label called myLabel, simply write #myLabel(inheritable) for
+ no value or #myLabel(inheritable)=value if there is a value.
+
+
Predefined labels
+
This is a list of labels that Trilium natively supports.
+
+
+
+
+
+
+
+
+
+
Label
+
Description
+
+
+
+
+
disableVersioning
+
+
Disables automatic creation of Note Revisions for
+ a particular note. Useful for e.g. large, but unimportant notes - e.g.
+ large JS libraries used for scripting.
+
+
+
versioningLimit
+
+
Limits the maximum number of Note Revisions for
+ a particular note, overriding the global settings.
+
+
+
calendarRoot
+
+
Marks the note which should be used as root for Day Notes. Only one should be marked
+ as such.
+
+
+
archived
+
+
Hides notes from default search results and dialogs. Archived notes can
+ optionally be hidden in the Note Tree.
+
+
+
excludeFromExport
+
+
Excludes this note and its children when exporting.
Scripts with this label won't be included into parent script execution.
+
+
+
sorted
+
+
+
Keeps child notes sorted by title alphabetically.
+
When given a value, it will sort by the value of another label instead.
+ If one of the child notes doesn't have the specified label, the title will
+ be used for them instead.
+
+
+
+
sortDirection
+
+
+
If sorted is applied, specifies the direction of the sort:
+
+
ASC, ascending (default)
+
DESC, descending
+
+
+
+
+
sortFoldersFirst
+
+
If sorted is applied, folders (notes with children) will be
+ sorted as a group at the top, and the rest will be sorted.
+
+
+
top
+
+
If sorted is applied to the parent note, keeps given note on
+ top in its parent.
+
+
+
hidePromotedAttributes
+
+
Hide Promoted Attributes on
+ this note. Generally useful when defining inherited attributes, but the
+ parent note doesn't need them.
+
+
+
readOnly
+
+
Marks a note to be always be read-only,
+ if it's a supported note (text, code, mermaid).
Marks CSS notes which are loaded into the Trilium application and can
+ thus be used to modify Trilium's looks. See Custom app-wide CSS for more info.
+
+
+
appTheme
+
+
Marks CSS notes which are full Trilium themes and are thus available in
+ Trilium options. See Theme development for
+ more information.
+
+
+
appThemeBase
+
+
Set to next, next-light, or next-dark to
+ use the corresponding TriliumNext theme (auto, light or dark) as the base
+ for a custom theme, instead of the legacy one. See Customize the Next theme for more
+ information.
+
+
+
cssClass
+
+
Value of this label is then added as CSS class to the node representing
+ given note in the Note Tree.
+ This can be useful for advanced theming. Can be used in template notes.
+
+
+
iconClass
+
+
value of this label is added as a CSS class to the icon on the tree which
+ can help visually distinguish the notes in the tree. Example might be bx
+ bx-home - icons are taken from boxicons. Can be used in template notes.
+
+
+
pageSize
+
+
Specifies the number of items per page in Note List.
default inbox location for new notes - when you create a note using new note button
+ in the sidebar, notes will be created as child notes in the note marked
+ as with #inbox label.
Comma delimited names of relations which should be displayed/hidden in
+ a Relation Map (both
+ the note type and the Note Map (Link map, Tree map) general
+ functionality).
+
+
+
titleTemplate
+
+
+
Default title of notes created as children of this note. This value is
+ evaluated as a JavaScript string and thus can be enriched with dynamic
+ content via the injected now and parentNote variables.
+
Examples:
+
+
\({parentNote.getLabel('authorName')}'s literary works
+
This note will appear in the selection of available template when creating
+ new note. See Templates for
+ more information.
+
+
+
toc
+
+
Controls the display of the Table of contents for
+ a given note. #toc or #toc=show to always display
+ the table of contents, #toc=false to always hide it.
+
+
+
color
+
+
defines color of the note in note tree, links etc. Use any valid CSS color
+ value like 'red' or #a13d5f
+
+
+
keyboardShortcut
+
+
Defines a keyboard shortcut which will immediately jump to this note.
+ Example: 'ctrl+alt+e'. Requires frontend reload for the change to take
+ effect.
+
+
+
keepCurrentHoisting
+
+
Opening this link won't change hoisting even if the note is not displayable
+ in the current hoisted subtree.
+
+
+
executeButton
+
+
Title of the button which will execute the current code note
+
+
+
executeDescription
+
+
Longer description of the current code note displayed together with the
+ execute button
+
+
+
excludeFromNoteMap
+
+
Notes with this label will be hidden from the Note Map.
+
+
+
newNotesOnTop
+
+
New notes will be created at the top of the parent note, not on the bottom.
Sets the view of child notes (e.g. grid or list). See Note List for more information.
+
+
+
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes.html
new file mode 100644
index 000000000..4f02e8d75
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes.html
@@ -0,0 +1,49 @@
+
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/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes_image.png b/apps/server/src/assets/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/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes_promot.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes_promot.png
new file mode 100644
index 000000000..cca868320
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes_promot.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Relations.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Relations.html
new file mode 100644
index 000000000..d9c79a998
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Relations.html
@@ -0,0 +1,139 @@
+
A relation is similar to a label,
+ but instead of having a text value it refers to another note.
+
Common use cases
+
+
Metadata Relationships for personal use: For example,
+ linking a book note to an author note.
+ This can be combined with Promoted Attributes to
+ make their display more user-friendly.
+
Configuration: For configuring some notes such as
+ Render Note, or configuring Sharing or
+ Templates (see the list below).
+
Scripting: Attaching scripts to events or conditions
+ related to the note.
note's attributes will be inherited even without a parent-child relationship,
+ note's content and subtree will be added to instance notes if empty. See
+ documentation for details.
+
+
+
inherit
+
+
note's attributes will be inherited even without a parent-child relationship.
+ See Templates for
+ a similar concept. See Attribute Inheritance in
+ the documentation.
+
+
+
renderNote
+
+
notes of type Render Note will
+ be rendered using a code note (HTML or script) and it is necessary to point
+ using this relation to which note should be rendered
+
+
+
widget_relation
+
+
target of this relation will be executed and rendered as a widget in the
+ sidebar
+
+
+
shareCss
+
+
CSS note which will be injected into the share page. CSS note must be
+ in the shared sub-tree as well. Consider using share_hidden_from_tree and share_omit_default_css as
+ well.
+
+
+
shareJs
+
+
JavaScript note which will be injected into the share page. JS note must
+ be in the shared sub-tree as well. Consider using share_hidden_from_tree.
+
+
+
shareTemplate
+
+
Embedded JavaScript note that will be used as the template for displaying
+ the shared note. Falls back to the default template. Consider using share_hidden_from_tree.
+
+
+
shareFavicon
+
+
Favicon note to be set in the shared page. Typically you want to set it
+ to share root and make it inheritable. Favicon note must be in the shared
+ sub-tree as well. Consider using share_hidden_from_tree.
+
+
+
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes_image.png
new file mode 100644
index 000000000..f0d2a63c2
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Bulk Actions.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Bulk Actions.html
new file mode 100644
index 000000000..f505b9714
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Bulk Actions.html
@@ -0,0 +1,169 @@
+
+
+
+
The Bulk Actions dialog makes it easy to apply changes to multiple
+ notes at once, ranging from simple actions such as adding or removing a
+ label to being executing custom scripts.
+
Interaction
+
+
The first step is to select the notes in the Note Tree. It's possible to apply bulk
+ actions to:
+
+
A single note (and potentially its child notes) simply by clicking on
+ it (with a left click or a right click).
Right click in the Note Tree and
+ select Advanced → Apply bulk actions.
+
By default, only the selected notes will be affected. To also include
+ all the descendants of the notes, check Include descendants of the selected notes.
+ The number of affected notes at the top of the dialog will update to reflect
+ the change.
+
Click on which action to apply from the Available actions section.
+ A detailed description of each is available in the next section.
+
+
For each action selected, the Chosen actions section will update
+ to reveal the entry. Each action will have its own configuration.
+
To remove an action, simply press the X button to the right of it.
+
It is possible to apply multiple actions of the same type, such as adding
+ multiple types.
+
+
+
When all the actions are defined, press Execute bulk actions to
+ trigger all of them at once.
+
For convenience, the last bulk action configuration is saved for further
+ use and will be restored when entering the dialog again.
For each note, if it doesn't already have a label of
+ the given name, it will create it. Keep the New value field empty
+ to create a label without a value, or complete it to assign a value.
+
If a note already has this label, its value will be updated.
+
+
+
Update label value
+
+
For each note, if it has a label of
+ the given name, it will change its value to the specified one. Leave New value field
+ empty to create a label without a value.
+
Notes without the label will not be affected.
+
+
+
Rename label
+
+
For each note, if it has a label of
+ the given name, it will be renamed/replaced with a label of the new name.
+ The value of the label (if present) will be kept intact.
+
Notes without the label will not be affected.
+
+
+
Delete label
+
+
For each note, if it has a label of a given name, it will be deleted (regardless
+ of whether it has a value or not).
For each note, it will create a relation pointing to the given note.
+
Notes without this relation will not be affected.
+
+
+
Update relation target
+
+
For each note, it will modify a relation to point to the newly given note.
+
Notes without this relation will not be affected.
+
+
+
Rename relation
+
+
For each note, if it has a relation of the given name, it will be renamed/replaced
+ with a relation of the new name. The target note of the relation will be
+ kept intact.
+
Notes without this relation will not be affected.
+
+
+
Delete relation
+
+
For each note, if it has a relation of the given name, it will be deleted.
+
Notes without this relation will not be affected.
+
+
+
+
Notes
+
+
Rename note
+
+
For each note, it will change the title of the note to the given one.
+
As a more advanced use case, the note can be a “template string” which
+ allows for dynamic values with access to the note information via
+ FNote, for example:
+
+
NEW: ${note.title} will prefix all notes with NEW: .
+
${note.dateCreatedObj.format('MM-DD:')}: ${note.title} will
+ prefix the note titles with each note's creation date (in month-day format).
+
+
+
+
+
Move note
+
+
For each note, it will be moved to the specified parent note.
+
As an alternative for less complex situations, the notes can be moved
+ directly from within the Note Tree via
+ cut → paste or via the contextual menu.
+
+
+
Delete note
+
+
For each note, it will be deleted.
+
As an alternative for less complex situations, the notes can be removed
+ directly from within the Note Tree by
+ selecting them and pressing Delete.
For more complex scenarios, it is possible to type in a JavaScript expression
+ in order to apply the necessary changes.
+
Examples:
+
+
+
To apply a suffix (- suffix in this example), to the note
+ title:
note.title = note.title + " - suffix";
+
+
+
To alter attributes of a note based on another attribute, 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/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Bulk Actions_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Bulk Actions_image.png
new file mode 100644
index 000000000..da7005580
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Bulk Actions_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Configuration (config.ini or e.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Configuration (config.ini or e.html
new file mode 100644
index 000000000..923cbdf03
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Configuration (config.ini or e.html
@@ -0,0 +1,27 @@
+
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/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Configuration (config.ini or environment variables)/Cross-Origin Resource Sharing .html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Configuration (config.ini or environment variables)/Cross-Origin Resource Sharing .html
new file mode 100644
index 000000000..0e1f1c318
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Configuration (config.ini or environment variables)/Cross-Origin Resource Sharing .html
@@ -0,0 +1,46 @@
+
By default, Trilium cannot be accessed in web browsers by requests coming
+ from other domains/origins than Trilium itself.
+
However, it is possible to manually configure Cross-Origin Resource Sharing (CORS) since
+ Trilium v0.93.0 using environment variables or config.ini,
+ as follows:
+
+
+
+
+
+
+
+
+
+
CORS Header
+
Corresponding option in config.ini
+
+
Corresponding option in environment variables in the Network section
+
+
+
+
+
Access-Control-Allow-Origin
+
+
TRILIUM_NETWORK_CORS_ALLOW_ORIGIN
+
+
corsAllowOrigin
+
+
+
Access-Control-Allow-Methods
+
+
TRILIUM_NETWORK_CORS_ALLOW_METHODS
+
+
corsAllowMethods
+
+
+
Access-Control-Allow-Headers
+
+
TRILIUM_NETWORK_CORS_ALLOW_HEADERS
+
+
corsAllowHeaders
+
+
+
+
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Configuration (config.ini or environment variables)/Trilium instance.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Configuration (config.ini or environment variables)/Trilium instance.html
new file mode 100644
index 000000000..35fc1d2b8
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Configuration (config.ini or environment variables)/Trilium instance.html
@@ -0,0 +1,17 @@
+
A Trilium instance represents a server. If Synchronization is set up, since
+ multiple servers are involved (the one from the desktop client and the
+ one the synchronisation is set up with), sometimes it can be useful to
+ distinguish the instance you are running on.
+
Setting the instance name
+
To set up a name for the instance, modify the config.ini:
[General]
+instanceName=Hello
+
Distinguishing the instance on back-end
+
Use api.getInstanceName() to obtain the instance name of the
+ current server, as specified in the config file or in environment variables.
+
Limiting script runs based on instance
+
For a script that is run periodically or on a certain event, it's possible
+ to limit it to certain instances without having to change the code. Just
+ add runOnInstance and set as the value the instance name where
+ the script should run. To run on multiple named instances, simply add the
+ label multiple times.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Custom Request Handler.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Custom Request Handler.html
new file mode 100644
index 000000000..d7068f7eb
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Custom Request Handler.html
@@ -0,0 +1,75 @@
+
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/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Custom Resource Providers.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Custom Resource Providers.html
new file mode 100644
index 000000000..e70528bd5
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Custom Resource Providers.html
@@ -0,0 +1,36 @@
+
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/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Database.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Database.html
new file mode 100644
index 000000000..3165b3940
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Database.html
@@ -0,0 +1,27 @@
+
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 first starting Trilium, it will provide a set of notes to showcase
+ various features of the application.
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/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Demo Notes.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Demo Notes.html
new file mode 100644
index 000000000..73691b220
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Demo Notes.html
@@ -0,0 +1,30 @@
+
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
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the data.png b/apps/server/src/assets/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/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the data.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database.html
new file mode 100644
index 000000000..f5abe37d1
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database.html
@@ -0,0 +1,36 @@
+
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/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/1_SQL Console_image.png b/apps/server/src/assets/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/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/1_SQL Console_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/2_SQL Console_image.png b/apps/server/src/assets/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..1b1834ba1
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/2_SQL Console_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/3_SQL Console_image.png b/apps/server/src/assets/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..ccef8f7aa
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/3_SQL Console_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/SQL Console.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/SQL Console.html
new file mode 100644
index 000000000..27e27dddb
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/SQL Console.html
@@ -0,0 +1,36 @@
+
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/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/SQL Console_image.png b/apps/server/src/assets/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/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/SQL Console_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Default Note Title.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Default Note Title.html
new file mode 100644
index 000000000..35a783519
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Default Note Title.html
@@ -0,0 +1,54 @@
+
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.
+
Second variable injected is parentNote which gives access to
+ the parent FNote.
+
See also Templates which
+ provides similar capabilities, including default note's content.
+
Examples
+
+
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.
+
+
+
To use a parent's attribute in the title of new notes: #titleTemplate="${parentNote.getLabelValue('authorName')}'s literary works"
+
+
To mirror the parent's note title: ${parentNote.title}
+
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/ETAPI (REST API).html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/ETAPI (REST API).html
new file mode 100644
index 000000000..a7ea78e55
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/ETAPI (REST API).html
@@ -0,0 +1,49 @@
+
ETAPI is Trilium's public/external REST API. It is available since Trilium
+ v0.50.
+
The documentation is in OpenAPI format, available here.
+
API clients
+
As an alternative to calling the API directly, there are client libraries
+ to simplify this
+
+
trilium-py, you can
+ use Python to communicate with Trilium.
+
+
Obtaining a token
+
All operations with the REST API 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).
+
Authentication
+
Via the Authorization header
GET https://myserver.com/etapi/app-info
+Authorization: ETAPITOKEN
+
where ETAPITOKEN is the token obtained in the previous step.
+
For compatibility with various tools, it's also possible to specify the
+ value of the Authorization header in the format Bearer ETAPITOKEN (since
+ 0.93.0).
+
Basic authentication
+
Since v0.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.
+
Interaction using Bash scripts
+
It is possible to write simple Bash scripts to interact with Trilium.
+ As an example, here's how to obtain the HTML content of a note:
#!/usr/bin/env bash
+
+# Configuration
+TOKEN=z1vA4fkGxjOR_ZXLrZeqHEFOv65yV3882iFCRtNIK9k9iWrHliITNSLQ=
+SERVER=http://localhost:8080
+
+# Download a note by ID
+NOTE_ID="i6ra4ZshJhgN"
+curl "$SERVER/etapi/notes/$NOTE_ID/content" -H "Authorization: $TOKEN"
+
Make sure to replace the values of:
+
+
TOKEN with your ETAPI token.
+
SERVER with the correct protocol, host name and port to your
+ Trilium instance.
+
NOTE_ID with an existing note ID to download.
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/ETAPI (REST API)/API Reference.dat b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/ETAPI (REST API)/API Reference.dat
new file mode 100644
index 000000000..e69de29bb
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Hidden Notes.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Hidden Notes.html
new file mode 100644
index 000000000..8fabb2276
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Hidden Notes.html
@@ -0,0 +1,182 @@
+
+
+
+
For easy extensibility, a lot of features in Trilium make use of actual
+ notes to store information as opposed to having them stored in a separate
+ location in the database. This allows some functions such as Attributes, Relations or even Search and Links to be able to operate on
+ them.
+
As the name suggests, these notes are hidden to the user by default to
+ prevent cluttering the note tree and to prevent them from being accidentally
+ deleted.
+
The hidden notes are stored in the user's Database just like normal notes,
+ but they have a unique Note ID which
+ allows them to be distinguished from the normal ones.
+
Accessing the hidden note tree
+
From the Global menu,
+ select Advanced → Show Hidden Subtree.
+
Contents of the hidden note tree
+
Here is a brief summary of all the notes within the hidden tree:
This note is actually opened when the Note Map feature
+ that is accessed from the Launch Bar.
+
It is possible to create any child notes in it without any additional
+ meaning. For example, it can be used to store a list of note maps which
+ can be linked to from other notes or bookmarked.
When SQL queries or commands are executed in the SQL Console, they are stored here,
+ grouped by month. Only the query is stored and not the results.
+
This section can be accessed without going to the hidden tree by simply
+ going to the Global menu and
+ selecting Advanced → Open SQL Console History.
+
Notes can be added as children of this tree, but it's generally not recommended
+ to do so to not interfere with the normal history process.
Whenever a search is executed from the full Search, the query will be stored here,
+ grouped by month. Only the search parameters are stored and not the results
+ themselves.
+
This section can be accessed without going to the hidden tree by simply
+ going to the Global menu and
+ selecting Advanced → Open Search History.
+
Notes can be added as children of this tree, but it's generally not recommended
+ to do so to not interfere with the normal history process.
This section is used for Bulk Actions.
+ The last configuration for bulk actions will be stored as part of this
+ note, each action in its own action label.
+
Notes can be added as children of this tree, but there won't be any benefit
+ in doing so.
This section can be used by scripts to
+ create their own notes that should not be directly visible to the user.
+ The note can be identified by scripts by its unique ID: _userHidden
+
This tree lists all of the notes that are shared publicly.
+ It can be useful to track down which notes are shared regardless of their
+ position in the note tree.
+
This section can be accessed without going to the hidden tree simply by
+ going to the Global menu and
+ selecting Show Shared Notes Subtree.
This is where the note structure for the User Guide is actually stored.
+ Only the metadata is stored, as the help itself is present as actual files
+ in the application directory.
+
+
+
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Hidden Notes_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Hidden Notes_image.png
new file mode 100644
index 000000000..eb59b57b1
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Hidden Notes_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Internal API/API Reference.dat b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Internal API/API Reference.dat
new file mode 100644
index 000000000..e69de29bb
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Metrics.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Metrics.html
new file mode 100644
index 000000000..47a84af0d
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Metrics.html
@@ -0,0 +1,99 @@
+
The Trilium Metrics API provides comprehensive monitoring data about your
+ Trilium instance, designed for external monitoring systems like Prometheus.
+
Endpoint
+
+
URL: /etapi/metrics
+
+
Method: GET
+
+
Authentication: ETAPI token required
+
Default Format: Prometheus text format
+
+
Authentication
+
You need an ETAPI token to access the metrics endpoint. Get one by:
# Get an ETAPI token
+curl -X POST http://localhost:8080/etapi/auth/login \
+ -H "Content-Type: application/json" \
+ -d '{"password": "your_password"}'
+
# HELP trilium_info Trilium instance information
+# TYPE trilium_info gauge
+trilium_info{version="0.91.6",db_version="231",node_version="v18.17.0"} 1 1701432000
+
+# HELP trilium_notes_total Total number of notes including deleted
+# TYPE trilium_notes_total gauge
+trilium_notes_total 1234 1701432000
+
You can also use the Grafana Dashboard that has been created for TriliumNext
+ - just take the JSON from grafana-dashboard.json and
+ then import the dashboard, following these screenshots:
Whereas some applications use file names to uniquely identify notes, Trilium
+ uses the concept of Note ID.
+
Generally, the Note ID is a 12-character long alphanumeric sequence (including
+ both lower and upper case letter) that is randomly generated for each new
+ note.
+
How does the import/export affect the note IDs
+
When notes are exported, their note ID is kept in the metadata of the
+ export. However when they are imported back in, a new note ID is generated
+ for all the notes. This also includes other entities that are part of the
+ import/export process such as Attachments.
+
Note collisions
+
Since the Note ID is a fixed-width randomly generated number, due to the
+ pigeonhole principle, there is a possibility that a newly created
+ note will have the same ID as an existing note.
+
Since the note ID is alphanumeric and the length is 12 we have
+ \(62^{12}\) unique IDs. However since we are generating them
+ randomly, we can use a collision calculator such as the one for Nano ID to
+ determine that we'd need to create 1000 notes per hour every hour for 9
+ centuries in order to have at least 1% probability of a note collision.
+
As such, Trilium does not take any explicit action against potential note
+ collisions, similar to other software that makes uses of unique hashes
+ such as Git.
+ If one would theoretically occur, what would most likely happen is that
+ the existing note will be replaced by the new one.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Note Map (Link map, Tree m.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Note Map (Link map, Tree m.png
new file mode 100644
index 000000000..2d41fd6c6
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Note Map (Link map, Tree m.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Note Map (Link map, Tree map).html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Note Map (Link map, Tree map).html
new file mode 100644
index 000000000..828cb8c65
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Note Map (Link map, Tree map).html
@@ -0,0 +1,30 @@
+
Note map is a visualisation of connections between notes.
+
This provides an insight into a structure ("web") of notes.
+
There are two types of note map:
+
+
Link Map, which shows relations between notes.
+
Note Map, which shows the hierarchical tree structure.
Apart from the note map feature which can be accessed from any note, it
+ is also possible to create a dedicated note which will display the relations
+ in full screen. See Note Map for
+ more information.
+
See also
+
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/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Note source.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Note source.html
new file mode 100644
index 000000000..39512ce81
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Note source.html
@@ -0,0 +1,68 @@
+
Understanding the source code of the different notes
+
Internally, the structure of the content of each note is different based
+ on the Note Types.
+
For example:
+
+
Text notes are
+ represented internally as HTML, using the CKEditor representation. Note
+ that due to the custom plugins, some HTML elements are specific to Trilium
+ only, for example the admonitions.
+
Code notes are
+ plain text and are represented internally as-is.
+
Geo Map notes
+ contain only minimal information (viewport, zoom) as a JSON.
+
Canvas notes
+ are represented as JSON, with Trilium's own information alongside with
+ Excalidraw's internal JSON representation format.
+
Mind Map notes
+ are represented as JSON, with the internal format of MindElixir.
+
+
Note that some information is also stored as Attachments. For example Canvas notes use the attachments
+ feature to store the custom libraries, and alongside with Mind Map and other similar note
+ types it stores an SVG representation of the content for use in other features
+ such as including in other notes, shared notes, etc.
+
Here's part of the HTML representation of this note, as it's stored in
+ the database (but prettified).
<h2>
+ Understanding the source code of the different notes
+</h2>
+<p>
+ Internally, the structure of the content of each note is different based on the
+ <a class="reference-link" href="#root/_help_KSZ04uQ2D1St">
+ Note Types
+ </a>
+ .
+</p>
+
Viewing the source code
+
It is possible to view the source code of a note by pressing the contextual
+ menu in Note buttons and
+ selecting Note source.
+
+
+
+
The source code will be displayed in a new tab.
+
For some note types, such as text notes, the source code is also formatted
+ in order to be more easily readable.
+
Modifying the source code
+
It is possible to modify the source code of a note directly, however not
+ via the Note source functionality.
+
To do so:
+
+
Change the note type from the real note type (e.g. Canvas, Geo Type) to
+ Code (plain text) or the corresponding format such as JSON or HTML.
+
Confirm the warning about changing the note type.
+
The source code will appear, make the necessary modifications.
+
Change the note type back to the real note type.
+
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Note source_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Note source_image.png
new file mode 100644
index 000000000..71f0ddf4a
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Note source_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing.html
new file mode 100644
index 000000000..3b34f2147
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing.html
@@ -0,0 +1,350 @@
+
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.
+
+
+
+
+
Features, interaction and limitations
+
+
Searching by note title.
+
Automatic dark/light mode based on the user's browser settings.
+
Mobile-friendly layout, with sidebar.
+
Collapsible tree with the same note icons as the application.
+
Customizable logo.
+
Toggle button for dark/light mode, which also stores the user preferences.
+
Quick navigation buttons (previous and next note).
+
Displaying the date of the last update of the note.
While the sharing feature is powerful, it has some limitations:
+
+
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.
+
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 design should be a good starting point, 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.
+
Attribute reference
+
+
+
+
+
Attribute
+
Description
+
+
+
+
+
shareHiddenFromTree
+
+
this note is hidden from left navigation tree, but still accessible with
+ its URL
+
+
+
shareExternalLink
+
+
note will act as a link to an external website in the share tree
+
+
+
shareAlias
+
+
define an alias using which the note will be available under https://your_trilium_host/share/[your_alias]
+
+
+
+
shareOmitDefaultCss
+
+
default share page CSS will be omitted. Use when you make extensive styling
+ changes.
+
+
+
shareRoot
+
+
marks note which is served on /share root.
+
+
+
shareDescription
+
+
define text to be added to the HTML meta tag for description
+
+
+
shareRaw
+
+
Note will be served in its raw format, without HTML wrapper. See also
+ Serving directly the content of a note for an alternative method
+ without setting an attribute.
+
+
+
shareDisallowRobotIndexing
+
+
+
Indicates to web crawlers that the page should not be indexed of this
+ note by:
+
+
Setting the X-Robots-Tag: noindex HTTP header.
+
Setting the noindex, follow meta tag.
+
+
+
+
+
shareCredentials
+
+
require credentials to access this shared note. Value is expected to be
+ in format username:password. Don't forget to make this inheritable
+ to apply to child-notes/images.
+
+
+
shareIndex
+
+
Note with this label will list all roots of shared notes.
+
+
+
+
+
+
Credits
+
Since v0.95.0, a new theme was introduced (and enabled by default) which
+ greatly improves the visual aspect of the Share feature, as well as its
+ functionality (such as mobile support, dark/light mode, collapsible tree,
+ etc.). This theme is an adaptation of the Trilium Rocks! by
+ zerebos.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/1_Serving directly the conte.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/1_Serving directly the conte.png
new file mode 100644
index 000000000..23592294b
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/1_Serving directly the conte.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/Serving directly the conte.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/Serving directly the conte.png
new file mode 100644
index 000000000..bab0f97f5
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/Serving directly the conte.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/Serving directly the content o.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/Serving directly the content o.html
new file mode 100644
index 000000000..8f7217624
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/Serving directly the content o.html
@@ -0,0 +1,37 @@
+
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.
+
+
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing_image.png
new file mode 100644
index 000000000..4c92b90c5
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing_share-single-note.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing_share-single-note.png
new file mode 100644
index 000000000..87b99cabb
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing_share-single-note.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing_shared-list.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing_shared-list.png
new file mode 100644
index 000000000..8002303f8
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing_shared-list.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Technologies used.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Technologies used.html
new file mode 100644
index 000000000..191b87d06
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Technologies used.html
@@ -0,0 +1,7 @@
+
One core aspect of Trilium that allows it to have support for multiple
+ Note Types is the fact that it makes use of various off-the-shelf
+ or reusable libraries.
+
The sub-pages showcase some of the technologies used, for a better understanding
+ of how Trilium works but also to credit the developers of that particular
+ technology.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Technologies used/CKEditor.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Technologies used/CKEditor.html
new file mode 100644
index 000000000..c6da6762b
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Technologies used/CKEditor.html
@@ -0,0 +1,45 @@
+
Editor core
+
The CKEditor is the WYSIWYG (standing for What You See Is What You Get)
+ editor behind Text notes.
CKEditor by itself is a commercial product, but the core is open-source.
+ As described in its documentation,
+ the editor supports quite a large number of features. Do note that not
+ all the features are enabled in Trilium.
+
Premium features
+
Some features are marked as premium in the CKEditor feature set. This
+ means that they cannot be used without a license.
+
Trilium cannot benefit from any of these premium features as they require
+ a commercial license, however we are in discussions with the CKEditor team
+ to allow us to use a subset of these premium features such as Slash commands.
+
Plugins
+
The CKEditor ecosystem is quite extensible, in the sense that custom plugins
+ can be written to extend the functionality of the editor beyond its original
+ scope.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Templates.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Templates.html
new file mode 100644
index 000000000..4c91ffc9c
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Templates.html
@@ -0,0 +1,66 @@
+
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.
+
To specify a template for child notes, you can use a ~child:template relation
+ pointing to the appropriate template note. There is no limit to the depth
+ of the hierarchy — you can use ~child:child:template, ~child:child:child:template,
+ and so on.
+
+
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/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Templates_template-create-.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Templates_template-create-.png
new file mode 100644
index 000000000..e0de7dc97
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Templates_template-create-.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Templates_template.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Templates_template.png
new file mode 100644
index 000000000..72af71ad8
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Templates_template.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/1_Zen mode_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/1_Zen mode_image.png
new file mode 100644
index 000000000..347ade3a2
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/1_Zen mode_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/2_Zen mode_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/2_Zen mode_image.png
new file mode 100644
index 000000000..cd5a9ccde
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/2_Zen mode_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/3_Zen mode_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/3_Zen mode_image.png
new file mode 100644
index 000000000..e708d46de
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/3_Zen mode_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Import & Export/Evernote.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Import & Export/Evernote.html
new file mode 100644
index 000000000..42140ed52
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Import & Export/Evernote.html
@@ -0,0 +1,16 @@
+
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.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Import & Export/Markdown.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Import & Export/Markdown.html
new file mode 100644
index 000000000..d71887009
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Import & Export/Markdown.html
@@ -0,0 +1,46 @@
+
Trilium supports Markdown for both import and export, while trying to
+ keep compatibility as high as possible.
+
Import
+
Clipboard import
+
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.
When exporting, images are usually kept in the basic Markdown syntax but
+ will use the HTML syntax if the image has a custom width. Figures are always
+ embedded as HTML.
+
Tables
+
Simple tables are supported with the Markdown syntax. If the table is
+ too complex or contains elements that would render as HTML, the table is
+ also rendered as HTML.
+
Links
+
Standard Markdown links are supported.
+
Trilium internal links (that mirror a note's title and display its icon)
+ are embedded as HTML in order to preserve the information on import.
+
Math equations
+
Both inline and display equations are supported, using the $ and $$ syntaxes.
+
Admonitions
+
The Markdown syntax for admonitions as supported by Trilium is the one
+ that GitHub uses, which is as follows:
> [!NOTE]
+> This is a note.
+
+> [!TIP]
+> This is a tip.
+
+> [!IMPORTANT]
+> This is a very important information.
+
+> [!CAUTION]
+> This is a caution.
+
There are currently no plans of supporting alternative admonition syntaxes
+ such as !!! note.
+
Wikilinks
+
Basic support for wikilinks has been added in v0.96.0:
+
+
[[foo/bar]] will look for the bar.md file in the foo directory
+ and turn it into an internal link.
+
![[foo/baz.png]] will look for the baz.png file
+ in the foo directory and turn it into an image.
+
+
This feature is import-only, which means that it will turn wikilinks into
+ Trilium-compatible syntax, but it will not export Trilium Notes into Markdown
+ files with this syntax.
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Import & Export/Markdown_markdown-export-n.gif b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Import & Export/Markdown_markdown-export-n.gif
new file mode 100644
index 000000000..d1eb7c087
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Import & Export/Markdown_markdown-export-n.gif differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Import & Export/Markdown_markdown-export-s.gif b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Import & Export/Markdown_markdown-export-s.gif
new file mode 100644
index 000000000..13316bb5f
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Import & Export/Markdown_markdown-export-s.gif differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Import & Export/Markdown_markdown-file-imp.gif b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Import & Export/Markdown_markdown-file-imp.gif
new file mode 100644
index 000000000..bcb2541f3
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Import & Export/Markdown_markdown-file-imp.gif differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Import & Export/Markdown_markdown-inline-i.gif b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Import & Export/Markdown_markdown-inline-i.gif
new file mode 100644
index 000000000..bf27467fd
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Import & Export/Markdown_markdown-inline-i.gif differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Import & Export/OneNote.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Import & Export/OneNote.html
new file mode 100644
index 000000000..429a2cb67
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Import & Export/OneNote.html
@@ -0,0 +1,79 @@
+
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/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Themes/Theme Gallery.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Themes/Theme Gallery.html
new file mode 100644
index 000000000..0e7f7d56a
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Themes/Theme Gallery.html
@@ -0,0 +1,126 @@
+
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.
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Themes_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Themes_image.png
index e69de29bb..49df90730 100644
Binary files a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Themes_image.png and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Themes_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Note Tree.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Note Tree.html
index b3ef4588e..ee13f51dd 100644
--- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Note Tree.html
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Note Tree.html
@@ -30,5 +30,8 @@
in the context menu, or with the associated keyboard shortcuts: CTRL-C (
copy), Ctrl + X (cut) and Ctrl + V (paste).
-
Alt+Clickto add a single note to the current selection.
+
Shift+Clickto select a range of notes, starting
+ from the current note (the highlighted one) to the one that is being clicked.
+
+
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Zen mode.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Zen mode.html
new file mode 100644
index 000000000..7d10cb786
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Zen mode.html
@@ -0,0 +1,47 @@
+
+
+
+
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 F9 since TriliumNext 0.92.5
+ and Alt+Z for older versions). 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/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Zen mode_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Zen mode_image.png
new file mode 100644
index 000000000..bdd61d5ba
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Zen mode_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/FAQ.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/FAQ.html
new file mode 100644
index 000000000..24dfa9332
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/FAQ.html
@@ -0,0 +1,73 @@
+
macOS support
+
Originally, Trilium Notes considered the macOS build unsupported. TriliumNext
+ commits to make the experience on macOS as good as possible.
+
if you find any platform-specific issues, feel free to report them.
+
Translation / localisation support
+
The original Trilium Notes application did not support multiple languages.
+ Since we believe that internationalisation is a core part of an application,
+ we have added support for it.
+
Contributions to translations are welcome.
+
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/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types.html
new file mode 100644
index 000000000..711607951
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types.html
@@ -0,0 +1,132 @@
+
One core features of Trilium is that it supports multiple types of notes,
+ depending on the need.
+
Creating a new note with a different type via the note tree
+
The default note type in Trilium (e.g. when creating a new note) is
+ Text, since it's for general use.
+
To create a new note of a different type, head to the Note Tree and right click an existing
+ note where to place the new one and select:
+
+
Insert note after, to put the new note underneath the one selected.
+
Insert child note, to insert the note as a child of the selected
+ note.
+
+
+
+
+
Creating a new note of a different type via add link or new tab
+
+
When adding a link in a Text note, type the desired title
+ of the new note and press Enter. Afterwards the type of the note will be
+ asked.
+
Similarly, when creating a new tab, type the desired title and press Enter.
+
+
Changing the type of a note
+
It is possible to change the type of a note after it has been created
+ via the Basic Properties tab in the Ribbon. Note that it's generally a
+ good idea to change the note type only if the note is empty. Can also be
+ used to edit the source of a note.
+
Supported note types
+
The following note types are supported by Trilium:
Stores the information about a search (the search text, criteria, etc.)
+ for later use. Can be used for quick filtering of a large amount of notes,
+ for example. The search can easily be triggered.
Used in Scripting,
+ it displays the HTML content of another note. This allows displaying any
+ kind of content, provided there is a script behind it to generate it.
Displays diagrams such as bar charts, flow charts, state diagrams, etc.
+ Requires a bit of technical knowledge since the diagrams are written in
+ a specialized format.
Displays the children of the note as a geographical map, one use-case
+ would be to plan vacations. It even has basic support for tracks. Notes
+ can also be created from it.
Represents an uploaded file such as PDFs, images, video or audio files.
+
+
+
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/1_Code_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/1_Code_image.png
new file mode 100644
index 000000000..7520e45c1
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/1_Code_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/1_File_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/1_File_image.png
new file mode 100644
index 000000000..18ce5beff
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/1_File_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/1_Mermaid Diagrams_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/1_Mermaid Diagrams_image.png
new file mode 100644
index 000000000..381504c06
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/1_Mermaid Diagrams_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/1_Relation Map_relation-map-.gif b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/1_Relation Map_relation-map-.gif
new file mode 100644
index 000000000..8ff234f4e
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/1_Relation Map_relation-map-.gif differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/1_Relation Map_relation-map-.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/1_Relation Map_relation-map-.png
new file mode 100644
index 000000000..fb97d0e99
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/1_Relation Map_relation-map-.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/1_Text_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/1_Text_image.png
new file mode 100644
index 000000000..278d44dbc
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/1_Text_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/2_File_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/2_File_image.png
new file mode 100644
index 000000000..04478a3ad
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/2_File_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/2_Mermaid Diagrams_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/2_Mermaid Diagrams_image.png
new file mode 100644
index 000000000..ac8b0cf4c
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/2_Mermaid Diagrams_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/2_Text_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/2_Text_image.png
new file mode 100644
index 000000000..8a68dcb5a
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/2_Text_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/3_File_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/3_File_image.png
new file mode 100644
index 000000000..498813236
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/3_File_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/4_File_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/4_File_image.png
new file mode 100644
index 000000000..3dd5cebb8
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/4_File_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/5_File_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/5_File_image.png
new file mode 100644
index 000000000..af5bdfd5b
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/5_File_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/6_File_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/6_File_image.png
new file mode 100644
index 000000000..14044ba95
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/6_File_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Canvas.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Canvas.html
new file mode 100644
index 000000000..430c7ed66
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Canvas.html
@@ -0,0 +1,7 @@
+
Available since Trilium v0.52.
+
Canvas notes use the Excalidraw library to allow handwritten notes with
+ mouse, pen or touch on an infinite canvas. It also supports basic diagramming,
+ text and graphics input.
+
+
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Canvas_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Canvas_image.png
new file mode 100644
index 000000000..9259c84d5
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Canvas_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Code.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Code.html
new file mode 100644
index 000000000..95e10fd24
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Code.html
@@ -0,0 +1,53 @@
+
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 Scripting
+
+
+
+
JSON, XML etc. can be used as storage for structured data (typically used
+ in conjunction with scripting)
+
+
For shorter snippets of code that can be embedded in Text notes,
+ see Code blocks.
+
+
+
+
Adjusting the language of a code note
+
In the Ribbon, look for the Note type selector
+ and click it to reveal the possible note types. Inside of it there will
+ be a section called Code, select any one of the languages.
+
+
+
+
Adjusting the list of languages
+
Trilium supports syntax highlighting for many languages, but by default
+ displays only some of them. The supported languages can be adjusted by
+ going to Options, then Code Notes and
+ looking for the Available MIME types in the dropdown section. Simply
+ check any of the items to add them to the list, or un-check them to remove
+ them from the list.
+
Note that the list of languages is not immediately refreshed, you'd have
+ to manually refresh the application.
+
The list of languages is also shared with the Code blocks feature
+ of Text notes.
+
Color schemes
+
Since Trilium 0.94.0 the colors of code notes can be customized by going
+ Options → Code Notes and looking for the Appearance section.
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Code_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Code_image.png
new file mode 100644
index 000000000..f3ebaf673
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Code_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections.html
new file mode 100644
index 000000000..658fe8d99
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections.html
@@ -0,0 +1,20 @@
+
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
+
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.
+
It uses the Note List mechanism
+ to display the child notes, allowing the use of any of the view types (grid,
+ list, calendar).
+
To adjust the view type, see the dedicated Book tab in the
+ Ribbon.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections_image.png
new file mode 100644
index 000000000..ba4e1dd7a
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Collections_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/File.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/File.html
new file mode 100644
index 000000000..104d8dd6a
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/File.html
@@ -0,0 +1,138 @@
+
The File note type can be used to attach various external files
+ such as images, videos or PDF documents.
+
Uploading a file
+
Since these files come from an external source, it is not possible to
+ create a File note type directly:
Right click a note and select Import into note and point it to
+ one of the supported files.
+
+
Supported file types
+
PDFs
+
+
+
+
PDFs can be browsed directly from Trilium.
+
Interaction:
+
+
Press the menu icon at the top-left to see a preview (thumbnail) of all
+ the pages, as well as a table of contents (if the PDF has this information).
+
See or edit the page number at the top.
+
Adjust the zoom using the buttons at the top or manually editing the value.
+
Rotate the document if it's in the wrong orientation.
+
In the contextual menu:
+
+
View two pages at once (great for books).
+
Toggle annotations (if present in the document).
+
View document properties.
+
+
+
+
Images
+
+
+
+
Interaction:
+
+
Copy reference to clipboard, for embedding the image within
+ Text notes. See Image references for
+ more information.
+
+
Videos
+
+
+
+
Video files can be added in as well. The file is streamed directly, so
+ when accessing the note from a server it doesn't have to download the entire
+ video to start playing it.
+
+
Audio
+
+
+
+
Adding a supported audio file will reveal a basic audio player that can
+ be used to play it.
+
Interactions:
+
+
The audio can be played/paused using the dedicated button.
+
Dragging the mouse across, or clicking the progress bar will seek through
+ the song.
+
The volume can be set.
+
The playback speed can be adjusted via the contextual menu next to the
+ volume.
+
+
Text files
+
+
+
+
Files that are identified as containing text will show a preview of their
+ content. One common use case for this type of file is to embed text files
+ whose content is not necessarily of interest to the user, such as third-party
+ libraries or generated content, that can then be downloaded if needed.
+
Note that generally text files will be imported as
+ either Text or
+ Code notes. To bypass this behavior and create a File note
+ type, use the Import into note feature and uncheck Import HTML, Markdown and TXT as text notes,
+ as well as Import recognized code files as code notes.
+
Since one of the use cases for having files instead of notes is to display
+ large files, the content preview is limited to a relatively small amount
+ of characters. To view the full file, consider opening it in an external
+ application.
+
Unknown file types
+
+
+
+
If the file could not be identified as any of the supported file types
+ from above, it will be treated as an unknown file. In this case, all the
+ default interactions will be available such as downloading or opening the
+ file externally, but there will be no preview of the content.
+
Interaction
+
+
Regardless of the file type, a series of buttons will be displayed in
+ the Image or File tab in the Ribbon.
+
+
Download, which will download the file for local use.
+
Open, will will open the file with the system-default application.
+
Upload new revision to replace the file with a new one.
+
+
+
It is not possible to change the note type of a File note.
Files are also displayed in the Note List based
+ on their type:
+
+
+
+
Non-image files can be embedded into text notes as read-only widgets via
+ the Include Note functionality.
+
+
+
Image files can be embedded into text notes like normal images via
+ Image references.
+
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/File_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/File_image.png
new file mode 100644
index 000000000..0f01d19d9
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/File_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams.html
new file mode 100644
index 000000000..44850ab53
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams.html
@@ -0,0 +1,67 @@
+
+
+
+
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.
The source/preview can be laid out left-right or bottom-top via the Move editing pane to the left / bottom option.
+
Press Lock editing to automatically mark the note as read-only.
+ In this mode, the code pane is hidden and the diagram is displayed full-size.
+ Similarly, press Unlock editing to mark a read-only note as editable.
+
Press the Copy image reference to the clipboard to be able to insert
+ the image representation of the diagram into a text note. See Image references for more information.
+
Press the Export diagram as SVG to download a scalable/vector rendering
+ of the diagram. Can be used to present the diagram without degrading when
+ zooming.
+
Press the Export diagram as PNG to download a normal image (at
+ 1x scale, raster) of the diagram. Can be used to send the diagram in more
+ traditional channels such as e-mail.
+
+
+
+
Errors in the diagram
+
If there is an error in the source code, the error will be displayed in
+ an information pane.
+
During the state of an error, the diagram will no longer be rendered and
+ the previously working diagram will remain in the preview section.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams/ELK layout.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams/ELK layout.html
new file mode 100644
index 000000000..6ea404077
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams/ELK layout.html
@@ -0,0 +1,26 @@
+
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:
---
+config:
+ layout: elk
+---
+
+
+
+
With ELK off
+
With ELK on
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams/ELK layout_ELK off.svg b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams/ELK layout_ELK off.svg
new file mode 100644
index 000000000..a6a8a0125
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams/ELK layout_ELK off.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams/ELK layout_ELK on.svg b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams/ELK layout_ELK on.svg
new file mode 100644
index 000000000..1a400331d
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams/ELK layout_ELK on.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams_image.png
new file mode 100644
index 000000000..c0cc4cd31
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Mind Map.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Mind Map.html
new file mode 100644
index 000000000..48766db0c
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Mind Map.html
@@ -0,0 +1,39 @@
+
+
+
+
The mindmap allows for easy jotting down of ideas and storing them in
+ a hierarchical fashion.
+
Terminology
+
+
A node is a single idea, represented differently based
+ on depth (filled rounded rectangle for the root note, unfilled rectangles
+ for sub-ideas, lines only for sub-sub-ideas).
+
The root node is the top-most node from which all other
+ nodes derive, displayed as a filled rectangle. There can only be a single
+ root node.
+
+
Interaction
+
+
To create a new node at the same level as the current one, press Enter,
+ enter the desired text and then press Enter once again to confirm.
+
Similarly, to create a sub-node, press Tab, enter the desired
+ text and then press Enter.
+
To create a parent, use Ctrl+Enter instead.
+
To remove a node, press Delete.
+
To move a node up or down, press Page Up or Page Down.
+
To adjust the font size, color of the text or background or to add a link,
+ click on a node and use the floating panel that appears to the right.
+
To select one or more notes, drag and drop across the map.
+
Right click the node to bring a contextual menu with options such as creating
+ new nodes, focusing on a particular notes or creating links between them.
+
Use the buttons at the top-left to change the positioning of the nodes
+ relative to the root node (to the left, to the right, or to both sides).
An image reference can be copied,
+ to paste the mind map in a text note.
+
The diagram can be exported either as SVG (vectorial) or PNG (raster).
+
+
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Mind Map_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Mind Map_image.png
new file mode 100644
index 000000000..9e4481862
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Mind Map_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Note Map.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Note Map.html
new file mode 100644
index 000000000..9c567f670
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Note Map.html
@@ -0,0 +1,12 @@
+
+
+
+
A Note map is a note type which displays a standalone version of the feature
+ of the same name: Note Map (Link map, Tree map).
+
Once created, the note map will display the relations between notes. Only
+ the notes that are part of the parent of the note map will be displayed
+ (including their children).
+
The labels mapIncludeRelation and mapExcludeRelation,
+ if set, filter the note map to include only the specified relations or
+ to exclude the specified relations, respectively.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Note Map_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Note Map_image.png
new file mode 100644
index 000000000..2ba7707df
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Note Map_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Relation Map.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Relation Map.html
new file mode 100644
index 000000000..957acc574
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Relation Map.html
@@ -0,0 +1,75 @@
+
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.
Assign the renderNoterelation to
+ point at the previously created code note.
+
+
Dynamic content
+
A static HTML is generally not enough for Scripting. The next step is to automatically
+ change parts of the note using JavaScript.
+
For a simple example, we are going to create a render note that displays
+ the current date in a field.
+
To do so, first create an HTML code note with the following content:
<h1>Current date & time</h1>
+The current date & time is <span class="date"></span>
+
Now we need to add the script. Create another Code, but this time of JavaScript (frontend)
+ language. Make sure the newly created note is a direct child of the HTML
+ note created previously; with the following content:
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Render Note_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Render Note_image.png
new file mode 100644
index 000000000..75e246c44
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Render Note_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Saved Search.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Saved Search.html
new file mode 100644
index 000000000..6d6794743
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Saved Search.html
@@ -0,0 +1,15 @@
+
Trilium allows you to save common searches as notes within the note tree.
+ The search results will appear as sub-notes under these "saved search"
+ notes. Here is an example of how it works:
+
+
+
+
+
Location
+
By default, saved searches are stored in the day note. However, you can
+ designate a different note to store saved searches by marking it with the #searchHome label.
+ Additionally, for workspaces, you
+ can use the #workspaceSearchHome label to specify a storage
+ location for saved searches within that workspace.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Saved Search_saved-search.gif b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Saved Search_saved-search.gif
new file mode 100644
index 000000000..72864f1cc
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Saved Search_saved-search.gif differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text.html
new file mode 100644
index 000000000..b09ee1395
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text.html
@@ -0,0 +1,187 @@
+
The default note type in Trilium, text notes allow for rich formatting,
+ tables, images, admonitions and a handful of other features.
+
Formatting bars
+
Most of the interaction with text notes is done via the built-in toolbars.
+ Depending on preference, there are two different layouts:
+
+
The Floating toolbar is hidden by default and only appears when
+ needed. In this mode there are actually two different toolbars:
+
+
+
+
+
A toolbar that appears when text is selected. This provides text-level
+ formatting such as bold, italic, text colors, inline code, etc.
+
+
Text notes are usually opened in edit mode. However, they may open in
+ read-only mode if the note is too big or the note is explicitly marked
+ as read-only. For more information, see Read-Only Notes.
+
Keyboard shortcuts
+
There are numerous keyboard shortcuts to format the text without having
+ to use the mouse. For a reference of all the key combinations, see
+ Keyboard Shortcuts. In addition, see Markdown-like formatting as an
+ alternative to the keyboard shortcuts.
+
Technical details
+
For the text editing functionality, Trilium uses a commercial product
+ (with an open-source base) called CKEditor.
+ This brings the benefit of having a powerful WYSIWYG (What You See Is What
+ You Get) editor.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/10_Images_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/10_Images_image.png
new file mode 100644
index 000000000..32f99c37c
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/10_Images_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/10_Lists_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/10_Lists_image.png
new file mode 100644
index 000000000..1282f27ec
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/10_Lists_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/10_Tables_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/10_Tables_image.png
new file mode 100644
index 000000000..5cf2cc519
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/10_Tables_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/11_Tables_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/11_Tables_image.png
new file mode 100644
index 000000000..cde63c9ac
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/11_Tables_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/12_Tables_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/12_Tables_image.png
new file mode 100644
index 000000000..9c512ee53
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/12_Tables_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Block quotes & admonitions.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Block quotes & admonitions.png
new file mode 100644
index 000000000..175c661f7
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Block quotes & admonitions.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Bookmarks_plus.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Bookmarks_plus.png
new file mode 100644
index 000000000..84183c1e8
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Bookmarks_plus.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Developer-specific formatt.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Developer-specific formatt.png
new file mode 100644
index 000000000..9580128a2
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Developer-specific formatt.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Footnotes_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Footnotes_image.png
new file mode 100644
index 000000000..64c876e33
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Footnotes_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Formatting toolbar_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Formatting toolbar_image.png
new file mode 100644
index 000000000..bc6bd96c4
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Formatting toolbar_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_General formatting_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_General formatting_image.png
new file mode 100644
index 000000000..295d3c809
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_General formatting_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Images_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Images_image.png
new file mode 100644
index 000000000..a4e23ef9a
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Images_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Insert buttons_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Insert buttons_image.png
new file mode 100644
index 000000000..7ae8c13cc
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Insert buttons_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Insert buttons_plus.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Insert buttons_plus.png
new file mode 100644
index 000000000..723ca82d7
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Insert buttons_plus.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Lists_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Lists_image.png
new file mode 100644
index 000000000..fba0cc85c
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Lists_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Math Equations_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Math Equations_image.png
new file mode 100644
index 000000000..e81487085
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Math Equations_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Other features_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Other features_image.png
new file mode 100644
index 000000000..6618b1375
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Other features_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Tables_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Tables_image.png
new file mode 100644
index 000000000..4dacba1e3
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Tables_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/2_Block quotes & admonitions.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/2_Block quotes & admonitions.png
new file mode 100644
index 000000000..afc26f32c
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/2_Block quotes & admonitions.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/2_Developer-specific formatt.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/2_Developer-specific formatt.png
new file mode 100644
index 000000000..295d3c809
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/2_Developer-specific formatt.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/2_Formatting toolbar_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/2_Formatting toolbar_image.png
new file mode 100644
index 000000000..c7d879eba
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/2_Formatting toolbar_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/2_General formatting_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/2_General formatting_image.png
new file mode 100644
index 000000000..aa65a36f0
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/2_General formatting_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/2_Images_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/2_Images_image.png
new file mode 100644
index 000000000..08a40b0d0
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/2_Images_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/2_Insert buttons_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/2_Insert buttons_image.png
new file mode 100644
index 000000000..66cd278a0
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/2_Insert buttons_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/2_Lists_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/2_Lists_image.png
new file mode 100644
index 000000000..ee7a6bdea
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/2_Lists_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/2_Other features_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/2_Other features_image.png
new file mode 100644
index 000000000..e6cd79c22
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/2_Other features_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/2_Tables_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/2_Tables_image.png
new file mode 100644
index 000000000..5cc9f0b7b
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/2_Tables_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/3_Developer-specific formatt.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/3_Developer-specific formatt.png
new file mode 100644
index 000000000..67c4c43fe
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/3_Developer-specific formatt.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/3_Formatting toolbar_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/3_Formatting toolbar_image.png
new file mode 100644
index 000000000..3270223e2
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/3_Formatting toolbar_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/3_General formatting_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/3_General formatting_image.png
new file mode 100644
index 000000000..d19a5e7a0
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/3_General formatting_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/3_Images_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/3_Images_image.png
new file mode 100644
index 000000000..297d49ee5
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/3_Images_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/3_Insert buttons_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/3_Insert buttons_image.png
new file mode 100644
index 000000000..b6b417931
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/3_Insert buttons_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/3_Lists_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/3_Lists_image.png
new file mode 100644
index 000000000..32992762a
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/3_Lists_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/3_Other features_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/3_Other features_image.png
new file mode 100644
index 000000000..c3cead392
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/3_Other features_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/3_Tables_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/3_Tables_image.png
new file mode 100644
index 000000000..092a053e5
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/3_Tables_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/4_Developer-specific formatt.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/4_Developer-specific formatt.png
new file mode 100644
index 000000000..ef28ed50d
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/4_Developer-specific formatt.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/4_General formatting_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/4_General formatting_image.png
new file mode 100644
index 000000000..7d1208b10
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/4_General formatting_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/4_Images_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/4_Images_image.png
new file mode 100644
index 000000000..9f8ecc326
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/4_Images_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/4_Insert buttons_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/4_Insert buttons_image.png
new file mode 100644
index 000000000..614c755b2
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/4_Insert buttons_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/4_Lists_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/4_Lists_image.png
new file mode 100644
index 000000000..8369a03c6
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/4_Lists_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/4_Other features_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/4_Other features_image.png
new file mode 100644
index 000000000..3645073c6
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/4_Other features_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/4_Tables_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/4_Tables_image.png
new file mode 100644
index 000000000..eaf4d9694
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/4_Tables_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/5_Developer-specific formatt.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/5_Developer-specific formatt.png
new file mode 100644
index 000000000..c0cf731a5
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/5_Developer-specific formatt.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/5_Images_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/5_Images_image.png
new file mode 100644
index 000000000..2e37305ca
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/5_Images_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/5_Insert buttons_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/5_Insert buttons_image.png
new file mode 100644
index 000000000..1221e39b9
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/5_Insert buttons_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/5_Lists_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/5_Lists_image.png
new file mode 100644
index 000000000..ed6f4c37c
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/5_Lists_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/5_Other features_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/5_Other features_image.png
new file mode 100644
index 000000000..ee7a6bdea
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/5_Other features_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/5_Tables_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/5_Tables_image.png
new file mode 100644
index 000000000..5df4b16ce
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/5_Tables_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/6_Developer-specific formatt.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/6_Developer-specific formatt.png
new file mode 100644
index 000000000..ddc7e16e7
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/6_Developer-specific formatt.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/6_Images_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/6_Images_image.png
new file mode 100644
index 000000000..f8c5cf48f
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/6_Images_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/6_Insert buttons_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/6_Insert buttons_image.png
new file mode 100644
index 000000000..28711b3cb
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/6_Insert buttons_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/6_Lists_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/6_Lists_image.png
new file mode 100644
index 000000000..0ab30524b
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/6_Lists_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/6_Other features_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/6_Other features_image.png
new file mode 100644
index 000000000..4c702d538
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/6_Other features_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/6_Tables_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/6_Tables_image.png
new file mode 100644
index 000000000..3394d4661
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/6_Tables_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/7_Images_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/7_Images_image.png
new file mode 100644
index 000000000..731df83bb
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/7_Images_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/7_Insert buttons_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/7_Insert buttons_image.png
new file mode 100644
index 000000000..68028bba0
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/7_Insert buttons_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/7_Lists_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/7_Lists_image.png
new file mode 100644
index 000000000..3caf2d880
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/7_Lists_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/7_Tables_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/7_Tables_image.png
new file mode 100644
index 000000000..4b7670285
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/7_Tables_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/8_Images_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/8_Images_image.png
new file mode 100644
index 000000000..0167e759b
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/8_Images_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/8_Insert buttons_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/8_Insert buttons_image.png
new file mode 100644
index 000000000..20581dfa7
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/8_Insert buttons_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/8_Lists_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/8_Lists_image.png
new file mode 100644
index 000000000..4a17f481c
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/8_Lists_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/8_Tables_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/8_Tables_image.png
new file mode 100644
index 000000000..cde63c9ac
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/8_Tables_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/9_Images_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/9_Images_image.png
new file mode 100644
index 000000000..8fa28fbf9
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/9_Images_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/9_Lists_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/9_Lists_image.png
new file mode 100644
index 000000000..2473cd310
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/9_Lists_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/9_Tables_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/9_Tables_image.png
new file mode 100644
index 000000000..099b25357
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/9_Tables_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Block quotes & admonitions.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Block quotes & admonitions.html
new file mode 100644
index 000000000..6f16fc214
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Block quotes & admonitions.html
@@ -0,0 +1,65 @@
+
Block quotes
+
As the name suggests, block quotes can be useful to cite one or more paragraphs.
+
To create a block quote, press
+ from the Formatting toolbar.
+ It's also possible to type >, followed by a space to create
+ one (but only if the cursor is at the beginning of a line).
+
Inside the quote block, other block items can be inserted such as tables,
+ images, or even other block quotes or admonitions.
+
Admonitions
+
Admonitions are a way to highlight information to the reader. Other names
+ for it include call-outs and info/warning/alert boxes.
+
+
+
+
From a functional point of view, admonitions act very similarly to a block
+ quote, just with different styling. This includes the ability to insert
+ other elements in it such as headings, tables, images, etc.
It's possible to insert an admonition simply by typing:
+
+
!!! note
+
+
!!! tip
+
+
!!! important
+
+
!!! caution
+
+
!!! warning
+
+
+
In addition to that, it's also possible to type !!!
+ followed by any text, case in which a default admonition type will appear
+ (note) with the entered text inside it.
+
Interaction
+
By design, admonitions act very similar to block quotes.
+
+
Selecting a text and pressing the admonition button will turn that text
+ into an admonition.
+
If selecting multiple admonitions, pressing the admonition button will
+ automatically merge them into one.
+
+
Inside an admonition:
+
+
Pressing Backspace while the admonition is empty will remove
+ it.
+
Pressing Enter will start a new paragraph. Pressing it twice
+ will exit out of the admonition.
+
Headings and other block content including tables can be inserted inside
+ the admonition.
+
+
Types of admonitions
+
There are currently five types of admonitions: Note, Tip, Important, Caution, Warning.
+
These types were inspired by GitHub's support for this feature and there
+ are currently no plans for adjusting it or allowing the user to customize
+ them.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Block quotes & admonitions.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Block quotes & admonitions.png
new file mode 100644
index 000000000..ee95e6653
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Block quotes & admonitions.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Bookmarks.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Bookmarks.html
new file mode 100644
index 000000000..8e1e9979f
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Bookmarks.html
@@ -0,0 +1,29 @@
+
Bookmarks allows creating links to
+ a certain part of a note, such as referencing a particular heading.
+
Technically, bookmarks are HTML anchors.
+
This feature was introduced in TriliumNext 0.94.0.
+
Interaction
+
+
To create a bookmark:
+
+
Place the cursor at the desired position where to place the bookmark.
+
Look for the
+ button in the Formatting toolbar,
+ and then press the
+ button.
+
+
+
To place a link to a bookmark:
+
+
Place the cursor at the desired position of the link.
+
From the link pane, select the Bookmarks section
+ and select the desired bookmark.
+
+
+
+
Limitations
+
+
Currently it's not possible to create a link to a bookmark from a different
+ note. This functionality will be added after the internal links feature
+ is enhanced to support bookmarks.
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Bookmarks_plus.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Bookmarks_plus.png
new file mode 100644
index 000000000..b2dc917a6
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Bookmarks_plus.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Content language & Right-t.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Content language & Right-t.png
new file mode 100644
index 000000000..dee799386
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Content language & Right-t.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Content language & Right-to-le.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Content language & Right-to-le.html
new file mode 100644
index 000000000..6f0462213
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Content language & Right-to-le.html
@@ -0,0 +1,15 @@
+
+
+
+
A language hint can be provided for text notes. This option informs the
+ browser or the desktop application about the language the note is written
+ in (for example this might help with spellchecking), and it also determines
+ whether the text is displayed from right-to-left for languages such as
+ Arabic, Hebrew, etc.
+
Setting the language
+
To set the language of the content, go to “Basic Properties” and look
+ for the “Language” field.
+
Adjusting the list of languages
+
By default there will be no language configured, they can be configured
+ by going to settings or by selecting the “Configure languages” item when
+ setting the language.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Cut to subnote.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Cut to subnote.html
new file mode 100644
index 000000000..853088334
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Cut to subnote.html
@@ -0,0 +1,17 @@
+
+
+
+
When editing a document that becomes too large, you can split it into
+ sub-notes:
+
+
Select the desired text and cut it to the clipboard.
+
Create a new sub-note and name it.
+
Paste the content from the clipboard into the sub-note.
+
+
Trilium can automate this process. Select some text within the note, and
+ in the selection toolbar, click the scissors icon for the "cut & pasted
+ selection to sub-note" action. The heading is automatically detected and
+ the new sub-note is named accordingly. You can also assign a keyboard shortcut
+ for this action. This functionality is available through the block toolbar
+ icon.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Cut to subnote_cut-to-subn.gif b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Cut to subnote_cut-to-subn.gif
new file mode 100644
index 000000000..b71afd0bd
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Cut to subnote_cut-to-subn.gif differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Developer-specific formatt.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Developer-specific formatt.png
new file mode 100644
index 000000000..6ae0fd87a
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Developer-specific formatt.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Developer-specific formatting.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Developer-specific formatting.html
new file mode 100644
index 000000000..be60556c4
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Developer-specific formatting.html
@@ -0,0 +1,42 @@
+
Inline code
+
Inline code formats text using a monospace font to indicate technical
+ content in a sentence such as code, paths, etc.
+
+
+
+
Example of inline code being used to illustrate file system paths as well
+ as shell commands (git in this case).
Pressing directly on the icon will insert a code block with the language
+ that was selected most recently. If this is the first time a code block
+ is inserted, the language will be “Auto-detected” by default.
+
Pressing the arrow next to the icon, which will show a popup with the
+ available languages.
+
+
+
Type ``` (as in Markdown).
+
+
Note that it's not possible to specify the language, as it will default
+ to the last selected language.
+
+
+
+
Syntax highlighting & color schemes
+
Since TriliumNext v0.90.12, Trilium will try to offer syntax highlighting
+ to the code block. Note that the syntax highlighting mechanism is slightly
+ different than the one in Code notes
+ as different technologies are involved.
+
Interaction:
+
+
When the language is set to Auto-detected (by default), Trilium
+ will try to identify the programming language (or similar) that corresponds
+ to the given snippet of text and highlight it. If this is problematic,
+ consider changing the language of the code block manually.
+
When the language is set to Plain text, there will be no syntax
+ highlighting.
+
+
Note that when editing a text note, syntax highlighting is automatically
+ disabled if the code block is too big (somewhere around 500 lines). This
+ value is currently not configurable. For Read-Only Notes, this limitation is
+ not applied.
+
In order to configure this new feature, a section has been added in Options
+ → Appearance to control the syntax highlighting. There the color scheme
+ can be chosen, from a builtin selection of themes from Highlight.js.
+
+
It is possible to disable the syntax highlighting for all the notes by
+ selecting “No syntax highlighting” in the “Color scheme” option.
+
Word wrapping is disabled by default, but can be configured from the same
+ section.
+
+
+
Migrating from existing syntax highlight plugins
+
If you are already using a syntax highlighting plugin such as the Trilium-SyntaxHighlightWidget we
+ are basing off of, it is important to disable that plugin before upgrading
+ in order for it not to conflict with our implementation.
+
Should you encounter any issues after the migration, try running Trilium
+ in safe mode.
+
Changing the language of a code block
+
Simply click anywhere inside the code block and press again the code block
+ button in the Formatting toolbar:
+
+
+
+
Adjusting the list of languages
+
The code blocks feature shares the list of languages with the
+ Code note type.
+
The supported languages can be adjusted by going to Options, then Code Notes and
+ looking for the Available MIME types in the dropdown section. Simply
+ check any of the items to add them to the list, or uncheck them to remove
+ them from the list.
+
Note that the list of languages is not immediately refreshed, you'd have
+ to manually refresh the application.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Developer-specific formatting/Code blocks_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Developer-specific formatting/Code blocks_image.png
new file mode 100644
index 000000000..cabd7f48a
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Developer-specific formatting/Code blocks_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Footnotes.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Footnotes.html
new file mode 100644
index 000000000..dc63ed511
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Footnotes.html
@@ -0,0 +1,21 @@
+
+
+
+
Footnotes are a good place to insert references to a paragraph or details
+ that are displayed at the bottom of the note.
+
Interaction
+
+
To insert a new footnote, press
+ (or press the right arrow and select New footnote).
+
To insert a reference to an existing footnote, press the right arrow and
+ select Insert footnote, followed by the number of the footnote
+ to insert.
+
Hovering over a reference (e.g. [1]) will display the content
+ of the footnote in a tooltip for easy reference.
+
Clicking on a reference in the text (e.g. [1]) will navigate
+ to the corresponding footnote.
+
Similarly, clicking on the ^ button of a footnote will navigate
+ to the corresponding reference in the text.
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Footnotes_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Footnotes_image.png
new file mode 100644
index 000000000..8c69b7fdd
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Footnotes_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Formatting toolbar.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Formatting toolbar.html
new file mode 100644
index 000000000..72e18f740
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Formatting toolbar.html
@@ -0,0 +1,39 @@
+
Trilium allows two different editing experiences for text notes, based
+ on your preference.
+
The type of formatting toolbar can be changed by going to Options and then looking for the
+ Text Notes section. In it, look for the Formatting toolbar category.
+
Floating
+
The floating bar is a more minimalist option, in which the formatting
+ is hidden behind two different popups.
+
Block-level popup
+
The first popup is the block-level popup. This will appear to the left
+ of the current paragraph you are currently editing, as a sequence of dots:
+
+
+
+
Clicking this popup will reveal the formatting options that are specific
+ to the entire paragraph, such as setting a heading, lists, tables, etc.
+
+
+
+
Inline popup
+
The inline popup appears automatically when selecting a text:
+
+
+
+
All the options here apply only to the selected portion of text, such
+ as changing the font size, or making the text bold.
+
Fixed
+
The fixed formatting offers a more traditional editing paradigm, usually
+ useful if a lot of formatting is needed.
+
All the options are combined into a single toolbar that will appear as
+ part of the Ribbon.
+
+
+
+
By default, if the toolbar does not fit on the screen, the rest of the
+ options will be grouped into a single option at the end. It is possible
+ to display items on multiple lines by checking the corresponding option
+ in the Formatting toolbar section.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Formatting toolbar_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Formatting toolbar_image.png
new file mode 100644
index 000000000..85578b78e
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Formatting toolbar_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/General formatting.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/General formatting.html
new file mode 100644
index 000000000..8ee8f6989
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/General formatting.html
@@ -0,0 +1,94 @@
+
Headings
+
+
+
+
Trilium provides headings to define sections within text. Headings are
+ numbered from 2 to 6.
+
The reason why Heading 1 is missing from the list is that it is being
+ reserved for the title of note.
+
To turn a heading back into a normal text, select Paragraph from
+ the list.
+
Apart from using the UI, it is also possible to quickly insert headings
+ using the Markdown-like shortcuts:
+
+
## for Heading 2
+
### for Heading 3
+
#### for Heading 4
+
##### for Heading 5
+
###### for Heading 6
+
+
Font size
+
+
+
+
One way to highlight a portion of text is to increase the size of the
+ font.
+
To do so, select some text and choose an option from the Font size selector
+ (as pictured to the right).
+
Unlike other text editors such as Microsoft Word, the font size is relative
+ (i.e. “Tiny”, “Small” instead of a number like 12).
+
Avoid using this feature just to simply make all text bigger. In that
+ case it's generally better to adjust the font size for all notes in
+ Options or by zooming.
+
Bold, italic, underline, strike-through
+
+
+
+
Text can be formatted as Bold,Italic, Underline
+ or Strike-through via the dedicated buttons in the formatting
+ toolbar.
+
This formatting can be easily removed using the Remove formatting item.
+
The following keyboard shortcuts can be used here:
+
+
Ctrl+B for bold
+
Ctrl+I for italic
+
Ctrl+U for underline
+
+
Alternatively, Markdown-like formatting can be used:
+
+
Bold: Type **text** or __text__
+
+
Italic: Type *text* or _text_
+
+
Strikethrough: Type ~~text~~
+
+
+
Superscript, subscript
+
This allows writing superscript or subscript text.
+
This is mostly useful for units of measure (e.g. cm3 for cubic centimeters)
+ and chemical notations (e.g. NaHCO3)
+
For mathematical formulas, prefer the Math Equations feature
+ instead.
+
Font color and background color
+
+
+
+
Selected text can be colored with one of the predefined colors from a
+ palette or any color can be selected using the color picker.
+
Once there is at least one color defined in the document, it will appear
+ in the list for easy reuse.
+
When selecting a foreground or a background color, consider the contrast
+ if switching between a dark theme or a light theme.
+
To remove either the background or foreground color of a text, select
+ the corresponding formatting button and press Remove color or use
+ the Remove formatting toolbar item.
+
Remove formatting
+
The
+ Remove formatting button is a quick way to eliminate the general
+ formatting styling of a particular text.
+
Simply select the text and press the button to remove the formatting (bold,
+ italic, colors, sizes, etc.). If the text does not have any removable formatting,
+ the button will appear disabled.
+
Note that heading styles are not taken into consideration, these must
+ be manually changed back to a paragraph according to the Headings section.
+
When pasting content that comes with undesired formatting, an alternative
+ to pasting and then removing formatting is pasting as plain text via Ctrl+Shift+V.
+
Support for Markdown
+
When exported to Markdown,
+ most of the general formatting is maintained such as headings, bold, italic,
+ underline, etc.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/General formatting_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/General formatting_image.png
new file mode 100644
index 000000000..1d1cfb3ea
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/General formatting_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Highlights list.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Highlights list.html
new file mode 100644
index 000000000..b492c7cc0
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Highlights list.html
@@ -0,0 +1,32 @@
+
+
+
+
Similar to the Table of contents,
+ but instead of headings this feature will list highlighted text from a
+ text note and allow easy navigation to them. The list will be displayed
+ in the Right Sidebar,
+ provided there is at least one highlighted text.
+
Highlighted text is defined as:
+
+
Bold text.
+
Italic text.
+
Underlined text.
+
Text with a foreground color set.
+
Text with a background color/highlight set.
+
+
Interaction
+
+
Clicking on a highlighted text will scroll the document to its position.
+
Pressing the close button will dismiss the list of highlights but it can
+ be shown again from the Floating buttons section.
+
+
Global configuration
+
It's possible to toggle the display of each category of highlighted text
+ (as defined above) in the highlights list by going to Text Notes settings
+ and looking for the Highlights List section.
+
Per-note configuration
+
To suppress the display of highlighted text for one specific note, use
+ Attributes to add the #hideHighlightWidget label.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Highlights list_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Highlights list_image.png
new file mode 100644
index 000000000..2115d49ba
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Highlights list_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Images.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Images.html
new file mode 100644
index 000000000..3ac99f8af
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Images.html
@@ -0,0 +1,106 @@
+
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.
+
Configuring the images
+
Clicking on an image will reveal a popup with multiple options:
+
+
+
+
Alignment
+
The first set of options configure the alignment are, in order:
+
+
+
+
+
Icon
+
Option
+
Preview
+
Description
+
+
+
+
+
+
+
+
Inline
+
+
+
+
As the name suggests, the name can be put inside a paragraph and moved
+ around similarly as if it was a block of text. Use drag & drop or cut-paste
+ to move it around.
+
+
+
+
+
+
Centered image
+
+
+
+
The image will be displayed as a block and centered, not allowing text
+ in either the left or right of it.
+
+
+
+
+
+
Wrap text
+
+
+
+
The image will be displayed to the left or the right of the text.
+
+
+
+
+
+
Block align
+
+
+
+
Similarly to Centered image, the image will be displayed as a
+ block and aligned either to the left or to the right, but not allowing
+ text to flow on either of its sides.
+
+
+
+
+
+
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 (look for the contextual menu in
+ Note buttons → Import files).
+
Aligning images side-by-side
+
There are generally two ways to display images side by side:
+
+
If they are roughly the same size, simply make the two images in-line,
+ according to the alignment section above. The images can be dragged &
+ dropped onto the same line.
+
If they are on different size, create a table with
+ invisible borders.
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Images/1_Image references_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Images/1_Image references_image.png
new file mode 100644
index 000000000..d6ca4aa80
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Images/1_Image references_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Images/Image references.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Images/Image references.html
new file mode 100644
index 000000000..c9b26fc84
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Images/Image references.html
@@ -0,0 +1,31 @@
+
+
+
+
Image references are an easy way to embed the preview of another note
+ type into a Text note.
Go to one of the supported notes (listed above) and look for the
+ button in the Floating buttons area.
+
Go to a Text note
+ and use the Paste function to insert the reference to that note.
+
+
Interaction
+
+
Double-clicking an image reference from a text note will automatically
+ open the target note.
+
Clicking an image reference while Ctrl is pressed will open the
+ target note in a new tab.
+
Modifying the target note should also update the image reference. If that
+ doesn't happen, consider Refreshing the application.
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Images/Image references_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Images/Image references_image.png
new file mode 100644
index 000000000..a54daef4a
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Images/Image references_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Images_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Images_image.png
new file mode 100644
index 000000000..938a0d2b3
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Images_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Include Note.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Include Note.html
new file mode 100644
index 000000000..84adc92de
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Include Note.html
@@ -0,0 +1,8 @@
+
Text notes can "include" another note as a read-only widget. This can
+ be useful for e.g. including a dynamically generated chart (from scripts
+ & "render HTML" note) or other more advanced use cases.
+
Including a note
+
In the Formatting toolbar,
+ look for the
+ button. There is also a keyboard shortcut defined for it but it is not
+ allocated by default.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Include Note_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Include Note_image.png
new file mode 100644
index 000000000..6fb41a445
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Include Note_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Insert buttons.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Insert buttons.html
new file mode 100644
index 000000000..d74b7f43b
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Insert buttons.html
@@ -0,0 +1,77 @@
+
Press the
+ button in the Formatting toolbar to
+ reveal special inserable items and blocks such as symbols, Math expressions
+ and separators.
This feature allows inserting Unicode emoji characters. Simply select
+ a category and a desired emoji to insert it.
+
Emojis can also be searched by their English name and the skin tone can
+ be selected via a combo box to the right.
+
There is also the possibility of inserting emojis directly by typing : followed
+ by a name of an emoji, triggering the display of a list of emojis. Simply
+ use the arrow keys to select one and press Enter to insert it.
+
+
+
Symbols
+
+
+
+
Pressing the
+ button will reveal a popup window displaying a list of characters that
+ are generally more difficult to insert directly from the keyboard, such
+ as a subset of emojis, quotation characters, etc.
+
Interaction:
+
+
Click on a character to insert it at the current cursor position.
+
The window can be dragged around by the top bar where the title is, to
+ avoid it getting in the way of the text.
+
Click on the Category selector to filter the characters.
Press the
+ button to create an inline Mermaid diagram.
+
This feature is quite similar to the Mermaid Diagrams note
+ types and is meant as an alternative to it for simple diagrams. For more
+ complex diagrams, use the Include Note feature
+ for a dedicated Mermaid note.
+
+
+
+
+
Horizontal ruler
+
This feature will display a horizontal line, generally useful to separate
+ different sections of the text. To do so, press the
+ button in the Formatting toolbar.
+
+
Alternatively, it's possible to insert a horizontal ruler by typing ---.
+
Page break
+
+
+
+
Page breaks provide a way to force the next paragraph or block (table,
+ image, etc.) to be displayed onto the next page when printing (either to
+ a real printer to when exporting to PDF).
+
Page breaks are marked in the editor with the words Page break,
+ but they will not actually be shown when printed.
+
+
To insert a page break, press the
+ in the formatting toolbar.
+
To insert many page breaks at once, insert a page break first, click on
+ it and press Ctrl+C. Then use Ctrl+V,
+ to paste as many times as needed.
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Insert buttons_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Insert buttons_image.png
new file mode 100644
index 000000000..b2bdcc520
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Insert buttons_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Insert buttons_plus.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Insert buttons_plus.png
new file mode 100644
index 000000000..5cd65f1e1
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Insert buttons_plus.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Keyboard shortcuts.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Keyboard shortcuts.html
new file mode 100644
index 000000000..f26061d1c
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Keyboard shortcuts.html
@@ -0,0 +1,443 @@
+
Trilium-specific shortcuts
+
+
+
+
+
Action
+
PC
+
Mac
+
+
+
+
+
Bring up inline formatting toolbar (arrow keys ←,→ to
+ navigate, Enter to apply)
Blocks are images, tables, blockquotes, annotations.
+
+
+
+
+
Action
+
PC
+
Mac
+
+
+
+
+
Insert a new paragraph directly after a widget
+
Enter
+
+
+
+
+
Insert a new paragraph directly before a widget
+
Shift+Enter
+
+
⇧Enter
+
+
+
+
Move the caret to allow typing directly before a widget
+
↑, ←
+
+
+
+
+
Move the caret to allow typing directly after a widget
+
↓, →
+
+
+
+
+
After entering a nested editable, move the selection to the closest ancestor
+ widget. For example: move from an image caption to the whole image widget.
+
Tab then Esc
+
+
+
+
+
+
+
Specifically for lists:
+
+
+
+
+
Action
+
PC
+
Mac
+
+
+
+
+
Increase list item indent
+
⇥
+
+
+
+
+
Decrease list item indent
+
Shift+⇥
+
+
⇧⇥
+
+
+
+
+
+
In tables:
+
+
+
+
+
Action
+
PC
+
Mac
+
+
+
+
+
Move the selection to the next cell
+
⇥
+
+
+
+
+
Move the selection to the previous cell
+
Shift+⇥
+
+
⇧⇥
+
+
+
+
Insert a new table row (when in the last cell of a table)
+
⇥
+
+
+
+
+
Navigate through the table
+
↑, →, ↓, ←
+
+
+
+
+
+
+
+
General UI shortcuts
+
+
+
+
+
Action
+
PC
+
Mac
+
+
+
+
+
Close contextual balloons, dropdowns, and dialogs
+
Esc
+
+
+
+
+
Open the accessibility help dialog
+
Alt+0
+
+
⌥0
+
+
+
+
Move focus between form fields (inputs, buttons, etc.)
+
⇥, Shift+⇥
+
+
⇥, ⇧⇥
+
+
+
+
Move focus to the toolbar, navigate between toolbars
+
Alt+F10
+
+
⌥F10 (may require Fn)
+
+
+
Navigate through the toolbar or menu bar
+
↑, →, ↓, ←
+
+
+
+
+
Navigate to the next focusable field or an element outside the editor
+
Tab, Shift+Tab
+
+
+
+
+
Execute the currently focused button. Executing buttons that interact
+ with the editor content moves the focus back to the content.
+
Enter, Space
+
+
+
+
+
Move focus in and out of an active dialog window
+
Ctrl+F6
+
+
⌘F6 (may require Fn)
+
+
+
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Links.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Links.html
new file mode 100644
index 000000000..ab4d227e1
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Links.html
@@ -0,0 +1,35 @@
+
There are two types of links:
+
+
External links,
+ for standard hyperlinks to websites or other resources.
For internal links (links to notes in Trilium), press Ctrl+C in the
+ Note Tree:
+
+
Pasting directly in a text note will create a reference link (with an
+ icon to the note and the actual note title).
+
Pasting over an existing text will create a traditional link.
+
+
+
For external links:
+
+
Paste the raw URL directly and press space to turn it into a link.
+
Select a text and paste the URL over it to turn that text into a link.
+
If you are pasting a formatted link (e.g. from the a webpage in a browser),
+ simply paste it and it will keep the original text and URL.
+
+
+
+
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/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Links/1_External links_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Links/1_External links_image.png
new file mode 100644
index 000000000..03fdc6792
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Links/1_External links_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Links/2_External links_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Links/2_External links_image.png
new file mode 100644
index 000000000..72b2415d5
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Links/2_External links_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Links/External links.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Links/External links.html
new file mode 100644
index 000000000..e296eef5a
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Links/External links.html
@@ -0,0 +1,38 @@
+
Filling in the desired note to link. It's also possible to create notes
+ from this dialog by typing a non-existing note title and selecting Create and link child note.
+
+
There are two link types, adjustable when creating the link to the note:
+
+
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.
+
The icon of the note is also displayed.
+
The link title will automatically update if the title of the note is changed.
+
+
+
link title can be changed arbitrarily
+
+
This is the traditional hyperlink, where the text of the link can be different
+ to the note title.
+
+
+
+
Once an internal link is created:
+
+
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.
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Links/Internal (reference) links.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Links/Internal (reference) links.png
new file mode 100644
index 000000000..1bd071c53
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Links/Internal (reference) links.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Lists.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Lists.html
new file mode 100644
index 000000000..50dfcf4a2
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Lists.html
@@ -0,0 +1,98 @@
+
There are three types of lists supported by text notes:
+
+
+ Bulleted lists (also known as unordered lists).
+
+ Numbered lists (or ordered lists).
+
+ To-do lists
+
+
For bulleted and numbered lists, it's possible to configure an alternative
+ marker such as squares or Roman numbering by pressing the
+ icon. For numbered lists, it's also possible to specify the number to
+ start at or whether to count in reverse order.
+
Keyboard interaction
+
+
To create a new list:
+
+
Bulleted list: Start a line with * or - followed
+ by a space;
+
Numbered list: Start a line with 1. or 1) followed
+ by a space;
+
To-do list: Start a line with [ ] for an unchecked item or [x] for
+ a checked item.
+
+
+
To create a new item in the list, press Enter.
+
To create a blank line within a list item, press Shift+Enter.
+
To exit out of the list, press Enter twice.
+
To merge two lists, simply delete the gap between them.
+
To create nested lists, simply use the
+ button (see Indentation in Other features)
+ or the Tab key. To decrease the nesting level for the current
+ element, press Shift+Tab.
+
+
Headings, code blocks within lists
+
It possible to add content-level blocks such as headings, code blocks,
+ tables within lists, as follows:
+
+
+
+
+
+
+
+
+
+
1
+
+
+
+
First, create a list.
+
+
+
2
+
+
+
+
Press Enter to create a new list item.
+
+
+
3
+
+
+
+
Press Backspace to get rid of the bullet point. Notice the cursor position.
+
+
+
4
+
+
+
+
At this point, insert any desired block-level item such as a code block.
+
+
+
5
+
+
+
+
To continue with a new bullet point, press Enter until the cursor moves
+ to a new blank position.
+
+
+
6
+
+
+
+
Press Enter once more to create the new bullet.
+
+
+
+
+
The same principle applies to all three list types (bullet, numbered and
+ to-do).
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Lists_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Lists_image.png
new file mode 100644
index 000000000..30a9511b0
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Lists_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Markdown-like formatting.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Markdown-like formatting.html
new file mode 100644
index 000000000..165093de0
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Markdown-like formatting.html
@@ -0,0 +1,66 @@
+
Markdown-like formatting allows inserting some basic formatting by typing
+ the Markdown equivalent. Note that this does not mean that Text notes supports Markdown,
+ these are just some convenience shortcuts.
+
To import more complex formatting into text notes, consider using the
+ Import from Markdown
+ function. For fully-fleged Markdown notes imports, consider using the
+ dedicated import function.
Starting any other text with !!! will insert a note admonition
+ with the text inside of it.
+
+
+
For emojis, type : followed
+ by an emoji name to trigger an auto-completion.
+
+
If auto-formatting is not desirable, press Ctrl + Z to
+ revert the text to its original form.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Math Equations.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Math Equations.html
new file mode 100644
index 000000000..dd41d19ab
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Math Equations.html
@@ -0,0 +1,34 @@
+
+
+
+
Within text notes, it's possible to enter mathematical equations using
+ the
+ button from the Formatting toolbar (generally
+ found under the Insert buttons).
+
If inserting equations frequently, using the Ctrl+M keyboard
+ shortcut can be more comfortable. Alternatively, type $$ or \[ to
+ trigger the popup directly.
+
There is currently no quick way to insert an equation, such as surrounding
+ it with $ or pressing Ctrl+M on an already
+ typed-out equation.
+
The mathematical expression must be written in the TeX format. There is
+ no visual editor for the math equations, only a preview.
+
Enabling Display mode will render the equation slightly bigger
+ (especially if using big operators such as summation, or fractions) and
+ center it. Display mode equations will act as blocks (i.e. like paragraphs,
+ or tables) and can be inserted for example in lists. Non-display equations
+ can be part of the text.
+
Supported math features
+
Technically we are using the KaTeX library which allows for a subset of
+ the TeX format. To see the full list of supported features, consult the
+ Supported Functionsand the Support Table from
+ the official documentation.
+
Markdown support
+
Math equations will be preserved when exporting to or importing from Markdown,
+ surrounded by \( characters for inline math expressions, and $\) for
+ display mode.
+
If you notice any issue with the Markdown import/export for equations,
+ feel free to report it while providing
+ the equation that causes issues.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Math Equations_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Math Equations_image.png
new file mode 100644
index 000000000..ffd51f4fa
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Math Equations_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Other features.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Other features.html
new file mode 100644
index 000000000..fe16dc603
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Other features.html
@@ -0,0 +1,51 @@
+
Indentation
+
+
+
+
Paragraphs can be indented to the right using the button from the
+ Formatting toolbar.
+
+
Press
+ to increase the indentation of the current paragraph by one. Can be pressed
+ multiple times if needed.
+
Press
+ to decrease the indentation of a current paragraph. The button will be
+ disabled if it is already at the minimum indentation level.
+
For convenience, keyboard shortcuts are also available. Press Tab to
+ indent or Shift+Tab to decrease the indentation. These
+ shortcuts work even if the cursor is not at the beginning of a paragraph
+ or a list.
+
Apart from paragraphs, the indent button is also enabled in Lists, where it can be used to create
+ nested lists.
+
+
Markdown import
+
If the clipboard contains Markdown text, it can be easily imported into
+ text notes. Simply copy a Markdown-formatted text and press the
+ to insert its visual representation.
+
Note that this only works with raw Markdown (e.g. # Heading 1 to
+ generate a heading) and not the visual representation of the Markdown (e.g.
+ as in the preview pane of an application). In that case, simply use the
+ paste function which already accepts HTML-formatted content.
+
This is mostly useful for snippets of text, for entire Markdown documents
+ use the dedicated Markdown import/export
+ function.
+
If accessing Trilium with a web browser, the Markdown import action will
+ ask for the content to be inserted into a dedicated screen since it does
+ not have access to the clipboard.
+
Cut to subnote
+
The
+ button will create a child note with the selected text. For more information,
+ see Cut to subnote.
+
Find and replace
+
+
+
+
The
+ button will open the editor's dedicated search and replace functionality.
+
Alternatively, the Ctrl+F combination can be pressed
+ to show the dialog.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Other features_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Other features_image.png
new file mode 100644
index 000000000..63ff048a3
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Other features_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features.html
new file mode 100644
index 000000000..8b3a9e8ac
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features.html
@@ -0,0 +1,18 @@
+
The text editor we are using for Text notes
+ is called CKEditor and it's a commercial product. The core components are
+ open-source, however they offer quite a few features that
+ require a commercial license in order to be used.
+
We have reached out to the CKEditor team in order to obtain a license
+ in order to have some of these extra features and they have agreed, based
+ on a signed agreement.
+
How the license works
+
The license key is stored in the application and it enables the use of
+ the previously described premium features. The license key has an expiration
+ date which means that the features can become disabled if using an older
+ version of the application for extended periods of time.
+
Can I opt out of these features?
+
At this moment there is no way to disable these features, apart from manually
+ modifying the source code. If this is a problem, let us know.
+
If you have the possibility of rebuilding the source code (e.g. if a package
+ maintainer), then modify VITE_CKEDITOR_KEY in apps/client/.env to
+ be GPL.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features/1_Text Snippets_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features/1_Text Snippets_image.png
new file mode 100644
index 000000000..b2dd17dfa
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features/1_Text Snippets_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features/Slash Commands.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features/Slash Commands.html
new file mode 100644
index 000000000..ca453511a
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features/Slash Commands.html
@@ -0,0 +1,34 @@
+
+
+
+
+
Slash commands is a feature of Text notes
+ which allows easily accessing commonly used commands simply by using the
+ keyboard, without having to remember dedicated Keyboard Shortcuts.
+
Interaction
+
+
As the name suggests, to trigger the slash commands simply press the / key
+ to trigger it. Note that this can be anywhere in a paragraph as long as
+ it's not part of the word, if it doesn't show up simply press a space and
+ press the / key again.
+
Use ↑ and ↓ keys to navigate between options.
+
By default, the full list of commands is displayed.
+
To search by title or description, simply start typing for an action.
+
To trigger an action, press the Enter key.
+
+
Integration with other features
+
Apart from the common set of commands, some features are specially integrated
+ with the slash commands:
+
+
For admonitions, each admonition
+ type (e.g. note, tip) will be individually displayed.
+
Every Text Snippets will
+ also appear individually, making it easy to insert them.
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features/Slash Commands_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features/Slash Commands_image.png
new file mode 100644
index 000000000..b46c1a4c6
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features/Slash Commands_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features/Text Snippets.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features/Text Snippets.html
new file mode 100644
index 000000000..54e7ea03d
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features/Text Snippets.html
@@ -0,0 +1,53 @@
+
+
+
+
+
Text Snippets are closely related to Templates,
+ but instead of defining the content of an entire note, text snippets are
+ pieces of formatted text that can easily be inserted in a text note.
To look for a specific template, start typing the name of the template
+ (its title).
+
To look for all the templates, type template.
+
+
+
+
+
Limitations
+
+
Whenever a snippet is created, deleted or its title/description are modified,
+ all the open text notes will need to be refreshed. This causes a slight
+ flash for usually under a second, but it can cause some discomfort.
+
Unlike Templates,
+ the snippets cannot be limited to a particular workspace.
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features/Text Snippets_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features/Text Snippets_image.png
new file mode 100644
index 000000000..90b8fbe95
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Premium features/Text Snippets_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Table of contents.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Table of contents.html
new file mode 100644
index 000000000..e1f806133
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Table of contents.html
@@ -0,0 +1,32 @@
+
+
+
+
The table of contents appears in the Right Sidebar automatically
+ when there are multiple headings in a text note.
+
Interaction
+
+
Clicking on a heading will scroll the document to the position of the
+ heading.
+
Pressing the close button will dismiss the table of contents but it can
+ be shown again from the Floating buttons section.
+
+
Global configuration
+
In Text Notes options,
+ look for the Table of Contents section and configure the minimum
+ amount of headings that need to be present in the current note in order
+ for the table of contents to show:
+
+
To always hide it, set the value to a really large number (e.g. 10000).
+
To always display it if there's at least a single heading, set the value
+ to 1.
+
+
Per-note configuration
+
Use Attributes to
+ configure the table of contents for a particular note:
+
+
#toc=show will show the table of contents for that note regardless
+ of the global settings.
+
Similarly, #toc=hide will always hide the table of contents
+ for that note.
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Table of contents_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Table of contents_image.png
new file mode 100644
index 000000000..ff11c558c
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Table of contents_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Tables.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Tables.html
new file mode 100644
index 000000000..feee331e6
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Tables.html
@@ -0,0 +1,148 @@
+
Tables are a powerful feature for Text notes,
+ since editing them is generally easy.
+
+
+
+
To create a table, simply press the table button and select with the mouse
+ the desired amount of columns and rows, as indicated in the adjacent figure.
+
Formatting toolbar
+
When a table is selected, a special formatting toolbar will appear:
+
+
+
Navigating a table
+
+
Using the mouse:
+
+
Click on a cell to focus it.
+
Click the
+ button at the top or the bottom of a table to insert an empty paragraph
+ near it.
+
Click the
+ button at the top-left of the table to select it entirely (for easy copy-pasting
+ or cutting) or drag and drop it to relocate the table.
+
+
+
Using the keyboard:
+
+
Use the arrow keys on the keyboard to easily navigate between cells.
+
It's also possible to use Tab to go to the next cell and Shift+Tab
+ to go to the previous cell.
+
Unlike arrow keys, pressing Tab at the end of the table (last
+ row, last column) will create a new row automatically.
+
To select multiple cells, hold Shift while using the arrow keys.
+
+
+
+
Resizing cells
+
+
Columns can be resized by hovering the mouse over the border of two adjacent
+ cells and dragging it.
+
By default, the row height is not adjustable using the mouse, but it can
+ be configured from the cell settings (see below).
+
To adjust exactly the width (in pixels or percentages) of a cell, select
+ the
+ button.
+
+
Inserting new rows and new columns
+
+
To insert a new column, click on a desired location, then press the
+ button from the formatting toolbar and select Insert column left or right.
+
+
To insert a new row, click on a desired location, then press the
+ button and select Insert row above or below.
+
+
A quicker alternative to creating a new row while at the end of the table
+ is to press the Tab key.
+
+
+
+
Merging cells
+
To merge two or more cells together, simply select them via drag &
+ drop and press the
+ button from the formatting toolbar.
+
More options are available by pressing the arrow next to it:
+
+
Click on a single cell and select Merge cell up/down/right/left to merge
+ with an adjacent cell.
+
Select Split cell vertically or horizontally, to split
+ a cell into multiple cells (can also be used to undo a merge).
+
+
Table properties
+
+
+
+
The table properties can be accessed via the
+ button and allows for the following adjustments:
+
+
Border (not the border of the cells, but the outer rim of the table),
+ which includes the style (single, double), color and width.
+
The background color, with none set by default.
+
The width and height of the table in percentage (must end with %)
+ or pixels (must end with px).
+
The alignment of the table.
+
+
Left or right-aligned, case in which the text will flow next to it.
+
Centered, case in which text will avoid the table, regardless of the table
+ width.
+
+
+
+
The table will immediately update to reflect the changes, but the Save button
+ must be pressed for the changes to persist.
+
Cell properties
+
+
+
+
Similarly to table properties, the
+ button opens a popup which adjusts the styling of one or more cells (based
+ on the user's selection).
+
The following options can be adjusted:
+
+
The border style, color and width (same as table properties), but applying
+ to the current cell only.
+
The background color, with none set by default.
+
The width and height of the cell in percentage (must end with %)
+ or pixels (must end with px).
+
The padding (the distance of the text compared to the cell's borders).
+
The alignment of the text, both horizontally (left, centered, right, justified)
+ and vertically (top, middle or bottom).
+
+
The cell will immediately update to reflect the changes, but the Save button
+ must be pressed for the changes to persist.
+
Caption
+
Press the
+ button to insert a caption or a text description of the table, which is
+ going to be displayed above the table.
+
Tables with invisible borders
+
Tables can be set to have invisible borders in order to allow for basic
+ layouts (columns, grids) of text or images without
+ the distraction of their border:
+
+
First insert a table with the desired number of columns and rows.
+
Select the entire table.
+
In Table properties, set:
+
+
Style to Single
+
+
Color to transparent
+
+
Width to 1px.
+
+
+
In Cell Properties, set the same as on the previous step.
+
+
Markdown import/export
+
Simple tables are exported in GitHub-flavored Markdown format (e.g. a
+ series of | items). If the table is found to be more complex
+ (it contains HTML elements, has custom sizes or images), the table is converted
+ to a HTML one instead.
+
Generally formatting loss should be minimal when exported to Markdown
+ due to the fallback to HTML formatting.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Tables_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Tables_image.png
new file mode 100644
index 000000000..63a9efa85
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Tables_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text_image.png
new file mode 100644
index 000000000..6e2befad8
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Web View.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Web View.html
new file mode 100644
index 000000000..c8cb12d29
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Web View.html
@@ -0,0 +1,26 @@
+
Configuration
+
A webview needs to know which URL to render, and it can be provided by
+ setting the webViewSrclabel,
+ such as:
#webViewSrc="https://www.wikipedia.org"
+
Web view on the server vs. Electron
+
When accessing Trilium via a browser instead of the desktop application,
+ the web view will still try to render the content of the desired webpage.
+ However, since it's running in a browser there are quite a few limitations
+ as opposed to the desktop one.
+
More specifically, quite a few websites oppose being embedded in another
+ website (technically they have a non-permisive X-Frame-Options header).
+ This is not bypassable by Trilium so the page will simply fail to render.
+
You can diagnose this by right clicking the Trilium web page → Inspect
+ (element) and looking in the “Console” tab for errors such as:
+
+
Refused to display 'https://www.google.com/' in a frame because it set 'X-Frame-Options' to 'sameorigin'.
+
+
Refused to frame 'https://duckduckgo.com/' because an ancestor violates the following Content Security Policy directive: "frame-ancestors 'self' https://html.duckduckgo.com".
+
+
+
There are a few websites that do render such as wikipedia.org.
+
Do note that we are also applying some sandboxing constraints on the server
+ side, so if you have any issues other than the unresolvable X-Frame-Options described
+ above, feel free to report them.
+
On the desktop side, a different technology is used which bypasses the
+ constraints of an iframe (webview).
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types_image.png
new file mode 100644
index 000000000..d10e03765
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Quick Start.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Quick Start.html
new file mode 100644
index 000000000..be555159e
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Quick Start.html
@@ -0,0 +1,32 @@
+
Choose the setup
+
Local only desktop/laptop - Allows a single instance on
+ a desktop and will save the notes locally on that desktop.
Combination of server and desktop/laptop - Install the
+ application on both a server, for web access and data synchronisation,
+ and desktop instance(s). This allows all the data to be stored on the server
+ and either accessed from the web browser, or the desktop application. The
+ desktop application will sync and store the data locally so that it can
+ be used when offline.
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting.html
new file mode 100644
index 000000000..9d8077cad
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting.html
@@ -0,0 +1,48 @@
+
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.
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/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Custom Widgets.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Custom Widgets.html
new file mode 100644
index 000000000..a3c74131e
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Custom Widgets.html
@@ -0,0 +1,13 @@
+
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
+
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Custom Widgets/Widget Basics.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Custom Widgets/Widget Basics.html
new file mode 100644
index 000000000..273dbaae6
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Custom Widgets/Widget Basics.html
@@ -0,0 +1,91 @@
+
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/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Custom Widgets/Word count widget.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Custom Widgets/Word count widget.html
new file mode 100644
index 000000000..c627056c8
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Custom Widgets/Word count widget.html
@@ -0,0 +1,88 @@
+
+
Create a Code note
+ of type JS frontend and give it a#widgetlabel.
/*
+ * 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 = `<div style="padding: 10px; border-top: 1px solid var(--main-border-color); contain: none;">
+ <strong>Word count: </strong>
+ <span class="word-count"></span>
+
+
+
+ <strong>Character count: </strong>
+ <span class="character-count"></span>
+</div`;
+
+class WordCountWidget extends api.NoteContextAwareWidget {
+ get position() { return 100; } // higher value means position towards the bottom/right
+
+ get parentWidget() { return 'center-pane'; }
+
+ doRender() {
+ this.$widget = $(TPL);
+ this.$wordCount = this.$widget.find('.word-count');
+ this.$characterCount = this.$widget.find('.character-count');
+ return this.$widget;
+ }
+
+ async refreshWithNote(note) {
+ if (note.type !== 'text' || !note.hasLabel('wordCount')) {
+ // show widget only on text notes and when marked with 'wordCount' label
+ this.toggleInt(false); // hide
+
+ return;
+ }
+
+ this.toggleInt(true); // display
+
+ 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 = new WordCountWidget();
+
After you make changes it is necessary to restart Trilium so
+ that the layout can be rebuilt.
+
At the bottom of the note you can see the resulting widget:
+
+
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Custom Widgets/Word count widget_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Custom Widgets/Word count widget_image.png
new file mode 100644
index 000000000..2f1e5e5fd
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Custom Widgets/Word count widget_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Events.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Events.html
new file mode 100644
index 000000000..f8b02d626
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Events.html
@@ -0,0 +1,130 @@
+
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.
+
+
+
+
+
Label
+
Description
+
+
+
+
+
run
+
+
+
Defines on which events script should run. Possible values are:
+
+
frontendStartup - when Trilium frontend starts up (or is refreshed),
+ but not on mobile.
+
mobileStartup - when Trilium frontend starts up (or is refreshed),
+ on mobile.
+
backendStartup - when Trilium backend starts up
+
hourly - run once an hour. You can use additional label runAtHour to
+ specify at which hour, on the back-end.
+
daily - run once a day, on the back-end
+
+
+
+
+
runOnInstance
+
+
Specifies that the script should only run on a particular Trilium instance.
+
+
+
runAtHour
+
+
On which hour should this run. Should be used together with #run=hourly.
+ Can be defined multiple times for more runs during the day.
+
+
+
+
+
+
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).
+
+
+
+
+
Relation
+
Description
+
+
+
+
+
runOnNoteCreation
+
+
executes when note is created on backend. Use this relation if you want
+ to run the script for all notes created under a specific subtree. In that
+ case, create it on the subtree root note and make it inheritable. A new
+ note created within the subtree (any depth) will trigger the script.
+
+
+
runOnChildNoteCreation
+
+
executes when new note is created under the note where this relation is
+ defined
+
+
+
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). Does not
+ include content changes
+
+
+
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
+
+
executes when a branch is updated. (since v0.62)
+
+
+
runOnBranchDeletion
+
+
executes when a branch is deleted. Branch is a link between parent note
+ and child note and is deleted e.g. when moving note (old branch/link is
+ deleted).
+
+
+
runOnAttributeCreation
+
+
executes when new attribute is created for the note which defines this
+ relation
+
+
+
runOnAttributeChange
+
+
executes when the attribute is changed of a note which defines this relation.
+ This is triggered also when the attribute is deleted
+
+
+
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Examples/Downloading responses from Goo.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Examples/Downloading responses from Goo.html
new file mode 100644
index 000000000..c6911fb88
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Examples/Downloading responses from Goo.html
@@ -0,0 +1,37 @@
+
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/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Examples/New Task launcher button.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Examples/New Task launcher button.html
new file mode 100644
index 000000000..aae9e6f6f
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Examples/New Task launcher button.html
@@ -0,0 +1,126 @@
+
In this example we are going to extend the functionality of Task Manager showcase (which comes
+ by default with Trilium) by adding a button in the Launch Bar (
+ ) to create a new task automatically and open it.
+
Creating the note
+
+
First, create a new Code note
+ type with the JS frontend language.
+
Define the #run=frontendStartup label in Attributes.
Here we identify a note with the label#taskTodoRoot.
+ This is how the Task Manager showcase
+ knows where to place all the different tasks.
+
Normally this might return a null value if no such note could
+ be identified, but error handling is outside the scope of this example.
+
+
+
+
+
const resp = api.createTextNote(todoRootNote.noteId, "New task", "")
+
+
+
+
We create a new child note within the to-do root note (first argument)
+ with the title “New task" (second argument) and no content by default (third
+ argument).
+
+
+
+
+
await api.waitUntilSynced();
+
+
+
+
Back on the client, since we created a new note on the server, we now
+ need to wait for the change to be reflected in the client.
+
+
+
+
+
await api.activateNewNote(taskNoteId);
+
+
+
+
Since we know the ID of the newly
+ created note, all we have to do now is to show this note to the user.
+
+
+
+
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Examples/New Task launcher button_i.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Examples/New Task launcher button_i.png
new file mode 100644
index 000000000..cff2c36af
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Examples/New Task launcher button_i.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Examples/Using promoted attributes .png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Examples/Using promoted attributes .png
new file mode 100644
index 000000000..a26050356
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Examples/Using promoted attributes .png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Examples/Using promoted attributes to c.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Examples/Using promoted attributes to c.html
new file mode 100644
index 000000000..c76d5d93a
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Examples/Using promoted attributes to c.html
@@ -0,0 +1,40 @@
+
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/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Frontend Basics.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Frontend Basics.html
new file mode 100644
index 000000000..1113d7587
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Frontend Basics.html
@@ -0,0 +1,83 @@
+
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:
In both cases, the API resides in a global variable, api,
+ that can be used anywhere in the script.
+
For example, to display a message to the user the following front-end
+ script can be used:
api.showMessage("Hello world.");
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Script API/Backend API.dat b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Script API/Backend API.dat
new file mode 100644
index 000000000..e69de29bb
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Script API/Frontend API/FNote.dat b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Script API/Frontend API/FNote.dat
new file mode 100644
index 000000000..e69de29bb
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/1_Custom app-wide CSS_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/1_Custom app-wide CSS_image.png
new file mode 100644
index 000000000..97b8fc11d
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/1_Custom app-wide CSS_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/2_Custom app-wide CSS_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/2_Custom app-wide CSS_image.png
new file mode 100644
index 000000000..582152fe7
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/2_Custom app-wide CSS_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme.html
new file mode 100644
index 000000000..f54e2f9e9
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme.html
@@ -0,0 +1,66 @@
+
Step 1. Find a place to place the themes
+
Organization is an important aspect of managing a knowledge base. When
+ developing a new theme or importing an existing one it's a good idea to
+ keep them into one place.
+
As such, the first step is to create a new note to gather all the themes.
+
+
+
+
Step 2. Create the theme
+
+
+
+
+
+
+
+
+
+
+
+
+
Themes are code notes with a special attribute. Start by creating a new
+ code note.
+
+
+
+
+
+
Then change the note type to a CSS code.
+
+
+
+
+
+
In the Owned Attributes section define the #appTheme attribute
+ to point to any desired name. This is the name that will show up in the
+ appearance section in settings.
+
+
+
+
+
Step 3. Define the theme's CSS
+
As a very simple example we will change the background color of the launcher
+ pane to a shade of blue.
Refresh the application (Ctrl+Shift+R is a good way to do so) and go to
+ settings. You should see the newly created theme:
+
+
+
+
Afterwards the application will refresh itself with the new theme:
+
+
+
+
Do note that the theme will be based off of the legacy theme. To override
+ that and base the theme on the new TriliumNext theme, see: Theme base (legacy vs. next)
+
+
Step 5. Making changes
+
Simply go back to the note and change according to needs. To apply the
+ changes to the current window, press Ctrl+Shift+R to
+ refresh.
+
It's a good idea to keep two windows, one for editing and the other one
+ for previewing the changes.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme_1_.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme_1_.png
new file mode 100644
index 000000000..81a9d35c8
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme_1_.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme_2_.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme_2_.png
new file mode 100644
index 000000000..d35262149
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme_2_.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme_3_.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme_3_.png
new file mode 100644
index 000000000..743d51c8f
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme_3_.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme_4_.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme_4_.png
new file mode 100644
index 000000000..4f9583c7b
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme_4_.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme_5_.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme_5_.png
new file mode 100644
index 000000000..f2e63f1ec
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme_5_.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme_Cr.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme_Cr.png
new file mode 100644
index 000000000..94afbf424
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme_Cr.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Custom app-wide CSS.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Custom app-wide CSS.html
new file mode 100644
index 000000000..8e27cd82b
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Custom app-wide CSS.html
@@ -0,0 +1,53 @@
+
It is possible to provide a CSS file to be used regardless of the theme
+ set by the user.
+
+
+
+
+
+
+
+
+
+
+
+
+
Start by creating a new note and changing the note type to CSS
+
+
+
+
+
+
In the ribbon, press the “Owned Attributes” section and type #appCss.
+
+
+
+
+
+
Type the desired CSS.
+
+ Generally it's a good idea to append !important for the styles
+ that are being changed, in order to prevent other
+
+
+
+
+
Seeing the changes
+
Adding a new app CSS note or modifying an existing one does not
+ immediately apply changes. To see the changes, press Ctrl+Shift+R to refresh
+ the page first.
+
Example use-case: customizing the printing stylesheet
+
When printing a document or exporting as PDF, it is possible to adjust
+ the style by creating a CSS note that uses the @media selector.
+
For example, to change the font of the document from the one defined by
+ the theme or the user to a serif one:
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Custom app-wide CSS_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Custom app-wide CSS_image.png
new file mode 100644
index 000000000..dc6dcbefe
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Custom app-wide CSS_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Customize the Next theme.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Customize the Next theme.html
new file mode 100644
index 000000000..bcd4ddad7
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Customize the Next theme.html
@@ -0,0 +1,20 @@
+
By default, any custom theme will be based on the legacy light theme.
+ To use the TriliumNext theme instead, add the #appThemeBase=next attribute
+ onto the existing theme. The appTheme attribute must also be
+ present.
+
+
+
+
The appThemeBase label can be set to one of the following values:
+
+
next, for the TriliumNext (auto light or dark mode).
+
next-light, for the always light mode of the TriliumNext.
+
next-dark, for the always dark mode of the TriliumNext.
+
Any other value is ignored and will use the legacy white theme instead.
+
+
Overrides
+
Do note that the TriliumNext theme has a few more overrides than the legacy
+ theme, so you might need to suffix !important if the style changes
+ are not applied.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Customize the Next theme_i.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Customize the Next theme_i.png
new file mode 100644
index 000000000..e397c87dc
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Customize the Next theme_i.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Reference.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Reference.html
new file mode 100644
index 000000000..c9a4d0275
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Theme development/Reference.html
@@ -0,0 +1,154 @@
+
Detecting mobile vs. desktop
+
The mobile layout is different than the one on the desktop. Use body.mobile and body.desktop to
+ differentiate between them.
body.mobile #root-widget {
+ /* Do something on mobile */
+}
+
+body.desktop #root-widget {
+ /* Do something on desktop */
+}
+
Do note that there is also a “tablet mode” in the mobile layout. For that
+ particular case media queries are required:
@media (max-width: 991px) {
+
+ #launcher-pane {
+
+ /* Do something on mobile layout */
+
+ }
+
+}
+
+
+
+@media (min-width: 992px) {
+
+ #launcher-pane {
+
+ /* Do something on mobile tablet + desktop layout */
+
+ }
+
+}
+
Detecting horizontal vs. vertical layout
+
The user can select between vertical layout (the classical one, where
+ the launcher bar is on the left) and a horizontal layout (where the launcher
+ bar is on the top and tabs are full-width).
+
Different styles can be applied by using classes at body level:
body.layout-vertical #left-pane {
+ /* Do something */
+}
+
+body.layout-horizontal #center-pane {
+ /* Do something else */
+}
+
The two different layouts use different containers (but they are present
+ in the DOM regardless of the user's choice), for example #horizontal-main-container and #vertical-main-container can
+ be used to customize the background of the content section.
+
Detecting platform (Windows, macOS) or Electron
+
It is possible to add particular styles that only apply to a given platform
+ by using the classes in body:
It is also possible to only apply a style if running under Electron (desktop
+ application):
body.electron {
+ background: blue;
+}
+
Native title bar
+
It's possible to detect if the user has selected the native title bar
+ or the custom title bar by querying against body:
body.electron.native-titlebar {
+ /* Do something */
+}
+
+body.electron:not(.native-titlebar) {
+ /* Do something else */
+}
+
Native window buttons
+
When running under Electron with native title bar off, a feature was introduced
+ to use the platform-specific window buttons such as the semaphore on macOS.
The colors of the native window button area can be adjusted using a RGB
+ hex color:
body {
+ --native-titlebar-foreground: #ffffff;
+ --native-titlebar-background: #ff0000;
+}
+
It is also possible to use transparency at the cost of reduced hover colors
+ using a RGBA hex color:
body {
+ --native-titlebar-background: #ff0000aa;
+}
+
Note that the value is read when the window is initialized and then it
+ is refreshed only when the user changes their light/dark mode preference.
+
On macOS
+
On macOS the semaphore window buttons are enabled by default when the
+ native title bar is disabled. The offset of the buttons can be adjusted
+ using:
body {
+ --native-titlebar-darwin-x-offset: 12;
+ --native-titlebar-darwin-y-offset: 14 !important;
+}
+
Background/transparency effects on Windows (Mica)
+
Windows 11 offers a special background/transparency effect called Mica,
+ which can be enabled by themes by setting the --background-material variable
+ at body level:
The value can be either tabbed (especially useful for the horizontal
+ layout) or mica (ideal for the vertical layout).
+
Do note that the Mica effect is applied at body level and the
+ theme needs to make the entire hierarchy (semi-)transparent in order for
+ it to be visible. Use the TrilumNext theme as an inspiration.
+
Note icons, tab workspace accent color
+
Theme capabilities are small adjustments done through CSS variables that
+ can affect the layout or the visual aspect of the application.
+
In the tab bar, to display the icons of notes instead of the icon of the
+ workspace:
:root {
+ --tab-note-icons: true;
+}
+
When a workspace is hoisted for a given tab, it is possible to get the
+ background color of that workspace, for example to apply a small strip
+ on the tab instead of the whole background color:
Currently the only way to include a custom font is to use Custom resource providers.
+ Basically import a font into Trilium and assign it #customResourceProvider=fonts/myfont.ttf and
+ then import the font in CSS via /custom/fonts/myfont.ttf. Use ../../../custom/fonts/myfont.ttf if
+ you run your Trilium server on a different path than /.
+
Dark and light themes
+
A light theme needs to have the following CSS:
:root {
+ --theme-style: light;
+}
+
if the theme is dark, then --theme-style needs to be dark.
+
If the theme is auto (e.g. supports both light or dark based on prefers-color-scheme)
+ it must also declare (in addition to setting --theme-style to
+ either light or dark):
:root {
+
+ --theme-style-auto: true;
+
+}
+
This will affect the behavior of the Electron application by informing
+ the operating system of the color preference (e.g. background effects will
+ appear correct on Windows).
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting.html
new file mode 100644
index 000000000..77d1aa2dc
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting.html
@@ -0,0 +1,61 @@
+
As Trilium is currently in beta, encountering bugs is to be expected.
+
General Quick Fix
+
The first step in troubleshooting is often a restart.
+
If you experience an UI issue, the frontend may have entered an inconsistent
+ state. Reload the application by pressing Ctrl + R.
+ This will reload the frontend.
+
If the issue persists or appears to be a backend problem, restart the
+ entire application. For the desktop (Electron) build, simply close and
+ reopen the window. If you're using a Docker build, restart the container.
+
Broken Note Crashes Trilium
+
Certain problems, such as rendering a note with a faulty script, can cause
+ Trilium to crash. If Trilium attempts to reload the problematic note upon
+ restart, it will continue to crash.
+
To resolve this, use the TRILIUM_START_NOTE_ID environment
+ variable to reset the open tabs to a single specified note ID (e.g., root).
+ In Linux, you can set it as follows:
TRILIUM_START_NOTE_ID=root ./trilium
+
Broken Script Prevents Application Startup
+
If a custom script causes Triliumto crash, and it is set as a startup
+ script or in an active custom widget,
+ start Triliumin "safe mode" to prevent any custom scripts from executing:
TRILIUM_SAFE_MODE=true ./trilium
+
Depending on your Trilium distribution, you may have pre-made scripts
+ available: trilium-safe-mode.bat and trilium-safe-mode.sh.
+
Once Trilium starts, locate and fix or delete the problematic note.
+
Sync and Consistency Checks
+
Trilium periodically verifies the logical consistency of the database
+ (e.g., ensuring every note has a parent). If inconsistencies are detected,
+ you will be notified via the UI.
+
In such cases, file a bug report and attach an anonymized database if
+ necessary.
+
Restoring Backup
+
Trilium makes regular automatic backups. If issues become severe, you
+ can restore from a backup.
+
Forgotten Password
+
If you forget your password:
+
+
Protected notes are irretrievable without the password.
+
Unprotected notes can be recovered. Follow these steps:
+
+
Access the database file in the
+ data directory. Open the document.db file with an SQLite
+ client (e.g., DB Browser) and execute
+ the following queries:
UPDATE options SET value = '77/twC5O00cuQgNC63VK32qOKKYwj21ev3jZDXoytVU=' WHERE name = 'passwordVerificationSalt';
+UPDATE options SET value = '710BMasZCAgibzIc07X4P9Q4TeBd4ONnqJOho+pWcBM=' WHERE name = 'passwordDerivedKeySalt';
+UPDATE options SET value = 'Eb8af1/T57b89lCRuS97tPEl4CwxsAWAU7YNJ77oY+s=' WHERE name = 'passwordVerificationHash';
+UPDATE options SET value = 'QpC8XoiYYeqHPtHKRtbNxfTHsk+pEBqVBODYp0FkPBa22tlBBKBMigdLu5GNX8Uu' WHERE name = 'encryptedDataKey';
+
After executing the changes, commit/write the changes. This sets the password to "password," allowing you to log in again.
+
+
For pre-existing protected notes (now unrecoverable), consider deleting
+ them or exporting the unprotected notes. Then, delete document.db and
+ start fresh.
+
If you continue using the existing document file, change your password
+ (Options -> Change Password).
+
Reporting Bugs
+
Reporting bugs is highly valuable. Here are some tips:
Refer to the error logs page for
+ information on providing necessary details.
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting/Anonymized Database.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting/Anonymized Database.html
new file mode 100644
index 000000000..1ae7334bf
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting/Anonymized Database.html
@@ -0,0 +1,29 @@
+
+
+
+
In certain scenarios, understanding the structure of a database is crucial
+ for troubleshooting issues. However, sharing your actual database file
+ with personal notes is not advisable. To address this, Trilium offers a
+ feature to anonymize the database. This feature can be accessed via Menu
+ -> Options -> Advanced tab.
+
This feature creates a copy of your database with all sensitive data removed.
+ Specifically, it strips out note titles, contents, revisions, history,
+ and some non-system attributes while retaining the overall structure and
+ metadata, such as modification dates. After anonymization, the database
+ undergoes a vacuuming process to
+ ensure no sensitive data remnants remain in the file. The anonymized database
+ is saved in the anonymized directory within the data directory,
+ making it safe to share with bug reports.
+
This will create a copy of your document and remove all sensitive data
+ (currently note titles, contents, revisions, history and some of the options,
+ and non-system attributes) while leaving all structure and metadata (e.g.
+ date of last change). After this is done, the database is VACUUMed to
+ make sure there's no stale sensitive data in the document file. The resulting
+ file is stored in anonymized directory (placed in the data directory).
+ You can safely attach it to a bug report.
+
Command Line Anonymization
+
If your database is corrupted to
+ the point where Trilium cannot start, the anonymization process can still
+ be executed via the command line:
node src/anonymize.js
+
Run this command from the directory containing Trilium's source files,
+ typically found in the resources/app directory for desktop builds.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting/Anonymized Database_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting/Anonymized Database_image.png
new file mode 100644
index 000000000..fb640c0c9
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting/Anonymized Database_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting/Error logs.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting/Error logs.html
new file mode 100644
index 000000000..362ec507b
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting/Error logs.html
@@ -0,0 +1,45 @@
+
It's important to provide all available error logs together with bug reports.
+ This page will show you how to do it.
+
Backend logs
+
Open data directory, go to log subdirectory
+ and find the latest log file, e.g. trilium-2022-12-14.log.
+ You can attach the whole file to the bug report (preferable) or open it
+ and copy-paste only the last lines / lines you believe are relevant.
+
If you have trouble finding it the log files, there's also an in-app option
+ in top-left menu button -> Advanced -> Show backend log.
+
Frontend logs
+
To provide frontend logs, we need to open the Developer Console. Often
+ the easiest way is to press Ctrl-Shift-I which
+ should work in most browsers (and desktop app). Make sure that the error
+ producing action happened right before you copy&paste the errors, the
+ console is cleared on app restart.
+
If that doesn't work, then:
+
+
in Trilium desktop app, go to top-left menu button -> Advanced ->
+ Open Dev Tools
+
In Firefox/Chrome right-click anywhere in the page and click Inspect:
+
+
+
+
+
Once you have Dev Tools open, click on "Console" tab:
+
+
+
+
Copy-paste (or screenshot) the logs. It's better to provide not just errors,
+ but the whole log, which might provide context while analyzing the bug.
+
Providing sensitive data
+
If you don't feel comfortable attaching the logs or anything sensitive
+ to the public GitHub issues, feel free to contact the devs in our Matrix
+ support channel.
+
Use this email to also provide anything which could assist in analysing
+ the bug - e.g. files/images/ZIPs being imported or anonymized database.
+
Exporting note subtree for reproduction
+
Often times, bugs manifest themselves in specific notes and having them
+ would greatly ease reproduction and fixing.
+
In such case, please export the relevant note subtree by right-clicking
+ it on the left tree, choosing Export - HTML as ZIP:
+
+
+
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting/Error logs_error-logs-expo.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting/Error logs_error-logs-expo.png
new file mode 100644
index 000000000..65abe4999
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting/Error logs_error-logs-expo.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting/Error logs_error-logs-fire.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting/Error logs_error-logs-fire.png
new file mode 100644
index 000000000..a6c45bb43
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting/Error logs_error-logs-fire.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting/Error logs_image.png b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting/Error logs_image.png
new file mode 100644
index 000000000..62a034e3f
Binary files /dev/null and b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting/Error logs_image.png differ
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting/Refreshing the application.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting/Refreshing the application.html
new file mode 100644
index 000000000..1eace412d
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting/Refreshing the application.html
@@ -0,0 +1,3 @@
+
Some changes to the application will not take effect immediately and as
+ such it might require to manually reload or refresh the application.
+
To do so, simply press Ctrl+Shift+R.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting/Reporting issues.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting/Reporting issues.html
new file mode 100644
index 000000000..4af29831e
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting/Reporting issues.html
@@ -0,0 +1,3 @@
+
If you are reporting a bug, select “Bug Report” and fill in the details.
\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting/Synchronization fails with 504.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting/Synchronization fails with 504.html
new file mode 100644
index 000000000..0799b33f1
--- /dev/null
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Troubleshooting/Synchronization fails with 504.html
@@ -0,0 +1,13 @@
+
Synchronization can sometimes take a long amount of time in order to compute
+ the items that require update. When running behind a reverse proxy, the
+ request can time out.
+
The solution is to increase the timeout at proxy level.
If it still doesn't work, try increasing the timeout.
\ No newline at end of file
diff --git a/docs/User Guide/!!!meta.json b/docs/User Guide/!!!meta.json
index 70b90a5af..f115bc124 100644
--- a/docs/User Guide/!!!meta.json
+++ b/docs/User Guide/!!!meta.json
@@ -1395,6 +1395,13 @@
"value": "bx bxs-tree-alt",
"isInheritable": false,
"position": 50
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "DvdZhoQZY9Yd",
+ "isInheritable": false,
+ "position": 60
}
],
"format": "markdown",
@@ -1650,6 +1657,56 @@
"dataFileName": "Multiple selection_image.png"
}
]
+ },
+ {
+ "isClone": false,
+ "noteId": "DvdZhoQZY9Yd",
+ "notePath": [
+ "pOsGYCXsbNQG",
+ "gh7bpGYxajRS",
+ "Vc8PjrjAGuOp",
+ "oPVyFC7WL2Lp",
+ "DvdZhoQZY9Yd"
+ ],
+ "title": "Keyboard shortcuts",
+ "notePosition": 30,
+ "prefix": null,
+ "isExpanded": false,
+ "type": "text",
+ "mime": "text/html",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-keyboard",
+ "isInheritable": false,
+ "position": 10
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "oPVyFC7WL2Lp",
+ "isInheritable": false,
+ "position": 20
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "yTjUdsOi4CIE",
+ "isInheritable": false,
+ "position": 30
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "ZjLYv08Rp3qC",
+ "isInheritable": false,
+ "position": 40
+ }
+ ],
+ "format": "markdown",
+ "dataFileName": "Keyboard shortcuts.md",
+ "attachments": []
}
]
},
diff --git a/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Note Tree.md b/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Note Tree.md
index 24014253c..edd0470e0 100644
--- a/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Note Tree.md
+++ b/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Note Tree.md
@@ -22,4 +22,8 @@ You can easily rearrange the note tree by dragging and dropping notes, as demons
You can also move notes using the familiar cut and paste functions available in the context menu, or with the associated keyboard [shortcuts](../Keyboard%20Shortcuts.md): `CTRL-C` ( [copy](../Notes/Cloning%20Notes.md)), Ctrl + X (cut) and Ctrl + V (paste).
-See Note Tree Menu for more information.
\ No newline at end of file
+See Note tree contextual menu for more information.
+
+## Keyboard shortcuts
+
+The note tree comes with multiple keyboard shortcuts to make editing faster, consult the dedicated Keyboard shortcuts section.
\ No newline at end of file
diff --git a/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Note Tree/Keyboard shortcuts.md b/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Note Tree/Keyboard shortcuts.md
new file mode 100644
index 000000000..faec3ac7a
--- /dev/null
+++ b/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Note Tree/Keyboard shortcuts.md
@@ -0,0 +1,17 @@
+# Keyboard shortcuts
+The Note Tree comes with multiple keyboard shortcuts to make editing faster:
+
+* Opening notes:
+ * Click to open the note in the current tab.
+ * Ctrl+Click or Middle click to open the note in a new tab.
+ * Ctrl+Right click to open the note in Quick edit.
+* Navigation within the tree:
+ * Up and Down to navigate between notes.
+ * Left to collapse a note, or Right to expand it.
+* Clipboard management:
+ * Ctrl+C to copy a note.
+ * Ctrl+X to cut a note.
+ * Ctrl+V to paste it somewhere.
+* For Multiple selection:
+ * Alt+Clickto add a single note to the current selection.
+ * Shift+Clickto select a range of notes, starting from the current note (the highlighted one) to the one that is being clicked.
\ No newline at end of file
+
+
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+
+
+
+
+
+
+
+
+
+
icon.
+ 
button. Once saved, the note will appear in Day Notes.
+
+
+
+
+
+
+
+ 
+ 
+ 
+ 
+ 
+
+
+
+
+
+
+
+
icon in the top-right corner of the window or by pressing the keyboard
+ combination again.
+
+
+
+
+
+
+
+
+
+
+
+
+ 
+
icon in the Floating buttons area.
+ 
+ 
+ 
+
+
+
+
+
+
+
+
+ 
+ 
+ 
from the Formatting toolbar.
+ It's also possible to type >, followed by a space to create
+ one (but only if the cursor is at the beginning of a line).
+ 
+ 
button in the Formatting toolbar,
+ and then press the
+ 
button.
+
+
+
button.
+
+
button in
+ 
group from the Formatting toolbar.
+ On the floating toolbar, the buttons appear when selecting a text.
Remove formatting button.
+
button.
+ 
+
+
(or press the right arrow and select New footnote).
+
+
+
+
+
+
+
+
Remove formatting button is a quick way to eliminate the general
+ formatting styling of a particular text.
+
+
+
+
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+
button in the Floating buttons area.
button. There is also a keyboard shortcut defined for it but it is not
+ allocated by default.
button in the Formatting toolbar to
+ reveal special inserable items and blocks such as symbols, Math expressions
+ and separators.
+
+ 
button will reveal a popup window displaying a list of characters that
+ are generally more difficult to insert directly from the keyboard, such
+ as a subset of emojis, quotation characters, etc.
button to create an inline Mermaid diagram.
+ 
button in the Formatting toolbar.
+ 
+ 
in the formatting toolbar.
in the Formatting toolbar:
+ 
Edit link button.
Unlink button. links.png){kind=small}
button from the Formatting toolbar.
Bulleted lists (also known as unordered lists).
Numbered lists (or ordered lists).
To-do lists
icon. For numbered lists, it's also possible to specify the number to
+ start at or whether to count in reverse order.
button (see Indentation in Other features)
+ or the Tab key. To decrease the nesting level for the current
+ element, press Shift+Tab.
+ 
+ 
+ 
+ 
+ 
+ 
+
button from the Formatting toolbar (generally
+ found under the Insert buttons).
+
to increase the indentation of the current paragraph by one. Can be pressed
+ multiple times if needed.
to decrease the indentation of a current paragraph. The button will be
+ disabled if it is already at the minimum indentation level.
to insert its visual representation.
button will create a child note with the selected text. For more information,
+ see Cut to subnote.
+
button will open the editor's dedicated search and replace functionality.
+
+
button.
+
+
button at the top or the bottom of a table to insert an empty paragraph
+ near it.
button at the top-left of the table to select it entirely (for easy copy-pasting
+ or cutting) or drag and drop it to relocate the table.
button.
button from the formatting toolbar and select Insert column left or right.
+ 
button and select Insert row above or below.
+ 
button from the formatting toolbar.
+ 
button and allows for the following adjustments:
+ 
button opens a popup which adjusts the styling of one or more cells (based
+ on the user's selection).
button to insert a caption or a text description of the table, which is
+ going to be displayed above the table.
+ 
) to create a new task automatically and open it.
+
+ 
+ 
+ 
+
+
+ 
+ 
+ 
+
+
+
+
+