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
feat(mobile): list the bookmarks in the tree
Elian Doran62d2d6e98df3
diff --git a/apps/client/src/translations/en/translation.json b/apps/client/src/translations/en/translation.jsonindex 62d8a21d0e..668b3d834b 100644--- a/apps/client/src/translations/en/translation.json+++ b/apps/client/src/translations/en/translation.json@@ -2865,6 +2865,7 @@"children_count_other": "{{count}} child notes","children_hidden": "Child notes are hidden from the tree","workspaces": "Workspaces",+ "bookmarks": "Bookmarks","add_child": "Add child note","more_actions": "More actions"},diff --git a/apps/client/src/widgets/mobile_widgets/MobileNoteNavigator.spec.tsx b/apps/client/src/widgets/mobile_widgets/MobileNoteNavigator.spec.tsxindex fcd556d452..0a184eada4 100644--- a/apps/client/src/widgets/mobile_widgets/MobileNoteNavigator.spec.tsx+++ b/apps/client/src/widgets/mobile_widgets/MobileNoteNavigator.spec.tsx@@ -1,6 +1,7 @@import { act } from "preact/test-utils";-import { describe, expect, it, vi } from "vitest";+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";+import appContext from "../../components/app_context";import type Component from "../../components/component";import FBranch from "../../entities/fbranch";import type FNote from "../../entities/fnote";@@ -10,7 +11,7 @@ import search from "../../services/search";import { buildNote, buildNotes } from "../../test/easy-froca";import { renderInto } from "../../test/render";import { ParentComponent } from "../react/react_utils";-import { getListedChildCount, getPreviewNoteIds, TitleWithIndicators, WorkspaceCards } from "./MobileNoteNavigator";+import { BookmarkList, getListedChildCount, getPreviewNoteIds, TitleWithIndicators, WorkspaceCards } from "./MobileNoteNavigator";vi.mock("../../services/i18n", () => ({t: (key: string, options?: object) => (options ? `${key} ${JSON.stringify(options)}` : key),@@ -135,3 +136,51 @@ describe("WorkspaceCards", () => {expect(triggerCommand).toHaveBeenCalledWith("hoistNote", { noteId: workspace.noteId });});});++describe("BookmarkList", () => {+ // `tree.resolveNotePath()` reads the active note path from the tab manager.+ const { tabManager } = appContext;+ beforeEach(() => {+ appContext.tabManager = { getActiveContextNotePath: () => null } as unknown as typeof tabManager;+ });+ afterEach(() => {+ appContext.tabManager = tabManager;+ });++ it("lists the bookmarks under their path in the tree, and nothing without any", async () => {+ buildNote({ id: "root", title: "root", children: [+ { id: "bmFolder", title: "Folder", children: [ { id: "bookmarked", title: "Bookmarked" } ] }+ ] });+ const bookmarks = buildNote({ id: "_lbBookmarks", title: "Bookmarks" });+ const renderRow = ({ note, notePath }: { note: FNote, notePath: string }) => (+ <div key={note.noteId} className="row">{notePath}</div>+ );+ const mount = async () => {+ let container = document.body;+ await act(async () => {+ container = renderInto(<BookmarkList renderRow={renderRow} />);+ });+ // The paths resolve after the bookmarks load.+ await act(async () => {});+ return container;+ };++ expect((await mount()).querySelector(".mobile-navigator-bookmarks-label")).toBeNull();++ const bookmarked = froca.notes["bookmarked"];+ if (!bookmarked) throw new Error("expected the bookmarked note");+ const branchId = "_lbBookmarks_bookmarked";+ froca.branches[branchId] = new FBranch(froca, {+ branchId, noteId: "bookmarked", parentNoteId: "_lbBookmarks", notePosition: 0, fromSearchNote: false+ });+ bookmarks.addChild("bookmarked", branchId, false);+ bookmarked.addParent("_lbBookmarks", branchId, false);++ const container = await mount();+ await vi.waitFor(() => {+ expect([ ...container.querySelectorAll(".mobile-navigator-list .row") ].map((row) => row.textContent))+ .toEqual([ "root/bmFolder/bookmarked" ]);+ });+ expect(container.querySelector(".mobile-navigator-bookmarks-label")?.textContent).toBe("mobile_note_navigator.bookmarks");+ });+});diff --git a/apps/client/src/widgets/mobile_widgets/MobileNoteNavigator.tsx b/apps/client/src/widgets/mobile_widgets/MobileNoteNavigator.tsxindex 04d3004414..4623219e53 100644--- a/apps/client/src/widgets/mobile_widgets/MobileNoteNavigator.tsx+++ b/apps/client/src/widgets/mobile_widgets/MobileNoteNavigator.tsx@@ -1,6 +1,7 @@import "./MobileNoteNavigator.css";import clsx from "clsx";+import type { ComponentChildren } from "preact";import { useCallback, useContext, useEffect, useLayoutEffect, useMemo, useRef, useState } from "preact/hooks";import type Component from "../../components/component";@@ -21,6 +22,7 @@ import { useShareState } from "../layout/NoteBadges";import { Badge } from "../react/Badge";import {useActiveNoteContext,+ useChildNotes,useLongPressContextMenu,useNote,useNoteColorClass,@@ -270,6 +272,25 @@ export default function MobileNoteNavigator() {<div ref={scrollRef} className={clsx("mobile-navigator-scroll", showInitialLoader && "is-pending")}><div ref={bodyRef} className="mobile-navigator-body">{!isHoisted && currentParentId === "root" && <WorkspaceCards />}+ {!isHoisted && currentParentId === "root" && (+ <BookmarkList+ renderRow={({ note, notePath, parentNoteId }) => (+ <NavigatorRow+ key={note.noteId}+ note={note}+ parentNoteId={parentNoteId}+ childNotePath={notePath}+ isActive={note.noteId === activeNoteId}+ isPending={note.noteId === pendingChildId}+ isSpotlighted={false}+ hideArchived={hideArchived}+ onDrill={drillInto}+ onOpen={openNotePath}+ parentComponent={parentComponent}+ />+ )}+ />+ )}{parentNote && (<div className="mobile-navigator-children-label">{t("mobile_note_navigator.current_note")}@@ -479,6 +500,46 @@ export function WorkspaceCards() {);}+interface Bookmark {+ note: FNote;+ /** The note's best path in the tree, not the one through `_lbBookmarks`. */+ notePath: string;+ parentNoteId: string | undefined;+}++/**+ * The bookmarks, as the launch bar's Bookmarks button lists them, for the root column of a tab+ * that is not hoisted: a heading and a list of rows that `renderRow` draws.+ */+export function BookmarkList({ renderRow }: { renderRow: (bookmark: Bookmark) => ComponentChildren }) {+ const bookmarkNotes = useChildNotes("_lbBookmarks");+ const [ bookmarks, setBookmarks ] = useState<Bookmark[]>([]);++ useEffect(() => {+ let cancelled = false;+ Promise.all(bookmarkNotes.map(async (note) => {+ const notePath = await tree.resolveNotePath(note.noteId);+ return notePath ? { note, notePath, parentNoteId: notePath.split("/").at(-2) } : null;+ })).then((resolved) => {+ if (!cancelled) setBookmarks(resolved.filter((bookmark): bookmark is Bookmark => !!bookmark));+ });+ return () => { cancelled = true; };+ }, [ bookmarkNotes ]);++ if (!bookmarks.length) return null;++ return (+ <>+ <div className="mobile-navigator-children-label mobile-navigator-bookmarks-label">+ {t("mobile_note_navigator.bookmarks")}+ </div>+ <div className="mobile-navigator-list">+ {bookmarks.map(renderRow)}+ </div>+ </>+ );+}+function WorkspaceCard({ note, onClick }: { note: FNote, onClick: () => void }) {const icon = useNoteIcon(note);const [ workspaceIconClass ] = useNoteLabel(note, "workspaceIconClass");diff --git a/apps/server/src/assets/help/help_content.json b/apps/server/src/assets/help/help_content.jsonindex 6dc3a1621e..3a03e6350f 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>On a phone, the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a> lies under the note. The <span class=\"tn-icon bx bx-chevron-left\"></span> button in the top-left of the screen slides the note away to reveal the tree, and opening a note from the tree slides it back in.<ul><li>A swipe from the left edge of the screen also reveals the tree, but the system's or the browser's back gesture can take it over, depending on the platform.</li><li>Each tab remembers whether it was showing the tree or its note, and the folder its tree was showing. Switching tabs brings both back. Opening another note in the tab moves its tree to the folder holding that note.</li><li>A new tab opens on the tree, at the root, with the <a class=\"reference-link\" href=\"#root/_help_9sRHySam5fXb\">Workspaces</a>, if there are any, listed above it. Tap one to hoist the tab into it.</li><li>In the Android app, the system back gesture or button closes the menu or dialog on top first, then a settings page in <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>, then slides the note away to reveal the tree, then goes up one level in the tree. At the top of the tree, it sends the app to the background.</li><li>On wider screens, such as a tablet in landscape, the note tree is displayed as a sidebar next to the note instead. There, a <span class=\"tn-icon bx bx-sidebar\"></span> button hides and shows it, and the choice is remembered together with the left pane of the desktop version.</li><li>A note with children shows a <span class=\"tn-icon bx bx-chevron-right\"></span> (on iOS, preceded by how many children it lists): tapping it lists its children, and tapping any other note opens it.</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>New window</em> and <em>Keyboard shortcuts</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>In a text note, the formatting toolbar sits at the bottom of the screen. See <em>Editing text notes</em> below.</li><li>On iOS, the buttons of the title row, the launch bar, the formatting toolbar, the menus that open from the bottom of the screen and short dialogs are translucent panes that float clear of the screen's edges, and the note scrolls beneath the title row and the launch bar. A dialog taller than half the screen is opaque and attached to the bottom of the screen instead. To make the panes opaque, go to <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Appearance</em> → <em>Performance</em> and turn off <em>Background effects for menus, popups and panels</em>. On Android, the option is not shown and they are always opaque.</li><li>While the on-screen keyboard is open, a <span class=\"tn-icon bx bxs-keyboard\"></span> button in the bottom-right corner, just above the keyboard, hides it. In a text note, the button is at the right end of the formatting toolbar. While a menu of the formatting toolbar is open in place of the keyboard, the button becomes a <span class=\"tn-icon bx bx-x\"></span>, which closes the menu and brings the keyboard back. This works in every note type and in every text field, and is the only way to hide the keyboard in the iOS app, where the keyboard has no <em>Done</em> button.</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. On a phone, a tab left on the note tree shows the folder it was on, with the tab's note highlighted, instead of a preview of the note.<ul><li>Swipe left or right anywhere on the launch bar to go to the next or previous tab without opening the switcher. This works while the tab switcher is in the launch bar and all of the bar's buttons fit on the screen; when they do not, swiping scrolls the bar instead. The page follows your finger and reaches the other tab as your finger reaches the edge of the screen: let go less than a third of the way there to stay on the current tab, unless you flick.</li></ul></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>Editing text notes</h2><h3>The formatting toolbar</h3><p>In a text note, the formatting toolbar sits at the bottom of the screen as a single row that scrolls sideways. It is shown only while you are editing the text, and hides when you hide the keyboard or move to another field, such as the note title. From left to right, it holds:</p><ul><li><em>Undo</em> and <em>Redo</em>, since the on-screen keyboard has no keys for them.</li><li>A highlighted button naming the element the cursor is in, such as <em>Table ›</em> or <em>List ›</em>, when it is in one. See <em>Tables, images and other elements</em> and <em>Lists</em> below.</li><li>The <span class=\"tn-icon cke cke-trilium-block-type\"></span> block type button, <span class=\"tn-icon cke cke-plus\"></span> to insert content, and <span class=\"tn-icon cke cke-text\"></span> for the formatting applied to text.</li><li><span class=\"tn-icon cke cke-link\"></span> to add a link and <span class=\"tn-icon cke cke-paper-clip\"></span> to attach a file.</li><li>The indentation buttons, then <span class=\"tn-icon cke cke-arrow-up\"></span> and <span class=\"tn-icon cke cke-arrow-down\"></span>, which move the current block, or the selected blocks, up or down, as <kbd>Alt</kbd>+<kbd>↑</kbd> and <kbd>Alt</kbd>+<kbd>↓</kbd> do on a keyboard. Inside a table they move the row instead.</li><li>The <span class=\"tn-icon cke cke-trilium-ai\"></span> AI assistant button, shown once a provider is configured, which opens its quick actions as a menu at the bottom of the screen, with <em>Ask AI…</em> at its top.</li></ul><p>While the keyboard is open, the <span class=\"tn-icon bx bxs-keyboard\"></span> button at the right end of the toolbar hides it.</p><p>The hints in the corner of the editor that explain the element under the cursor, such as a to-do item's state and its shortcut, are not shown, whatever the <em>Content hints</em> setting under <em>Options</em> → <em>Text Notes</em> → <em>Features</em>.</p><h3>Inserting content</h3><p>The <span class=\"tn-icon cke cke-plus\"></span> button opens insertions as tiles at the bottom of the screen:</p><ul><li>Image, table and to-do list.</li><li>Code block, block quote and admonition.</li><li>The less common collapsible, tabs, columns, horizontal line, page break, footnote, math, drawing canvas, Mermaid diagram, bookmark, link and content embeds, special characters, emoji, icon, date/time, template and Markdown import.</li></ul><p>The image is also under the paperclip, and the to-do list, code block, block quote and admonition are also in the block type button.</p><p>The tiles marked with <span class=\"tn-icon bx bx-chevron-right\"></span> open a list of choices:</p><ul><li><em>Code block</em>: the language.</li><li><em>Admonition</em>: its type.</li><li><em>Insert table</em>: the size of the table.</li><li><em>Columns</em>: the number of columns.</li><li><em>Footnote</em>: a new footnote or a reference to an existing one.</li><li><em>Date/time</em>: the format of the date and time.</li><li><em>Insert text snippet</em>: the template to insert. It is grayed out while there are none.</li></ul><h3>Block types</h3><p>The <span class=\"tn-icon cke cke-trilium-block-type\"></span> block type button opens the block types as tiles at the bottom of the screen, with the current one highlighted:</p><ul><li>Paragraph and heading 2 to 6.</li><li>Bulleted list, numbered list and to-do list.</li><li>Code block, block quote and admonition.</li></ul><p>Picking a paragraph or a heading in a list turns the item back into plain text, and the same goes for a code block. Block quote and admonition wrap the current block rather than replace it, so they are highlighted alongside it; pick one again to remove it.</p><p>Typing <code>-</code> , <code>1.</code> or <code>[ ]</code> at the start of a line also starts a list.</p><h3>Lists</h3><p>While the cursor is in a list, a <em>List ›</em> button follows <em>Undo</em> and <em>Redo</em>. Its row holds:</p><ul><li>The indentation buttons and the buttons that move the item up or down, as on the main row.</li><li><em>List type</em>, which opens the to-do list and the markers of bulleted and numbered lists (such as squares or roman numerals) as tiles, the markers under the kind of each, with the current one highlighted. Picking a tile of another kind also turns the list into that kind, such as a bulleted list into a numbered one or a to-do list back into a bulleted one.</li><li>In a numbered list, <em>Start at</em>, which asks for the number the list starts at, and <span class=\"tn-icon bx bx-sort-down\"></span> <em>Reversed order</em>, which is highlighted while the list counts down.</li><li>In a to-do list, a button for each task state, followed by <span class=\"tn-icon bx bx-pencil\"></span> to edit the states.</li></ul><p>Starting a list, from the block type button, the insert menu or by typing <code>-</code> , <code>1.</code> or <code>[ ]</code>, shows this row right away. It stays closed once you tap the back button, until you start another list.</p><h3>Tables, images and other elements</h3><p>While the cursor is in a table, an image, a code block, a link or another element that has a toolbar of its own on desktop, a highlighted button naming that element, such as <em>Table ›</em>, follows <em>Undo</em> and <em>Redo</em>. It replaces the formatting toolbar with the element's toolbar, which starts with a back button that closes it again, followed by the element's name ahead of its tools. The button goes away when the cursor leaves the element.</p><p>Selecting an element as a whole, such as an image, or tapping a link shows its toolbar right away; tap the back button to return to the formatting toolbar.</p><p>Buttons of the element's toolbar with a list of choices, such as the column and row actions of a table, open that list as a menu at the bottom of the screen, where an option that is on or off, such as a table's header row, is a switch.</p><h3>Formatting text</h3><p>The formatting applied to text (bold, italic, underline, strikethrough, inline code, superscript and subscript, keyboard shortcut, font size and colors, and removing formatting) is on a row of its own, followed by the left, center, right and justify alignments of the current block, with the current one highlighted. The row ends with <span class=\"tn-icon cke cke-trilium-scissors\"></span> to cut the selection into a sub-note.</p><ul><li>Tap <span class=\"tn-icon cke cke-text\"></span> after the <span class=\"tn-icon cke cke-plus\"></span> button to show it, and <span class=\"tn-icon cke cke-previous-arrow\"></span> at its start to return to the main row.</li><li>Selecting text shows this row on its own, and it goes back to the main row once the selection is gone (for example as you start typing), unless you opened or closed the row yourself in the meantime.</li></ul><p>The font size button opens the list of sizes as a menu at the bottom of the screen, each drawn at its size, with the current one checked.</p><p>A single color button replaces the separate text and background color buttons. It opens a menu with a row of colors for the text and one for its background, each with a cell that removes the color and one that opens the device's color picker.</p><h3>Links and attachments</h3><p>The <span class=\"tn-icon cke cke-link\"></span> link button replaces the separate link and internal link buttons. It opens the <em>Add link</em> dialog, which links to a note or to a web address, or <em>Edit link</em> when the cursor is inside a link. The dialog does not open the keyboard by itself; tap the note or address field to type. The same button is on the row of text formatting, after the inline styles, to turn selected text into a link.</p><p>The <span class=\"tn-icon cke cke-paper-clip\"></span> button opens <em>Image</em>, <em>Camera</em>, <em>Attach and embed file</em> and <em>Attach file as a link</em> as a list: the menu of the desktop toolbar, with <em>Camera</em> added. <em>Camera</em> opens the device's camera and inserts the photo taken; the others open the device's file picker.</p><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>On a phone, the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a> lies under the note. The <span class=\"tn-icon bx bx-chevron-left\"></span> button in the top-left of the screen slides the note away to reveal the tree, and opening a note from the tree slides it back in.<ul><li>A swipe from the left edge of the screen also reveals the tree, but the system's or the browser's back gesture can take it over, depending on the platform.</li><li>Each tab remembers whether it was showing the tree or its note, and the folder its tree was showing. Switching tabs brings both back. Opening another note in the tab moves its tree to the folder holding that note.</li><li>A new tab opens on the tree, at the root, with the <a class=\"reference-link\" href=\"#root/_help_9sRHySam5fXb\">Workspaces</a> and the <a class=\"reference-link\" href=\"#root/_help_u3YFHC9tQlpm\">Bookmarks</a>, if there are any, listed above it. Tap a workspace to hoist the tab into it.</li><li>In the Android app, the system back gesture or button closes the menu or dialog on top first, then a settings page in <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>, then slides the note away to reveal the tree, then goes up one level in the tree. At the top of the tree, it sends the app to the background.</li><li>On wider screens, such as a tablet in landscape, the note tree is displayed as a sidebar next to the note instead. There, a <span class=\"tn-icon bx bx-sidebar\"></span> button hides and shows it, and the choice is remembered together with the left pane of the desktop version.</li><li>A note with children shows a <span class=\"tn-icon bx bx-chevron-right\"></span> (on iOS, preceded by how many children it lists): tapping it lists its children, and tapping any other note opens it.</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>New window</em> and <em>Keyboard shortcuts</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>In a text note, the formatting toolbar sits at the bottom of the screen. See <em>Editing text notes</em> below.</li><li>On iOS, the buttons of the title row, the launch bar, the formatting toolbar, the menus that open from the bottom of the screen and short dialogs are translucent panes that float clear of the screen's edges, and the note scrolls beneath the title row and the launch bar. A dialog taller than half the screen is opaque and attached to the bottom of the screen instead. To make the panes opaque, go to <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Appearance</em> → <em>Performance</em> and turn off <em>Background effects for menus, popups and panels</em>. On Android, the option is not shown and they are always opaque.</li><li>While the on-screen keyboard is open, a <span class=\"tn-icon bx bxs-keyboard\"></span> button in the bottom-right corner, just above the keyboard, hides it. In a text note, the button is at the right end of the formatting toolbar. While a menu of the formatting toolbar is open in place of the keyboard, the button becomes a <span class=\"tn-icon bx bx-x\"></span>, which closes the menu and brings the keyboard back. This works in every note type and in every text field, and is the only way to hide the keyboard in the iOS app, where the keyboard has no <em>Done</em> button.</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. On a phone, a tab left on the note tree shows the folder it was on, with the tab's note highlighted, instead of a preview of the note.<ul><li>Swipe left or right anywhere on the launch bar to go to the next or previous tab without opening the switcher. This works while the tab switcher is in the launch bar and all of the bar's buttons fit on the screen; when they do not, swiping scrolls the bar instead. The page follows your finger and reaches the other tab as your finger reaches the edge of the screen: let go less than a third of the way there to stay on the current tab, unless you flick.</li></ul></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>Editing text notes</h2><h3>The formatting toolbar</h3><p>In a text note, the formatting toolbar sits at the bottom of the screen as a single row that scrolls sideways. It is shown only while you are editing the text, and hides when you hide the keyboard or move to another field, such as the note title. From left to right, it holds:</p><ul><li><em>Undo</em> and <em>Redo</em>, since the on-screen keyboard has no keys for them.</li><li>A highlighted button naming the element the cursor is in, such as <em>Table ›</em> or <em>List ›</em>, when it is in one. See <em>Tables, images and other elements</em> and <em>Lists</em> below.</li><li>The <span class=\"tn-icon cke cke-trilium-block-type\"></span> block type button, <span class=\"tn-icon cke cke-plus\"></span> to insert content, and <span class=\"tn-icon cke cke-text\"></span> for the formatting applied to text.</li><li><span class=\"tn-icon cke cke-link\"></span> to add a link and <span class=\"tn-icon cke cke-paper-clip\"></span> to attach a file.</li><li>The indentation buttons, then <span class=\"tn-icon cke cke-arrow-up\"></span> and <span class=\"tn-icon cke cke-arrow-down\"></span>, which move the current block, or the selected blocks, up or down, as <kbd>Alt</kbd>+<kbd>↑</kbd> and <kbd>Alt</kbd>+<kbd>↓</kbd> do on a keyboard. Inside a table they move the row instead.</li><li>The <span class=\"tn-icon cke cke-trilium-ai\"></span> AI assistant button, shown once a provider is configured, which opens its quick actions as a menu at the bottom of the screen, with <em>Ask AI…</em> at its top.</li></ul><p>While the keyboard is open, the <span class=\"tn-icon bx bxs-keyboard\"></span> button at the right end of the toolbar hides it.</p><p>The hints in the corner of the editor that explain the element under the cursor, such as a to-do item's state and its shortcut, are not shown, whatever the <em>Content hints</em> setting under <em>Options</em> → <em>Text Notes</em> → <em>Features</em>.</p><h3>Inserting content</h3><p>The <span class=\"tn-icon cke cke-plus\"></span> button opens insertions as tiles at the bottom of the screen:</p><ul><li>Image, table and to-do list.</li><li>Code block, block quote and admonition.</li><li>The less common collapsible, tabs, columns, horizontal line, page break, footnote, math, drawing canvas, Mermaid diagram, bookmark, link and content embeds, special characters, emoji, icon, date/time, template and Markdown import.</li></ul><p>The image is also under the paperclip, and the to-do list, code block, block quote and admonition are also in the block type button.</p><p>The tiles marked with <span class=\"tn-icon bx bx-chevron-right\"></span> open a list of choices:</p><ul><li><em>Code block</em>: the language.</li><li><em>Admonition</em>: its type.</li><li><em>Insert table</em>: the size of the table.</li><li><em>Columns</em>: the number of columns.</li><li><em>Footnote</em>: a new footnote or a reference to an existing one.</li><li><em>Date/time</em>: the format of the date and time.</li><li><em>Insert text snippet</em>: the template to insert. It is grayed out while there are none.</li></ul><h3>Block types</h3><p>The <span class=\"tn-icon cke cke-trilium-block-type\"></span> block type button opens the block types as tiles at the bottom of the screen, with the current one highlighted:</p><ul><li>Paragraph and heading 2 to 6.</li><li>Bulleted list, numbered list and to-do list.</li><li>Code block, block quote and admonition.</li></ul><p>Picking a paragraph or a heading in a list turns the item back into plain text, and the same goes for a code block. Block quote and admonition wrap the current block rather than replace it, so they are highlighted alongside it; pick one again to remove it.</p><p>Typing <code>-</code> , <code>1.</code> or <code>[ ]</code> at the start of a line also starts a list.</p><h3>Lists</h3><p>While the cursor is in a list, a <em>List ›</em> button follows <em>Undo</em> and <em>Redo</em>. Its row holds:</p><ul><li>The indentation buttons and the buttons that move the item up or down, as on the main row.</li><li><em>List type</em>, which opens the to-do list and the markers of bulleted and numbered lists (such as squares or roman numerals) as tiles, the markers under the kind of each, with the current one highlighted. Picking a tile of another kind also turns the list into that kind, such as a bulleted list into a numbered one or a to-do list back into a bulleted one.</li><li>In a numbered list, <em>Start at</em>, which asks for the number the list starts at, and <span class=\"tn-icon bx bx-sort-down\"></span> <em>Reversed order</em>, which is highlighted while the list counts down.</li><li>In a to-do list, a button for each task state, followed by <span class=\"tn-icon bx bx-pencil\"></span> to edit the states.</li></ul><p>Starting a list, from the block type button, the insert menu or by typing <code>-</code> , <code>1.</code> or <code>[ ]</code>, shows this row right away. It stays closed once you tap the back button, until you start another list.</p><h3>Tables, images and other elements</h3><p>While the cursor is in a table, an image, a code block, a link or another element that has a toolbar of its own on desktop, a highlighted button naming that element, such as <em>Table ›</em>, follows <em>Undo</em> and <em>Redo</em>. It replaces the formatting toolbar with the element's toolbar, which starts with a back button that closes it again, followed by the element's name ahead of its tools. The button goes away when the cursor leaves the element.</p><p>Selecting an element as a whole, such as an image, or tapping a link shows its toolbar right away; tap the back button to return to the formatting toolbar.</p><p>Buttons of the element's toolbar with a list of choices, such as the column and row actions of a table, open that list as a menu at the bottom of the screen, where an option that is on or off, such as a table's header row, is a switch.</p><h3>Formatting text</h3><p>The formatting applied to text (bold, italic, underline, strikethrough, inline code, superscript and subscript, keyboard shortcut, font size and colors, and removing formatting) is on a row of its own, followed by the left, center, right and justify alignments of the current block, with the current one highlighted. The row ends with <span class=\"tn-icon cke cke-trilium-scissors\"></span> to cut the selection into a sub-note.</p><ul><li>Tap <span class=\"tn-icon cke cke-text\"></span> after the <span class=\"tn-icon cke cke-plus\"></span> button to show it, and <span class=\"tn-icon cke cke-previous-arrow\"></span> at its start to return to the main row.</li><li>Selecting text shows this row on its own, and it goes back to the main row once the selection is gone (for example as you start typing), unless you opened or closed the row yourself in the meantime.</li></ul><p>The font size button opens the list of sizes as a menu at the bottom of the screen, each drawn at its size, with the current one checked.</p><p>A single color button replaces the separate text and background color buttons. It opens a menu with a row of colors for the text and one for its background, each with a cell that removes the color and one that opens the device's color picker.</p><h3>Links and attachments</h3><p>The <span class=\"tn-icon cke cke-link\"></span> link button replaces the separate link and internal link buttons. It opens the <em>Add link</em> dialog, which links to a note or to a web address, or <em>Edit link</em> when the cursor is inside a link. The dialog does not open the keyboard by itself; tap the note or address field to type. The same button is on the row of text formatting, after the inline styles, to turn selected text into a link.</p><p>The <span class=\"tn-icon cke cke-paper-clip\"></span> button opens <em>Image</em>, <em>Camera</em>, <em>Attach and embed file</em> and <em>Attach file as a link</em> as a list: the menu of the desktop toolbar, with <em>Camera</em> added. <em>Camera</em> opens the device's camera and inserts the photo taken; the others open the device's file picker.</p><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>",@@ -86,7 +86,7 @@"_help_eIg8jdvaoNNd": "<figure class=\"image\"><img style=\"aspect-ratio:987/725;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Navigation/Search_image.png\" width=\"987\" height=\"725\"></figure><p>Note search enables you to find notes by searching for text in the title, content, or <a href=\"#root/_help_zEY4DaJG4YT5\">attributes</a> of the notes. You also have the option to save your searches, which will create a special search note which is visible on your navigation tree and contains the search results as sub-items.</p><h2>Types of search</h2><p>There are multiple types of searches, all using the same search mechanism and query language:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_Ms1nauBra7gq\">Quick search</a> which can be found in the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a> for small one-off searches.<ul><li>The results are shown in a popup and it has an infinite scroll.</li></ul></li><li><em>Full search</em> is the more advanced search mechanism.<ul><li>The results are displayed in a separate page and it has multiple advanced features (search script, fast search, include archived notes, order by, limit).</li><li><a class=\"reference-link\" href=\"#root/_help_ivYnonVFBxbQ\">Bulk Actions</a> such as adding a label/relation can be applied to the results.</li><li>The results are paginated and they can be displayed in any <a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a> view (e.g. grid, list, calendar, table).</li></ul></li><li>Some <a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a> such as board view have a dedicated search bar which applies to that collection.<ul><li>In this case, the results are displayed directly in the collection instead of a popup and they are limited to the collection but the query language remains the same.</li></ul></li></ul><aside class=\"admonition note\"><p><a href=\"#root/_help_F1r9QtzQLZqm\">Jump to note</a> is a similar concept but it's mainly used to search for notes by title, not by content. Nevertheless, it also features a way to search in full text if the results are unsatisfactory.</p></aside><h2>Accessing the search</h2><ul><li>From the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>, look for the dedicated <span class=\"tn-icon bx bx-search\"></span> search button.</li><li>To limit the search to a note and its children, select <em>Search in subtree</em> (<span class=\"tn-icon bx bx-search\"></span>) from the <a class=\"reference-link\" href=\"#root/_help_YtSN43OrfzaA\">Note tree contextual menu</a> or press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>S</kbd>.</li><li>Go to <a class=\"reference-link\" href=\"#root/_help_F1r9QtzQLZqm\">Jump to & command palette</a>, look for something then press <em>Show in full search</em> below the results (or <kbd>Ctrl</kbd>+<kbd>Enter</kbd>).</li></ul><h2>Interaction</h2><p>To search for notes, click on the <span class=\"tn-icon bx bx-search\"></span> icon in the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a> or press the keyboard <a href=\"#root/_help_A9Oc6YKKc65v\">shortcut</a>.</p><ol><li>Set the text to search for in the <em>Search string</em> field.<ol><li>Apart from searching for words literally, there is also the possibility to search for attributes or properties of notes.</li><li>See the examples below for more information.</li></ol></li><li>To limit the search to a note and its sub-children, set a note in <em>Ancestor</em>.<ol><li>This value is also pre-filled if the search is triggered from a <a href=\"#root/_help_OR8WJ7Iz9K4U\">hoisted note</a> or a <a href=\"#root/_help_9sRHySam5fXb\">workspace</a>.</li><li>To search the entire database, keep the value empty.</li></ol></li><li>To limit the search to only a few levels of hierarchy (e.g. look in sub-children but not in sub-sub-children of a note), set the <em>depth</em> field to one of the provided values.</li><li>In addition to that, the search can be configured via the <em>Add search option</em> menu, as described in the follow-up section.</li><li>Press <em>Search</em> (<span class=\"tn-icon bx bx-search\"></span>) to trigger the search. The results are displayed below the search configuration pane.</li><li>The <em>Search & Execute actions</em> (<span class=\"tn-icon bx bxs-zap\"></span>) entry in the menu beside <em>Search</em> is only relevant if at least one action has been added (as described in the section below).</li><li>The <em>Save to note</em> (<span class=\"tn-icon bx bx-save\"></span>) entry in the same menu will create a new note with the search configuration. For more information, see <a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a>.</li></ol><h2>Features</h2><h3>Autocomplete</h3><p>To help with the syntax, Trilium offers an autocomplete functionality which can be triggered by pressing <kbd>Ctrl</kbd>+<kbd>Space</kbd>.</p><p>Some suggestions also open on their own as you type: label and relation names after <code>#</code> and <code>~</code>, fields after <code>.</code>, operators, values, and notes after <code>@</code>. Keywords such as <code>and</code>, <code>or</code>, <code>not</code>, <code>orderBy</code> and <code>limit</code> appear only on <kbd>Ctrl</kbd>+<kbd>Space</kbd>, since a plain word is usually a search term.</p><p>No suggestion is selected when a list opens on its own, so <kbd>Enter</kbd> runs the search as typed. To insert a suggestion, select it with <kbd>Down</kbd> and press <kbd>Enter</kbd>. The list opened with <kbd>Ctrl</kbd>+<kbd>Space</kbd> and the notes after <code>@</code> open on the best match instead, so <kbd>Enter</kbd> inserts it.</p><p>The autocomplete offers:</p><ul><li>Basic operators such as <code>*=</code> and keywords (<code>limit</code>, <code>not</code>).</li><li>Fields for object-like fields such as <code>note</code> or <code>~relation</code>, triggered by typing <code>.</code>.</li><li>Contextual enumerations such as <code>note.type = \"</code> or <code>note.mime = \"</code>.</li><li><a href=\"#root/_help_HI6GBBIduIgv\">Label</a> names by typing <code>#</code>.<ul><li>A small gear on the name's icon indicates a system attribute.</li><li>After typing the label name, the value is also autocompleted with values that are present in the database.</li></ul></li><li><a href=\"#root/_help_Cq5X6iKQop6R\">Relation</a> names by typing <code>~</code>.</li><li><a href=\"#root/_help_m1lbrzyKDaRB\">Note ID</a>s can be inserted easily by typing <code>@</code> and looking for a note.<ul><li>If the note ID is under a valid syntax, it will be shown as a chip of the note instead of the raw ID.</li><li>This is especially useful for queries that make use of the note ID such as searching by template: <code>~template.noteId = @</code></li></ul></li></ul><h3>Syntax highlighting</h3><p>The search input features syntax highlighting, making recognized fields such as <code>note.</code> and operators like <code>NOT</code> stand out.</p><p>The same highlighting is available in <a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a> notes, for example to keep a collection of queries: set the language of the note to <em>Trilium Search Query</em>. The language is not enabled by default; add it from <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Code Notes</em> → <em>Available MIME types in the dropdown</em>.</p><h3>Error highlighting & linting</h3><p>The search is also checked for errors in two phases, which will be displayed as a red squiggle:</p><ul><li>Linter errors which identify common error patterns and also provide a way to fix them.</li><li>Search errors which are checked by the server, without indicating the exact place the error occurred.</li></ul><p>An error the search only runs into while running, such as an operator that note content cannot be searched with, is shown in a <em>Search error</em> card instead: below the search string, or at the top of the <a class=\"reference-link\" href=\"#root/_help_Ms1nauBra7gq\">Quick search</a> results.</p><h3>Multiline</h3><p>Long or complicated searches can be formatted by using newlines, similar to SQL queries. Newlines are treated just like spaces.</p><p>To add a new line, press <kbd>Shift</kbd>+<kbd>Enter</kbd>.</p><aside class=\"admonition note\"><p>Multiline is available only for the full search, other inputs such as the quick search or the collection filter are single line.</p></aside><h2>Search options</h2><p>Click <em>Add search option</em> to choose an option to apply.</p><ul><li>For each search option selected, the search configuration will update to reveal the entry. Each search option will have its own configuration.</li><li>To remove a search option, simply press the <span class=\"tn-icon bx bx-x\"></span> button to the right of it.</li></ul><p>The options available are:</p><ol><li><span class=\"tn-icon bx bx-code\"></span> Search script<ol><li>This feature allows writing a <a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a> note that will handle the search on its own.</li></ol></li><li><span class=\"tn-icon bx bx-run\"></span> Fast search<ol><li>The search will not look into the content of the notes, but it will still look into note titles and attributes, relations (based on the search query).</li><li>This method can speed up the search considerably for large <a href=\"#root/_help_wX4HbRucYSDD\">databases</a>.</li></ol></li><li><span class=\"tn-icon bx bx-archive\"></span> Include archived<ol><li><a class=\"reference-link\" href=\"#root/_help_MKmLg5x6xkor\">Archived Notes</a> will also be included in the results, whereas otherwise they would be ignored.</li></ol></li><li><span class=\"tn-icon bx bx-arrow-from-top\"></span> Order by<ol><li>Allows changing the criteria for ordering the results, for example to order by creation date or alphabetically instead of by relevancy (default).</li><li>It's also possible to change the order (ascending or descending) of the results.</li></ol></li><li><span class=\"tn-icon bx bx-stop\"></span> Limit<ol><li>Limits the results to a given maximum.</li><li>This can help if the number of results would otherwise be high, at the cost of not being able to view all the results.</li></ol></li><li><span class=\"tn-icon bx bx-bug\"></span> Debug<ol><li>This will print additional information in the server log (see <a class=\"reference-link\" href=\"#root/_help_qzNzp9LYQyPT\">Error logs</a>), regarding how the search expression was parsed.</li><li>This function is especially useful after understanding the search functionality in detail, in order to determine why a complex search query is not working as expected.</li></ol></li></ol><p>The same menu ends with a <em>Bulk actions</em> section for applying changes such as adding a label or a relation to the matched notes. Its groups—<em>Labels</em>, <em>Relations</em>, <em>Notes</em> and <em>Other</em>—each open a list of the actions in the corresponding group of the <a class=\"reference-link\" href=\"#root/_help_ivYnonVFBxbQ\">Bulk Actions</a> dialog, which is an alternative for operating directly with notes within the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>. Choosing one adds it to the search; unlike the other options, the same action can be added more than once (e.g. to apply multiple labels). After defining the actions, first press <em>Search</em> to check the matched notes and then choose <em>Search & Execute actions</em> from the menu beside it to trigger the actions.</p><h2>Viewing search results</h2><p>Results appear below the search pane, by default in the <em>Search preview</em> view. Each result is drawn as a <strong>snippet card</strong> with the note title, the path to it, a short excerpt of the matching text, and the attributes that matched. The excerpt of a code note keeps its indentation and is shown in the code font.</p><p>To show the results as a plain note list instead, choose <em>List</em> from the <a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a> bar. The <em>List</em> view shows one row per note, with the note's title and content preview.</p><p>The search will also highlight the words from the title or content that matched:</p><ul><li>With a solid underlined green for a direct match;</li><li>With a dotted underline orange for a partial match (matched by the fuzzy search).</li></ul><p>In addition, the <em>Search preview</em> view offers:</p><ul><li>The <strong>total number of results</strong> is always shown, so you can immediately tell how broad a query is.</li><li>A <strong>page-size selector</strong> lets you choose how many results to display per page. Your choice is remembered and synced across your devices (stored in the <code>searchResultsPageSize</code> option), so you do not have to reset it on every device.</li><li><strong>Clicking a result's title</strong> opens the note and jumps straight to the first match. The in-note find bar opens pre-filled with the first word of your search, so you can step through its matches with the find controls. To have the find bar look for a whole phrase instead, put the phrase in quotes in the search, e.g. <code>\"The Lord of the Rings\"</code>. In read-only notes, the other words of the search are highlighted as well. The excerpt and attributes can be selected without opening the note.</li><li><em>Open all results in new tabs</em> (<span class=\"tn-icon bx bx-window-open\"></span>, the button above the results) opens every result in a tab of its own, up to 50. Each tab opens on its first match with the find bar pre-filled, as when clicking a result.</li><li>If a match is inside a <strong>collapsed section</strong> (for example a folded heading), that section is expanded automatically so the match is visible.</li><li>When the excerpt is cut short, a <em>Show more</em> button expands the card to the note's full content, with the search terms highlighted. <em>Show less</em> returns to the excerpt.</li></ul><p>A saved search can also be <a class=\"reference-link\" href=\"#root/_help_NRnIZmSMc5sj\">printed or exported as PDF</a> from the <em>Print/export to PDF…</em> item of the <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>, in either <em>Search preview</em> or <em>List</em> view. The results are laid out as a list, as they stand when printing starts.</p><h2>Simple Note Search Examples</h2><ul><li><code>rings tolkien</code>: Full-text search to find notes containing both \"rings\" and \"tolkien\".</li><li><code>\"The Lord of the Rings\" Tolkien</code>: Full-text search where \"The Lord of the Rings\" must match exactly.</li><li><code>note.content *=* rings OR note.content *=* tolkien</code>: Find notes containing \"rings\" or \"tolkien\" in their content.</li><li><code>towers #book</code>: Combine full-text and attribute search to find notes containing \"towers\" and having the \"book\" label. Writing <code>towers AND #book</code> does the same; to search for the word \"and\" itself, put it in quotes.</li><li><code>c#</code> or <code>towers#book</code>: A <code>#</code> or <code>~</code> inside a word is part of the text, so these find notes containing \"c#\" or \"towers#book\". To start a label or relation, put a space before it.</li><li><code>towers #book or #author</code>: Search for notes containing \"towers\" and having either the \"book\" or \"author\" label.</li><li><code>towers #!book</code>: Search for notes containing \"towers\" and not having the \"book\" label.</li><li><code>#book #publicationYear = 1954</code>: Find notes with the \"book\" label and \"publicationYear\" set to 1954.</li><li><code>#genre *=* fan</code>: Find notes with the \"genre\" label containing the substring \"fan\". Additional operators include <code>*=*</code> for \"contains\", <code>=*</code> for \"starts with\", <code>*=</code> for \"ends with\", and <code>!=</code> for \"is not equal to\".</li><li><code>#book #publicationYear >= 1950 #publicationYear < 1960</code>: Use numeric operators to find all books published in the 1950s.</li><li><code>#dateNote >= TODAY-30</code>: Find notes with the \"dateNote\" label within the last 30 days. Supported date values include NOW +- seconds, TODAY +- days, MONTH +- months, YEAR +- years.</li><li><code>~author.title *=* Tolkien</code>: Find notes related to an author whose title contains \"Tolkien\".</li><li><code>#publicationYear %= '19[0-9]{2}'</code>: Use the '%=' operator to match a regular expression (regex). This feature has been available since Trilium 0.52.</li><li><code>note.content %= '\\\\d{2}:\\\\d{2} (PM|AM)'</code>: Find notes that mention a time. Backslashes in a regex must be escaped.</li></ul><h2>Advanced Use Cases</h2><ul><li><code>~author.relations.son.title = 'Christopher Tolkien'</code>: Search for notes with an \"author\" relation to a note that has a \"son\" relation to \"Christopher Tolkien\". This can be modeled with the following note structure:<ul><li>Books<ul><li>Lord of the Rings<ul><li>label: “book”</li><li>relation: “author” points to “J. R. R. Tolkien” note</li></ul></li></ul></li><li>People<ul><li>J. R. R. Tolkien<ul><li>relation: “son” points to \"Christopher Tolkien\" note</li><li>Christopher Tolkien</li></ul></li></ul></li></ul></li><li><code>~author.title *= Tolkien OR (#publicationDate >= 1954 AND #publicationDate <= 1960)</code>: Use boolean expressions and parentheses to group expressions.</li><li><code>towers (#genre = fantasy OR #genre = scifi)</code>: A group can open the expression part directly, without a <code>#</code> or <code>~</code> before the parenthesis. Here it finds notes containing \"towers\" whose genre is fantasy or scifi.</li><li><code>note.parents.title = 'Books'</code>: Find notes with a parent named \"Books\".</li><li><code>note.parents.parents.title = 'Books'</code>: Find notes with a grandparent named \"Books\".</li><li><code>note.ancestors.title = 'Books'</code>: Find notes with an ancestor named \"Books\".</li><li><code>note.children.title = 'sub-note'</code>: Find notes with a child named \"sub-note\".</li><li><code>note.links.title = 'Tolkien'</code>: Find notes linking to a note named \"Tolkien\".</li><li><code>note.backlinks.title = 'Reading list'</code>: Find the notes that \"Reading list\" links to.</li><li>A link is a relation you created, such as <code>~author</code>, or one that content creates: an internal link (<code>~internalLink</code>), an image (<code>~imageLink</code>), an included note (<code>~includeNoteLink</code>) or a relation map connection (<code>~relationMapLink</code>). Relations that configure a note, such as <code>~template</code> or a saved search's <code>~ancestor</code>, are not links.</li></ul><p>See also <a class=\"reference-link\" href=\"#root/_help_Oxyb6jOjjVNL\">Under the hood</a> for more syntax references.</p><h3>Search with Note Properties</h3><p>Notes have properties that can be used in searches, such as <code>noteId</code>, <code>dateModified</code>, <code>dateCreated</code>, <code>isProtected</code>, <code>type</code>, <code>title</code>, <code>text</code>, <code>content</code>, <code>rawContent</code>, <code>ownedLabelCount</code>, <code>labelCount</code>, <code>ownedRelationCount</code>, <code>relationCount</code>, <code>ownedRelationCountIncludingLinks</code>, <code>relationCountIncludingLinks</code>, <code>ownedAttributeCount</code>, <code>attributeCount</code>, <code>targetRelationCount</code>, <code>targetRelationCountIncludingLinks</code>, <code>parentCount</code>, <code>childrenCount</code>, <code>isArchived</code>, <code>contentSize</code>, <code>noteSize</code>, and <code>revisionCount</code>.</p><p>These properties can be accessed via the <code>note.</code> prefix, e.g., <code>note.type = code AND note.mime = 'application/json'</code>.</p><h3>Order by and Limit</h3><pre><code class=\"language-text-x-trilium-auto\">#author=Tolkien orderBy #publicationDate desc, note.title limit 10</code></pre><p>This example will:</p><ol><li>Find notes with the author label \"Tolkien\".</li><li>Order the results by <code>publicationDate</code> in descending order.</li><li>Use <code>note.title</code> as a secondary ordering if publication dates are equal.</li><li>Limit the results to the first 10 notes.</li></ol><h3>Negation</h3><p>Some queries can only be expressed with negation:</p><pre><code class=\"language-text-x-trilium-auto\">#book AND not(note.ancestors.title = 'Tolkien')</code></pre><p>This query finds all book notes not in the \"Tolkien\" subtree.</p><h2>Under the Hood</h2><p>See the <a href=\"#root/_help_Oxyb6jOjjVNL\">dedicated page</a> to understand how progressive search works in Trilium, as well as some advanced use cases.</p><h2>Auto-Trigger Search from URL</h2><p>You can open Trilium and automatically trigger a search by including the search <a href=\"https://meyerweb.com/eric/tools/dencoder/\">url encoded</a> string in the URL:</p><p><code>http://localhost:8080/#?searchString=abc</code></p><h2>Search Configuration</h2><h3>Parameters</h3><figure class=\"table\"><table><thead><tr><th>Parameter</th><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>MIN_FUZZY_TOKEN_LENGTH</code></td><td>3</td><td>Minimum characters the <code>~=</code> and <code>~*</code> operators accept</td></tr><tr><td><code>MAX_EDIT_DISTANCE</code></td><td>2</td><td>Ceiling on character changes, reached only by 7+ character terms; shorter terms allow fewer. See the <em>Fuzzy tolerance</em> section above</td></tr><tr><td><code>RESULT_SUFFICIENCY_THRESHOLD</code></td><td>5</td><td>Minimum exact results before fuzzy fallback</td></tr><tr><td><code>MAX_CONTENT_SIZE</code></td><td>10MB</td><td>Maximum note content size for search processing</td></tr></tbody></table></figure><h3>Limits</h3><ul><li>Searched note content is limited to 10MB per note to prevent performance issues</li><li>Notes exceeding this limit will still be included in title and attribute searches</li><li>Terms of 3 characters or fewer are matched exactly; typo tolerance starts at 4 characters</li></ul>","_help_Oxyb6jOjjVNL": "<h2>Progressive Search Strategy</h2><p>Trilium uses a progressive search strategy that performs exact matching first, then adds fuzzy matching when needed.</p><p>The search has three phases:</p><ol><li><strong>Phase 1 - Exact Matching</strong>: When you search, Trilium first looks for exact matches of your search terms. This handles the vast majority of searches (90%+) and returns results almost instantly.</li><li><strong>Phase 2 - Fuzzy Fallback</strong>: If Phase 1 doesn't find enough high-quality results (fewer than 5 results with good relevance scores), Trilium automatically adds fuzzy matching to find results with typos or spelling variations.</li><li><strong>Result Ordering</strong>: Exact matches always appear before fuzzy matches, regardless of individual scores. This ensures that when you search for \"project\", notes containing the exact word \"project\" will appear before notes containing similar words like \"projects\" or \"projection\".</li></ol><h3>Progressive Search Behavior</h3><ul><li><strong>Speed</strong>: Most searches complete using only exact matching</li><li><strong>Ordering</strong>: Exact matches appear before fuzzy matches</li><li><strong>Fallback</strong>: Fuzzy matching activates when exact matches return fewer than 5 results</li><li><strong>Identification</strong>: Results indicate whether they are exact or fuzzy matches</li></ul><h2>Search Performance</h2><p>Search system specifications:</p><ul><li>Content size limit: 10MB per note (previously 50KB)</li><li>Edit distance calculations for fuzzy matching</li><li>Infinite scrolling in Quick Search</li></ul><h2>Label and Relation Shortcuts</h2><p>The \"full\" syntax for searching by labels is:</p><pre><code class=\"language-text-x-trilium-auto\">note.labels.publicationYear = 1954</code></pre><p>For relations:</p><pre><code class=\"language-text-x-trilium-auto\">note.relations.author.title *=* Tolkien</code></pre><p>However, common label and relation searches have shortcut syntax:</p><pre><code class=\"language-text-x-trilium-auto\">#publicationYear = 1954\n~author.title *=* Tolkien</code></pre><h2>Separating Full-Text and Attribute Parts</h2><p>Search syntax allows combining full-text search with attribute-based search. For example, <code>tolkien #book</code> contains:</p><ol><li>Full-text tokens - <code>tolkien</code></li><li>Attribute expressions - <code>#book</code></li></ol><p>Trilium detects the separation between full text search and attribute/property search by looking for certain special characters or words that denote attributes and properties (e.g., #, ~, note.). If you need to include these in full-text search, escape them with a backslash so they are processed as regular text:</p><pre><code class=\"language-text-x-trilium-auto\">\"note.txt\" \n\\#hash \n#myLabel = 'Say \"Hello World\"'</code></pre><h2>Escaping Special Characters</h2><p>Special characters can be enclosed in quotes or escaped with a backslash to be used in full-text search:</p><pre><code class=\"language-text-x-trilium-auto\">\"note.txt\"\n\\#hash\n#myLabel = 'Say \"Hello World\"'</code></pre><p>Three types of quotes are supported: single, double, and backtick.</p><h2>Type Coercion</h2><p>Label values are technically strings but can be coerced for numeric comparisons:</p><pre><code class=\"language-text-x-trilium-auto\">note.dateCreated =* '2019-05'</code></pre><p>This finds notes created in May 2019. Numeric operators like <code>#publicationYear >= 1960</code> convert string values to numbers for comparison.</p>","_help_WbjlujkUhEb5": "<p>The single most common source of confusion is that the <code>=</code> sign means two <em>different</em> things depending on where it appears. Read this section once and the rest of search becomes predictable.</p><p>There are three matching modes:</p><figure class=\"table\"><table><thead><tr><th>Mode</th><th>How you trigger it</th><th>What it matches</th><th>Substring?</th><th>Fuzzy (typos)?</th></tr></thead><tbody><tr><td><strong>Default</strong></td><td>type words with no prefix</td><td>whole words <em>and</em> substrings, anywhere in title, content or attributes, relevance-ranked</td><td>Yes</td><td>Yes</td></tr><tr><td><strong>Exact full-text</strong></td><td>a leading <code>=</code> (e.g. <code>=sync</code>)</td><td>the exact whole word or phrase, ignoring surrounding punctuation</td><td>No</td><td>No</td></tr><tr><td><strong>Attribute / property equality</strong></td><td><code>=</code> inside a <code>#label=value</code> or <code>note.property=value</code> clause</td><td>the <em>entire</em> attribute or property value, exactly</td><td>No</td><td>No</td></tr></tbody></table></figure><h3>Default matching (no prefix)</h3><p><strong>Rule:</strong> typing words with no prefix finds notes that contain those words anywhere in the title, content or attributes, as whole words or as substrings. The closest matches are ranked first.</p><figure class=\"table\"><table><thead><tr><th>Query</th><th>Example note content</th><th>Matches?</th><th>Why</th></tr></thead><tbody><tr><td><code>sync</code></td><td><code>please sync the folders</code></td><td>Yes (ranked higher)</td><td>contains the exact word <code>sync</code></td></tr><tr><td><code>sync</code></td><td><code>synchronize the database now</code></td><td>Yes (ranked lower)</td><td><code>sync</code> is a substring of <code>synchronize</code></td></tr></tbody></table></figure><h3>Exact match with the <code>=</code> prefix</h3><p><strong>Rule:</strong> a leading <code>=</code> switches the full-text search to exact matching. It finds the whole word or phrase only, ignoring surrounding punctuation, with <strong>no</strong> substring and <strong>no</strong> fuzzy matching. Use it when a normal search returns too many near-matches.</p><figure class=\"table\"><table><thead><tr><th>Query</th><th>Example note content</th><th>Matches?</th><th>Why</th></tr></thead><tbody><tr><td><code>=sync</code></td><td><code>see (sync) mode</code></td><td>Yes</td><td><code>(sync)</code> is the whole word <code>sync</code>; punctuation is ignored</td></tr><tr><td><code>=sync</code></td><td><code>in sync, then continue</code></td><td>Yes</td><td><code>sync,</code> is the whole word <code>sync</code></td></tr><tr><td><code>=sync</code></td><td><code>he said \"sync\" out loud</code></td><td>Yes</td><td><code>\"sync\"</code> is the whole word <code>sync</code></td></tr><tr><td><code>=sync</code></td><td><code>synchronize the database now</code></td><td>No</td><td><code>=</code> never matches substrings</td></tr><tr><td><code>=sync</code></td><td><code>please send the file</code></td><td>No</td><td><code>=</code> never matches typos / fuzzy</td></tr></tbody></table></figure><p>To match an exact <strong>phrase</strong>, quote it after the <code>=</code> (single, double or backtick quotes all work). The phrase must appear as consecutive words, but punctuation between or around them is ignored:</p><figure class=\"table\"><table><thead><tr><th>Query</th><th>Example note (title or content)</th><th>Matches?</th><th>Why</th></tr></thead><tbody><tr><td><code>=\"project plan\"</code></td><td>title <code>Project Plan</code></td><td>Yes</td><td>the title is exactly the phrase</td></tr><tr><td><code>=\"project plan\"</code></td><td><code>the (project plan) is ready to share</code></td><td>Yes</td><td>the consecutive phrase appears; punctuation is ignored</td></tr><tr><td><code>=\"project plan\"</code></td><td><code>the plan for this project is late</code></td><td>No</td><td>the words are present but not consecutive</td></tr></tbody></table></figure><h3>Attribute and property equality (<code>=</code>, <code>!=</code>)</h3><p><strong>Rule:</strong> when <code>=</code> compares an attribute or property, as in <code>#label=value</code> or <code>note.title=value</code>, it is <strong>strict full-value equality</strong>: the <em>whole</em> value must equal what you typed, ignoring case and diacritics. This is <strong>not</strong> word matching. <code>!=</code> inverts it.</p><p>The examples below assume four notes: <em>Austria</em> (<code>#capital=Vienna</code>), <em>Somewhere</em> (<code>#capital=Vienna Austria</code>), <em>Czech Republic</em> (<code>#capital=Prague</code>) and <em>Switzerland</em> (<code>#capital=Zürich</code>).</p><figure class=\"table\"><table><thead><tr><th>Query</th><th>Example label value</th><th>Matches?</th><th>Why</th></tr></thead><tbody><tr><td><code>#capital=Vienna</code></td><td><code>Vienna</code></td><td>Yes</td><td>the whole value equals <code>Vienna</code></td></tr><tr><td><code>#capital=Vienna</code></td><td><code>Vienna Austria</code></td><td>No</td><td>the whole value is <code>Vienna Austria</code>, not <code>Vienna</code></td></tr><tr><td><code>#capital=\"Vienna Austria\"</code></td><td><code>Vienna Austria</code></td><td>Yes</td><td>quote a multi-word value to match it in full</td></tr><tr><td><code>#capital=Zurich</code></td><td><code>Zürich</code></td><td>Yes</td><td>equality ignores diacritics</td></tr><tr><td><code>#capital!=Vienna</code></td><td><code>Prague</code></td><td>Yes</td><td><code>!=</code> matches every value that is not <code>Vienna</code></td></tr><tr><td><code>#capital!=Vienna</code></td><td><code>Vienna</code></td><td>No</td><td><code>!=</code> excludes the exact value</td></tr></tbody></table></figure><blockquote><p><strong>Quick search relaxes this.</strong> The <a href=\"#root/_help_Ms1nauBra7gq\">Quick search</a> bar and autocomplete treat an attribute <code>=</code> as \"contains\", so <code>#capital=Vienna</code> typed there also matches <code>Vienna Austria</code>. The strict full-value equality described here applies only in the full Search.</p></blockquote><h3>Fuzzy operators (<code>~=</code> and <code>~*</code>)</h3><p><strong>Rule:</strong> the fuzzy operators tolerate typos. <code>~=</code> (fuzzy-equals) matches a value that is a close whole-word variant of your term. <code>~*</code> (fuzzy-contains) matches when your term appears anywhere inside the value, either as a fragment or as a near-miss. Both work on note properties such as <code>note.title</code> and <code>note.content</code>, and on labels (<code>#label</code>). Fuzzy operators accept terms of at least 3 characters, though how many typos each term tolerates depends on its length — see <em>Fuzzy tolerance</em> below.</p><p>The examples assume a note titled <code>Books</code> carrying the label <code>#author=Tolkien</code>, and a note whose content is <code>learn programming today</code>.</p><figure class=\"table\"><table><thead><tr><th>Query</th><th>Example value</th><th>Matches?</th><th>Why</th></tr></thead><tbody><tr><td><code>note.title ~= boks</code></td><td>title <code>Books</code></td><td>Yes</td><td>one edit away from <code>books</code></td></tr><tr><td><code>#author ~= tolkein</code></td><td>author <code>Tolkien</code></td><td>Yes</td><td><code>tolkein</code> is a typo of <code>tolkien</code></td></tr><tr><td><code>note.content ~* progr</code></td><td><code>learn programming today</code></td><td>Yes</td><td><code>progr</code> is a fragment of <code>programming</code></td></tr><tr><td><code>note.content ~* programing</code></td><td><code>learn programming today</code></td><td>Yes</td><td><code>programing</code> is one edit from <code>programming</code></td></tr></tbody></table></figure><h3>Fuzzy tolerance</h3><p><strong>Rule:</strong> how many typos are tolerated depends on the <strong>length</strong> of your search term. Short terms must match exactly, because a single edit is enough to turn one short word into an unrelated one; longer terms have greater tolerance.</p><figure class=\"table\"><table><thead><tr><th>Term length</th><th>Edits allowed</th></tr></thead><tbody><tr><td>1–3 characters</td><td>0 (exact only)</td></tr><tr><td>4–6 characters</td><td>1</td></tr><tr><td>7+ characters</td><td>2</td></tr></tbody></table></figure><figure class=\"table\"><table><thead><tr><th>Query</th><th>Term length</th><th>Example note content</th><th>Matches?</th><th>Why</th></tr></thead><tbody><tr><td><code>cat</code></td><td>3</td><td><code>a bright red car</code></td><td>No</td><td>No edits are allowed below 4 characters, so <code>cat</code> does not reach <code>car</code></td></tr><tr><td><code>carr</code></td><td>4</td><td><code>a blue debit card</code></td><td>Yes</td><td>1 edit is within budget for 4–6 character terms</td></tr><tr><td><code>ceck</code></td><td>4</td><td><code>the latest tech trends</code></td><td>No</td><td><code>ceck</code>→<code>tech</code> needs 2 edits; only 1 is allowed at this length</td></tr><tr><td><code>combinef</code></td><td>8</td><td><code>the values were combined together</code></td><td>Yes</td><td><code>combinef</code>→<code>combined</code> is 1 edit; up to 2 are allowed at 7+ characters</td></tr></tbody></table></figure><h3>Relevance ranking</h3><p><strong>Rule:</strong> results are ordered by <em>how well</em> they match, not merely whether they match. Exact whole-word and phrase matches rank above substring and fuzzy matches, and a note where your words appear as a consecutive phrase outranks one where they are scattered.</p><figure class=\"table\"><table><thead><tr><th>Query</th><th>Ranked higher</th><th>Ranked lower</th><th>Why</th></tr></thead><tbody><tr><td><code>sync</code></td><td><code>please sync the folders</code></td><td><code>synchronize the database now</code></td><td>exact word beats substring</td></tr><tr><td><code>you and me</code></td><td><code>I like you and me as a phrase</code></td><td><code>the menu is here and you know it</code></td><td>consecutive phrase beats scattered words</td></tr></tbody></table></figure><h3>What is searchable</h3><p>A search looks at more than the visible body text. All of the following are indexed and searchable:</p><ul><li>note titles,</li><li>note body content,</li><li>labels and relations (<a href=\"#root/_help_zEY4DaJG4YT5\">attributes</a>),</li><li>link URLs and the titles/descriptions of link previews,</li><li>the titles of notes that a note reference-links to.</li></ul><p>The last point is the least obvious: if a note's only content is a reference link to another note, searching for that other note's <strong>title</strong> still finds the linking note.</p><figure class=\"table\"><table><thead><tr><th>Query</th><th>Setup</th><th>Matches?</th><th>Why</th></tr></thead><tbody><tr><td><code>special topic</code></td><td>a note whose only content is a reference link to a note titled <code>Special Topic</code></td><td>Yes, and the linked target ranks first</td><td>the target's title is indexed into the linking note's searchable text</td></tr><tr><td><code>special</code></td><td>the same note (only a reference link to <code>Special Topic</code>)</td><td>Yes, one word from the target's title is enough</td><td>the indexed title is normalized just like body text, so even one lowercased word matches</td></tr><tr><td><code>zurich</code></td><td>a note whose only content is a reference link to a note titled <code>Zürich</code></td><td>Yes</td><td>the indexed title has its accents normalized, so the plain form matches the accented title</td></tr></tbody></table></figure><h3>Diacritics</h3><p><strong>Rule:</strong> accents are normalized on both sides, so an accented word and its plain form match each other.</p><figure class=\"table\"><table><thead><tr><th>Query</th><th>Example note content</th><th>Matches?</th></tr></thead><tbody><tr><td><code>ktory</code></td><td><code>slovo ktorý znamena nieco</code></td><td>Yes</td></tr><tr><td><code>ktorý</code></td><td><code>the word ktory appears here</code></td><td>Yes</td></tr></tbody></table></figure><h3>Regular expressions (<code>%=</code>)</h3><p><strong>Rule:</strong> the <code>%=</code> operator matches a property or label value against a regular expression.</p><figure class=\"table\"><table><thead><tr><th>Query</th><th>Example note content</th><th>Matches?</th></tr></thead><tbody><tr><td><code>note.content %= 'colou?r'</code></td><td><code>my favorite color of all</code></td><td>Yes</td></tr><tr><td><code>note.content %= 'colou?r'</code></td><td><code>my favourite colour of all</code></td><td>Yes</td></tr></tbody></table></figure>",- "_help_u3YFHC9tQlpm": "<p>Frequently used notes can be bookmarked, which will make them appear in the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a> for easy access.</p><h2>Configuring the launch bar</h2><p>If bookmarks don't appear in the launch bar, then most likely the bookmark section has been hidden. Go to the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a> configuration from the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> and ensure <em>Bookmarks</em> is in the <em>Visible Launchers</em> section.</p><h2>Bookmark folder</h2><p>Space in the left panel is limited, and you might want to bookmark many items. One possible solution is to bookmark a folder, so it shows its children:</p><p>To do this, bookmark a folder, then right click its button in the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a> and check <em>Folder</em>. The button then opens a menu instead of the note itself: the note is at the top, followed by its children. Uncheck <em>Folder</em> to turn it back into a regular bookmark.</p><p>A child that has children of its own shows an arrow at the end of its row. Click the arrow to list its children in a submenu, or click the rest of the row to open the note. Submenus nest up to four levels deep. A menu that lists more than 15 children shows a filter field above them: type part of a title to list only the notes that match. A note whose subtree is hidden (see <a class=\"reference-link\" href=\"#root/_help_wyaGBBQrl4i3\">Hiding the subtree</a>) doesn't list its children here either.</p><p>The notes in the menu open the way links do: a middle click or <kbd>Ctrl</kbd>+click opens a note in a new tab, <kbd>Shift</kbd>+click opens it in a new window, and a right click lists the other places it can be opened in.</p><p><em>Folder</em> assigns the <code>#bookmarkFolder</code> label to the note, so adding the label by hand works as well. Because the label belongs to the note, a note that is both bookmarked and dropped onto the launch bar shows its children in both places.</p><h2>Mobile</h2><p>On mobile, bookmarks are only displayed starting with v0.102.0. Because of the more constrained screen size, the bookmarks are grouped under a single icon instead of displaying them as separate icons.</p><p>When pressed, a menu will appear listing all the bookmarks. Bookmark folders are also supported and will appear as submenus. Each submenu starts with its own note, so a note with children can be opened as well as browsed.</p>",+ "_help_u3YFHC9tQlpm": "<p>Frequently used notes can be bookmarked, which will make them appear in the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a> for easy access.</p><h2>Configuring the launch bar</h2><p>If bookmarks don't appear in the launch bar, then most likely the bookmark section has been hidden. Go to the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a> configuration from the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> and ensure <em>Bookmarks</em> is in the <em>Visible Launchers</em> section.</p><h2>Bookmark folder</h2><p>Space in the left panel is limited, and you might want to bookmark many items. One possible solution is to bookmark a folder, so it shows its children:</p><p>To do this, bookmark a folder, then right click its button in the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a> and check <em>Folder</em>. The button then opens a menu instead of the note itself: the note is at the top, followed by its children. Uncheck <em>Folder</em> to turn it back into a regular bookmark.</p><p>A child that has children of its own shows an arrow at the end of its row. Click the arrow to list its children in a submenu, or click the rest of the row to open the note. Submenus nest up to four levels deep. A menu that lists more than 15 children shows a filter field above them: type part of a title to list only the notes that match. A note whose subtree is hidden (see <a class=\"reference-link\" href=\"#root/_help_wyaGBBQrl4i3\">Hiding the subtree</a>) doesn't list its children here either.</p><p>The notes in the menu open the way links do: a middle click or <kbd>Ctrl</kbd>+click opens a note in a new tab, <kbd>Shift</kbd>+click opens it in a new window, and a right click lists the other places it can be opened in.</p><p><em>Folder</em> assigns the <code>#bookmarkFolder</code> label to the note, so adding the label by hand works as well. Because the label belongs to the note, a note that is both bookmarked and dropped onto the launch bar shows its children in both places.</p><h2>Mobile</h2><p>On mobile, bookmarks are only displayed starting with v0.102.0. Because of the more constrained screen size, the bookmarks are grouped under a single icon instead of displaying them as separate icons.</p><p>When pressed, a menu will appear listing all the bookmarks. Bookmark folders are also supported and will appear as submenus. Each submenu starts with its own note, so a note with children can be opened as well as browsed.</p><p>On a phone, the bookmarks are also listed at the top of the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a> while it shows the root of a tab that is not hoisted, below the <a class=\"reference-link\" href=\"#root/_help_9sRHySam5fXb\">Workspaces</a>. Tap a bookmark to open it, or, for one with children, to list them, as with the other notes of the tree.</p>","_help_OR8WJ7Iz9K4U": "<p>Hoisting is a standard outliner feature which allows you to focus on (or \"zoom into\") a specific note and its subtree by hiding all parent and sibling notes. Demo:</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Navigation/Note%20Hoisting_note-hoisting.gif\"></p><p>In addition to showing only this subtree, this also narrows both full text search and <a href=\"#root/_help_MMiBEQljMQh2\">“jump to note”</a> to just notes present in hoisted subtree.</p><h2>Showing all notes again</h2><p>While a note is hoisted, the desktop interface shows a <em>Show all notes</em> button with the <span class=\"tn-icon bx bx-arrow-back\"></span> icon above the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>. Click it to unhoist the note and see the whole tree again.</p><p>See also <a href=\"#root/_help_9sRHySam5fXb\">Workspace</a> which extends this feature.</p>","_help_ZjLYv08Rp3qC": "<figure class=\"image image-style-align-right image_resized\" style=\"width:53.13%;\"><img style=\"aspect-ratio:895/694;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Navigation/Quick%20edit_image.png\" width=\"895\" height=\"694\"></figure><p><em>Quick edit</em> provides an alternative to the standard tab-based navigation and editing.</p><p>Instead of clicking on a note which switches the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a> to the newly selected note, or navigating between two different <a class=\"reference-link\" href=\"#root/_help_3seOhtN8uLIY\">Tabs</a>, the <em>Quick edit</em> feature opens as a popup window that can be easily dismissed.</p><p>This feature is also well integrated with <a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a> such as the calendar view, which makes it easy to edit entries without having to go back and forth between the child note and the calendar.</p><h2>Feature highlights</h2><ul><li>All note types are supported, including <a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>.</li><li>Note that the <a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a> will not be displayed, except for notes of type <a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>.</li><li>For <a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a> notes, depending on user preference, both the floating and classic editors are supported. See <a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>.</li><li>The title and the note and the icon are editable, just like a normal tab.</li><li>The note's actions and its menu are shown in the header of the popup, as in the title row of a tab.<ul><li>When other notes link to the note, a button with a link icon lists the <a class=\"reference-link\" href=\"#root/_help_wfGXLmm7x27z\">Backlinks</a>. Pressing one opens that note in the popup.</li><li>The menu items that only work in a tab are not shown: <em>Note map</em>, <em>Full width</em> and <em>Convert into attachment</em>.</li><li><em>Find</em> in the menu, or <kbd>Ctrl</kbd>+<kbd>F</kbd> on the desktop application, opens the <a class=\"reference-link\" href=\"#root/_help_McngOG2jbUWX\">Search in note</a> bar at the bottom of the popup. It searches the note in the popup, not the note in the tab behind it.</li><li>A help page opened from the popup, such as through the help button of the note type, opens in a second popup on top of it. Closing that popup returns to the note being edited.</li></ul></li><li>The <a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a> are also displayed.<ul><li>This integrates well with <a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a> where there are predefined attributes such as the <em>Start date</em> and <em>End date</em>, allowing for easy editing.</li></ul></li></ul><h2>Accessing the quick edit</h2><ul><li>From the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>:<ul><li>Right click on a note and select <em>Quick edit</em>.</li><li>or, press <kbd>Ctrl</kbd>+<kbd>Right click</kbd> on a note.</li></ul></li><li>On <a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>: <ul><li>Right click and select <em>Quick edit</em>.</li><li>or, press <kbd>Ctrl</kbd>+<kbd>Right click</kbd> on the link.</li></ul></li><li>On a <a class=\"reference-link\" href=\"#root/_help_lgKX7r3aL30x\">Note Tooltip</a>, press the quick edit icon.</li><li>In <a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>:<ul><li>For <a class=\"reference-link\" href=\"#root/_help_xWbu3jpNWapp\">Calendar</a>:<ul><li>Clicking on an event will open that event for quick editing.</li><li>If the calendar is for the <a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a> root, clicking on the day number will open the popup for that day note.</li></ul></li><li>For <a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map</a>:<ul><li>Clicking on a marker will open that marker, but only if the map is in read-only mode.</li></ul></li></ul></li></ul><h2>Handling of read-only notes</h2><p>The Quick edit feature has a unique behavior for <a class=\"reference-link\" href=\"#root/_help_CoFPLs3dRlXc\">Read-Only Notes</a>: </p><ul><li>If the note is read-only due to performance reasons (auto read-only), then the note is made editable for quick editing.</li><li>If the note has been manually set to read-only, then the note is read-only to prevent accidental change.<ul><li>In this case, the note can still be edited by on-screen instructions.</li></ul></li></ul><h2>Mobile support</h2><p>On a phone, the popup uses the full width of the screen and the note's content keeps the same side margin as a <a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a> note. The <a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a> of a text note sits at the foot of the dialog, below the note; its dropdowns open upwards so the keyboard does not cover them.</p>","_help_9sRHySam5fXb": "<p>Workspace is a concept built up on top of <a href=\"#root/_help_OR8WJ7Iz9K4U\">note hoisting</a>. It is based on the idea that a user has several distinct spheres of interest. An example might be \"Personal\" and \"Work\", these two spheres are quite distinct and don't interact together. When I focus on Work, I don't really care about personal notes.</p><p>So far workspace consists of these features:</p><ul><li><p><a href=\"#root/_help_OR8WJ7Iz9K4U\">note hoisting</a> - you can \"zoom\" into a workspace subtree to focus only on the relevant notes</p></li><li><p>easy entering of workspace: </p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Navigation/1_Workspaces_image.jpg\"></p></li><li><p>opening a workspace in a new tab: right-click the <span class=\"tn-icon bx bx-plus\"></span> button of the <a class=\"reference-link\" href=\"#root/_help_3seOhtN8uLIY\">Tabs</a> bar and select the workspace.</p></li><li><p>on a phone, the workspaces are listed at the top of the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a> while it shows the root of a tab that is not hoisted, such as a new tab. Tap one to enter it.</p></li><li><p>visual identification of workspace in tabs:<br><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Navigation/Workspaces_image.jpg\"></p></li></ul><h3>Configuration</h3><figure class=\"table\"><table><thead><tr><th>Label</th><th>Description</th></tr></thead><tbody><tr><td><code>workspace</code></td><td>Marks this note as a workspace, button to enter the workspace is controlled by this</td></tr><tr><td><code>workspaceIconClass</code></td><td>defines box icon CSS class which will be used in tab when hoisted to this note, and in the menu of the tab bar's <span class=\"tn-icon bx bx-plus\"></span> button</td></tr><tr><td><code>workspaceTabBackgroundColor</code></td><td>CSS color used in the note tab when hoisted to this note, and for the workspace's icon in the menu of the tab bar's <span class=\"tn-icon bx bx-plus\"></span> button, use any CSS color format, e.g. \"lightblue\" or \"#ddd\". See <a href=\"https://www.w3schools.com/cssref/css_colors.asp\">https://www.w3schools.com/cssref/css_colors.asp</a>.</td></tr><tr><td><code>workspaceCalendarRoot</code></td><td>Marking a note with this label will define a new per-workspace calendar for <a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a>. If there's no such note, the global calendar will be used.</td></tr><tr><td><code>workspaceTemplate</code></td><td>This note will appear in the selection of available template when creating new note, but only when hoisted into a workspace containing this template</td></tr><tr><td><code>workspaceSearchHome</code></td><td>new search notes will be created as children of this note when hoisted to some ancestor of this workspace note</td></tr><tr><td><code>workspaceInbox</code></td><td>Default inbox location for new notes when hoisted to some ancestor of this workspace note. See <a class=\"reference-link\" href=\"#root/_help_S0Fos78ZfcY7\">Note Inbox</a> for more information.</td></tr></tbody></table></figure>",diff --git a/docs/User Guide/User Guide/Basic Concepts and Features/Navigation/Bookmarks.md b/docs/User Guide/User Guide/Basic Concepts and Features/Navigation/Bookmarks.mdindex 70cbedc89c..842115e39b 100644--- a/docs/User Guide/User Guide/Basic Concepts and Features/Navigation/Bookmarks.md+++ b/docs/User Guide/User Guide/Basic Concepts and Features/Navigation/Bookmarks.md@@ -21,4 +21,6 @@ _Folder_ assigns the `#bookmarkFolder` label to the note, so adding the label byOn mobile, bookmarks are only displayed starting with v0.102.0. Because of the more constrained screen size, the bookmarks are grouped under a single icon instead of displaying them as separate icons.-When pressed, a menu will appear listing all the bookmarks. Bookmark folders are also supported and will appear as submenus. Each submenu starts with its own note, so a note with children can be opened as well as browsed.\ No newline at end of file+When pressed, a menu will appear listing all the bookmarks. Bookmark folders are also supported and will appear as submenus. Each submenu starts with its own note, so a note with children can be opened as well as browsed.++On a phone, the bookmarks are also listed at the top of the <a class="reference-link" href="../UI%20Elements/Note%20Tree.md">Note Tree</a> while it shows the root of a tab that is not hoisted, below the <a class="reference-link" href="Workspaces.md">Workspaces</a>. Tap a bookmark to open it, or, for one with children, to list them, as with the other notes of the tree.\ No newline at end of filediff --git a/docs/User Guide/User Guide/Installation & Setup/Mobile Frontend.md b/docs/User Guide/User Guide/Installation & Setup/Mobile Frontend.mdindex c1bf8e7263..1cf16682fd 100644--- a/docs/User Guide/User Guide/Installation & Setup/Mobile Frontend.md+++ b/docs/User Guide/User Guide/Installation & Setup/Mobile Frontend.md@@ -14,7 +14,7 @@ Here is a non-exhaustive list of differences between the desktop version and the* On a phone, the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree.md">Note Tree</a> lies under the note. The <span class="tn-icon bx bx-chevron-left"></span> button in the top-left of the screen slides the note away to reveal the tree, and opening a note from the tree slides it back in.* A swipe from the left edge of the screen also reveals the tree, but the system's or the browser's back gesture can take it over, depending on the platform.* Each tab remembers whether it was showing the tree or its note, and the folder its tree was showing. Switching tabs brings both back. Opening another note in the tab moves its tree to the folder holding that note.- * A new tab opens on the tree, at the root, with the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Navigation/Workspaces.md">Workspaces</a>, if there are any, listed above it. Tap one to hoist the tab into it.+ * A new tab opens on the tree, at the root, with the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Navigation/Workspaces.md">Workspaces</a> and the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Navigation/Bookmarks.md">Bookmarks</a>, if there are any, listed above it. Tap a workspace to hoist the tab into it.* In the Android app, the system back gesture or button closes the menu or dialog on top first, then a settings page in <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Options.md">Options</a>, then slides the note away to reveal the tree, then goes up one level in the tree. At the top of the tree, it sends the app to the background.* On wider screens, such as a tablet in landscape, the note tree is displayed as a sidebar next to the note instead. There, a <span class="tn-icon bx bx-sidebar"></span> button hides and shows it, and the choice is remembered together with the left pane of the desktop version.* A note with children shows a <span class="tn-icon bx bx-chevron-right"></span> (on iOS, preceded by how many children it lists): tapping it lists its children, and tapping any other note opens it.