feat(docs): improve include note

This commit is contained in:
Elian Doran 2025-04-05 01:18:25 +03:00
parent 1e6c197794
commit 10b3ede686
No known key found for this signature in database
11 changed files with 160 additions and 27 deletions

View File

@ -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",

View File

@ -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)
* 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).

View File

@ -73,9 +73,3 @@ When editing a document that becomes too large, you can split it into sub-notes:
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.

View File

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

Binary file not shown.

After

Width:  |  Height:  |  Size: 253 B

View File

@ -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",

View File

@ -128,13 +128,18 @@
<li>Convert into an <a href="../Basic%20Concepts%20and%20Features/Notes/Attachments.html">attachment</a> from
the <a href="../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20buttons.html">note menu</a>.</li>
</ul>
<h2>Note list</h2>
<p>Files are also displayed in the&nbsp;<a class="reference-link" href="../Basic%20Concepts%20and%20Features/Notes/Note%20List.html">Note List</a>&nbsp;based
on their type:</p>
<p>
<h2>Relation with other notes</h2>
<ul>
<li>Files are also displayed in the&nbsp;<a class="reference-link" href="../Basic%20Concepts%20and%20Features/Notes/Note%20List.html">Note List</a>&nbsp;based
on their type:
<img src="6_File_image.png" width="853" height="315">
</p>
<p>&nbsp;</p>
</li>
<li>Non-image files can be embedded into text notes as read-only widgets via
the&nbsp;<a class="reference-link" href="Text/Include%20Note.html">Include Note</a>&nbsp;functionality.</li>
<li>Image files can be embedded into text notes like normal images via&nbsp;
<a
class="reference-link" href="Text/Images/Image%20references.html">Image references</a>.</li>
</ul>
</div>
</div>
</body>

View File

@ -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.</p>
<h2>Including a Note</h2>
<p>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
&amp; "render HTML" note) or other more advanced use cases.</p>
<p>This functionality is available in the block toolbar icon.</p>
<p>&nbsp;</p>
</div>
</div>
</body>

View File

@ -0,0 +1,28 @@
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../../../style.css">
<base target="_parent">
<title data-trilium-title>Include Note</title>
</head>
<body>
<div class="content">
<h1 data-trilium-h1>Include Note</h1>
<div class="ck-content">
<p>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
&amp; "render HTML" note) or other more advanced use cases.</p>
<h2>Including a note</h2>
<p>In the&nbsp;<a class="reference-link" href="Formatting%20toolbar.html">Formatting toolbar</a>,
look for the
<img src="Include Note_image.png" width="16" height="16">button. There is also a keyboard shortcut defined for it but it is not
allocated by default.</p>
</div>
</div>
</body>
</html>

Binary file not shown.

After

Width:  |  Height:  |  Size: 253 B

View File

@ -239,6 +239,8 @@
</li>
</ul>
</li>
<li><a href="User%20Guide/Note%20Types/Text/Include%20Note.html" target="detail">Include Note</a>
</li>
<li><a href="User%20Guide/Note%20Types/Text/Links.html" target="detail">Links</a>
</li>
<li><a href="User%20Guide/Note%20Types/Text/Lists.html" target="detail">Lists</a>