From fb91d4fbd4ad312a0138e9acde4041d4e6fb5a72 Mon Sep 17 00:00:00 2001 From: Elian Doran Date: Sun, 9 Nov 2025 22:52:02 +0200 Subject: [PATCH] docs(user): mention updates after react improvements --- .../Advanced Usage/Note source.html | 24 ++--- .../User Guide/Note Types/Canvas.html | 11 ++- .../User Guide/Note Types/File.html | 93 +++++++++++-------- .../User Guide/Note Types/Mind Map.html | 50 +++++----- .../User Guide/Note Types/Render Note.html | 20 +++- docs/Developer Guide/!!!meta.json | 2 +- .../Developer Guide/Documentation.md | 2 +- docs/Release Notes/!!!meta.json | 2 +- docs/User Guide/!!!meta.json | 44 ++++++++- .../User Guide/Advanced Usage/Note source.md | 2 +- .../User Guide/Note Types/Canvas.md | 6 +- docs/User Guide/User Guide/Note Types/File.md | 8 +- .../User Guide/Note Types/Mind Map.md | 3 +- .../User Guide/Note Types/Render Note.md | 7 ++ 14 files changed, 183 insertions(+), 91 deletions(-) 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 index ffd2e11de..2292a7cec 100644 --- 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 @@ -3,20 +3,20 @@ on the Note Types.

For example:

@@ -46,18 +46,20 @@

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.

+

For some note types, such as text notes and JSON 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:

    -
  1. Change the note type from the real note type (e.g. Canvas, Geo Type) to +
  2. 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.
    3. -
  3. Confirm the warning about changing the note type.
    4. -
  4. The source code will appear, make the necessary modifications.
    5. -
  5. Change the note type back to the real note type.
    6. +
  6. Confirm the warning about changing the note type.
    7. +
  7. The source code will appear, make the necessary modifications.
    8. +
  8. Change the note type back to the real note type.

Audio

-
+
@@ -68,11 +77,11 @@ be used to play it.

Interactions:

Text files

@@ -95,7 +104,7 @@ of characters. To view the full file, consider opening it in an external application.

Unknown file types

-
+
@@ -105,33 +114,35 @@ 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 +
  • 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.
      • +
    • 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.
    • -
  • Convert into an attachment from the note menu.
    • + +
  • It is not possible to change the note type of a File note.
    • +
  • Convert into an attachment from the note menu.

Relation with other notes

    -
  • +

  • 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.

    +

    + +

    • +
  • 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/Mind Map.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Mind Map.html index c47a4a034..b310466e9 100644 --- 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 @@ -6,34 +6,42 @@ a hierarchical fashion.

Terminology

    -
  • A node is a single idea, represented differently based +
  • 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 +
  • 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, +
  • 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 +
  • 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).
    • -
  • In the Floating buttons area: -
      -
    • 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).
      • -
    -
    • +
  • 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).
    • +
  • In the Floating buttons area: +
      +
    • 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).
      • +
    • The note can be togged read-only.
      • +
    +
\ No newline at end of file diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Render Note.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Render Note.html index 010fcc823..14a6cf28c 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Render Note.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Render Note.html @@ -7,11 +7,13 @@ via an attribute.

Creating a render note

    -
  1. Create a Code note +
  2. Create a Code note with the HTML language, with what needs to be displayed (for example <p>Hello world.</p>).
    3. -
  3. Create a Render Note.
    4. -
  4. Assign the renderNote relation to - point at the previously created code note.
    5. +
  5. Create a Render Note.
    6. +
  6. Assign the renderNote relation to + point at the previously created code note.

Dynamic content

A static HTML is generally not enough for 
The current date & time is Sun Apr 06 2025 15:26:29 GMT+0300 (Eastern European Summer Time)

+

Refreshing the note

+

It's possible to refresh the note via:

+

Examples

\ No newline at end of file diff --git a/docs/Developer Guide/!!!meta.json b/docs/Developer Guide/!!!meta.json index 8bcd2ba82..b1dc64a44 100644 --- a/docs/Developer Guide/!!!meta.json +++ b/docs/Developer Guide/!!!meta.json @@ -1,6 +1,6 @@ { "formatVersion": 2, - "appVersion": "0.99.3", + "appVersion": "0.99.4", "files": [ { "isClone": false, diff --git a/docs/Developer Guide/Developer Guide/Documentation.md b/docs/Developer Guide/Developer Guide/Documentation.md index de0b27f30..70c715368 100644 --- a/docs/Developer Guide/Developer Guide/Documentation.md +++ b/docs/Developer Guide/Developer Guide/Documentation.md @@ -1,5 +1,5 @@ # Documentation -There are multiple types of documentation for Trilium: +There are multiple types of documentation for Trilium: * The _User Guide_ represents the user-facing documentation. This documentation can be browsed by users directly from within Trilium, by pressing F1. * The _Developer's Guide_ represents a set of Markdown documents that present the internals of Trilium, for developers. diff --git a/docs/Release Notes/!!!meta.json b/docs/Release Notes/!!!meta.json index 5ffcff5c5..4e489fecf 100644 --- a/docs/Release Notes/!!!meta.json +++ b/docs/Release Notes/!!!meta.json @@ -1,6 +1,6 @@ { "formatVersion": 2, - "appVersion": "0.99.3", + "appVersion": "0.99.4", "files": [ { "isClone": false, diff --git a/docs/User Guide/!!!meta.json b/docs/User Guide/!!!meta.json index 60e415c5d..b05f2ed21 100644 --- a/docs/User Guide/!!!meta.json +++ b/docs/User Guide/!!!meta.json @@ -1,6 +1,6 @@ { "formatVersion": 2, - "appVersion": "0.99.3", + "appVersion": "0.99.4", "files": [ { "isClone": false, @@ -8888,6 +8888,20 @@ "value": "render-note", "isInheritable": false, "position": 70 + }, + { + "type": "relation", + "name": "internalLink", + "value": "XpOYSgsLkTJy", + "isInheritable": false, + "position": 80 + }, + { + "type": "relation", + "name": "internalLink", + "value": "A9Oc6YKKc65v", + "isInheritable": false, + "position": 90 } ], "format": "markdown", @@ -9093,6 +9107,20 @@ "value": "canvas", "isInheritable": false, "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "CoFPLs3dRlXc", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "XpOYSgsLkTJy", + "isInheritable": false, + "position": 40 } ], "format": "markdown", @@ -9191,6 +9219,13 @@ "value": "mindmap", "isInheritable": false, "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "CoFPLs3dRlXc", + "isInheritable": false, + "position": 40 } ], "format": "markdown", @@ -9318,6 +9353,13 @@ "value": "bx bx-file-blank", "isInheritable": false, "position": 140 + }, + { + "type": "relation", + "name": "internalLink", + "value": "XpOYSgsLkTJy", + "isInheritable": false, + "position": 150 } ], "format": "markdown", diff --git a/docs/User Guide/User Guide/Advanced Usage/Note source.md b/docs/User Guide/User Guide/Advanced Usage/Note source.md index 3466e6a0f..bfb34912b 100644 --- a/docs/User Guide/User Guide/Advanced Usage/Note source.md +++ b/docs/User Guide/User Guide/Advanced Usage/Note source.md @@ -36,7 +36,7 @@ It is possible to view the source code of a note by pressing the contextual menu 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. +For some note types, such as text notes and JSON notes, the source code is also formatted in order to be more easily readable. ## Modifying the source code diff --git a/docs/User Guide/User Guide/Note Types/Canvas.md b/docs/User Guide/User Guide/Note Types/Canvas.md index b88e1e27c..febd2bf65 100644 --- a/docs/User Guide/User Guide/Note Types/Canvas.md +++ b/docs/User Guide/User Guide/Note Types/Canvas.md @@ -1,6 +1,10 @@ # Canvas +
grafik
+ 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. -![grafik](Canvas_image.png) \ No newline at end of file +## Interaction + +* The note can be togged [read-only](../Basic%20Concepts%20and%20Features/Notes/Read-Only%20Notes.md) from the Floating buttons section. \ No newline at end of file diff --git a/docs/User Guide/User Guide/Note Types/File.md b/docs/User Guide/User Guide/Note Types/File.md index 96733128a..9c14f6228 100644 --- a/docs/User Guide/User Guide/Note Types/File.md +++ b/docs/User Guide/User Guide/Note Types/File.md @@ -33,7 +33,9 @@ Interaction: Interaction: -* _Copy reference to clipboard_, for embedding the image within Text notes. See Image references for more information. +* _Copy reference to clipboard_, for embedding the image within Text notes. + * See Image references for more information. + * Alternatively, press the corresponding button from the Floating buttons. ### Videos @@ -46,7 +48,7 @@ Video files can be added in as well. The file is streamed directly, so when acce ### Audio -
+
Adding a supported audio file will reveal a basic audio player that can be used to play it. @@ -69,7 +71,7 @@ Since one of the use cases for having files instead of notes is to display large ### 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. diff --git a/docs/User Guide/User Guide/Note Types/Mind Map.md b/docs/User Guide/User Guide/Note Types/Mind Map.md index b21edb683..878a4f544 100644 --- a/docs/User Guide/User Guide/Note Types/Mind Map.md +++ b/docs/User Guide/User Guide/Note Types/Mind Map.md @@ -21,4 +21,5 @@ The mindmap allows for easy jotting down of ideas and storing them in a hierarch * 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). * In the Floating buttons area: * An [image reference](Text/Images/Image%20references.md) 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 + * The diagram can be exported either as SVG (vectorial) or PNG (raster). + * The note can be togged [read-only](../Basic%20Concepts%20and%20Features/Notes/Read-Only%20Notes.md). \ No newline at end of file diff --git a/docs/User Guide/User Guide/Note Types/Render Note.md b/docs/User Guide/User Guide/Note Types/Render Note.md index 74acf618d..2b0f3d5cd 100644 --- a/docs/User Guide/User Guide/Note Types/Render Note.md +++ b/docs/User Guide/User Guide/Note Types/Render Note.md @@ -34,6 +34,13 @@ Now create a render note at any place and set its `~renderNote` relation to poin > **Current date & time** > The current date & time is Sun Apr 06 2025 15:26:29 GMT+0300 (Eastern European Summer Time) +## Refreshing the note + +It's possible to refresh the note via: + +* The corresponding button in Floating buttons. +* The “Render active note” [keyboard shortcut](../Basic%20Concepts%20and%20Features/Keyboard%20Shortcuts.md) (not assigned by default). + ## Examples * Weight Tracker which is present in the Demo Notes. \ No newline at end of file