From 10b3ede68625fa37ced0803c9f96be1872d70d9c Mon Sep 17 00:00:00 2001 From: Elian Doran Date: Sat, 5 Apr 2025 01:18:25 +0300 Subject: [PATCH] feat(docs): improve include note --- docs/User Guide/!!!meta.json | 55 +++++++++++++++++- docs/User Guide/User Guide/Note Types/File.md | 8 +-- docs/User Guide/User Guide/Note Types/Text.md | 8 +-- .../Note Types/Text/Include Note.md | 6 ++ .../Note Types/Text/Include Note_image.png | Bin 0 -> 253 bytes .../app/doc_notes/en/User Guide/!!!meta.json | 55 +++++++++++++++++- .../User Guide/Note Types/File.html | 19 +++--- .../User Guide/Note Types/Text.html | 6 +- .../Note Types/Text/Include Note.html | 28 +++++++++ .../Note Types/Text/Include Note_image.png | Bin 0 -> 253 bytes .../doc_notes/en/User Guide/navigation.html | 2 + 11 files changed, 160 insertions(+), 27 deletions(-) create mode 100644 docs/User Guide/User Guide/Note Types/Text/Include Note.md create mode 100644 docs/User Guide/User Guide/Note Types/Text/Include Note_image.png create mode 100644 src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Include Note.html create mode 100644 src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Include Note_image.png diff --git a/docs/User Guide/!!!meta.json b/docs/User Guide/!!!meta.json index 02c712334..70794da6e 100644 --- a/docs/User Guide/!!!meta.json +++ b/docs/User Guide/!!!meta.json @@ -4594,6 +4594,13 @@ "value": "s8alTXmpFR61", "isInheritable": false, "position": 70 + }, + { + "type": "label", + "name": "iconClass", + "value": "bx bxs-file-image", + "isInheritable": false, + "position": 80 } ], "format": "markdown", @@ -4619,6 +4626,43 @@ } ] }, + { + "isClone": false, + "noteId": "nBAXQFj20hS1", + "notePath": [ + "pOsGYCXsbNQG", + "KSZ04uQ2D1St", + "iPIMuisry3hd", + "nBAXQFj20hS1" + ], + "title": "Include Note", + "notePosition": 60, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "nRhnJkTT8cPs", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "Include Note.md", + "attachments": [ + { + "attachmentId": "GoLuBbQUYIQE", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "Include Note_image.png" + } + ] + }, { "isClone": false, "noteId": "QEAPj01N5f7w", @@ -4629,7 +4673,7 @@ "QEAPj01N5f7w" ], "title": "Links", - "notePosition": 60, + "notePosition": 70, "prefix": null, "isExpanded": false, "type": "text", @@ -4685,7 +4729,7 @@ "S6Xx8QIWTV66" ], "title": "Lists", - "notePosition": 70, + "notePosition": 80, "prefix": null, "isExpanded": false, "type": "text", @@ -5931,6 +5975,13 @@ "value": "0ESUbbAxVnoK", "isInheritable": false, "position": 120 + }, + { + "type": "relation", + "name": "internalLink", + "value": "nBAXQFj20hS1", + "isInheritable": false, + "position": 130 } ], "format": "markdown", diff --git a/docs/User Guide/User Guide/Note Types/File.md b/docs/User Guide/User Guide/Note Types/File.md index 68287c89c..955dfbd2f 100644 --- a/docs/User Guide/User Guide/Note Types/File.md +++ b/docs/User Guide/User Guide/Note Types/File.md @@ -82,8 +82,8 @@ If the file could not be identified as any of the supported file types from abov * It is **not** possible to change the note type of a _File_ note. * Convert into an [attachment](../Basic%20Concepts%20and%20Features/Notes/Attachments.md) from the [note menu](../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20buttons.md). -## Note list +## Relation with other notes -Files are also displayed in the [Note List](../Basic%20Concepts%20and%20Features/Notes/Note%20List.md) based on their type: - -![](6_File_image.png) \ No newline at end of file +* Files are also displayed in the [Note List](../Basic%20Concepts%20and%20Features/Notes/Note%20List.md) based on their type:![](6_File_image.png) +* Non-image files can be embedded into text notes as read-only widgets via the [Include Note](Text/Include%20Note.md) functionality. +* Image files can be embedded into text notes like normal images via [Image references](Text/Images/Image%20references.md). \ No newline at end of file diff --git a/docs/User Guide/User Guide/Note Types/Text.md b/docs/User Guide/User Guide/Note Types/Text.md index 5295c590b..43d074a5d 100644 --- a/docs/User Guide/User Guide/Note Types/Text.md +++ b/docs/User Guide/User Guide/Note Types/Text.md @@ -72,10 +72,4 @@ When editing a document that becomes too large, you can split it into sub-notes: 2. Create a new sub-note and name it. 3. 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. - -## Including a Note - -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. - -This functionality is available in the block toolbar icon. \ No newline at end of file +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/docs/User Guide/User Guide/Note Types/Text/Include Note.md b/docs/User Guide/User Guide/Note Types/Text/Include Note.md new file mode 100644 index 000000000..0a1eab62a --- /dev/null +++ b/docs/User Guide/User Guide/Note Types/Text/Include Note.md @@ -0,0 +1,6 @@ +# Include Note +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](Formatting%20toolbar.md), look for the ![](Include%20Note_image.png) 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/docs/User Guide/User Guide/Note Types/Text/Include Note_image.png b/docs/User Guide/User Guide/Note Types/Text/Include Note_image.png new file mode 100644 index 0000000000000000000000000000000000000000..a261c113d22638360528717224a7410aa470abfa GIT binary patch literal 253 zcmeAS@N?(olHy`uVBq!ia0vp^0wB!61|;P_|4#%`EX7WqAsj$Z!;#Vf4fk2|`C>f3UDk>|mI5{fx8Q_Q*r8 zOEym4|0elne%(tWMZVd)=Q(dWS6mvN`S%~o<5P97e2(gd0Nu~v>FVdQ&MBb@0IJAi A^#A|> literal 0 HcmV?d00001 diff --git a/src/public/app/doc_notes/en/User Guide/!!!meta.json b/src/public/app/doc_notes/en/User Guide/!!!meta.json index 03de91530..0c83f2046 100644 --- a/src/public/app/doc_notes/en/User Guide/!!!meta.json +++ b/src/public/app/doc_notes/en/User Guide/!!!meta.json @@ -4594,6 +4594,13 @@ "value": "s8alTXmpFR61", "isInheritable": false, "position": 70 + }, + { + "type": "label", + "name": "iconClass", + "value": "bx bxs-file-image", + "isInheritable": false, + "position": 80 } ], "format": "html", @@ -4619,6 +4626,43 @@ } ] }, + { + "isClone": false, + "noteId": "nBAXQFj20hS1", + "notePath": [ + "pOsGYCXsbNQG", + "KSZ04uQ2D1St", + "iPIMuisry3hd", + "nBAXQFj20hS1" + ], + "title": "Include Note", + "notePosition": 60, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "nRhnJkTT8cPs", + "isInheritable": false, + "position": 10 + } + ], + "format": "html", + "dataFileName": "Include Note.html", + "attachments": [ + { + "attachmentId": "GoLuBbQUYIQE", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "Include Note_image.png" + } + ] + }, { "isClone": false, "noteId": "QEAPj01N5f7w", @@ -4629,7 +4673,7 @@ "QEAPj01N5f7w" ], "title": "Links", - "notePosition": 60, + "notePosition": 70, "prefix": null, "isExpanded": false, "type": "text", @@ -4685,7 +4729,7 @@ "S6Xx8QIWTV66" ], "title": "Lists", - "notePosition": 70, + "notePosition": 80, "prefix": null, "isExpanded": false, "type": "text", @@ -5931,6 +5975,13 @@ "value": "0ESUbbAxVnoK", "isInheritable": false, "position": 120 + }, + { + "type": "relation", + "name": "internalLink", + "value": "nBAXQFj20hS1", + "isInheritable": false, + "position": 130 } ], "format": "html", diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/File.html b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/File.html index b4cf07f00..60467d9bc 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/File.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/File.html @@ -128,13 +128,18 @@
  • Convert into an attachment from the note menu.
    • -

    Note list

    -

    Files are also displayed in the Note List based - on their type:

    -

    - -

    -

     

    +

    Relation with other notes

    + diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text.html b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text.html index 04bb5aae5..f80834ab2 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text.html @@ -91,11 +91,7 @@ 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.

    -

    Including a Note

    -

    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.

    -

    This functionality is available in the block toolbar icon.

    +

     

    diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Include Note.html b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Include Note.html new file mode 100644 index 000000000..4a522d47d --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Include Note.html @@ -0,0 +1,28 @@ + + + + + + + + Include Note + + + +
    +

    Include Note

    + +
    +

    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/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Include Note_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Include Note_image.png new file mode 100644 index 0000000000000000000000000000000000000000..a261c113d22638360528717224a7410aa470abfa GIT binary patch literal 253 zcmeAS@N?(olHy`uVBq!ia0vp^0wB!61|;P_|4#%`EX7WqAsj$Z!;#Vf4fk2|`C>f3UDk>|mI5{fx8Q_Q*r8 zOEym4|0elne%(tWMZVd)=Q(dWS6mvN`S%~o<5P97e2(gd0Nu~v>FVdQ&MBb@0IJAi A^#A|> literal 0 HcmV?d00001 diff --git a/src/public/app/doc_notes/en/User Guide/navigation.html b/src/public/app/doc_notes/en/User Guide/navigation.html index d512c22d9..3642a0343 100644 --- a/src/public/app/doc_notes/en/User Guide/navigation.html +++ b/src/public/app/doc_notes/en/User Guide/navigation.html @@ -239,6 +239,8 @@ +
  • Include Note +
  • Links
  • Lists