Build your personal knowledge base with Trilium Notes
TypeScript electronelectron-appknowledge-baseknowledge-graphknowledge-managementknowledge-management-graphlocal-firstnote-managmentnote-takernote-takingnotebooknotesnotes-apppersonal-knowledge-basepersonal-wikiscriptableself-hostedself-hostingwiki
fix(menus): write the menu labels in sentence case
Elian Doran4f5028283958
diff --git a/apps/client/src/translations/en/translation.json b/apps/client/src/translations/en/translation.jsonindex bdc45908eb..d6d5cc17e4 100644--- a/apps/client/src/translations/en/translation.json+++ b/apps/client/src/translations/en/translation.json@@ -1155,34 +1155,34 @@"global_menu": {"menu": "Menu","options": "Options",- "open_new_window": "Open New Window",- "switch_to_mobile_version": "Switch to Mobile Version",- "switch_to_desktop_version": "Switch to Desktop Version",+ "open_new_window": "Open new window",+ "switch_to_mobile_version": "Switch to mobile version",+ "switch_to_desktop_version": "Switch to desktop version","zoom": "Zoom",- "toggle_fullscreen": "Toggle Fullscreen",- "zoom_out": "Zoom Out",- "reset_zoom_level": "Reset Zoom Level",- "zoom_in": "Zoom In",- "configure_launchbar": "Configure Launchbar...",- "show_shared_notes_subtree": "Show Shared Notes Subtree",- "show_deleted_notes": "Show Deleted Notes",- "show_space_usage": "Show Space Usage",+ "toggle_fullscreen": "Toggle fullscreen",+ "zoom_out": "Zoom out",+ "reset_zoom_level": "Reset zoom level",+ "zoom_in": "Zoom in",+ "configure_launchbar": "Configure launch bar...",+ "show_shared_notes_subtree": "Show shared notes subtree",+ "show_deleted_notes": "Show deleted notes",+ "show_space_usage": "Show space usage","advanced": "Advanced",- "open_dev_tools": "Open Dev Tools",- "open_sql_console": "Open SQL Console",- "open_sql_console_history": "Open SQL Console History",- "open_search_history": "Open Search History",- "show_backend_log": "Show Backend Log",+ "open_dev_tools": "Open dev tools",+ "open_sql_console": "Open SQL console",+ "open_sql_console_history": "Open SQL console history",+ "open_search_history": "Open search history",+ "show_backend_log": "Show backend log","reload_hint": "Reload can help with some visual glitches without restarting the whole app.",- "reload_frontend": "Reload Frontend",- "show_hidden_subtree": "Show Hidden Subtree",- "show_help": "Show Help",+ "reload_frontend": "Reload frontend",+ "show_hidden_subtree": "Show hidden subtree",+ "show_help": "Show help","about": "About Trilium Notes","logout": "Logout",- "show-cheatsheet": "Show Cheatsheet",- "toggle-zen-mode": "Zen Mode",- "new-version-available": "New Update Available",- "download-update": "Get Version {{latestVersion}}",+ "show-cheatsheet": "Show cheatsheet",+ "toggle-zen-mode": "Zen mode",+ "new-version-available": "New update available",+ "download-update": "Get version {{latestVersion}}","search_notes": "Search notes"},"zen_mode": {@@ -1225,7 +1225,6 @@"import_files": "Import files...","export_note": "Export note...","delete_note": "Delete note...",- "print_note": "Print note...","print_or_export_to_pdf": "Print/export to PDF...","view_revisions": "Note revisions...","save_revision": "Save revision",@@ -1234,8 +1233,8 @@"convert_into_attachment_failed": "Converting note '{{title}}' failed.","convert_into_attachment_successful": "Note '{{title}}' has been converted to attachment.","convert_into_attachment_prompt": "Are you sure you want to convert note '{{title}}' into an attachment of the parent note?",- "convert_to_markdown": "Convert to Markdown Note...",- "convert_to_text": "Convert to Text Note...",+ "convert_to_markdown": "Convert to Markdown note...",+ "convert_to_text": "Convert to text note...","convert_format_warning": "Some formatting may be lost during the conversion and you may need to fix a few things afterwards. A revision of the current note will be saved beforehand so you can restore it. Do you want to continue?","convert_format_warning_risky": "You are converting between two formats that don't have identical capabilities, so some formatting may be lost and some unsupported elements may be dropped.<br><br>Do you fully assume this risk and want to proceed with the conversion?<br><br>A revision of the current note will be saved beforehand, so you can revert to the original format.","convert_to_markdown_successful": "Note has been converted to Markdown.",@@ -1391,7 +1390,7 @@"calculate": "calculate","subtree_size_one": "(subtree size: {{size}} in {{count}} note)","subtree_size_other": "(subtree size: {{size}} in {{count}} notes)",- "title": "Note Info",+ "title": "Note info","show_similar_notes": "Show similar notes"},"note_map": {@@ -2501,7 +2500,7 @@"editability_select": {"auto": "Auto","read_only": "Read-only",- "always_editable": "Always Editable",+ "always_editable": "Always editable","note_is_editable": "Note is editable if it's not too long.","note_is_read_only": "Note is read-only, but can be edited with a button click.","note_is_always_editable": "Note is always editable, regardless of its length."@@ -2843,7 +2842,7 @@"more_actions": "More actions"},"title_bar_buttons": {- "window-on-top": "Keep Window on Top"+ "window-on-top": "Keep window on top"},"note_detail": {"content_load_error": "The note's content could not be loaded.",diff --git a/apps/client/src/widgets/layout/NoteActions.tsx b/apps/client/src/widgets/layout/NoteActions.tsxindex aaf6e7ffa8..4788f67dae 100644--- a/apps/client/src/widgets/layout/NoteActions.tsx+++ b/apps/client/src/widgets/layout/NoteActions.tsx@@ -205,7 +205,7 @@ export function NoteContextMenu({ note, noteContext, leadingViewActions = [], tr</>)}<CommandItem command="printActiveNote" icon="bx bx-printer" disabled={!isPrintable}- text={isElectron ? t("note_actions.print_or_export_to_pdf") : t("note_actions.print_note")}+ text={t("note_actions.print_or_export_to_pdf")}/><FormDropdownDivider />diff --git a/apps/server/src/assets/help/help_content.json b/apps/server/src/assets/help/help_content.jsonindex 60f3edc9cd..95d9f02dfb 100644--- a/apps/server/src/assets/help/help_content.json+++ b/apps/server/src/assets/help/help_content.json@@ -29,7 +29,7 @@"_help_yeEaYqosGLSh": "<p>As an alternative to <a href=\"#root/_help_Dgg7bR3b6K9j\">hosting your own Trilium instance</a>, there are two services out there that provide out of the box support for Trilium.</p><aside class=\"admonition important\"><p><strong>Disclaimer</strong>: The Trilium Notes project and maintainers are not directly affiliated with either of the projects.</p><p>PikaPods have gracefully offered us free credits for testing purposes.</p></aside><h2>Cloud instance providers</h2><h3>PikaPods</h3><ol><li>Go to <a href=\"https://www.pikapods.com\">pikapods.com</a> and sign up.</li><li>In the “Available Apps” section, look for \"TriliumNext<br> and select “Run your own”.</li><li>Follow the on-screen instructions to set up your own cloud hosted instance.</li></ol><p>PikaPods generally updates their Trilium instances to the latest version within a two-week interval after a new version is released.</p><h2>Matching your version with the cloud instance</h2><p>Please note that once you set up <a class=\"reference-link\" href=\"#root/_help_cbkrhQjrkKrh\">Synchronization</a> between a cloud instance and <a href=\"#root/_help_poXkQfguuA0U\">desktop</a> clients, it's important that the version of the desktop application and the server match up.</p><p>When setting up a cloud instance, it's best to check the version of the server by accessing it via a web browser and going to the <em>About</em> section. It's best that both the desktop and the server have the same <em>App version</em>; however it's generally OK to update the desktop to a newer version than the server if it has the same <em>Sync version</em>.</p><p>If the <em>Sync version</em> between the server and the desktop application doesn't match, synchronization will not work.</p>","_help_iGTnKjubbXkA": "<ul><li>Using Docker, the server can be run on Windows, Linux and macOS devices.</li><li>Native binaries are provided for Linux x64 and ARM (<code>aarch64</code>).</li></ul><h2>Legacy ARM support</h2><p>The Docker builds also provide <code>linux/arm/v7</code> and <code>linux/arm/v8</code> platforms. These platforms are considered legacy since Trilium uses Node.js version 24 which have <a href=\"https://github.com/nodejs/node/commit/6682861d6f\">officially downgraded support</a> for these platforms to “experimental”.</p><p>As a result, Trilium needs to use Node.js 22 for these versions. As soon as soon Node.js 22 will no longer be compatible, support for <code>armv7</code> and <code>armv8</code> will be dropped entirely.</p><p>Regardless of upstream support, these platforms are supported on a best-effort basis and are not officially supported by the Trilium development team. Bug reports are accepted but they will not be treated with priority; contributions are welcome.</p>","_help_cbkrhQjrkKrh": "<p>Trilium is an offline-first note-taking application that stores all data locally on the desktop client. However, it also offers the option to set up synchronization with a server instance, allowing multiple desktop clients to sync with a central server. This creates a star-shaped topology:</p><p><img src=\"{{helpAssets}}/User%20Guide/Installation%20%26%20Setup/Synchronization_image.jpg\"></p><p>In this setup, a central server (referred to as the <em>sync server</em>) and multiple <em>client</em> (or <em>desktop</em>) instances synchronize with the sync server. Once configured, synchronization is automatic and ongoing, requiring no manual intervention.</p><h2>Setting Up Synchronization</h2><h3>Security Considerations</h3><p>Setting up the server securely is critical and can be complex. It is crucial to use a valid <a href=\"#root/_help_l2VkvOwUNfZj\">TLS certificate</a> (HTTPS) rather than an unencrypted HTTP connection to ensure security and avoid potential vulnerabilities.</p><h3>Synchronizing a Desktop Instance with a Sync Server</h3><p>This method is used when you already have a desktop instance of Trilium and want to set up a sync server on your web host.</p><ol><li><strong>Server Deployment</strong>: Ensure your server instance is deployed but uninitialized.</li><li><strong>Desktop Configuration</strong>: Open your desktop instance, navigate to <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Sync</em> → <em>Sync server</em>, and set the <em>Server address</em> to your sync server's address.<ul><li>Note that the sync server can also be overridden through <a class=\"reference-link\" href=\"#root/_help_Gzjqa934BdH4\">Configuration (config.ini or environment variables)</a>, case in which that value takes precedence. If that's the case, a field called <em>Server in use</em> indicates it.</li></ul></li><li><strong>Testing Sync</strong>: Click the <em>Test sync</em> button to verify the connection to the sync server.<ul><li>If successful, the client will start pushing all data to the server instance.</li><li>This process may take some time, but you can continue using Trilium. Periodically check the server instance to confirm when the sync is complete. Once finished, you should see the login screen on the server.</li></ul></li></ol><h3>Synchronizing a Desktop Instance from a Sync Server</h3><p>This method is used when you already have a sync server and want to configure a new desktop instance to sync with it.</p><ol><li><strong>Desktop Setup</strong>: Follow the <a href=\"#root/_help_poXkQfguuA0U\">desktop installation page</a>.</li><li><strong>Initial Configuration</strong>: When prompted, choose the option to set up sync with a sync server.</li></ol><p><img src=\"{{helpAssets}}/User%20Guide/Installation%20%26%20Setup/Synchronization_sync-init.png\" alt=\"screenshot of the sync from server setup page\"></p><ol><li><strong>Server Details</strong>: Configure the Trilium server address and enter the server's password. If the server has <a class=\"reference-link\" href=\"#root/_help_7DAiwaf8Z7Rz\">Multi-factor authentication with TOTP</a> enabled, also enter a one-time password from your authenticator app, or a recovery code.</li><li><strong>Finish Setup</strong>: Click the \"Finish setup\" button. If successful, you will see the following screen:</li></ol><p><img src=\"{{helpAssets}}/User%20Guide/Installation%20%26%20Setup/Synchronization_sync-in-progress.png\" alt=\"screenshot of the sync page\"></p><p>Once synchronization is complete, you will be automatically redirected to the Trilium application.</p><h3>Desktop-to-desktop sync</h3><p>This method allows two desktop instances to synchronize between each other without requiring a <a class=\"reference-link\" href=\"#root/_help_WOcw2SLH6tbX\">Server Installation</a>.</p><aside class=\"admonition warning\"><p>Since v0.104.0, LAN access needs to be enabled to allow this sync to function. See <a class=\"reference-link\" href=\"#root/_help_swSFivWk6KkA\">Network Access</a> for information on how to do so.</p></aside><h2>Proxy Configuration</h2><p>Two proxy setups are supported:</p><ul><li><strong>Explicit Proxy Configuration</strong>: Set the proxy server in Options / Sync. Only unauthenticated proxy servers are supported.</li><li><strong>System Proxy Settings</strong>: If no proxy server is explicitly configured, Trilium will use the system proxy settings.</li></ul><h2>Troubleshooting</h2><h3>Date/Time Synchronization</h3><p>For successful synchronization, both client and server must have the same date and time, with a tolerance of up to five minutes.</p><h3>Certificate Issues</h3><p>When using TLS, Trilium will verify the server certificate. If verification fails (e.g., due to self-signed certificates or certain corporate proxies), you can run the Trilium client with the <code>NODE_TLS_REJECT_UNAUTHORIZED</code> environment variable set to <code>0</code>:</p><pre><code class=\"language-text-x-trilium-auto\">export NODE_TLS_REJECT_UNAUTHORIZED=0</code></pre><p>This will disable TLS certificate verification, significantly reducing security and exposing the setup to MITM attacks. It is strongly recommended to use a valid signed server certificate. Newer Trilium versions include a script called <code>trilium-no-cert-check.sh</code> for this purpose.</p><h3>Conflict Resolution</h3><p>If you edit the same note on multiple instances before synchronization, Trilium resolves conflicts by retaining the newer change and discarding the older one. The older version remains accessible in <a href=\"#root/_help_vZWERwf8U3nx\">note revisions</a>, allowing data recovery if needed.</p><h3>Hash Check</h3><p>After each synchronization, Trilium computes a hash of all synced data on both the client and the sync server. If there is a discrepancy, Trilium will automatically initiate a recovery mechanism to resolve the issue.</p>",- "_help_RDslemsQ6gCp": "<figure class=\"image image-style-align-right image_resized\" style=\"width:33.52%;\"><img style=\"aspect-ratio:1242/2688;\" src=\"{{helpAssets}}/User%20Guide/Installation%20%26%20Setup/Mobile%20Frontend_IMG_1765.PNG\" width=\"1242\" height=\"2688\"></figure><p>Trilium has a mobile web frontend which is optimized for touch based devices - smartphones and tablets. It is activated automatically during login process based on browser detection.</p><p>Mobile frontend is limited in features compared to the full desktop version. See below for more details on this.</p><h2>Layout basics</h2><p>Unlike the desktop version, the mobile version has a slightly different UI meant to better fit the constrained screens of a mobile phone.</p><p>Here is a non-exhaustive list of differences between the desktop version and the mobile one:</p><ul><li>The <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a> is displayed as a sidebar. To display the sidebar, press the button in the top-left of the screen.<ul><li>There is also a swipe gesture that can be done from the left of the screen, but the browser's navigation gesture interferes with it most of the time (depending on the platform).</li><li>Press and hold a note to display the <a class=\"reference-link\" href=\"#root/_help_YtSN43OrfzaA\">Note tree contextual menu</a>.</li></ul></li><li>The <a class=\"reference-link\" href=\"#root/_help_Ms1nauBra7gq\">Quick search</a> bar is also displayed at the top of the note tree.</li><li>The full <a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a> function can be triggered either from either the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> or from the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>, if configured.</li><li>The <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> is shorter: <em>Open New Window</em> and <em>Show Cheatsheet</em> are left out, and <em>Switch to Desktop Version</em> is under <em>Advanced</em>.</li><li>The <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a> is displayed at the bottom of the screen.<ul><li>The launch bar uses a different configuration for icons than the desktop version. See the dedicated page for more information on how to configure it.</li></ul></li><li>Most of the note-related actions are grouped in the horizontal dots icon on the top-right of the note.</li><li>The <a class=\"reference-link\" href=\"#root/_help_3seOhtN8uLIY\">Tabs</a> are grouped under a tab switcher in the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>, where the tabs are displayed in a full-screen grid with preview for easy switching, as well as additional options such as reopening closed tabs.</li><li>Since v0.100.0, <a class=\"reference-link\" href=\"#root/_help_luNhaphA37EO\">Split View</a> can also be used in mobile view, but with a maximum of two panes at once. The splits are displayed vertically instead of horizontally.</li></ul><h2>Installing as a PWA</h2><p>The mobile view can be set up as a PWA. While this does not offer any offline capabilities, it will display the application in full-screen and makes it easy to access via your mobile phone's home screen.</p><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-apple\"></span> iOS with Safari</p><div class=\"trilium-tab-panel\"><ol><li>Open your default web browser and access your Trilium instance.</li><li>Login.</li><li>Press the […] button in the bottom-right of the screen and select Share.</li><li>Scroll down to reveal the full list of items and choose <em>Add to Home Screen</em>.</li><li>Press <em>Add</em> and the web app will be available.</li></ol></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-chrome\"></span> Android with Google Chrome</p><div class=\"trilium-tab-panel\"><aside class=\"admonition important\"><p>Google Chrome requires the server to be served over HTTPS in order to display in full-screen. If using HTTP, the app will appear like a normal web page (similar to a bookmark).</p></aside><ol><li>Open your default web browser and access your Trilium instance.</li><li>Login.</li><li>Press the three vertical dots icon in the top-right of the screen and select <em>Add to Home screen.</em></li><li>Select the <em>Install</em> option.</li><li>Select an appropriate name.</li><li>The web app will appear as an application, not on the home screen.</li></ol></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Android with Brave</p><div class=\"trilium-tab-panel\"><aside class=\"admonition important\"><p>Brave requires the server to be served over HTTPS in order to display in full-screen. If using HTTP, the app will appear like a normal web page (similar to a bookmark).</p></aside><ol><li>Open your default web browser and access your Trilium instance.</li><li>Login.</li><li>Press the three vertical dots icon in the bottom-right of the screen and select <em>Add to Home screen</em>.</li><li>Press the <em>Install</em> option.</li><li>The web app will appear as an application, not on the home screen.</li></ol></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Samsung Browser</p><div class=\"trilium-tab-panel\"><ol><li>Open your default web browser and access your Trilium instance.</li><li>Login.</li><li>Press the hamburger menu in the bottom-right of the screen.</li><li>Select <em>Add to</em>, followed by <em>Home screen</em>.</li><li>Press <em>Add</em> and the web app will appear on the home page.</li></ol></div></section></div><h2>Sharing to Trilium</h2><p>Once installed as a PWA on Android, Trilium appears in the system's share menu, so links, text, images and other files can be sent to it from other apps. Shared content is saved to the <a class=\"reference-link\" href=\"#root/_help_S0Fos78ZfcY7\">Note Inbox</a>, and Trilium opens the note it created:</p><ul><li>Text or a link becomes a text note. A shared link is also stored in the <code>#pageUrl</code> label.</li><li>A single file becomes an image note or a file note, placed directly in the inbox.</li><li>Several files, or files shared together with text, are placed under a new text note that holds the text.</li></ul><p>Every note created this way carries the <code>#clipType=share</code> label, which gives a shared text note the <span class=\"tn-icon bx bx-share\"></span> icon unless the note has an <code>#iconClass</code> of its own. A single share can carry at most 20 files.</p><aside class=\"admonition note\"><p>Sharing requires being logged in. If the session has expired, log in again and share once more.</p></aside><h2>Testing via the desktop application</h2><p>If you are running Trilium without a dedicated <a href=\"#root/_help_WOcw2SLH6tbX\">server installation</a>, you can still test the mobile application using the desktop application. For more information, see <a class=\"reference-link\" href=\"#root/_help_nRqcgfTb97uV\">Using the desktop application as a server</a>. To access it go to <code>http://<ip>:37840/login?mobile</code> .</p><h2>Forcing mobile/desktop frontend</h2><p>Trilium decides automatically whether to use mobile or desktop front-end. If this is not appropriate, you can use <code>?mobile</code> or <code>?desktop</code> query param on <strong>login</strong> page (Note: you might need to log out).</p><p>Alternatively, simply select <em>Switch to Mobile Version</em> in the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>. In the mobile version, select <em>Advanced</em> → <em>Switch to Desktop Version</em> there instead.</p><h2>Scripting</h2><p>You can alter the behavior with <a class=\"reference-link\" href=\"#root/_help_CdNpE2pqjmI6\">Scripting</a>, just like for normal frontend. For script notes to be executed, they need to have labeled <code>#run=mobileStartup</code>.</p><p>Custom <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a> widgets are also supported.</p>",+ "_help_RDslemsQ6gCp": "<figure class=\"image image-style-align-right image_resized\" style=\"width:33.52%;\"><img style=\"aspect-ratio:1242/2688;\" src=\"{{helpAssets}}/User%20Guide/Installation%20%26%20Setup/Mobile%20Frontend_IMG_1765.PNG\" width=\"1242\" height=\"2688\"></figure><p>Trilium has a mobile web frontend which is optimized for touch based devices - smartphones and tablets. It is activated automatically during login process based on browser detection.</p><p>Mobile frontend is limited in features compared to the full desktop version. See below for more details on this.</p><h2>Layout basics</h2><p>Unlike the desktop version, the mobile version has a slightly different UI meant to better fit the constrained screens of a mobile phone.</p><p>Here is a non-exhaustive list of differences between the desktop version and the mobile one:</p><ul><li>The <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a> is displayed as a sidebar. To display the sidebar, press the button in the top-left of the screen.<ul><li>There is also a swipe gesture that can be done from the left of the screen, but the browser's navigation gesture interferes with it most of the time (depending on the platform).</li><li>Press and hold a note to display the <a class=\"reference-link\" href=\"#root/_help_YtSN43OrfzaA\">Note tree contextual menu</a>.</li></ul></li><li>The <a class=\"reference-link\" href=\"#root/_help_Ms1nauBra7gq\">Quick search</a> bar is also displayed at the top of the note tree.</li><li>The full <a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a> function can be triggered either from either the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> or from the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>, if configured.</li><li>The <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> is shorter: <em>Open new window</em> and <em>Show cheatsheet</em> are left out, and <em>Switch to desktop version</em> is under <em>Advanced</em>.</li><li>The <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a> is displayed at the bottom of the screen.<ul><li>The launch bar uses a different configuration for icons than the desktop version. See the dedicated page for more information on how to configure it.</li></ul></li><li>Most of the note-related actions are grouped in the horizontal dots icon on the top-right of the note.</li><li>The <a class=\"reference-link\" href=\"#root/_help_3seOhtN8uLIY\">Tabs</a> are grouped under a tab switcher in the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>, where the tabs are displayed in a full-screen grid with preview for easy switching, as well as additional options such as reopening closed tabs.</li><li>Since v0.100.0, <a class=\"reference-link\" href=\"#root/_help_luNhaphA37EO\">Split View</a> can also be used in mobile view, but with a maximum of two panes at once. The splits are displayed vertically instead of horizontally.</li></ul><h2>Installing as a PWA</h2><p>The mobile view can be set up as a PWA. While this does not offer any offline capabilities, it will display the application in full-screen and makes it easy to access via your mobile phone's home screen.</p><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-apple\"></span> iOS with Safari</p><div class=\"trilium-tab-panel\"><ol><li>Open your default web browser and access your Trilium instance.</li><li>Login.</li><li>Press the […] button in the bottom-right of the screen and select Share.</li><li>Scroll down to reveal the full list of items and choose <em>Add to Home Screen</em>.</li><li>Press <em>Add</em> and the web app will be available.</li></ol></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-chrome\"></span> Android with Google Chrome</p><div class=\"trilium-tab-panel\"><aside class=\"admonition important\"><p>Google Chrome requires the server to be served over HTTPS in order to display in full-screen. If using HTTP, the app will appear like a normal web page (similar to a bookmark).</p></aside><ol><li>Open your default web browser and access your Trilium instance.</li><li>Login.</li><li>Press the three vertical dots icon in the top-right of the screen and select <em>Add to Home screen.</em></li><li>Select the <em>Install</em> option.</li><li>Select an appropriate name.</li><li>The web app will appear as an application, not on the home screen.</li></ol></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Android with Brave</p><div class=\"trilium-tab-panel\"><aside class=\"admonition important\"><p>Brave requires the server to be served over HTTPS in order to display in full-screen. If using HTTP, the app will appear like a normal web page (similar to a bookmark).</p></aside><ol><li>Open your default web browser and access your Trilium instance.</li><li>Login.</li><li>Press the three vertical dots icon in the bottom-right of the screen and select <em>Add to Home screen</em>.</li><li>Press the <em>Install</em> option.</li><li>The web app will appear as an application, not on the home screen.</li></ol></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Samsung Browser</p><div class=\"trilium-tab-panel\"><ol><li>Open your default web browser and access your Trilium instance.</li><li>Login.</li><li>Press the hamburger menu in the bottom-right of the screen.</li><li>Select <em>Add to</em>, followed by <em>Home screen</em>.</li><li>Press <em>Add</em> and the web app will appear on the home page.</li></ol></div></section></div><h2>Sharing to Trilium</h2><p>Once installed as a PWA on Android, Trilium appears in the system's share menu, so links, text, images and other files can be sent to it from other apps. Shared content is saved to the <a class=\"reference-link\" href=\"#root/_help_S0Fos78ZfcY7\">Note Inbox</a>, and Trilium opens the note it created:</p><ul><li>Text or a link becomes a text note. A shared link is also stored in the <code>#pageUrl</code> label.</li><li>A single file becomes an image note or a file note, placed directly in the inbox.</li><li>Several files, or files shared together with text, are placed under a new text note that holds the text.</li></ul><p>Every note created this way carries the <code>#clipType=share</code> label, which gives a shared text note the <span class=\"tn-icon bx bx-share\"></span> icon unless the note has an <code>#iconClass</code> of its own. A single share can carry at most 20 files.</p><aside class=\"admonition note\"><p>Sharing requires being logged in. If the session has expired, log in again and share once more.</p></aside><h2>Testing via the desktop application</h2><p>If you are running Trilium without a dedicated <a href=\"#root/_help_WOcw2SLH6tbX\">server installation</a>, you can still test the mobile application using the desktop application. For more information, see <a class=\"reference-link\" href=\"#root/_help_nRqcgfTb97uV\">Using the desktop application as a server</a>. To access it go to <code>http://<ip>:37840/login?mobile</code> .</p><h2>Forcing mobile/desktop frontend</h2><p>Trilium decides automatically whether to use mobile or desktop front-end. If this is not appropriate, you can use <code>?mobile</code> or <code>?desktop</code> query param on <strong>login</strong> page (Note: you might need to log out).</p><p>Alternatively, simply select <em>Switch to mobile version</em> in the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>. In the mobile version, select <em>Advanced</em> → <em>Switch to desktop version</em> there instead.</p><h2>Scripting</h2><p>You can alter the behavior with <a class=\"reference-link\" href=\"#root/_help_CdNpE2pqjmI6\">Scripting</a>, just like for normal frontend. For script notes to be executed, they need to have labeled <code>#run=mobileStartup</code>.</p><p>Custom <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a> widgets are also supported.</p>","_help_MtPxeAWVAzMg": "<p><img src=\"{{helpAssets}}/User%20Guide/Installation%20%26%20Setup/Web%20Clipper_image.png\"></p><p>Trilium Web Clipper is a web browser extension which allows user to clip text, screenshots, whole pages and short notes and save them directly to Trilium Notes.</p><h2>Supported browsers</h2><p>Trilium Web Clipper officially supports the following web browsers:</p><ul><li>Mozilla Firefox, using Manifest v2.</li><li>Google Chrome, using Manifest v3. Theoretically the extension should work on other Chromium-based browsers as well, but they are not officially supported.</li></ul><h2>Obtaining the extension</h2><p>The extension is available from the official browser web stores:</p><ul><li><strong>Firefox</strong>: <a href=\"https://addons.mozilla.org/firefox/addon/trilium-notes-web-clipper/\">Trilium Web Clipper on Firefox Add-ons</a></li><li><strong>Chrome</strong>: <a href=\"https://chromewebstore.google.com/detail/trilium-web-clipper/ofoiklieachadcaeffficgjaajojpkpi\">Trilium Web Clipper on Chrome Web Store</a></li></ul><h2>Functionality</h2><ul><li>select text and clip it with the right-click context menu</li><li>click on an image or link and save it through context menu</li><li>save whole page from the popup or context menu</li><li>save a PDF that the browser shows, as a file note</li><li>save a screenshot of an area you select, of the visible part of the page or of the whole page, from either popup or context menu</li><li>create short text note from popup</li></ul><h2>The popup</h2><p>Clicking the extension's button in the browser toolbar opens its popup:</p><ul><li><p>The popup shows what will be saved from the current page: the note's title, which can be edited before saving, the website, and below them a preview, which starts with a box for your own note and the page's description. A switch above the preview chooses what to save, among what the page offers:</p><ul><li><em>Selection</em>, when text is selected on the page: <em>Save selection</em> saves it into the note of that page's clippings, as the context menu does.</li><li><em>Page</em>: <em>Save page to Trilium</em> saves the page's text and images. A smaller switch at the top of the preview chooses how much of the page to keep: <em>Article</em> keeps only the page's main text, without its menus, sidebars and footers, and <em>Whole page</em> keeps everything the page shows. <em>Whole page</em> is for pages that are not an article (such as a gallery or a page of cards), where <em>Article</em> can leave out part of the content; the preview shows what each one keeps. <em>Article</em> is unavailable on a page where Trilium finds no article. The author the page names shows under the description, marked by the <span class=\"tn-icon bx bx-user\"></span> icon. It can be edited or cleared before saving, or written in when the page names none, and is saved in the <code>#pageAuthor</code> label of the note. When the page states when it was published, that date shows under the author, marked by the <span class=\"tn-icon bx bx-calendar\"></span> icon, and is saved in the <code>#publishedDate</code> label of the note. When it states when it was last modified, that date shows below, marked by the <span class=\"tn-icon bx bx-history\"></span> icon, and is saved in the <code>#modifiedDate</code> label.</li><li><em>PDF</em>, when the tab shows a PDF in the browser's viewer: <em>Save PDF to Trilium</em> downloads the PDF and saves it as a file note, which Trilium opens in its <a class=\"reference-link\" href=\"#root/_help_XJGJrpu7F9sh\">PDFs</a> viewer. Only the title and the description can be edited, since a file note has no text of its own for your note. The page's address is saved in the note's <code>#pageUrl</code> label and the PDF's file name in <code>#originalFileName</code>. Saving a PDF needs Trilium v0.107.0 or later.</li><li><em>Bookmark</em>, always: there is no preview, and <em>Save bookmark</em> saves a link to the page with your note as the content of the note. Left empty, the title stays the page's title.</li></ul><p>The box for your note, marked by the <span class=\"tn-icon bx bx-info-circle\"></span> icon, has the cursor when the popup opens, so a note (such as why the page is worth keeping) can be typed right away. It grows with its text, and keeps it when switching between <em>Selection</em>, <em>Page</em> and <em>Bookmark</em>. A note on a selection or a page is saved above the clipped content, in a <em>Note</em> admonition. Left empty, nothing is added. <kbd>Ctrl</kbd>+<kbd>Enter</kbd> in any of the popup's fields saves, whichever is chosen.</p><p>The description, marked by the <span class=\"tn-icon bx bx-align-left\"></span> icon, comes from the page's <code>description</code> meta tag, or the one it gives social sites. It can be edited or cleared before saving, or written in when the page has none, and is saved in the <code>#pageDescription</code> label of the note. Clippings saved with the keyboard shortcuts or the context menu, screenshots and images included, get the description as the page gives it. Each clipping that brings a description updates the label. The description, the author and the dates are shown by clicking the <em>Web clip</em> badge next to the title of the note (see <a class=\"reference-link\" href=\"#root/_help_B5dihXRDksTk\">Note badges</a>).</p><p>The popup opens on the selection if there is one, otherwise on <em>Page</em>, showing the article, or the whole page when the page has no article. On a PDF, it opens on <em>PDF</em>. On a page that shows nothing to save, it opens on <em>Bookmark</em> and says so. The keyboard shortcuts and the context menu still save right away, without a preview: saving the whole page that way saves the article, the whole page when the page has no article, or the PDF when the tab shows one.</p></li><li><p>Pages the extension cannot access (the browser's own pages, the extension stores, and pages that were open before the extension was installed until they are reloaded) cannot be saved or captured, so the popup says so in place of the preview, and only <em>All tabs</em> remains available there.</p></li><li><p>Below the preview, a row of buttons offers the other actions: <em>Area</em> (a screenshot of an area you select), <em>Visible</em> (a screenshot of the visible part of the page), <em>Full page</em> (a screenshot of the whole page) and <em>All tabs</em> (saves the links of every tab in the current window as a list of <a class=\"reference-link\" href=\"#root/_help_UmgZAfcltxkS\">Link Previews</a>, or of plain links when <em>Autogenerate link previews</em> is turned off). Hovering over a button shows its full name and, if it has one, its keyboard shortcut.</p></li><li><p><em>Full page</em> scrolls through the page, takes a screenshot of each part and joins them into one image, then scrolls back to where the page was. The scrollbars are hidden while it does, so they do not appear in the image. Stay on the tab until it is saved: switching to another tab stops the screenshot. A header that stays at the top of the window appears once, at the top of the image, and headings that stick while scrolling appear where they are in the page. Other elements that stay in place while scrolling (such as cookie banners and chat buttons) are left out, while a background that fills the whole window repeats on every screen. In Firefox, the page is captured without scrolling through it, which is faster: such a background then appears only at the top, and images that the page loads only once they are scrolled into view can be missing. A long page is saved as several images, one below the other in the note. A page longer than 100 screens is cut off there, and the message after saving says so. Screenshots keep their full height in Trilium: <em>Resize image</em> (under <em>Automatically compress images</em> in Options → Media) limits only their width.</p></li><li><p>The popup stays open while Trilium saves, which can take a few seconds for a long page or a large PDF, and the other actions wait until it is done. The bar at the top of the popup then says, in green, that the clipping was saved (in place of the notice that the page was already clipped), with <em>Open note</em> to open it in Trilium (and, after <em>All tabs</em>, <em>Close saved tabs</em>), or, in red, why it could not be saved. The same clipping cannot be saved twice by accident: the save button stays disabled until another mode is chosen. <em>Crop</em> is the exception: the popup closes so that an area of the page can be selected, and the notification on the page reports the outcome.</p></li><li><p>If the current page was already clipped, a notice at the top offers to open the note in Trilium.</p></li><li><p>If Trilium cannot be found, the popup explains why instead of showing the actions, with buttons to look for Trilium again and to open the options.</p></li><li><p>The bottom of the popup shows whether the extension is connected to Trilium, as a colored dot (green when connected, amber when the versions are not compatible, red when Trilium was not found) next to a description of the connection, followed by the buttons for the extension's options and for this help page. A button to check the connection again appears next to them when hovering over the bar, and stays visible while Trilium cannot be reached or is not compatible.</p></li></ul><h2>Location of clippings</h2><p>Trilium will save these clippings as a new child note under a \"clipper inbox\" note.</p><p>By default, that's the <a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a> but you can override that by setting the <a href=\"#root/_help_zEY4DaJG4YT5\">label</a> <code>clipperInbox</code>, on any other note.</p><p>Further clippings of the same kind from the same page are added to the note created by the first one, even on a later day or after that note was moved out of the clipper inbox. The note stays where it is and is not cloned back into the inbox. A PDF is the exception: each save creates a new file note, since the PDF can have changed since it was last saved.</p><p>The icon of a clipped note shows what was saved:</p><ul><li><span class=\"tn-icon bx bx-paperclip\"></span> a selection, a screenshot or a link from the context menu;</li><li><span class=\"tn-icon bx bx-globe\"></span> a page (<em>Article</em> or <em>Whole page</em>);</li><li><span class=\"tn-icon bx bx-bookmark\"></span> a bookmark;</li><li><span class=\"tn-icon bx bx-window-alt\"></span> the tabs of a window.</li></ul><p>The icon is derived from the note's <code>#clipType</code> label, so setting an <code>#iconClass</code> label on the note replaces it. A saved PDF has the icon of a PDF file, like any other PDF in Trilium.</p><h2>Embedded videos</h2><p>A YouTube video embedded in a clipped page is saved as a <a class=\"reference-link\" href=\"#root/_help_UmgZAfcltxkS\">Link Previews</a> embed, with the video's title and thumbnail. As with a link preview added in the editor, the video plays only when clicked. Other embedded content (such as videos from other websites) is not saved.</p><p>The popup's preview shows each such video as a chip with the YouTube icon and the video's short link, and leaves out the embedded content that will not be saved.</p><h2>Keyboard shortcuts</h2><p>Keyboard shortcuts are available for most functions:</p><ul><li>Save selected text: <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>S</kbd> (Mac: <kbd>⌘</kbd>+<kbd>⇧</kbd>+<kbd>S</kbd>)</li><li>Save whole page: <kbd>Alt</kbd>+<kbd>Shift</kbd>+<kbd>S</kbd> (Mac: <kbd>⌥</kbd>+<kbd>⇧</kbd>+<kbd>S</kbd>)</li><li>Save a screenshot of an area: <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>E</kbd> (Mac: <kbd>⌘</kbd>+<kbd>⇧</kbd>+<kbd>E</kbd>)</li><li>Save all tabs of the current window: no default shortcut, but one can be assigned as described below.</li><li>Save a screenshot of the whole page: no default shortcut, but one can be assigned as described below.</li></ul><p>To set custom shortcuts, follow the directions for your browser.</p><ul><li><strong>Firefox</strong>: <code>about:addons</code> → Gear icon ⚙️ → Manage extension shortcuts</li><li><strong>Chrome</strong>: <code>chrome://extensions/shortcuts</code></li></ul><aside class=\"admonition note\"><p>On Firefox, the default shortcuts interfere with some browser features. As such, the keyboard combinations will not trigger the Web Clipper action. To fix this, simply change the keyboard shortcut to something that works. The defaults will be adjusted in future versions.</p></aside><h2>Configuration</h2><p>The extension needs to connect to a running Trilium instance. By default, it looks for the desktop application on port 37840 of the local computer. If the desktop application runs on a different port (for example because it was started with the <code>TRILIUM_PORT</code> environment variable), enter that port in the extension's options. The extension checks for Trilium again every minute, or right away when pressing the refresh button at the bottom of its popup.</p><p>It's also possible to configure the <a href=\"#root/_help_WOcw2SLH6tbX\">server</a> address if you don't run the desktop application, or want it to work without the desktop application running.</p><p>To connect to a server, enter its address and your password in the extension's options and press <em>Login to the server instance</em>. If the server uses <a href=\"#root/_help_7DAiwaf8Z7Rz\">multi-factor authentication</a>, also fill in <em>Authentication code</em> with the current code from your authenticator app (or one of your recovery codes); otherwise leave it empty. The password and the code are used only once, to obtain a token for the extension, and are not stored.</p><h3>When a clipping fails</h3><p>After each clipping made with a keyboard shortcut or the context menu, a notification in the corner of the page confirms that it was saved, with a link to open the new note in Trilium. A clipping made from the popup reports in the popup instead, unless the popup was closed before it was saved. If the clipping could not be saved, the message says why instead:</p><ul><li>Trilium was not found: start the desktop application, or check the server address and token in the extension's options.</li><li>The versions of Trilium and the extension are not compatible: update the one the message names.</li><li>Trilium rejected the request: the message includes the reason Trilium gave.</li><li>The popup could not reach the extension's background script, or it gave no answer: close the popup and open it again. If the extension was just updated or reloaded, reload the page as well.</li><li>A PDF could not be saved: Trilium is older than v0.107.0, the website refused to send the PDF again, or the PDF is larger than 100 MB. The extension downloads the PDF with the browser's cookies for that website, so a PDF behind a login can be saved while you are logged in.</li></ul><p>The extension downloads the images of a clipping itself, so that they are stored in Trilium together with the note. If some of them cannot be downloaded (for example because the website refuses the request), the clipping is still saved, and the notification says how many images are missing. Those images keep their address on the original website: Trilium tries to download them once more if <em>Download images automatically</em> is enabled in <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Media</em>, and otherwise the note shows them from the website for as long as it serves them.</p><p>The notification is shown on the page itself, so it does not appear on pages where extensions cannot run (such as the browser's own settings pages, the extension stores and Firefox's PDF viewer). A clipping saved from the popup on such a page still reports in the popup.</p><h2>Testing development versions</h2><p>Development versions are version pre-release versions, generally meant for testing purposes. These are not available in the Google or Firefox web stores, but can be downloaded from either:</p><ul><li><a href=\"https://github.com/TriliumNext/Trilium/releases\">GitHub Releases</a> by looking for releases starting with <em>Web Clipper.</em></li><li>Artifacts in GitHub Actions, by looking for the <a href=\"https://github.com/TriliumNext/Trilium/actions/workflows/web-clipper.yml\"><em>Deploy web clipper extension</em> workflow</a>. Once a workflow run is selected, the ZIP files are available in the <em>Artifacts</em> section, under the name <code>web-clipper-extension</code>.</li></ul><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-chrome\"></span> Chrome</p><div class=\"trilium-tab-panel\"><ol><li>Download <code>trilium-web-clipper-[x.y.z]-chrome.zip</code>.</li><li>Extract the archive.</li><li>In Chrome, navigate to <code>chrome://extensions/</code></li><li>Toggle <em>Developer Mode</em> in top-right of the page.</li><li>Press the <em>Load unpacked</em> button near the header.</li><li>Point to the extracted directory from step (2).</li></ol></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-firefox\"></span> Firefox</p><div class=\"trilium-tab-panel\"><aside class=\"admonition warning\"><p>Firefox prevents installation of unsigned packages in the “retail” version. To be able to install extensions from disk, consider using <em>Firefox Developer Edition</em> or a non-branded version of Firefox (e.g. <em>GNU IceCat</em>).</p><p>One time, go to <code>about:config</code> and change <code>xpinstall.signatures.required</code> to <code>false</code>.</p></aside><ol><li>Navigate to <code>about:addons</code>.</li><li>Select <em>Extensions</em> in the left-side navigation.</li><li>Press the <em>Gear</em> icon on the right of the <em>Manage Your Extensions</em> title.</li><li>Select <em>Install Add-on From File…</em></li><li>Point it to <code>trilium-web-clipper-[x.y.z]-firefox.zip</code>.</li><li>Press the <em>Add</em> button to confirm.</li></ol></div></section></div><h2>Credits</h2><p>Some parts of the code are based on the <a href=\"https://github.com/laurent22/joplin/tree/master/Clipper\">Joplin Notes browser extension</a>.</p>","_help_n1lujUxCwipy": "<p>This document outlines the steps required to upgrade Trilium to a new release version.</p><h2>How to Upgrade</h2><p>Trilium does not support built-in automatic upgrades; all updates must be performed manually. The upgrade process varies depending on the installation method:</p><ul><li><a href=\"#root/_help_rWX5eY045zbE\"><strong>Docker Server Installation</strong></a>: Pull the new image and restart the container.</li><li><strong>Other Installations</strong>: Download the latest version from the <a href=\"https://github.com/TriliumNext/Trilium/releases/latest\">release page</a> and replace the existing application files.</li></ul><h2>Database Compatibility and Migration</h2><p>Upon startup, Trilium will automatically migrate the <a href=\"#root/_help_wX4HbRucYSDD\">database</a> to the new version. Note that after migration, older versions of Trilium will be unable to read the database. If you need to revert to a previous version of Trilium and its database, you can restore the <a href=\"#root/_help_ODY7qQn5m2FT\">backup</a> that is created prior to migration.</p><h2>Sync Compatibility</h2><p>The <a href=\"#root/_help_cbkrhQjrkKrh\">synchronization</a> protocol used by Trilium is versioned, requiring all members of the sync cluster to use the same protocol version. Therefore, when upgrading to a new version, you may need to upgrade all instances in the sync cluster. Changes to the sync protocol version are typically indicated on the release page.</p>","_help_ODY7qQn5m2FT": "<p>Trilium supports simple backup scheme where it saves copy of the <a class=\"reference-link\" href=\"#root/_help_wX4HbRucYSDD\">Database</a> on these events:</p><ul><li>once a day</li><li>once a week</li><li>once a month</li><li>before DB migration to newer version</li></ul><p>So in total you'll have at most 4 backups from different points in time which should protect you from various problems. These backups are stored by default in <code>backup</code> directory placed in the <a href=\"#root/_help_tAassRL4RSQL\">data directory</a>.</p><p>This is only very basic backup solution, and you're encouraged to add some better backup solution - e.g. backing up the <a class=\"reference-link\" href=\"#root/_help_wX4HbRucYSDD\">Database</a> to cloud / different computer etc.</p><p>Note that <a class=\"reference-link\" href=\"#root/_help_cbkrhQjrkKrh\">Synchronization</a> provides also some backup capabilities by its nature of distributing the data to other computers.</p><h2>Creating a backup</h2><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bx-desktop\"></span> On the desktop app & web client</p><div class=\"trilium-tab-panel\"><ol><li>Go to <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Backup</em> and press the <em>Backup now</em> button.</li><li>The backup creation process may take a few moments, especially for larger databases. A notification will inform you when the backup is complete.</li><li>The backup will be saved as <code>backup-now</code> in the <em>Existing backups</em> list, where you can download it.</li></ol></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bx-globe\"></span> On the standalone client</p><div class=\"trilium-tab-panel\"><ol><li>Go to <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Backup</em> and press the <em>Download backup</em> button.</li><li>You will be prompted to restart the app. Confirm, and the app will restart automatically.</li><li>Set a <em>backup name</em> or <em>password</em> (both optional), then press <em>Continue</em>.</li><li>Press the <em>Generate and download</em> button and wait for the download to complete.</li><li>Once you confirm the download is saved on your device, press <em>Finish</em> to complete</li></ol></div></section></div><h2>Downloading a backup</h2><ul><li><strong>Desktop and web client</strong>: to download an existing backup, navigate to <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Backup</em> → <em>Existing backups</em> and select <em>Download</em> (<span class=\"tn-icon bx bx-download\"></span>).</li><li><strong>Standalone client</strong>: automatic backups are not supported in this version. You can manually create and download a backup by going to <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Backup</em> → <em>Download backup</em>.</li></ul><h2>Restoring a backup</h2><ul><li><strong>For a new Trilium instance</strong>: When setting up a new Trilium instance, use the <em>Restore from backup</em> option in the setup menu to guide you through restoring your existing backup.</li><li><strong>For an existing Trilium instance</strong>: To restore a backup and replace your current database, go to <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Backup</em> and click <em>Restore a backup</em>. You will be prompted to restart the app for the restoration process to begin. After restarting, you can choose to back up the existing database before overwriting it. Note: For the web client, use the Start Over feature ( <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Database</em> → <em>Start over</em> (<span class=\"tn-icon bx bx-reset\"></span>)) to switch to the setup screen and restore a backup.</li></ul><p>Next, select the backup file (.db or .tnbackup) from your device. The web client is optimized for handling large backups and is resilient to unstable network conditions, similar to the desktop application.</p><p>If your database is encrypted, you will be prompted to enter the password used for encrypting the backup file. Without the correct password, decryption and restoration cannot proceed.</p><p>Restoring a backup may take some time, depending on its size. Once it completes, Trilium will open the freshly restored database.</p><h3>The alternative way for restoring a backup</h3><p>Let's assume you want to restore the weekly backup (only in .db format, .tnbackup files are not supported by this method), here's how to do it:</p><ul><li>find <a href=\"#root/_help_tAassRL4RSQL\">data directory</a> Trilium uses - easy way is to open \"About Trilium Notes\" (<span class=\"tn-icon bx bx-info-circle\"></span>) from \"Menu\" in upper left corner and looking at \"data directory\"<ul><li>I'll refer to <code>~/trilium-data</code> as data directory from now on</li></ul></li><li>find <code>~/trilium-data/backup/backup-weekly.db</code> - this is the <a class=\"reference-link\" href=\"#root/_help_wX4HbRucYSDD\">Database</a> backup.</li><li>at this point stop/kill Trilium</li><li>delete <code>~/trilium-data/document.db</code>, <code>~/trilium-data/document.db-wal</code> and <code>~/trilium-data/document.db-shm</code> (latter two files are auto generated)</li><li>copy and rename this <code>~/trilium-data/backup/backup-weekly.db</code> to <code>~/trilium-data/document.db</code></li><li>make sure that the file is writable, e.g. with <code>chmod 600 document.db</code></li><li>start Trilium again</li></ul><aside class=\"admonition warning\"><p>If you have configured sync then you need to do it across all members of the sync cluster, otherwise older version (restored backup) of the document will be detected and synced to the newer version.</p></aside><h2>Changing the backup location in Trilium (desktop only)</h2><p>Starting with version 0.105, the Trilium desktop client allows users to change the directory where backups are stored. Follow these steps to specify a custom backup directory:</p><ol><li>Navigate to <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Backup</em> → <em>Backup location</em>.</li><li>Click the <em>Select location</em> button.</li><li>Choose any writable directory on your file system. This could include network shares, depending on your operating system.</li></ol><p>Once you set a custom directory, all manual and automatic backups will be saved there. If the selected directory becomes unavailable, backups may fail or revert to the default location.</p><aside class=\"admonition tip\"><p>For better privacy when using unsafe backup locations, you can enable backup encryption, which makes the backup file unreadable without the correct password.</p></aside><h2>Backup encryption</h2><p>Trilium can secure the entire content of the database backup, ensuring it remains unreadable unless the correct password is provided. This is particularly useful for storing backups in unsecured locations, like network shares, unencrypted external drives, or cloud services. </p><p>Encrypted database backups use the Trilium Backup Container (.tnbackup) format, which relies on AES-256-GCM. This authenticated encryption mode scrambles the data and generates a tag confirming it hasn't been altered. The password itself isn't directly used as the key; it's processed through scrypt, a key derivation function designed to be slow and memory-intensive, making brute-force password guessing difficult even with powerful hardware. Each backup also receives a random 16-byte salt, ensuring that the same password never produces the same encryption key twice. Additionally, critical metadata such as chunk order, length, and header flags are cryptographically bound into the encryption (via \"additional authenticated data\"), preventing undetected tampering like reorder, truncate, or splice operations.</p><h3>Enabling backup encryption</h3><p>To enable encryption for automatic backups in the Desktop application:</p><ol><li>Go to <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Backup</em> → <em>Backup options</em>.</li><li>Click on <em>Turn on encryption</em> and set a password.</li></ol><p>Once encryption is enabled, all newly created backups (both automatic and manual) will be encrypted with the specified password. Backups created prior to enabling encryption will remain unsecured.</p><p>You can change the password anytime using the <em>Change password</em> button. The new password will apply to backups created after the change.</p><p>To disable encryption, uncheck <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Backup</em> → <em>Enable encryption</em>.</p><aside class=\"admonition note\"><p>On some systems, a keyring may not be available for Trilium to securely store the encryption password. In such cases, the encryption option is disabled.</p></aside><h2>Backup compression</h2><p>Database backups can be optionally compressed to minimize storage footprint. This method is effective primarily when the database consists largely of text content. However, media files (images, videos, audio), along with PDF, ODF, and DOCX files, are already compressed in their original formats and won't benefit from further compression.</p><p>Compressed backups are stored using the Trilium Backup Container (.tnbackup), employing RFC 1952 GZIP compression.</p><aside class=\"admonition warning\"><p><strong>Note:</strong> Compression increases the time required for backup creation and restoration. It may also lead to higher CPU usage during automatic backups, potentially draining the battery faster on battery-powered devices. Enable this option only if necessary.</p></aside><h3>Enabling Backup Compression (Desktop Only)</h3><p>To enable compression for new automatic and manual backups, navigate to <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Backup</em> → <em>Backup options</em> and toggle <em>Enable compression</em> to on.</p><h2>Disabling backup</h2><p>Although this is not recommended, it is possible to disable backup in <code>config.ini</code> in the <a href=\"#root/_help_tAassRL4RSQL\">data directory</a>:</p><pre><code class=\"language-text-x-trilium-auto\">[General]\n... some other configs\n# set to true to disable backups (e.g. because of limited space on server)\nnoBackup=true</code></pre><p>You can also review the <a href=\"#root/_help_Gzjqa934BdH4\">configuration</a> file to provide all <code>config.ini</code> values as environment variables instead.</p><p>See <a href=\"https://github.com/TriliumNext/Trilium/blob/master/config-sample.ini\">sample config</a>.</p>",@@ -43,8 +43,8 @@"_help_DvdZhoQZY9Yd": "<p>The <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a> comes with multiple keyboard shortcuts to make editing faster:</p><h2>Navigation within the tree</h2><ul><li><kbd><span>↑</span></kbd> and <kbd><span>↑</span></kbd> to navigate between notes.</li><li><kbd><span>←</span></kbd> to collapse a note with children, or <kbd><span>→</span></kbd> to expand it.</li><li><kbd><span>←</span></kbd> on a note with no children to navigate to its parent.</li></ul><h2>Opening notes</h2><ul><li><kbd>Click</kbd> to open the note in the current tab.</li><li><kbd>Ctrl</kbd>+<kbd>Click</kbd> or <kbd>Middle click</kbd> to open the note in a new tab.</li><li><kbd>Ctrl</kbd>+<kbd>Right click</kbd> to open the note in <a class=\"reference-link\" href=\"#root/_help_ZjLYv08Rp3qC\">Quick edit</a>.</li></ul><h2>Clipboard management</h2><ul><li><kbd>Ctrl</kbd>+<kbd>C</kbd> to copy one or more notes based on selection (see <a class=\"reference-link\" href=\"#root/_help_IakOLONlIfGI\">Cloning Notes</a>).</li><li><kbd>Ctrl</kbd>+<kbd>X</kbd> to cut one or more notes (for moving them).</li><li><kbd>Ctrl</kbd>+<kbd>V</kbd> to paste them somewhere (which results in a copy or move based on the shortcut used).</li></ul><h2>Moving notes</h2><ul><li><kbd>Ctrl</kbd> + <kbd><span>↑</span></kbd> , <kbd>Ctrl</kbd> + <kbd><span>↓</span></kbd> - move note up/down in the note list.</li><li><kbd>Ctrl</kbd> + <kbd><span>←</span></kbd> - move note up in the note tree.</li><li><kbd>Ctrl</kbd>+<kbd><span>→</span></kbd> - move note down in the note tree.</li><li><kbd>Del</kbd> - deletes note and optionally its subtree (asked in the dialog).</li><li><kbd>Alt</kbd>+<kbd>S</kbd> - sorts the child notes of the note (see <a class=\"reference-link\" href=\"#root/_help_aGlEvb9hyDhS\">Sorting Notes</a>).</li></ul><h2>Multiple selection</h2><p>See <a class=\"reference-link\" href=\"#root/_help_yTjUdsOi4CIE\">Multiple selection</a> for more information about how selection works.</p><ul><li><kbd>Alt</kbd>+<kbd>Click</kbd> – add a single note to the current selection.</li><li><kbd>Shift</kbd>+<kbd>Click</kbd> – select a range of notes, starting from the current note (the highlighted one) to the one that is being clicked.</li><li><kbd>Shift</kbd>+<kbd><span>↑</span></kbd>, <kbd>Shift</kbd>+<kbd><span>↓</span></kbd> – multi-select not above/below.</li><li><kbd>Ctrl</kbd>+<kbd>A</kbd> – select all notes in the current level</li></ul>","_help_wyaGBBQrl4i3": "<figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:328/45;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree/1_Hiding%20the%20subtree_image.png\" width=\"328\" height=\"45\"><figcaption>An example of a collection with a relatively large number of children that are hidden from the tree.</figcaption></figure><p>The tree works well when the notes are structured in a hierarchy so that the number of items stays small. When a note has a large number of notes (in the order of thousands or tens of thousands), two problems arise:</p><ul><li>Navigating between notes becomes cumbersome and the tree itself gets cluttered with a large amount of notes.</li><li>The large amount of notes can slow down the application considerably.</li></ul><p>Since v0.102.0, Trilium allows the tree to hide the child notes of particular notes. This works for both <a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a> and normal notes.</p><h2>Interaction</h2><p>When the subtree of a note is hidden, there are a few subtle changes:</p><ul><li>To indicate that the subtree is hidden, the note will not have an expand button and it will display the number of children to the right.</li><li>It's not possible to add a new note directly from the tree.<ul><li>For <a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>, it's best to use the built-in mechanism to create notes (for example by creating a new point on a geo-map, or by adding a new row in a table).</li><li>For normal notes, it's still possible to create children via other means such as using the <a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a> system.</li></ul></li><li>Notes can be dragged from outside the note, case in which they will be cloned into it.<ul><li>Instead of switching to the child notes that were copied, the parent note is highlighted instead.</li><li>A notification will indicate this behavior.</li></ul></li><li>Similarly, features such as cut/copy and then paste into the note will also work.</li></ul><h2>Spotlighting</h2><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:322/83;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree/Hiding%20the%20subtree_image.png\" width=\"322\" height=\"83\"></figure><p>Even if the subtree of a note is hidden, if a child note manages to become active, it will still appear inside the tree in a special state called <em>spotlighted</em>.</p><p>During this state, the note remains under its normal hierarchy, so that its easy to tell its location. In addition, this means that:</p><ul><li>The note position is clearly visible when using the <a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>.</li><li>The note can still be operated on from the tree, such as adding a <a class=\"reference-link\" href=\"#root/_help_TBwsyfadTA18\">Branch prefix</a> or moving it outside the collection.</li></ul><p>The note appears in italics to indicate its temporary display. When switching to another note, the spotlighted note will disappear.</p><aside class=\"admonition note\"><p>Only one note can be highlighted at the time. When working with multiple notes such as dragging them into the collection, no note will be spotlighted. This is intentional to avoid displaying a partial state of the subtree.</p></aside><h2>Working with collections</h2><p>For large collections, it can be helpful to hide their child notes for performance reasons or de-cluttering the tree.</p><p>To toggle this behavior:</p><ul><li>Open the collection and in <a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>, look for <em>Hide child notes in tree</em>.</li><li>Right click the collection note in the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a> and select <em>Advanced</em> → <em>Show subtree</em>.</li></ul><h2>Working with normal notes</h2><p>It's possible to hide the subtree for normal notes as well, not just collections. To do so, right click the note in the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a> and select <em>Advanced</em> → <em>Hide subtree.</em></p>","_help_3seOhtN8uLIY": "<figure class=\"image image-style-align-center\"><img style=\"aspect-ratio:1119/43;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Tabs_image.png\" width=\"1119\" height=\"43\"></figure><p>In Trilium, tabs allow easy switching between notes.</p><h2>Layout</h2><p>Depending on the <a class=\"reference-link\" href=\"#root/_help_x0JgW8UqGXvq\">Vertical and horizontal layout</a>:</p><ul><li>For the vertical layout, the tabs will be placed at the top but to the right of the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</li><li>For the horizontal layout, the tabs will be placed at the top in full-width, above the <a href=\"#root/_help_oPVyFC7WL2Lp\">note tree</a>, allowing for more tabs to be comfortably displayed.</li></ul><h2>Interaction</h2><ul><li>To create a new tab, press the <span class=\"tn-icon bx bx-plus\"></span> button that is to the right of the last tab.</li><li>To close a tab, press the corresponding <span class=\"tn-icon bx bx-x\"></span> button.</li><li>For multitasking, tabs can be used alongside <a class=\"reference-link\" href=\"#root/_help_luNhaphA37EO\">Split View</a>. Each tab can have one or more notes, displayed horizontally.</li><li>Tabs can be reordered by drag-and-dropping it into a new position.</li><li>An existing tab can be displayed in a new window by dragging the tab upwards or downwards. It is not possible to combine tabs back into another window.</li></ul><h2>Keyboard interaction</h2><p>Since tabs are a commonly used feature, there are multiple keyboard shortcuts that can be used:</p><ul><li><kbd>Ctrl</kbd>+<kbd>T</kbd> to open a new tab.</li><li><kbd>Ctrl</kbd>+<kbd>W</kbd> to close the current tab.</li><li><kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>T</kbd> to reopen the last closed tab.</li><li><kbd>Ctrl</kbd>+<kbd>Tab</kbd> and <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Tab</kbd> to go to the next or previous tab.</li><li><kbd>Ctrl</kbd>+<kbd>1</kbd>, <kbd>Ctrl</kbd>+<kbd>2</kbd>, up to <kbd>Ctrl</kbd>+<kbd>9</kbd> to activate the first, second and up to ninth tab.</li><li>There is also a shortcut to go to the last tab, but it is not assigned a key by default.</li></ul><h2>Mobile</h2><figure class=\"image image-style-align-right image_resized\" style=\"width:34.12%;\"><img style=\"aspect-ratio:1242/2688;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Tabs_IMG_1767.PNG\" width=\"1242\" height=\"2688\"></figure><p>Tabs are also supported on the <a class=\"reference-link\" href=\"#root/_help_RDslemsQ6gCp\">Mobile Frontend</a>.</p><p>Since v0.102.0, the tabs are displayed by pressing the dedicated tab switcher button in the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>. In this view the tabs are laid out on a grid with a preview of the note content.</p><p>The context menu button at the top-right of the popup allows creating a new tab, reopening the last closed tab and closing all the tabs.</p><p><a class=\"reference-link\" href=\"#root/_help_luNhaphA37EO\">Split View</a>s are also indicated in the tab switcher, with two titles displayed in a tab.</p><aside class=\"admonition note\"><p>Versions prior to v0.102.0 also supported tabs, but they were displayed directly above the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>. The decision to use a more mobile-like tab switcher was taken because the original tab bar could not support many tabs at once and the new design better aligns with how mobile applications handle tabs.</p></aside>",- "_help_xYmIYSP6wE3F": "<h2>Position of the Launch bar</h2><p>On desktop, depending on the layout selected, the launcher bar will either be on the left side of the screen with buttons displayed vertically or at the top of the screen. See <a class=\"reference-link\" href=\"#root/_help_x0JgW8UqGXvq\">Vertical and horizontal layout</a> for more information.</p><p>On mobile, the launch bar will always be at the bottom.</p><p>If there are too many items in the launch bar to fit the screen, it will become scrollable.</p><h2>Terminology</h2><ul><li><strong>Launcher</strong>: a button that can be (or is) displayed on the launch bar.</li><li><strong>Available Launcher</strong>: a launcher that is not displayed on the launch bar, but can be added.</li><li><strong>Visible Launcher</strong>: a launcher that is currently displayed on the launch bar.</li></ul><h2>Configuring the desktop Launch bar</h2><p>There are two ways to configure the launch bar:</p><ul><li>Right click in the empty space between launchers on the launch bar and select <em>Configure Launchbar…</em></li><li>Click on the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> and select <em>Configure Launchbar</em>.</li></ul><p>This will open a new tab with the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a> listing the launchers.</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Launch%20Bar_image.jpg\"></p><p>Expanding <em>Available Launchers</em> section will show the list of launchers that are not displayed on the launch bar. The <em>Visible Launchers</em> will show the ones that are currently displayed.</p><h2>Configuring the mobile launch bar</h2><p>The launch bar on mobile uses a different configuration from the desktop one. The reasoning is that not all desktop icons are available on mobile, and fewer icons fit on a mobile screen.</p><p>To configure the launch bar on mobile, go to <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> and select <em>Configure Launchbar</em>.</p><p>The configure the mobile launch bar while on the desktop (especially useful to configure more complicated launchers such as scripts or custom widgets), go to <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> → Advanced → Show Hidden Subtree and look for the <em>Mobile Launch Bar</em> section. While in the hidden subtree, it's also possible to drag launchers between the <em>Mobile Launch Bar</em> and (Desktop) <em>Launch Bar</em> sections.</p><h3>Adding/removing and reordering launchers</h3><p>To display a new launcher in the launch bar, first look for it in the <em>Available Launchers</em> section. Then right click it and select <em>Move to visible launchers</em>. It is also possible to drag and drop the item manually.</p><p>Similarly, to remove it from the launch bar, simply look for it in <em>Visible Launchers</em> then right click it and select <em>Move to available launchers</em> or use drag-and-drop.</p><p>Drag-and-drop the items in the tree in order to change their order. See <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a> for more interaction options, including using keyboard shortcuts.</p><h2>Customizing the launcher</h2><ul><li>The icon of a launcher can be changed just like a normal note. See <a href=\"#root/_help_p9kXRFAkwN4o\">note icons</a> for more information.</li><li>The title of the launcher can also be changed.</li></ul><h3>Resetting</h3><p>Resetting allows restoring the original configuration of Trilium for the launcher bar, or for a portion of it. Simply right click a launcher (or even the entire <em>Launch Bar</em> section) and select <em>Reset</em> to bring it back to the original state.</p><h3>Creating new launchers / types of launchers</h3><p>Right click either the <em>Available launchers</em> or <em>Visible launchers</em> sections and select one of the options:</p><ol><li><p><strong>Note Launcher</strong><br>A note launcher will simply navigate to a specified note.</p><ol><li>Set the <code>target</code> promoted attribute to the note to navigate to.</li><li>Optionally, set <code>hoistedNote</code> to hoist a particular note. See <a class=\"reference-link\" href=\"#root/_help_OR8WJ7Iz9K4U\">Note Hoisting</a> for more information.</li><li>Optionally, set a <code>keyboardShortcut</code> to trigger the launcher.</li></ol></li><li><p><strong>Script Launcher</strong><br>An advanced launcher which will run a script upon pressing. See <a class=\"reference-link\" href=\"#root/_help_CdNpE2pqjmI6\">Scripting</a> for more information.</p><ol><li>Set <code>script</code> to point to the desired script to run.</li><li>Optionally, set a <code>keyboardShortcut</code> to trigger the launcher.</li></ol></li><li><p><strong>Custom Widget</strong></p><p>Allows defining a custom widget to be rendered inside the launcher. See <a class=\"reference-link\" href=\"#root/_help_SynTBQiBsdYJ\">Widget Basics</a> for more information.</p></li><li><p><strong>Spacers</strong><br>Launchers that create some distance between other launchers for better visual distinction.</p></li></ol><p>Launchers are configured via predefined <a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>.</p>",- "_help_8YBEPzcpUgxw": "<figure class=\"image image-style-align-right image_resized\" style=\"width:25.95%;\"><img style=\"aspect-ratio:402/988;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Note%20menu_image.png\" width=\"402\" height=\"988\"></figure><p>The note menu contains various actions and configurations for the current note. It can be found in the <a class=\"reference-link\" href=\"#root/_help_1P8QXI5edXNd\">Note buttons</a> area (to the right of the <a class=\"reference-link\" href=\"#root/_help_l7pigIGu01K2\">Title</a>).</p><p>Every split has a note menu of its own, which acts on the note displayed in that split. Entries that don't apply to the current note are still listed but grayed out, while entries that only exist for some notes (described in <em>Note-specific entries</em>) appear only on those notes.</p><h2>Navigating the note</h2><p>These entries are the row of icons at the top of the menu, each with a short title. Hovering one shows its full name and its keyboard shortcut. In Quick edit, where only the attachments are left, it is listed as an ordinary entry instead.</p><ul><li><span class=\"tn-icon bx bx-file-find\"></span> <em>Find</em> opens the <a class=\"reference-link\" href=\"#root/_help_McngOG2jbUWX\">Search in note</a> bar, to find and replace text inside the current note. On the desktop application, the same bar opens with <kbd>Ctrl</kbd>+<kbd>F</kbd>.<ul><li>It is available on <a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>, <a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>, <a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a> and <a class=\"reference-link\" href=\"#root/_help_GWHEkY4I4OE3\">Spreadsheets</a> notes, <a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>, PDF files, and any note displayed as <a class=\"reference-link\" href=\"#root/_help_4FahAwuGTAwC\">Note source</a>.</li></ul></li><li><span class=\"tn-icon bx bx-paperclip\"></span> <em>Attachments</em> switches the note to the list of its <a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>, where they can be uploaded, opened, downloaded, renamed or deleted.</li><li><span class=\"tn-icon bx bxs-network-chart\"></span> <em>Note map</em> opens the <a class=\"reference-link\" href=\"#root/_help_KRlZFoIH0j6p\">Connections tab</a> of the <a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>, which shows the <a class=\"reference-link\" href=\"#root/_help_BCkXAVs63Ttv\">Note Map (Link map, Tree map)</a> centered on the current note.</li></ul><h2>Note properties</h2><p>The toggles in this section take effect immediately:</p><ul><li><span class=\"tn-icon bx bx-share-alt\"></span> <em>Shared</em> publishes the note via <a class=\"reference-link\" href=\"#root/_help_R9pX4DGra2Vt\">Sharing</a>, by cloning it into the <em>Shared Notes</em> tree.<ul><li>Turning it off removes the clone from that tree. If the note exists only as a shared note, Trilium asks for confirmation, since unsharing it deletes it.</li><li>The toggle is unavailable on the root note, on the <em>Shared Notes</em> note itself, and on system notes.</li></ul></li><li><span class=\"tn-icon bx bx-lock-alt\"></span> <em>Protect the note</em> encrypts the note, turning it into one of the <a class=\"reference-link\" href=\"#root/_help_bwg0e8ewQMak\">Protected Notes</a>. If no protected session is active, Trilium asks for the password first. Only the current note is affected, not its children.</li><li><span class=\"tn-icon bx bx-bookmark\"></span> <em>Bookmark</em> adds the note to the <a class=\"reference-link\" href=\"#root/_help_u3YFHC9tQlpm\">Bookmarks</a> that are displayed in the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>, or removes it from them.</li><li><span class=\"tn-icon bx bx-copy-alt\"></span> <em>Template</em> marks the note as one of the <a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a> (by adding the <code>#template</code> label), which makes it available when creating a new note.</li><li><span class=\"tn-icon bx bx-expand-horizontal\"></span> <em>Full width</em> lets the note use the whole width of the window instead of the limit set in <a class=\"reference-link\" href=\"#root/_help_t596jLvPrqkS\">Content width</a> by adding the <code>#fullContentWidth</code> label. It is not listed for note types that are always displayed at full width.</li></ul><p>The two submenus in this section:</p><ul><li><span class=\"tn-icon bx bx-file\"></span> <em>Note type</em> changes the type of the note to any of the <a class=\"reference-link\" href=\"#root/_help_KSZ04uQ2D1St\">Note Types</a>; the current one is checked. If the note already has content, Trilium asks for confirmation first, since the content generally doesn't carry over. <a class=\"reference-link\" href=\"#root/_help_jludwdW7N4hg\">Converting between note types</a>.<ul><li>For a <a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a> note, the language is chosen in the <a class=\"reference-link\" href=\"#root/_help_AlJ73vBCjWDw\">Status bar</a> instead.</li></ul></li><li><span class=\"tn-icon bx bx-edit-alt\"></span> <em>Editable</em> controls when the note opens as read-only (see <a class=\"reference-link\" href=\"#root/_help_CoFPLs3dRlXc\">Read-Only Notes</a>):<ul><li><em>Auto</em> (the default): the note is editable, unless it is long enough to be opened as read-only automatically.</li><li><em>Read-only</em>: the note always opens as read-only, but can still be edited after pressing <em>Edit note</em>.</li><li><em>Always Editable</em>: the note is always editable, regardless of its length.</li></ul></li></ul><h2>Importing, exporting and printing</h2><ul><li><span class=\"tn-icon bx bx-import\"></span> <em>Import files</em> opens the import dialog, which imports files as children of the current note. See <a class=\"reference-link\" href=\"#root/_help_mHbBMPDPkVV5\">Import & Export</a>. It is unavailable on <a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a> notes.</li><li><span class=\"tn-icon bx bx-export\"></span> <em>Export note</em> opens the export dialog with <em>Only this note</em> selected; select <em>This note & all descendants</em> there to export the whole subtree.</li><li><span class=\"tn-icon bx bx-printer\"></span><em>Print note…</em> prints the note. On the desktop application this entry reads <em>Print/export to PDF…</em> and can also save the note as a PDF file. See <a class=\"reference-link\" href=\"#root/_help_NRnIZmSMc5sj\">Printing & Exporting as PDF</a>, including which note types and collections can be printed.</li></ul><p>Some note types add their own export formats right below <em>Export note</em>:</p><ul><li><span class=\"tn-icon bx bxs-file-image\"></span><em>Export as image</em>, on <a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a> and <a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a> notes, downloads the diagram as <em>PNG (raster)</em> or <em>SVG (vector)</em>.</li><li><span class=\"tn-icon bx bxs-spreadsheet\"></span><em>Export to Excel (.xlsx)</em> and <em>Export to CSV (.csv)</em>, on <a class=\"reference-link\" href=\"#root/_help_GWHEkY4I4OE3\">Spreadsheets</a>, download the spreadsheet in those formats.</li></ul><h2>Revisions</h2><p>These entries manage the <a class=\"reference-link\" href=\"#root/_help_vZWERwf8U3nx\">Note Revisions</a> of the note:</p><ul><li><span class=\"tn-icon bx bx-history\"></span><em>Note revisions…</em> opens the revisions dialog, where previous versions can be previewed, compared with the current one, downloaded or restored. The arrow beside it opens the entries that save a revision right away. On mobile, tapping it opens those entries, with <em>Note revisions…</em> as the first one.<ul><li><span class=\"tn-icon bx bx-save\"></span><em>Save revision</em> saves a revision of the note right away, instead of waiting for the next automatic snapshot.</li><li><span class=\"tn-icon bx bx-purchase-tag\"></span><em>Save named revision…</em> also saves a revision right away, but first asks for a short description of the changes, which is shown in the revisions dialog.</li></ul></li></ul><h2>Note-specific entries</h2><p>The following entries only appear on some notes:</p><ul><li><span class=\"tn-icon bx bx-pencil\"></span><em>Edit note</em> appears at the top of the menu when the note is currently read-only. It enables editing until the note is closed.</li><li><span class=\"tn-icon bx bx-align-justify\"></span><em>Word wrap</em> appears at the top of the menu on <a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a> notes, and sets whether long lines wrap in this note:<ul><li><em>Auto</em> (the default) follows <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Code Notes</em> → <em>Wrap lines in code notes</em>.</li><li><em>On</em> and <em>Off</em> override it for this note only, by setting the <code>#wrapLines</code> label.</li></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 which is a <a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">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=\"#root/_help_0vhv7lsOLy82\">Attachments</a>.</li><li><span class=\"tn-icon bx bx-extension\"></span><em>Re-render note</em> appears on a <a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>, and runs its script again to refresh the output.</li><li><span class=\"tn-icon bx bx-cog\"></span><em>Board properties</em> appears on a <a class=\"reference-link\" href=\"#root/_help_CtBQqbwXDx1w\">Kanban Board</a>, and configures its columns, card attributes and card templates.</li><li><span class=\"tn-icon bx bx-cog\"></span><em>Calendar properties</em> appears on a <a class=\"reference-link\" href=\"#root/_help_xWbu3jpNWapp\">Calendar</a> that creates events, and configures its event templates.</li><li><span class=\"tn-icon bx bx-cog\"></span><em>Geo map properties</em> appears on a <a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map</a>, and configures its map settings and the image of an <a href=\"#root/_help_ZRDXGc0nAIh4\">image map</a>.</li><li><span class=\"tn-icon bx bx-cog\"></span><em>Table properties</em> appears on a <a class=\"reference-link\" href=\"#root/_help_2FvYrpmOXm29\">Table</a>, and configures which notes it shows.</li></ul><h2>Advanced</h2><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 <a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a> and <a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a> 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 <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 <a class=\"reference-link\" href=\"#root/_help_jludwdW7N4hg\">Converting between note types</a>.</p></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 images found and how much space they take, and offers to:</p><ul><li>Resize the images larger than a chosen size.</li><li>Keep, or compress, JPEG images.</li><li>Keep, optimize, or convert to JPEG the PNG images.</li><li><em>Process child notes as well</em>, to include the images of the notes beneath this one.</li></ul><p>Compressing cannot be undone. Images can also be compressed automatically on upload, see <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 <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 <a class=\"reference-link\" href=\"#root/_help_cbkrhQjrkKrh\">Synchronization</a> is configured) opens the same note on the sync server, in the web browser.</p></li></ul><h2>Deleting the note</h2><p><span class=\"tn-icon bx bx-trash\"></span><em>Delete note</em> opens the deletion dialog for the current note and its subtree. The dialog lists the notes that will be deleted and the relations that will be broken, and offers to:</p><ul><li>Also delete the other clones of the note, if it is cloned elsewhere. Otherwise, only the current placement is removed and the note stays in its other locations. See <a class=\"reference-link\" href=\"#root/_help_IakOLONlIfGI\">Cloning Notes</a>.</li><li><em>Erase permanently</em> instead of the usual soft deletion. This cannot be undone.</li></ul><p>Notes deleted without erasing can be brought back, see <a class=\"reference-link\" href=\"#root/_help_5Ct4MAJTS4tQ\">Restoring Deleted Notes</a>.</p><h2>Limitations</h2><ul><li>The note menu is not available on launchers.</li><li>On the notes of <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> and of the in-app help, most entries are grayed out, since these notes cannot be imported into, deleted or have revisions. Of the two, only the in-app help can be exported, see <a class=\"reference-link\" href=\"#root/_help_mHbBMPDPkVV5\">Import & Export</a>.</li><li>The <a href=\"#note-properties\">Note properties</a> section is only listed when the note itself is displayed, not its <a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a> or its <a class=\"reference-link\" href=\"#root/_help_4FahAwuGTAwC\">Note source</a>.</li><li>In <a class=\"reference-link\" href=\"#root/_help_ZjLYv08Rp3qC\">Quick edit</a>, <em>Find</em>, <em>Note map</em>, <em>Full width</em> and <em>Convert into attachment</em> are not listed.</li></ul><h2>Mobile support</h2><p>On the <a class=\"reference-link\" href=\"#root/_help_RDslemsQ6gCp\">Mobile Frontend</a>, the note menu opens as a sheet from the bottom of the screen. Besides the entries above, it contains the items that the desktop layout places elsewhere:</p><ul><li>Two more icons in the row of icons at the very top of the sheet, which reads <span class=\"tn-icon bx bx-dock-right\"></span> <em>New split</em>, <em>Note map</em>, <em>Find</em> and <span class=\"tn-icon bx bx-plus\"></span> <em>Child note</em> from left to right: <em>New split</em> opens a <a class=\"reference-link\" href=\"#root/_help_luNhaphA37EO\">Split View</a> while there is none in the tab, and <em>Child note</em> creates a note under the current one.</li><li><em>Backlinks</em> and <em>Note paths</em>, below the row of icons, which open the <a class=\"reference-link\" href=\"#root/_help_wfGXLmm7x27z\">Backlinks</a> and the other locations of the note.</li><li><span class=\"tn-icon bx bx-paperclip\"></span> <em>Attachments</em> and <span class=\"tn-icon bx bx-list-check\"></span> <em>Attributes</em>, under them, which open the attachments and the attributes of the note, each with the number the note has. Links made by the content of the note are not counted as attributes. <em>Attributes</em> is unavailable where the note cannot be edited. On mobile, <em>Attachments</em> is listed here instead of in the row of icons.</li><li>The custom buttons of the note type (such as <span class=\"tn-icon bx bx-download\"></span><em>Download</em> on a <a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a>).</li><li><em>Close this pane</em>, on the second note of a <a class=\"reference-link\" href=\"#root/_help_luNhaphA37EO\">Split View</a>.</li><li><span class=\"tn-icon bx bx-slider-alt\"></span> <em>Note settings</em>, below <em>Protect the note</em>, which opens <em>Shared</em> and <em>Bookmark</em>, then <em>Note type</em>, <em>Template</em> and <em>Full width</em>, on a page of their own, together with the language of the note: the content language on <a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a> notes (see <a class=\"reference-link\" href=\"#root/_help_veGu4faJErEM\">Content language & Right-to-left support</a>), and the language of the code on <a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a> notes. The choices of <em>Editable</em> are listed at the end of that page, under their own heading, instead of in a further submenu.</li><li><span class=\"tn-icon bx bx-info-circle\"></span> <em>Note info</em>, below <em>Note settings</em>, which opens the dates, type, ID and size of the note on a page of its own, ending with <em>Show similar notes</em> (see <a class=\"reference-link\" href=\"#root/_help_xWtq5NUHOwql\">Similar Notes</a>).</li><li><em>Note map</em> opens the map in a popup instead of the right sidebar.</li></ul>",+ "_help_xYmIYSP6wE3F": "<h2>Position of the Launch bar</h2><p>On desktop, depending on the layout selected, the launcher bar will either be on the left side of the screen with buttons displayed vertically or at the top of the screen. See <a class=\"reference-link\" href=\"#root/_help_x0JgW8UqGXvq\">Vertical and horizontal layout</a> for more information.</p><p>On mobile, the launch bar will always be at the bottom.</p><p>If there are too many items in the launch bar to fit the screen, it will become scrollable.</p><h2>Terminology</h2><ul><li><strong>Launcher</strong>: a button that can be (or is) displayed on the launch bar.</li><li><strong>Available Launcher</strong>: a launcher that is not displayed on the launch bar, but can be added.</li><li><strong>Visible Launcher</strong>: a launcher that is currently displayed on the launch bar.</li></ul><h2>Configuring the desktop Launch bar</h2><p>There are two ways to configure the launch bar:</p><ul><li>Right click in the empty space between launchers on the launch bar and select <em>Configure launch bar…</em></li><li>Click on the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> and select <em>Configure launch bar</em>.</li></ul><p>This will open a new tab with the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a> listing the launchers.</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Launch%20Bar_image.jpg\"></p><p>Expanding <em>Available Launchers</em> section will show the list of launchers that are not displayed on the launch bar. The <em>Visible Launchers</em> will show the ones that are currently displayed.</p><h2>Configuring the mobile launch bar</h2><p>The launch bar on mobile uses a different configuration from the desktop one. The reasoning is that not all desktop icons are available on mobile, and fewer icons fit on a mobile screen.</p><p>To configure the launch bar on mobile, go to <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> and select <em>Configure launch bar</em>.</p><p>The configure the mobile launch bar while on the desktop (especially useful to configure more complicated launchers such as scripts or custom widgets), go to <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> → Advanced → Show hidden subtree and look for the <em>Mobile Launch Bar</em> section. While in the hidden subtree, it's also possible to drag launchers between the <em>Mobile Launch Bar</em> and (Desktop) <em>Launch Bar</em> sections.</p><h3>Adding/removing and reordering launchers</h3><p>To display a new launcher in the launch bar, first look for it in the <em>Available Launchers</em> section. Then right click it and select <em>Move to visible launchers</em>. It is also possible to drag and drop the item manually.</p><p>Similarly, to remove it from the launch bar, simply look for it in <em>Visible Launchers</em> then right click it and select <em>Move to available launchers</em> or use drag-and-drop.</p><p>Drag-and-drop the items in the tree in order to change their order. See <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a> for more interaction options, including using keyboard shortcuts.</p><h2>Customizing the launcher</h2><ul><li>The icon of a launcher can be changed just like a normal note. See <a href=\"#root/_help_p9kXRFAkwN4o\">note icons</a> for more information.</li><li>The title of the launcher can also be changed.</li></ul><h3>Resetting</h3><p>Resetting allows restoring the original configuration of Trilium for the launcher bar, or for a portion of it. Simply right click a launcher (or even the entire <em>Launch Bar</em> section) and select <em>Reset</em> to bring it back to the original state.</p><h3>Creating new launchers / types of launchers</h3><p>Right click either the <em>Available launchers</em> or <em>Visible launchers</em> sections and select one of the options:</p><ol><li><p><strong>Note Launcher</strong><br>A note launcher will simply navigate to a specified note.</p><ol><li>Set the <code>target</code> promoted attribute to the note to navigate to.</li><li>Optionally, set <code>hoistedNote</code> to hoist a particular note. See <a class=\"reference-link\" href=\"#root/_help_OR8WJ7Iz9K4U\">Note Hoisting</a> for more information.</li><li>Optionally, set a <code>keyboardShortcut</code> to trigger the launcher.</li></ol></li><li><p><strong>Script Launcher</strong><br>An advanced launcher which will run a script upon pressing. See <a class=\"reference-link\" href=\"#root/_help_CdNpE2pqjmI6\">Scripting</a> for more information.</p><ol><li>Set <code>script</code> to point to the desired script to run.</li><li>Optionally, set a <code>keyboardShortcut</code> to trigger the launcher.</li></ol></li><li><p><strong>Custom Widget</strong></p><p>Allows defining a custom widget to be rendered inside the launcher. See <a class=\"reference-link\" href=\"#root/_help_SynTBQiBsdYJ\">Widget Basics</a> for more information.</p></li><li><p><strong>Spacers</strong><br>Launchers that create some distance between other launchers for better visual distinction.</p></li></ol><p>Launchers are configured via predefined <a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>.</p>",+ "_help_8YBEPzcpUgxw": "<figure class=\"image image-style-align-right image_resized\" style=\"width:25.95%;\"><img style=\"aspect-ratio:402/988;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Note%20menu_image.png\" width=\"402\" height=\"988\"></figure><p>The note menu contains various actions and configurations for the current note. It can be found in the <a class=\"reference-link\" href=\"#root/_help_1P8QXI5edXNd\">Note buttons</a> area (to the right of the <a class=\"reference-link\" href=\"#root/_help_l7pigIGu01K2\">Title</a>).</p><p>Every split has a note menu of its own, which acts on the note displayed in that split. Entries that don't apply to the current note are still listed but grayed out, while entries that only exist for some notes (described in <em>Note-specific entries</em>) appear only on those notes.</p><h2>Navigating the note</h2><p>These entries are the row of icons at the top of the menu, each with a short title. Hovering one shows its full name and its keyboard shortcut. In Quick edit, where only the attachments are left, it is listed as an ordinary entry instead.</p><ul><li><span class=\"tn-icon bx bx-file-find\"></span> <em>Find</em> opens the <a class=\"reference-link\" href=\"#root/_help_McngOG2jbUWX\">Search in note</a> bar, to find and replace text inside the current note. On the desktop application, the same bar opens with <kbd>Ctrl</kbd>+<kbd>F</kbd>.<ul><li>It is available on <a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>, <a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>, <a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a> and <a class=\"reference-link\" href=\"#root/_help_GWHEkY4I4OE3\">Spreadsheets</a> notes, <a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>, PDF files, and any note displayed as <a class=\"reference-link\" href=\"#root/_help_4FahAwuGTAwC\">Note source</a>.</li></ul></li><li><span class=\"tn-icon bx bx-paperclip\"></span> <em>Attachments</em> switches the note to the list of its <a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>, where they can be uploaded, opened, downloaded, renamed or deleted.</li><li><span class=\"tn-icon bx bxs-network-chart\"></span> <em>Note map</em> opens the <a class=\"reference-link\" href=\"#root/_help_KRlZFoIH0j6p\">Connections tab</a> of the <a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>, which shows the <a class=\"reference-link\" href=\"#root/_help_BCkXAVs63Ttv\">Note Map (Link map, Tree map)</a> centered on the current note.</li></ul><h2>Note properties</h2><p>The toggles in this section take effect immediately:</p><ul><li><span class=\"tn-icon bx bx-share-alt\"></span> <em>Shared</em> publishes the note via <a class=\"reference-link\" href=\"#root/_help_R9pX4DGra2Vt\">Sharing</a>, by cloning it into the <em>Shared Notes</em> tree.<ul><li>Turning it off removes the clone from that tree. If the note exists only as a shared note, Trilium asks for confirmation, since unsharing it deletes it.</li><li>The toggle is unavailable on the root note, on the <em>Shared Notes</em> note itself, and on system notes.</li></ul></li><li><span class=\"tn-icon bx bx-lock-alt\"></span> <em>Protect the note</em> encrypts the note, turning it into one of the <a class=\"reference-link\" href=\"#root/_help_bwg0e8ewQMak\">Protected Notes</a>. If no protected session is active, Trilium asks for the password first. Only the current note is affected, not its children.</li><li><span class=\"tn-icon bx bx-bookmark\"></span> <em>Bookmark</em> adds the note to the <a class=\"reference-link\" href=\"#root/_help_u3YFHC9tQlpm\">Bookmarks</a> that are displayed in the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>, or removes it from them.</li><li><span class=\"tn-icon bx bx-copy-alt\"></span> <em>Template</em> marks the note as one of the <a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a> (by adding the <code>#template</code> label), which makes it available when creating a new note.</li><li><span class=\"tn-icon bx bx-expand-horizontal\"></span> <em>Full width</em> lets the note use the whole width of the window instead of the limit set in <a class=\"reference-link\" href=\"#root/_help_t596jLvPrqkS\">Content width</a> by adding the <code>#fullContentWidth</code> label. It is not listed for note types that are always displayed at full width.</li></ul><p>The two submenus in this section:</p><ul><li><span class=\"tn-icon bx bx-file\"></span> <em>Note type</em> changes the type of the note to any of the <a class=\"reference-link\" href=\"#root/_help_KSZ04uQ2D1St\">Note Types</a>; the current one is checked. If the note already has content, Trilium asks for confirmation first, since the content generally doesn't carry over. <a class=\"reference-link\" href=\"#root/_help_jludwdW7N4hg\">Converting between note types</a>.<ul><li>For a <a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a> note, the language is chosen in the <a class=\"reference-link\" href=\"#root/_help_AlJ73vBCjWDw\">Status bar</a> instead.</li></ul></li><li><span class=\"tn-icon bx bx-edit-alt\"></span> <em>Editable</em> controls when the note opens as read-only (see <a class=\"reference-link\" href=\"#root/_help_CoFPLs3dRlXc\">Read-Only Notes</a>):<ul><li><em>Auto</em> (the default): the note is editable, unless it is long enough to be opened as read-only automatically.</li><li><em>Read-only</em>: the note always opens as read-only, but can still be edited after pressing <em>Edit note</em>.</li><li><em>Always editable</em>: the note is always editable, regardless of its length.</li></ul></li></ul><h2>Importing, exporting and printing</h2><ul><li><span class=\"tn-icon bx bx-import\"></span> <em>Import files</em> opens the import dialog, which imports files as children of the current note. See <a class=\"reference-link\" href=\"#root/_help_mHbBMPDPkVV5\">Import & Export</a>. It is unavailable on <a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a> notes.</li><li><span class=\"tn-icon bx bx-export\"></span> <em>Export note</em> opens the export dialog with <em>Only this note</em> selected; select <em>This note & all descendants</em> there to export the whole subtree.</li><li><span class=\"tn-icon bx bx-printer\"></span><em>Print/export to PDF…</em> prints the note or saves it as a PDF file. See <a class=\"reference-link\" href=\"#root/_help_NRnIZmSMc5sj\">Printing & Exporting as PDF</a>, including which note types and collections can be printed.</li></ul><p>Some note types add their own export formats right below <em>Export note</em>:</p><ul><li><span class=\"tn-icon bx bxs-file-image\"></span><em>Export as image</em>, on <a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a> and <a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a> notes, downloads the diagram as <em>PNG (raster)</em> or <em>SVG (vector)</em>.</li><li><span class=\"tn-icon bx bxs-spreadsheet\"></span><em>Export to Excel (.xlsx)</em> and <em>Export to CSV (.csv)</em>, on <a class=\"reference-link\" href=\"#root/_help_GWHEkY4I4OE3\">Spreadsheets</a>, download the spreadsheet in those formats.</li></ul><h2>Revisions</h2><p>These entries manage the <a class=\"reference-link\" href=\"#root/_help_vZWERwf8U3nx\">Note Revisions</a> of the note:</p><ul><li><span class=\"tn-icon bx bx-history\"></span><em>Note revisions…</em> opens the revisions dialog, where previous versions can be previewed, compared with the current one, downloaded or restored. The arrow beside it opens the entries that save a revision right away. On mobile, tapping it opens those entries, with <em>Note revisions…</em> as the first one.<ul><li><span class=\"tn-icon bx bx-save\"></span><em>Save revision</em> saves a revision of the note right away, instead of waiting for the next automatic snapshot.</li><li><span class=\"tn-icon bx bx-purchase-tag\"></span><em>Save named revision…</em> also saves a revision right away, but first asks for a short description of the changes, which is shown in the revisions dialog.</li></ul></li></ul><h2>Note-specific entries</h2><p>The following entries only appear on some notes:</p><ul><li><span class=\"tn-icon bx bx-pencil\"></span><em>Edit note</em> appears at the top of the menu when the note is currently read-only. It enables editing until the note is closed.</li><li><span class=\"tn-icon bx bx-align-justify\"></span><em>Word wrap</em> appears at the top of the menu on <a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a> notes, and sets whether long lines wrap in this note:<ul><li><em>Auto</em> (the default) follows <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Code Notes</em> → <em>Wrap lines in code notes</em>.</li><li><em>On</em> and <em>Off</em> override it for this note only, by setting the <code>#wrapLines</code> label.</li></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 which is a <a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">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=\"#root/_help_0vhv7lsOLy82\">Attachments</a>.</li><li><span class=\"tn-icon bx bx-extension\"></span><em>Re-render note</em> appears on a <a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>, and runs its script again to refresh the output.</li><li><span class=\"tn-icon bx bx-cog\"></span><em>Board properties</em> appears on a <a class=\"reference-link\" href=\"#root/_help_CtBQqbwXDx1w\">Kanban Board</a>, and configures its columns, card attributes and card templates.</li><li><span class=\"tn-icon bx bx-cog\"></span><em>Calendar properties</em> appears on a <a class=\"reference-link\" href=\"#root/_help_xWbu3jpNWapp\">Calendar</a> that creates events, and configures its event templates.</li><li><span class=\"tn-icon bx bx-cog\"></span><em>Geo map properties</em> appears on a <a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map</a>, and configures its map settings and the image of an <a href=\"#root/_help_ZRDXGc0nAIh4\">image map</a>.</li><li><span class=\"tn-icon bx bx-cog\"></span><em>Table properties</em> appears on a <a class=\"reference-link\" href=\"#root/_help_2FvYrpmOXm29\">Table</a>, and configures which notes it shows.</li></ul><h2>Advanced</h2><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 <a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a> and <a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a> 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 <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 <a class=\"reference-link\" href=\"#root/_help_jludwdW7N4hg\">Converting between note types</a>.</p></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 images found and how much space they take, and offers to:</p><ul><li>Resize the images larger than a chosen size.</li><li>Keep, or compress, JPEG images.</li><li>Keep, optimize, or convert to JPEG the PNG images.</li><li><em>Process child notes as well</em>, to include the images of the notes beneath this one.</li></ul><p>Compressing cannot be undone. Images can also be compressed automatically on upload, see <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 <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 <a class=\"reference-link\" href=\"#root/_help_cbkrhQjrkKrh\">Synchronization</a> is configured) opens the same note on the sync server, in the web browser.</p></li></ul><h2>Deleting the note</h2><p><span class=\"tn-icon bx bx-trash\"></span><em>Delete note</em> opens the deletion dialog for the current note and its subtree. The dialog lists the notes that will be deleted and the relations that will be broken, and offers to:</p><ul><li>Also delete the other clones of the note, if it is cloned elsewhere. Otherwise, only the current placement is removed and the note stays in its other locations. See <a class=\"reference-link\" href=\"#root/_help_IakOLONlIfGI\">Cloning Notes</a>.</li><li><em>Erase permanently</em> instead of the usual soft deletion. This cannot be undone.</li></ul><p>Notes deleted without erasing can be brought back, see <a class=\"reference-link\" href=\"#root/_help_5Ct4MAJTS4tQ\">Restoring Deleted Notes</a>.</p><h2>Limitations</h2><ul><li>The note menu is not available on launchers.</li><li>On the notes of <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> and of the in-app help, most entries are grayed out, since these notes cannot be imported into, deleted or have revisions. Of the two, only the in-app help can be exported, see <a class=\"reference-link\" href=\"#root/_help_mHbBMPDPkVV5\">Import & Export</a>.</li><li>The <a href=\"#note-properties\">Note properties</a> section is only listed when the note itself is displayed, not its <a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a> or its <a class=\"reference-link\" href=\"#root/_help_4FahAwuGTAwC\">Note source</a>.</li><li>In <a class=\"reference-link\" href=\"#root/_help_ZjLYv08Rp3qC\">Quick edit</a>, <em>Find</em>, <em>Note map</em>, <em>Full width</em> and <em>Convert into attachment</em> are not listed.</li></ul><h2>Mobile support</h2><p>On the <a class=\"reference-link\" href=\"#root/_help_RDslemsQ6gCp\">Mobile Frontend</a>, the note menu opens as a sheet from the bottom of the screen. Besides the entries above, it contains the items that the desktop layout places elsewhere:</p><ul><li>Two more icons in the row of icons at the very top of the sheet, which reads <span class=\"tn-icon bx bx-dock-right\"></span> <em>New split</em>, <em>Note map</em>, <em>Find</em> and <span class=\"tn-icon bx bx-plus\"></span> <em>Child note</em> from left to right: <em>New split</em> opens a <a class=\"reference-link\" href=\"#root/_help_luNhaphA37EO\">Split View</a> while there is none in the tab, and <em>Child note</em> creates a note under the current one.</li><li><em>Backlinks</em> and <em>Note paths</em>, below the row of icons, which open the <a class=\"reference-link\" href=\"#root/_help_wfGXLmm7x27z\">Backlinks</a> and the other locations of the note.</li><li><span class=\"tn-icon bx bx-paperclip\"></span> <em>Attachments</em> and <span class=\"tn-icon bx bx-list-check\"></span> <em>Attributes</em>, under them, which open the attachments and the attributes of the note, each with the number the note has. Links made by the content of the note are not counted as attributes. <em>Attributes</em> is unavailable where the note cannot be edited. On mobile, <em>Attachments</em> is listed here instead of in the row of icons.</li><li>The custom buttons of the note type (such as <span class=\"tn-icon bx bx-download\"></span><em>Download</em> on a <a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a>).</li><li><em>Close this pane</em>, on the second note of a <a class=\"reference-link\" href=\"#root/_help_luNhaphA37EO\">Split View</a>.</li><li><span class=\"tn-icon bx bx-slider-alt\"></span> <em>Note settings</em>, below <em>Protect the note</em>, which opens <em>Shared</em> and <em>Bookmark</em>, then <em>Note type</em>, <em>Template</em> and <em>Full width</em>, on a page of their own, together with the language of the note: the content language on <a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a> notes (see <a class=\"reference-link\" href=\"#root/_help_veGu4faJErEM\">Content language & Right-to-left support</a>), and the language of the code on <a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a> notes. The choices of <em>Editable</em> are listed at the end of that page, under their own heading, instead of in a further submenu.</li><li><span class=\"tn-icon bx bx-info-circle\"></span> <em>Note info</em>, below <em>Note settings</em>, which opens the dates, type, ID and size of the note on a page of its own, ending with <em>Show similar notes</em> (see <a class=\"reference-link\" href=\"#root/_help_xWtq5NUHOwql\">Similar Notes</a>).</li><li><em>Note map</em> opens the map in a popup instead of the right sidebar.</li></ul>","_help_1P8QXI5edXNd": "<p>The note buttons is an area at the top-right of a note with a few buttons:</p><ul><li>The <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> which offers commands for the note or its subtree, such as import, export, viewing the <a href=\"#root/_help_4FahAwuGTAwC\">Note source code</a> or <a href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>.</li><li><a class=\"reference-link\" href=\"#root/_help_luNhaphA37EO\">Split View</a> controls<ul><li><span class=\"tn-icon bx bx-dock-right\"></span> to open a new split</li><li><span class=\"tn-icon bx bx-chevron-right\"></span>/<span class=\"tn-icon bx bx-chevron-left\"></span> to move the pane around</li><li><span class=\"tn-icon bx bx-x\"></span> to close the pane.</li></ul></li><li>On some note types such as <a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a> and images, there are dedicated buttons (e.g. <span class=\"tn-icon bx bx-download\"></span> to download the file locally).</li></ul>","_help_4TIF1oA4VQRO": "<figure class=\"image image-style-align-center\"><img style=\"aspect-ratio:1189/709;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Options_image.png\" width=\"1189\" height=\"709\"></figure><p>The Options section allows the configuration of the TriliumNext client and server.</p><h2>Entering options</h2><p>The Options can be accessed via:</p><ul><li>The <a href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>, by selecting the <em>Options</em> item.</li><li>The <span class=\"tn-icon bx bx-cog\"></span> button in the <a href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a> which can optionally be hidden if not desirable.</li><li>Optionally, a keyboard shortcut can be defined, but it is not assigned by default.</li><li>By clicking on this link: <a class=\"reference-link\" href=\"#root/_hidden/_options\">Options</a>.</li></ul><p>Once in the options section, simply select one of the option categories using the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</p><h2>Exiting options</h2><p>When entering the options, they are opened in a new <a href=\"#root/_help_3seOhtN8uLIY\">tab</a>. To close them, simply close the tab.</p><h2>Options when using sync</h2><p>When using <a class=\"reference-link\" href=\"#root/_help_cbkrhQjrkKrh\">Synchronization</a>, some of the options will be kept in sync across all the devices while others can be changed independently.</p><p>Generally, the options that relate to appearance are intentionally kept not synced in order to allow per-client customization (layout orientation, theme, vertical/horizontal layout, code block themes).</p>","_help_luNhaphA37EO": "<p>In Trilium, is possible to work with two or more notes side-by-side.</p><figure class=\"image image-style-align-center\"><img style=\"aspect-ratio:1398/1015;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Split%20View_2_Split%20View_image.png\" width=\"1398\" height=\"1015\"></figure><h2>Interactions</h2><ul><li>Press the <span class=\"tn-icon bx bx-dock-right\"></span> button to the right of a note's title to open a new split to the right of it.<ul><li>It is possible to have as many splits as desired, simply press again the button.</li><li>Only horizontal splits are possible, vertical or drag & dropping is not supported.</li></ul></li><li>When at least one split is open, press the <span class=\"tn-icon bx bx-x\"></span> button next to it to close it.</li><li>Use the <span class=\"tn-icon bx bx-chevron-right\"></span> or the <span class=\"tn-icon bx bx-chevron-left\"></span> button to move around the splits.</li><li>Creating, closing and moving a split can also be triggered from a <a href=\"#root/_help_A9Oc6YKKc65v\">keyboard shortcut</a> (<em>Create New Split</em>, <em>Close Active Split</em>, <em>Move Split Left</em> and <em>Move Split Right</em>, all unassigned by default) or through the <a href=\"#root/_help_F1r9QtzQLZqm\">command palette</a>.</li><li>The focus can be moved from one split to the one next to it with the <em>Focus Split to the Left</em> and <em>Focus Split to the Right</em> actions, which stop at either end of the tab instead of continuing into the next tab. They are unassigned by default as well.</li><li>Each <a href=\"#root/_help_3seOhtN8uLIY\">tab</a> has its own split view configuration (e.g. one tab can have two notes in a split view, whereas the others are one-note views).<ul><li>The tab's title will indicate all the note titles, in the order of the splits from the left to right and separated by a bullet symbol.</li><li>The tab's icon will indicate the icon of the last active split, which will be automatically focused when clicking on the tab.</li></ul></li></ul><h2>Splits and the note tree & hoisting</h2><p>Clicking on the content of a split will focus that split. While focused, the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a> will also indicate the note that is being edited.</p><p>It is possible for each of the splits to have their own <a class=\"reference-link\" href=\"#root/_help_OR8WJ7Iz9K4U\">Note Hoisting</a>.</p><p>When a new split is created, it will share the same note hoisting as the previous one. An easy solution to this is to simply hoist the notes after the split is created.</p><p>This is generally quite useful for reorganizing notes from one place to the other, by hoisting the old place in the first split and hoisting the new place to the second one. This will allow easy cut and paste without the tree jumping around from switching between notes.</p><h2>Mobile support</h2><p>Since v0.100.0, it's possible to have a split view on the mobile view as well, with the following differences from the desktop version of the split:</p><ul><li>On smartphones, the split views are laid out vertically (one on the top and one on the bottom), instead of horizontally as on the desktop.</li><li>There can be only one split open per tab.</li><li>It's not possible to resize the two split panes.</li><li>When the keyboard is opened, the active note will be “maximized”, thus allowing for more space even when a split is open. When the keyboard is closed, the splits become equal in size again.</li></ul><p>Interaction:</p><ul><li>To create a new split, click the three dots button on the right of the note title and tap <span class=\"tn-icon bx bx-dock-right\"></span> <em>New split</em> in the row of icons at the top.<ul><li>This option will only be available if there is no split already open in the current tab.</li></ul></li><li>To close a split, click the three dots button on the right of the note title and select <em>Close this pane</em>.<ul><li>Note that this option will only be available on the second note in the split (the one at the bottom on smartphones, the one on the right on tablets).</li></ul></li><li>When long-pressing a link, a contextual menu will show up with an option to <em>Open note in a new split</em>.<ul><li>If there's already a split, the option will replace the existing split instead.</li></ul></li></ul>",@@ -71,11 +71,11 @@"_help_MKmLg5x6xkor": "<p>Archived notes are notes which have <code>archived</code> <a href=\"#root/_help_zEY4DaJG4YT5\">attribute</a> - either directly or <a href=\"#root/_help_bwZpz2ajCEwO\">inherited</a>.</p><p>Such notes are then by default not shown in the autocomplete and in the full text <a href=\"#root/_help_eIg8jdvaoNNd\">search</a>.</p><p>This can be useful for notes which are no longer very useful but still valuable enough to keep around without them getting too much in the way.</p><p>You can control whether archived notes are displayed in the note tree with a setting:</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/Archived%20Notes_hide-archived.png\"></p>","_help_vZWERwf8U3nx": "<figure class=\"image\"><img style=\"aspect-ratio:2089/1515;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/Note%20Revisions_image.png\" width=\"2089\" height=\"1515\"></figure><p>Trilium supports seamless versioning of notes by storing snapshots (\"revisions\") of notes at regular intervals.</p><p>To display the revisions, press the <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> and select <em>Note revisions…</em> (<span class=\"tn-icon bx bx-history\"></span>).</p><h2>Interaction</h2><aside class=\"admonition note\"><p>This documentation matches the redesign of the note revisions dialog on v0.103.0, older versions have a similar dialog but with some differences.</p></aside><ul><li>The full list of revisions are displayed on the left in reverse chronological order.<ul><li>The revisions are grouped by the date the revision was taken.</li><li>This list does not contain the <em>current state</em> of the note, so it is possible to have notes with no revisions/snapshots saved.</li></ul></li><li>The icon of a revision indicates the <em>source</em> of that revision (e.g. a <span class=\"tn-icon bx bx-save\"></span> icon for a manually saved revision).</li><li>Pressing the <span class=\"tn-icon bx bx-dots-horizontal-rounded\"></span> button on the top-right of the dialog displays multiple options, including:<ul><li><span class=\"tn-icon bx bx-save\"></span> Saving a new revision now.</li><li>Checking the interval and limit for this note (see below).</li><li><span class=\"tn-icon bx bx-trash\"></span> Deleting all the revisions of this note.</li></ul></li><li>For supported notes (text, code), changes are highlighted. This behavior can be toggled via the <em>Highlight changes</em> at the top of the dialog.<ul><li>The highlighted changes are relative to the <strong>current state of the note</strong>, not to the revision prior to this one.</li></ul></li><li>For any given revision, the buttons on the top-right allow operating on it:<ul><li><span class=\"tn-icon bx bx-trash\"></span> Deleting the revision.</li><li><span class=\"tn-icon bx bx-download\"></span> Downloading the revision locally.</li><li><span class=\"tn-icon bx bx-history\"></span> Restoring the revision, which replaces the current content of the note with the one from the revision. Another revision is saved containing the current content of the note.</li></ul></li></ul><h2>Named revisions</h2><p>Named revisions are a new feature of Trilium v0.103.0 which allows adding a short description of what the changes in the snapshot contain.</p><p>In the list of note revisions:</p><ul><li>The name of the revision is displayed underneath the time of the revision in the sidebar, as well as at the top of the dialog where it is displayed in full.</li><li>Clicking on the <span class=\"tn-icon bx bx-edit-alt\"></span> edit button near the name of the revision allows it to be changed.</li></ul><p>To create a named revision, either:</p><ul><li>Go to the <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>, select <em>Note revisions…</em> → <em>Save named revision…</em> (<span class=\"tn-icon bx bx-purchase-tag\"></span>), enter the name of revision and confirm.</li><li>Use the corresponding <a href=\"#root/_help_A9Oc6YKKc65v\">keyboard shortcut</a> or the <a class=\"reference-link\" href=\"#root/_help_F1r9QtzQLZqm\">Jump to & command palette</a> command with the same name.</li><li>Save a revision normally, and adjust the name afterwards from the note revision list.</li></ul><h2>When revisions are saved</h2><p>Revisions are saved:</p><ul><li>Automatically at a fixed interval. This behavior can be configured (see below).</li><li>Manually, by:<ul><li>Going to the <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> and selecting <em>Note revisions…</em> → <em>Save revision</em> (<span class=\"tn-icon bx bx-save\"></span>).</li><li>Using the <em>Force Save Revision</em> <a href=\"#root/_help_A9Oc6YKKc65v\">keyboard shortcut</a>.</li><li>In the <em>Note Revisions</em> dialog, pressing the <span class=\"tn-icon bx bx-dots-horizontal-rounded\"></span> button in the top-right and selecting <em>Save a revision now</em>.</li></ul></li></ul><p>Additionally, revisions can also come from somewhere else, and this is indicated via the icon of the revision:</p><ul><li><span class=\"tn-icon bx bx-code-alt\"></span> Generated externally, by <a class=\"reference-link\" href=\"#root/_help_pgxEVkzLl1OP\">ETAPI (REST API)</a>.</li><li><span class=\"tn-icon bx bx-bot\"></span> A modification created by <a class=\"reference-link\" href=\"#root/_help_GBBMSlVSOIGP\">AI</a>.</li><li><span class=\"tn-icon bx bx-history\"></span> A revision is restored, causing the existing note content to be saved as a revision to prevent potential data loss.</li></ul><h4>Snapshot interval</h4><p>Time interval of taking note snapshot is configurable in the Options → Other dialog. This provides a trade-off between more revisions and more data to store.</p><p>To turn off note versioning for a particular note (or sub-tree), add <code>disableVersioning</code> <a href=\"#root/_help_zEY4DaJG4YT5\">label</a> to the note.</p><h4>Maximum revisions</h4><p>The limit on the number of note snapshots can be configured in the Options → Other dialog. The note revision snapshot number limit refers to the maximum number of revisions that can be saved for each note. Where -1 means no limit, 0 means delete all revisions. You can set the maximum revisions for a single note through the <code>versioningLimit=X</code> label.</p><p>The note limit will not take effect immediately; it will only apply when the note is modified.</p><p>You can click the <em>Erase now</em> button under <em>Erase excess revision snapshots</em> to apply the changes immediately.</p>","_help_aGlEvb9hyDhS": "<p>Trilium can sort the child notes of a note once, using the <em>Sort by…</em> dialog, or keep them sorted permanently, using the <code>#sorted</code> label. Both sort by the same criteria: the title, the creation or modification date, or the value of a label on the child notes, and both can combine several of these into sorting levels.</p><h2>Sorting once with the dialog</h2><p>To sort the children of a note once, right-click it in the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a> and select <em>Sort by…</em>, or select it and press <kbd>Alt</kbd>+<kbd>S</kbd>. The order is applied to the existing child notes only; notes added later are placed wherever they are created.</p><p>The dialog consists of:</p><ul><li><em>Sorting criteria</em>, a list of levels. Each level sorts by <em>Title</em>, <em>Date created</em>, <em>Date modified</em> or <em>Label</em> (followed by the name of the label), <em>Ascending</em> or <em>Descending</em>.<ul><li>To sort by more than one criterion, select <em>Add level</em>. The first level decides the order; the next level only decides between notes the previous ones left equal (see <em>Sort levels</em> below).</li><li>To change the order of the levels, use the <span class=\"tn-icon bx bx-up-arrow-alt\"></span> and <span class=\"tn-icon bx bx-down-arrow-alt\"></span> buttons. To remove a level, use the <span class=\"tn-icon bx bx-x\"></span> button.</li></ul></li><li><em>Sort folders at the top</em>, which places notes that have children of their own before the others. When the first level is descending, they are placed at the bottom instead.</li><li><em>Natural sort</em>, which compares numbers and characters by the rules of a language (see <em>How values are compared</em> below). <em>Natural sort language</em> sets the language code, for example <code>zh-CN</code> for Chinese.</li></ul><p>Notes with <code>#top</code> or <code>#bottom</code> stay at the top or bottom, as with automatic sorting (see <em>Pinning notes to the top or bottom</em> below).</p><h2>Keeping child notes sorted</h2><p>To keep the children of a note sorted, add the <code>#sorted</code> <a href=\"#root/_help_HI6GBBIduIgv\">label</a> to it. Trilium sorts its child notes again whenever a child is added or changes, and whenever the sorting labels change.</p><figure class=\"table\"><table><thead><tr><th>Label</th><th>Description</th></tr></thead><tbody><tr><td><code>#sorted</code></td><td>Keeps the child notes sorted. Without a value, they are sorted by title; with a value, by the levels it lists (see <em>Sort levels</em> below). <code>#sorted=off</code> turns sorting off.</td></tr><tr><td><code>#sortDirection</code></td><td><code>asc</code> (the default) or <code>desc</code>. The direction of every level that doesn't specify its own.</td></tr><tr><td><code>#sortFoldersFirst</code></td><td>Places notes that have children of their own before the others, or after them when <code>#sortDirection</code> is <code>desc</code>.</td></tr><tr><td><code>#sortNatural</code></td><td>Compares numbers by their value instead of character by character, so 2 comes before 10.</td></tr><tr><td><code>#sortLocale</code></td><td>The language code for <code>#sortNatural</code>, for example <code>zh-CN</code> or <code>de</code>.</td></tr><tr><td><code>#top</code></td><td>On a child note: keeps it at the top of its sorted parent.</td></tr><tr><td><code>#bottom</code></td><td>On a child note: keeps it at the bottom of its sorted parent.</td></tr></tbody></table></figure><p>The labels apply to the note that carries them and, when made <a href=\"#root/_help_bwZpz2ajCEwO\">inheritable</a>, to every note below it, so a single <code>#sorted(inheritable)</code> sorts a whole subtree. A note created from a <a href=\"#root/_help_KC1HB96bqqHX\">template</a> that has <code>#sorted</code> keeps its children sorted too. To exclude part of such a subtree, add <code>#sorted=off</code> to the note whose children must keep their manual order; to exclude everything below it as well, make that label inheritable too.</p><h2>Sort levels</h2><p>The value of <code>#sorted</code> is a comma-separated list of levels, written like the <code>orderBy</code> of a <a href=\"#root/_help_eIg8jdvaoNNd\">search</a>. Each level is one of:</p><ul><li>A label on the child notes, written with <code>#</code>, such as <code>#priority</code>.</li><li>One of the properties <code>title</code>, <code>dateCreated</code> and <code>dateModified</code>, written without <code>#</code>.</li><li><code>folders</code>, which only the notes with children of their own have (see <em>Grouping</em> below).</li></ul><p>A level can be followed by <code>asc</code> or <code>desc</code> to set its direction; otherwise it follows <code>#sortDirection</code>.</p><p>The child notes are sorted by the first level. Notes that are equal at that level are sorted by the second level, and so on. Notes equal at every level are sorted by title, in the direction of <code>#sortDirection</code>.</p><p>A child note that doesn't have a level's label is placed after every child that has it, whichever direction the level runs in. Between two notes that both lack it, the next level decides.</p><p>For example, <code>#sorted=\"#priority desc, #dueDate\"</code> on a parent with these children:</p><figure class=\"table\"><table><thead><tr><th>Child note</th><th>Labels</th></tr></thead><tbody><tr><td>Book report</td><td><code>#priority=2</code> <code>#dueDate=2026-11-01</code></td></tr><tr><td>Groceries</td><td><code>#priority=1</code></td></tr><tr><td>Taxes</td><td><code>#priority=2</code> <code>#dueDate=2026-10-25</code></td></tr><tr><td>Ideas</td><td>none</td></tr></tbody></table></figure><p>sorts them as <em>Taxes</em>, <em>Book report</em>, <em>Groceries</em>, <em>Ideas</em>. The highest priority comes first; <em>Taxes</em> and <em>Book report</em> share it, so the earlier due date decides between them. <em>Ideas</em> has no priority and goes last.</p><p>A value that is a single name without <code>#</code> is read the way older versions did: <code>title</code>, <code>dateCreated</code> or <code>dateModified</code> is a property, and any other name is a label, so <code>#sorted=myOrder</code> sorts by the <code>#myOrder</code> label of the children.</p><aside class=\"admonition warning\"><p>Since v0.107.0, a label in a <code>#sorted</code> value with more than one level, or with a direction, must be written with <code>#</code>. In v0.106.0 the names were written bare, as in <code>#sorted=\"priority desc, dueDate\"</code>; such a value now reads both names as properties that don't exist, and the notes fall back to sorting by title. Add a <code>#</code> before each label name to restore it.</p></aside><h2>Grouping with <code>first</code> and <code>last</code></h2><p>A label followed by <code>first</code> or <code>last</code> doesn't sort by the label's value: it places the child notes that have the label, with any value, before or after the rest. The levels that follow then sort within each group. Grouping ignores <code>#sortDirection</code>.</p><p>For example, <code>#sorted=\"#archived last, #priority desc\"</code> on a parent with these children:</p><figure class=\"table\"><table><thead><tr><th>Child note</th><th>Labels</th></tr></thead><tbody><tr><td>Old project</td><td><code>#archived</code> <code>#priority=3</code></td></tr><tr><td>Draft</td><td><code>#priority=1</code></td></tr><tr><td>Launch</td><td><code>#priority=3</code></td></tr><tr><td>Meeting notes</td><td>none</td></tr></tbody></table></figure><p>sorts them as <em>Launch</em>, <em>Draft</em>, <em>Meeting notes</em>, <em>Old project</em>. The <a href=\"#root/_help_MKmLg5x6xkor\">archived note</a> goes below all the others despite its high priority, and the rest are sorted by priority.</p><p><code>folders first</code> and <code>folders last</code> group the notes that have children of their own. A <code>folders</code> level without <code>first</code> or <code>last</code> also places them first, in either direction. <code>#sortFoldersFirst</code> is a shortcut for a <code>folders first</code> level; it has no effect when <code>#sorted</code> already contains <code>folders</code>.</p><h2>Pinning notes to the top or bottom</h2><p>A child note with <code>#top</code> stays at the top of a sorted parent, and one with <code>#bottom</code> stays at the bottom, whatever the levels of <code>#sorted</code> say. When several notes have <code>#top</code>, they are sorted by the label's value, so <code>#top=1</code> comes before <code>#top=2</code>, and a <code>#top</code> without a value comes first. <code>#bottom</code> works the other way round: the last notes are <code>#bottom=2</code>, then <code>#bottom=1</code>, then a <code>#bottom</code> without a value at the very end.</p><p><code>#sortFoldersFirst</code> places the folders right after the <code>#top</code> notes.</p><p>To pin notes within groups instead of the whole list, name <code>#top</code> and <code>#bottom</code> in <code>#sorted</code> at the position where they apply. For example:</p><ul><li><code>#sorted=\"#archived last, #top first, #bottom last, title\"</code> keeps archived notes below all the others, including those with <code>#bottom</code>. <code>#top</code> and <code>#bottom</code> then apply within the archived and the non-archived group separately.</li><li><code>#sorted=\"#archived last, #top first, #bottom last, folders first, title\"</code> also places folders first within each group. <code>#sortFoldersFirst</code> does the same: its <code>folders first</code> level goes right after the last of <code>#top</code> and <code>#bottom</code>.</li><li>Written with <code>first</code> or <code>last</code>, <code>#top</code> and <code>#bottom</code> ignore their values. To order several pinned notes by value, add a level after them, such as <code>#top first, #top, #bottom last, #bottom desc</code>.</li></ul><h2>How values are compared</h2><ul><li>Values are compared as text, character by character, without regard to letter case. Dates in the <code>YYYY-MM-DD</code> form sort correctly, but numbers don't: <code>\"10\"</code> comes before <code>\"2\"</code>. Either pad the numbers with zeros (<code>02</code>, <code>10</code>) or enable <code>#sortNatural</code>.</li><li>With <code>#sortNatural</code>, numbers are compared by their value, and the comparison follows the rules of the language set by <code>#sortLocale</code> (or the default one), which also ignores accents.</li><li>The title of a note includes its <a class=\"reference-link\" href=\"#root/_help_TBwsyfadTA18\">Branch prefix</a>, if it has one in this parent, as <code>prefix - title</code>.</li><li>A label without a value still counts as present: it sorts before the notes that don't have the label, and among the notes that have it, as the smallest value.</li></ul>",- "_help_NRnIZmSMc5sj": "<figure class=\"image\"><img style=\"aspect-ratio:2023/1488;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/Printing%20%26%20Exporting%20as%20PDF_image.png\" width=\"2023\" height=\"1488\"><figcaption>Screenshot of the Print preview functionality introduced in v0.103.0.</figcaption></figure><p>Trilium allows printing notes to a real printer, or generating a structured PDF for a single note or for multiple notes through <a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>.</p><p>Note that not all note types are printable as of now. We do plan to increase the coverage of supported note types in the future.</p><p>Printing and exporting as PDF are not perfect. Due to technical limitations, and sometimes even browser or Electron glitches the text might appear cut off in some circumstances. </p><h2>Printing a note or exporting as PDF on the desktop</h2><aside class=\"admonition note\"><p>Versions prior to v0.103.0 had two different options, one for printing and another one for exporting to PDF. With the introduction of the print preview, these functions have been unified.</p></aside><p>On the desktop application of Trilium it is possible to export a note as PDF. To print a note:</p><ul><li>Press the menu button in the <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> and select <em>Print note</em>.</li><li>Alternatively, printing can be triggered from a <a href=\"#root/_help_A9Oc6YKKc65v\">keyboard shortcut</a> (unassigned by default) or through the <a href=\"#root/_help_F1r9QtzQLZqm\">command palette</a>.</li></ul><p>This will trigger the print preview screen next.</p><h3>Print preview & print options</h3><p>The print preview dialog allows the following printing options to be adjusted:</p><ul><li>The printer to use<ul><li><em>Save as PDF</em> generates a PDF that is structured (maintains a table of contents, keeps the text selectable). Prefer this over other virtual PDF printers that ship with the operating system.</li></ul></li><li>Page orientation: <em>Portrait</em> (default) or <em>Landscape</em>.</li><li>Page size</li><li>Scale the entire content from 10% to 200% to improve the fit within the page.</li><li>Margins, which can be removed completely or adjusted individually for all the four edges.</li><li>Print only a subset of pages. Individual page numbers are separated by colons and hyphen-based ranges are supported (e.g. 3-5 for pages 3 to 5).</li></ul><p>Additional interaction:</p><ul><li><em>Print using system dialog</em> allows setting more options that are otherwise not available in Trilium.</li></ul><p>If the note cannot be rendered with the current options, or stops making progress for 30 seconds, the preview is replaced by an error message. Adjust the options to try again.</p><aside class=\"admonition note\"><p>Most of the options here (except printer & which pages to print) are managed at note level through <a class=\"reference-link\" href=\"#root/_help_zEY4DaJG4YT5\">Attributes</a> (such as <code>#printLandscape</code>, <code>#printPageSize</code>, <code>#printScale</code>, <code>#printMargins</code>).</p><p>This means that the print settings will be restored when printing the same note. There are no default settings that can be configured for all the notes, but this can be achieved via <a href=\"#root/_help_bwZpz2ajCEwO\">inheritable attributes</a>.</p></aside><h2>Printing on the browser</h2><p>This feature allows printing of notes. It works on both the desktop client, but also on the web.</p><p>To print a note, click the <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> and select <em>Print note</em>. Depending on the size and type of the note, this can take up to a few seconds. Afterwards you will be redirected to the system/browser printing dialog.</p><p>On the server or PWA (mobile), the option is not available due to technical constraints and it will be hidden.</p><h2>Reporting issues with the rendering</h2><p>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 <a href=\"#root/_help_wy8So3yZZlH9\">report the issue</a>. In this case, it's best to offer a sample note (click on the <span class=\"tn-icon cke cke-three-vertical-dots\"></span> button, select <em>Export note</em> → <em>This note and all of its descendants</em> → <em>HTML in ZIP archive</em>). Make sure not to accidentally leak any personal information.</p><p>Consider adjusting font sizes and using <a href=\"#root/_help_CohkqWQC1iBv\">page breaks</a> to work around the layout.</p><aside class=\"admonition tip\"><p>Although direct export as PDF is not available in the browser version of the application, it's still possible to generate a PDF by selecting the <em>Print</em> option instead and selecting “Save to PDF” as the printer (depending on the browser). Generally, Mozilla Firefox has better printing capabilities.</p></aside><h3>Automatic opening of the file</h3><p>When the PDF is exported, it is automatically opened with the system default application for easy preview.</p><p>Note that if you are using Linux with the GNOME desktop environment, sometimes the default application might seem incorrect (such as opening in GIMP). This is because it uses Gnome's “Recommended applications” list.</p><p>To solve this, you can change the recommended application for PDFs via this command line. First, list the available applications via <code>gio mime application/pdf</code> and then set the desired one. For example to use GNOME's Evince:</p><pre><code class=\"language-text-x-trilium-auto\">gio mime application/pdf</code></pre><h2>Printing multiple notes</h2><p>Since v0.100.0, it is possible to print more than one note at the time by using <a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>:</p><ol><li>First create a collection.</li><li>Configure it to use <a class=\"reference-link\" href=\"#root/_help_mULW0Q3VojwY\">List View</a>.</li><li>Print the collection note normally.</li></ol><p>The resulting collection will contain all the children of the collection, while maintaining the hierarchy.</p><aside class=\"admonition note\"><p>Not all note types are supported when printing or exporting to PDF. When an unsupported note is encountered, it is skipped. At the end, if any of the notes were skipped, a message will be displayed with the possibility of viewing the full list of skipped notes. The same limitations as the ones described in <em>Constraints & limitations</em> apply.</p></aside><h2>Keyboard shortcut</h2><p>It's possible to trigger both printing and export as PDF from the keyboard by going to <em>Keyboard shortcuts</em> in <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> and assigning a key combination for:</p><ul><li><em>Print Active Note</em></li><li><em>Export Active Note as PDF</em></li></ul><h2>Constraints & limitations</h2><p>Not all <a class=\"reference-link\" href=\"#root/_help_KSZ04uQ2D1St\">Note Types</a> are supported when printing, in which case the <em>Print</em> and <em>Export as PDF</em> options will be disabled.</p><ul><li>For <a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a> notes, font, background and table colors are printed in the shades of light themes, whatever the current theme (see <a class=\"reference-link\" href=\"#root/_help_Gr6xFaF6ioJ5\">General formatting</a>).</li><li><a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a> notes are printed with line numbers and syntax highlighting, in the <em>Light theme</em> of <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Code Notes</em> → <em>Appearance</em>, whatever the current theme.</li><li>A <a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a> is printed as it is displayed, without running its script again, once its <code>~renderNote</code> relation is set.</li><li>For <a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>, the following are supported:<ul><li><a class=\"reference-link\" href=\"#root/_help_mULW0Q3VojwY\">List View</a>, allowing to print multiple notes at once while preserving hierarchy (similar to a book).</li><li><a class=\"reference-link\" href=\"#root/_help_zP3PMqaG71Ct\">Presentation</a>, where each slide/sub-note is displayed.<ul><li>Most note types are supported, especially the ones that have an image representation such as <a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a> and <a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a>.</li></ul></li><li><a class=\"reference-link\" href=\"#root/_help_2FvYrpmOXm29\">Table</a>, where the table is rendered in a print-friendly way.<ul><li>Tables that are too complex (especially if they have multiple columns) might not fit properly, however tables with a large number of rows are supported thanks to pagination.</li><li>Consider printing in landscape mode, or using <code>#printLandscape</code> if exporting to PDF.</li></ul></li><li>The rest of the collections are not supported, but we plan to add support for all the collection types at some point.</li></ul></li><li>Using <a class=\"reference-link\" href=\"#root/_help_AlhDUqhENtH7\">Custom app-wide CSS</a> for printing is no longer supported, instead a custom <code>printCss</code> relation needs to be used (see below).</li></ul><h2>Customizing the print CSS</h2><p>As an advanced use case, it's possible to customize the CSS used for printing such as adjusting the fonts, sizes or margins. Note that <a class=\"reference-link\" href=\"#root/_help_AlhDUqhENtH7\">Custom app-wide CSS</a> will not work for printing.</p><p>To do so:</p><ul><li>Create a CSS <a href=\"#root/_help_6f9hih2hXXZk\">code note</a>.</li><li>On the note being printed, apply the <code>~printCss</code> relation to point to the newly created CSS code note.</li><li>To apply the CSS to multiple notes, consider using <a href=\"#root/_help_bwZpz2ajCEwO\">inheritable attributes</a> or <a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>.</li></ul><p>For example, to change the font of the document from the one defined by the theme or the user to a serif one:</p><pre><code class=\"language-text-x-trilium-auto\">body {\n\t--print-font-family: serif;\n --print-font-size: 11pt;\n}</code></pre><aside class=\"admonition important\"><p>When altering <code>--print-font-family</code>, make sure the change is done at <code>body</code> level and not <code>:root</code>, since otherwise it won't be picked up due to specificity rules.</p></aside><p>To remark:</p><ul><li>Multiple CSS notes can be add by using multiple <code>~printCss</code> relations.</li><li>If the note pointing to the <code>printCss</code> doesn't have the right note type or mime type, it will be ignored.</li><li>If migrating from a previous version where <a class=\"reference-link\" href=\"#root/_help_AlhDUqhENtH7\">Custom app-wide CSS</a>, there's no need for <code>@media print {</code> since the style-sheet is used only for printing.</li></ul><h2>Under the hood</h2><p>Both printing and exporting as PDF use the same mechanism: a note is rendered individually in a separate webpage that is then sent to the browser or the Electron application either for printing or exporting as PDF.</p><p>The webpage that renders a single note can actually be accessed in a web browser. For example <code>http://localhost:8080/#root/WWRGzqHUfRln/RRZsE9Al8AIZ?ntxId=0o4fzk</code> becomes <code>http://localhost:8080/?print#root/WWRGzqHUfRln/RRZsE9Al8AIZ</code>.</p><p>Accessing the print note in a web browser allows for easy debugging to understand why a particular note doesn't render well. The mechanism for rendering is similar to the one used in <a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a>.</p>",- "_help_CoFPLs3dRlXc": "<p>Some note types such as <a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>, <a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a> notes and even some of the <a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a> can be set to read-only. When a note is in read-only mode, it is presented to the user in a non-editable view, with the option to switch to editing mode if needed.</p><h2>Automatic read-only mode</h2><p>For optimization purposes, Trilium will automatically set very large notes to read-only. Displaying such lengthy notes in editing mode can slow down performance, especially when editing is unnecessary.</p><p>This behavior can be disabled on a per-note basis, by following the instructions of the next section.</p><p>In addition, it's possible to change the number of characters at which the automatic read-only mode will trigger in <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> by going to the options for <a class=\"reference-link\" href=\"#root/_hidden/_options/_optionsTextNotes\">Text Notes</a> and <a class=\"reference-link\" href=\"#root/_hidden/_options/_optionsCodeNotes\">Code Notes</a>.</p><h2>Changing a note's read-only behavior</h2><p>A note's read-only behavior can be changed via <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> → <em>Editable.</em> The following options are possible:</p><ul><li><strong>Auto</strong><br>This is the default behavior in which the note will be editable by default, unless it becomes large enough to trigger read-only mode.</li><li><strong>Read-only</strong><br>The note will be always marked as read-only, regardless of its size. Nevertheless, it's still possible to temporarily edit the note if needed. This is generally useful for notes that are not prone to change.</li><li><strong>Always Editable</strong><br>This option will bypass the automatic read-only activation for this particular note. It's useful for large notes that are frequently edited.</li></ul><p>If the <em>Editable</em> section is missing from the <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>, then the note type does not support read-only mode.</p><h3>Manually setting the options</h3><p>Apart from using the <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> as previously mentioned, it's also possible to use <a href=\"#root/_help_zEY4DaJG4YT5\">labels</a> to change the behavior:</p><ul><li>To set as read-only, apply the <code>readOnly</code> label to the note.</li><li>To disable automatic read-only (always editable), apply the <code>autoReadOnlyDisabled</code> label.</li></ul><h2>Temporarily editing a read-only note</h2><p>When accessing a read-only note, it's possible to temporarily edit it pressing the <em>Read-only</em> badge.</p><p>When pressed, the note will become editable but will become read-only again after navigating to a different note.</p><p>The pages of the built-in user guide are an exception: they are part of Trilium itself and cannot be edited, not even temporarily. Their <em>Read-only</em> badge cannot be pressed, the note menu does not offer to edit them, and their attributes are shown in the right sidebar without a way to change them.</p>",+ "_help_NRnIZmSMc5sj": "<figure class=\"image\"><img style=\"aspect-ratio:2023/1488;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/Printing%20%26%20Exporting%20as%20PDF_image.png\" width=\"2023\" height=\"1488\"><figcaption>Screenshot of the Print preview functionality introduced in v0.103.0.</figcaption></figure><p>Trilium allows printing notes to a real printer, or generating a structured PDF for a single note or for multiple notes through <a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>.</p><p>Note that not all note types are printable as of now. We do plan to increase the coverage of supported note types in the future.</p><p>Printing and exporting as PDF are not perfect. Due to technical limitations, and sometimes even browser or Electron glitches the text might appear cut off in some circumstances. </p><h2>Printing a note or exporting as PDF on the desktop</h2><aside class=\"admonition note\"><p>Versions prior to v0.103.0 had two different options, one for printing and another one for exporting to PDF. With the introduction of the print preview, these functions have been unified.</p></aside><p>On the desktop application of Trilium it is possible to export a note as PDF. To print a note:</p><ul><li>Press the menu button in the <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> and select <em>Print/export to PDF…</em>.</li><li>Alternatively, printing can be triggered from a <a href=\"#root/_help_A9Oc6YKKc65v\">keyboard shortcut</a> (unassigned by default) or through the <a href=\"#root/_help_F1r9QtzQLZqm\">command palette</a>.</li></ul><p>This will trigger the print preview screen next.</p><h3>Print preview & print options</h3><p>The print preview dialog allows the following printing options to be adjusted:</p><ul><li>The printer to use<ul><li><em>Save as PDF</em> generates a PDF that is structured (maintains a table of contents, keeps the text selectable). Prefer this over other virtual PDF printers that ship with the operating system.</li></ul></li><li>Page orientation: <em>Portrait</em> (default) or <em>Landscape</em>.</li><li>Page size</li><li>Scale the entire content from 10% to 200% to improve the fit within the page.</li><li>Margins, which can be removed completely or adjusted individually for all the four edges.</li><li>Print only a subset of pages. Individual page numbers are separated by colons and hyphen-based ranges are supported (e.g. 3-5 for pages 3 to 5).</li></ul><p>Additional interaction:</p><ul><li><em>Print using system dialog</em> allows setting more options that are otherwise not available in Trilium.</li></ul><p>If the note cannot be rendered with the current options, or stops making progress for 30 seconds, the preview is replaced by an error message. Adjust the options to try again.</p><aside class=\"admonition note\"><p>Most of the options here (except printer & which pages to print) are managed at note level through <a class=\"reference-link\" href=\"#root/_help_zEY4DaJG4YT5\">Attributes</a> (such as <code>#printLandscape</code>, <code>#printPageSize</code>, <code>#printScale</code>, <code>#printMargins</code>).</p><p>This means that the print settings will be restored when printing the same note. There are no default settings that can be configured for all the notes, but this can be achieved via <a href=\"#root/_help_bwZpz2ajCEwO\">inheritable attributes</a>.</p></aside><h2>Printing on the browser</h2><p>This feature allows printing of notes. It works on both the desktop client, but also on the web.</p><p>To print a note, click the <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> and select <em>Print/export to PDF…</em>. Depending on the size and type of the note, this can take up to a few seconds. Afterwards you will be redirected to the system/browser printing dialog.</p><p>On the server or PWA (mobile), the option is not available due to technical constraints and it will be hidden.</p><h2>Reporting issues with the rendering</h2><p>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 <a href=\"#root/_help_wy8So3yZZlH9\">report the issue</a>. In this case, it's best to offer a sample note (click on the <span class=\"tn-icon cke cke-three-vertical-dots\"></span> button, select <em>Export note</em> → <em>This note and all of its descendants</em> → <em>HTML in ZIP archive</em>). Make sure not to accidentally leak any personal information.</p><p>Consider adjusting font sizes and using <a href=\"#root/_help_CohkqWQC1iBv\">page breaks</a> to work around the layout.</p><aside class=\"admonition tip\"><p>Although direct export as PDF is not available in the browser version of the application, it's still possible to generate a PDF by selecting the <em>Print</em> option instead and selecting “Save to PDF” as the printer (depending on the browser). Generally, Mozilla Firefox has better printing capabilities.</p></aside><h3>Automatic opening of the file</h3><p>When the PDF is exported, it is automatically opened with the system default application for easy preview.</p><p>Note that if you are using Linux with the GNOME desktop environment, sometimes the default application might seem incorrect (such as opening in GIMP). This is because it uses Gnome's “Recommended applications” list.</p><p>To solve this, you can change the recommended application for PDFs via this command line. First, list the available applications via <code>gio mime application/pdf</code> and then set the desired one. For example to use GNOME's Evince:</p><pre><code class=\"language-text-x-trilium-auto\">gio mime application/pdf</code></pre><h2>Printing multiple notes</h2><p>Since v0.100.0, it is possible to print more than one note at the time by using <a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>:</p><ol><li>First create a collection.</li><li>Configure it to use <a class=\"reference-link\" href=\"#root/_help_mULW0Q3VojwY\">List View</a>.</li><li>Print the collection note normally.</li></ol><p>The resulting collection will contain all the children of the collection, while maintaining the hierarchy.</p><aside class=\"admonition note\"><p>Not all note types are supported when printing or exporting to PDF. When an unsupported note is encountered, it is skipped. At the end, if any of the notes were skipped, a message will be displayed with the possibility of viewing the full list of skipped notes. The same limitations as the ones described in <em>Constraints & limitations</em> apply.</p></aside><h2>Keyboard shortcut</h2><p>It's possible to trigger both printing and export as PDF from the keyboard by going to <em>Keyboard shortcuts</em> in <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> and assigning a key combination for:</p><ul><li><em>Print Active Note</em></li><li><em>Export Active Note as PDF</em></li></ul><h2>Constraints & limitations</h2><p>Not all <a class=\"reference-link\" href=\"#root/_help_KSZ04uQ2D1St\">Note Types</a> are supported when printing, in which case the <em>Print</em> and <em>Export as PDF</em> options will be disabled.</p><ul><li>For <a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a> notes, font, background and table colors are printed in the shades of light themes, whatever the current theme (see <a class=\"reference-link\" href=\"#root/_help_Gr6xFaF6ioJ5\">General formatting</a>).</li><li><a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a> notes are printed with line numbers and syntax highlighting, in the <em>Light theme</em> of <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Code Notes</em> → <em>Appearance</em>, whatever the current theme.</li><li>A <a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a> is printed as it is displayed, without running its script again, once its <code>~renderNote</code> relation is set.</li><li>For <a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>, the following are supported:<ul><li><a class=\"reference-link\" href=\"#root/_help_mULW0Q3VojwY\">List View</a>, allowing to print multiple notes at once while preserving hierarchy (similar to a book).</li><li><a class=\"reference-link\" href=\"#root/_help_zP3PMqaG71Ct\">Presentation</a>, where each slide/sub-note is displayed.<ul><li>Most note types are supported, especially the ones that have an image representation such as <a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a> and <a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a>.</li></ul></li><li><a class=\"reference-link\" href=\"#root/_help_2FvYrpmOXm29\">Table</a>, where the table is rendered in a print-friendly way.<ul><li>Tables that are too complex (especially if they have multiple columns) might not fit properly, however tables with a large number of rows are supported thanks to pagination.</li><li>Consider printing in landscape mode, or using <code>#printLandscape</code> if exporting to PDF.</li></ul></li><li>The rest of the collections are not supported, but we plan to add support for all the collection types at some point.</li></ul></li><li>Using <a class=\"reference-link\" href=\"#root/_help_AlhDUqhENtH7\">Custom app-wide CSS</a> for printing is no longer supported, instead a custom <code>printCss</code> relation needs to be used (see below).</li></ul><h2>Customizing the print CSS</h2><p>As an advanced use case, it's possible to customize the CSS used for printing such as adjusting the fonts, sizes or margins. Note that <a class=\"reference-link\" href=\"#root/_help_AlhDUqhENtH7\">Custom app-wide CSS</a> will not work for printing.</p><p>To do so:</p><ul><li>Create a CSS <a href=\"#root/_help_6f9hih2hXXZk\">code note</a>.</li><li>On the note being printed, apply the <code>~printCss</code> relation to point to the newly created CSS code note.</li><li>To apply the CSS to multiple notes, consider using <a href=\"#root/_help_bwZpz2ajCEwO\">inheritable attributes</a> or <a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>.</li></ul><p>For example, to change the font of the document from the one defined by the theme or the user to a serif one:</p><pre><code class=\"language-text-x-trilium-auto\">body {\n\t--print-font-family: serif;\n --print-font-size: 11pt;\n}</code></pre><aside class=\"admonition important\"><p>When altering <code>--print-font-family</code>, make sure the change is done at <code>body</code> level and not <code>:root</code>, since otherwise it won't be picked up due to specificity rules.</p></aside><p>To remark:</p><ul><li>Multiple CSS notes can be add by using multiple <code>~printCss</code> relations.</li><li>If the note pointing to the <code>printCss</code> doesn't have the right note type or mime type, it will be ignored.</li><li>If migrating from a previous version where <a class=\"reference-link\" href=\"#root/_help_AlhDUqhENtH7\">Custom app-wide CSS</a>, there's no need for <code>@media print {</code> since the style-sheet is used only for printing.</li></ul><h2>Under the hood</h2><p>Both printing and exporting as PDF use the same mechanism: a note is rendered individually in a separate webpage that is then sent to the browser or the Electron application either for printing or exporting as PDF.</p><p>The webpage that renders a single note can actually be accessed in a web browser. For example <code>http://localhost:8080/#root/WWRGzqHUfRln/RRZsE9Al8AIZ?ntxId=0o4fzk</code> becomes <code>http://localhost:8080/?print#root/WWRGzqHUfRln/RRZsE9Al8AIZ</code>.</p><p>Accessing the print note in a web browser allows for easy debugging to understand why a particular note doesn't render well. The mechanism for rendering is similar to the one used in <a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a>.</p>",+ "_help_CoFPLs3dRlXc": "<p>Some note types such as <a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>, <a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a> notes and even some of the <a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a> can be set to read-only. When a note is in read-only mode, it is presented to the user in a non-editable view, with the option to switch to editing mode if needed.</p><h2>Automatic read-only mode</h2><p>For optimization purposes, Trilium will automatically set very large notes to read-only. Displaying such lengthy notes in editing mode can slow down performance, especially when editing is unnecessary.</p><p>This behavior can be disabled on a per-note basis, by following the instructions of the next section.</p><p>In addition, it's possible to change the number of characters at which the automatic read-only mode will trigger in <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> by going to the options for <a class=\"reference-link\" href=\"#root/_hidden/_options/_optionsTextNotes\">Text Notes</a> and <a class=\"reference-link\" href=\"#root/_hidden/_options/_optionsCodeNotes\">Code Notes</a>.</p><h2>Changing a note's read-only behavior</h2><p>A note's read-only behavior can be changed via <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> → <em>Editable.</em> The following options are possible:</p><ul><li><strong>Auto</strong><br>This is the default behavior in which the note will be editable by default, unless it becomes large enough to trigger read-only mode.</li><li><strong>Read-only</strong><br>The note will be always marked as read-only, regardless of its size. Nevertheless, it's still possible to temporarily edit the note if needed. This is generally useful for notes that are not prone to change.</li><li><strong>Always editable</strong><br>This option will bypass the automatic read-only activation for this particular note. It's useful for large notes that are frequently edited.</li></ul><p>If the <em>Editable</em> section is missing from the <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>, then the note type does not support read-only mode.</p><h3>Manually setting the options</h3><p>Apart from using the <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> as previously mentioned, it's also possible to use <a href=\"#root/_help_zEY4DaJG4YT5\">labels</a> to change the behavior:</p><ul><li>To set as read-only, apply the <code>readOnly</code> label to the note.</li><li>To disable automatic read-only (always editable), apply the <code>autoReadOnlyDisabled</code> label.</li></ul><h2>Temporarily editing a read-only note</h2><p>When accessing a read-only note, it's possible to temporarily edit it pressing the <em>Read-only</em> badge.</p><p>When pressed, the note will become editable but will become read-only again after navigating to a different note.</p><p>The pages of the built-in user guide are an exception: they are part of Trilium itself and cannot be edited, not even temporarily. Their <em>Read-only</em> badge cannot be pressed, the note menu does not offer to edit them, and their attributes are shown in the right sidebar without a way to change them.</p>","_help_0ESUbbAxVnoK": "<figure class=\"image\"><img style=\"aspect-ratio:990/590;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/Note%20List_image.png\" width=\"990\" height=\"590\"></figure><p>When a note has one or more child notes, they will be listed at the end of the note for easy navigation.</p><h2>Configuration</h2><ul><li>To hide the note list for a particular note, simply apply the <code>hideChildrenOverview</code> <a href=\"#root/_help_zEY4DaJG4YT5\">label</a>.</li><li>For some view types, such as Grid view, only a subset of notes will be displayed and pagination can be used to navigate through all of them for performance reasons. To adjust the number of notes per page, set <code>pageSize</code> to the desired number.</li></ul><h2>View types</h2><p>The view types dictate how the child notes are represented. By default, the notes will be displayed in a grid, however there are also some other view types available.</p><p>Generally the view type can only be changed from the <a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>, but it can also be changed manually on any type of note using the <code>#viewType</code> <a href=\"#root/_help_HI6GBBIduIgv\">label</a>.</p>","_help_S0Fos78ZfcY7": "<p>The inbox is the default destination for quickly captured notes. When a note is created without picking a location first, it lands in the inbox. This makes it easy to quickly capture notes and sort them later.</p><h2>Where the inbox is used</h2><ul><li>The <em>New note</em> button in the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</li><li>The global <em>Create note into inbox</em> shortcut (default <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>P</kbd>).</li><li>The <em>New note</em> action in the <a href=\"#root/_help_7iwde4lsKc6O\">tray icon menu</a>.</li><li>The <a class=\"reference-link\" href=\"#root/_help_MtPxeAWVAzMg\">Web Clipper</a> extension.</li><li>The <em>Create note</em> option offered when a search finds no match, in <a class=\"reference-link\" href=\"#root/_help_F1r9QtzQLZqm\">Jump to & command palette</a>, in an empty tab and in the <code>@</code> completion of a text note.</li></ul><h2>Setting a note inbox</h2><p>To create a note inbox, apply the <code>#inbox</code> <a href=\"#root/_help_HI6GBBIduIgv\">label</a> to it.</p><p>Only one note should carry this label. If there are multiple notes, only one will be used by the application.</p><aside class=\"admonition note\"><p>If there is no inbox note, Trilium will fall back to today's <a href=\"#root/_help_l0tKav7yLHGF\">day note</a>, creating it and its calendar ancestors as needed. If the journal has been removed altogether, the note is created at the top level instead of a new journal being built for it.</p></aside><h2>Workspace inboxes</h2><p>Each <a href=\"#root/_help_9sRHySam5fXb\">workspace</a> can have its own inbox, set via the <code>#workspaceInbox</code> label.</p><p>When a new note is created while hoisted in a workspace, the location is determined in the following order:</p><ul><li>A note carrying the <code>#workspaceInbox</code> label in that workspace.</li><li>A note carrying the <code>#inbox</code> within that workspace.</li><li>Today's <a href=\"#root/_help_l0tKav7yLHGF\">day note</a>, if the workspace has a <code>#workspaceCalendarRoot</code>.</li><li>The workspace root note itself.</li></ul>",- "_help_5Ct4MAJTS4tQ": "<p>Deleted notes are listed in the <em>Deleted Notes</em> dialog (<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> → <em>Show Deleted Notes</em>) and can be restored by pressing the <em>undelete</em> link.</p><p>If a note has child notes, they will be restored along with it. Should the original location no longer exist (e.g. the parent has been deleted), the note will be restored into the default location for new notes (<a class=\"reference-link\" href=\"#root/_help_S0Fos78ZfcY7\">Note Inbox</a>).</p><aside class=\"admonition note\"><p>When a note is hoisted in the tree, the dialog will only display notes deleted from the subtree of that hoisted note.</p></aside><p>To permanently erase deleted notes and clear the list, press the three-dots menu and select <em>Erase deleted notes now</em>.</p><p>Deleted notes are permanently erased after a certain amount of time (7 days by default). To change this interval, press the three-dots menu and select <em>Deleted Notes Settings</em>.</p>",+ "_help_5Ct4MAJTS4tQ": "<p>Deleted notes are listed in the <em>Deleted Notes</em> dialog (<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> → <em>Show deleted notes</em>) and can be restored by pressing the <em>undelete</em> link.</p><p>If a note has child notes, they will be restored along with it. Should the original location no longer exist (e.g. the parent has been deleted), the note will be restored into the default location for new notes (<a class=\"reference-link\" href=\"#root/_help_S0Fos78ZfcY7\">Note Inbox</a>).</p><aside class=\"admonition note\"><p>When a note is hoisted in the tree, the dialog will only display notes deleted from the subtree of that hoisted note.</p></aside><p>To permanently erase deleted notes and clear the list, press the three-dots menu and select <em>Erase deleted notes now</em>.</p><p>Deleted notes are permanently erased after a certain amount of time (7 days by default). To change this interval, press the three-dots menu and select <em>Deleted Notes Settings</em>.</p>","_help_m3VlURMSeOrd": "<p>When an empty <a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a> note is created, a note type switcher will appear below the inline <a class=\"reference-link\" href=\"#root/_help_l7pigIGu01K2\">Title</a>. Apart from changing the note type, it's also possible to apply a <a href=\"#root/_help_KC1HB96bqqHX\">template</a>:</p><ul><li><span class=\"tn-icon bx bxl-markdown\"></span> <em>Markdown</em> and <span class=\"tn-icon bx bx-pen\"></span> <em>Canvas</em> switch the note to that type in one click.</li><li><span class=\"tn-icon bx bx-code\"></span> <em>Code</em> lists the scripting notes (<em>Custom CSS</em>, <em>Widget</em> and <em>Backend script</em>), then the enabled code languages.</li><li><span class=\"tn-icon bx bx-book\"></span> <em>Collection</em> and <span class=\"tn-icon bx bx-copy-alt\"></span><em>Template</em> list the collections and the templates.</li><li><span class=\"tn-icon bx bx-dots-vertical-rounded\"></span> <em>All types</em> displays the same menu as <em>Insert note after</em> in the <a class=\"reference-link\" href=\"#root/_help_YtSN43OrfzaA\">Note tree contextual menu</a>, with every note type and template.</li></ul><p>Typing while the <span class=\"tn-icon bx bx-code\"></span> <em>Code</em>, <span class=\"tn-icon bx bx-copy-alt\"></span> <em>Template</em> or <span class=\"tn-icon bx bx-dots-vertical-rounded\"></span> <em>All types</em> menu is open narrows it down to the matching entries.</p><p>The switcher will disappear as soon as a text is entered.</p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/New%20note%20type%20switcher_image.png\" width=\"735\" height=\"143\">","_help_B5dihXRDksTk": "<p>Note badges appear near the fixed note title and indicate important information about the note such as whether it is read-only. Some of the badges are also interactive.</p><figure class=\"image\"><img style=\"aspect-ratio:910/49;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/Note%20badges_image.png\" width=\"910\" height=\"49\"></figure><p>The following badges are available:</p><ul><li><span class=\"tn-icon bx bx-lock-alt\"></span> <strong>Read-only badge</strong>, which will be shown if the note is not editable due to either automatic read-only or manual read-only. Clicking on the badge will temporarily edit the note. On the pages of the built-in user guide, which cannot be edited, the badge does nothing when clicked.</li><li><span class=\"tn-icon bx bx-share-alt\"></span> <strong>Share badge</strong>, which will indicate that the current note is shared. The badge will also indicate if the share is on the local network (for the desktop application without <a class=\"reference-link\" href=\"#root/_help_cbkrhQjrkKrh\">Synchronization</a> set up) or publicly accessible (for the server).</li><li><span class=\"tn-icon bx bx-globe\"></span> <strong>Web clip badge</strong>, which will indicate if the note was clipped using the <a class=\"reference-link\" href=\"#root/_help_MtPxeAWVAzMg\">Web Clipper</a>. The badge acts as a link, so it can be clicked on to navigate to the page or right clicked for more options. When the clipper also saved the page's description, its author, or the dates it was published and last updated, clicking the badge shows these details instead, with a link to the page at the top.</li><li><span class=\"tn-icon bx bx-play\"></span> <strong>Execute badge</strong>, for <a href=\"#root/_help_CdNpE2pqjmI6\">scripts</a> or <a href=\"#root/_help_YKWqdJhzi2VY\">saved SQL queries</a> which have an execute button or a description.</li><li><span class=\"tn-icon bx bx-copy-alt\"></span> <strong>Template badge</strong>, for <a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a> (including workspace templates, for which the badge reads <em>Workspace template</em>). Notes created from a template inherit its attributes, so the badge is a reminder that changing them affects every such note. Clicking the badge switches the template between being offered everywhere and only while hoisted into its workspace, the latter only for a template inside a workspace (see <a class=\"reference-link\" href=\"#root/_help_9sRHySam5fXb\">Workspaces</a>). It also opens <em>Template properties...</em>, where the default title and location of new notes are set.</li><li>For <a class=\"reference-link\" href=\"#root/_help_YzMcWlCVeW09\">Active content</a> (e.g. scripts, styles), a dedicated badge will be shown indicating the type of note and with an option to easily enable or disable it.</li></ul>","_help_Bsm4fyzPJkSc": "<p><img class=\"image-style-align-right\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/Save%20status%20indicator_image.png\" width=\"168\" height=\"47\">To the right of the note title, a temporary indicator appears after making a change to the document which shows whether the document has been saved.</p><p>It indicates the following states:</p><ul><li><span class=\"tn-icon bx bx-pencil\"></span> <em>Unsaved</em>, if the changes will be saved soon.</li><li><span class=\"tn-icon bx bx-loader\"></span> <em>Saving</em>, if the changes are being saved.</li><li><span class=\"tn-icon bx bx-check\"></span> <em>Saved</em>, if all the changes were successfully saved to the server.</li><li><span class=\"tn-icon bx bx-error\"></span> <em>Error</em>, if the changes could not be saved, for example due to a communication server with the server.</li></ul><p>After all changes have been saved, the indicator will hide automatically after a few seconds.</p>",@@ -109,7 +109,7 @@"_help_dj3j8dG4th4l": "const query = `note.type = \"text\" and note.content *=* \"evernote:///view/\"`;\nconst notes = api.searchForNotes(query);\n\nfor (const note of notes) {\n api.log(`Processing note ${note.title}...`);\n \n const content = note.getContent();\n const root = api.htmlParser.parse(content);\n \n for (const el of root.querySelectorAll(\"a\")) {\n const url = el.getAttribute(\"href\");\n if (!url?.startsWith(\"evernote:///\")) continue;\n\n const text = el.textContent;\n const matchingNotes = api.searchForNotes(`note.title = \"${text}\"`);\n if (matchingNotes.length === 0) {\n api.log(`No matching notes for \"${text}...\"`);\n continue;\n }\n\n if (matchingNotes.length > 1) {\n api.log(`Found multiple matching notes for \"${text}\". Skipping.`);\n continue;\n }\n\n const matchingNote = matchingNotes[0];\n \n api.log(`Found matching note: ${matchingNote.title} ${matchingNote.noteId}`);\n el.setAttribute(\"href\", `#root/${matchingNote.noteId}`);\n el.classList.add(\"reference-link\");\n }\n note.setContent(root.toString()); \n}\n","_help_83zmPBJRgfnW": "<p>Starting with v0.104.0, Trilium is able to import data from Anytype from JSON imports which preserve most of the formatting and the metainformation.</p><h2>Import process</h2><p>The first step is to export the data from Anytype:</p><ul><li>To export a single page:<ul><li>Select the page to export.</li><li>Press the […] at the top-right of the window and select <em>Export</em>.</li><li>Ensure the following options are set:<ul><li>Export format: Any-Block</li><li>File Format: JSON</li><li>Zip archive: On</li><li>Include linked objects: On</li><li>Include files: On</li><li>Include archived objects: On</li></ul></li></ul></li><li>To export an entire channel:<ul><li>Select the desired channel from the left bar.</li><li>Underneath the channel icon in the left sidebar, press the name of the channel with an arrow and select <em>Channel Settings</em>.</li><li>In the left sidebar, look for the <em>Integrations</em> section and select <em>Export</em>.</li><li>Press <em>Any-Block</em>.</li><li>Ensure the following options are set:<ul><li>File Format: JSON</li><li>Zip archive: On</li><li>Include files: On</li><li>Include archived objects: On</li></ul></li></ul></li></ul><p>In Trilium Notes:</p><ol><li>In the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, right click and select <em>Import into note</em>.</li><li>In the <em>Import from</em> section, select <span class=\"tn-icon tn-brand tn-brand-anytype\"></span> <em>Anytype</em>.</li><li>Upload the ZIP.</li></ol><aside class=\"admonition note\"><p>Exporting collections individually can sometimes miss information that would otherwise be picked up from an export of the entire channel. The reason is that Anytype leaves out some information when exporting individual pages/collections.</p></aside><h2>Supported features</h2><p>The following features are preserved by Trilium during the import process:</p><ul><li>Basic formatting (bold, italic, underline, strikethrough, headings, colors, highlights, inline code).</li><li><a class=\"reference-link\" href=\"#root/_help_S6Xx8QIWTV66\">Lists</a> (numbered or bullet)</li><li><a class=\"reference-link\" href=\"#root/_help_mT0HEkOsz6i1\">Images</a> and files are handled as <a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>.</li><li>To-do lists</li><li>Toggle sections</li><li><a class=\"reference-link\" href=\"#root/_help_NdowYOC1GFKS\">Tables</a></li><li>Inline <a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a></li><li><a class=\"reference-link\" href=\"#root/_help_YfYAtQBcfo5V\">Math Equations</a></li><li>Highlight blocks are imported as block quotes.</li><li><a class=\"reference-link\" href=\"#root/_help_QxEyIjRBizuC\">Code blocks</a>, with a best-effort attempt to restore the language.</li><li>Links between other imported pages are converted to <a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a> if they are part of the same import.<ul><li>Applies to both block links and inline links.</li></ul></li><li>Collections are imported as Trilium-native <a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a> (see below).<ul><li>Files inside collections are imported as <a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a> notes.</li></ul></li><li>Dividers (line, dots) are imported as horizontal rules.</li><li><a href=\"#root/_help_NwBbFdNZ9h7O\">Admonitions</a> are preserved, including its emoji (added as part of the content).</li><li>Creation and modification date of pages is preserved.</li></ul><h2>Collections</h2><p>Collections created in Anytype are imported on a best-effort basis, preserving both the view mode and the page properties as <a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>.</p><p>The following view modes are supported:</p><ul><li>List as <a class=\"reference-link\" href=\"#root/_help_mULW0Q3VojwY\">List View</a></li><li>Gallery as <a class=\"reference-link\" href=\"#root/_help_8QqnMzx393bx\">Grid View</a></li><li><a class=\"reference-link\" href=\"#root/_help_xWbu3jpNWapp\">Calendar</a>, preserving the attribute which identifies the date.</li><li><a class=\"reference-link\" href=\"#root/_help_CtBQqbwXDx1w\">Kanban Board</a>, preserving the board group column.</li><li><a class=\"reference-link\" href=\"#root/_help_2FvYrpmOXm29\">Table</a>, also used as fallback for unsupported collection layouts.</li></ul><p>The following types are supported:</p><figure class=\"table\"><table><thead><tr><th scope=\"col\">Anytype property type</th><th scope=\"col\">Trilium</th></tr></thead><tbody><tr><td>Text / Select</td><td>Single-valued <code>text</code> label</td></tr><tr><td>Number</td><td>Single-valued <code>number</code> label</td></tr><tr><td>Multi-select</td><td>One <code>text</code> label per option (multi)</td></tr><tr><td>Date / Date with time</td><td><ul><li><code>datetime</code> if the time is included.</li><li><code>date</code> if only dates.</li></ul></td></tr><tr><td>File</td><td>The files are preserved as attachments, and a link to them is prepended to the content of the note for visibility.</td></tr><tr><td>Checkbox</td><td><code>boolean</code> label (<code>true</code>/<code>false</code>).</td></tr><tr><td>URL / Email / Phone</td><td><code>url</code> label (<code>mailto:</code>, <code>tel:</code> prefix)</td></tr></tbody></table></figure><h2>Reporting issues</h2><p>When importing your Anytype notes, you might find issues in how a note is imported; in that case consider <a href=\"#root/_help_wy8So3yZZlH9\">reporting</a> it.</p><p>When reporting such an issue make sure to provide the following information:</p><ul><li>A .zip export of the original note (and children if applicable). This allows us to reproduce the issue.</li><li>A screenshot with how it originally looked like before the import and how it looks after the import.</li></ul>","_help_iWD7wiIuMtgV": "<p>Although Obsidian was indirectly supported through the standard <a class=\"reference-link\" href=\"#root/_help_Oau6X9rCuegd\">Markdown</a> import, its vault structure is distinct enough to warrant its own dedicated import channel.</p><h2>Import process</h2><p>The first step is to obtain a .zip of your Obsidian vault:</p><ol><li>First, identify where your Obsidian vault is located. The easiest way to do so is to open Obsidian and right clicking the name of the vault at the bottom of the left sidebar and then selecting <em>Show in system explorer</em>.</li><li>In your system explorer, right click the directory containing your Obsidian vault and compress it to a ZIP file (e.g. on Windows, <em>Compress To</em> → <em>ZIP</em>).</li></ol><aside class=\"admonition tip\"><p>When zipping, you can either ZIP the outer folder of the vault, or the contents of the vault as Trilium will automatically determine the position of the vault in the archive via the <code>.obsidian</code> directory.</p></aside><p>Then, in Trilium Notes:</p><ol><li>In the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, right click and select <em>Import into note</em>.</li><li>In the <em>Import from</em> section, select <span class=\"tn-icon tn-brand tn-brand-obsidian\"></span> <em>Obsidian</em>.</li><li>Upload the ZIP obtained in the previous step.</li></ol><p>Alternatively, simply drag & drop the .zip archive in the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a> and Trilium will auto-detect it as an Obsidian import provided there is a <code>.obsidian</code> directory. If not, follow the previous steps instead.</p><h2>Supported features</h2><p>The following features are preserved by Trilium during the import process:</p><ul><li>Folder hierarchy is preserved.</li><li>Basic Markdown formatting (bold, italic, underline, strikethrough, headings).</li><li>Specific Obsidian formatting (highlighting).</li><li><a class=\"reference-link\" href=\"#root/_help_S6Xx8QIWTV66\">Lists</a></li><li>To-do lists</li><li><a class=\"reference-link\" href=\"#root/_help_mT0HEkOsz6i1\">Images</a> and <a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a><ul><li>Non-Markdown files in the Vault are treated as attachments by default if they are referenced by at least one note.</li><li>Otherwise, they will be imported as <a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a> notes.</li></ul></li><li>Transclusions are converted to <a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a> or <a class=\"reference-link\" href=\"#root/_help_mT0HEkOsz6i1\">Images</a> (depending on type).</li><li><a class=\"reference-link\" href=\"#root/_help_YfYAtQBcfo5V\">Math Equations</a> (inline or block)</li><li><a class=\"reference-link\" href=\"#root/_help_QxEyIjRBizuC\">Code blocks</a>, with a best-effort attempt to restore the language.</li><li>Links between pages are converted to <a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>.</li><li>Callouts are converted to Trilium's <a href=\"#root/_help_NwBbFdNZ9h7O\">Admonitions</a>.<ul><li>Obsidian has many more types of callouts (<code>tldr</code>, <code>question</code>, <code>attention</code>), these are all mapped to one of Trilium's existing admonition types (e.g. Note, Tip, Important).</li><li>Custom titles are kept and shown as a bold line at the top of the admonition, since there is no concept of admonition title in Trilium.</li><li>Foldable callouts are imported expanded and without a fold marker.</li></ul></li><li>Notes created by the <a href=\"https://github.com/zsviczian/obsidian-excalidraw-plugin\"><em>Excalidraw</em></a> community plugin for Obsidian are converted to <a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a> (same underlying technology).<ul><li>Note that custom features introduced by that plugin will not be supported.</li></ul></li><li>Modification date is preserved via the information obtained from the .zip archive, creation date is not recoverable so it's kept the same as the modification date.</li></ul><h2>Properties</h2><p>Properties are Obsidian's equivalent of <a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>. One of the core differences between the two is where the property information is stored (i.e. name and type): in Obsidian everything is stored at vault level and shared across all notes, whereas in Trilium each page can have individual promoted attributes, shared through <a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a> or <a class=\"reference-link\" href=\"#root/_help_bwZpz2ajCEwO\">Attribute Inheritance</a>.</p><p>Another important difference is that promoted attributes in Trilium are always displayed, even if empty. In Obsidian, these are simply suggested when creating a new property.</p><p>To reconcile all these differences, properties are converted to <a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a> at note level.</p><p>The following note types are supported:</p><figure class=\"table\"><table><thead><tr><th>Obsidian type</th><th>Trilium</th></tr></thead><tbody><tr><td>Text or not defined</td><td>Single-valued <code>text</code> label</td></tr><tr><td>Number</td><td>Single-valued <code>number</code> label</td></tr><tr><td>Multitext</td><td>Multi-valued <code>text</code> label</td></tr><tr><td>Checkbox</td><td><code>boolean</code> label (<code>true</code>/<code>false</code>).</td></tr><tr><td>Date</td><td><code>date</code></td></tr><tr><td>Date & Time</td><td><code>datetime</code></td></tr></tbody></table></figure><h3>Special properties</h3><p>Obsidian has a few reserved property names, which are treated differently in Trilium as well:</p><ul><li><code>tags</code>, where every tag is turned into its own <a href=\"#root/_help_HI6GBBIduIgv\">label</a> (e.g. <code>#one</code>, <code>#two</code> when <code>tags: [ one, two ]</code>).</li><li><code>aliases</code> are simply mapped to individual <code>#alias</code> labels</li><li><code>cssclasses</code>, <code>publish</code>, <code>permalink</code> are ignored.</li></ul><h2>Limitations</h2><ul><li>Comments (<code>%%</code> syntax) are simply stripped.</li><li>Obsidian <em>bases</em> functionality is not preserved.<ul><li>The closest equivalent in Trilium would be <a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a> but they work fundamentally different because bases don't store particular notes, they act more like a <a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a> with a collection view.</li><li>Since the base query format is quite different to Trilium's <a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a> syntax, it's unlikely they'll ever be supported.</li><li>When a base is encountered, it is simply ignored from the import.</li></ul></li><li>Canvases are not imported.<ul><li>Theoretically they could map to either <a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a> or <a class=\"reference-link\" href=\"#root/_help_iRwzGnHPzonm\">Relation Map</a> but they are too different to reconcile.</li></ul></li><li>Links<ul><li>Links to a specific heading in another note will still point to the right note, but the heading anchor will be dropped.</li><li>Dangling links (pointing to a note that doesn't exist) and ambiguous links (same base name in 2+ notes) are unwrapped to plain text.</li></ul></li></ul>",- "_help_rC3pL2aptaRE": "<p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/2_Zen%20mode_image.png\"></p><p>Screenshot of Zen Mode activated on a Windows 11 system with native title bar off and background effects on.</p><p>When Zen Mode is activated (pictured on the side), most of the user interface of Trilium is hidden away in order to be able to focus on the content, whether it's for reading or writing.</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/1_Zen%20mode_image.png\"></p><p>Screenshot of the Zen Mode option in the global menu.</p><h2>Activating & deactivating</h2><p>The Zen Mode can be activated by accessing the global menu and selecting the “Zen Mode” option:</p><p>Aside from the global menu, it's also possible to activate this mode by using a keyboard shortcut (which is <kbd>F9</kbd> since TriliumNext 0.92.5 and <kbd>Alt</kbd>+<kbd>Z</kbd> for older versions). Look for <code>toggleZenMode</code> in the shortcut configuration.</p><p>Once Zen Mode is activated, all the UI elements of the application will be hidden away, including the global menu. In that case, the Zen Mode can be deactivated either by pressing the <span class=\"tn-icon bx bxs-yin-yang\"></span> icon in the top-right corner of the window or by pressing the keyboard combination again.</p><p>Do note that, by design, activating or deactivating the Zen Mode applies only to the current window. Restarting the application will also disable the Zen Mode.</p><h2>Moving the window around</h2><p>If “Native title bar” is activated, then the operating system's default title bar can be used to drag the window around. If deactivated, the window can still be moved by dragging the mouse across the top part of the window where the note titles are.</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Zen%20mode_image.png\"></p><p>Screenshot of two notes side-by-side while Zen Mode is active, on Windows 11 with background effects off.</p><h2>Split windows and tabs</h2><p>Tabs are completely hidden, however it's still possible to use keyboard shortcuts such as <code>firstTab</code> (<kbd>Ctrl</kbd>+<kbd>1</kbd> by default), <code>secondTab</code> (<kbd>Ctrl</kbd>+<kbd>2</kbd> by default). There are also some newer shortcuts such as <code>activateNextTab</code> (<kbd>Ctrl</kbd>+<kbd>Tab</kbd>) or <code>activatePreviousTab</code> (<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Tab</kbd>) that allow easy navigation, however make sure that they are configured properly in the settings.</p><p>For the split view of notes, there are no keyboard shortcuts at the time of writing, but it's still possible to have them in Zen Mode by creating the split while the Zen Mode is off and then reactivating it afterwards.</p>",+ "_help_rC3pL2aptaRE": "<p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/2_Zen%20mode_image.png\"></p><p>Screenshot of Zen Mode activated on a Windows 11 system with native title bar off and background effects on.</p><p>When Zen Mode is activated (pictured on the side), most of the user interface of Trilium is hidden away in order to be able to focus on the content, whether it's for reading or writing.</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/1_Zen%20mode_image.png\"></p><p>Screenshot of the Zen Mode option in the global menu.</p><h2>Activating & deactivating</h2><p>The Zen Mode can be activated by accessing the global menu and selecting the “Zen mode” option:</p><p>Aside from the global menu, it's also possible to activate this mode by using a keyboard shortcut (which is <kbd>F9</kbd> since TriliumNext 0.92.5 and <kbd>Alt</kbd>+<kbd>Z</kbd> for older versions). Look for <code>toggleZenMode</code> in the shortcut configuration.</p><p>Once Zen Mode is activated, all the UI elements of the application will be hidden away, including the global menu. In that case, the Zen Mode can be deactivated either by pressing the <span class=\"tn-icon bx bxs-yin-yang\"></span> icon in the top-right corner of the window or by pressing the keyboard combination again.</p><p>Do note that, by design, activating or deactivating the Zen Mode applies only to the current window. Restarting the application will also disable the Zen Mode.</p><h2>Moving the window around</h2><p>If “Native title bar” is activated, then the operating system's default title bar can be used to drag the window around. If deactivated, the window can still be moved by dragging the mouse across the top part of the window where the note titles are.</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Zen%20mode_image.png\"></p><p>Screenshot of two notes side-by-side while Zen Mode is active, on Windows 11 with background effects off.</p><h2>Split windows and tabs</h2><p>Tabs are completely hidden, however it's still possible to use keyboard shortcuts such as <code>firstTab</code> (<kbd>Ctrl</kbd>+<kbd>1</kbd> by default), <code>secondTab</code> (<kbd>Ctrl</kbd>+<kbd>2</kbd> by default). There are also some newer shortcuts such as <code>activateNextTab</code> (<kbd>Ctrl</kbd>+<kbd>Tab</kbd>) or <code>activatePreviousTab</code> (<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Tab</kbd>) that allow easy navigation, however make sure that they are configured properly in the settings.</p><p>For the split view of notes, there are no keyboard shortcuts at the time of writing, but it's still possible to have them in Zen Mode by creating the split while the Zen Mode is off and then reactivating it afterwards.</p>","_help_YzMcWlCVeW09": "<p><em>Active content</em> is a generic name for powerful features in Trilium, these range from customizing the UI to advanced scripting that can alter your notes or even your PC.</p><h2>Safe import</h2><p>Active content problem of safety, especially when this active content comes from a third-party such as if it is downloaded from a website and then imported into Trilium.</p><p>When <a href=\"#root/_help_mHbBMPDPkVV5\">importing</a> .zip archives into Trilium, <em>safe mode</em> is active by default which will try to prevent untrusted code from executing. For example, a <a href=\"#root/_help_MgibgPcfeuGz\">custom widget</a> needs the <code>#widget</code> <a href=\"#root/_help_HI6GBBIduIgv\">label</a> in order to function; safe import works by renaming that label to <code>#disabled:widget</code>.</p><h2>Safe mode</h2><p>Sometimes active content can cause issues with the UI or the server, preventing it from functioning properly. <a class=\"reference-link\" href=\"#root/_help_64ZTlUPgEPtW\">Safe mode</a> allows starting Trilium in such a way that active content is not loaded by default at start-up, allowing the user to fix the problematic scripts or widgets.</p><h2>Types of active content</h2><p>These are the types of active content in Trilium, along with a few examples of what untrusted content of that type could cause:</p><figure class=\"table\"><table><thead><tr><th>Name</th><th>Disabled on a safe <a href=\"#root/_help_mHbBMPDPkVV5\">import</a></th><th>Description</th><th>Potential risks of untrusted code</th></tr></thead><tbody><tr><td><a href=\"#root/_help_yIhgI5H7A2Sm\">Front-end scripts</a></td><td>Yes</td><td>Allow running arbitrary code on the client (UI) of Trilium, which can alter the user interface.</td><td>A malicious script can execute server-side code, access un-encrypted notes or change their contents.</td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a></td><td>Yes</td><td>Can add new UI features to Trilium, for example by adding a new section in the <a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>.</td><td>The UI can be altered in such a way that it can be used to extract sensitive information or it can simply cause the application to crash.</td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_SPirpZypehBG\">Backend scripts</a></td><td>Yes</td><td>Can run custom code on the server of Trilium (Node.js environment), with full access to the notes and the database.</td><td>Has access to all the unencrypted notes, but with full access to the database it can completely destroy the data. It also has access to execute other applications or alter the files and folders on the server).</td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_1vHRoWCEjj0L\">Web View</a></td><td>Yes</td><td>Displays a website inside a note.</td><td>Can point to a phishing website which can collect the data (for example on a log in page).</td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a></td><td>Yes</td><td>Renders custom content inside a note, such as a dashboard or a new editor that is not officially supported by Trilium.</td><td>Can affect the UI similar to front-end scripts or custom widgets since the scripts are not completely encapsulated, or they can act similar to a web view where they can collect data entered by the user.</td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_AlhDUqhENtH7\">Custom app-wide CSS</a></td><td>No</td><td>Can alter the layout and style of the UI using CSS, applied regardless of theme.</td><td>Generally less problematic than the rest of active content, but a badly written CSS can affect the layout of the application, requiring the use of <a class=\"reference-link\" href=\"#root/_help_64ZTlUPgEPtW\">Safe mode</a> to be able to use the application.</td></tr><tr><td><a href=\"#root/_help_pKK96zzmvBGf\">Custom themes</a></td><td>No</td><td>Can change the style of the entire UI.</td><td>Similar to custom app-wide CSS.</td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_gOKqSJgXLcIj\">Icon Packs</a></td><td>No</td><td>Introduces new icons that can be used for notes.</td><td>Generally are more contained and less prone to cause issues, but they can cause performance issues (for example if the icon pack has millions of icons in it).</td></tr></tbody></table></figure><h2>Active content badge</h2><p>If a note is considered to have active content, a badge is shown in the <a class=\"reference-link\" href=\"#root/_help_B5dihXRDksTk\">Note badges</a> area. Clicking the badge will reveal a menu with various options related to that content type, for example to open the documentation or to configure the execution of scripts.</p><p>For some active content types, such as backend scripts with custom triggering conditions a toggle button will appear. This makes it possible to easily disable scripts or widgets, but also to re-enable them if an import was made with safe mode active.</p>","_help_s3YCWHBfmYuM": "<h2>Choose the setup</h2><p><strong>Local only desktop/laptop</strong> - Allows a single instance on a desktop and will save the notes locally on that desktop.</p><ul><li><a class=\"reference-link\" href=\"#root/_help_poXkQfguuA0U\">Desktop Installation</a></li></ul><p><strong>Server with web only access</strong> - Installs the application on the server and allows access from any web browser on any device, including mobile.</p><ol><li><a class=\"reference-link\" href=\"#root/_help_WOcw2SLH6tbX\">Server Installation</a></li><li><a class=\"reference-link\" href=\"#root/_help_RDslemsQ6gCp\">Mobile Frontend</a> (optional)</li><li><a class=\"reference-link\" href=\"#root/_help_yeEaYqosGLSh\">Third-party cloud hosting</a></li></ol><p><strong>Combination of server and desktop/laptop</strong> - Install the application on both a server, for web access and data synchronisation, and desktop instance(s). This allows all the data to be stored on the server and either accessed from the web browser, or the desktop application. The desktop application will sync and store the data locally so that it can be used when offline.</p><ol><li><a class=\"reference-link\" href=\"#root/_help_WOcw2SLH6tbX\">Server Installation</a></li><li><a class=\"reference-link\" href=\"#root/_help_RDslemsQ6gCp\">Mobile Frontend</a> (optional)</li><li><a class=\"reference-link\" href=\"#root/_help_poXkQfguuA0U\">Desktop Installation</a></li><li><a class=\"reference-link\" href=\"#root/_help_cbkrhQjrkKrh\">Synchronization</a></li></ol>","_help_i6dbnitykE5D": "<h2>Inspiration for the name “Trilium”</h2><blockquote><p>Naming software is hard. I lived in Ontario when I first started the project and Trillium (the flower) is sort of a provincial logo, many institutions in Ontario are named \"Trillium [something]\". So I kept hearing/reading it almost everyday, I liked the sound of it and its nature motif, so I just reused it.</p><p><em>– Zadam (original Trilium maintainer)</em></p></blockquote><aside class=\"admonition note\"><p>Despite the fact that the Trillium flower has two “l\"s, the Trilium application only has one.</p></aside><h2>How do I create a folder?</h2><p>Trilium has no separate folder type: any note can have child notes, so any note can act as a folder. A note can hold its own content and have children at the same time, unlike a file system, which separates files from directories.</p><p>To organize notes into a folder:</p><ol><li>Create a note that acts as the folder, for example \"Projects\".</li><li>Right-click it in the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a> and select <em>Insert child note</em>, or hover over it and press the <span class=\"tn-icon bx bx-plus\"></span> button.</li><li>To move existing notes into it, drag them onto it in the tree.</li></ol><p>The children of a note are listed at the end of its content (see <a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a>).</p><p>If you want the note to look like a folder, with no content of its own and only its children shown, make it a collection instead: right-click in the tree, select <em>Insert child note</em> → <em>Collection</em>, then choose <a class=\"reference-link\" href=\"#root/_help_8QqnMzx393bx\">Grid View</a> or <a class=\"reference-link\" href=\"#root/_help_mULW0Q3VojwY\">List View</a>. See <a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a> for the other views, such as tables, boards and calendars.</p><h2>macOS support</h2><p>Originally, Trilium Notes considered the macOS build unsupported. TriliumNext commits to make the experience on macOS as good as possible.</p><p>if you find any platform-specific issues, feel free to <a href=\"#root/_help_wy8So3yZZlH9\">report them</a>.</p><h2>Translation / localisation support</h2><p>The original Trilium Notes application did not support multiple languages. Since we believe that internationalisation is a core part of an application, we have added support for it.</p><p>Contributions to translations are welcome.</p><h2>Multi-user support</h2><p>Common request is to allow multiple users collaborate, share notes etc. So far I'm resisting this because of these reasons:</p><ul><li>it's a huge feature, or rather a Pandora's box of collaboration features like user management, permissions, conflict resolution, real-time editing of a note by multiple people etc. This would be a huge amount of work. Trilium Notes is project made mostly by one person in free time and that's unlikely to change in the future.</li><li>given its size it would probably pivot the attention away from my main focus which is a personal note-taking</li><li>the assumption that only single person has access to the app simplifies many things, or just outright makes them possible. In multi-user app, our <a href=\"#root/_help_CdNpE2pqjmI6\">scripting</a>support would be a XSS security hole, while with the single user assumption it's an endless customizable tool.</li></ul><h2>How to open multiple documents in one Trilium instance</h2><p>This is normally not supported - one Trilium process can open only a single instance of a <a href=\"#root/_help_wX4HbRucYSDD\">database</a>. However, you can run two Trilium processes (from one installation), each connected to a separate document. To achieve this, you need to set a location for the <a href=\"#root/_help_tAassRL4RSQL\">data directory</a> in the <code>TRILIUM_DATA_DIR</code> environment variable and separate port on <code>TRILIUM_PORT</code> environment variable. How to do that depends on the platform, in Unix-based systems you can achieve that by running command such as this:</p><pre><code class=\"language-text-x-sh\">TRILIUM_DATA_DIR=/home/me/path/to/data/dir TRILIUM_PORT=12345 trilium </code></pre><p>You can save this command into a <code>.sh</code> script file or make an alias. Do this similarly for a second instance with different data directory and port.</p><h2>Can I use Dropbox / Google Drive / OneDrive to sync data across multiple computers.</h2><p>No.</p><p>These general purpose sync apps are not suitable to sync database files which are open and being worked on by another application. The result is that they will corrupt the database file, resulting in data loss and this message in the Trilium logs:</p><pre><code class=\"language-text-x-trilium-auto\">SqliteError: database disk image is malformed</code></pre><p>The only supported way to sync Trilium's data across the network is to use a <a href=\"#root/_help_cbkrhQjrkKrh\">sync/web server</a>.</p><h2>Why database instead of flat files?</h2><p>Trilium stores notes in a <a href=\"#root/_help_wX4HbRucYSDD\">database</a> which is an SQLite database. People often ask why doesn't Trilium rather use flat files for note storage - it's fair question since flat files are easily interoperable, work with SCM/git etc.</p><p>Short answer is that file systems are simply not powerful enough for what we want to achieve with Trilium. Using filesystem would mean fewer features with probably more problems.</p><p>More detailed answer:</p><ul><li><a href=\"#root/_help_IakOLONlIfGI\">clones</a> are what you might call \"hard directory link\" in filesystem lingo, but this concept is not implemented in any filesystem</li><li>filesystems make a distinction between directory and file while there's intentionally no such difference in Trilium</li><li>files are stored in no particular order and user can't change this</li><li>Trilium allows storing note <a href=\"#root/_help_zEY4DaJG4YT5\">attributes</a> which could be represented in extended user attributes but their support differs greatly among different filesystems / operating systems</li><li>Trilium makes links / relations between different notes which can be quickly retrieved / navigated (e.g. for <a href=\"#root/_help_BCkXAVs63Ttv\">note map</a>). There's no such support in file systems which means these would have to be stored in some kind of side-car files (mini-databases).</li><li>Filesystems are generally not transactional. While this is not completely required for a note-taking application, having transactions make it way easier to keep notes and their metadata in predictable and consistent state.</li></ul><h2>Search-related Questions</h2><h3>Why does search sometimes find results with typos?</h3><p>Trilium uses a progressive search strategy that includes fuzzy matching when exact matches return fewer than 5 results. This finds notes despite minor typos in your search query. You can use fuzzy search operators (<code>~=</code> for fuzzy exact match and <code>~*</code> for fuzzy contains). See the <a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a> documentation for details.</p><h3>How can I search for notes when I'm not sure of the exact spelling?</h3><p>Use the fuzzy search operators:</p><ul><li><code>#title ~= \"projct\"</code> - finds notes with titles like \"project\" despite the typo</li><li><code>note.content ~* \"algoritm\"</code> - finds content containing \"algorithm\" or similar words</li></ul><h3>Why do some search results appear before others with lower scores?</h3><p>Trilium places exact matches before fuzzy matches. When you search for \"project\", notes containing exactly \"project\" appear before notes with variations like \"projects\" or \"projection\", regardless of other scoring factors.</p><h3>How can I make my searches faster?</h3><ol><li>Use the \"Fast search\" option to search only titles and attributes (not content)</li><li>Limit search scope using the \"Ancestor\" field</li><li>Set a result limit to prevent loading too many results</li><li>For large databases, consider archiving old notes to reduce search scope</li></ol>",@@ -171,7 +171,7 @@"_help_KG48zgNY31NW": "<p>Since v0.105.0, office documents stored in Trilium display an inline preview of their content, without the need to download them or open them in an external application.</p><h2>Supported formats</h2><ul><li>Microsoft Office formats: Word (<code>.docx</code>), Excel (<code>.xlsx</code>) and PowerPoint (<code>.pptx</code>).</li><li>The OpenDocument alternatives to the previous formats (Text, Spreadsheet, Presentation), created by editors such as LibreOffice and OpenOffice.</li><li><a href=\"https://en.wikipedia.org/wiki/Rich_Text_Format\">Rich Text Format (RTF)</a>.</li><li><a href=\"https://en.wikipedia.org/wiki/EPUB\">EPUB</a> e-books.</li></ul><aside class=\"admonition note\"><p>Older Microsoft Office formats (<code>.doc</code>, <code>.xls</code>, <code>.ppt</code>) are not supported.</p></aside><h2>How it works</h2><p>The document is converted to a simplified representation on the server and rendered as read-only content, similar to a <a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a> note.</p><p>The preview generally preserves:</p><ul><li>Headings, paragraphs and text alignment.</li><li>Text formatting: bold, italic, underline, strikethrough, subscript/superscript, text and highlight colors, fonts and font sizes.</li><li>Bulleted and numbered lists.</li><li>Tables, including merged cells and cell background colors.</li><li>Embedded images.</li><li>Links and footnotes.</li></ul><p>To keep links readable regardless of the theme, the default hyperlink color applied automatically by word processors is ignored; links that were deliberately given a custom color by the author keep it.</p><h2>Limitations</h2><ul><li>The preview is read-only. To edit the document, download it or open it in an external application; the content of the note is not affected by the preview. Alternatively copy and paste it into a text note.</li><li>The preview is a simplified rendering: complex layouts (columns, text boxes, headers and footers), charts and the precise styling of table borders are not reproduced.</li><li>Documents larger than 20 MB are not previewed, to keep the server responsive. The usual download and open actions remain available.</li><li>If the document cannot be converted, a notice is displayed instead and the file can still be downloaded or opened externally.</li></ul><h2>Relation with other features</h2><ul><li>The same preview is used when an office document is displayed in the <a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a> or embedded in a text note via <a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>, as well as for office documents stored as <a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>.</li><li>Independently of the preview, the text content of office documents is also extracted in the background so that it can be found with <a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a> via <a class=\"reference-link\" href=\"#root/_help_TiQbQDgP8L5t\">Text Extraction (OCR)</a>.</li><li><code>.csv</code> and <code>.xlsx</code> files can be converted to <a class=\"reference-link\" href=\"#root/_help_GWHEkY4I4OE3\">Spreadsheets</a> via the <a href=\"#root/_help_mHbBMPDPkVV5\">import</a> function.</li></ul>","_help_GWHEkY4I4OE3": "<figure class=\"image\"><img style=\"aspect-ratio:1102/573;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Spreadsheets_image.png\" width=\"1102\" height=\"573\"></figure><aside class=\"admonition important\"><p>Spreadsheets are a new type of note introduced in v0.103.0 and are currently considered experimental/beta. As such, expect major changes to occur to this note type.</p></aside><p>Spreadsheets provide a familiar experience to Microsoft Excel or LibreOffice Calc, with support for formulas, data validation and text formatting.</p><h2>Spreadsheets vs. collections</h2><p>There is a slight overlap between spreadsheets and the <a class=\"reference-link\" href=\"#root/_help_2FvYrpmOXm29\">Table</a> collection. In general the table collection is useful to track meta-information about notes (for example a collection of people and their birthdays), whereas spreadsheets are quite useful for calculations since they support formulas.</p><p>Spreadsheets also benefit from a wider range of features such as data validation, formatting and can work on a relatively large dataset.</p><h2>Data intercompatibility (import/export)</h2><p>Starting with v0.104.0, Trilium provides a level of data intercompatibility between the internal format (Univer) and the following formats:</p><ul><li>Microsoft Excel (.xlsx)<ul><li>Preserves basic formatting (fonts, sizes, borders, backgrounds).</li><li>Formulas are preserved, but note that not all Excel functions are supported and vice-versa with Univer.</li><li>Images (cell-bound or floating), without preserving rotation.</li><li>Supports multi-sheets natively.</li></ul></li><li>Comma-Separated Values (.csv)<ul><li>Since it's a text-based format, any formatting is lost.</li><li>Formulas are evaluated and turned into their final value instead.</li><li>Multi-sheets spreadsheets are exported as a single ZIP containing a CSV file per sheet.</li></ul></li></ul><p>Both <a href=\"#root/_help_mHbBMPDPkVV5\">import and export</a> are supported, as follows:</p><ul><li>To import a file, simply drag it into the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a> and it will be converted into a spreadsheet note.<ul><li>To avoid this behavior (e.g. to import a .xlsx file as an actual <a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a>), uncheck the corresponding option in the <a href=\"#root/_help_mHbBMPDPkVV5\">Import dialog</a>.</li><li>Multiple files can be imported at the same time, including a mixture of .csv and .xlsx files. Folder structure can be preserved by using a .zip file.</li></ul></li><li>Unlike importing, exporting is on a per-note basis:<ul><li>In the <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>, choose the <em>Export to Excel</em> or <em>Export to CSV</em> options.</li><li>If exported as a single file via <a class=\"reference-link\" href=\"#root/_help_mHbBMPDPkVV5\">Import & Export</a>, the resulting file will be a custom <code>.triliumsheet</code> file that preserves the spreadsheet as-is.<ul><li>The export is intentionally a different process than the normal <a class=\"reference-link\" href=\"#root/_help_mHbBMPDPkVV5\">Import & Export</a> functionality because it does conversion to multiple formats with varying degrees of compatibility.</li></ul></li></ul></li></ul><p>Cells pasted from Excel or another application keep their formatting except for the font, so they use the spreadsheet's font like the rest of the cells.</p><aside class=\"admonition important\"><p>Import & export for both .xlsx and .csv files are supported on a best-effort basis. It does not support advanced features (data validation, scripting, etc.). If you notice a particular issue, it can be <a href=\"#root/_help_wy8So3yZZlH9\">reported</a>, however all bug reports must contain a sample file in order to be taken into consideration.</p></aside><h2>Supported features</h2><p>The spreadsheet has support for the following features:</p><ul><li>Since v0.104.0, images that can be either inside a cell or floating above.<ul><li>The images are saved as <a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a> for performance reasons.</li><li>The image upload respects the same compression settings as text <a class=\"reference-link\" href=\"#root/_help_mT0HEkOsz6i1\">Images</a>.</li></ul></li><li>Filtering</li><li>Sorting</li><li>Data validation</li><li>Conditional formatting</li><li>Notes / annotations</li><li>Find / replace</li></ul><p>We might consider adding <a href=\"https://docs.univer.ai/guides/sheets/features/filter\">other features</a> from Univer at some point. If there is a particular feature that can be added easily, it can be discussed over <a href=\"#root/_help_wy8So3yZZlH9\">GitHub Issues</a>.</p><h3>Share functionality</h3><p>Spreadsheets can be <a href=\"#root/_help_R9pX4DGra2Vt\">shared</a>, case in which a best-effort HTML rendering of the spreadsheet is done:</p><ul><li>Preserves basic formatting.</li><li>Cells with formulas display the precalculated value instead of the formula.</li></ul><p>Since v0.104.0:</p><ul><li>Numbers and dates are properly formatted.</li><li>Images are shown inside a cell or floating above, including rotation.</li></ul><p>For more advanced use cases, this will most likely not work as intended. Feel free to <a href=\"#root/_help_wy8So3yZZlH9\">report issues</a>, but keep in mind that we might not be able to have a complete feature parity with all the features of Univer.</p><h2>Features not supported yet</h2><h3>Regarding Pro features</h3><p>Univer spreadsheets also feature a <a href=\"https://univer.ai/pro\">Pro plan</a> which adds quite a lot of functionality such as charts, printing, pivot tables, export, etc.</p><p>As the Pro plan needs a license, Trilium does not support any of the premium features. Theoretically, pro features can be used in trial mode with some limitations, we might explore this direction at some point.</p><h3>Planned features</h3><p>There are a few features that are already planned but are not supported yet:</p><ul><li>Trilium-specific formulas (e.g. to obtain the title of a note).</li><li>User-defined formulas</li><li>Cross-workbook calculation</li></ul><p>If you would like us to work on these features, consider <a href=\"https://triliumnotes.org/en/support-us\">supporting us</a>.</p><h3>Mobile support</h3><p>Versions prior to v0.104.0 have no dedicated mobile support, which means that the interaction is difficult without a mouse and keyboard. Starting with v0.104.0 we integrate Univer's mobile plugin, which introduces feature such as drag to pan which makes the interface more usable on mobile.</p>","_help_6RM1Q7ppFVoj": "<p>Trilium has always supported Markdown through its <a href=\"#root/_help_Oau6X9rCuegd\">import feature</a>, however the file was either transformed to a <a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a> note (converted to Trilium's internal HTML format) or saved as a <a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a> note with only syntax highlight.</p><p>This note type is a split view, meaning that both the source code and a preview of the document are displayed side-by-side. See <a class=\"reference-link\" href=\"#root/_help_SL5f1Auq7sVN\">Note types with split view</a> for more information.</p><h2>Rationale</h2><p>The goal of this note type is to fill a gap: rendering Markdown but not altering its structure or its whitespace which would inevitably change otherwise through import/export.</p><p>Even if Markdown is now specially treated by having a preview mechanism, Trilium remains at its core a WYSWYG editor so Markdown will not replace text notes.</p><aside class=\"admonition note\"><p>Feature requests regarding the Markdown implementation will be considered, but if they are outside the realm of Trilium, they will not be implemented. One of the core aspects of the Markdown integration is that it reuses components that are already available through other features of the application.</p></aside><h2>Features</h2><h3>Source view pane</h3><ul><li>Syntax highlighting for the Markdown syntax.</li><li>Nested syntax highlighting for code inside code blocks, including <a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a> in <code>```mermaid</code> blocks.</li><li>When editing larger documents, the preview scrolls along with the source editor.</li></ul><h3>Preview pane</h3><p>The following features are supported by Trilium's Markdown format and will show up in the preview pane:</p><ul><li><p>All standard and GitHub-flavored syntax (basic formatting, tables, blockquotes).</p></li><li><p>Basic HTML is also supported (e.g. collapsible blocks using <code><details></code> and <code><summary></code>).</p></li><li><p>Code blocks with syntax highlight.</p><ul><li>The language must be specified for syntax highlight to be applied (e.g. <code>```js</code>).</li><li>Code blocks will respect the text wrapping from the <a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a> section in <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>.</li></ul></li><li><p><a class=\"reference-link\" href=\"#root/_help_NwBbFdNZ9h7O\">Block quotes & admonitions</a></p></li><li><p><a class=\"reference-link\" href=\"#root/_help_YfYAtQBcfo5V\">Math Equations</a> (both inline and block)</p></li><li><p><a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a> using <code>```mermaid</code></p></li><li><p><a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a> (no built-in Markdown syntax, but HTML syntax works just fine):</p><pre><code class=\"language-text-html\"><figure class=\"include-note\" data-note-id=\"vJDjQm0VK8Na\" data-box-size=\"expandable\">\n <figcaption>An optional caption, with <strong>HTML</strong> formatting</figcaption>\n</figure></code></pre><ul><li>The caption is optional. Markdown is not processed inside the HTML block, so format the caption with HTML tags.</li><li>Includes written as <code><section class=\"include-note\"></code>, the syntax of earlier versions, still work.</li><li>These can also be quickly created via the <code>/include</code> command or via a dedicated keyboard shortcut (not assigned by default).</li></ul></li><li><p><a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a> via its HTML syntax, or through a <em>Wikilinks</em>-like format (only <a class=\"reference-link\" href=\"#root/_help_m1lbrzyKDaRB\">Note ID</a>):</p><pre><code class=\"language-text-x-trilium-auto\">[[Hg8TS5ZOxti6]]</code></pre></li><li><p>To-do lists with extended task states:</p><figure class=\"table\"><table class=\"ck-table-resized\" style=\"border-style:none;\"><colgroup><col style=\"width:80.6%;\"><col style=\"width:19.4%;\"></colgroup><tbody><tr><td><pre><code class=\"language-text-x-markdown\">- [ ] None\n- [/] Doing\n- [X] Done\n- [?] Maybe\n- [-] Cancelled</code></pre></td><td><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:218/221;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Markdown_image.png\" width=\"218\" height=\"221\"></figure></td></tr></tbody></table></figure><p>Task states are customizable: you can reorder them, create new ones with different colors and symbols, or delete the ones you don't need. See <a class=\"reference-link\" href=\"#root/_help_i16PM6A7GXdU\">Customizing to-do task states</a> for more details.</p><p>Note that to-do items with task states other than \"None\" and \"Done\" are Trilium-specific and may not work well with other Markdown software.</p></li><li><p><a class=\"reference-link\" href=\"#root/_help_AgjCISero73a\">Footnotes</a> are also supported via the corresponding Markdown syntax:</p><pre><code class=\"language-text-x-trilium-auto\">This is [^1], while this is [^2].\n\n[^1]: the first footnote\n[^2]: the second footnote</code></pre><ul><li>These can also be quickly created using the <code>/footnote</code> command.</li></ul></li><li><p>Page breaks for <a class=\"reference-link\" href=\"#root/_help_NRnIZmSMc5sj\">Printing & Exporting as PDF</a>:</p><pre><code class=\"language-text-x-trilium-auto\"><div class=\"page-break\"></div></code></pre></li><li><p>Highlights (background color) are supported both via the <code>==</code> Markdown syntax, as well as the canonical HTML representation in Trilium:</p><pre><code class=\"language-text-x-trilium-auto\">==highlighted==\n<span style=\"background-color:#e5e64d;--tn-background:#e5e64d;\">Highlighted</span></code></pre></li></ul><h3>Links</h3><p>Multiple types of links are supported:</p><ul><li><p>Web URLs can be written with the standard Markdown syntax:</p><pre><code class=\"language-text-x-trilium-auto\">[Wikipedia](https://www.wikipedia.org)</code></pre></li><li><p><a href=\"#root/_help_hrZ1D00cLbal\">Reference link</a> to other notes with dynamic title, either by manually entering the note ID or via the <em>Add link</em> dialog:</p><pre><code class=\"language-text-x-trilium-auto\">[[B9oMG6rFvvfq]]</code></pre></li><li><p><a href=\"#root/_help_hrZ1D00cLbal\">Reference link</a> to other notes with a custom text:</p><pre><code class=\"language-text-x-trilium-auto\">[This is a link](#root/LhtnZxtVsUMp)</code></pre></li></ul><p>To create a link, either:</p><ul><li>Type it manually using the syntax described above.</li><li>Use the <em>Add link</em> dialog by pressing <kbd>Ctrl</kbd>+<kbd>L</kbd> or typing the <code>/link</code> command.</li></ul><p><a class=\"reference-link\" href=\"#root/_help_UmgZAfcltxkS\">Link Previews</a> are also rendered, but there is no mechanism to insert them automatically as of now, they have to be copied from a <a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a> note instead.</p><h3>Keyboard shortcuts</h3><p>The Markdown notes share some of the keyboard shortcuts from <a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a> notes:</p><ul><li><em>Cut to note</em> (<kbd>Ctrl</kbd>+<kbd>X</kbd>) which cuts the selection into a new child note.</li><li><em>Add link</em> (<kbd>Ctrl</kbd>+<kbd>L</kbd>) which shows the dialog to create external or reference links.</li><li><em>Date/time</em> (<kbd>Alt</kbd>+<kbd>T</kbd>) which respects the same formatting as text notes.</li><li><em>Include note</em> (not assigned by default), which triggers the same dialog to insert notes as the one for text notes.</li></ul><p>In addition, the following formatting keyboard shortcuts are available:</p><ul><li><kbd>Ctrl</kbd>+<kbd>B</kbd> to toggle <strong>bold</strong>.</li><li><kbd>Ctrl</kbd>+<kbd>I</kbd> to toggle <em>italic</em>.</li><li><kbd>Ctrl</kbd>+<kbd>M</kbd> to wrap the current selection in an inline math (<code>$</code>).</li><li><kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>X</kbd> to toggle <del>strikethrough</del>.</li></ul><h3>Images & attachments</h3><p>Images can be inserted into the document in four different methods:</p><ul><li>Drag & drop directly into the editor area.</li><li>Pasting an image from clipboard.</li><li>Pasting a reference to another <a href=\"#root/_help_0vhv7lsOLy82\">attachment</a> (e.g. <em>Copy reference to clipboard</em> button).</li><li>Use the <code>/image</code> slash command.</li></ul><p>An image reference to an attachment looks like this:</p><pre><code class=\"language-text-x-trilium-auto\"></code></pre><h3>Auto-completion</h3><h4>Slash commands</h4><p>Just like <a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a> notes, Markdown notes support a selection of slash commands:</p><ul><li>Inserting the current date & time (<code>/date</code>).</li><li><a href=\"#root/_help_nBAXQFj20hS1\">Including</a> another note (<code>/include</code>).</li><li>Uploading and inserting an image (<code>/image</code>).</li><li>Inserting a note link (<code>/link</code>).</li><li>Inserting a math equation block (<code>/math</code>).</li><li>Inserting a <a href=\"#root/_help_AgjCISero73a\">footnote</a> (<code>/footnote</code>).</li><li>Inserting a <a href=\"#root/_help_s1aBHPd79XYj\">Mermaid</a> diagram (<code>/mermaid</code>), with one variant per sample template (e.g. <code>/mermaid:flowchart</code>).</li><li>Inserting a collapsible block (<code>/collapsible</code>).</li><li>Inserting <a href=\"#root/_help_rJ9grSgoExl9\">tabs</a> (<code>/tabs</code>).</li><li>Inserting a page break for printing (<code>/page-break</code>).</li><li>Inserting a table (<code>/table</code>).</li><li>Creating admonitions (e.g. <code>/tip</code>, <code>/note</code>, <code>/important</code>, <code>/caution</code>, <code>/warning</code>).</li><li>Inserting task items (<code>/todo:<state></code>, e.g. <code>/todo:done</code>), one per configured task state.</li><li>Inserting code snippets (<code>/snippet:<name></code>) from your Markdown/plain-text snippet notes.</li></ul><p>The list shows each command by its title, as in Text notes. Typing a command's title, its keyword (as listed above) or a related word such as <code>latex</code> or <code>grid</code> finds it.</p><p>Note that slash commands only work outside of code blocks and inline code.</p><h4>Linking notes with <code>@</code> or <code>[[</code></h4><p>As in <a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a> notes, typing <code>@</code> at the start of a line or after a space opens the note search. Picking a note replaces what was typed with a link to it in the Wikilinks-like format (<code>[[noteId]]</code>), which the preview shows as an <a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a> with the note's title.</p><p>The search runs on everything typed after the <code>@</code>, spaces included, so a title such as <code>@My meeting notes</code> can be typed out; press <kbd>Esc</kbd> to close the list and go on writing. If no note fits, the list offers to create one, as a child of the Markdown note or in the inbox; the link is inserted once the note is created.</p><p>You can also start typing the link directly: <code>[[</code> opens the same list, and closing the brackets yourself dismisses it. To change where an existing link points, place the cursor inside it and pick another note.</p><p>Like slash commands, <code>@</code> and <code>[[</code> do nothing inside code blocks and inline code.</p><p>In the editor, a <code>[[noteId]]</code> link shows as the note's icon and title, so you can tell which note it points to without looking up its ID. Clicking it, or moving the cursor next to it, shows the link as written so it can be edited. Links inside code blocks and inline code are left as they are.</p><h4>Code block language auto-completion</h4><p>Starting with v0.104.0, typing ``` to insert a code block will automatically open a list of suggested language types which have syntax highlighting.</p><p>The list of languages matches the one for <a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a> notes set in <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>, it's not the full list of languages supported by Trilium.</p><h3>Other features</h3><ul><li>The <a class=\"reference-link\" href=\"#root/_help_BFvAtE74rbP6\">Table of contents</a> will be displayed in the <a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a> based on the Markdown-level headings.</li><li>A Markdown note included in a <a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a> note shows its source, its preview or both, and can be edited in place. See <em>Included Markdown</em> in <a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>.</li></ul><h3>Shared notes</h3><p>When a Markdown note is <a href=\"#root/_help_R9pX4DGra2Vt\">shared publicly</a>, it will be rendered with extended formatting just like <a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a> notes.</p><p>Most of the features described previously should be supported. If you face any issues, feel free to <a href=\"#root/_help_wy8So3yZZlH9\">report it</a> alongside a sample Markdown file.</p><h2>Creating Markdown notes</h2><p>There are two ways to create a Markdown note:</p><ol><li>Create a new note (e.g. in the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>) and select the type <em>Markdown</em>, just like all the other note types.</li><li>Create a note of type <a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a> and select as the language either <em>Markdown</em> or <em>GitHub-Flavored Markdown</em>. This maintains compatibility with your existing notes prior to the introduction of this feature.</li></ol><aside class=\"admonition note\"><p>There is no distinction between the new Markdown note type and code notes of type Markdown; internally both are represented as <a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a> notes with one of the following MIME types:</p><ul><li><code>text/markdown</code></li><li><code>text/x-markdown</code></li><li><code>text/x-gfm</code> (GitHub Flavored Markdown)</li></ul></aside><h2>Import/export</h2><h3>Import</h3><p>By default, when importing a single Markdown file it automatically gets converted to a <a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a> note. To avoid that and have it imported as a Markdown note instead:</p><ul><li>Right click the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a> and select <em>Import into note</em>.</li><li>Select the file normally.</li><li>Uncheck <em>Import HTML, Markdown and TXT as text notes if it's unclear from the metadata</em>.</li></ul><p>When importing a Trilium ZIP, it will preserve the Markdown type without converting to text notes thanks to the meta-information in it.</p><h3>Exporting</h3><p>When exporting Markdown files, the extension is preserved and the content remains the same as in the source view (with some small exceptions such as handling of attachments).</p><p>When exporting Markdown files as ZIP, choosing HTML or Markdown as the export format makes no difference as that only affects <a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a> notes.</p><p>If the Markdown note contains attachments, a ZIP export will rewrite the links to attachments so that they are replaced with a relative path to the attachment. On import, the links are re-written back.</p><h2>Conversion between text notes and Markdown notes</h2><p><a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a> notes can be converted into Markdown notes and vice versa. See <a class=\"reference-link\" href=\"#root/_help_jludwdW7N4hg\">Converting between note types</a>.</p><h2>Sync-scrolling & block highlight</h2><p>When scrolling through the editing pane, the preview pane will attempt to synchronize its position to make it easier to see the preview.</p><p>In addition, the block in the preview matching the position of the cursor in the source view will appear slightly highlighted.</p><p>The sync is currently one-way only, scrolling the preview will not synchronize the position of the editor.</p><p>This feature cannot be disabled as of now; if the scrolling feels distracting, consider temporarily switching to the editor mode and then switching to preview mode when ready.</p><aside class=\"admonition note\"><p>This feature of synchronizing the scroll is based on blocks but it's provided on a best-effort basis since our underlying Markdown library doesn't support this feature natively, so we had to implement our own algorithm. Feel free to <a href=\"#root/_help_wy8So3yZZlH9\">report issues</a>, but always provide a sample Markdown file to be able to reproduce it.</p></aside>",- "_help_jludwdW7N4hg": "<p>A note's type may be converted to another:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a> notes to <a class=\"reference-link\" href=\"#root/_help_6RM1Q7ppFVoj\">Markdown</a> notes</li><li>Markdown notes to Text notes</li></ul><p>Before conversion, a revision is saved automatically, so you can restore the original or recover any missing elements from it if the conversion produces undesired results. Read more about <a class=\"reference-link\" href=\"#root/_help_vZWERwf8U3nx\">Note Revisions</a>.</p><h2>Converting individual notes</h2><h3>Markdown to Text Note</h3><p>Markdown notes can be converted to Text Notes with negligible loss of formatting fidelity.</p><p>To do so, go to the <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> → <em>Advanced</em> and select <em>Convert to Text Note</em>.</p><h3>Text Note to Markdown</h3><aside class=\"admonition warning\"><p>Since Markdown does not support all the capabilities of Text notes, this conversion is lossy in terms of formatting: some formatting may be lost, and some unsupported elements may even be dropped. It's strongly recommended that you inspect the content for any information that might have gone missing after the conversion.</p></aside><p>To convert a text note to Markdown, go to the <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> → <em>Advanced</em> and select <em>Convert to Markdown Note</em>.</p><h2>Converting multiple notes</h2><p>A note type conversion can also be performed on an entire subtree or a set of multiple notes using <a class=\"reference-link\" href=\"#root/_help_ivYnonVFBxbQ\">Bulk Actions</a>.</p>",+ "_help_jludwdW7N4hg": "<p>A note's type may be converted to another:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a> notes to <a class=\"reference-link\" href=\"#root/_help_6RM1Q7ppFVoj\">Markdown</a> notes</li><li>Markdown notes to Text notes</li></ul><p>Before conversion, a revision is saved automatically, so you can restore the original or recover any missing elements from it if the conversion produces undesired results. Read more about <a class=\"reference-link\" href=\"#root/_help_vZWERwf8U3nx\">Note Revisions</a>.</p><h2>Converting individual notes</h2><h3>Markdown to Text Note</h3><p>Markdown notes can be converted to Text Notes with negligible loss of formatting fidelity.</p><p>To do so, go to the <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> → <em>Advanced</em> and select <em>Convert to text note</em>.</p><h3>Text Note to Markdown</h3><aside class=\"admonition warning\"><p>Since Markdown does not support all the capabilities of Text notes, this conversion is lossy in terms of formatting: some formatting may be lost, and some unsupported elements may even be dropped. It's strongly recommended that you inspect the content for any information that might have gone missing after the conversion.</p></aside><p>To convert a text note to Markdown, go to the <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> → <em>Advanced</em> and select <em>Convert to Markdown note</em>.</p><h2>Converting multiple notes</h2><p>A note type conversion can also be performed on an entire subtree or a set of multiple notes using <a class=\"reference-link\" href=\"#root/_help_ivYnonVFBxbQ\">Bulk Actions</a>.</p>","_help_GTwFsgaA0lCt": "<p>Collections are a unique type of note that don't have content, but instead display their child notes in various presentation methods.</p><h2>Main collections</h2><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bx-calendar\"></span> Calendar</p><div class=\"trilium-tab-panel\"><p><a class=\"reference-link\" href=\"#root/_help_xWbu3jpNWapp\">Calendar</a> displays a week, month or year calendar with the notes being shown as events. New events can be added easily by dragging across the calendar.</p><figure class=\"image\"><img style=\"aspect-ratio:1651/810;\" src=\"{{helpAssets}}/User%20Guide/Collections_collection_calendar.webp\" width=\"1651\" height=\"810\"></figure></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bx-table\"></span> Table</p><div class=\"trilium-tab-panel\"><p><a class=\"reference-link\" href=\"#root/_help_2FvYrpmOXm29\">Table</a> displays each note as a row in a table, with <a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a> being shown as well. This makes it easy to visualize attributes of notes, as well as making them easily editable.</p><figure class=\"image\"><img style=\"aspect-ratio:1643/647;\" src=\"{{helpAssets}}/User%20Guide/Collections_collection_table.webp\" width=\"1643\" height=\"647\"></figure></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bx-columns\"></span> Kanban Board</p><div class=\"trilium-tab-panel\"><p><a class=\"reference-link\" href=\"#root/_help_CtBQqbwXDx1w\">Kanban Board</a> displays notes in columns, grouped by the value of a label. Items and columns can easily be created or dragged around to change their status.</p><figure class=\"image\"><img style=\"aspect-ratio:1174/850;\" src=\"{{helpAssets}}/User%20Guide/Collections_collection_board.webp\" width=\"1174\" height=\"850\"></figure></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bx-map-alt\"></span> Geo Map</p><div class=\"trilium-tab-panel\"><p><a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map</a> which displays a geographical map in which the notes are represented as pins on the map. New markers can be easily added by pointing on the map. In addition <a href=\"#root/_help_C2H9HK4BzwG7\">shapes</a> such as paths, rectangles and circles can be added, as well as GPX tracks.</p><figure class=\"image\"><img style=\"aspect-ratio:844/639;\" src=\"{{helpAssets}}/User%20Guide/Collections_collection_geomap.webp\" width=\"844\" height=\"639\"></figure></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bx-slideshow\"></span> Presentation</p><div class=\"trilium-tab-panel\"><p><a class=\"reference-link\" href=\"#root/_help_zP3PMqaG71Ct\">Presentation</a> which shows each note as a slide and can be presented full-screen with smooth transitions or exported to PDF for sharing.</p><figure class=\"image\"><img style=\"aspect-ratio:1120/763;\" src=\"{{helpAssets}}/User%20Guide/Collections_collection_presentation.webp\" width=\"1120\" height=\"763\"></figure></div></section></div><h2>Classic collections</h2><p>Classic collections are read-only mode and compiles the contents of all child notes into one continuous view. This makes it ideal for reading extensive information broken into smaller, manageable segments.</p><ul><li><a class=\"reference-link\" href=\"#root/_help_8QqnMzx393bx\">Grid View</a> which is the default presentation method for child notes (see <a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a>), where the notes are displayed as tiles with their title and content being visible.</li><li><a class=\"reference-link\" href=\"#root/_help_mULW0Q3VojwY\">List View</a> is similar to <a class=\"reference-link\" href=\"#root/_help_8QqnMzx393bx\">Grid View</a>, but it displays the notes one under the other with the content being expandable/collapsible, but also works recursively.</li></ul><p>Classic collections make use of pagination to support a large number of notes. The size of a page can be customized via <code>pageSize</code>.</p><h2>Creating a new collection</h2><p>To create a new collection, right-click a note in the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a> and select <em>Insert child note</em> → <em>Collection</em> → the desired type.</p><p>By default, collections come with a default configuration and sometimes even sample notes. To create a collection completely from scratch:</p><ol><li>Create a new note of type <em>Text</em> (or any type).</li><li>Change the <a href=\"#root/_help_KSZ04uQ2D1St\">note type</a> to <em>Collection</em>.</li><li>In <a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>, select the desired view type.</li><li>Consult the help page of the corresponding view type in order to understand how to configure them.</li></ol><h2>Configuration</h2><p>To change the configuration of a collection or even switch to a different collection (e.g. from Kanban Board to a Calendar), see the <a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a> bar at the top of the note.</p><h2>Archived notes</h2><p>By default, <a href=\"#root/_help_MKmLg5x6xkor\">archived notes</a> will not be shown in collections. This behavior can be changed by going to <a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a> and checking <em>Show archived notes</em>.</p><p>Archived notes will be generally indicated by being greyed out as opposed to the normal ones.</p><h2>Hiding the child notes from the note tree</h2><p>For collections with a large number of items, it can be helpful to hide the items from the note tree for performance reasons and to reduce clutter. This is especially useful for standalone collections, such as a geomap or a task board.</p><p>To do so, go to <a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a> and select <em>Hide child notes in tree</em>.</p><h2>Advanced use cases</h2><h3>Adding a description to a collection</h3><p>To add a text before the collection, for example to describe it:</p><ol><li>Create a new collection.</li><li>Change the <a href=\"#root/_help_KSZ04uQ2D1St\">note type</a> from <em>Collection</em> to <em>Text</em>.</li></ol><p>Now the text will be displayed above while still maintaining the collection view.</p><p>The only downside to this method is that <a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a> will not be shown anymore. In this case, modify the attributes manually or switch back temporarily to the <em>Collection</em> type for configuration purposes.</p><h3>Using saved search</h3><p>Collections, by default, only display the child notes. However, it is possible to use the <a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a> functionality to display notes all across the tree, with advanced querying functionality.</p><p>To do so, simply start a <a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a> and go to the <a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a> and select a desired type of collection. To keep the search-based collection, use a <a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a>.</p><aside class=\"admonition important\"><p>While in search, none of the collections will not display the child notes of the search results. The reason is that the search might hit a note multiple times, causing an exponential rise in the number of results.</p></aside><h2>Under the hood</h2><p>Collections by themselves are simply notes with no content that rely on the <a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a> mechanism (the one that lists the children notes at the bottom of a note) to display information.</p><p>By default, new collections use predefined <a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a> that are stored safely in the <a class=\"reference-link\" href=\"#root/_help_2mUhVmZK8RF3\">Hidden Notes</a> to define some basic configuration such as the type of view, but also some <a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a> to make editing easier.</p><p>Collections don't store their configuration (e.g. the position on the map, the hidden columns in a table) in the content of the note itself, but as attachments.</p>","_help_xWbu3jpNWapp": "<figure class=\"image\"><img style=\"aspect-ratio:2016/1413;\" src=\"{{helpAssets}}/User%20Guide/Collections/1_Calendar_image.png\" width=\"2016\" height=\"1413\"></figure><p>The Calendar view will display each child note in a calendar that has a start date and optionally an end date, as an event.</p><p>The Calendar view has multiple display modes:</p><ul><li>Month view, where the entire month is displayed and all-day events can be inserted. Both time-specific events and all-day events are listed.</li><li>Week view, where all the 7 days of the week (or 5 if the weekends are hidden) are displayed in columns. This mode allows entering and displaying time-specific events, not just all-day events.</li><li>Day view, which views only a single day. Especially useful for heavy agendas or mobile views.</li><li>List view, which displays all the events of a given month in sequence.</li><li>Year view, which displays the entire year for quick reference.</li></ul><p>Unlike other Collection view types, the Calendar view also allows some kind of interaction, such as moving events around as well as creating new ones.</p><h2>Creating a calendar</h2><p>Right click on an existing note in the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a> and select <em>Insert child note</em> → <em>Collection</em> → <em>Calendar</em>.</p><h2>Creating a new event/note</h2><p>To create a new event:</p><ul><li>First, click the desired day (month & year views) or the desired timeslot (day view).</li><li>Alternatively, drag across multiple days (or time slots) to set both the start and end date.</li></ul><p>In either cases, a small popup will show with a prompt for a title and the date & time of the event that will be created. The date and time can be changed there the same way as in the popup view of an existing event (see below).</p><p>At this point, the event hasn't been created yet to protect against accidental clicks. Add a title optionally and press the <em>Create</em> button. If no title is provided, the event will follow the <a class=\"reference-link\" href=\"#root/_help_47ZrP6FNuoG8\">Default Note Title</a> rules.</p><p>The <span class=\"tn-icon bx bx-detail\"></span> template field below the date and time shows the note type or template the event's note is made from. To make the event from another one, press the field and select it from the list; the calendar remembers the choice for the next event. Select <em>More templates…</em> to change which templates are listed (see <a href=\"#event-templates\">Event templates</a>). The date and time entered for the event replace any dates and times the template carries.</p><p>To give the event a time before creating it (for example, after clicking a day in the month view), press <em>Add time</em> and set the start and end time; the duration is shown to the right of them. To make the event all-day again, press the <span class=\"tn-icon bx bx-x\"></span> button at the end of the row. Adding or removing a time keeps the dates, so an event can start at a time on one day and end at a time on another (for example, a night shift). Changing the start date or time moves the end by the same amount, keeping the duration. An empty end date means the event ends on the day it starts; setting the end time before the start time moves the end date to the next day.</p><p>After creating the event, it will show up on the calendar. To edit the content of the event (including recurrence), click on it to bring it into the popup view.</p><aside class=\"admonition note\"><p>Creating new notes from the calendar will respect the <code>~child:template</code> relation if set on the Collection note.</p></aside><h2>Interacting with events</h2><ul><li>Hovering the mouse over an event will display information about the note.<br><img src=\"{{helpAssets}}/User%20Guide/Collections/4_Calendar_image.png\"></li><li>Left clicking the event will open a dedicated popup to quickly configure the event or edit its note content.</li><li>Right click will offer more options including opening the note in a new split or window.</li><li>Drag and drop an event on the calendar to move it to another day.</li><li>The length of an event can be changed by placing the mouse to the right edge of the event and dragging the mouse around.</li></ul><p>On a <a href=\"#root/_help_CoFPLs3dRlXc\">read-only</a> calendar, events can't be dragged, resized or created, their context menu only offers the places to open them in, and the button to pin the current date is hidden. Switching between the month, week and day views still works, but the choice isn't saved.</p><h3>Popup view</h3><p>When an event is clicked, a popup will show near the event which contains the following inforamtion:</p><ul><li>The title and icon of the event, both editable.</li><li>Buttons to interact with the event:<ul><li>Open the event in the same pane, new tab, etc.</li><li>Color picker to change the color of the event.</li><li>Button to remove the event from the calendar, which can optionally delete its corresponding note.</li></ul></li><li>Calendar-specific features:<ul><li>The start date and, for an event spanning several days, the end date.</li><li>The start and end time with the duration to the right of them, and a <span class=\"tn-icon bx bx-x\"></span> button that removes the time, making the event all-day. An all-day event shows an <em>Add time</em> button instead.</li><li>A full recurrence editor, opened from the dropdown below the time, to have the same event show up weekly, monthly, etc.</li></ul></li><li>The <a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a> of the marker, if any.</li><li>The note's content which can be edited directly from the panel.</li></ul><p>To dismiss the popup:</p><ul><li>Press the X button at the top-right of the popup.</li><li>In the calendar, press anywhere outside the popup.</li><li>Or simply press the <kbd>Escape</kbd> key.</li></ul><p>It is possible to switch between events by clicking on them even when the popup view is already open.</p><p>Events can have <a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a> between them and clicking on such a link will automatically navigate the calendar to the right date and the popup view to the new note.</p><h2>Interaction on mobile</h2><p>When Trilium is on mobile, the interaction with the calendar is slightly different:</p><ul><li>Clicking on an event displays the popup view, which allows editing the event.</li><li>Long-presing an event triggers the contextual menu, including the option to open in <a class=\"reference-link\" href=\"#root/_help_ZjLYv08Rp3qC\">Quick edit</a>.</li><li>To insert a new event, touch and hold the empty space. When successful, the empty space will become colored to indicate the selection.<ul><li>Before releasing, drag across multiple spaces to create multi-day events.</li><li>When released, a prompt will appear to enter the note title.</li></ul></li><li>To move an existing event, touch and hold the event until the empty space near it will become colored.<ul><li>At this point the event can be dragged across other days on the calendar.</li><li>Or the event can be resized by tapping on the small circle to the right end of the event.</li><li>To exit out of editing mode, simply tap the empty space anywhere on the calendar.</li></ul></li></ul><h2>Configuring the calendar view</h2><p>In the <a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>, it's possible to:</p><ul><li>Hide weekends from the week view.</li><li>Display week numbers on the calendar.</li><li>Hide routine events from the month, year and list views (see <a href=\"#hiding-routine-events\">Hiding routine events</a>).</li><li>Set the slot duration (the length of each time row in day/week view).</li><li>Set the slot label interval (how often time labels appear on the axis in day/week view).</li></ul><p>The same settings are also listed under <em>General</em> in the <span class=\"tn-icon bx bx-cog\"></span> <em>Calendar properties</em> dialog (see <a href=\"#event-templates\">Event templates</a> for how to open it). The time slots are listed there whichever view the calendar is in. Its <em>Included notes</em> section sets whether archived notes are shown and how deep the calendar looks for events (see <a href=\"#limiting-the-depth\">Limiting the depth</a>).</p><h3>Event templates</h3><p>By default, a new event is a <a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a> note. To make events from other note types, or from <a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a> with predefined content and attributes (such as a color), open the <span class=\"tn-icon bx bx-cog\"></span> <em>Calendar properties</em> dialog from the <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> or from the settings menu of the <a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>, and find <em>Event templates</em>. Here you can:</p><ul><li>Include a note type or note template already created in your knowledge base by pressing the <span class=\"tn-icon bx bx-list-plus\"></span> <em>Add existing template</em> button and then selecting the desired note type or template.</li><li>Create a new template by pressing the <span class=\"tn-icon bx bx-plus\"></span> <em>Create a new template</em> button. The template is created as a child of the calendar, and is not shown as an event.</li><li>Press the <span class=\"tn-icon bx bx-x\"></span> button to remove a template from the list. The template is removed only from the list, not deleted.</li><li>Press the <span class=\"tn-icon bx bx-dots-vertical-rounded\"></span> button of a custom template to edit, open in a new window, duplicate, or delete it.</li><li>Drag a template by its handle to reorder the list shown when creating an event.</li></ul><p>The dialog is not available on a read-only calendar, or on a calendar marked with <code>#calendarRoot</code> or <code>#workspaceCalendarRoot</code> (see <a href=\"#using-with-the-journal--calendar\">Using with the Journal / calendar</a>).</p><h3>Event attributes</h3><p>Events can show the values of their attributes below their title, in the month view, and in the week and day views for all-day events and for timed ones tall enough to hold them. To choose which attributes are shown, open the <span class=\"tn-icon bx bx-cog\"></span> <em>Calendar properties</em> dialog (see <a href=\"#event-templates\">Event templates</a> for how to open it) and find <em>Event attributes</em>. It lists the <a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a> the calendar defines, and those its events define themselves. Here you can:</p><ul><li>Turn an attribute on to show it on the events. New attributes are hidden until you turn them on, which keeps the calendar from getting cluttered.</li><li>Drag an attribute by its handle to change the order in which the events show them.</li><li>Create a new attribute, which is shown on the events right away, or edit or delete one the calendar defines.</li></ul><p>The dates, times and recurrence of the events are not listed, as the calendar always shows them itself.</p><p>If an event has a <code>#calendar:displayedAttributes</code> label, including one inherited from the calendar, the attributes listed in that label are shown instead.</p><h2>Configuring the calendar using attributes</h2><p>The following attributes can be added to the Collection type:</p><figure class=\"table\"><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><code>#calendar:hideWeekends</code></td><td>When present (regardless of value), it will hide Saturday and Sundays from the calendar.</td></tr><tr><td><code>#calendar:weekNumbers</code></td><td>When present (regardless of value), it will show the number of the week on the calendar.</td></tr><tr><td><code>#calendar:hideRoutineEvents</code></td><td>When present (regardless of value), it will hide routine events from the month, year and list views. See <a href=\"#hiding-routine-events\">Hiding routine events</a>.</td></tr><tr><td><code>#calendar:initialDate</code></td><td>Change the date the calendar opens on. When not present, the calendar opens on the current date.</td></tr><tr><td><code>#calendar:view</code></td><td><p>Which view to display in the calendar:</p><ul><li><code>timeGridDay</code> for the <em>day</em> view;</li><li><code>timeGridWeek</code> for the <em>week</em> view;</li><li><code>dayGridMonth</code> for the <em>month</em> view;</li><li><code>multiMonthYear</code> for the <em>year</em> view;</li><li><code>listMonth</code> for the <em>list</em> view.</li></ul><p>Any other value will be dismissed and the default view (month) will be used instead.</p><p>The value of this label is automatically updated when changing the view using the UI buttons.</p></td></tr><tr><td><code>#calendar:slotDuration</code></td><td>Sets how long each timeslot is on the calendar. Defaults to <code>00:15:00</code> (15 minutes). Must have the format \"HH:MM:SS\". For example, to create timeslots for every 10 minutes, you would set <code>#calendar:slotDuration=\"00:10:00\"</code>.</td></tr><tr><td><code>#calendar:slotLabelInterval</code></td><td>Sets how often the timeslots on the calendar should be labeled. Defaults to <code>01:00:00</code> (1 hour). Must have the format \"HH:MM:SS\". For example, to label timeslots every 30 minutes, you would set <code>#calendar:slotLabelInterval=\"00:30:00\"</code>.</td></tr><tr><td><code>~child:template</code></td><td>Defines the template for newly created notes in the calendar (via dragging or clicking).</td></tr></tbody></table></figure><p>In addition, the first day of the week can be either Sunday or Monday and can be adjusted from the application settings.</p><h2>Configuring the calendar events using attributes</h2><p>For each note of the calendar, the following attributes can be used:</p><figure class=\"table\"><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><code>#startDate</code></td><td>The date the event starts, which will display it in the calendar. The format is <code>YYYY-MM-DD</code> (year, month and day separated by a minus sign).</td></tr><tr><td><code>#endDate</code></td><td>Similar to <code>startDate</code>, mentions the end date if the event spans across multiple days. The date is inclusive, so the end day is also considered. The attribute can be missing for single-day events.</td></tr><tr><td><code>#startTime</code></td><td>The time the event starts at. If this value is missing, then the event is considered a full-day event. The format is <code>HH:MM</code> (hours in 24-hour format and minutes).</td></tr><tr><td><code>#endTime</code></td><td>Similar to <code>startTime</code>, it mentions the time at which the event ends (in relation with <code>endDate</code> if present, or <code>startDate</code>).</td></tr><tr><td><code>#recurrence</code></td><td>This is an optional CalDAV <code>RRULE</code> string that if present, determines whether a task should repeat or not. Note that it does not include the <code>DTSTART</code> attribute, which is derived from the <code>#startDate</code> and <code>#startTime</code> directly. For examples of valid <code>RRULE</code> strings see <a href=\"https://icalendar.org/rrule-tool.html\">https://icalendar.org/rrule-tool.html</a></td></tr><tr><td><code>#color</code></td><td>Displays the event with a specified color (named such as <code>red</code>, <code>gray</code> or hex such as <code>#FF0000</code>). This will also change the color of the note in other places such as the note tree.</td></tr><tr><td><code>#calendar:color</code></td><td><strong>❌️ Removed since v0.100.0. Use</strong> <code>#color</code> <strong>instead.</strong> <br> <br>Similar to <code>#color</code>, but applies the color only for the event in the calendar and not for other places such as the note tree.</td></tr><tr><td><code>#iconClass</code></td><td>If present, the icon of the note will be displayed to the left of the event title.</td></tr><tr><td><code>#calendar:title</code></td><td>Changes the title of an event to point to an attribute of the note other than the title, can either a label or a relation (without the <code>#</code> or <code>~</code> symbol). See <em>Use-cases</em> for more information.</td></tr><tr><td><code>#calendar:titleTemplate</code></td><td>Changes the title an event is displayed with on the calendar, filled in again for every occurrence of a repeating event. See <em>Use-cases</em> for displaying an age on a birthday.</td></tr><tr><td><code>#calendar:displayedAttributes</code></td><td>Takes precedence over the <a href=\"#event-attributes\">Event attributes</a> chosen in the calendar's properties. Allows displaying the value of one or more attributes in the calendar, in the order given, like this: <br> <br><img src=\"{{helpAssets}}/User%20Guide/Collections/6_Calendar_image.png\"> <br> <br><code>#weight=\"70\" #Mood=\"Good\" #calendar:displayedAttributes=\"weight,Mood\"</code> <br> <br>It can also be used with relations, case in which it will display the title of the target note: <br> <br><code>~assignee=@My assignee #calendar:displayedAttributes=\"assignee\"</code></td></tr><tr><td><code>#calendar:startDate</code></td><td>Allows using a different label to represent the start date, other than <code>startDate</code> (e.g. <code>expiryDate</code>). The label name <strong>must not be</strong> prefixed with <code>#</code>. If the label is not defined for a note, the default will be used instead.</td></tr><tr><td><code>#calendar:endDate</code></td><td>Similar to <code>#calendar:startDate</code>, allows changing the attribute which is being used to read the end date.</td></tr><tr><td><code>#calendar:startTime</code></td><td>Similar to <code>#calendar:startDate</code>, allows changing the attribute which is being used to read the start time.</td></tr><tr><td><code>#calendar:endTime</code></td><td>Similar to <code>#calendar:startDate</code>, allows changing the attribute which is being used to read the end time.</td></tr></tbody></table></figure><h2>How the calendar works</h2><p><img src=\"{{helpAssets}}/User%20Guide/Collections/8_Calendar_image.png\"></p><p>The calendar displays all the child notes of the Collection that have a <code>#startDate</code>. An <code>#endDate</code> can optionally be added.</p><p>A text note with a start date is shown with the <span class=\"tn-icon bx bx-calendar-event\"></span> icon in the note tree and elsewhere, unless it has an icon of its own (set with <code>#iconClass</code>). The start date is read from the label <code>#calendar:startDate</code> names, if any.</p><p>The start date & end date can easily be edited from the calendar collection itself by clicking on the event. To edit the date while in the event note itself, the following attributes can be added to the Collection note:</p><pre><code class=\"language-text-x-trilium-auto\">#viewType=calendar #label:startDate(inheritable)=\"promoted,alias=Start Date,single,date\"\n#label:endDate(inheritable)=\"promoted,alias=End Date,single,date\"\n#hidePromotedAttributes </code></pre><p>This will result in:</p><p><img src=\"{{helpAssets}}/User%20Guide/Collections/7_Calendar_image.png\"></p><p>When not used in a Journal, the calendar is recursive. That is, it will look for events not just in its child notes but also in the children of these child notes.</p><h3>Limiting the depth</h3><p>To limit how deep the calendar looks for events, set <em>Maximum nesting depth</em> under <em>Included notes</em> in the <span class=\"tn-icon bx bx-cog\"></span><em>Calendar properties</em> dialog (see <a href=\"#event-templates\">Event templates</a> for how to open it), or the <code>#maxNestingDepth</code> label: <code>0</code> shows only the child notes, <code>1</code> adds their children, and so on. Without a value, events are looked for at every level. The setting doesn't apply in a Journal.</p><h2>Recurrence</h2><p>The built in calendar view also supports repeating tasks (e.g. every week, every month as well as more complex recurrency rules).</p><p>Starting with v0.105.0, recurrence can be directly edited from the calendar by clicking on an event and then selecting the <em>Repeats</em> option.</p><h3>Custom recurrence using a subset of RRULE</h3><p>If the existing recurrence editor from the event popup is not sufficient, more complex rules can be manually set via the <code>#recurrence</code> label.</p><p>For example, to make a note repeat on the calendar:</p><ul><li>Every Day - <code>#recurrence=\"FREQ=DAILY;INTERVAL=1\"</code></li><li>Every 3 days - <code>#recurrence=\"FREQ=DAILY;INTERVAL=3\"</code></li><li>Every week - <code>#recurrence=\"FREQ=WEEKLY;INTERVAL=1\"</code></li><li>Every 2 weeks on Monday, Wednesday and Friday - <code>#recurrence=\"FREQ=WEEKLY;INTERVAL=2;BYDAY=MO,WE,FR\"</code></li><li>Every 3 months - <code>#recurrence=\"FREQ=MONTHLY;INTERVAL=3\"</code></li><li>Every 2 months on the First Sunday - <code>#recurrence=\"FREQ=MONTHLY;INTERVAL=2;BYDAY=1SU\"</code></li><li>Every month on the Last Friday - <code>#recurrence=\"FREQ=MONTHLY;INTERVAL=1;BYDAY=-1FR\"</code></li></ul><p>For other examples of valid <code>RRULE</code> strings see <a href=\"https://icalendar.org/rrule-tool.html\">https://icalendar.org/rrule-tool.html</a></p><p>Note that the recurrence string does not include the <code>DTSTART</code> attribute as defined in the iCAL specifications. This is derived directly from the <code>startDate</code> and <code>startTime</code> attributes</p><p>If you want to override the label the calendar uses to fetch the recurrence string, you can use the <code>#calendar:recurrence</code> attribute. For example, you can set <code>#calendar:recurrence=taskRepeats</code>. Then you can set your recurrence string like <code>#taskRepeats=\"FREQ=DAILY;INTERVAL=1\"</code></p><p>Also note that the recurrence label can be made promoted as with the start and end dates. </p><aside class=\"admonition warning\"><p>If the recurrence string is not valid, a toast will be shown with the note ID and title of the note with the erroneous recurrence message. This note will not be added to the calendar</p></aside><h3>Hiding routine events</h3><p>Events that repeat on most days of the week, such as sleep or working hours, fill every cell of the month view. To hide them from the views that show many days at once, check <em>Hide routine events</em> in the <a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a> (or set <code>#calendar:hideRoutineEvents</code>).</p><p>An event counts as routine when it has a start time and repeats on 4 or more days a week on average, for example:</p><figure class=\"table\"><table><thead><tr><th>Event</th><th>Days a week</th><th>Hidden from the month, year and list views</th></tr></thead><tbody><tr><td>Every day from 23:00 to 07:00</td><td>7</td><td>Yes</td></tr><tr><td>Monday to Friday from 09:00 to 17:00</td><td>5</td><td>Yes</td></tr><tr><td>Every other day at 07:00</td><td>3.5</td><td>No</td></tr><tr><td>Monday, Wednesday and Friday at 18:00</td><td>3</td><td>No</td></tr><tr><td>Every day, without a start time</td><td>7</td><td>No, as it lasts the whole day</td></tr><tr><td>Every month or every year</td><td>—</td><td>No</td></tr></tbody></table></figure><p>The day and week views always show routine events. To show them everywhere again, uncheck the option.</p><h2>Customizing the slot duration and label interval</h2><p>Time slots in day and week views can be customized from <a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a></p><ul><li><em>Slot duration</em> controls how tall each time slot is on the calendar (essentially the smallest unit of time the grid is divided into).<ul><li>A shorter duration means more rows and finer granularity; a longer one means fewer, chunkier rows.</li><li>The default is one row every 15 minutes.</li></ul></li><li><em>Label interval</em> controls how often a time label appears on the left-hand axis.<ul><li>This is independent of the slot size: you can have very small slots but only label every hour to keep the axis readable.</li><li>The default is a time label shown every hour.</li></ul></li></ul><aside class=\"admonition note\"><p>These values can also be customized directly via the <code>#calendar:slotDuration</code> and <code>#calendar:slotLabelInterval</code> <a href=\"#root/_help_HI6GBBIduIgv\">labels</a>. Both values use <code>HH:mm:ss</code> format. Hours can go up to <code>24</code> (<code>24:00:00</code>), while minutes and seconds must be between <code>00</code> and <code>59</code>. The minimum meaningful duration is 1 minute (<code>00:01:00</code>).</p></aside><h2>Use-cases</h2><h3>Using with the Journal / calendar</h3><p>It is possible to integrate the calendar view into the Journal with day notes. In order to do so change the note type of the Journal note (calendar root) to Collection and then select the Calendar View.</p><p>While in journal mode, the popup editor will not show dates, recurrence, colors or removal, since day notes aren't editable events.</p><p>Based on the <code>#calendarRoot</code> (or <code>#workspaceCalendarRoot</code>) attribute, the calendar will know that it's in a calendar and apply the following:</p><ul><li>The calendar events are now rendered based on their <code>dateNote</code> attribute rather than <code>startDate</code>.</li><li>Interactive editing such as dragging over an empty era or resizing an event is no longer possible.</li><li>Clicking on the empty space on a date will automatically open that day's note or create it if it does not exist.</li><li>Direct children of a day note will be displayed on the calendar despite not having a <code>dateNote</code> attribute. Children of the child notes will not be displayed.</li></ul><img src=\"{{helpAssets}}/User%20Guide/Collections/5_Calendar_image.png\" width=\"1217\" height=\"724\"><h3>Using a different attribute as event title</h3><p><img class=\"image-style-align-right\" src=\"{{helpAssets}}/User%20Guide/Collections/2_Calendar_image.png\" width=\"445\" height=\"124\">By default, events are displayed on the calendar by their note title. However, it is possible to configure a different attribute to be displayed instead.</p><p>To do so, assign <code>#calendar:title</code> to the child note (not the calendar/Collection note), with the value being <code>name</code> where <code>name</code> can be any label (make not to add the <code>#</code> prefix). The attribute can also come through inheritance such as a template attribute. If the note does not have the requested label, the title of the note will be used instead.</p><pre><code class=\"language-text-x-trilium-auto\">#startDate=2025-02-11 #endDate=2025-02-13 #name=\"My vacation\" #calendar:title=\"name\"</code></pre><h3>Using a relation attribute as event title</h3><p><img class=\"image-style-align-right image_resized\" style=\"aspect-ratio:294/151;width:21.22%;\" src=\"{{helpAssets}}/User%20Guide/Collections/3_Calendar_image.png\" width=\"294\" height=\"151\">Similarly to using an attribute, use <code>#calendar:title</code> and set it to <code>name</code> where <code>name</code> is the name of the relation to use.</p><p>Moreover, if there are more relations of the same name, they will be displayed as multiple events coming from the same note.</p><pre><code class=\"language-text-x-trilium-auto\">#startDate=2025-02-14 #endDate=2025-02-15 ~for=@John Smith ~for=@Jane Doe #calendar:title=\"for\"</code></pre><p><img class=\"image-style-align-left\" src=\"{{helpAssets}}/User%20Guide/Collections/Calendar_image.png\" width=\"296\" height=\"150\">Note that it's even possible to have a <code>#calendar:title</code> on the target note (e.g. “John Smith”) which will try to render an attribute of it. Note that it's not possible to use a relation here as well for safety reasons (an accidental recursion of attributes could cause the application to loop infinitely).</p><pre><code class=\"language-text-x-trilium-auto\">#calendar:title=\"shortName\" #shortName=\"John S.\"</code></pre><h3>Displaying an age on a recurring event</h3><p>A birthday or an anniversary repeats every year, and what is interesting about each occurrence is the number of years it marks. To display it:</p><ol><li>Set the event's start date to the original date (for example, the date of birth).</li><li>Click the event, then select the <em>Repeats</em> dropdown.</li><li>Select <em>Yearly</em> and check <em>Show the number of years in the title</em>.</li></ol><p>The event is then displayed as “John Smith (35)” in 2025, “John Smith (36)” in 2026, and so on. Only the calendar is affected; the note keeps its own title.</p><p>The checkbox sets the <code>#calendar:titleTemplate</code> label, which sets the title an event is displayed with and is filled in again for every occurrence the recurrence rule produces:</p><pre><code class=\"language-text-x-trilium-auto\">#startDate=1990-05-12 #recurrence=\"FREQ=YEARLY\" #calendar:titleTemplate=\"${title} (${years})\"</code></pre><p>To word the title differently, edit the label directly. The checkbox is then disabled, as it is when the template is inherited, so that it never overwrites a template of your own.</p><p>The following values can be used in the template:</p><figure class=\"table\"><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>${title}</code></td><td>The title the event would otherwise be displayed with: the note title, or the attribute <code>#calendar:title</code> points to.</td></tr><tr><td><code>${years}</code></td><td>The whole years between <code>#startDate</code> and the occurrence being displayed. It is <code>0</code> on the first occurrence.</td></tr><tr><td><code>${date}</code></td><td>The date of the occurrence being displayed, as a <a href=\"https://day.js.org/docs/en/display/format\">day.js</a> object. For example, <code>${date.format('YYYY')}</code>.</td></tr><tr><td><code>${startDate}</code></td><td>The date the event starts on, in the same form. For example, <code>${startDate.format('YYYY')}</code>.</td></tr></tbody></table></figure><p>To use the same template for every event of a calendar, make the label inheritable on the Collection note:</p><pre><code class=\"language-text-x-trilium-auto\">#calendar:titleTemplate(inheritable)=\"${title} (${years})\"</code></pre><aside class=\"admonition note\"><p>A template that cannot be read — an unknown value, or an expression other than a value and the <code>format</code> call shown above — leaves the event with its plain title and reports the reason in the browser console.</p></aside>","_help_2FvYrpmOXm29": "<figure class=\"image\"><img style=\"aspect-ratio:1050/259;\" src=\"{{helpAssets}}/User%20Guide/Collections/Table_image.png\" width=\"1050\" height=\"259\"></figure><p>The table view displays information in a grid, where the rows are individual notes and the columns are <a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>. In addition, values are editable.</p><h2>How it works</h2><p>The tabular structure is represented as such:</p><ul><li>Each child note is a row in the table.</li><li>If child rows also have children, they will be displayed under an expander (nested notes).</li><li>Each column is a <a href=\"#root/_help_OFXdgB2nNk1F\">promoted attribute</a> that is defined on the Collection note.<ul><li>Actually, both promoted and unpromoted attributes are supported, but it's a requirement to use a label/relation definition.</li><li>The promoted attributes are usually defined as inheritable in order to show up in the child notes, but it's not a requirement.</li></ul></li><li>If there are multiple attribute definitions with the same <code>name</code>, only one will be displayed.</li><li>If an attribute definition has multiple values, they will all be grouped under a single column, with chips indicating individual values.</li></ul><p>There are also a few predefined columns:</p><ul><li>The current item number, identified by the <code>#</code> symbol.<ul><li>This simply counts the note and is affected by sorting.</li></ul></li><li><a class=\"reference-link\" href=\"#root/_help_m1lbrzyKDaRB\">Note ID</a>, representing the unique ID used internally by Trilium</li><li>The title of the note.</li></ul><h2>Interaction</h2><h3>Creating a new table</h3><p>Right click on an existing note in the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a> and select <em>Insert child note</em> → <em>Collection</em> → <em>Table</em>.</p><h3>Adding columns</h3><p>Each column is a <a href=\"#root/_help_OFXdgB2nNk1F\">promoted or unpromoted attribute</a> that is defined on the Collection note.</p><p>To create a new column, either:</p><ul><li>Press <em>Add new column</em> at the bottom of the table.</li><li>Right click on an existing column and select Add column to the left/right.</li><li>Right click on the empty space of the column header and select <em>Label</em> or <em>Relation</em> in the <em>New column</em> section.</li></ul><h3>Adding new rows</h3><p>Each row is actually a note that is a child of the Collection note.</p><p>To create a new note, either:</p><ul><li>Press <em>Add new row</em> at the bottom of the table.</li><li>Right click on an existing row and select <em>Insert row above, Insert child note</em> or <em>Insert row below</em>.</li></ul><p>By default it will try to edit the title of the newly created note.</p><p>Alternatively, the note can be created from the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a> or <a href=\"#root/_help_CdNpE2pqjmI6\">scripting</a>.</p><h3>Context menu</h3><p>There are multiple menus:</p><ul><li>Right clicking on a column, allows:<ul><li>Sorting by the selected column and resetting the sort.</li><li>Hiding the selected column or adjusting the visibility of every column.</li><li>Adding new columns to the left or the right of the column.</li><li>Editing the current column.</li><li>Deleting the current column.</li></ul></li><li>Right clicking on the space to the right of the columns, allows:<ul><li>Adjusting the visibility of every column.</li><li>Adding new columns.</li></ul></li><li>Right clicking on a row, allows:<ul><li>Opening the corresponding note of the row in a new tab, split, window or quick editing it.</li><li>Inserting a new note above or below the selected row. These options are only enabled if the table is not sorted.</li><li>Inserting a new child note for the selected row.</li><li>Deleting the row.</li></ul></li></ul><h3>Editing data</h3><p>Simply click on a cell within a row to change its value. The change will not only reflect in the table, but also as an attribute of the corresponding note.</p><ul><li>The editing will respect the type of the promoted attribute, by presenting a normal text box, a number selector or a date selector for example.</li><li>It also possible to change the title of a note.</li><li>Editing relations is also possible<ul><li>Simply click on a relation and it will become editable. Enter the text to look for a note and click on it.</li><li>To remove a relation, remove the title of the note from the text box and click outside the cell.</li></ul></li></ul><h3>Editing columns</h3><p>It is possible to edit a column by right clicking it and selecting <em>Edit column…</em> This will basically change the label/relation definition at the collection level.</p><p>If the <em>Name</em> field of a column is changed, this will trigger a batch operation in which the corresponding label/relation will be renamed in all the children.</p><h3>Read-only tables</h3><p>On a <a href=\"#root/_help_CoFPLs3dRlXc\">read-only</a> table, the cells can't be edited and the rows can't be dragged. The <em>New row</em> and <em>New column</em> buttons are hidden, and the context menus offer only what leaves the notes as they are: sorting and hiding columns, and opening the notes. Columns can still be resized and reordered, but the layout isn't saved. The <em>Table properties</em> dialog isn't available.</p><h2>Working with the data</h2><h3>Sorting by column</h3><p>By default, the order of the notes matches the order in the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>. However, it is possible to sort the data by the values of a column:</p><ul><li>To do so, simply click on a column.</li><li>To switch between ascending or descending sort, simply click again on the same column. The arrow next to the column will indicate the direction of the sort.</li><li>To disable sorting and fall back to the original order, right click any column on the header and select <em>Clear sorting.</em></li></ul><h3>Reordering and hiding columns</h3><ul><li>Columns can be reordered by dragging the header of the columns.</li><li>Columns can be hidden or shown by right clicking on a column and clicking the item corresponding to the column.</li></ul><h3>Reordering rows</h3><p>Notes can be dragged around to change their order. To do so, move the mouse over the three vertical dots near the number row and drag the mouse to the desired position.</p><p>This will also change the order of the note in the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</p><p>Reordering does have some limitations:</p><ul><li>If the parent note has <code>#sorted</code>, reordering will be disabled.</li><li>If using nested tables, then reordering will also be disabled.</li><li>Currently, it's possible to reorder notes even if column sorting is used, but the result might be inconsistent.</li></ul><h3>Nested trees</h3><p>If the child notes of the collection also have their own child notes, then they will be displayed in a hierarchy.</p><p>Next to the title of each element there will be a button to expand or collapse. By default, all items are expanded.</p><p>Since nesting is not always desirable, it is possible to limit the nesting to a certain number of levels or even disable it completely. To do so, go to <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> → <em>Table properties</em> and set <em>Maximum nesting depth</em> (under the <em>Included notes</em> section), or set the <code>#maxNestingDepth</code> <a href=\"#root/_help_HI6GBBIduIgv\">label</a> of the collection:</p><ul><li><code>0</code> disables nesting, showing only the children of the collection.</li><li><code>1</code> also shows their children, <code>2</code> the level below that, and so on.</li><li>Removing the label shows every level again.</li></ul><p>Limitations:</p><ul><li>While in this mode, it's not possible to reorder notes.</li></ul><h2>Limitations</h2><ul><li>There is no support to filter the rows by a certain criteria. Consider using the table view in search for that use case.</li></ul><h2>Use in search</h2><p>The table view can be used in a <a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a> by adding the <code>#viewType=table</code> attribute.</p><p>Unlike when used in a Collection, saved searches are not limited to the sub-hierarchy of a note and allows for advanced queries thanks to the power of the <a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>.</p><p>However, there are also some limitations:</p><ul><li>It's not possible to reorder notes.</li><li>It's not possible to add a new row.</li></ul><p>Columns are supported, by being defined as <a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a> to the <a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a> note.</p><p>Editing is also supported.</p>",@@ -189,7 +189,7 @@"_help_x59R8J8KV5Bp": "<p><img src=\"{{helpAssets}}/User%20Guide/Troubleshooting/Anonymized%20Database_image.jpg\"></p><p>In certain scenarios, understanding the structure of a database is crucial for troubleshooting issues. However, sharing your actual <a href=\"#root/_help_wX4HbRucYSDD\">database</a> file with personal notes is not advisable. To address this, Trilium offers a feature to anonymize the database. This feature can be accessed via Menu -> Options -> Advanced tab.</p><p>This feature creates a copy of your database with all sensitive data removed. Specifically, it strips out note titles, contents, revisions, history, and some non-system attributes while retaining the overall structure and metadata, such as modification dates. After anonymization, the database undergoes a <a href=\"https://sqlite.org/lang_vacuum.html\">vacuuming process</a> to ensure no sensitive data remnants remain in the file. The anonymized database is saved in the <code>anonymized</code> directory within the <a href=\"#root/_help_tAassRL4RSQL\">data directory</a>, making it safe to share with bug reports.</p><p>This will create a copy of your document and remove all sensitive data (currently note titles, contents, revisions, history and some of the options, and non-system attributes) while leaving all structure and metadata (e.g. date of last change). After this is done, the database is <a href=\"https://sqlite.org/lang_vacuum.html\">VACUUMed</a> to make sure there's no stale sensitive data in the document file. The resulting file is stored in <code>anonymized</code> directory (placed in the <a href=\"#root/_help_tAassRL4RSQL\">data directory</a>). You can safely attach it to a bug report.</p><h2>Command Line Anonymization</h2><p>If your <a href=\"#root/_help_wX4HbRucYSDD\">database</a> is corrupted to the point where Trilium cannot start, the anonymization process can still be executed via the command line:</p><pre><code class=\"language-text-x-trilium-auto\">node src/anonymize.js</code></pre><p>Run this command from the directory containing Trilium's source files, typically found in the <code>resources/app</code> directory for desktop builds.</p>","_help_qzNzp9LYQyPT": "<p>It's important to provide all available error logs together with bug reports.</p><p>There are two types of error logs, both of which are useful when reporting bugs.</p><ul><li><a class=\"reference-link\" href=\"#root/_help_bnyigUA2UK7s\">Backend (server) logs</a></li><li><a class=\"reference-link\" href=\"#root/_help_9yEHzMyFirZR\">Frontend logs</a></li></ul><h2>Providing sensitive data</h2><p>If you don't feel comfortable attaching the logs or anything sensitive to the public GitHub issues, feel free to contact the devs in our Matrix <a href=\"https://github.com/TriliumNext/Trilium#-discuss-with-us\">support channel</a>.</p><p>Use this email to also provide anything which could assist in analysing the bug - e.g. files/images/ZIPs being imported or <a href=\"#root/_help_x59R8J8KV5Bp\">anonymized database</a>.</p><h3>Exporting note subtree for reproduction</h3><p>Often times, bugs manifest themselves in specific notes and having them would greatly ease reproduction and fixing.</p><p>In such case, please export the relevant note subtree by right-clicking it on the left tree, choosing Export - HTML as ZIP:</p><p><img src=\"{{helpAssets}}/User%20Guide/Troubleshooting/Error%20logs_error-logs-export-subtree.png\"></p>","_help_bnyigUA2UK7s": "<h2>Accessing via the backend log</h2><p>In the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>, go to <em>Advanced</em> → <em>Show backend log</em>. This will display the current backend log (i.e. today's), with the historical information available only on disk (see below).</p><p>Interaction since v0.104.0:</p><ul><li>The file can be downloaded as a text file using the <span class=\"tn-icon bx bx-download\"></span> button in the <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> area.</li><li>The file can also be searched just like a normal <a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a> note.</li></ul><h2>Location on the disk</h2><p>Backend logs are stored on the file system. To find them, open the <a class=\"reference-link\" href=\"#root/_help_tAassRL4RSQL\">Data directory</a>, go to the <code>log</code> subdirectory and find the latest log file, e.g. <code>trilium-2022-12-14.log</code>. </p><h2>Reporting backend bugs</h2><p>You can attach the whole file to the bug report (preferable) or open it and copy-paste only the last lines / lines you believe are relevant.</p><h2>Customizing the retention of logs</h2><p>The backend logs are fully managed by the Trilium server. By default the last 90 days worth of logs are kept; the logs older than that are deleted in order to reduce the space consumption.</p><p>It's possible to change the retention period by modifying the <a class=\"reference-link\" href=\"#root/_help_Gzjqa934BdH4\">Configuration (config.ini or environment variables)</a> via the <code>.ini</code> file:</p><pre><code class=\"language-text-x-trilium-auto\">[Logging]\nretentionDays=7</code></pre><p>Or via the environment variable <code>TRILIUM_LOGGING_RETENTION_DAYS</code>.</p><p>Special cases:</p><ul><li>Positive values indicate the number of days worth of logs to keep</li><li>A value of 0 results with the default value (90 days) to be used</li><li>Negative values (e.g. <code>-1</code>) result with all logs to be kept, irrespective how ancient and numerous (and</li></ul><aside class=\"admonition note\"><p>If you set the retention days to a low number, you might notice that not all the log files are being deleted. This is because a minimum number of logs (7 at the time of writing) is maintained at all times.</p></aside>",- "_help_9yEHzMyFirZR": "<p>To provide frontend logs, we need to open the Developer Console. Often the easiest way is to press <kbd>Ctrl</kbd>-<kbd>Shift</kbd>-<kbd>I</kbd> which should work in most browsers (and desktop app). Make sure that the error producing action happened right before you copy&paste the errors, the console is cleared on app restart.</p><p>If that doesn't work, then:</p><ul><li>in Trilium desktop app, go to top-left menu button -> Advanced -> Open Dev Tools</li><li>In Firefox/Chrome right-click anywhere in the page and click Inspect:</li></ul><p><img src=\"{{helpAssets}}/User%20Guide/Troubleshooting/Error%20logs/Frontend%20logs_error-logs-firefox-context-men.png\"></p><p>Once you have Dev Tools open, click on \"Console\" tab:</p><p><img src=\"{{helpAssets}}/User%20Guide/Troubleshooting/Error%20logs/Frontend%20logs_image.jpg\"></p><p>Copy-paste (or screenshot) the logs. It's better to provide not just errors, but the whole log, which might provide context while analyzing the bug.</p>",+ "_help_9yEHzMyFirZR": "<p>To provide frontend logs, we need to open the Developer Console. Often the easiest way is to press <kbd>Ctrl</kbd>-<kbd>Shift</kbd>-<kbd>I</kbd> which should work in most browsers (and desktop app). Make sure that the error producing action happened right before you copy&paste the errors, the console is cleared on app restart.</p><p>If that doesn't work, then:</p><ul><li>in Trilium desktop app, go to top-left menu button -> Advanced -> Open dev tools</li><li>In Firefox/Chrome right-click anywhere in the page and click Inspect:</li></ul><p><img src=\"{{helpAssets}}/User%20Guide/Troubleshooting/Error%20logs/Frontend%20logs_error-logs-firefox-context-men.png\"></p><p>Once you have Dev Tools open, click on \"Console\" tab:</p><p><img src=\"{{helpAssets}}/User%20Guide/Troubleshooting/Error%20logs/Frontend%20logs_image.jpg\"></p><p>Copy-paste (or screenshot) the logs. It's better to provide not just errors, but the whole log, which might provide context while analyzing the bug.</p>","_help_vdlYGAcpXAgc": "<p>Synchronization can sometimes take a long amount of time in order to compute the items that require update. When running behind a reverse proxy, the request can time out.</p><p>The solution is to increase the timeout at proxy level.</p><h2>Nginx</h2><p>Add the following to the configuration file:</p><pre><code class=\"language-text-x-nginx-conf\">proxy_connect_timeout 300;\nproxy_send_timeout 300;\nproxy_read_timeout 300;\nsend_timeout 300;</code></pre><p>And restart the server.</p><p>See <a href=\"#root/_help_ud6MShXL4WpO\">Nginx Proxy Setup</a> for more information about the Nginx setup.</p><p>If it still doesn't work, try increasing the timeout.</p>","_help_s8alTXmpFR61": "<p>Some changes to the application will not take effect immediately and as such it might require to manually reload or refresh the application.</p><p>To do so, simply press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>R</kbd>.</p>","_help_7NfNr5pZpVKV": "<h2>Step 1. Find a place to place the themes</h2><p>Organization is an important aspect of managing a knowledge base. When developing a new theme or importing an existing one it's a good idea to keep them into one place.</p><p>As such, the first step is to create a new note to gather all the themes.</p><p><img src=\"{{helpAssets}}/User%20Guide/Theme%20development/Creating%20a%20custom%20theme_5_Creating%20a%20custom%20theme_im.jpg\"></p><h2>Step 2. Create the theme</h2><figure class=\"table\"><table><tbody><tr><td><img src=\"{{helpAssets}}/User%20Guide/Theme%20development/Creating%20a%20custom%20theme_3_Creating%20a%20custom%20theme_im.jpg\"></td><td>Themes are code notes with a special attribute. Start by creating a new code note.</td></tr><tr><td><img src=\"{{helpAssets}}/User%20Guide/Theme%20development/Creating%20a%20custom%20theme_1_Creating%20a%20custom%20theme_im.jpg\"></td><td>Then change the note type to a CSS code.</td></tr><tr><td><img src=\"{{helpAssets}}/User%20Guide/Theme%20development/Creating%20a%20custom%20theme_Creating%20a%20custom%20theme_im.jpg\"></td><td>In the attributes of the note (the <span class=\"tn-icon bx bx-list-check\"></span> button in the <a class=\"reference-link\" href=\"#root/_help_AlJ73vBCjWDw\">Status bar</a>), define the <code>#appTheme</code> attribute to point to any desired name. This is the name that will show up in the appearance section in settings.</td></tr></tbody></table></figure><h2>Step 3. Define the theme's CSS</h2><p>As a very simple example we will change the background color of the launcher pane to a shade of blue.</p><p>To alter the different variables of the theme:</p><pre><code class=\"language-text-css\">:root {\n\t--launcher-pane-background-color: #0d6efd;\n}</code></pre><h2>Step 4. Activating the theme</h2><p>Refresh the application (Ctrl+Shift+R is a good way to do so) and go to settings. You should see the newly created theme:</p><p><img src=\"{{helpAssets}}/User%20Guide/Theme%20development/Creating%20a%20custom%20theme_2_Creating%20a%20custom%20theme_im.jpg\"></p><p>Afterwards the application will refresh itself with the new theme:</p><p><img src=\"{{helpAssets}}/User%20Guide/Theme%20development/Creating%20a%20custom%20theme_4_Creating%20a%20custom%20theme_im.jpg\"></p><p>Do note that the theme will be based off of the legacy theme. To override that and base the theme on the Modern theme, see <a class=\"reference-link\" href=\"#root/_help_WFGzWeUK6arS\">Customize the Next theme</a>.</p><h2>Step 5. Making changes</h2><p>Simply go back to the note and change according to needs. To apply the changes to the current window, press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>R</kbd> to refresh.</p><p>It's a good idea to keep two windows, one for editing and the other one for previewing the changes.</p>",@@ -207,7 +207,7 @@"_help_VQjhl61rlWh9": "<p>Markdown Snippets are closely related to <a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>, but instead of defining the content of an entire note, a snippet is a reusable piece of Markdown text that can easily be inserted into a <a class=\"reference-link\" href=\"#root/_help_6RM1Q7ppFVoj\">Markdown</a> note.</p><h2>Creating a Markdown snippet</h2><p>In the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>: </p><ol><li>Right-click the note where you want to place the snippet.</li><li>Select <em>Insert child note</em>.</li><li>Select <em>More</em> → <em>Markdown snippet</em>.</li></ol><p>Then simply type the desired content into the note.</p><p>The note's title becomes the title of the snippet. Optionally, you can add a description in the <a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a> section.</p><h2>Inserting a snippet</h2><p>To insert a snippet, type <code>/snippet</code> and select its title from the dropdown.</p><p><a class=\"reference-link\" href=\"#root/_help_IEgsWp5hHH35\">Code Snippets</a> with their language mode set to \"Plain text\" are also listed here.</p><h2>Limitations</h2><ul><li>Unlike <a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>, snippets cannot be limited to a particular <a href=\"#root/_help_9sRHySam5fXb\">workspace</a>.</li></ul>","_help_IEgsWp5hHH35": "<p>Code Snippets are closely related to <a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>, but instead of defining the content of an entire note, a snippet is a reusable piece of code that can easily be inserted into a <a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a> note.</p><h2>Creating a Code snippet</h2><p>In the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>: </p><ol><li>Right-click the note where you want to place the snippet.</li><li>Select <em>Insert child note</em>.</li><li>Select <em>More</em> → <em>Code snippet</em>.</li></ol><p>Then simply type the desired code into the note and set the correct language mode.</p><p>The note's title becomes the title of the snippet. Optionally, you can add a description in the <a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a> section.</p><h2>Inserting a snippet</h2><p>To insert a snippet, type <kbd>/</kbd> followed by the first letters of its title, then select it from the list. Typing <code>/snippet</code> lists every snippet available in the note. This also works in an included code or Markdown note that is being edited in place, see <a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>.</p><aside class=\"admonition important\"><p>Only code snippets whose language mode matches the current code note are listed. For example, a CSS code note shows only CSS snippets, not JavaScript ones. The exception is snippets set to \"Plain text\", which are available in <a class=\"reference-link\" href=\"#root/_help_6RM1Q7ppFVoj\">Markdown</a> notes and any code note regardless of its language mode.</p></aside><h2>Limitations</h2><ul><li>Unlike <a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>, snippets cannot be limited to a particular <a href=\"#root/_help_9sRHySam5fXb\">workspace</a>.</li></ul>","_help_BCkXAVs63Ttv": "<p>Note map is a visualization of connections between notes. This provides an insight into a structure (\"web\") of notes.</p><p>There are two types of note map:</p><ul><li>Link Map, which shows relations between notes.</li><li>Note Map, which shows the hierarchical tree structure.</li></ul><h2>Accessing the note map</h2><p>The note map comes into multiple flavors:</p><ul><li>The note map is available in the <a class=\"reference-link\" href=\"#root/_help_KRlZFoIH0j6p\">Connections tab</a> in the <a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>, in the <em>Note map</em> section.<ul><li>It can also be accessed by going to <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> → <em>Note map</em>, which will focus the sidebar at the right section.</li></ul></li><li>To display a full-screen note map, there is a <a href=\"#root/_help_bdUJEHsAPYQR\">dedicated note type</a> with the same name.</li><li>To view the global note map (of all the notes in the knowledge base), there is a dedicated <em>Note map</em> button in the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</li></ul><h2>Terminology and structure</h2><ul><li>Each note is represented as a <em>node</em> in the graph, with the title displayed underneath.<ul><li>When the map is zoomed out, the title can still be viewed by hovering over the node.</li><li>The <a href=\"#root/_help_p9kXRFAkwN4o\">icon and color</a> of the note are respected.</li></ul></li><li>The root node is the reference point for which the relations and hierarchical structure are displayed.<ul><li>When accessing the note map through the <a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>, the root node is the current note.</li><li>When using a dedicated <a class=\"reference-link\" href=\"#root/_help_bdUJEHsAPYQR\">Note Map</a> note, the root note can be either the parent note, the currently <a href=\"#root/_help_OR8WJ7Iz9K4U\">hoisted</a> note or a specific note. See the note type documentation for more information.</li></ul></li></ul><h2>Interaction</h2><ul><li>Nodes can be dragged around, but they will return to their original position once released.<ul><li>To have the notes remain in the same position as they were dragged, press the <em>Fix nodes</em> button. The position of the notes is not saved, so it will return to normal once you navigate to another note or restart the application.</li></ul></li><li>When hovering over a node, the adjacent relations and nodes are highlighted.</li><li>The distance between nodes can be adjusted via the slider in the bottom-left. Similarly, this value is not saved.</li><li>To zoom, use the mouse wheel, pinch on a touch screen, or press the <span class=\"tn-icon bx bx-plus-circle\"></span> and <span class=\"tn-icon bx bx-minus-circle\"></span> buttons in the bottom-right corner.<ul><li>To bring the whole map back into view, press the <span class=\"tn-icon bx bx-scan\"></span> <em>Fit to view</em> button next to them.</li><li>The zoom buttons are not shown on mobile, where pinching zooms instead. The <em>Fit to view</em> button is always shown.</li></ul></li><li><a class=\"reference-link\" href=\"#root/_help_MKmLg5x6xkor\">Archived Notes</a> are generally ignored by the note map in order to reduce clutter. There is one exception: if the root note is also archived, then all archived notes are displayed too.</li></ul><h2>Link Map</h2><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Note%20Map%20(Link%20map%2C%20Tree%20map)_image.png\" width=\"1425\" height=\"1093\"><p>The link map is a visualization of links and <a class=\"reference-link\" href=\"#root/_help_Cq5X6iKQop6R\">Relations</a> incoming to and outgoing from a particular note.</p><p>The map indicates the following types of relations:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a> between notes.</li><li><a class=\"reference-link\" href=\"#root/_help_Cq5X6iKQop6R\">Relations</a></li></ul><p>The link map will also show unlinked notes that are part of the hierarchy as a cloud of unconnected dots. On the <a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a> deliberately omits this in order to save some space, but they will be revealed once the map is maximized.</p><h2>Tree Map</h2><p>Shows hierarchical map of notes:</p><figure class=\"image\"><img style=\"aspect-ratio:1420/1490;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/1_Note%20Map%20(Link%20map%2C%20Tree%20map)_image.png\" width=\"1420\" height=\"1490\"></figure><h2>See also</h2><ul><li>Apart from the note map feature which can be accessed from any note, it is also possible to create a dedicated note which will display the relations in full screen. See <a class=\"reference-link\" href=\"#root/_help_bdUJEHsAPYQR\">Note Map</a> for more information.</li><li><a class=\"reference-link\" href=\"#root/_help_iRwzGnHPzonm\">Relation Map</a> is a similar concept, with some differences:<ul><li>note map is automatically generated while relation map must be created manually</li><li>relation map is a type of note while a link map is just virtual visualization</li></ul></li></ul>",- "_help_R9pX4DGra2Vt": "<p>Trilium allows you to share selected notes as <strong>publicly accessible</strong> read-only documents. This feature is particularly useful for publishing content directly from your Trilium notes, making it accessible to others online.</p><figure class=\"image\"><img style=\"aspect-ratio:1144/660;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Sharing_image.png\" width=\"1144\" height=\"660\"></figure><h2>Features, interaction and limitations</h2><ul><li>Searching by note title.</li><li>Light and dark mode, following the visitor's system setting by default, also while the page is open. The visitor can pick <em>Light</em>, <em>Dark</em> or <em>System</em> with the buttons at the top of the navigation pane; the choice is remembered by the browser.</li><li>A layout centered on wide screens, with the navigation tree and the table of contents at either side of the content, and a mobile-friendly layout on narrow ones. There, the navigation tree slides in from the menu button in the header, and lists the headings of the current page below its entry (at the top of the pane, for a page the tree does not show).</li><li>Collapsible tree with the same note icons as the application. It keeps the sections the visitor expanded and its scroll position while they move between the pages of the site, and shows the current note.</li><li>Customizable logo.</li><li>Quick navigation buttons (previous and next note).</li><li>Notes that hide their children from the tree with <code>#subtreeHidden</code> (such as a <a class=\"reference-link\" href=\"#root/_help_CtBQqbwXDx1w\">Kanban Board</a>) show a badge counting them in place of listing them. The page of one of those children shows only that child below its parent, and the previous and next buttons skip them.</li><li>The subpages of a text or code note shown below its content as cards, as in the application. Each card shows the icon of the subpage and the start of its text (or its <code>#shareDescription</code>), or, for a subpage without text, links to its own first subpages. The cards can be hidden with <code>#hideChildrenOverview</code>.</li><li>Displaying the date of the last update of the note, written out in the application's language.</li><li>Marking the page with the application's language and its text direction, and the content of the note with its own <a href=\"#root/_help_veGu4faJErEM\">content language</a>, for screen readers and right-to-left text.</li></ul><h3>By note type</h3><figure class=\"table\"><table class=\"ck-table-resized\"><colgroup><col style=\"width:19.92%;\"><col style=\"width:41.66%;\"><col style=\"width:38.42%;\"></colgroup><thead><tr><th> </th><th>Supported features</th><th>Limitations</th></tr></thead><tbody><tr><th><a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a></th><td><ul><li>Table of contents.</li><li>A link next to each heading, shown while the pointer is over the heading. Clicking it shows the address of the section in the address bar of the browser and copies it, to share a link to the section.</li><li>Syntax highlight of code blocks, in the language selected for each block and in the colors of the VS Code light or dark theme, following the page's mode. For “Auto-detected” blocks, the language is guessed among the ones enabled in <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Code Notes</em>; a language not enabled there is not highlighted.</li><li>Rendering for math equations.</li><li><a href=\"#root/_help_nBAXQFj20hS1\">Including notes</a> (only if the included notes are also shared).</li><li>Drawing canvases, shown as pictures at their own size.</li><li>Mermaid diagrams in code blocks, drawn in the page's light or dark mode and redrawn when the visitor switches it.</li></ul></td><td> </td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a></th><td><ul><li>Syntax highlight with line numbers, in the language of the note and in the colors of the VS Code light or dark theme, following the page's mode. A language not enabled in <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Code Notes</em> is not highlighted.</li></ul></td><td> </td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a></th><td>Not supported.</td><td> </td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_iRwzGnHPzonm\">Relation Map</a></th><td>Not supported.</td><td> </td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_bdUJEHsAPYQR\">Note Map</a></th><td>Not supported.</td><td> </td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a></th><td>Not supported.</td><td> </td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a></th><td><ul><li>The child notes are shown as cards, or as a list when the view type of the collection is <em>List</em>. Each shows its icon and the start of its text (or its <code>#shareDescription</code>), or, for a child note without text, links to its own first child notes.</li></ul></td><td><ul><li>The calendar, table, board, geo map, dashboard and presentation view types are shown as in the app, but read-only.</li></ul></td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a></th><td><ul><li>The diagram is drawn in the page's light or dark mode and redrawn when the visitor switches it. In browsers with JavaScript disabled, the image saved when the note was last edited is shown instead, and the source of the diagram can be expanded below it.</li><li>The diagram fills the page and can be zoomed with the <span class=\"tn-icon bx bx-minus-circle\"></span> and <span class=\"tn-icon bx bx-plus-circle\"></span> buttons in its bottom corner or with the mouse wheel, between 50% and 1000% of its fitted size, and on touch screens by pinching. Clicking the percentage between the buttons, or double-clicking the diagram, shows it whole again. The diagram can be panned by dragging it.</li></ul></td><td> </td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a></th><td><ul><li>The diagram is displayed as a vector image.</li></ul></td><td><ul><li>No further interaction supported.</li></ul></td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_1vHRoWCEjj0L\">Web View</a></th><td>Not supported.</td><td> </td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a></th><td>The diagram is displayed as a vector image.</td><td><ul><li>No further interaction supported.</li></ul></td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map</a></th><td>Not supported.</td><td> </td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a></th><td>Basic interaction (downloading the file).</td><td><ul><li>No further interaction supported.</li></ul></td></tr></tbody></table></figure><p>While the sharing feature is powerful, it has some limitations:</p><ul><li><strong>Static Note Tree</strong></li><li><strong>Protected Notes</strong>: Cannot be shared.</li><li><strong>Include Notes</strong>: Not supported.</li></ul><p>Some of these limitations may be addressed in future updates.</p><h2>Prerequisites</h2><p>To use the sharing feature, you must have a <a class=\"reference-link\" href=\"#root/_help_WOcw2SLH6tbX\">Server Installation</a> of Trilium. This is necessary because the notes will be hosted from the server.</p><h2>Sharing a note</h2><ol><li><p><strong>Enable Sharing</strong>: To share a note, toggle the <code>Shared</code> switch within the note's interface. Once sharing is enabled, an URL will appear, which you can click to access the shared note.</p><p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Sharing_share-single-note.png\" alt=\"Share Note\"></p></li><li><p><strong>Access the Shared Note</strong>: The link provided will open the note in your browser. If your server is not configured with a public IP, the URL will refer to <code>localhost (127.0.0.1)</code>.</p></li></ol><h2>Sharing a note subtree</h2><p>When you share a note, you actually share the entire subtree of notes beneath it. If the note has child notes, they will also be included in the shared content. For example, sharing the \"Formatting\" subtree will display a page with basic navigation for exploring all the notes within that subtree.</p><h2>Viewing and managing shared notes</h2><p>You can view a list of all shared notes by clicking on <em>Advanced</em> → \"Show Shared Notes Subtree\" in the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>. This allows you to manage and navigate through all the notes you have made public.</p><h2>Security considerations</h2><ul><li>Shared notes are published on the open internet and can be accessed by anyone with the URL unless the notes are password-protected.</li><li>The URL's randomness does not provide security, so it is crucial not to share sensitive information through this feature.</li><li>Trilium takes precautions to protect your publicly shared instance from leaking information for non-shared notes, including opening a separate read-only connection to the <a class=\"reference-link\" href=\"#root/_help_wX4HbRucYSDD\">Database</a>. Depending on your threat model, it might make more sense to use <a class=\"reference-link\" href=\"#root/_help_ycBFjKrrwE9p\">Exporting static HTML for web publishing</a> and use battle-tested web servers such as Nginx or Apache to serve static content.</li></ul><h3>Password protection</h3><p>To protect shared notes with a username and password, you can use the <code>#shareCredentials</code> attribute. Add this label to the note with the format <code>#shareCredentials=\"username:password\"</code>. To protect an entire subtree, make sure the label is <a href=\"#root/_help_bwZpz2ajCEwO\">inheritable</a>.</p><h2>Advanced sharing options</h2><h3>Customizing the appearance of shared notes</h3><p>The default design should be a good starting point, but you can customize it using your own CSS:</p><ul><li><strong>Custom CSS</strong>: Link a CSS <a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a> note to the shared page by adding a <code>~shareCss</code> relation to the note. If you want this style to apply to the entire subtree, make the label inheritable. You can hide the CSS code note from the tree navigation by adding the <code>#shareHiddenFromTree</code> label.</li><li><strong>Omitting Default CSS</strong>: For extensive styling changes, use the <code>#shareOmitDefaultCss</code> label to avoid conflicts with Trilium's <a href=\"#root/_help_Wy267RK4M69c\">default stylesheet</a>.</li></ul><h3>Adding JavaScript</h3><p>You can inject custom JavaScript into the shared note using the <code>~shareJs</code> relation. This allows you to access note attributes or traverse the note tree using the <code>fetchNote()</code> API, which retrieves note data based on its ID.</p><h3>Adding custom HTML</h3><p>You can inject custom HTML snippets into specific locations of the shared page using the <code>~shareHtml</code> relation. The HTML note should contain the raw HTML content you want to inject, and you can control where it appears by adding the <code>#shareHtmlLocation</code> label to the HTML snippet note itself.</p><p>The <code>#shareHtmlLocation</code> label accepts values in the format <code>location:position</code>:</p><ul><li><strong>Locations</strong>: <code>head</code>, <code>body</code>, <code>content</code></li><li><strong>Positions</strong>: <code>start</code>, <code>end</code></li></ul><p>For example:</p><ul><li><code>#shareHtmlLocation=head:start</code> - Injects HTML at the beginning of the <code><head></code> section</li><li><code>#shareHtmlLocation=head:end</code> - Injects HTML at the end of the <code><head></code> section (default)</li><li><code>#shareHtmlLocation=body:start</code> - Injects HTML at the beginning of the <code><body></code> section</li><li><code>#shareHtmlLocation=content:start</code> - Injects HTML at the beginning of the content area</li><li><code>#shareHtmlLocation=content:end</code> - Injects HTML at the end of the content area</li></ul><p>If no location is specified, the HTML will be injected at <code>content:end</code> by default.</p><p>Example:</p><pre><code class=\"language-text-javascript\">const currentNote = await fetchNote();\nconst parentNote = await fetchNote(currentNote.parentNoteIds[0]);\n\nfor (const attr of parentNote.attributes) {\n console.log(attr.type, attr.name, attr.value);\n}</code></pre><h3>Custom share templates</h3><p>To completely redesign the share, it is possible to create or use an existing <a href=\"#root/_help_Ad7Ku5gOHrDU\">custom share template</a>.</p><h3>Creating human-readable URL aliases</h3><p>Shared notes typically have URLs like <code>http://domain.tld/share/knvU8aJy4dJ7</code>, where the last part is the note's ID. You can make these URLs more user-friendly by adding the <code>#shareAlias</code> label to individual notes (e.g., <code>#shareAlias=highlighting</code>). This will change the URL to <code>http://domain.tld/share/highlighting</code>. The URL with the note's ID keeps working and redirects to the alias.</p><p><strong>Important</strong>:</p><ol><li>Ensure that aliases are unique.</li><li>Using slashes (<code>/</code>) within aliases to create subpaths is not supported.</li></ol><aside class=\"admonition tip\"><ul><li>To easily identify pages that don't have a share alias, run a <a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a> with <code>#!shareAlias</code>.</li><li>To be able to enter the share alias faster, consider using <a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a> (for example <code>#label:shareAlias(inheritable)=\"promoted,alias=Slug,single,text\"</code>).</li></ul></aside><h3>Setting a custom favicon</h3><p>To customize the favicon for your shared pages, create a relation <code>~shareFavicon</code> pointing to a file note containing the favicon (e.g., in <code>.ico</code> format).</p><h3>Sharing a note as the root</h3><p>You can designate a specific note or folder as the root of your shared content by adding the <code>#shareRoot</code> label. This note will be linked when visiting <code>[http://domain.tld/share](http://domain/share)</code>, making it easier to use Trilium as a fully-fledged website.</p><aside class=\"admonition tip\"><p>Consider combining this with the <code>#shareIndex</code> label, which will display a list of all shared notes.</p></aside><h3>Displaying an index of shared notes</h3><p>When accessing a share, the sub-notes will be displayed in a tree on the left. But since multiple note trees can be shared, it might be useful to display a list of all the different share trees.</p><p>To do so, create a shared text note and apply the <code>shareIndex</code> label. When viewed, the list of shared roots will be displayed at the bottom of the note.</p><h3>Linking to an external website</h3><p>Sometimes it's useful to include a link to an external website alongside your shared notes — for example in the shared navigation or in an index. To do so, add the <code>#shareExternalLink</code> label to a note, with the target URL as its value (e.g. <code>#shareExternalLink=\"https://example.com\"</code>).</p><p>Any link pointing to this note will then redirect to the external website and open in a new browser tab, instead of opening the note's own shared page. Opening the note's shared URL by its ID also redirects to the external website. This applies to:</p><ul><li>the listing produced by the <code>#shareIndex</code> label;</li><li>the navigation tree of the shared site;</li><li>the \"Subpages\" list shown under a parent note;</li><li>inline links to this note from within other shared notes.</li></ul><p>The URL must be absolute and include the scheme (e.g. <code>https://</code>).</p><aside class=\"admonition note\"><p>The note still exists in the share tree and its own page remains reachable by its direct URL — the label only changes how links to it behave.</p></aside><h2>Attribute reference</h2><figure class=\"table\"><table class=\"ck-table-resized\"><colgroup><col style=\"width:18.38%;\"><col style=\"width:81.62%;\"></colgroup><thead><tr><th>Attribute</th><th>Description</th></tr></thead><tbody><tr><td><code>#shareHiddenFromTree</code></td><td>this note is hidden from the left navigation tree, from its parent's list of subpages, from shared note maps and from the share's search, but still accessible with its URL</td></tr><tr><td><code>#shareExternalLink</code></td><td>when a link points to this note (from the share index, a subpage list, or an inline link in another shared note), it redirects to the given external URL in a new tab instead of the note's shared page. Value is the absolute URL, e.g. <code>https://example.com</code>.</td></tr><tr><td><code>#shareAlias</code></td><td>define an alias using which the note will be available under <code>https://your_trilium_host/share/[your_alias]</code></td></tr><tr><td><code>#shareOmitDefaultCss</code></td><td>default share page CSS will be omitted. Use when you make extensive styling changes.</td></tr><tr><td><code>#shareRoot</code></td><td>marks note which is served on /share root.</td></tr><tr><td><code>#shareDescription</code></td><td>define text to be added to the HTML meta tag for description. It also describes the note in the list of subpages of its parent, in place of the start of its text.</td></tr><tr><td><code>#shareRaw</code></td><td>Note will be served in its raw format, without HTML wrapper. See also <a class=\"reference-link\" href=\"#root/_help_Qjt68inQ2bRj\">Serving directly the content of a note</a> for an alternative method without setting an attribute.</td></tr><tr><td><code>#shareDisallowRobotIndexing</code></td><td><p>Indicates to web crawlers that the page should not be indexed of this note by:</p><ul><li>Setting the <code>X-Robots-Tag: noindex</code> HTTP header.</li><li>Setting the <code>noindex, follow</code> meta tag.</li></ul></td></tr><tr><td><code>#shareCredentials</code></td><td>require credentials to access this shared note. Value is expected to be in format <code>username:password</code>. Don't forget to make this inheritable to apply to child-notes/images.</td></tr><tr><td><code>#shareIndex</code></td><td>Note with this label will list all roots of shared notes.</td></tr><tr><td><code>#shareHtmlLocation</code></td><td>defines where custom HTML injected via <code>~shareHtml</code> relation should be placed. Applied to the HTML snippet note itself. Format: <code>location:position</code> where location is <code>head</code>, <code>body</code>, or <code>content</code> and position is <code>start</code> or <code>end</code>. Defaults to <code>content:end</code>.</td></tr></tbody></table></figure><h3>Customizing logo</h3><p>It's possible to adjust the logo which is displayed above the navigation tree (in the header, on a narrow screen).</p><figure class=\"table\"><table><thead><tr><th>Attribute</th><th>Description</th></tr></thead><tbody><tr><td><code>~shareLogo</code></td><td>Relation set to an image to use as logo. The image must be part of the share tree (it can be hidden if needed). Without it, the logo is the icon of the shared root note.</td></tr><tr><td><code>#shareLogoWidth</code></td><td>The width of the logo, as a number without unit. With <code>#shareLogoHeight</code>, it sets the proportions of the logo, which is shown 32 pixels wide. Default is <code>53</code>.</td></tr><tr><td><code>#shareLogoHeight</code></td><td>The height of the logo, as a number without unit. With <code>#shareLogoWidth</code>, it sets the proportions of the logo. Default is <code>40</code>.</td></tr><tr><td><code>#shareRootLink</code></td><td>URL to navigate to when the logo is pressed.</td></tr></tbody></table></figure><h3>Customizing OpenGraph</h3><p>A meta-property is left out of the page when its attribute is not set. Without an image, link previews use a small card.</p><figure class=\"table\"><table><thead><tr><th>Attribute</th><th>Description</th></tr></thead><tbody><tr><td><code>#shareOpenGraphColor</code></td><td>This adjusts the <code>theme-color</code> meta-property.</td></tr><tr><td><code>#shareOpenGraphURL</code></td><td>This adjusts the <code>og:url</code> and <code>twitter:url</code> meta-properties. It is also the address a relative <code>og:image</code> is completed with, so it should be the public address of the shared site, such as <code>https://example.com/share/</code>.</td></tr><tr><td><code>#shareOpenGraphDomain</code></td><td>Adjusts the <code>twitter:domain</code> meta-property.</td></tr><tr><td><code>#shareOpenGraphImage</code> <br><code>~shareOpenGraphImage</code></td><td>Can be either a label with the address of an image, or a relation to an image <a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a>. This controls the <code>og:image</code> meta-property. Sites that show a preview of the link load the image from their own servers, so a relative address, which the relation always gives, is completed with <code>#shareOpenGraphURL</code>; without it, the image does not show in such previews.</td></tr></tbody></table></figure><h2>Credits</h2><p>Since v0.95.0, a new theme was introduced (and enabled by default) which greatly improves the visual aspect of the Share feature, as well as its functionality (such as mobile support, dark/light mode, collapsible tree, etc.). This theme is an adaptation of the <a href=\"https://github.com/zerebos/trilium.rocks\">Trilium Rocks!</a> by <a href=\"https://github.com/zerebos\">zerebos</a>.</p>",+ "_help_R9pX4DGra2Vt": "<p>Trilium allows you to share selected notes as <strong>publicly accessible</strong> read-only documents. This feature is particularly useful for publishing content directly from your Trilium notes, making it accessible to others online.</p><figure class=\"image\"><img style=\"aspect-ratio:1144/660;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Sharing_image.png\" width=\"1144\" height=\"660\"></figure><h2>Features, interaction and limitations</h2><ul><li>Searching by note title.</li><li>Light and dark mode, following the visitor's system setting by default, also while the page is open. The visitor can pick <em>Light</em>, <em>Dark</em> or <em>System</em> with the buttons at the top of the navigation pane; the choice is remembered by the browser.</li><li>A layout centered on wide screens, with the navigation tree and the table of contents at either side of the content, and a mobile-friendly layout on narrow ones. There, the navigation tree slides in from the menu button in the header, and lists the headings of the current page below its entry (at the top of the pane, for a page the tree does not show).</li><li>Collapsible tree with the same note icons as the application. It keeps the sections the visitor expanded and its scroll position while they move between the pages of the site, and shows the current note.</li><li>Customizable logo.</li><li>Quick navigation buttons (previous and next note).</li><li>Notes that hide their children from the tree with <code>#subtreeHidden</code> (such as a <a class=\"reference-link\" href=\"#root/_help_CtBQqbwXDx1w\">Kanban Board</a>) show a badge counting them in place of listing them. The page of one of those children shows only that child below its parent, and the previous and next buttons skip them.</li><li>The subpages of a text or code note shown below its content as cards, as in the application. Each card shows the icon of the subpage and the start of its text (or its <code>#shareDescription</code>), or, for a subpage without text, links to its own first subpages. The cards can be hidden with <code>#hideChildrenOverview</code>.</li><li>Displaying the date of the last update of the note, written out in the application's language.</li><li>Marking the page with the application's language and its text direction, and the content of the note with its own <a href=\"#root/_help_veGu4faJErEM\">content language</a>, for screen readers and right-to-left text.</li></ul><h3>By note type</h3><figure class=\"table\"><table class=\"ck-table-resized\"><colgroup><col style=\"width:19.92%;\"><col style=\"width:41.66%;\"><col style=\"width:38.42%;\"></colgroup><thead><tr><th> </th><th>Supported features</th><th>Limitations</th></tr></thead><tbody><tr><th><a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a></th><td><ul><li>Table of contents.</li><li>A link next to each heading, shown while the pointer is over the heading. Clicking it shows the address of the section in the address bar of the browser and copies it, to share a link to the section.</li><li>Syntax highlight of code blocks, in the language selected for each block and in the colors of the VS Code light or dark theme, following the page's mode. For “Auto-detected” blocks, the language is guessed among the ones enabled in <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Code Notes</em>; a language not enabled there is not highlighted.</li><li>Rendering for math equations.</li><li><a href=\"#root/_help_nBAXQFj20hS1\">Including notes</a> (only if the included notes are also shared).</li><li>Drawing canvases, shown as pictures at their own size.</li><li>Mermaid diagrams in code blocks, drawn in the page's light or dark mode and redrawn when the visitor switches it.</li></ul></td><td> </td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a></th><td><ul><li>Syntax highlight with line numbers, in the language of the note and in the colors of the VS Code light or dark theme, following the page's mode. A language not enabled in <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Code Notes</em> is not highlighted.</li></ul></td><td> </td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a></th><td>Not supported.</td><td> </td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_iRwzGnHPzonm\">Relation Map</a></th><td>Not supported.</td><td> </td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_bdUJEHsAPYQR\">Note Map</a></th><td>Not supported.</td><td> </td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a></th><td>Not supported.</td><td> </td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a></th><td><ul><li>The child notes are shown as cards, or as a list when the view type of the collection is <em>List</em>. Each shows its icon and the start of its text (or its <code>#shareDescription</code>), or, for a child note without text, links to its own first child notes.</li></ul></td><td><ul><li>The calendar, table, board, geo map, dashboard and presentation view types are shown as in the app, but read-only.</li></ul></td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a></th><td><ul><li>The diagram is drawn in the page's light or dark mode and redrawn when the visitor switches it. In browsers with JavaScript disabled, the image saved when the note was last edited is shown instead, and the source of the diagram can be expanded below it.</li><li>The diagram fills the page and can be zoomed with the <span class=\"tn-icon bx bx-minus-circle\"></span> and <span class=\"tn-icon bx bx-plus-circle\"></span> buttons in its bottom corner or with the mouse wheel, between 50% and 1000% of its fitted size, and on touch screens by pinching. Clicking the percentage between the buttons, or double-clicking the diagram, shows it whole again. The diagram can be panned by dragging it.</li></ul></td><td> </td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a></th><td><ul><li>The diagram is displayed as a vector image.</li></ul></td><td><ul><li>No further interaction supported.</li></ul></td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_1vHRoWCEjj0L\">Web View</a></th><td>Not supported.</td><td> </td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a></th><td>The diagram is displayed as a vector image.</td><td><ul><li>No further interaction supported.</li></ul></td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map</a></th><td>Not supported.</td><td> </td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a></th><td>Basic interaction (downloading the file).</td><td><ul><li>No further interaction supported.</li></ul></td></tr></tbody></table></figure><p>While the sharing feature is powerful, it has some limitations:</p><ul><li><strong>Static Note Tree</strong></li><li><strong>Protected Notes</strong>: Cannot be shared.</li><li><strong>Include Notes</strong>: Not supported.</li></ul><p>Some of these limitations may be addressed in future updates.</p><h2>Prerequisites</h2><p>To use the sharing feature, you must have a <a class=\"reference-link\" href=\"#root/_help_WOcw2SLH6tbX\">Server Installation</a> of Trilium. This is necessary because the notes will be hosted from the server.</p><h2>Sharing a note</h2><ol><li><p><strong>Enable Sharing</strong>: To share a note, toggle the <code>Shared</code> switch within the note's interface. Once sharing is enabled, an URL will appear, which you can click to access the shared note.</p><p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Sharing_share-single-note.png\" alt=\"Share Note\"></p></li><li><p><strong>Access the Shared Note</strong>: The link provided will open the note in your browser. If your server is not configured with a public IP, the URL will refer to <code>localhost (127.0.0.1)</code>.</p></li></ol><h2>Sharing a note subtree</h2><p>When you share a note, you actually share the entire subtree of notes beneath it. If the note has child notes, they will also be included in the shared content. For example, sharing the \"Formatting\" subtree will display a page with basic navigation for exploring all the notes within that subtree.</p><h2>Viewing and managing shared notes</h2><p>You can view a list of all shared notes by clicking on <em>Advanced</em> → \"Show shared notes subtree\" in the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>. This allows you to manage and navigate through all the notes you have made public.</p><h2>Security considerations</h2><ul><li>Shared notes are published on the open internet and can be accessed by anyone with the URL unless the notes are password-protected.</li><li>The URL's randomness does not provide security, so it is crucial not to share sensitive information through this feature.</li><li>Trilium takes precautions to protect your publicly shared instance from leaking information for non-shared notes, including opening a separate read-only connection to the <a class=\"reference-link\" href=\"#root/_help_wX4HbRucYSDD\">Database</a>. Depending on your threat model, it might make more sense to use <a class=\"reference-link\" href=\"#root/_help_ycBFjKrrwE9p\">Exporting static HTML for web publishing</a> and use battle-tested web servers such as Nginx or Apache to serve static content.</li></ul><h3>Password protection</h3><p>To protect shared notes with a username and password, you can use the <code>#shareCredentials</code> attribute. Add this label to the note with the format <code>#shareCredentials=\"username:password\"</code>. To protect an entire subtree, make sure the label is <a href=\"#root/_help_bwZpz2ajCEwO\">inheritable</a>.</p><h2>Advanced sharing options</h2><h3>Customizing the appearance of shared notes</h3><p>The default design should be a good starting point, but you can customize it using your own CSS:</p><ul><li><strong>Custom CSS</strong>: Link a CSS <a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a> note to the shared page by adding a <code>~shareCss</code> relation to the note. If you want this style to apply to the entire subtree, make the label inheritable. You can hide the CSS code note from the tree navigation by adding the <code>#shareHiddenFromTree</code> label.</li><li><strong>Omitting Default CSS</strong>: For extensive styling changes, use the <code>#shareOmitDefaultCss</code> label to avoid conflicts with Trilium's <a href=\"#root/_help_Wy267RK4M69c\">default stylesheet</a>.</li></ul><h3>Adding JavaScript</h3><p>You can inject custom JavaScript into the shared note using the <code>~shareJs</code> relation. This allows you to access note attributes or traverse the note tree using the <code>fetchNote()</code> API, which retrieves note data based on its ID.</p><h3>Adding custom HTML</h3><p>You can inject custom HTML snippets into specific locations of the shared page using the <code>~shareHtml</code> relation. The HTML note should contain the raw HTML content you want to inject, and you can control where it appears by adding the <code>#shareHtmlLocation</code> label to the HTML snippet note itself.</p><p>The <code>#shareHtmlLocation</code> label accepts values in the format <code>location:position</code>:</p><ul><li><strong>Locations</strong>: <code>head</code>, <code>body</code>, <code>content</code></li><li><strong>Positions</strong>: <code>start</code>, <code>end</code></li></ul><p>For example:</p><ul><li><code>#shareHtmlLocation=head:start</code> - Injects HTML at the beginning of the <code><head></code> section</li><li><code>#shareHtmlLocation=head:end</code> - Injects HTML at the end of the <code><head></code> section (default)</li><li><code>#shareHtmlLocation=body:start</code> - Injects HTML at the beginning of the <code><body></code> section</li><li><code>#shareHtmlLocation=content:start</code> - Injects HTML at the beginning of the content area</li><li><code>#shareHtmlLocation=content:end</code> - Injects HTML at the end of the content area</li></ul><p>If no location is specified, the HTML will be injected at <code>content:end</code> by default.</p><p>Example:</p><pre><code class=\"language-text-javascript\">const currentNote = await fetchNote();\nconst parentNote = await fetchNote(currentNote.parentNoteIds[0]);\n\nfor (const attr of parentNote.attributes) {\n console.log(attr.type, attr.name, attr.value);\n}</code></pre><h3>Custom share templates</h3><p>To completely redesign the share, it is possible to create or use an existing <a href=\"#root/_help_Ad7Ku5gOHrDU\">custom share template</a>.</p><h3>Creating human-readable URL aliases</h3><p>Shared notes typically have URLs like <code>http://domain.tld/share/knvU8aJy4dJ7</code>, where the last part is the note's ID. You can make these URLs more user-friendly by adding the <code>#shareAlias</code> label to individual notes (e.g., <code>#shareAlias=highlighting</code>). This will change the URL to <code>http://domain.tld/share/highlighting</code>. The URL with the note's ID keeps working and redirects to the alias.</p><p><strong>Important</strong>:</p><ol><li>Ensure that aliases are unique.</li><li>Using slashes (<code>/</code>) within aliases to create subpaths is not supported.</li></ol><aside class=\"admonition tip\"><ul><li>To easily identify pages that don't have a share alias, run a <a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a> with <code>#!shareAlias</code>.</li><li>To be able to enter the share alias faster, consider using <a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a> (for example <code>#label:shareAlias(inheritable)=\"promoted,alias=Slug,single,text\"</code>).</li></ul></aside><h3>Setting a custom favicon</h3><p>To customize the favicon for your shared pages, create a relation <code>~shareFavicon</code> pointing to a file note containing the favicon (e.g., in <code>.ico</code> format).</p><h3>Sharing a note as the root</h3><p>You can designate a specific note or folder as the root of your shared content by adding the <code>#shareRoot</code> label. This note will be linked when visiting <code>[http://domain.tld/share](http://domain/share)</code>, making it easier to use Trilium as a fully-fledged website.</p><aside class=\"admonition tip\"><p>Consider combining this with the <code>#shareIndex</code> label, which will display a list of all shared notes.</p></aside><h3>Displaying an index of shared notes</h3><p>When accessing a share, the sub-notes will be displayed in a tree on the left. But since multiple note trees can be shared, it might be useful to display a list of all the different share trees.</p><p>To do so, create a shared text note and apply the <code>shareIndex</code> label. When viewed, the list of shared roots will be displayed at the bottom of the note.</p><h3>Linking to an external website</h3><p>Sometimes it's useful to include a link to an external website alongside your shared notes — for example in the shared navigation or in an index. To do so, add the <code>#shareExternalLink</code> label to a note, with the target URL as its value (e.g. <code>#shareExternalLink=\"https://example.com\"</code>).</p><p>Any link pointing to this note will then redirect to the external website and open in a new browser tab, instead of opening the note's own shared page. Opening the note's shared URL by its ID also redirects to the external website. This applies to:</p><ul><li>the listing produced by the <code>#shareIndex</code> label;</li><li>the navigation tree of the shared site;</li><li>the \"Subpages\" list shown under a parent note;</li><li>inline links to this note from within other shared notes.</li></ul><p>The URL must be absolute and include the scheme (e.g. <code>https://</code>).</p><aside class=\"admonition note\"><p>The note still exists in the share tree and its own page remains reachable by its direct URL — the label only changes how links to it behave.</p></aside><h2>Attribute reference</h2><figure class=\"table\"><table class=\"ck-table-resized\"><colgroup><col style=\"width:18.38%;\"><col style=\"width:81.62%;\"></colgroup><thead><tr><th>Attribute</th><th>Description</th></tr></thead><tbody><tr><td><code>#shareHiddenFromTree</code></td><td>this note is hidden from the left navigation tree, from its parent's list of subpages, from shared note maps and from the share's search, but still accessible with its URL</td></tr><tr><td><code>#shareExternalLink</code></td><td>when a link points to this note (from the share index, a subpage list, or an inline link in another shared note), it redirects to the given external URL in a new tab instead of the note's shared page. Value is the absolute URL, e.g. <code>https://example.com</code>.</td></tr><tr><td><code>#shareAlias</code></td><td>define an alias using which the note will be available under <code>https://your_trilium_host/share/[your_alias]</code></td></tr><tr><td><code>#shareOmitDefaultCss</code></td><td>default share page CSS will be omitted. Use when you make extensive styling changes.</td></tr><tr><td><code>#shareRoot</code></td><td>marks note which is served on /share root.</td></tr><tr><td><code>#shareDescription</code></td><td>define text to be added to the HTML meta tag for description. It also describes the note in the list of subpages of its parent, in place of the start of its text.</td></tr><tr><td><code>#shareRaw</code></td><td>Note will be served in its raw format, without HTML wrapper. See also <a class=\"reference-link\" href=\"#root/_help_Qjt68inQ2bRj\">Serving directly the content of a note</a> for an alternative method without setting an attribute.</td></tr><tr><td><code>#shareDisallowRobotIndexing</code></td><td><p>Indicates to web crawlers that the page should not be indexed of this note by:</p><ul><li>Setting the <code>X-Robots-Tag: noindex</code> HTTP header.</li><li>Setting the <code>noindex, follow</code> meta tag.</li></ul></td></tr><tr><td><code>#shareCredentials</code></td><td>require credentials to access this shared note. Value is expected to be in format <code>username:password</code>. Don't forget to make this inheritable to apply to child-notes/images.</td></tr><tr><td><code>#shareIndex</code></td><td>Note with this label will list all roots of shared notes.</td></tr><tr><td><code>#shareHtmlLocation</code></td><td>defines where custom HTML injected via <code>~shareHtml</code> relation should be placed. Applied to the HTML snippet note itself. Format: <code>location:position</code> where location is <code>head</code>, <code>body</code>, or <code>content</code> and position is <code>start</code> or <code>end</code>. Defaults to <code>content:end</code>.</td></tr></tbody></table></figure><h3>Customizing logo</h3><p>It's possible to adjust the logo which is displayed above the navigation tree (in the header, on a narrow screen).</p><figure class=\"table\"><table><thead><tr><th>Attribute</th><th>Description</th></tr></thead><tbody><tr><td><code>~shareLogo</code></td><td>Relation set to an image to use as logo. The image must be part of the share tree (it can be hidden if needed). Without it, the logo is the icon of the shared root note.</td></tr><tr><td><code>#shareLogoWidth</code></td><td>The width of the logo, as a number without unit. With <code>#shareLogoHeight</code>, it sets the proportions of the logo, which is shown 32 pixels wide. Default is <code>53</code>.</td></tr><tr><td><code>#shareLogoHeight</code></td><td>The height of the logo, as a number without unit. With <code>#shareLogoWidth</code>, it sets the proportions of the logo. Default is <code>40</code>.</td></tr><tr><td><code>#shareRootLink</code></td><td>URL to navigate to when the logo is pressed.</td></tr></tbody></table></figure><h3>Customizing OpenGraph</h3><p>A meta-property is left out of the page when its attribute is not set. Without an image, link previews use a small card.</p><figure class=\"table\"><table><thead><tr><th>Attribute</th><th>Description</th></tr></thead><tbody><tr><td><code>#shareOpenGraphColor</code></td><td>This adjusts the <code>theme-color</code> meta-property.</td></tr><tr><td><code>#shareOpenGraphURL</code></td><td>This adjusts the <code>og:url</code> and <code>twitter:url</code> meta-properties. It is also the address a relative <code>og:image</code> is completed with, so it should be the public address of the shared site, such as <code>https://example.com/share/</code>.</td></tr><tr><td><code>#shareOpenGraphDomain</code></td><td>Adjusts the <code>twitter:domain</code> meta-property.</td></tr><tr><td><code>#shareOpenGraphImage</code> <br><code>~shareOpenGraphImage</code></td><td>Can be either a label with the address of an image, or a relation to an image <a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a>. This controls the <code>og:image</code> meta-property. Sites that show a preview of the link load the image from their own servers, so a relative address, which the relation always gives, is completed with <code>#shareOpenGraphURL</code>; without it, the image does not show in such previews.</td></tr></tbody></table></figure><h2>Credits</h2><p>Since v0.95.0, a new theme was introduced (and enabled by default) which greatly improves the visual aspect of the Share feature, as well as its functionality (such as mobile support, dark/light mode, collapsible tree, etc.). This theme is an adaptation of the <a href=\"https://github.com/zerebos/trilium.rocks\">Trilium Rocks!</a> by <a href=\"https://github.com/zerebos\">zerebos</a>.</p>","_help_Qjt68inQ2bRj": "<p>When accessing a shared note, Trilium will render it as a web page. Sometimes it's desirable to serve the content directly so that it can be used in a script or downloaded by the user.</p><figure class=\"table\"><table><thead><tr><th>A note displayed as a web page (HTML)</th><th>A note displayed as a raw format</th></tr></thead><tbody><tr><td><figure class=\"image\"><img style=\"aspect-ratio:738/275;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Sharing/Serving%20directly%20the%20content%20of%20a%20note_image.png\" width=\"738\" height=\"275\"></figure></td><td><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Sharing/Serving%20directly%20the%20content%20of%20a%20note_image.jpg\"></td></tr></tbody></table></figure><h2>By adding an attribute to the note</h2><p>Simply add the <code>#shareRaw</code> attribute and the note will always be rendered <em>raw</em> when accessed from the share URL.</p><h2>By altering the URL</h2><p>Append <code>?raw</code> to the URL to display a note in its raw format regardless of whether the <code>#shareRaw</code> attribute is added on the note.</p><p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Sharing/Serving%20directly%20the%20content%20of%20a%20note_image.jpg\"></p>","_help_ycBFjKrrwE9p": "<p>As described in <a class=\"reference-link\" href=\"#root/_help_R9pX4DGra2Vt\">Sharing</a>, Trilium can act as a public server in which the shared notes are displayed in read-only mode. While this can work in most cases, it's generally not meant for high-traffic websites and since it's running on a Node.js server it can be potentially exploited.</p><p>Another alternative is to generate static HTML files (just like other static site generators such as <a href=\"https://www.mkdocs.org/\">MkDocs</a>). Since the normal HTML ZIP export does not contain any styling or additional functionality, Trilium provides a way to export the same layout and style as the <a class=\"reference-link\" href=\"#root/_help_R9pX4DGra2Vt\">Sharing</a> function into static HTML files.</p><p>Apart from the enhanced security, these HTML files are also easy to deploy on “serverless” deployments such as GitHub Pages or CloudFlare Pages and cache very easily.</p><aside class=\"admonition tip\"><p>Trilium's documentation, available at <a href=\"https://docs.triliumnotes.org/\">docs.triliumnotes.org</a> is built using this function of exporting to static HTML files which are then deployed automatically to CloudFlare Pages.</p><p>The process is <a href=\"https://github.com/TriliumNext/Trilium/blob/main/apps/edit-docs/src/build-docs.ts\">automated</a> by importing the Markdown documentation and exporting it via a script to the static web format.</p></aside><h2>Differences from normal sharing</h2><p>Apart from normal <a class=\"reference-link\" href=\"#root/_help_R9pX4DGra2Vt\">Sharing</a>, exporting to static HTML files comes with a few subtle differences:</p><ul><li>The URL structure is different. Where in normal sharing it's something along the way of <code>example.com/share/noteid</code>, the notes follow an hierarchical structure, such as <code>docs.triliumnotes.org/user-guide/concepts/navigation/tree-concepts</code>.</li><li>The <code>favicon.ico</code> is not handled automatically, it needs to be manually added on the server after the export is generated.</li><li>The “Last updated” for notes is not available.</li><li>The search functionality works slightly different since the normal one requires an active API to work. In the static export, search still works but uses a different mechanism so results might be different.</li></ul><h2>Differences from normal .zip export</h2><ul><li>The name of the files/URLs will prefer <code>shareAlias</code> to allow for clean URLs.</li><li>The export requires a functional web server as the pages will not render properly if accessed locally via a web browser due to the use of module scripts.</li><li>The directory structure is also slightly different:<ul><li>A normal HTML export results in an index file and a single directory.</li><li>Instead, for static exporting the top-root level becomes the index file and the child directories are on the root instead.</li><li>This makes it possible to easily publish to a website, without forcing everything but the root note to be in a sub-directory.</li></ul></li></ul><h2>Testing locally</h2><p>As mentioned previously, the exported static pages require a website to function. In order to test locally, a web server needs to be used.</p><p>One example is to use the Node.js-based <a href=\"https://www.npmjs.com/package/http-server\"><code>http-server</code></a> which can be installed via:</p><pre><code class=\"language-text-x-trilium-auto\">npm i -g http-server</code></pre><p>Once installed simply:</p><ol><li>Extract the exported .zip file.</li><li>Inside the extracted directory, run <code>http-server</code>.</li><li>Access the indicated address (e.g. <a href=\"http://localhost:8080\">http://localhost:8080</a>).</li></ol><h2>Automation</h2><p><a class=\"reference-link\" href=\"#root/_help_pgxEVkzLl1OP\">ETAPI (REST API)</a> could potentially be used to automate an export on a scheduled task.</p>","_help_sLIJ6f1dkJYW": "<p>It might be desirable to only expose the share functionality of Trilium to the Internet, and keep the application accessible only within a local network or via VPN.</p><p>To do so, a reverse proxy is required.</p><h2>Caddy</h2><pre><code class=\"language-text-x-trilium-auto\">http://domain.com {\n reverse_proxy /share http://localhost:8080/share\n}</code></pre><p>This is for newer versions where the share functionality is isolated, for older versions it's required to also include <code>/assets</code>.<a href=\"#fn2b8mg20aol8\"><sup>[1]</sup></a></p><ol><li><p><a href=\"#fnref2b8mg20aol8\"><strong><sup>^</sup></strong></a></p><p><a href=\"https://github.com/orgs/TriliumNext/discussions/7341#discussioncomment-14679897\">https://github.com/orgs/TriliumNext/discussions/7341#discussioncomment-14679897</a></p></li></ol>",@@ -217,13 +217,13 @@"_help_R7abl2fc6Mxi": "<p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Advanced%20Showcases/Weight%20Tracker_image.jpg\"></p><p>The <code>Weight Tracker</code> is a <a href=\"#root/_help_GLks18SNjxmC\">Script API</a> showcase present in the <a href=\"#root/_help_wX4HbRucYSDD\">demo notes</a>.</p><p>By adding <code>weight</code> as a <a href=\"#root/_help_OFXdgB2nNk1F\">promoted attribute</a> in the <a href=\"#root/_help_KC1HB96bqqHX\">template</a> from which <a href=\"#root/_help_l0tKav7yLHGF\">day notes</a> are created, you can aggregate the data and plot weight change over time.</p><h2>Implementation</h2><p>The <code>Weight Tracker</code> note in the screenshot above is of the type <code>Render Note</code>. That type of note doesn't have any useful content itself. Instead it is a placeholder where a <a href=\"#root/_help_CdNpE2pqjmI6\">script</a> can render its output.</p><p>Scripts for <code>Render Notes</code> are defined in a <a href=\"#root/_help_zEY4DaJG4YT5\">relation</a> called <code>~renderNote</code>. In this example, it's the <code>Weight Tracker</code>'s child <code>Implementation</code>. The Implementation consists of two <a href=\"#root/_help_6f9hih2hXXZk\">code notes</a> that contain some HTML and JavaScript respectively, which load all the notes with a <code>weight</code> attribute and display their values in a chart.</p><p>To actually render the chart, we're using a third party library called <a href=\"https://www.chartjs.org/\">chart.js</a>which is imported as an attachment, since it's not built into Trilium.</p><h3>Code</h3><p>Here's the content of the script which is placed in a <a href=\"#root/_help_6f9hih2hXXZk\">code note</a> of type <code>JS Frontend</code>:</p><pre><code class=\"language-text-x-trilium-auto\">async function getChartData() {\n const days = await api.runOnBackend(async () => {\n const notes = api.getNotesWithLabel('weight');\n const days = [];\n\n for (const note of notes) {\n const date = note.getLabelValue('dateNote');\n const weight = parseFloat(note.getLabelValue('weight'));\n\n if (date && weight) {\n days.push({ date, weight });\n }\n }\n\n days.sort((a, b) => a.date > b.date ? 1 : -1);\n\n return days;\n });\n\n const datasets = [\n {\n label: \"Weight (kg)\",\n backgroundColor: 'red',\n borderColor: 'red',\n data: days.map(day => day.weight),\n fill: false,\n spanGaps: true,\n datalabels: {\n display: false\n }\n }\n ];\n\n return {\n datasets: datasets,\n labels: days.map(day => day.date)\n };\n}\n\nconst ctx = $(\"#canvas\")[0].getContext(\"2d\");\n\nnew chartjs.Chart(ctx, {\n type: 'line',\n data: await getChartData()\n});</code></pre><h2>How to remove the Weight Tracker button from the top bar</h2><p>In the link map of the <code>Weight Tracker</code>, there is a note called <code>Button</code>. Open it and delete or comment out its contents. The <code>Weight Tracker</code> button will disappear after you restart Trilium.</p>","_help_xYjQUYhpbUEW": "<p>Task Manager is a <a href=\"#root/_help_OFXdgB2nNk1F\">promoted attributes</a> and <a href=\"#root/_help_CdNpE2pqjmI6\">scripts</a>showcase present in the <a href=\"#root/_help_wX4HbRucYSDD\">demo notes</a>.</p><h2>Demo</h2><p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Advanced%20Showcases/Task%20Manager_task-manager.png\"></p><p>Task Manager manages outstanding (TODO) tasks and finished tasks (non-empty doneDate attribute). Outstanding tasks are further categorized by location and arbitrary tags - whenever you change tag attribute in the task note, this task is then automatically moved to appropriate location.</p><p>Task Manager also integrates with <a href=\"#root/_help_l0tKav7yLHGF\">day notes</a> - notes are <a href=\"#root/_help_IakOLONlIfGI\">cloned</a> into day note to both todoDate note and doneDate note (with <a href=\"#root/_help_kBrnXNG3Hplm\">prefix</a> of either \"TODO\" or \"DONE\").</p><h2>Implementation</h2><p>New tasks are created in the TODO note which has <code>~child:template</code> <a href=\"#root/_help_zEY4DaJG4YT5\">relation</a>(see <a href=\"#root/_help_bwZpz2ajCEwO\">attribute inheritance</a>) pointing to the task template.</p><h3>Attributes</h3><p>Task template defines several <a href=\"#root/_help_OFXdgB2nNk1F\">promoted attributes</a> - todoDate, doneDate, tags, location. Importantly it also defines <code>~runOnAttributeChange</code> relation - <a href=\"#root/_help_GPERMystNGTB\">event</a> handler which is run on attribute change. This <a href=\"#root/_help_CdNpE2pqjmI6\">script</a> 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.</p><h3>New task button</h3><p>There's also \"button\" note which contains simple script which adds a button to create new note (task) in the TODO note.</p><pre><code class=\"language-text-x-trilium-auto\">api.addButtonToToolbar({\n title: 'New task',\n icon: 'check',\n shortcut: 'alt+n',\n action: async () => {\n // creating notes is backend (server) responsibility so we need to pass\n // the control there\n const taskNoteId = await api.runOnBackend(async () => {\n const todoRootNote = await api.getNoteWithLabel('taskTodoRoot');\n const {note} = await api.createNote(todoRootNote.noteId, 'new task', '');\n\n return note.noteId;\n });\n\n // we got an ID of newly created note and we want to immediatelly display it\n await api.activateNewNote(taskNoteId);\n }\n});</code></pre><h3>CSS</h3><p>In the demo screenshot above you may notice that TODO tasks are in red color and DONE tasks are green.</p><p>This is done by having this CSS <a href=\"#root/_help_6f9hih2hXXZk\">code note</a> which defines extra CSS classes:</p><pre><code class=\"language-text-x-trilium-auto\">span.fancytree-node.todo .fancytree-title {\n color: red !important;\n}\n\nspan.fancytree-node.done .fancytree-title {\n color: green !important;\n}</code></pre><p>This <a href=\"#root/_help_6f9hih2hXXZk\">code note</a> has <code>#appCss</code> <a href=\"#root/_help_zEY4DaJG4YT5\">label</a>which is recognized by Trilium on startup and loaded as CSS into the application.</p><p>Second part of this functionality is based in event handler described above which assigns <code>#cssClass</code> label to the task to either \"done\" or \"todo\" based on the task status.</p>","_help_i16PM6A7GXdU": "<p>Trilium features customizable to-do list task states. To customize them, go to <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Text Notes</em> → <em>Related settings</em> → <em>Custom checkbox states for to-do lists</em>. Alternatively, right-click a checkbox in an editable text note and click the pencil icon.</p><aside class=\"admonition warning\"><p>Changes take effect only after restarting the application.</p></aside><h2>Creating a new task state</h2><p>Click the plus icon next to Task States in the left-side pane, then define the task details as described in the next section.</p><h2>Editing a task state</h2><p>Selecting any state other than \"None\" and \"Done\" (which cannot be modified) from the side pane reveals the following editable fields:</p><ul><li><em>Icon</em> (required): The symbol shown inside the checkbox. You can pick an icon just as you would for any regular note, including from custom icon packs.</li><li><em>Title</em> (required): The name of the task state shown in the UI. For example: \"Doing\", \"Postponed\".</li><li><em>Identifier</em> (required): A short name for the state, using only letters, digits, \"<code>-</code>\" and \"<code>_</code>\". It is stored as metadata in the note's markup and used to identify the task state. Two task states cannot share the same identifier.<br>Prefix the identifiers of your custom task states with an underscore \"<code>_</code>\" or a hyphen \"<code>-</code>\" to avoid clashes with task states that may be introduced in future versions of Trilium.</li><li><em>Markdown symbol</em>: A single character used to represent the state in Markdown syntax. For example, \"<code>#</code>\" creates a task state that can be applied in Markdown using \" <code>- [#]</code> \". Make sure no other task state uses the same symbol.</li><li><em>Counts as completed</em>: If checked, the task is treated as completed.</li><li><em>Color</em>: The color of the checkbox. Its lightness and saturation are adjusted automatically to match the current color scheme or theme.</li><li><em>Hidden from toolbar</em>: The state is not listed in the UI. This is useful when you want existing notes to keep rendering the state correctly but no longer need to apply it yourself.</li></ul><aside class=\"admonition note\"><p>The task definition details are validated at startup. If errors are found, a toast provides the details and the affected task definition is ignored.</p></aside><h2>Reordering task states</h2><p>To change the order in which task states appear in the UI and when cycling through them with the keyboard, simply reorder the states in the side pane (or tree panel, if it's the case).</p><h2>Deleting task states</h2><p>Any task state other than \"None\" and \"Done\" can be deleted.</p><p>Once deleted, to-do items using that state will no longer display the custom checkbox. They fall back to either a \"None\" or \"Done\" state, depending on the state's \"Counts as completed\" setting. The identifier and title remain stored in the note until you set the checkbox to a new state.</p><h2>Transferring notes with custom task states between Trilium database instances</h2><p>Exporting notes to another Trilium database instance preserves the task states of to-do items, but does not include the custom task definitions. As a result, the destination instance won't know how to render the checkbox unless you recreate the task state there with the same identifier and Markdown symbol.</p><aside class=\"admonition note\"><p>This is a known limitation of the current version. If there is enough interest in the community for transferring notes between Trilium database instances more easily, the Trilium team may consider a better state definition mechanism.</p></aside>",- "_help_J5Ex1ZrMbyJ6": "<p>Trilium provides a mechanism for <a href=\"#root/_help_CdNpE2pqjmI6\">scripts</a> 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. <code>/trilium buy milk</code>).</p><h2>Create note from outside Trilium</h2><p>Let's take a look at an example. The goal is to provide a REST endpoint to which we can send title and content and Trilium will create a note.</p><p>We'll start with creating a JavaScript backend <a href=\"#root/_help_6f9hih2hXXZk\">code note</a> containing:</p><pre><code class=\"language-text-x-trilium-auto\">const {req, res} = api;\nconst {secret, title, content} = req.body;\n\nif (req.method == 'POST' && secret === 'secret-password') {\n // notes must be saved somewhere in the tree hierarchy specified by a parent note. \n // This is defined by a relation from this code note to the \"target\" parent note\n // alternatively you can just use constant noteId for simplicity (get that from \"Note Info\" dialog of the desired parent note)\n const targetParentNoteId = api.currentNote.getRelationValue('targetNote');\n \n const {note} = api.createTextNote(targetParentNoteId, title, content);\n const notePojo = note.getPojo();\n\n res.status(201).json(notePojo);\n}\nelse {\n res.send(400);\n}</code></pre><p>This script note has also following two attributes:</p><ul><li>label <code>#customRequestHandler</code> with value <code>create-note</code></li><li>relation <code>~targetNote</code> pointing to a note where new notes should be saved</li></ul><h3>Explanation</h3><p>Let's test this by using an HTTP client to send a request:</p><pre><code class=\"language-text-x-trilium-auto\">POST http://your-trilium-server/custom/create-note\nContent-Type: application/json\n\n{\n \"secret\": \"secret-password\",\n \"title\": \"hello\",\n \"content\": \"world\"\n}+++++++++++++++++++++++++++++++++++++++++++++++</code></pre><p>Notice the <code>/custom</code> part in the request path - Trilium considers any request with this prefix as \"custom\" and tries to find a matching handler by looking at all notes which have <code>customRequestHandler</code> <a href=\"#root/_help_zEY4DaJG4YT5\">label</a>. Value of this label then contains a regular expression which will match the request path (in our case trivial regex \"create-note\").</p><p>Trilium will then find our code note created above and execute it. <code>api.req</code>, <code>api.res</code> are set to <a href=\"https://expressjs.com/en/api.html#req\">request</a> and <a href=\"https://expressjs.com/en/api.html#res\">response</a>objects from which we can get details of the request and also respond.</p><p>In the code note we check the request method and then use trivial authentication - keep in mind that these endpoints are by default totally unauthenticated, and you need to take care of this yourself.</p><p>Once we pass these checks we will just create the desired note using <a href=\"#root/_help_GLks18SNjxmC\">Script API</a>.</p><h2>Custom resource provider</h2><p>Another common use case is that you want to just expose a file note - in such case you create label <code>customResourceProvider</code> (value is again path regex).</p><p>For more information, see <a href=\"#root/_help_d3fAXQ2diepH\">Custom Resource Providers</a>.</p><h2>Advanced concepts</h2><p><code>api.req</code> and <code>api.res</code> are Express.js objects - you can always look into its <a href=\"https://expressjs.com/en/api.html\">documentation</a> for details.</p><h3>Parameters</h3><p>REST request paths often contain parameters in the URL, e.g.:</p><pre><code class=\"language-text-x-trilium-auto\">http://your-trilium-server/custom/notes/123</code></pre><p>The last part is dynamic so the matching of the URL must also be dynamic - for this reason the matching is done with regular expressions. Following <code>customRequestHandler</code> value would match it:</p><pre><code class=\"language-text-x-trilium-auto\">notes/([0-9]+)</code></pre><p>Additionally, this also defines a matching group with the use of parenthesis which then makes it easier to extract the value. The matched groups are available in <code>api.pathParams</code>:</p><pre><code class=\"language-text-x-trilium-auto\">const noteId = api.pathParams[0];</code></pre><p>Often you also need query params (as in e.g. <code>http://your-trilium-server/custom/notes?noteId=123</code>), you can get those with standard express <code>req.query.noteId</code>.</p>",+ "_help_J5Ex1ZrMbyJ6": "<p>Trilium provides a mechanism for <a href=\"#root/_help_CdNpE2pqjmI6\">scripts</a> 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. <code>/trilium buy milk</code>).</p><h2>Create note from outside Trilium</h2><p>Let's take a look at an example. The goal is to provide a REST endpoint to which we can send title and content and Trilium will create a note.</p><p>We'll start with creating a JavaScript backend <a href=\"#root/_help_6f9hih2hXXZk\">code note</a> containing:</p><pre><code class=\"language-text-x-trilium-auto\">const {req, res} = api;\nconst {secret, title, content} = req.body;\n\nif (req.method == 'POST' && secret === 'secret-password') {\n // notes must be saved somewhere in the tree hierarchy specified by a parent note. \n // This is defined by a relation from this code note to the \"target\" parent note\n // alternatively you can just use constant noteId for simplicity (get that from \"Note info\" dialog of the desired parent note)\n const targetParentNoteId = api.currentNote.getRelationValue('targetNote');\n \n const {note} = api.createTextNote(targetParentNoteId, title, content);\n const notePojo = note.getPojo();\n\n res.status(201).json(notePojo);\n}\nelse {\n res.send(400);\n}</code></pre><p>This script note has also following two attributes:</p><ul><li>label <code>#customRequestHandler</code> with value <code>create-note</code></li><li>relation <code>~targetNote</code> pointing to a note where new notes should be saved</li></ul><h3>Explanation</h3><p>Let's test this by using an HTTP client to send a request:</p><pre><code class=\"language-text-x-trilium-auto\">POST http://your-trilium-server/custom/create-note\nContent-Type: application/json\n\n{\n \"secret\": \"secret-password\",\n \"title\": \"hello\",\n \"content\": \"world\"\n}+++++++++++++++++++++++++++++++++++++++++++++++</code></pre><p>Notice the <code>/custom</code> part in the request path - Trilium considers any request with this prefix as \"custom\" and tries to find a matching handler by looking at all notes which have <code>customRequestHandler</code> <a href=\"#root/_help_zEY4DaJG4YT5\">label</a>. Value of this label then contains a regular expression which will match the request path (in our case trivial regex \"create-note\").</p><p>Trilium will then find our code note created above and execute it. <code>api.req</code>, <code>api.res</code> are set to <a href=\"https://expressjs.com/en/api.html#req\">request</a> and <a href=\"https://expressjs.com/en/api.html#res\">response</a>objects from which we can get details of the request and also respond.</p><p>In the code note we check the request method and then use trivial authentication - keep in mind that these endpoints are by default totally unauthenticated, and you need to take care of this yourself.</p><p>Once we pass these checks we will just create the desired note using <a href=\"#root/_help_GLks18SNjxmC\">Script API</a>.</p><h2>Custom resource provider</h2><p>Another common use case is that you want to just expose a file note - in such case you create label <code>customResourceProvider</code> (value is again path regex).</p><p>For more information, see <a href=\"#root/_help_d3fAXQ2diepH\">Custom Resource Providers</a>.</p><h2>Advanced concepts</h2><p><code>api.req</code> and <code>api.res</code> are Express.js objects - you can always look into its <a href=\"https://expressjs.com/en/api.html\">documentation</a> for details.</p><h3>Parameters</h3><p>REST request paths often contain parameters in the URL, e.g.:</p><pre><code class=\"language-text-x-trilium-auto\">http://your-trilium-server/custom/notes/123</code></pre><p>The last part is dynamic so the matching of the URL must also be dynamic - for this reason the matching is done with regular expressions. Following <code>customRequestHandler</code> value would match it:</p><pre><code class=\"language-text-x-trilium-auto\">notes/([0-9]+)</code></pre><p>Additionally, this also defines a matching group with the use of parenthesis which then makes it easier to extract the value. The matched groups are available in <code>api.pathParams</code>:</p><pre><code class=\"language-text-x-trilium-auto\">const noteId = api.pathParams[0];</code></pre><p>Often you also need query params (as in e.g. <code>http://your-trilium-server/custom/notes?noteId=123</code>), you can get those with standard express <code>req.query.noteId</code>.</p>","_help_d3fAXQ2diepH": "<p>A custom resource provider allows any file imported into Trilium (images, fonts, stylesheets) to be publicly accessible via a URL.</p><p>A potential use case for this is to add embed a custom font alongside a theme.</p><h2>Steps for creating a custom resource provider</h2><ol><li>Import a file such as an image or a font into Trilium by drag & drop.</li><li>Set the <a href=\"#root/_help_HI6GBBIduIgv\">label</a> <code>#customResourceProvider</code> to <code>hello</code>.</li><li>To test if it is working, use a browser to navigate to <code><protocol>://<host>/custom/hello</code> (where <code><protocol></code> is either <code>http</code> or <code>https</code> based on your setup, and <code><host></code> is the host or IP to your Trilium server instance). If you are running the TriliumNext application without a server, use <code>http://localhost:37840</code> as the base URL.</li><li>If everything went well, at the previous step the browser should have downloaded the file uploaded in the first step.</li></ol><p>Instead of <code>hello</code>, the name can be:</p><ul><li>A path, such as <code>fonts/Roboto.ttf</code>, which would be accessible via <code><host>/custom/fonts/Roboto.ttf</code>.</li><li>As a more advanced use case, a regular expression to match multiple routes, such as <code>hello/.*</code> which will be accessible via <code>/custom/hello/1</code>, <code>/custom/hello/2</code>, <code>/custom/hello/world</code>, etc.</li></ul><h2>Using it in a theme</h2><p>For example, if you have a custom font to be imported by the theme, first upload a font file into Trilium and assign it the <code>#customResourceProvider=fonts/myfont.ttf</code> attribute.</p><p>Then modify the theme CSS to point to:</p><pre><code class=\"language-text-css\">@font-face {\n\tfont-family: customFont;\n\tsrc: url(\"/custom/fonts/myfont.ttf\");\n}\n\ndiv {\n\tfont-family: customFont;\n}</code></pre>","_help_pgxEVkzLl1OP": "<aside class=\"admonition tip\"><p>For a quick start, consult the <a class=\"reference-link\" href=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/ETAPI%20(REST%20API)/API%20Reference.dat\">API Reference</a>.</p></aside><p>ETAPI is Trilium's public/external REST API. It is available since Trilium v0.50.</p><h2>API clients</h2><p>As an alternative to calling the API directly, there are client libraries to simplify this</p><ul><li><a href=\"https://github.com/Nriver/trilium-py\">trilium-py</a>, you can use Python to communicate with Trilium.</li></ul><h2>Obtaining a token</h2><p>All operations with the REST API have to be authenticated using a token. You can get this token either from Options -> ETAPI or programmatically using the <code>/auth/login</code> REST call (see the <a href=\"https://github.com/TriliumNext/Trilium/blob/master/src/etapi/etapi.openapi.yaml\">spec</a>).</p><h2>Authentication</h2><h3>Via the <code>Authorization</code> header</h3><pre><code class=\"language-text-x-trilium-auto\">GET https://myserver.com/etapi/app-info\nAuthorization: ETAPITOKEN</code></pre><p>where <code>ETAPITOKEN</code> is the token obtained in the previous step.</p><p>For compatibility with various tools, it's also possible to specify the value of the <code>Authorization</code> header in the format <code>Bearer ETAPITOKEN</code> (since 0.93.0).</p><h3>Basic authentication</h3><p>Since v0.56 you can also use basic auth format:</p><pre><code class=\"language-text-x-trilium-auto\">GET https://myserver.com/etapi/app-info\nAuthorization: Basic BATOKEN</code></pre><ul><li>Where <code>BATOKEN = BASE64(username + ':' + password)</code> - this is a standard Basic Auth serialization</li><li>Where <code>username</code> is \"etapi\"</li><li>And <code>password</code> is the generated ETAPI token described above.</li></ul><p>Basic Auth is meant to be used with tools which support only basic auth.</p><h2>Interaction using Bash scripts</h2><p>It is possible to write simple Bash scripts to interact with Trilium. As an example, here's how to obtain the HTML content of a note:</p><pre><code class=\"language-text-x-trilium-auto\">#!/usr/bin/env bash\n\n# Configuration\nTOKEN=z1vA4fkGxjOR_ZXLrZeqHEFOv65yV3882iFCRtNIK9k9iWrHliITNSLQ=\nSERVER=http://localhost:8080\n\n# Download a note by ID\nNOTE_ID=\"i6ra4ZshJhgN\"\ncurl \"$SERVER/etapi/notes/$NOTE_ID/content\" -H \"Authorization: $TOKEN\" </code></pre><p>Make sure to replace the values of:</p><ul><li><code>TOKEN</code> with your ETAPI token.</li><li><code>SERVER</code> with the correct protocol, host name and port to your Trilium instance.</li><li><code>NOTE_ID</code> with an existing note ID to download.</li></ul><p>As another example, to obtain a .zip export of a note and place it in a directory called <code>out</code>, simply replace the last statement in the script with:</p><pre><code class=\"language-text-x-trilium-auto\">curl -H \"Authorization: $TOKEN\" \\\n\t-X GET \"$SERVER/etapi/notes/$NOTE_ID/export\" \\\n --output \"out/$NOTE_ID.zip\"</code></pre><h2>Uploading binary content</h2><p>A JSON request body can only carry text, so the <code>content</code> field of <code>POST /etapi/attachments</code> stores exactly the string it receives. To upload an image, a PDF or any other binary file, send the raw bytes to the content endpoint with the <code>application/octet-stream</code> content type. The same applies to the content of a note (<code>PUT /etapi/notes/{noteId}/content</code>).</p><p>To attach a file to a note, create the attachment without content, then upload the file to it:</p><pre><code class=\"language-text-x-trilium-auto\">ATTACHMENT_ID=$(curl -s -X POST \"$SERVER/etapi/attachments\" \\\n -H \"Authorization: $TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d \"{\\\"ownerId\\\": \\\"$NOTE_ID\\\", \\\"role\\\": \\\"file\\\", \\\"mime\\\": \\\"application/pdf\\\", \\\"title\\\": \\\"report.pdf\\\", \\\"position\\\": 10}\" \\\n | jq -r .attachmentId)\n\ncurl -X PUT \"$SERVER/etapi/attachments/$ATTACHMENT_ID/content\" \\\n -H \"Authorization: $TOKEN\" \\\n -H \"Content-Type: application/octet-stream\" \\\n --data-binary @report.pdf</code></pre><p>Use <code>--data-binary</code> rather than <code>-d</code>, which strips line breaks from the file. For an image, set <code>role</code> to <code>image</code> and <code>mime</code> to the image's type, such as <code>image/png</code>.</p>","_help_47ZrP6FNuoG8": "<p>When a new note is created, its name is by default \"new note\". In some cases, it can be desirable to have a different or even a dynamic default note title.</p><p>For this use case, Trilium (since v0.52) supports <code>#titleTemplate</code> <a href=\"#root/_help_zEY4DaJG4YT5\">label</a>. You can create such a label for a given note, assign it a value, and this value will be used as a default title when creating child notes. As with other labels, you can make it inheritable to apply recursively, and you can even place it on the root note to have it applied globally everywhere.</p><p>As an example use case, imagine you collect books you've read in a given year like this:</p><ul><li>2022 Books<ul><li>Neal Stephenson: Anathem, 2008</li><li>Franz Kafka: Die Verwandlung, 1915</li></ul></li></ul><p>Now, to the parent note \"2022 Books\" you can assign label <code>#titleTemplate=\"[Author name]: [Book title], [Publication year]\"</code>.</p><p>And all children of \"2022 Books\" will be created with initial title \"[Author name]: [Book title], [Publication year]\". There's no artificial intelligence here, the idea is to just prompt you to manually fill in the pieces of information into the note title by yourself.</p><h2>Titles set by a template</h2><p>A template can name the notes created from it, wherever they are created. To do so, add a <code>#template:titleTemplate</code> label to the template note, for example <code>#template:titleTemplate=\"Meeting ${now.format('YYYY-MM-DD')}\"</code> on a <em>Meeting</em> template.</p><ul><li>It applies both when the template is picked explicitly and when it comes from a parent's <code>~child:template</code>. See <a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>.</li><li>It takes precedence over the parent's <code>#titleTemplate</code>. A title typed in by the user always wins.</li><li>It can be inherited from the template's ancestors in the tree (for example, a folder holding several templates), in which case a label owned by the template itself takes precedence. A note created from a template and later marked as a template does not keep that template's title.</li><li>Its value is evaluated the same way as <code>#titleTemplate</code>, with <code>parentNote</code> being the parent of the new note.</li></ul><h2>Dynamic value</h2><p>The value of <code>#titleTemplate</code> is evaluated at the point of note's creation as a JavaScript string, which means it can be enriched with the help of JS string interpolation with dynamic data.</p><p>Second variable injected is <code>parentNote</code> which gives access to the parent <a href=\"{{helpAssets}}/User%20Guide/Scripting/Script%20API/Frontend%20API/FNote.dat\"><code>FNote</code></a>.</p><p>See also <a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a> which provides similar capabilities, including default note's content.</p><h3>Examples</h3><ul><li>Imagine you collect server outage incidents and write some notes. It looks like this:<ul><li>Incidents<ul><li>2022-05-09: System crash</li><li>2022-05-15: Backup delay</li></ul></li><li>You can automatize the date assignment by assigning a label <code>#titleTemplate=\"${now.format('YYYY-MM-DD')}: \"</code> to the parent note \"Incidents\". Whenever a new child note is created, the title template is evaluated with the injected <a href=\"https://day.js.org/docs/en/display/format\">now</a> object.</li></ul></li><li>To use a parent's attribute in the title of new notes: <code>#titleTemplate=\"${parentNote.getLabelValue('authorName')}'s literary works\"</code></li><li>To mirror the parent's note title: <code>${parentNote.title}</code></li></ul>","_help_wX4HbRucYSDD": "<p>Your Trilium data is stored in a <a href=\"https://www.sqlite.org\">SQLite</a> database which contains all notes, tree structure, metadata, and most of the configuration. The database file is named <code>document.db</code> and is stored in the application's default <a href=\"#root/_help_tAassRL4RSQL\">Data directory</a>.</p><h2>Demo Notes</h2><p>When first starting Trilium, it will provide a set of notes to showcase various features of the application.</p><p>For more information see <a class=\"reference-link\" href=\"#root/_help_6tZeKvSHEUiB\">Demo Notes</a>.</p><h2>Manually Modifying the Database</h2><p>Trilium provides a lot of flexibility, and with it, opportunities for advanced users to tweak it. If you need to explore or modify the database directly, you can use a tool such as <a href=\"https://sqlitebrowser.org/\">SQLite Browser</a> to work directly on the database file.</p><p>See <a href=\"#root/_help_oyIAJ9PvvwHX\">Manually altering the database</a> for more information.</p><h2>How to Reset the Database</h2><p>If you want to start again and:</p><ul><li>Create and switch to a new blank knowledge base</li><li>Use a different knowledge base synced from a server or desktop application</li><li>Restore a backup</li></ul><p>You can navigate to <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Database</em> and click the <em>Start over</em> button. You'll be prompted to restart the application, with the option to back up your current database before proceeding.</p><aside class=\"admonition important\"><p>For the web client, Trilium cannot restart automatically. You'll need to manually restart the server/container and then reload the web application.</p></aside><p>After restarting, the setup screen will appear. You can choose to back up your existing database, then proceed with the setup menu as if it's a new installation. The existing database will only be overwritten after selecting to create a new database, sync with a server, or restore from a backup.</p><h3>The Legacy Method</h3><p>If you are experimenting with Trilium and want to return it to its original state, you can do that by deleting the current database. When you restart the application, it will generate a new database containing the original demo notes.</p><p>To delete the database, simply go to the <a href=\"#root/_help_tAassRL4RSQL\">data directory</a> and delete the <code>document.db</code> file (and any other files starting with <code>document.db</code>).</p><p>If you do not need to preserve any configurations that might be stored in the <code>config.ini</code> file, you can just delete all of the <a href=\"#root/_help_tAassRL4RSQL\">data directory's</a> contents to fully restore the application to its original state. You can also review the <a href=\"#root/_help_Gzjqa934BdH4\">configuration</a> file to provide all <code>config.ini</code> values as environment variables instead.</p>","_help_oyIAJ9PvvwHX": "<p>There are some situations where modifying the SQLite database that Trilium uses is desirable.</p><p>If you are doing any advanced development or troubleshooting where you manually modify the database, you might want to consider creating backups of your <code>document.db</code> file.</p><h2>Modifying it internally using the SQL Console</h2><p>The SQL Console is Trilium's built-in database editor.</p><p>See <a class=\"reference-link\" href=\"#root/_help_YKWqdJhzi2VY\">SQL Console</a>.</p><h2>Externally modifying the database</h2><p>Sometimes the SQL Console cannot be used (for example if the application cannot start).</p><p>When making external modifications, consider closing the desktop application. If modifying the server database, then stop the service or Docker container.</p><h3>Using DB Browser for SQLite</h3><p>DB Browser for SQLite is a cross-platform editor that can be used to alter the database using a graphical user interface.</p><p>To do so:</p><ol><li>In the main menu, select File → Open database… and navigate to the database in the <a href=\"#root/_help_tAassRL4RSQL\">Data directory</a>.</li><li>Select the <em>Execute SQL</em> tab.</li><li>Type in the desired SQL statement.</li><li>Press the \"Play\" button in the toolbar underneath the \"Execute SQL\" tab (or F5 key).</li><li>Press \"Write Changes\" in the main toolbar.</li><li>Close the application or close the database.</li></ol><p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Database/Manually%20altering%20the%20database_image.jpg\"></p><h3>Using the SQLite CLI</h3><p>First, start the SQLite 3 CLI by specifying the path to the database:</p><pre><code class=\"language-text-x-trilium-auto\">sqlite3 ~/.local/share/trilium-data/document.db</code></pre><ul><li>In the prompt simply type the statement and make sure it ends with a <code>;</code> character.</li><li>To exit, simply type <code>.quit</code> and enter.</li></ul>",- "_help_YKWqdJhzi2VY": "<aside class=\"admonition important\"><p>Starting with v0.104.0, backend scripts are disabled by default to reduce the attack surface. See <a class=\"reference-link\" href=\"#root/_help_fiHicjpHjIRJ\">Security</a> for more information.</p></aside><p>The SQL Console is Trilium's built-in database editor.</p><p>It can be accessed by going to the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> → Advanced → Open SQL Console.</p><p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Database/Manually%20altering%20the%20database/SQL%20Console_image.jpg\"></p><h3>Interaction</h3><ul><li>Hovering the mouse over one of the tables listed at the top of the document will show the columns and their data type.</li><li>Only one SQL statement can be run at once.</li><li>To run the statement, press the <em>Execute</em> icon.</li><li>For queries that return a result, the data will displayed in a table.</li><li>For statements (e.g. <code>INSERT</code>, <code>UPDATE</code>), the number of affected rows is displayed.</li></ul><figure class=\"image\"><img style=\"aspect-ratio:1124/571;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Database/Manually%20altering%20the%20database/SQL%20Console_image.png\" width=\"1124\" height=\"571\"></figure><h3>Interacting with the table</h3><p>After executing a query, a table with the results will be displayed:</p><ul><li>Clicking on a column allows sorting ascending or descending.</li><li>Underneath each column there is an input field which allows filtering by text.</li><li>Press <kbd>Ctrl</kbd>+<kbd>C</kbd> to copy the current cell to clipboard.</li><li>Multiple cells can be selected by dragging or by holding <kbd>Shift</kbd> + arrow keys</li><li>Results are paginated for performance reasons. The controls at the bottom of the table can be used to navigate through pages.</li></ul><h3>Saved SQL console</h3><p>SQL queries or commands can be saved into a dedicated note.</p><p>To do so, simply write the query and press the <span class=\"tn-icon bx bx-save\"></span> button. Once saved, the note will appear in <a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a> by default. It is possible to change the default location of saved queries by assigning a <code>#sqlConsoleHome</code> <a href=\"#root/_help_HI6GBBIduIgv\">label</a>.</p><p>The note can be locked for editing by pressing the <em>Lock</em> button in the note actions section near the title bar. When editing is locked, the SQL statement is hidden from view.</p>",+ "_help_YKWqdJhzi2VY": "<aside class=\"admonition important\"><p>Starting with v0.104.0, backend scripts are disabled by default to reduce the attack surface. See <a class=\"reference-link\" href=\"#root/_help_fiHicjpHjIRJ\">Security</a> for more information.</p></aside><p>The SQL Console is Trilium's built-in database editor.</p><p>It can be accessed by going to the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> → Advanced → Open SQL console.</p><p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Database/Manually%20altering%20the%20database/SQL%20Console_image.jpg\"></p><h3>Interaction</h3><ul><li>Hovering the mouse over one of the tables listed at the top of the document will show the columns and their data type.</li><li>Only one SQL statement can be run at once.</li><li>To run the statement, press the <em>Execute</em> icon.</li><li>For queries that return a result, the data will displayed in a table.</li><li>For statements (e.g. <code>INSERT</code>, <code>UPDATE</code>), the number of affected rows is displayed.</li></ul><figure class=\"image\"><img style=\"aspect-ratio:1124/571;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Database/Manually%20altering%20the%20database/SQL%20Console_image.png\" width=\"1124\" height=\"571\"></figure><h3>Interacting with the table</h3><p>After executing a query, a table with the results will be displayed:</p><ul><li>Clicking on a column allows sorting ascending or descending.</li><li>Underneath each column there is an input field which allows filtering by text.</li><li>Press <kbd>Ctrl</kbd>+<kbd>C</kbd> to copy the current cell to clipboard.</li><li>Multiple cells can be selected by dragging or by holding <kbd>Shift</kbd> + arrow keys</li><li>Results are paginated for performance reasons. The controls at the bottom of the table can be used to navigate through pages.</li></ul><h3>Saved SQL console</h3><p>SQL queries or commands can be saved into a dedicated note.</p><p>To do so, simply write the query and press the <span class=\"tn-icon bx bx-save\"></span> button. Once saved, the note will appear in <a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a> by default. It is possible to change the default location of saved queries by assigning a <code>#sqlConsoleHome</code> <a href=\"#root/_help_HI6GBBIduIgv\">label</a>.</p><p>The note can be locked for editing by pressing the <em>Lock</em> button in the note actions section near the title bar. When editing is locked, the SQL statement is hidden from view.</p>","_help_6tZeKvSHEUiB": "<p>When you run Trilium for the first time, it will generate a new database containing demo notes. These notes showcase its many features, such as:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_iRwzGnHPzonm\">Relation Map</a></li><li><a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a></li><li><a class=\"reference-link\" href=\"#root/_help_R7abl2fc6Mxi\">Weight Tracker</a></li><li><a class=\"reference-link\" href=\"#root/_help_xYjQUYhpbUEW\">Task Manager</a></li><li><a class=\"reference-link\" href=\"#root/_help_Wy267RK4M69c\">Themes</a></li></ul><h3>Restoring Demo Notes</h3><p>There are some cases in which you may want to restore the original demo notes. For example, if you experimented with some of the more advanced features and want to see the original reference, or if you simply want to explore the latest version of the demo notes, which might showcase new features.</p><p>You can easily restore the demo notes by using Trilium's built-in import feature by importing them:</p><ul><li>Download <a href=\"https://github.com/TriliumNext/Trilium/raw/refs/heads/main/apps/server/src/assets/db/demo.zip\">the .zip archive</a> with the latest version of the demo notes</li><li>Right click on any note in your tree under which you would like the demo notes to be imported</li><li>Click \"Import into note…\"</li><li>Select the .zip archive to import it</li></ul>","_help_Gzjqa934BdH4": "<p>Trilium supports configuration via a file named <code>config.ini</code> and environment variables. This document provides a comprehensive reference for all configuration options.</p><h2>Location of the configuration file</h2><p>The configuration file is not located in the same directory as the application. Instead, the <code>config.ini</code> is located in the <a class=\"reference-link\" href=\"#root/_help_tAassRL4RSQL\">Data directory</a>. As such, the configuration file is only available after starting the application and creating a database.</p><h2>Configuration Precedence</h2><p>Configuration values are loaded in the following order of precedence (highest to lowest):</p><ol><li><strong>Environment variables</strong> (checked first)</li><li><strong>config.ini file values</strong></li><li><strong>Default values</strong></li></ol><h2>Environment Variable Patterns</h2><p>Trilium supports multiple environment variable patterns for flexibility. The primary pattern is: <code>TRILIUM_[SECTION]_[KEY]</code></p><p>Where:</p><ul><li><code>SECTION</code> is the INI section name in UPPERCASE</li><li><code>KEY</code> is the camelCase configuration key converted to UPPERCASE (e.g., <code>instanceName</code> → <code>INSTANCENAME</code>)</li></ul><p>Additionally, shorter aliases are available for common configurations (see Alternative Variables section below).</p><h2>Environment Variable Reference</h2><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">General</p><div class=\"trilium-tab-panel\"><figure class=\"table\"><table><thead><tr><th>Environment Variable</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>TRILIUM_GENERAL_INSTANCENAME</code></td><td>string</td><td>\"\"</td><td>Instance name for API identification</td></tr><tr><td><code>TRILIUM_GENERAL_NOAUTHENTICATION</code></td><td>boolean</td><td>false</td><td>Disable authentication (server only)</td></tr><tr><td><code>TRILIUM_GENERAL_NOBACKUP</code></td><td>boolean</td><td>false</td><td>Disable automatic backups</td></tr><tr><td><code>TRILIUM_GENERAL_NODESKTOPICON</code></td><td>boolean</td><td>false</td><td>Disable desktop icon creation</td></tr><tr><td><code>TRILIUM_GENERAL_READONLY</code></td><td>boolean</td><td>false</td><td>Enable read-only mode</td></tr></tbody></table></figure></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Network</p><div class=\"trilium-tab-panel\"><figure class=\"table\"><table><thead><tr><th>Environment Variable</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>TRILIUM_NETWORK_HOST</code></td><td>string</td><td>\"0.0.0.0\"</td><td>Server host binding</td></tr><tr><td><code>TRILIUM_NETWORK_PORT</code></td><td>string</td><td>\"8080\"</td><td>Server port</td></tr><tr><td><code>TRILIUM_NETWORK_HTTPS</code></td><td>boolean</td><td>false</td><td>Enable HTTPS</td></tr><tr><td><code>TRILIUM_NETWORK_CERTPATH</code></td><td>string</td><td>\"\"</td><td>SSL certificate path</td></tr><tr><td><code>TRILIUM_NETWORK_KEYPATH</code></td><td>string</td><td>\"\"</td><td>SSL key path</td></tr><tr><td><code>TRILIUM_NETWORK_TRUSTEDREVERSEPROXY</code></td><td>string</td><td>false</td><td>Addresses of the reverse proxy to trust, see <a href=\"#root/_help_LLzSMXACKhUs\">Trusted proxy</a></td></tr><tr><td><code>TRILIUM_NETWORK_CORSALLOWORIGIN</code></td><td>string</td><td>\"\"</td><td>CORS allowed origins</td></tr><tr><td><code>TRILIUM_NETWORK_CORSALLOWMETHODS</code></td><td>string</td><td>\"\"</td><td>CORS allowed methods</td></tr><tr><td><code>TRILIUM_NETWORK_CORSALLOWHEADERS</code></td><td>string</td><td>\"\"</td><td>CORS allowed headers</td></tr><tr><td><code>TRILIUM_NETWORK_CORSRESOURCEPOLICY</code></td><td>string</td><td>same-origin</td><td>CORS Resource Policy allows same-origin/same-site/cross-origin as values, will error if not</td></tr></tbody></table></figure></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Session</p><div class=\"trilium-tab-panel\"><figure class=\"table\"><table><thead><tr><th>Environment Variable</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>TRILIUM_SESSION_COOKIEMAXAGE</code></td><td>integer</td><td>1814400</td><td>Session cookie max age in seconds (21 days)</td></tr></tbody></table></figure></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Sync</p><div class=\"trilium-tab-panel\"><figure class=\"table\"><table><thead><tr><th>Environment Variable</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>TRILIUM_SYNC_SYNCSERVERHOST</code></td><td>string</td><td>\"\"</td><td>Sync server host URL</td></tr><tr><td><code>TRILIUM_SYNC_SYNCSERVERTIMEOUT</code></td><td>string</td><td>\"120000\"</td><td>Sync server timeout in milliseconds</td></tr><tr><td><code>TRILIUM_SYNC_SYNCPROXY</code></td><td>string</td><td>\"\"</td><td>Sync proxy URL</td></tr></tbody></table></figure></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">MultiFactorAuthentication</p><div class=\"trilium-tab-panel\"><p>See <a class=\"reference-link\" href=\"#root/_help_x1lQNKQBqLcA\">Signing in with OpenID Connect</a>.</p></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Logging</p><div class=\"trilium-tab-panel\"><figure class=\"table\"><table><thead><tr><th>Environment Variable</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>TRILIUM_LOGGING_RETENTIONDAYS</code></td><td>integer</td><td>90</td><td>Number of days to retain log files</td></tr></tbody></table></figure></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Development</p><div class=\"trilium-tab-panel\"><figure class=\"table\"><table><thead><tr><th>Environment Variable</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>TRILIUM_MANUAL_DB_MIGRATION</code></td><td>boolean</td><td>false</td><td>If <code>true</code>, the application will not start if automatic database migrations are pending and would modify the database schema.</td></tr></tbody></table></figure></div></section></div><details class=\"trilium-collapsible\"><summary>Alternative environment variables</summary><p>The following alternative environment variable names are also supported and work identically to their longer counterparts.</p><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Network CORS</p><div class=\"trilium-tab-panel\"><ul><li><code>TRILIUM_NETWORK_CORS_ALLOW_ORIGIN</code> (alternative to <code>TRILIUM_NETWORK_CORSALLOWORIGIN</code>)</li><li><code>TRILIUM_NETWORK_CORS_ALLOW_METHODS</code> (alternative to <code>TRILIUM_NETWORK_CORSALLOWMETHODS</code>)</li><li><code>TRILIUM_NETWORK_CORS_ALLOW_HEADERS</code> (alternative to <code>TRILIUM_NETWORK_CORSALLOWHEADERS</code>)</li><li><code>TRILIUM_NETWORK_CORS_RESOURCE_POLICY</code> (alternative to <code>TRILIUM_NETWORK_CORSRESOURCEPOLICY</code>)</li></ul></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Sync</p><div class=\"trilium-tab-panel\"><ul><li><code>TRILIUM_SYNC_SERVER_HOST</code> (alternative to <code>TRILIUM_SYNC_SYNCSERVERHOST</code>)</li><li><code>TRILIUM_SYNC_SERVER_TIMEOUT</code> (alternative to <code>TRILIUM_SYNC_SYNCSERVERTIMEOUT</code>)</li><li><code>TRILIUM_SYNC_SERVER_PROXY</code> (alternative to <code>TRILIUM_SYNC_SYNCPROXY</code>)</li></ul></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">OAuth/MFA</p><div class=\"trilium-tab-panel\"><ul><li><code>TRILIUM_OAUTH_BASE_URL</code> (alternative to <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHBASEURL</code>)</li><li><code>TRILIUM_OAUTH_CLIENT_ID</code> (alternative to <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTID</code>)</li><li><code>TRILIUM_OAUTH_CLIENT_SECRET</code> (alternative to <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTSECRET</code>)</li><li><code>TRILIUM_OAUTH_ISSUER_BASE_URL</code> (alternative to <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERBASEURL</code>)</li><li><code>TRILIUM_OAUTH_ISSUER_NAME</code> (alternative to <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERNAME</code>)</li><li><code>TRILIUM_OAUTH_ISSUER_ICON</code> (alternative to <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERICON</code>)</li><li><code>TRILIUM_OAUTH_HTTP_TIMEOUT</code> (alternative to <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHHTTPTIMEOUT</code>)</li><li><code>TRILIUM_OAUTH_SCOPE</code> (alternative to <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHSCOPE</code>)</li></ul></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Logging</p><div class=\"trilium-tab-panel\"><ul><li><code>TRILIUM_LOGGING_RETENTION_DAYS</code> (alternative to <code>TRILIUM_LOGGING_RETENTIONDAYS</code>)</li></ul></div></section></div></details><h2>Boolean Values</h2><p>Boolean environment variables accept the following values:</p><ul><li><strong>True</strong>: <code>\"true\"</code>, <code>\"1\"</code>, <code>1</code></li><li><strong>False</strong>: <code>\"false\"</code>, <code>\"0\"</code>, <code>0</code></li><li>Any other value defaults to <code>false</code></li></ul><h2>Using Environment Variables</h2><p>Both naming patterns are fully supported and can be used interchangeably:</p><ul><li>The longer format follows the section/key pattern for consistency with the INI file structure</li><li>The shorter alternatives provide convenience for common configurations</li><li>You can use whichever format you prefer - both are equally valid</li></ul><h2>Examples</h2><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-docker\"></span> Docker Compose</p><div class=\"trilium-tab-panel\"><pre><code class=\"language-text-x-yaml\">services:\n trilium:\n image: triliumnext/trilium\n environment:\n # Using full format\n TRILIUM_GENERAL_INSTANCENAME: \"My Trilium Instance\"\n TRILIUM_NETWORK_PORT: \"8080\"\n TRILIUM_NETWORK_CORSALLOWORIGIN: \"https://myapp.com\"\n TRILIUM_SYNC_SYNCSERVERHOST: \"https://sync.example.com\"\n TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHBASEURL: \"https://auth.example.com\"\n \n # Or using shorter alternatives (equally valid)\n # TRILIUM_NETWORK_CORS_ALLOW_ORIGIN: \"https://myapp.com\"\n # TRILIUM_SYNC_SERVER_HOST: \"https://sync.example.com\"\n # TRILIUM_OAUTH_BASE_URL: \"https://auth.example.com\"</code></pre></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-tux\"></span> Linux Shell</p><div class=\"trilium-tab-panel\"><pre><code class=\"language-text-x-trilium-auto\"># Using either format\nexport TRILIUM_GENERAL_NOAUTHENTICATION=false\nexport TRILIUM_NETWORK_HTTPS=true\nexport TRILIUM_NETWORK_CERTPATH=/path/to/cert.pem\nexport TRILIUM_NETWORK_KEYPATH=/path/to/key.pem\nexport TRILIUM_LOGGING_RETENTIONDAYS=30\n\n# Start Trilium\nnpm start</code></pre></div></section></div><h2>config.ini Reference</h2><p>For the complete list of configuration options and their INI file format, please review the <a href=\"https://github.com/TriliumNext/Trilium/blob/main/apps/server/src/assets/config-sample.ini\">config-sample.ini</a> file in the Trilium repository.</p>","_help_c5xB8m4g2IY6": "<p>A Trilium instance represents a server. If <a class=\"reference-link\" href=\"#root/_help_cbkrhQjrkKrh\">Synchronization</a> is set up, since multiple servers are involved (the one from the desktop client and the one the synchronisation is set up with), sometimes it can be useful to distinguish the instance you are running on.</p><h2>Setting the instance name</h2><p>To set up a name for the instance, modify the <code>config.ini</code>:</p><pre><code class=\"language-text-x-trilium-auto\">[General]\ninstanceName=Hello</code></pre><h2>Distinguishing the instance on back-end</h2><p>Use <code>api.getInstanceName()</code> to obtain the instance name of the current server, as specified in the config file or in environment variables.</p><h2>Limiting script runs based on instance</h2><p>For a script that is run periodically or on a certain event, it's possible to limit it to certain instances without having to change the code. Just add <code>runOnInstance</code> and set as the value the instance name where the script should run. To run on multiple named instances, simply add the label multiple times.</p>",@@ -233,7 +233,7 @@"_help_1YeN2MzFUluU": "<p>One core aspect of Trilium that allows it to have support for multiple <a href=\"#root/_help_KSZ04uQ2D1St\">Note Types</a> is the fact that it makes use of various off-the-shelf or reusable libraries.</p><p>This page showcases some of the technologies used, for a better understanding of how Trilium works but also to credit the developers of that particular technology.</p><h2>CKEditor</h2><p>CKEditor is the editor behind <a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a> notes, as well as integrated in various facets of the application such as the attribute editor in the <a class=\"reference-link\" href=\"#root/_help_AlJ73vBCjWDw\">Status bar</a> or the chat box in the <a class=\"reference-link\" href=\"#root/_help_GBBMSlVSOIGP\">AI</a> sidebar or notes.</p><p>For more information see <a class=\"reference-link\" href=\"#root/_help_MI26XDLSAlCD\">CKEditor</a>.</p><h2>Excalidraw</h2><p><a href=\"https://excalidraw.com/\">Excalidraw</a> is the technology behind the <a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a> notes. The source code of the library is available on <a href=\"https://github.com/excalidraw/excalidraw\">GitHub</a>.</p><p>We are using an unmodified version of it, so it shares the same <a href=\"https://github.com/excalidraw/excalidraw/issues\">issues</a> as the original.</p><h2>MapLibre GL JS</h2><p>Trilium v0.105.0 introduces <a href=\"https://github.com/maplibre/maplibre-gl-js\">MapLibre GL JS</a> for the <a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map</a> collection, which brings improved performance by using graphical acceleration (WebGL). Trilium ships its own track parsing logic as well as most of the UI such as the right panel.</p><h2>MindElixir</h2><p>MindElixir is the library we are using for <a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a> note types. The main library is available on <a href=\"https://github.com/SSShooter/mind-elixir-core/issues\">GitHub as mind-elixir-core</a>.</p><p>Trilium ships its own UI which covers the toolbars, the contextual menu, the zoom buttons and the right panel that shows when clicking a node.</p><h2>FullCalendar</h2><p><a href=\"https://fullcalendar.io/\">FullCalendar</a> is the technology behind the <a class=\"reference-link\" href=\"#root/_help_xWbu3jpNWapp\">Calendar</a> collection, providing the various views (day, week, month, year) and the event management. Trilium also ships its own UI in the form of the popup that appears when editing, as well as the header that appears in the <a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>.</p><p>Licensed under the MIT license.</p>","_help_MI26XDLSAlCD": "<h2>Editor core</h2><p>The CKEditor is the WYSIWYG (standing for What You See Is What You Get) editor behind <a href=\"#root/_help_iPIMuisry3hd\">Text</a> notes.</p><p>Their website is <a href=\"https://ckeditor.com/\">ckeditor.com</a>.</p><p>CKEditor by itself is a commercial product, but the core is open-source. As described in <a href=\"https://ckeditor.com/docs/ckeditor5/latest/features/index.html\">its documentation</a>, the editor supports quite a large number of features. Do note that not all the features are enabled in Trilium.</p><h2>Premium features</h2><p>CKEditor ships some plugins as premium (slash commands, templates, AI integration). Initially Trilium (since v0.96.0) shipped some of them like slash commands as part of a license grant from CKEditor to the Trilium Notes developers.</p><p>In v0.105.0 we've decided to replace those premium plugins with our own open-source implementations. This also means that we can better tailor those plugins to the Trilium app.</p><h2>Plugins</h2><p>The CKEditor ecosystem is quite extensible, in the sense that custom plugins can be written to extend the functionality of the editor beyond its original scope.</p><p>Trilium makes use of such features:</p><ul><li>The math feature is added by a version of <a href=\"https://github.com/isaul32/ckeditor5-math\">isaul32/ckeditor5-math: Math feature for CKEditor 5.</a> modified by us to fit our needs.</li><li><a href=\"https://github.com/mlewand/ckeditor5-keyboard-marker\">mlewand/ckeditor5-keyboard-marker: Plugin adds support for the keyboard input element (<code><kbd></code>) to CKEditor 5.</a></li><li>A modified version of <a href=\"https://github.com/ThomasAitken/ckeditor5-footnotes\">ThomasAitken/ckeditor5-footnotes: Footnotes plugin for CKEditor5</a> to allow footnotes.</li></ul><p>Apart from that, Trilium also has its own set of specific plugins such as:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_2x0ZAX9ePtzV\">Cut to subnote</a></li><li><a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>, which also shows drawing canvases and <a href=\"#root/_help_CohkqWQC1iBv\">Mermaid diagrams</a> in place.</li><li>Mentions, for linking pages.</li><li><a class=\"reference-link\" href=\"#root/_help_Oau6X9rCuegd\">Markdown</a></li><li><a href=\"#root/_help_QEAPj01N5f7w\">Reference links</a></li><li><a href=\"#root/_help_NwBbFdNZ9h7O\">Admonitions</a>, we ended up creating our own plugin but <a href=\"https://github.com/aarkue/ckeditor5-admonition\">aarkue/ckeditor5-admonition</a> was a good inspiration (including the toolbar icon).</li></ul>","_help_m1lbrzyKDaRB": "<p>Whereas some applications use file names to uniquely identify notes, Trilium uses the concept of Note ID.</p><p>Generally, the Note ID is a 12-character long alphanumeric sequence (including both lower and upper case letter) that is randomly generated for each new note.</p><h2>How does the import/export affect the note IDs</h2><p>When notes are exported, their note ID is kept in the metadata of the export. However when they are imported back in, a new note ID is generated for all the notes. This also includes other entities that are part of the import/export process such as <a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>.</p><h2>Note collisions</h2><p>Since the Note ID is a fixed-width randomly generated number, due to the <a href=\"https://en.wikipedia.org/wiki/Pigeonhole_principle\">pigeonhole principle</a>, there is a possibility that a newly created note will have the same ID as an existing note.</p><p>Since the note ID is alphanumeric and the length is 12 we have <span class=\"math-tex\">\\(62^{12}\\)</span> unique IDs. However since we are generating them randomly, we can use a collision calculator such as the one for <a href=\"https://alex7kom.github.io/nano-nanoid-cc/?alphabet=0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz&size=12&speed=1000&speedUnit=hour\">Nano ID</a> to determine that we'd need to create 1000 notes per hour every hour for 9 centuries in order to have at least 1% probability of a note collision.</p><p>As such, Trilium does not take any explicit action against potential note collisions, similar to other software that makes uses of unique hashes such as <a href=\"https://stackoverflow.com/questions/10434326/hash-collision-in-git\">Git</a>. If one would theoretically occur, what would most likely happen is that the existing note will be replaced by the new one.</p>",- "_help_2mUhVmZK8RF3": "<figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:263/445;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Hidden%20Notes_image.png\" width=\"263\" height=\"445\"></figure><p>For easy extensibility, a lot of features in Trilium make use of actual notes to store information as opposed to having them stored in a separate location in the database. This allows some functions such as <a class=\"reference-link\" href=\"#root/_help_zEY4DaJG4YT5\">Attributes</a>, <a class=\"reference-link\" href=\"#root/_help_Cq5X6iKQop6R\">Relations</a> or even <a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a> and <a class=\"reference-link\" href=\"#root/_help_QEAPj01N5f7w\">Links</a> to be able to operate on them.</p><p>As the name suggests, these notes are hidden to the user by default to prevent cluttering the note tree and to prevent them from being accidentally deleted.</p><p>The hidden notes are stored in the user's <a class=\"reference-link\" href=\"#root/_help_wX4HbRucYSDD\">Database</a> just like normal notes, but they have a unique <a class=\"reference-link\" href=\"#root/_help_m1lbrzyKDaRB\">Note ID</a> which allows them to be distinguished from the normal ones.</p><h2>Accessing the hidden note tree</h2><p>From the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>, select <em>Advanced</em> → <em>Show Hidden Subtree</em>.</p><h2>Contents of the hidden note tree</h2><p>Here is a brief summary of all the notes within the hidden tree:</p><figure class=\"table\"><table class=\"ck-table-resized\"><colgroup><col style=\"width:19.93%;\"><col style=\"width:80.07%;\"></colgroup><thead><tr><th>Note</th><th>Description</th></tr></thead><tbody><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_globalNoteMap\">Note Map</a></td><td><p>This note is actually opened when the <a class=\"reference-link\" href=\"#root/_help_bdUJEHsAPYQR\">Note Map</a> feature that is accessed from the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</p><p>It is possible to create any child notes in it without any additional meaning. For example, it can be used to store a list of note maps which can be linked to from other notes or <a href=\"#root/_help_u3YFHC9tQlpm\">bookmarked</a>.</p></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_sqlConsole\">SQL Console History</a></td><td><p>When SQL queries or commands are executed in the <a class=\"reference-link\" href=\"#root/_help_YKWqdJhzi2VY\">SQL Console</a>, they are stored here, grouped by month. Only the query is stored and not the results.</p><p>This section can be accessed without going to the hidden tree by simply going to the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> and selecting Advanced → Open SQL Console History.</p><p>Notes can be added as children of this tree, but it's generally not recommended to do so to not interfere with the normal history process.</p></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_search\">Search History</a></td><td><p>Whenever a search is executed from the full <a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>, the query will be stored here, grouped by month. Only the search parameters are stored and not the results themselves.</p><p>This section can be accessed without going to the hidden tree by simply going to the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> and selecting Advanced → Open Search History.</p><p>Notes can be added as children of this tree, but it's generally not recommended to do so to not interfere with the normal history process.</p></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_bulkAction\">Bulk Action</a></td><td><p>This section is used for <a class=\"reference-link\" href=\"#root/_help_ivYnonVFBxbQ\">Bulk Actions</a>. The last configuration for bulk actions will be stored as part of this note, each action in its own <code>action</code> label.</p><p>Notes can be added as children of this tree, but there won't be any benefit in doing so.</p></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_backendLog\">Backend Log</a></td><td><p>This note corresponds to the backend log feature (see <a class=\"reference-link\" href=\"#root/_help_qzNzp9LYQyPT\">Error logs</a>).</p><p>This item can be accessed without going to the hidden try by going to the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> and selecting Advanced → Show backend log.</p></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_userHidden\">User Hidden</a></td><td>This section can be used by <a href=\"#root/_help_CdNpE2pqjmI6\">scripts</a> to create their own notes that should not be directly visible to the user. The note can be identified by scripts by its unique ID: <code>_userHidden</code></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_lbTplRoot\">Launch Bar Templates</a></td><td><p>This section contains the templates for the creation of launchers in the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>. It is not possible to create child notes here.</p><p>Theoretically some of the notes here can be customized, but there's not much benefit to be had in doing so.</p></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_share\">Shared Notes</a></td><td><p>This tree lists all of the notes that are <a href=\"#root/_help_R9pX4DGra2Vt\">shared</a> publicly. It can be useful to track down which notes are shared regardless of their position in the note tree.</p><p>This section can be accessed without going to the hidden tree simply by going to the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> and selecting <em>Show Shared Notes Subtree</em>.</p><p>Sub-notes cannot be created here.</p></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_lbRoot\">Launch Bar</a></td><td><p>The tree contains both available and displayed items of the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</p><p>This section can be accessed without going to the hidden tree by:</p><ul><li>Going to the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> and selecting <em>Configure Launchbar…</em>.</li><li>Right-clicking an empty space on the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a> and selecting <em>Configure Launchbar…</em>.</li></ul><p>Sub-notes cannot be created here.</p></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_options\">Options</a></td><td><p>This section stores the list of <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>.</p><p>This section can be accessed without going to the hidden tree by:</p><ul><li>Going to the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> and selecting <em>Options</em>.</li><li>Pressing the dedicated Options icon in the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</li></ul></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_lbMobileRoot\">Mobile Launch Bar</a></td><td><p>This is very similar to the <em>Launch Bar</em>, but is dedicated for the mobile UI only.</p><p>Accessing it outside the <em>Launch Bar</em> is the same as the Launch Bar, but needs to be done so from the mobile interface.</p></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_help\">User Guide</a></td><td>This is where the User Guide appears in the note tree. Its notes are not stored in the database: Trilium builds them from files that ship with the application each time it starts, so they cannot be edited, moved or cloned, and they are not synchronized.</td></tr></tbody></table></figure>",+ "_help_2mUhVmZK8RF3": "<figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:263/445;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Hidden%20Notes_image.png\" width=\"263\" height=\"445\"></figure><p>For easy extensibility, a lot of features in Trilium make use of actual notes to store information as opposed to having them stored in a separate location in the database. This allows some functions such as <a class=\"reference-link\" href=\"#root/_help_zEY4DaJG4YT5\">Attributes</a>, <a class=\"reference-link\" href=\"#root/_help_Cq5X6iKQop6R\">Relations</a> or even <a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a> and <a class=\"reference-link\" href=\"#root/_help_QEAPj01N5f7w\">Links</a> to be able to operate on them.</p><p>As the name suggests, these notes are hidden to the user by default to prevent cluttering the note tree and to prevent them from being accidentally deleted.</p><p>The hidden notes are stored in the user's <a class=\"reference-link\" href=\"#root/_help_wX4HbRucYSDD\">Database</a> just like normal notes, but they have a unique <a class=\"reference-link\" href=\"#root/_help_m1lbrzyKDaRB\">Note ID</a> which allows them to be distinguished from the normal ones.</p><h2>Accessing the hidden note tree</h2><p>From the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>, select <em>Advanced</em> → <em>Show hidden subtree</em>.</p><h2>Contents of the hidden note tree</h2><p>Here is a brief summary of all the notes within the hidden tree:</p><figure class=\"table\"><table class=\"ck-table-resized\"><colgroup><col style=\"width:19.93%;\"><col style=\"width:80.07%;\"></colgroup><thead><tr><th>Note</th><th>Description</th></tr></thead><tbody><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_globalNoteMap\">Note Map</a></td><td><p>This note is actually opened when the <a class=\"reference-link\" href=\"#root/_help_bdUJEHsAPYQR\">Note Map</a> feature that is accessed from the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</p><p>It is possible to create any child notes in it without any additional meaning. For example, it can be used to store a list of note maps which can be linked to from other notes or <a href=\"#root/_help_u3YFHC9tQlpm\">bookmarked</a>.</p></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_sqlConsole\">SQL Console History</a></td><td><p>When SQL queries or commands are executed in the <a class=\"reference-link\" href=\"#root/_help_YKWqdJhzi2VY\">SQL Console</a>, they are stored here, grouped by month. Only the query is stored and not the results.</p><p>This section can be accessed without going to the hidden tree by simply going to the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> and selecting Advanced → Open SQL console history.</p><p>Notes can be added as children of this tree, but it's generally not recommended to do so to not interfere with the normal history process.</p></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_search\">Search History</a></td><td><p>Whenever a search is executed from the full <a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>, the query will be stored here, grouped by month. Only the search parameters are stored and not the results themselves.</p><p>This section can be accessed without going to the hidden tree by simply going to the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> and selecting Advanced → Open search history.</p><p>Notes can be added as children of this tree, but it's generally not recommended to do so to not interfere with the normal history process.</p></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_bulkAction\">Bulk Action</a></td><td><p>This section is used for <a class=\"reference-link\" href=\"#root/_help_ivYnonVFBxbQ\">Bulk Actions</a>. The last configuration for bulk actions will be stored as part of this note, each action in its own <code>action</code> label.</p><p>Notes can be added as children of this tree, but there won't be any benefit in doing so.</p></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_backendLog\">Backend Log</a></td><td><p>This note corresponds to the backend log feature (see <a class=\"reference-link\" href=\"#root/_help_qzNzp9LYQyPT\">Error logs</a>).</p><p>This item can be accessed without going to the hidden try by going to the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> and selecting Advanced → Show backend log.</p></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_userHidden\">User Hidden</a></td><td>This section can be used by <a href=\"#root/_help_CdNpE2pqjmI6\">scripts</a> to create their own notes that should not be directly visible to the user. The note can be identified by scripts by its unique ID: <code>_userHidden</code></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_lbTplRoot\">Launch Bar Templates</a></td><td><p>This section contains the templates for the creation of launchers in the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>. It is not possible to create child notes here.</p><p>Theoretically some of the notes here can be customized, but there's not much benefit to be had in doing so.</p></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_share\">Shared Notes</a></td><td><p>This tree lists all of the notes that are <a href=\"#root/_help_R9pX4DGra2Vt\">shared</a> publicly. It can be useful to track down which notes are shared regardless of their position in the note tree.</p><p>This section can be accessed without going to the hidden tree simply by going to the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> and selecting <em>Show shared notes subtree</em>.</p><p>Sub-notes cannot be created here.</p></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_lbRoot\">Launch Bar</a></td><td><p>The tree contains both available and displayed items of the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</p><p>This section can be accessed without going to the hidden tree by:</p><ul><li>Going to the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> and selecting <em>Configure launch bar…</em>.</li><li>Right-clicking an empty space on the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a> and selecting <em>Configure launch bar…</em>.</li></ul><p>Sub-notes cannot be created here.</p></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_options\">Options</a></td><td><p>This section stores the list of <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>.</p><p>This section can be accessed without going to the hidden tree by:</p><ul><li>Going to the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> and selecting <em>Options</em>.</li><li>Pressing the dedicated Options icon in the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</li></ul></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_lbMobileRoot\">Mobile Launch Bar</a></td><td><p>This is very similar to the <em>Launch Bar</em>, but is dedicated for the mobile UI only.</p><p>Accessing it outside the <em>Launch Bar</em> is the same as the Launch Bar, but needs to be done so from the mobile interface.</p></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_help\">User Guide</a></td><td>This is where the User Guide appears in the note tree. Its notes are not stored in the database: Trilium builds them from files that ship with the application each time it starts, so they cannot be edited, moved or cloned, and they are not synchronized.</td></tr></tbody></table></figure>","_help_uYF7pmepw27K": "<p>The Trilium Metrics API provides comprehensive monitoring data about your Trilium instance, designed for external monitoring systems like Prometheus.</p><h2>Endpoint</h2><ul><li><strong>URL</strong>: <code>/etapi/metrics</code></li><li><strong>Method</strong>: <code>GET</code></li><li><strong>Authentication</strong>: ETAPI token required</li><li><strong>Default Format</strong>: Prometheus text format</li></ul><h2>Authentication</h2><p>You need an ETAPI token to access the metrics endpoint. Get one by:</p><pre><code class=\"language-text-x-trilium-auto\"># Get an ETAPI token\ncurl -X POST http://localhost:8080/etapi/auth/login \\\n -H \"Content-Type: application/json\" \\\n -d '{\"password\": \"your_password\"}'\n</code></pre><h2>Usage</h2><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Prometheus Format (Default)</p><div class=\"trilium-tab-panel\"><pre><code class=\"language-text-x-trilium-auto\">curl -H \"Authorization: YOUR_ETAPI_TOKEN\" \\\n http://localhost:8080/etapi/metrics\n</code></pre><p>Returns metrics in Prometheus text format:</p><pre><code class=\"language-text-x-trilium-auto\"># HELP trilium_info Trilium instance information\n# TYPE trilium_info gauge\ntrilium_info{version=\"0.91.6\",db_version=\"231\",node_version=\"v18.17.0\"} 1 1701432000\n\n# HELP trilium_notes_total Total number of notes including deleted\n# TYPE trilium_notes_total gauge\ntrilium_notes_total 1234 1701432000</code></pre></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">JSON Format</p><div class=\"trilium-tab-panel\"><pre><code class=\"language-text-x-trilium-auto\">curl -H \"Authorization: YOUR_ETAPI_TOKEN\" \\\n \"http://localhost:8080/etapi/metrics?format=json\"\n</code></pre><p>Returns detailed metrics in JSON format for debugging or custom integrations.</p></div></section></div><h2>Available Metrics</h2><h3>Instance Information</h3><ul><li><code>trilium_info</code> - Version and build information with labels</li></ul><h3>Database Metrics</h3><ul><li><code>trilium_notes_total</code> - Total notes (including deleted)</li><li><code>trilium_notes_deleted</code> - Number of deleted notes</li><li><code>trilium_notes_active</code> - Number of active notes</li><li><code>trilium_notes_protected</code> - Number of protected notes</li><li><code>trilium_attachments_total</code> - Total attachments</li><li><code>trilium_attachments_active</code> - Active attachments</li><li><code>trilium_revisions_total</code> - Total note revisions</li><li><code>trilium_branches_total</code> - Active branches</li><li><code>trilium_attributes_total</code> - Active attributes</li><li><code>trilium_blobs_total</code> - Total blob records</li><li><code>trilium_etapi_tokens_total</code> - Active ETAPI tokens</li><li><code>trilium_embeddings_total</code> - Note embeddings (if available)</li></ul><h3>Categorized Metrics</h3><ul><li><code>trilium_notes_by_type{type=\"text|code|image|file\"}</code> - Notes by type</li><li><code>trilium_attachments_by_type{mime_type=\"...\"}</code> - Attachments by MIME type</li></ul><h3>Statistics</h3><ul><li><code>trilium_database_size_bytes</code> - Database size in bytes</li><li><code>trilium_oldest_note_timestamp</code> - Timestamp of oldest note</li><li><code>trilium_newest_note_timestamp</code> - Timestamp of newest note</li><li><code>trilium_last_modified_timestamp</code> - Last modification timestamp</li></ul><h2>Prometheus Configuration</h2><p>Add to your <code>prometheus.yml</code>:</p><pre><code class=\"language-text-x-trilium-auto\">scrape_configs:\n - job_name: 'trilium'\n static_configs:\n - targets: ['localhost:8080']\n metrics_path: '/etapi/metrics'\n bearer_token: 'YOUR_ETAPI_TOKEN'\n scrape_interval: 30s\n</code></pre><h2>Error Responses</h2><ul><li><code>400</code> - Invalid format parameter</li><li><code>401</code> - Missing or invalid ETAPI token</li><li><code>500</code> - Internal server error</li></ul><h2>Grafana Dashboard</h2><figure class=\"image\"><img style=\"aspect-ratio:2594/1568;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/1_Metrics_image.png\" width=\"2594\" height=\"1568\"></figure><p>You can also use the Grafana Dashboard that has been created for TriliumNext - just take the JSON from <a class=\"reference-link\" href=\"#root/_help_bOP3TB56fL1V\">grafana-dashboard.json</a> and then import the dashboard, following these screenshots:</p><figure class=\"image\"><img style=\"aspect-ratio:1881/282;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/2_Metrics_image.png\" width=\"1881\" height=\"282\"></figure><p>Then paste the JSON, and hit load:</p><figure class=\"image\"><img style=\"aspect-ratio:1055/830;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Metrics_image.png\" width=\"1055\" height=\"830\"></figure>","_help_bOP3TB56fL1V": "{\n \"annotations\": {\n \"list\": [\n {\n \"builtIn\": 1,\n \"datasource\": {\n \"type\": \"grafana\",\n \"uid\": \"-- Grafana --\"\n },\n \"enable\": true,\n \"hide\": true,\n \"iconColor\": \"rgba(0, 211, 255, 1)\",\n \"name\": \"Annotations & Alerts\",\n \"type\": \"dashboard\"\n }\n ]\n },\n \"editable\": true,\n \"fiscalYearStartMonth\": 0,\n \"graphTooltip\": 1,\n \"id\": 549,\n \"links\": [],\n \"panels\": [\n {\n \"collapsed\": false,\n \"gridPos\": {\n \"h\": 1,\n \"w\": 24,\n \"x\": 0,\n \"y\": 0\n },\n \"id\": 100,\n \"panels\": [],\n \"title\": \"🏠 Trilium Overview\",\n \"type\": \"row\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"description\": \"Current Trilium version and build information\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"thresholds\"\n },\n \"custom\": {\n \"align\": \"auto\",\n \"cellOptions\": {\n \"type\": \"auto\"\n },\n \"filterable\": false,\n \"inspect\": false\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\"\n }\n ]\n }\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 6,\n \"w\": 12,\n \"x\": 0,\n \"y\": 1\n },\n \"id\": 101,\n \"options\": {\n \"cellHeight\": \"sm\",\n \"footer\": {\n \"countRows\": false,\n \"fields\": \"\",\n \"reducer\": [\n \"sum\"\n ],\n \"show\": false\n },\n \"showHeader\": true\n },\n \"pluginVersion\": \"12.0.1\",\n \"targets\": [\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_info{job=~'$job',instance=~'$instance'}\",\n \"format\": \"table\",\n \"instant\": true,\n \"refId\": \"A\"\n }\n ],\n \"title\": \"📋 Instance Information\",\n \"transformations\": [\n {\n \"id\": \"organize\",\n \"options\": {\n \"excludeByName\": {\n \"Time\": true,\n \"Value\": true,\n \"__name__\": true,\n \"instance\": true,\n \"job\": true\n },\n \"indexByName\": {},\n \"renameByName\": {\n \"build_date\": \"Build Date\",\n \"build_revision\": \"Git Revision\",\n \"db_version\": \"DB Version\",\n \"node_version\": \"Node.js\",\n \"sync_version\": \"Sync Version\",\n \"version\": \"Version\"\n }\n }\n }\n ],\n \"type\": \"table\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"description\": \"Database file size in human-readable format\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"thresholds\"\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\"\n },\n {\n \"color\": \"yellow\",\n \"value\": 500000000\n },\n {\n \"color\": \"red\",\n \"value\": 1000000000\n }\n ]\n },\n \"unit\": \"decbytes\"\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 6,\n \"w\": 6,\n \"x\": 12,\n \"y\": 1\n },\n \"id\": 102,\n \"options\": {\n \"colorMode\": \"background\",\n \"graphMode\": \"area\",\n \"justifyMode\": \"center\",\n \"orientation\": \"auto\",\n \"percentChangeColorMode\": \"standard\",\n \"reduceOptions\": {\n \"calcs\": [\n \"lastNotNull\"\n ],\n \"fields\": \"\",\n \"values\": false\n },\n \"showPercentChange\": false,\n \"textMode\": \"auto\",\n \"wideLayout\": true\n },\n \"pluginVersion\": \"12.0.1\",\n \"targets\": [\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_database_size_bytes{job=~'$job',instance=~'$instance'}\",\n \"refId\": \"A\"\n }\n ],\n \"title\": \"💾 Database Size\",\n \"type\": \"stat\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"description\": \"Total active notes in your Trilium instance\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"thresholds\"\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\"\n },\n {\n \"color\": \"yellow\",\n \"value\": 1000\n },\n {\n \"color\": \"red\",\n \"value\": 5000\n }\n ]\n },\n \"unit\": \"short\"\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 6,\n \"w\": 6,\n \"x\": 18,\n \"y\": 1\n },\n \"id\": 103,\n \"options\": {\n \"colorMode\": \"background\",\n \"graphMode\": \"area\",\n \"justifyMode\": \"center\",\n \"orientation\": \"auto\",\n \"percentChangeColorMode\": \"standard\",\n \"reduceOptions\": {\n \"calcs\": [\n \"lastNotNull\"\n ],\n \"fields\": \"\",\n \"values\": false\n },\n \"showPercentChange\": false,\n \"textMode\": \"auto\",\n \"wideLayout\": true\n },\n \"pluginVersion\": \"12.0.1\",\n \"targets\": [\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_notes_active{job=~'$job',instance=~'$instance'}\",\n \"refId\": \"A\"\n }\n ],\n \"title\": \"📝 Active Notes\",\n \"type\": \"stat\"\n },\n {\n \"collapsed\": false,\n \"gridPos\": {\n \"h\": 1,\n \"w\": 24,\n \"x\": 0,\n \"y\": 7\n },\n \"id\": 200,\n \"panels\": [],\n \"title\": \"📊 Key Metrics\",\n \"type\": \"row\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"description\": \"Total notes including deleted ones\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"palette-classic\"\n },\n \"custom\": {\n \"hideFrom\": {\n \"legend\": false,\n \"tooltip\": false,\n \"viz\": false\n }\n },\n \"mappings\": [],\n \"unit\": \"short\"\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 8,\n \"w\": 6,\n \"x\": 0,\n \"y\": 8\n },\n \"id\": 201,\n \"options\": {\n \"legend\": {\n \"displayMode\": \"list\",\n \"placement\": \"bottom\",\n \"showLegend\": true,\n \"values\": []\n },\n \"pieType\": \"pie\",\n \"reduceOptions\": {\n \"calcs\": [\n \"lastNotNull\"\n ],\n \"fields\": \"\",\n \"values\": false\n },\n \"tooltip\": {\n \"hideZeros\": false,\n \"mode\": \"single\",\n \"sort\": \"none\"\n }\n },\n \"pluginVersion\": \"12.0.1\",\n \"targets\": [\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_notes_active{job=~'$job',instance=~'$instance'}\",\n \"legendFormat\": \"Active Notes\",\n \"refId\": \"A\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_notes_deleted{job=~'$job',instance=~'$instance'}\",\n \"legendFormat\": \"Deleted Notes\",\n \"refId\": \"B\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_notes_protected{job=~'$job',instance=~'$instance'}\",\n \"legendFormat\": \"Protected Notes\",\n \"refId\": \"C\"\n }\n ],\n \"title\": \"📝 Notes Distribution\",\n \"type\": \"piechart\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"description\": \"Breakdown of attachments by MIME type\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"palette-classic\"\n },\n \"custom\": {\n \"hideFrom\": {\n \"legend\": false,\n \"tooltip\": false,\n \"viz\": false\n }\n },\n \"mappings\": [],\n \"unit\": \"short\"\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 8,\n \"w\": 6,\n \"x\": 6,\n \"y\": 8\n },\n \"id\": 202,\n \"options\": {\n \"legend\": {\n \"displayMode\": \"list\",\n \"placement\": \"bottom\",\n \"showLegend\": true,\n \"values\": []\n },\n \"pieType\": \"donut\",\n \"reduceOptions\": {\n \"calcs\": [\n \"lastNotNull\"\n ],\n \"fields\": \"\",\n \"values\": false\n },\n \"tooltip\": {\n \"hideZeros\": false,\n \"mode\": \"single\",\n \"sort\": \"none\"\n }\n },\n \"pluginVersion\": \"12.0.1\",\n \"targets\": [\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_attachments_by_type{job=~'$job',instance=~'$instance'}\",\n \"legendFormat\": \"{{mime_type}}\",\n \"refId\": \"A\"\n }\n ],\n \"title\": \"🖼️ Attachments by Type\",\n \"type\": \"piechart\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"description\": \"Distribution of notes by their content type\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"palette-classic\"\n },\n \"custom\": {\n \"hideFrom\": {\n \"legend\": false,\n \"tooltip\": false,\n \"viz\": false\n }\n },\n \"mappings\": [],\n \"unit\": \"short\"\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 8,\n \"w\": 12,\n \"x\": 12,\n \"y\": 8\n },\n \"id\": 203,\n \"options\": {\n \"legend\": {\n \"displayMode\": \"table\",\n \"placement\": \"right\",\n \"showLegend\": true,\n \"values\": [\n \"value\",\n \"percent\"\n ]\n },\n \"pieType\": \"donut\",\n \"reduceOptions\": {\n \"calcs\": [\n \"lastNotNull\"\n ],\n \"fields\": \"\",\n \"values\": false\n },\n \"tooltip\": {\n \"hideZeros\": false,\n \"mode\": \"single\",\n \"sort\": \"none\"\n }\n },\n \"pluginVersion\": \"12.0.1\",\n \"targets\": [\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_notes_by_type{job=~'$job',instance=~'$instance'}\",\n \"legendFormat\": \"{{type}}\",\n \"refId\": \"A\"\n }\n ],\n \"title\": \"📄 Notes by Content Type\",\n \"type\": \"piechart\"\n },\n {\n \"collapsed\": false,\n \"gridPos\": {\n \"h\": 1,\n \"w\": 24,\n \"x\": 0,\n \"y\": 16\n },\n \"id\": 300,\n \"panels\": [],\n \"title\": \"📈 Trends & Time Series\",\n \"type\": \"row\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"description\": \"Growth of notes over time\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"palette-classic\"\n },\n \"custom\": {\n \"axisBorderShow\": false,\n \"axisCenteredZero\": false,\n \"axisColorMode\": \"text\",\n \"axisLabel\": \"\",\n \"axisPlacement\": \"auto\",\n \"barAlignment\": 0,\n \"barWidthFactor\": 0.6,\n \"drawStyle\": \"line\",\n \"fillOpacity\": 20,\n \"gradientMode\": \"hue\",\n \"hideFrom\": {\n \"legend\": false,\n \"tooltip\": false,\n \"viz\": false\n },\n \"insertNulls\": false,\n \"lineInterpolation\": \"smooth\",\n \"lineWidth\": 3,\n \"pointSize\": 8,\n \"scaleDistribution\": {\n \"type\": \"linear\"\n },\n \"showPoints\": \"auto\",\n \"spanNulls\": false,\n \"stacking\": {\n \"group\": \"A\",\n \"mode\": \"none\"\n },\n \"thresholdsStyle\": {\n \"mode\": \"off\"\n }\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\"\n }\n ]\n },\n \"unit\": \"short\"\n },\n \"overrides\": [\n {\n \"matcher\": {\n \"id\": \"byName\",\n \"options\": \"Active Notes\"\n },\n \"properties\": [\n {\n \"id\": \"color\",\n \"value\": {\n \"fixedColor\": \"blue\",\n \"mode\": \"fixed\"\n }\n }\n ]\n },\n {\n \"matcher\": {\n \"id\": \"byName\",\n \"options\": \"Total Notes\"\n },\n \"properties\": [\n {\n \"id\": \"color\",\n \"value\": {\n \"fixedColor\": \"green\",\n \"mode\": \"fixed\"\n }\n }\n ]\n }\n ]\n },\n \"gridPos\": {\n \"h\": 8,\n \"w\": 12,\n \"x\": 0,\n \"y\": 17\n },\n \"id\": 301,\n \"options\": {\n \"legend\": {\n \"calcs\": [\n \"last\",\n \"max\"\n ],\n \"displayMode\": \"table\",\n \"placement\": \"bottom\",\n \"showLegend\": true\n },\n \"tooltip\": {\n \"hideZeros\": false,\n \"mode\": \"multi\",\n \"sort\": \"desc\"\n }\n },\n \"pluginVersion\": \"12.0.1\",\n \"targets\": [\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_notes_active{job=~'$job',instance=~'$instance'}\",\n \"legendFormat\": \"Active Notes\",\n \"refId\": \"A\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_notes_total{job=~'$job',instance=~'$instance'}\",\n \"legendFormat\": \"Total Notes\",\n \"refId\": \"B\"\n }\n ],\n \"title\": \"📈 Notes Growth Over Time\",\n \"type\": \"timeseries\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"description\": \"Attachment storage trends\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"palette-classic\"\n },\n \"custom\": {\n \"axisBorderShow\": false,\n \"axisCenteredZero\": false,\n \"axisColorMode\": \"text\",\n \"axisLabel\": \"\",\n \"axisPlacement\": \"auto\",\n \"barAlignment\": 0,\n \"barWidthFactor\": 0.6,\n \"drawStyle\": \"line\",\n \"fillOpacity\": 20,\n \"gradientMode\": \"hue\",\n \"hideFrom\": {\n \"legend\": false,\n \"tooltip\": false,\n \"viz\": false\n },\n \"insertNulls\": false,\n \"lineInterpolation\": \"smooth\",\n \"lineWidth\": 3,\n \"pointSize\": 8,\n \"scaleDistribution\": {\n \"type\": \"linear\"\n },\n \"showPoints\": \"auto\",\n \"spanNulls\": false,\n \"stacking\": {\n \"group\": \"A\",\n \"mode\": \"none\"\n },\n \"thresholdsStyle\": {\n \"mode\": \"off\"\n }\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\"\n }\n ]\n },\n \"unit\": \"short\"\n },\n \"overrides\": [\n {\n \"matcher\": {\n \"id\": \"byName\",\n \"options\": \"Active Attachments\"\n },\n \"properties\": [\n {\n \"id\": \"color\",\n \"value\": {\n \"fixedColor\": \"purple\",\n \"mode\": \"fixed\"\n }\n }\n ]\n },\n {\n \"matcher\": {\n \"id\": \"byName\",\n \"options\": \"Total Attachments\"\n },\n \"properties\": [\n {\n \"id\": \"color\",\n \"value\": {\n \"fixedColor\": \"orange\",\n \"mode\": \"fixed\"\n }\n }\n ]\n }\n ]\n },\n \"gridPos\": {\n \"h\": 8,\n \"w\": 12,\n \"x\": 12,\n \"y\": 17\n },\n \"id\": 302,\n \"options\": {\n \"legend\": {\n \"calcs\": [\n \"last\",\n \"max\"\n ],\n \"displayMode\": \"table\",\n \"placement\": \"bottom\",\n \"showLegend\": true\n },\n \"tooltip\": {\n \"hideZeros\": false,\n \"mode\": \"multi\",\n \"sort\": \"desc\"\n }\n },\n \"pluginVersion\": \"12.0.1\",\n \"targets\": [\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_attachments_active{job=~'$job',instance=~'$instance'}\",\n \"legendFormat\": \"Active Attachments\",\n \"refId\": \"A\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_attachments_total{job=~'$job',instance=~'$instance'}\",\n \"legendFormat\": \"Total Attachments\",\n \"refId\": \"B\"\n }\n ],\n \"title\": \"📎 Attachments Growth Over Time\",\n \"type\": \"timeseries\"\n },\n {\n \"collapsed\": false,\n \"gridPos\": {\n \"h\": 1,\n \"w\": 24,\n \"x\": 0,\n \"y\": 25\n },\n \"id\": 400,\n \"panels\": [],\n \"title\": \"🔧 Advanced Metrics\",\n \"type\": \"row\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"description\": \"Number of branches connecting notes\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"thresholds\"\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\"\n }\n ]\n },\n \"unit\": \"short\"\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 4,\n \"w\": 6,\n \"x\": 0,\n \"y\": 26\n },\n \"id\": 401,\n \"options\": {\n \"colorMode\": \"value\",\n \"graphMode\": \"none\",\n \"justifyMode\": \"center\",\n \"orientation\": \"auto\",\n \"percentChangeColorMode\": \"standard\",\n \"reduceOptions\": {\n \"calcs\": [\n \"lastNotNull\"\n ],\n \"fields\": \"\",\n \"values\": false\n },\n \"showPercentChange\": false,\n \"textMode\": \"auto\",\n \"wideLayout\": true\n },\n \"pluginVersion\": \"12.0.1\",\n \"targets\": [\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_branches_total{job=~'$job',instance=~'$instance'}\",\n \"refId\": \"A\"\n }\n ],\n \"title\": \"🌳 Total Branches\",\n \"type\": \"stat\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"description\": \"Number of note attributes\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"thresholds\"\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\"\n }\n ]\n },\n \"unit\": \"short\"\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 4,\n \"w\": 6,\n \"x\": 6,\n \"y\": 26\n },\n \"id\": 402,\n \"options\": {\n \"colorMode\": \"value\",\n \"graphMode\": \"none\",\n \"justifyMode\": \"center\",\n \"orientation\": \"auto\",\n \"percentChangeColorMode\": \"standard\",\n \"reduceOptions\": {\n \"calcs\": [\n \"lastNotNull\"\n ],\n \"fields\": \"\",\n \"values\": false\n },\n \"showPercentChange\": false,\n \"textMode\": \"auto\",\n \"wideLayout\": true\n },\n \"pluginVersion\": \"12.0.1\",\n \"targets\": [\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_attributes_total{job=~'$job',instance=~'$instance'}\",\n \"refId\": \"A\"\n }\n ],\n \"title\": \"🏷️ Attributes\",\n \"type\": \"stat\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"description\": \"Number of note revisions\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"thresholds\"\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\"\n }\n ]\n },\n \"unit\": \"short\"\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 4,\n \"w\": 6,\n \"x\": 12,\n \"y\": 26\n },\n \"id\": 403,\n \"options\": {\n \"colorMode\": \"value\",\n \"graphMode\": \"none\",\n \"justifyMode\": \"center\",\n \"orientation\": \"auto\",\n \"percentChangeColorMode\": \"standard\",\n \"reduceOptions\": {\n \"calcs\": [\n \"lastNotNull\"\n ],\n \"fields\": \"\",\n \"values\": false\n },\n \"showPercentChange\": false,\n \"textMode\": \"auto\",\n \"wideLayout\": true\n },\n \"pluginVersion\": \"12.0.1\",\n \"targets\": [\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_revisions_total{job=~'$job',instance=~'$instance'}\",\n \"refId\": \"A\"\n }\n ],\n \"title\": \"🔄 Revisions\",\n \"type\": \"stat\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"description\": \"Number of ETAPI tokens\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"thresholds\"\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\"\n }\n ]\n },\n \"unit\": \"short\"\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 4,\n \"w\": 6,\n \"x\": 18,\n \"y\": 26\n },\n \"id\": 404,\n \"options\": {\n \"colorMode\": \"value\",\n \"graphMode\": \"none\",\n \"justifyMode\": \"center\",\n \"orientation\": \"auto\",\n \"percentChangeColorMode\": \"standard\",\n \"reduceOptions\": {\n \"calcs\": [\n \"lastNotNull\"\n ],\n \"fields\": \"\",\n \"values\": false\n },\n \"showPercentChange\": false,\n \"textMode\": \"auto\",\n \"wideLayout\": true\n },\n \"pluginVersion\": \"12.0.1\",\n \"targets\": [\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_etapi_tokens_total{job=~'$job',instance=~'$instance'}\",\n \"refId\": \"A\"\n }\n ],\n \"title\": \"🔑 API Tokens\",\n \"type\": \"stat\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"description\": \"Various storage and system metrics\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"palette-classic\"\n },\n \"custom\": {\n \"axisBorderShow\": false,\n \"axisCenteredZero\": false,\n \"axisColorMode\": \"text\",\n \"axisLabel\": \"\",\n \"axisPlacement\": \"auto\",\n \"barAlignment\": 0,\n \"barWidthFactor\": 0.6,\n \"drawStyle\": \"line\",\n \"fillOpacity\": 10,\n \"gradientMode\": \"none\",\n \"hideFrom\": {\n \"legend\": false,\n \"tooltip\": false,\n \"viz\": false\n },\n \"insertNulls\": false,\n \"lineInterpolation\": \"linear\",\n \"lineWidth\": 2,\n \"pointSize\": 5,\n \"scaleDistribution\": {\n \"type\": \"linear\"\n },\n \"showPoints\": \"auto\",\n \"spanNulls\": false,\n \"stacking\": {\n \"group\": \"A\",\n \"mode\": \"none\"\n },\n \"thresholdsStyle\": {\n \"mode\": \"off\"\n }\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\"\n }\n ]\n },\n \"unit\": \"short\"\n },\n \"overrides\": [\n {\n \"matcher\": {\n \"id\": \"byName\",\n \"options\": \"Recent Notes\"\n },\n \"properties\": [\n {\n \"id\": \"color\",\n \"value\": {\n \"fixedColor\": \"yellow\",\n \"mode\": \"fixed\"\n }\n }\n ]\n }\n ]\n },\n \"gridPos\": {\n \"h\": 8,\n \"w\": 12,\n \"x\": 0,\n \"y\": 30\n },\n \"id\": 405,\n \"options\": {\n \"legend\": {\n \"calcs\": [\n \"last\"\n ],\n \"displayMode\": \"table\",\n \"placement\": \"bottom\",\n \"showLegend\": true\n },\n \"tooltip\": {\n \"hideZeros\": false,\n \"mode\": \"multi\",\n \"sort\": \"desc\"\n }\n },\n \"pluginVersion\": \"12.0.1\",\n \"targets\": [\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_blobs_total{job=~'$job',instance=~'$instance'}\",\n \"legendFormat\": \"Blob Records\",\n \"refId\": \"A\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_recent_notes_total{job=~'$job',instance=~'$instance'}\",\n \"legendFormat\": \"Recent Notes\",\n \"refId\": \"B\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_embeddings_total{job=~'$job',instance=~'$instance'}\",\n \"legendFormat\": \"Embeddings\",\n \"refId\": \"C\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_embedding_providers_total{job=~'$job',instance=~'$instance'}\",\n \"legendFormat\": \"Embedding Providers\",\n \"refId\": \"D\"\n }\n ],\n \"title\": \"📊 Storage & System Metrics\",\n \"type\": \"timeseries\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"description\": \"Timeline showing when content was created and last modified\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"palette-classic\"\n },\n \"custom\": {\n \"axisBorderShow\": false,\n \"axisCenteredZero\": false,\n \"axisColorMode\": \"text\",\n \"axisLabel\": \"\",\n \"axisPlacement\": \"auto\",\n \"barAlignment\": 0,\n \"barWidthFactor\": 0.6,\n \"drawStyle\": \"points\",\n \"fillOpacity\": 0,\n \"gradientMode\": \"none\",\n \"hideFrom\": {\n \"legend\": false,\n \"tooltip\": false,\n \"viz\": false\n },\n \"insertNulls\": false,\n \"lineInterpolation\": \"linear\",\n \"lineWidth\": 1,\n \"pointSize\": 8,\n \"scaleDistribution\": {\n \"type\": \"linear\"\n },\n \"showPoints\": \"always\",\n \"spanNulls\": false,\n \"stacking\": {\n \"group\": \"A\",\n \"mode\": \"none\"\n },\n \"thresholdsStyle\": {\n \"mode\": \"off\"\n }\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\"\n }\n ]\n },\n \"unit\": \"dateTimeAsIso\"\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 8,\n \"w\": 12,\n \"x\": 12,\n \"y\": 30\n },\n \"id\": 406,\n \"options\": {\n \"legend\": {\n \"calcs\": [],\n \"displayMode\": \"list\",\n \"placement\": \"bottom\",\n \"showLegend\": true\n },\n \"tooltip\": {\n \"hideZeros\": false,\n \"mode\": \"single\",\n \"sort\": \"none\"\n }\n },\n \"pluginVersion\": \"12.0.1\",\n \"targets\": [\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_oldest_note_timestamp{job=~'$job',instance=~'$instance'} * 1000\",\n \"legendFormat\": \"Oldest Note\",\n \"refId\": \"A\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_newest_note_timestamp{job=~'$job',instance=~'$instance'} * 1000\",\n \"legendFormat\": \"Newest Note\",\n \"refId\": \"B\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_last_modified_timestamp{job=~'$job',instance=~'$instance'} * 1000\",\n \"legendFormat\": \"Last Modified\",\n \"refId\": \"C\"\n }\n ],\n \"title\": \"⏰ Content Timeline\",\n \"type\": \"timeseries\"\n }\n ],\n \"preload\": false,\n \"refresh\": \"1m\",\n \"schemaVersion\": 41,\n \"tags\": [\n \"trilium\",\n \"notes\",\n \"monitoring\",\n \"enhanced\"\n ],\n \"templating\": {\n \"list\": [\n {\n \"current\": {\n \"text\": \"myprom\",\n \"value\": \"PA04845DA3A4B088E\"\n },\n \"includeAll\": false,\n \"label\": \"Datasource\",\n \"name\": \"datasource\",\n \"options\": [],\n \"query\": \"prometheus\",\n \"refresh\": 1,\n \"regex\": \"//\",\n \"type\": \"datasource\"\n },\n {\n \"allValue\": \".*\",\n \"current\": {\n \"text\": \"All\",\n \"value\": \"$__all\"\n },\n \"datasource\": {\n \"UID\": \"\",\n \"type\": \"\"\n },\n \"includeAll\": true,\n \"label\": \"Job\",\n \"multi\": true,\n \"name\": \"job\",\n \"options\": [],\n \"query\": \"query_result(up)\",\n \"refresh\": 1,\n \"regex\": \"/job=\\\"([^\\\"]+)\\\"/\",\n \"sort\": 1,\n \"type\": \"query\"\n },\n {\n \"allValue\": \".*\",\n \"current\": {\n \"text\": [\n \"All\"\n ],\n \"value\": [\n \"$__all\"\n ]\n },\n \"datasource\": {\n \"type\": \"prometheus\",\n \"uid\": \"${datasource}\"\n },\n \"includeAll\": true,\n \"label\": \"Instance\",\n \"multi\": true,\n \"name\": \"instance\",\n \"options\": [],\n \"query\": \"trilium_database_size_bytes\",\n \"refresh\": 1,\n \"regex\": \"/instance=\\\"([^\\\"]+)\\\"/\",\n \"sort\": 1,\n \"type\": \"query\"\n }\n ]\n },\n \"time\": {\n \"from\": \"now-1h\",\n \"to\": \"now\"\n },\n \"timepicker\": {},\n \"timezone\": \"browser\",\n \"title\": \"TriliumNext Dashboard\",\n \"uid\": \"06993f9b-a477-4723-bf18-47743393b382\",\n \"version\": 5\n}","_help_64ZTlUPgEPtW": "<p>Safe mode is triggered by setting the <code>TRILIUM_SAFE_MODE</code> environment variable to a truthy value, usually <code>1</code>.</p><p>In each artifact there is a <code>trilium-safe-mode.sh</code> (or <code>.bat</code>) script to enable it.</p><p>What it does:</p><ul><li>Disables <code>customWidget</code> launcher types in <code>app/widgets/containers/launcher.js</code>.</li><li>Disables the running of <code>mobileStartup</code> or <code>frontendStartup</code> scripts.</li><li>Displays the root note instead of the previously saved session.</li><li>Does not run a <a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a> when it is opened; press <em>Search now</em> to run it.</li><li>Disables the running of <code>backendStartup</code>, <code>hourly</code>, <code>daily</code> scripts and checks for the hidden subtree.</li></ul>",@@ -258,7 +258,7 @@"_help_TjLYAo3JMO8X": "<aside class=\"admonition warning\"><p>This documentation is outdated, as it refers to using the deprecated <code>addButtonToToolbar</code> API which will only create widgets for desktop.</p><p>Instead, a custom launcher widget can be created using the <a class=\"reference-link\" href=\"#root/_help_4Gn3psZKsfSm\">Launch Bar Widgets</a> documentation.</p></aside><p>In this example we are going to extend the functionality of <a class=\"reference-link\" href=\"#root/_help_xYjQUYhpbUEW\">Task Manager</a> showcase (which comes by default with Trilium) by adding a button in the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a> (<span class=\"tn-icon bx bx-task\"></span>) to create a new task automatically and open it.</p><h2>Creating the note</h2><ol><li>First, create a new <a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a> note type with the <em>JavaScript (Trilium frontend)</em> language.</li><li>Define the <code>#run=frontendStartup</code> label in <a class=\"reference-link\" href=\"#root/_help_zEY4DaJG4YT5\">Attributes</a>.</li></ol><h2>Content of the script</h2><p>Copy-paste the following script:</p><pre><code class=\"language-text-javascript\">api.addButtonToToolbar({\n\ttitle: \"New task\",\n icon: \"task\",\n shortcut: \"alt+n\",\n action: async () => {\n \tconst taskNoteId = await api.runOnBackend(() => {\n \tconst todoRootNote = api.getNoteWithLabel(\"taskTodoRoot\");\n const resp = api.createTextNote(todoRootNote.noteId, \"New task\", \"\") \n return resp.note.noteId;\n });\n \n await api.waitUntilSynced();\n await api.activateNewNote(taskNoteId);\n }\n});</code></pre><h2>Testing the functionality</h2><p>Since we set the script to be run on start-up, all we need to do is to <a href=\"#root/_help_s8alTXmpFR61\">refresh the application</a>.</p><h2>Understanding how the script works</h2><figure class=\"table\"><table class=\"ck-table-resized\"><colgroup><col style=\"width:50%;\"><col style=\"width:50%;\"></colgroup><tbody><tr><td><pre><code class=\"language-text-x-trilium-auto\">api.addButtonToToolbar({\n\ttitle: \"New task\",\n icon: \"task\",\n shortcut: \"alt+n\",\n action: async () => {\n \t// [...]\n }\n});</code></pre></td><td><p>This uses the <a href=\"#root/_help_yIhgI5H7A2Sm\">Front-end API</a> to create a icon in the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>, by specifying:</p><ul><li>A title</li><li>A corresponding boxicons icon (without the <code>bx-</code> prefix).</li><li>Optionally, a keyboard shortcut to assign to it.</li><li>The action, which will be executed when the button is pressed.</li></ul></td></tr><tr><td><pre><code class=\"language-text-x-trilium-auto\">const taskNoteId = await api.runOnBackend(() => {\n // Shown below. \n return resp.note.noteId;\n});</code></pre></td><td><ul><li>This portion of code is actually executed on the server (backend) and not on the client (i.e. browser).<ul><li>The reason is that the creating notes is the responsibility of the server.</li></ul></li><li>Here we can also see that it is possible to return results from the server execution and read them in the client (<code>taskNoteId</code>).</li></ul></td></tr><tr><td><pre><code class=\"language-text-x-trilium-auto\">const todoRootNote = api.getNoteWithLabel(\"taskTodoRoot\");</code></pre></td><td><ul><li>Here we identify a note with the <a href=\"#root/_help_zEY4DaJG4YT5\">label</a> <code>#taskTodoRoot</code>. This is how the <a class=\"reference-link\" href=\"#root/_help_xYjQUYhpbUEW\">Task Manager</a> showcase knows where to place all the different tasks.</li><li>Normally this might return a <code>null</code> value if no such note could be identified, but error handling is outside the scope of this example. </li></ul></td></tr><tr><td><pre><code class=\"language-text-x-trilium-auto\">const resp = api.createTextNote(todoRootNote.noteId, \"New task\", \"\")</code></pre></td><td><ul><li>We create a new child note within the to-do root note (first argument) with the title “New task\" (second argument) and no content by default (third argument).</li></ul></td></tr><tr><td><pre><code class=\"language-text-x-trilium-auto\">await api.waitUntilSynced();</code></pre></td><td><ul><li>Back on the client, since we created a new note on the server, we now need to wait for the change to be reflected in the client.</li></ul></td></tr><tr><td><pre><code class=\"language-text-x-trilium-auto\">await api.activateNewNote(taskNoteId);</code></pre></td><td><ul><li>Since we know the <a href=\"#root/_help_m1lbrzyKDaRB\">ID</a> of the newly created note, all we have to do now is to show this note to the user.</li></ul></td></tr></tbody></table></figure>","_help_7kZPMD0uFwkH": "<p>This tutorial showcases a basic integration with Google Forms, where we are able to download the responses of a form using the “Link to Sheets\" functionality.</p><p>Note that the link will be publicly accessible to everyone (however the link is in a hard-to-guess format such as <code>https://docs.google.com/spreadsheets/d/e/2PACX-1vTA8NU2_eZFhc8TFadCZPreBfvP7un8IHd6J0SchrLLw3ueGmntNZjwRmsH2ZRcp1pJYDAzMz1FmFaj/pub?output=csv</code>). Make sure you are not accidentally publishing sensitive information.</p><h2>Obtaining the CSV link</h2><ol><li>Open the Google Forms in a browser.</li><li>Select the “Responses” tab and click on “Link to Sheets”.</li><li>Select “Create a new spreadsheet” and press “Create”.</li><li>In Google Sheets, select File → Share → Publish to web.</li><li>In the “Publish to the web” screen, make sure the “Link” tab is selected and instead of “Web page”, select “Comma-separated values (.csv)”.</li><li>Copy the given link which will be used for the upcoming script.</li></ol><h2>Creating the script</h2><p>Create a “JS Frontend” script:</p><pre><code class=\"language-text-x-trilium-auto\">const CSV_URL = \"https://docs.google.com/spreadsheets/d/e/2PACX-1vTiwooLV2whjCSVa49dJ99p_G3_qhqHHRqttMjYCJVfLXVdTgUSNJu5K0rpqmaHYF2k7Vofi3o7gW82/pub?output=csv\";\n\nasync function fetchData() {\n try {\n const response = await fetch(CSV_URL);\n return await response.text();\n } catch (e) {\n api.showError(e.message);\n }\n}\n\nconst data = await fetchData();\nconsole.log(data);\n// Do something with the data.</code></pre><p>Note that the data will be received as a string and there is no library to do the CSV parsing for us. To do a very simple parsing of CSV:</p><pre><code class=\"language-text-x-trilium-auto\">const content = data\n\t.split(\"\\n\")\n\t.slice(1)\n\t.map((row) => row.split(\",\"));</code></pre><p>This will return the data as an array of arrays.</p>","_help_DL92EjAaXT26": "<p>A good use case of promoted attributes is to easily define the various parameters a script might need, for example an input and output note if it's processing data, or a checkbox to define a particular change in behavior for the script.</p><p><img src=\"{{helpAssets}}/User%20Guide/Scripting/Frontend%20Basics/Examples/Using%20promoted%20attributes%20to%20configure%20scripts_image.png\"></p><h2>Using check boxes to toggle flags</h2><p>Instead of asking the user to modify a boolean value in the script, it's much more intuitive to use a checkbox for it as a promoted attribute.</p><p>To do so, first define the promoted attribute:</p><pre><code class=\"language-text-x-trilium-auto\">#label:groupByExtension=\"promoted,alias=Group by extension,single,boolean\"</code></pre><p>Then use it:</p><pre><code class=\"language-text-javascript\">const byExtension = api.currentNote.getLabelValue(\"groupByExtension\") === \"true\";\nif (byExtension) {\n\t// Do something.\n}</code></pre><p>This will work equally well in both front-end and back-end scripts.</p><h2>Using relations to select notes</h2><p>One common use case for a script is to read data from another note and perhaps output its result in another note. To do so we need to define the following promoted attributes:</p><pre><code class=\"language-text-x-trilium-auto\">#relation:input=\"promoted,alias=Input,single\" #relation:output=\"promoted,alias=Output,single\"</code></pre><p>Once we have this, we can add some basic error handling to ensure that the fields are completed by the user:</p><pre><code class=\"language-text-javascript\">const inputNoteId = api.currentNote.getRelationValue(\"input\");\nif (!inputNoteId) {\n\tapi.showError(\"Missing input.\");\n return;\n}\n\nconst outputNoteId = api.currentNote.getRelationValue(\"output\");\nif (!outputNoteId) {\n api.showError(\"Missing output.\");\n return;\n}</code></pre><p>Note that here we are using <code>api.showError</code> which is only available for frontend notes. If you are writing a backend note, simply remove <code>api.showError</code> but the user will no feedback on why the script did not execute properly.</p><p>Afterwards we can simply read the note and do something with it:</p><pre><code class=\"language-text-javascript\">const note = api.getNote(inputNoteId);\nif (!note) {\n\treturn;\n}\nconst content = note.getContent().toString(\"utf-8\");</code></pre>",- "_help_4Gn3psZKsfSm": "<p>Launch bar widgets are a subset of <a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a> that can be used to render custom buttons and widgets inside the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</p><h2>Creating a launch bar widget for the desktop layout</h2><p>Unlike <a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>, the process of setting up a launch bar widget is slightly different:</p><ol><li>Create a Code note of type <em>JavaScript (front-end)</em> or JSX (for Preact-based widgets).<ul><li>The script itself uses the same concepts as <a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>, including the use of a <code>NoteContextAwareWidget</code> or a <code>BasicWidget</code> (according to needs).</li><li>As examples in both legacy and Preact format, see <a class=\"reference-link\" href=\"#root/_help_IPArqVfDQ4We\">Note Title Widget</a> and <a class=\"reference-link\" href=\"#root/_help_gcI7RPbaNSh3\">Analog Watch</a>.</li></ul></li><li>Don't set <code>#widget</code>, as that attribute is reserved for <a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>.</li><li>In the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>, select <em>Configure launchbar</em>.</li><li>In the <em>Visible Launchers</em> section, select <em>Add a custom widget</em>.</li><li>Give the newly created launcher a name (and optionally a name).</li><li>In the <a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a> section, modify the <em>widget</em> field to point to the newly created note.</li><li><a href=\"#root/_help_s8alTXmpFR61\">Refresh</a> the UI.</li></ol><h2>Mobile layout</h2><p>Custom launch bar widgets are also supported on the <a class=\"reference-link\" href=\"#root/_help_RDslemsQ6gCp\">Mobile Frontend</a>. To do so:</p><ol><li>Go to <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> → <em>Advanced</em> → <em>Show Hidden Subtree</em>.</li><li>Look for <em>Mobile Launch Bar</em> and follow the same creation mechanism as in the previous section.</li></ol>",+ "_help_4Gn3psZKsfSm": "<p>Launch bar widgets are a subset of <a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a> that can be used to render custom buttons and widgets inside the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</p><h2>Creating a launch bar widget for the desktop layout</h2><p>Unlike <a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>, the process of setting up a launch bar widget is slightly different:</p><ol><li>Create a Code note of type <em>JavaScript (front-end)</em> or JSX (for Preact-based widgets).<ul><li>The script itself uses the same concepts as <a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>, including the use of a <code>NoteContextAwareWidget</code> or a <code>BasicWidget</code> (according to needs).</li><li>As examples in both legacy and Preact format, see <a class=\"reference-link\" href=\"#root/_help_IPArqVfDQ4We\">Note Title Widget</a> and <a class=\"reference-link\" href=\"#root/_help_gcI7RPbaNSh3\">Analog Watch</a>.</li></ul></li><li>Don't set <code>#widget</code>, as that attribute is reserved for <a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>.</li><li>In the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>, select <em>Configure launchbar</em>.</li><li>In the <em>Visible Launchers</em> section, select <em>Add a custom widget</em>.</li><li>Give the newly created launcher a name (and optionally a name).</li><li>In the <a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a> section, modify the <em>widget</em> field to point to the newly created note.</li><li><a href=\"#root/_help_s8alTXmpFR61\">Refresh</a> the UI.</li></ol><h2>Mobile layout</h2><p>Custom launch bar widgets are also supported on the <a class=\"reference-link\" href=\"#root/_help_RDslemsQ6gCp\">Mobile Frontend</a>. To do so:</p><ol><li>Go to <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> → <em>Advanced</em> → <em>Show hidden subtree</em>.</li><li>Look for <em>Mobile Launch Bar</em> and follow the same creation mechanism as in the previous section.</li></ol>","_help_IPArqVfDQ4We": "<figure class=\"image\"><img style=\"aspect-ratio:1007/94;\" src=\"{{helpAssets}}/User%20Guide/Scripting/Frontend%20Basics/Launch%20Bar%20Widgets/Note%20Title%20Widget_image.png\" width=\"1007\" height=\"94\"></figure><p>This is an example of a note context-aware widget, which reacts to the currently opened note and refreshes automatically as the user navigates through the notes.</p><p>In this example, the title of the note is displayed. It works best on the <a href=\"#root/_help_x0JgW8UqGXvq\">horizontal layout</a>.</p><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-react\"></span> Preact</p><div class=\"trilium-tab-panel\"><pre><code class=\"language-text-x-trilium-auto\">import { defineLauncherWidget, useActiveNoteContext } from \"trilium:preact\";\n\nexport default defineLauncherWidget({\n render: () => {\n const { note } = useActiveNoteContext();\n return <div style={{\n display: \"flex\",\n height: \"53px\",\n width: \"fit-content\",\n fontSize: \"0.75em\",\n alignItems: \"center\",\n flexShrink: 0 \n }}>{note?.title}</div>;\n }\n});</code></pre></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-javascript\"></span> Legacy</p><div class=\"trilium-tab-panel\"><pre><code class=\"language-text-javascript\">const TPL = `\\\n<div style=\"\n display: flex;\n height: 53px;\n width: fit-content;\n font-size: 0.75em;\n contain: none;\n align-items: center;\n flex-shrink: 0;\n padding: 0 1em;\n\"></div>`;\n\nclass NoteTitleWidget extends api.NoteContextAwareWidget {\n doRender() {\n this.$widget = $(TPL);\n }\n\n async refreshWithNote(note) {\n this.$widget.text(note.title);\n }\n}\n\nmodule.exports = new NoteTitleWidget();</code></pre></div></section></div>","_help_gcI7RPbaNSh3": "<figure class=\"image\"><img style=\"aspect-ratio:1007/94;\" src=\"{{helpAssets}}/User%20Guide/Scripting/Frontend%20Basics/Launch%20Bar%20Widgets/Analog%20Watch_image.png\" width=\"1007\" height=\"94\"></figure><p>This is a more intricate example of a basic widget, which displays an analog watch in the launch bar. Unlike note-context aware widgets, basic widgets don't react to note navigation.</p><pre><code class=\"language-text-javascript\">const TPL = `\n<div class=\"analog-watch\" style=\"\n position: relative;\n height: 38px;\n width: 38px;\n border-radius: 50%;\n background: white;\n border: 2px solid #444;\n flex-shrink: 0;\n\">\n <!-- hour hand -->\n <div class=\"hand hour\" style=\"\n position: absolute;\n left: 50%;\n top: 50%;\n width: 3px;\n height: 10px;\n background: #333;\n transform-origin: bottom center;\n \"></div>\n\n <!-- minute hand -->\n <div class=\"hand minute\" style=\"\n position: absolute;\n left: 50%;\n top: 50%;\n width: 2px;\n height: 13px;\n background: #111;\n transform-origin: bottom center;\n \"></div>\n\n <!-- second hand -->\n <div class=\"hand second\" style=\"\n position: absolute;\n left: 50%;\n top: 50%;\n width: 1px;\n height: 15px;\n background: red;\n transform-origin: bottom center;\n \"></div>\n</div>\n`;\n\nclass AnalogWatchWidget extends api.BasicWidget {\n doRender() { \n this.$widget = $(TPL);\n\n const hourHand = this.$widget.find('.hand.hour')[0];\n const minuteHand = this.$widget.find('.hand.minute')[0];\n const secondHand = this.$widget.find('.hand.second')[0];\n\n const update = () => {\n const now = new Date();\n const sec = now.getSeconds();\n const min = now.getMinutes();\n const hour = now.getHours();\n\n const secDeg = sec * 6;\n const minDeg = min * 6 + sec * 0.1;\n const hourDeg = (hour % 12) * 30 + min * 0.5;\n\n secondHand.style.transform = `translate(-50%, -100%) rotate(${secDeg}deg)`;\n minuteHand.style.transform = `translate(-50%, -100%) rotate(${minDeg}deg)`;\n hourHand.style.transform = `translate(-50%, -100%) rotate(${hourDeg}deg)`;\n };\n\n update();\n this._interval = setInterval(update, 1000);\n }\n\n cleanup() {\n if (this._interval) clearInterval(this._interval);\n }\n}\n\nmodule.exports = new AnalogWatchWidget();</code></pre>","_help_KLsqhjaqh1QW": "<p>Since v0.101.0, Trilium integrates Preact for front-end scripting, including support for JSX.</p><p>Preact can be used for:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>, where a JSX code note is used instead of a HTML one.</li><li><a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>, where JSX can be used to replace the old, jQuery-based mechanism.</li></ul><p>To get started, the first step is to enable JSX in the list of Code languages. Go to Options → Code Notes and check the “JSX” language. Afterwards, proceed with the documentation in either <a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a> or <a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>, which will both have a section on how to use the new Preact integration.</p><aside class=\"admonition important\"><p>The documentation assumes prior knowledge with React or Preact. As a starting point, consider the <a href=\"https://www.freecodecamp.org/learn/front-end-development-libraries-v9/\">FreeCodeCamp course on Front End Development Libraries</a> or the <a href=\"https://preactjs.com/tutorial/\">Preact Tutorial</a>.</p></aside><h2>Import/exports</h2><p>When using Preact with JSX, there is a special syntax which provides ES-like imports. This <code>import</code> syntax makes way for a more intuitive that doesn't make use of global objects and paves the way for better auto-completion support that might be introduced in the future. </p><h3>API imports</h3><p>Instead of:</p><pre><code class=\"language-text-jsx\">api.showMessage(\"Hello\");</code></pre><p>the JSX version looks like this:</p><pre><code class=\"language-text-jsx\">import { showMessage } from \"trilium:api\";\nshowMessage(\"hello\");</code></pre><h3>Preact API imports (hooks, components)</h3><p>There's a new <a class=\"reference-link\" href=\"#root/_help_GLks18SNjxmC\">Script API</a> dedicated to Preact, which provides shared components that are also used by Trilium internally as well as hooks, for example.</p><pre><code class=\"language-text-jsx\">import { useState } from \"trilium:preact\";\nconst [ myState, setMyState ] = useState(\"Hi\");</code></pre><h3>Exporting</h3><p>JSX notes can export a component for use in <a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a> or for <a class=\"reference-link\" href=\"#root/_help_Bqde6BvPo05g\">Component libraries</a>: </p><pre><code class=\"language-text-jsx\">export default function() {\n return (\n <>\n <p>Hello world.</p>\n </>\n );\n}</code></pre><h3>Import/export are not required</h3><p>These imports are syntactic sugar meant to replace the usage for the <code>api</code> global object (see <a class=\"reference-link\" href=\"#root/_help_GLks18SNjxmC\">Script API</a>). </p><aside class=\"admonition note\"><p>The <code>import</code> and <code>export</code> syntax work only for JSX notes. Standard/jQuery code notes still need to use the <code>api</code> global and <code>module.exports</code>.</p></aside><h2>Under the hood</h2><p>Unlike JavaScript, JSX requires pre-processing to turn it into JavaScript (just like TypeScript). To do so, Trilium uses <a href=\"https://github.com/alangpierce/sucrase\">Sucrase</a>, a JavaScript library which processes the JSX to pure JavaScript. The processing is done each time a script is run (for widgets this happens at every program startup). If you notice any performance degradation due to long compilation, consider <a href=\"#root/_help_wy8So3yZZlH9\">reporting the issue</a> to us.</p>",diff --git a/docs/User Guide/User Guide/Advanced Usage/Custom Request Handler.md b/docs/User Guide/User Guide/Advanced Usage/Custom Request Handler.mdindex 6d2c1e7340..dfb347321d 100644--- a/docs/User Guide/User Guide/Advanced Usage/Custom Request Handler.md+++ b/docs/User Guide/User Guide/Advanced Usage/Custom Request Handler.md@@ -14,7 +14,7 @@ const {secret, title, content} = req.body;if (req.method == 'POST' && secret === 'secret-password') {// notes must be saved somewhere in the tree hierarchy specified by a parent note.// This is defined by a relation from this code note to the "target" parent note- // alternatively you can just use constant noteId for simplicity (get that from "Note Info" dialog of the desired parent note)+ // alternatively you can just use constant noteId for simplicity (get that from "Note info" dialog of the desired parent note)const targetParentNoteId = api.currentNote.getRelationValue('targetNote');const {note} = api.createTextNote(targetParentNoteId, title, content);diff --git a/docs/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/SQL Console.md b/docs/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/SQL Console.mdindex 138448021e..b98ede924d 100644--- a/docs/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/SQL Console.md+++ b/docs/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/SQL Console.md@@ -4,7 +4,7 @@The SQL Console is Trilium's built-in database editor.-It can be accessed by going to the <a class="reference-link" href="../../../Basic%20Concepts%20and%20Features/UI%20Elements/Global%20menu.md">Global menu</a> → Advanced → Open SQL Console.+It can be accessed by going to the <a class="reference-link" href="../../../Basic%20Concepts%20and%20Features/UI%20Elements/Global%20menu.md">Global menu</a> → Advanced → Open SQL console.diff --git a/docs/User Guide/User Guide/Advanced Usage/Hidden Notes.md b/docs/User Guide/User Guide/Advanced Usage/Hidden Notes.mdindex 79f7d4cde1..07458b4d8f 100644--- a/docs/User Guide/User Guide/Advanced Usage/Hidden Notes.md+++ b/docs/User Guide/User Guide/Advanced Usage/Hidden Notes.md@@ -9,7 +9,7 @@ The hidden notes are stored in the user's <a class="reference-link" href="Datab## Accessing the hidden note tree-From the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Global%20menu.md">Global menu</a>, select _Advanced_ → _Show Hidden Subtree_.+From the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Global%20menu.md">Global menu</a>, select _Advanced_ → _Show hidden subtree_.## Contents of the hidden note tree@@ -33,11 +33,11 @@ Here is a brief summary of all the notes within the hidden tree:</tr><tr><td><a class="reference-link" href="#root/_hidden/_sqlConsole">SQL Console History</a></td>- <td><p>When SQL queries or commands are executed in the <a class="reference-link" href="Database/Manually%20altering%20the%20database/SQL%20Console.md">SQL Console</a>, they are stored here, grouped by month. Only the query is stored and not the results.</p><p>This section can be accessed without going to the hidden tree by simply going to the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Global%20menu.md">Global menu</a> and selecting Advanced → Open SQL Console History.</p><p>Notes can be added as children of this tree, but it's generally not recommended to do so to not interfere with the normal history process.</p></td>+ <td><p>When SQL queries or commands are executed in the <a class="reference-link" href="Database/Manually%20altering%20the%20database/SQL%20Console.md">SQL Console</a>, they are stored here, grouped by month. Only the query is stored and not the results.</p><p>This section can be accessed without going to the hidden tree by simply going to the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Global%20menu.md">Global menu</a> and selecting Advanced → Open SQL console history.</p><p>Notes can be added as children of this tree, but it's generally not recommended to do so to not interfere with the normal history process.</p></td></tr><tr><td><a class="reference-link" href="#root/_hidden/_search">Search History</a></td>- <td><p>Whenever a search is executed from the full <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Navigation/Search.md">Search</a>, the query will be stored here, grouped by month. Only the search parameters are stored and not the results themselves.</p><p>This section can be accessed without going to the hidden tree by simply going to the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Global%20menu.md">Global menu</a> and selecting Advanced → Open Search History.</p><p>Notes can be added as children of this tree, but it's generally not recommended to do so to not interfere with the normal history process.</p></td>+ <td><p>Whenever a search is executed from the full <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Navigation/Search.md">Search</a>, the query will be stored here, grouped by month. Only the search parameters are stored and not the results themselves.</p><p>This section can be accessed without going to the hidden tree by simply going to the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Global%20menu.md">Global menu</a> and selecting Advanced → Open search history.</p><p>Notes can be added as children of this tree, but it's generally not recommended to do so to not interfere with the normal history process.</p></td></tr><tr><td><a class="reference-link" href="#root/_hidden/_bulkAction">Bulk Action</a></td>@@ -57,11 +57,11 @@ Here is a brief summary of all the notes within the hidden tree:</tr><tr><td><a class="reference-link" href="#root/_hidden/_share">Shared Notes</a></td>- <td><p>This tree lists all of the notes that are <a href="Sharing.md">shared</a> publicly. It can be useful to track down which notes are shared regardless of their position in the note tree.</p><p>This section can be accessed without going to the hidden tree simply by going to the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Global%20menu.md">Global menu</a> and selecting <em>Show Shared Notes Subtree</em>.</p><p>Sub-notes cannot be created here.</p></td>+ <td><p>This tree lists all of the notes that are <a href="Sharing.md">shared</a> publicly. It can be useful to track down which notes are shared regardless of their position in the note tree.</p><p>This section can be accessed without going to the hidden tree simply by going to the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Global%20menu.md">Global menu</a> and selecting <em>Show shared notes subtree</em>.</p><p>Sub-notes cannot be created here.</p></td></tr><tr><td><a class="reference-link" href="#root/_hidden/_lbRoot">Launch Bar</a></td>- <td><p>The tree contains both available and displayed items of the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Launch%20Bar.md">Launch Bar</a>.</p><p>This section can be accessed without going to the hidden tree by:</p><ul><li>Going to the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Global%20menu.md">Global menu</a> and selecting <em>Configure Launchbar…</em>.</li><li>Right-clicking an empty space on the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Launch%20Bar.md">Launch Bar</a> and selecting <em>Configure Launchbar…</em>.</li></ul><p>Sub-notes cannot be created here.</p></td>+ <td><p>The tree contains both available and displayed items of the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Launch%20Bar.md">Launch Bar</a>.</p><p>This section can be accessed without going to the hidden tree by:</p><ul><li>Going to the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Global%20menu.md">Global menu</a> and selecting <em>Configure launch bar…</em>.</li><li>Right-clicking an empty space on the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Launch%20Bar.md">Launch Bar</a> and selecting <em>Configure launch bar…</em>.</li></ul><p>Sub-notes cannot be created here.</p></td></tr><tr><td><a class="reference-link" href="#root/_hidden/_options">Options</a></td>diff --git a/docs/User Guide/User Guide/Advanced Usage/Sharing.md b/docs/User Guide/User Guide/Advanced Usage/Sharing.mdindex 4e61d2ad4c..0151a11bc5 100644--- a/docs/User Guide/User Guide/Advanced Usage/Sharing.md+++ b/docs/User Guide/User Guide/Advanced Usage/Sharing.md@@ -125,7 +125,7 @@ When you share a note, you actually share the entire subtree of notes beneath it## Viewing and managing shared notes-You can view a list of all shared notes by clicking on _Advanced_ → "Show Shared Notes Subtree" in the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Global%20menu.md">Global menu</a>. This allows you to manage and navigate through all the notes you have made public.+You can view a list of all shared notes by clicking on _Advanced_ → "Show shared notes subtree" in the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Global%20menu.md">Global menu</a>. This allows you to manage and navigate through all the notes you have made public.## Security considerationsdiff --git a/docs/User Guide/User Guide/Basic Concepts and Features/Notes/Printing & Exporting as PDF.md b/docs/User Guide/User Guide/Basic Concepts and Features/Notes/Printing & Exporting as PDF.mdindex a96018df02..804195bdd1 100644--- a/docs/User Guide/User Guide/Basic Concepts and Features/Notes/Printing & Exporting as PDF.md+++ b/docs/User Guide/User Guide/Basic Concepts and Features/Notes/Printing & Exporting as PDF.md@@ -14,7 +14,7 @@ Printing and exporting as PDF are not perfect. Due to technical limitations, andOn the desktop application of Trilium it is possible to export a note as PDF. To print a note:-* Press the menu button in the <a class="reference-link" href="../UI%20Elements/Note%20menu.md">Note menu</a> and select _Print note_.+* Press the menu button in the <a class="reference-link" href="../UI%20Elements/Note%20menu.md">Note menu</a> and select _Print/export to PDF…_.* Alternatively, printing can be triggered from a [keyboard shortcut](../Keyboard%20Shortcuts.md) (unassigned by default) or through the [command palette](../Navigation/Jump%20to%20%26%20command%20palette.md).This will trigger the print preview screen next.@@ -46,7 +46,7 @@ If the note cannot be rendered with the current options, or stops making progresThis feature allows printing of notes. It works on both the desktop client, but also on the web.-To print a note, click the <a class="reference-link" href="../UI%20Elements/Note%20menu.md">Note menu</a> and select _Print note_. Depending on the size and type of the note, this can take up to a few seconds. Afterwards you will be redirected to the system/browser printing dialog.+To print a note, click the <a class="reference-link" href="../UI%20Elements/Note%20menu.md">Note menu</a> and select _Print/export to PDF…_. Depending on the size and type of the note, this can take up to a few seconds. Afterwards you will be redirected to the system/browser printing dialog.On the server or PWA (mobile), the option is not available due to technical constraints and it will be hidden.diff --git a/docs/User Guide/User Guide/Basic Concepts and Features/Notes/Read-Only Notes.md b/docs/User Guide/User Guide/Basic Concepts and Features/Notes/Read-Only Notes.mdindex 263bedd28c..105d3fea9d 100644--- a/docs/User Guide/User Guide/Basic Concepts and Features/Notes/Read-Only Notes.md+++ b/docs/User Guide/User Guide/Basic Concepts and Features/Notes/Read-Only Notes.md@@ -17,7 +17,7 @@ A note's read-only behavior can be changed via <a class="reference-link" href="This is the default behavior in which the note will be editable by default, unless it becomes large enough to trigger read-only mode.* **Read-only**The note will be always marked as read-only, regardless of its size. Nevertheless, it's still possible to temporarily edit the note if needed. This is generally useful for notes that are not prone to change.-* **Always Editable**+* **Always editable**This option will bypass the automatic read-only activation for this particular note. It's useful for large notes that are frequently edited.If the _Editable_ section is missing from the <a class="reference-link" href="../UI%20Elements/Note%20menu.md">Note menu</a>, then the note type does not support read-only mode.diff --git a/docs/User Guide/User Guide/Basic Concepts and Features/Notes/Restoring Deleted Notes.md b/docs/User Guide/User Guide/Basic Concepts and Features/Notes/Restoring Deleted Notes.mdindex 4a0f2ea92f..14e4a54d78 100644--- a/docs/User Guide/User Guide/Basic Concepts and Features/Notes/Restoring Deleted Notes.md+++ b/docs/User Guide/User Guide/Basic Concepts and Features/Notes/Restoring Deleted Notes.md@@ -1,5 +1,5 @@# Restoring Deleted Notes-Deleted notes are listed in the _Deleted Notes_ dialog (<a class="reference-link" href="../UI%20Elements/Global%20menu.md">Global menu</a> → _Show Deleted Notes_) and can be restored by pressing the _undelete_ link.+Deleted notes are listed in the _Deleted Notes_ dialog (<a class="reference-link" href="../UI%20Elements/Global%20menu.md">Global menu</a> → _Show deleted notes_) and can be restored by pressing the _undelete_ link.If a note has child notes, they will be restored along with it. Should the original location no longer exist (e.g. the parent has been deleted), the note will be restored into the default location for new notes (<a class="reference-link" href="Note%20Inbox.md">Note Inbox</a>).diff --git a/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Launch Bar.md b/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Launch Bar.mdindex 710ad88178..68ca9a8f3a 100644--- a/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Launch Bar.md+++ b/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Launch Bar.md@@ -17,8 +17,8 @@ If there are too many items in the launch bar to fit the screen, it will becomeThere are two ways to configure the launch bar:-* Right click in the empty space between launchers on the launch bar and select _Configure Launchbar…_-* Click on the <a class="reference-link" href="Global%20menu.md">Global menu</a> and select _Configure Launchbar_.+* Right click in the empty space between launchers on the launch bar and select _Configure launch bar…_+* Click on the <a class="reference-link" href="Global%20menu.md">Global menu</a> and select _Configure launch bar_.This will open a new tab with the <a class="reference-link" href="Note%20Tree.md">Note Tree</a> listing the launchers.@@ -30,9 +30,9 @@ Expanding _Available Launchers_ section will show the list of launchers that areThe launch bar on mobile uses a different configuration from the desktop one. The reasoning is that not all desktop icons are available on mobile, and fewer icons fit on a mobile screen.-To configure the launch bar on mobile, go to <a class="reference-link" href="Global%20menu.md">Global menu</a> and select _Configure Launchbar_.+To configure the launch bar on mobile, go to <a class="reference-link" href="Global%20menu.md">Global menu</a> and select _Configure launch bar_.-The configure the mobile launch bar while on the desktop (especially useful to configure more complicated launchers such as scripts or custom widgets), go to <a class="reference-link" href="Global%20menu.md">Global menu</a> → Advanced → Show Hidden Subtree and look for the _Mobile Launch Bar_ section. While in the hidden subtree, it's also possible to drag launchers between the _Mobile Launch Bar_ and (Desktop) _Launch Bar_ sections.+The configure the mobile launch bar while on the desktop (especially useful to configure more complicated launchers such as scripts or custom widgets), go to <a class="reference-link" href="Global%20menu.md">Global menu</a> → Advanced → Show hidden subtree and look for the _Mobile Launch Bar_ section. While in the hidden subtree, it's also possible to drag launchers between the _Mobile Launch Bar_ and (Desktop) _Launch Bar_ sections.### Adding/removing and reordering launchersdiff --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.mdindex 2e0ea62150..e5bd61ae70 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@@ -33,13 +33,13 @@ The two submenus in this section:* <span class="tn-icon bx bx-edit-alt"></span> _Editable_ controls when the note opens as read-only (see <a class="reference-link" href="../Notes/Read-Only%20Notes.md">Read-Only Notes</a>):* _Auto_ (the default): the note is editable, unless it is long enough to be opened as read-only automatically.* _Read-only_: the note always opens as read-only, but can still be edited after pressing _Edit note_.- * _Always Editable_: the note is always editable, regardless of its length.+ * _Always editable_: the note is always editable, regardless of its length.## Importing, exporting and printing* <span class="tn-icon bx bx-import"></span> _Import files_ opens the import dialog, which imports files as children of the current note. See <a class="reference-link" href="../Import%20%26%20Export.md">Import & Export</a>. It is unavailable on <a class="reference-link" href="../../Note%20Types/Saved%20Search.md">Saved Search</a> notes.* <span class="tn-icon bx bx-export"></span> _Export note_ opens the export dialog with _Only this note_ selected; select _This note & all descendants_ there to export the whole subtree.-* <span class="tn-icon bx bx-printer"></span>_Print note…_ prints the note. On the desktop application this entry reads _Print/export to PDF…_ and can also save the note as a PDF file. See <a class="reference-link" href="../Notes/Printing%20%26%20Exporting%20as%20PDF.md">Printing & Exporting as PDF</a>, including which note types and collections can be printed.+* <span class="tn-icon bx bx-printer"></span>_Print/export to PDF…_ prints the note or saves it as a PDF file. See <a class="reference-link" href="../Notes/Printing%20%26%20Exporting%20as%20PDF.md">Printing & Exporting as PDF</a>, including which note types and collections can be printed.Some note types add their own export formats right below _Export note_:@@ -76,7 +76,7 @@ The <span class="tn-icon bx bx-wrench"></span>_Advanced_ submenu groups the acti* <span class="tn-icon bx bx-file-find"></span>_Open note externally_ (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 <a class="reference-link" href="../../Collections.md">Collections</a> and <a class="reference-link" href="../../Note%20Types/Saved%20Search.md">Saved Search</a> notes.* <span class="tn-icon bx bx-customize"></span>_Open note custom_ (desktop application only, Windows and Linux) works like _Open note externally_, but lets you pick the application to open the file with.* <span class="tn-icon bx bx-code"></span>_Note source_ shows the <a class="reference-link" href="../../Advanced%20Usage/Note%20source.md">Note source</a>, the content of the note exactly as it is stored.-* <span class="tn-icon bx bxl-markdown"></span>_Convert to Markdown Note_ (on text notes) and _Convert to Text Note_ (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 <a class="reference-link" href="../../Note%20Types/Converting%20between%20note%20types.md">Converting between note types</a>.+* <span class="tn-icon bx bxl-markdown"></span>_Convert to Markdown note_ (on text notes) and _Convert to text note_ (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 <a class="reference-link" href="../../Note%20Types/Converting%20between%20note%20types.md">Converting between note types</a>.* <span class="tn-icon bx bx-collapse-alt"></span>_Compress images_ opens a dialog that reduces the size of the images in the note. It lists the images found and how much space they take, and offers to:* Resize the images larger than a chosen size.diff --git a/docs/User Guide/User Guide/Basic Concepts and Features/Zen mode.md b/docs/User Guide/User Guide/Basic Concepts and Features/Zen mode.mdindex 6a5906078e..ed659848d2 100644--- a/docs/User Guide/User Guide/Basic Concepts and Features/Zen mode.md+++ b/docs/User Guide/User Guide/Basic Concepts and Features/Zen mode.md@@ -11,7 +11,7 @@ Screenshot of the Zen Mode option in the global menu.## Activating & deactivating-The Zen Mode can be activated by accessing the global menu and selecting the “Zen Mode” option:+The Zen Mode can be activated by accessing the global menu and selecting the “Zen mode” option:Aside from the global menu, it's also possible to activate this mode by using a keyboard shortcut (which is <kbd>F9</kbd> since TriliumNext 0.92.5 and <kbd>Alt</kbd>+<kbd>Z</kbd> for older versions). Look for `toggleZenMode` in the shortcut configuration.diff --git a/docs/User Guide/User Guide/Installation & Setup/Mobile Frontend.md b/docs/User Guide/User Guide/Installation & Setup/Mobile Frontend.mdindex 3c89091e71..714da79708 100644--- a/docs/User Guide/User Guide/Installation & Setup/Mobile Frontend.md+++ b/docs/User Guide/User Guide/Installation & Setup/Mobile Frontend.md@@ -16,7 +16,7 @@ Here is a non-exhaustive list of differences between the desktop version and the* Press and hold a note to display the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree/Note%20tree%20contextual%20menu.md">Note tree contextual menu</a>.* The <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Navigation/Quick%20search.md">Quick search</a> bar is also displayed at the top of the note tree.* The full <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Navigation/Search.md">Search</a> function can be triggered either from either the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Global%20menu.md">Global menu</a> or from the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Launch%20Bar.md">Launch Bar</a>, if configured.-* The <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Global%20menu.md">Global menu</a> is shorter: _Open New Window_ and _Show Cheatsheet_ are left out, and _Switch to Desktop Version_ is under _Advanced_.+* The <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Global%20menu.md">Global menu</a> is shorter: _Open new window_ and _Show cheatsheet_ are left out, and _Switch to desktop version_ is under _Advanced_.* The <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Launch%20Bar.md">Launch Bar</a> is displayed at the bottom of the screen.* The launch bar uses a different configuration for icons than the desktop version. See the dedicated page for more information on how to configure it.* Most of the note-related actions are grouped in the horizontal dots icon on the top-right of the note.@@ -87,7 +87,7 @@ If you are running Trilium without a dedicated [server installation](Server%20InTrilium decides automatically whether to use mobile or desktop front-end. If this is not appropriate, you can use `?mobile` or `?desktop` query param on **login** page (Note: you might need to log out).-Alternatively, simply select _Switch to Mobile Version_ in the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Global%20menu.md">Global menu</a>. In the mobile version, select _Advanced_ → _Switch to Desktop Version_ there instead.+Alternatively, simply select _Switch to mobile version_ in the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Global%20menu.md">Global menu</a>. In the mobile version, select _Advanced_ → _Switch to desktop version_ there instead.## Scriptingdiff --git a/docs/User Guide/User Guide/Note Types/Converting between note types.md b/docs/User Guide/User Guide/Note Types/Converting between note types.mdindex 68b4347b21..d048dc6a6a 100644--- a/docs/User Guide/User Guide/Note Types/Converting between note types.md+++ b/docs/User Guide/User Guide/Note Types/Converting between note types.md@@ -12,14 +12,14 @@ Before conversion, a revision is saved automatically, so you can restore the oriMarkdown notes can be converted to Text Notes with negligible loss of formatting fidelity.-To do so, go to the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20menu.md">Note menu</a> → _Advanced_ and select _Convert to Text Note_.+To do so, go to the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20menu.md">Note menu</a> → _Advanced_ and select _Convert to text note_.### Text Note to Markdown> [!WARNING]> Since Markdown does not support all the capabilities of Text notes, this conversion is lossy in terms of formatting: some formatting may be lost, and some unsupported elements may even be dropped. It's strongly recommended that you inspect the content for any information that might have gone missing after the conversion.-To convert a text note to Markdown, go to the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20menu.md">Note menu</a> → _Advanced_ and select _Convert to Markdown Note_.+To convert a text note to Markdown, go to the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20menu.md">Note menu</a> → _Advanced_ and select _Convert to Markdown note_.## Converting multiple notesdiff --git a/docs/User Guide/User Guide/Scripting/Frontend Basics/Launch Bar Widgets.md b/docs/User Guide/User Guide/Scripting/Frontend Basics/Launch Bar Widgets.mdindex fbe6ac7bae..fc8dfa22ce 100644--- a/docs/User Guide/User Guide/Scripting/Frontend Basics/Launch Bar Widgets.md+++ b/docs/User Guide/User Guide/Scripting/Frontend Basics/Launch Bar Widgets.md@@ -19,5 +19,5 @@ Unlike <a class="reference-link" href="Custom%20Widgets.md">Custom Widgets</a>,Custom launch bar widgets are also supported on the <a class="reference-link" href="../../Installation%20%26%20Setup/Mobile%20Frontend.md">Mobile Frontend</a>. To do so:-1. Go to <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Global%20menu.md">Global menu</a> → _Advanced_ → _Show Hidden Subtree_.+1. Go to <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Global%20menu.md">Global menu</a> → _Advanced_ → _Show hidden subtree_.2. Look for _Mobile Launch Bar_ and follow the same creation mechanism as in the previous section.\ No newline at end of filediff --git a/docs/User Guide/User Guide/Troubleshooting/Error logs/Frontend logs.md b/docs/User Guide/User Guide/Troubleshooting/Error logs/Frontend logs.mdindex acba08dd49..5c622454d0 100644--- a/docs/User Guide/User Guide/Troubleshooting/Error logs/Frontend logs.md+++ b/docs/User Guide/User Guide/Troubleshooting/Error logs/Frontend logs.md@@ -3,7 +3,7 @@ To provide frontend logs, we need to open the Developer Console. Often the easieIf that doesn't work, then:-* in Trilium desktop app, go to top-left menu button -> Advanced -> Open Dev Tools+* in Trilium desktop app, go to top-left menu button -> Advanced -> Open dev tools* In Firefox/Chrome right-click anywhere in the page and click Inspect: