Trilium offers advanced functionality through Scripts and +
Trilium offers advanced functionality through Scripts and Promoted Attributes. To illustrate these features, we've prepared several showcases available in the demo notes:
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Task Manager.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Task Manager.html index 23fb6d32d..f30e0366e 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Task Manager.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Task Manager.html @@ -15,7 +15,7 @@Task Manager is a promoted attributes and scriptsshowcase present in the demo notes.
+ href="../../Note%20Types/Code/Scripting.html">scriptsshowcase present in the demo notes.Demo
@@ -37,7 +37,7 @@
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
+ 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.
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
+ 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.
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Custom Request Handler.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Custom Request Handler.html
index 8566430d4..ee165623a 100644
--- a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Custom Request Handler.html
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Custom Request Handler.html
@@ -13,7 +13,7 @@
Custom Request Handler
Trilium provides a mechanism for scripts to +
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).
Understanding the source code of the different notes
Internally, the structure of the content of each note is different based - on the Note Types.
+ on the Note Types.For example:
-
-
- Text Notes are - represented internally as HTML, using the CKEditor representation. +
- 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 +
- 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. +
- 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 +
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 + 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.
@@ -52,7 +56,7 @@ </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 + menu in Note buttons and selecting Note source.
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes.html
index 254220c22..9682039be 100644
--- a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes.html
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes.html
@@ -16,30 +16,15 @@
Note is a central entity in Trilium. Main attributes of note are title and content.
Note types
--
-
- text note - this is default note - type which allows you to put rich text, images etc. -
- code note - some kind of formal - code, typically programming language (e.g. JavaScript) or data structure - (e.g. JSON) -
- image note - - represents single image -
- file note - represents uploaded file (e.g. docx MS Word document). -
- render HTML note - this works as an output screen of attached scripts - -
- saved search note - contains - saved search query and dynamically displays result of the search as its - sub-notes -
- relation map note - visualizes - notes and their relations -
- book note - displays its children - notes, useful for reading many short notes -
- mermaid - create diagrams and flowcharts using mermaid.js ↗ - -
- canvas note - allows hand drawn notes - and basic diagraming on an infinite canvas using excalidraw ↗ - -
The main note type is a rich-text note type called Text. For diagrams and drawing there + is Canvas and + Mermaid Diagrams.
+There are also more complex note types such as Saved Search, Render Note that usually + go hand-in-hand with Scripting.
In Trilium there's no specific "folder" note type. Any note can have children and thus be a folder.
Root note
@@ -47,7 +32,8 @@ tree. All other notes are placed below it in the structure.Tree structure
Importantly, note itself doesn't carry information on its placement in - note tree. See cloning for details.
+ note tree. See Cloning Notes for + details.Tree structure of notes can resemble file system - but compared to that notes in Trilium can act as both file and directory - meaning that note can both have its own content and have children. "Leaf note" is a note @@ -70,7 +56,8 @@ - the solution is then undelete in the reverse order of your deletion.
After the 7 days (configurable) the notes will be "erased" - their title, content, revisions and attributes will be erased, and it will not be possible - anymore to recover them (unless you restore backup).
+ anymore to recover them (unless you restore a Backup).See also
- Read-only note
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Attachments.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Attachments.html
index fba61b4fb..4e5d2c70d 100644
--- a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Attachments.html
+++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Attachments.html
@@ -16,10 +16,10 @@
A note in Trilium can own one or more attachments, which can be either images or files. These attachments can be displayed or linked within the note that owns them.
-This can be especially useful to include dependencies for your scripts. +
This can be especially useful to include dependencies for your scripts. The Weight Tracker shows how to use chartjs which is attached to - the script note.
+ the script note.Each note exclusively owns its attachments, meaning attachments cannot be shared or linked from one note to another. If an attachment link is copied to a different note, the attachment itself is duplicated, and the diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Export as PDF.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Export as PDF.html index f19f6219b..41632d37b 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Export as PDF.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Notes/Export as PDF.html @@ -37,7 +37,7 @@
Should you encounter any visual issues in the resulting PDF file (e.g. a table does not fit properly, there is cut off text, etc.) feel free to report the issue. In this case, it's best to offer a sample note (click + href="../../Troubleshooting/Reporting%20issues.html">report the issue. In this case, it's best to offer a sample note (click on the
@@ -45,15 +45,16 @@
button, select Export note → This note and all of its descendants → HTML
in ZIP archive). Make sure not to accidentally leak any personal information.When exporting to PDF, there are no customizable settings such as page orientation, size, etc. However, it is possible to specify a given note to be printed as a PDF in landscape mode by adding the
+ to it (see Attributes).#printLandscapeattribute - to it (see [missing note]).Page size
By default, the resulting PDF will be in Letter format. It is possible to adjust it to another page size via the
#printPageSizeattribute, with one of the following values:A0,A1,A2,A3,A4,A5,A6,Legal,Letter,Tabloid,Ledger.Keyboard shortcut
It's possible to trigger the export to PDF from the keyboard by going - to Keyboard shortcuts and assigning a key combination - for the
+ to Keyboard shortcuts in Options and assigning a key + combination for theexportAsPdfaction.exportAsPdfaction.