Skip to content

Build your personal knowledge base with Trilium Notes

docs(user): address requested changes

Elian Doran8e1f0380c3bc
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Note menu.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Note menu.html
index 27ce6ef37b..d056f01ba7 100644
--- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Note menu.html
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Note menu.html
@@ -143,9 +143,10 @@
</ul>
</li>
<li><span class="tn-icon bx bx-paperclip"></span><em>Convert into attachment</em> appears
- on an image note that has no children and a single parent. After a confirmation,
- it turns the image into an attachment of its parent note and opens it there.
- See&nbsp;<a class="reference-link" href="#root/_help_0vhv7lsOLy82">Attachments</a>.</li>
+ on an image note that has no children and a single parent which is a&nbsp;<a
+ class="reference-link" href="#root/_help_iPIMuisry3hd">Text</a>&nbsp;note.
+ After a confirmation, it turns the image into an attachment of its parent
+ note and opens it there. See&nbsp;<a class="reference-link" href="#root/_help_0vhv7lsOLy82">Attachments</a>.</li>
<li><span class="tn-icon bx bx-extension"></span><em>Re-render note</em> appears
on a&nbsp;<a class="reference-link" href="#root/_help_HcABDtFCkbFN">Render Note</a>,
and runs its script again to refresh the output.</li>
@@ -157,31 +158,23 @@
<p>The <span class="tn-icon bx bx-wrench"></span><em>Advanced</em> submenu
groups the actions that are needed less often:</p>
<ul>
- <li>
- <p><span class="tn-icon bx bx-file-find"></span><em>Open note externally</em> (desktop
- application only) saves the note to a temporary file and opens it in the
- application that the operating system associates with it. Trilium watches
- the file, and offers to upload the modified version back into the note.
- It is unavailable on&nbsp;<a class="reference-link" href="#root/_help_GTwFsgaA0lCt">Collections</a>&nbsp;and&nbsp;<a
- class="reference-link" href="#root/_help_m523cpzocqaD">Saved Search</a>&nbsp;notes.</p>
- </li>
- <li>
- <p><span class="tn-icon bx bx-customize"></span><em>Open note custom</em> (desktop
- application only, Windows and Linux) works like <em>Open note externally</em>,
- but lets you pick the application to open the file with.</p>
- </li>
- <li>
- <p><span class="tn-icon bx bx-code"></span><em>Note source</em> shows the&nbsp;<a
- class="reference-link" href="#root/_help_4FahAwuGTAwC">Note source</a>,
- the content of the note exactly as it is stored.</p>
- </li>
- <li>
- <p><span class="tn-icon bx bxl-markdown"></span><em>Convert to Markdown Note</em> (on
- text notes) and <em>Convert to Text Note</em> (on Markdown notes) switch
- the note between rich text and Markdown. After a confirmation, Trilium
- saves a revision and converts the content; the revision allows going back
- if some formatting was lost. See&nbsp;<a class="reference-link" href="#root/_help_jludwdW7N4hg">Converting between note types</a>.</p>
- </li>
+ <li><span class="tn-icon bx bx-file-find"></span><em>Open note externally</em> (desktop
+ application only) saves the note to a temporary file and opens it in the
+ application that the operating system associates with it. Trilium watches
+ the file, and offers to upload the modified version back into the note.
+ It is unavailable on&nbsp;<a class="reference-link" href="#root/_help_GTwFsgaA0lCt">Collections</a>&nbsp;and&nbsp;<a
+ class="reference-link" href="#root/_help_m523cpzocqaD">Saved Search</a>&nbsp;notes.</li>
+ <li><span class="tn-icon bx bx-customize"></span><em>Open note custom</em> (desktop
+ application only, Windows and Linux) works like <em>Open note externally</em>,
+ but lets you pick the application to open the file with.</li>
+ <li><span class="tn-icon bx bx-code"></span><em>Note source</em> shows the&nbsp;<a
+ class="reference-link" href="#root/_help_4FahAwuGTAwC">Note source</a>,
+ the content of the note exactly as it is stored.</li>
+ <li><span class="tn-icon bx bxl-markdown"></span><em>Convert to Markdown Note</em> (on
+ text notes) and <em>Convert to Text Note</em> (on Markdown notes) switch
+ the note between rich text and Markdown. After a confirmation, Trilium
+ saves a revision and converts the content; the revision allows going back
+ if some formatting was lost. See&nbsp;<a class="reference-link" href="#root/_help_jludwdW7N4hg">Converting between note types</a>.</li>
<li>
<p><span class="tn-icon bx bx-collapse-alt"></span><em>Compress images</em> opens
a dialog that reduces the size of the images in the note. It lists the
@@ -196,17 +189,13 @@
<p>Compressing cannot be undone. Images can also be compressed automatically
on upload, see&nbsp;<a class="reference-link" href="#root/_help_mT0HEkOsz6i1">Images</a>.</p>
</li>
- <li>
- <p><span class="tn-icon bx bx-text"></span><em>View OCR text</em> (on image
- and file notes) shows the text extracted from the note via&nbsp;<a class="reference-link"
- href="#root/_help_TiQbQDgP8L5t">Text Extraction (OCR)</a>. If the note
- has not been processed yet, the dialog offers to <em>Process OCR</em>.</p>
- </li>
- <li>
- <p><span class="tn-icon bx bx-world"></span><em>Open note on server</em> (desktop
- application only, listed when&nbsp;<a class="reference-link" href="#root/_help_cbkrhQjrkKrh">Synchronization</a>&nbsp;is
- configured) opens the same note on the sync server, in the web browser.</p>
- </li>
+ <li><span class="tn-icon bx bx-text"></span><em>View OCR text</em> (on image
+ and file notes) shows the text extracted from the note via&nbsp;<a class="reference-link"
+ href="#root/_help_TiQbQDgP8L5t">Text Extraction (OCR)</a>. If the note
+ has not been processed yet, the dialog offers to <em>Process OCR</em>.</li>
+ <li><span class="tn-icon bx bx-world"></span><em>Open note on server</em> (desktop
+ application only, listed when&nbsp;<a class="reference-link" href="#root/_help_cbkrhQjrkKrh">Synchronization</a>&nbsp;is
+ configured) opens the same note on the sync server, in the web browser.</li>
</ul>
<h2>Deleting the note</h2>
<p><span class="tn-icon bx bx-trash"></span><em>Delete note</em> opens the
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Right Sidebar/Outline tab.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Right Sidebar/Outline tab.html
index 80dfceac86..aae4c3b3a9 100644
--- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Right Sidebar/Outline tab.html
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Right Sidebar/Outline tab.html
@@ -26,6 +26,8 @@
<li>As the document is scrolled, the heading being read is highlighted and
the list scrolls to keep it in view. If that heading is hidden inside a
collapsed section, the collapsed heading is highlighted instead.</li>
+ <li>Nested items can be collapsed by pressing the corresponding&nbsp;<span
+ class="tn-icon bx bx-chevron-down"></span> button.</li>
</ul>
<h2>Highlights</h2>
<figure class="image image-style-align-right image_resized" style="width:46.04%;">
@@ -48,8 +50,6 @@
<h3>Interaction</h3>
<ul>
<li>Clicking on a highlighted text will scroll the document to its position.</li>
- <li>Nested items can be collapsed by pressing the corresponding&nbsp;<span
- class="tn-icon bx bx-chevron-down"></span> button.</li>
</ul>
<h3>Configuration</h3>
<ul>
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
index 35d8d988e6..9dd10682d8 100644
--- 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
@@ -90,7 +90,9 @@
</ul>
</li>
<li>The note can be marked as <a href="#root/_help_CoFPLs3dRlXc">read-only</a>,
- case in which the code and preview are still available but cannot be edited.</li>
+ case in which it switches by default to the preview (although it can be
+ switched back using the source/preview buttons) and the source is no longer
+ editable.</li>
</ul>
<h2>Errors in the diagram</h2>
<p>If there is an error in the source code, the error will be displayed in
diff --git a/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Note menu.md b/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Note menu.md
index db5d9d3f8d..d9c8bd4300 100644
--- a/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Note menu.md
+++ b/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Note menu.md
@@ -60,7 +60,7 @@ The following entries only appear on some notes:
* <span class="tn-icon bx bx-align-justify"></span>_Word wrap_ appears at the top of the menu on <a class="reference-link" href="../../Note%20Types/Code.md">Code</a> notes, and sets whether long lines wrap in this note:
* _Auto_ (the default) follows <a class="reference-link" href="Options.md">Options</a> → _Code Notes_ → _Wrap lines in code notes_.
* _On_ and _Off_ override it for this note only, by setting the `#wrapLines` label.
-* <span class="tn-icon bx bx-paperclip"></span>_Convert into attachment_ appears on an image note that has no children and a single parent. After a confirmation, it turns the image into an attachment of its parent note and opens it there. See <a class="reference-link" href="../Notes/Attachments.md">Attachments</a>.
+* <span class="tn-icon bx bx-paperclip"></span>_Convert into attachment_ appears on an image note that has no children and a single parent which is a <a class="reference-link" href="../../Note%20Types/Text.md">Text</a> note. After a confirmation, it turns the image into an attachment of its parent note and opens it there. See <a class="reference-link" href="../Notes/Attachments.md">Attachments</a>.
* <span class="tn-icon bx bx-extension"></span>_Re-render note_ appears on a <a class="reference-link" href="../../Note%20Types/Render%20Note.md">Render Note</a>, and runs its script again to refresh the output.
* <span class="tn-icon bx bx-cog"></span>_Board properties_ appears on a <a class="reference-link" href="../../Collections/Kanban%20Board.md">Kanban Board</a>, and configures its columns, card attributes and card templates.
diff --git a/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Right Sidebar/Outline tab.md b/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Right Sidebar/Outline tab.md
index c74fbb93d9..7d54fc60ca 100644
--- a/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Right Sidebar/Outline tab.md
+++ b/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Right Sidebar/Outline tab.md
@@ -19,6 +19,7 @@ The following note types are supported:
* Clicking on a heading will scroll the document to the position of the heading.
* As the document is scrolled, the heading being read is highlighted and the list scrolls to keep it in view. If that heading is hidden inside a collapsed section, the collapsed heading is highlighted instead.
+* Nested items can be collapsed by pressing the corresponding <span class="tn-icon bx bx-chevron-down"></span> button.
## Highlights
@@ -39,7 +40,6 @@ Highlighted text is defined as:
### Interaction
* Clicking on a highlighted text will scroll the document to its position.
-* Nested items can be collapsed by pressing the corresponding <span class="tn-icon bx bx-chevron-down"></span> button.
### Configuration
diff --git a/docs/User Guide/User Guide/Note Types/Mermaid Diagrams.md b/docs/User Guide/User Guide/Note Types/Mermaid Diagrams.md
index a58f30f3a6..0d0632bce0 100644
--- a/docs/User Guide/User Guide/Note Types/Mermaid Diagrams.md
+++ b/docs/User Guide/User Guide/Note Types/Mermaid Diagrams.md
@@ -45,7 +45,7 @@ It's possible to switch between the two layouts at any time by pressing the <sp
* To export the diagram as either SVG or PNG, go to the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20buttons.md">Note buttons</a> and select _Export as image_:
* Select _SVG (vector)_ to download a scalable/vector rendering of the diagram. Can be used to present the diagram without degrading when zooming.
* Select _PNG (raster)_ 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.
-* The note can be marked as [read-only](../Basic%20Concepts%20and%20Features/Notes/Read-Only%20Notes.md), case in which the code and preview are still available but cannot be edited.
+* The note can be marked as [read-only](../Basic%20Concepts%20and%20Features/Notes/Read-Only%20Notes.md), case in which it switches by default to the preview (although it can be switched back using the source/preview buttons) and the source is no longer editable.
## Errors in the diagram