Skip to content

Build your personal knowledge base with Trilium Notes

Merge remote-tracking branch 'origin/main' into claude/help-virtual-branch-note-3ropqy

Elian Dorane9390ec61d3c
diff --cc .gitattributes
index ef8a6cda45,a416222b2a..687d3549e7
--- a/.gitattributes
+++ b/.gitattributes
@@@ -6,15 -7,14 +6,12 @@@ package-lock.json linguist-generated=tr
apps/edit-docs/demo/** linguist-vendored=true
docs/** linguist-vendored=true
- # Normalize line endings.
- docs/**/*.md eol=lf
- docs/**/*.json eol=lf
- demo/**/*.html eol=lf
- demo/**/*.json eol=lf
- demo/**/*.svg eol=lf
- demo/**/*.txt eol=lf
- demo/**/*.js eol=lf
- demo/**/*.css eol=lf
-# Normalize line endings. edit-docs writes the three generated trees with LF, so they have to
++# Normalize line endings. edit-docs writes the generated trees with LF, so they have to
+ # check out with LF too — otherwise every export leaves them looking modified on Windows.
+ # `text=auto` keeps the images and other binary attachments they contain out of the conversion.
+ patches/** eol=lf
+ docs/** text=auto eol=lf
-apps/server/src/assets/doc_notes/** text=auto eol=lf
+ apps/edit-docs/demo/** text=auto eol=lf
*.sh eol=lf
# Always diff TypeScript sources as text so a stray control byte (e.g. a NUL in
diff --cc CLAUDE.md
index aa1cb39e77,d915bbd80e..3c0cf320cc
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@@ -350,117 -225,47 +225,60 @@@ Use `note.getOwnedAttribute()` for dire
## Documentation
- Script API reference — Generated by `apps/build-docs` (TypeDoc) into the gitignored `site/script-api/{backend,frontend,electron}` and published to [docs.triliumnotes.org](https://docs.triliumnotes.org/). Not committed; never hand-edit — it's regenerated from the script API type definitions
- - `docs/User Guide/` — Edit via `pnpm edit-docs:edit-docs`, not manually. It is also the **single source of the in-app help**; see below
- - `docs/Developer Guide/` and `docs/Release Notes/` — Safe for direct Markdown editing
-- `docs/User Guide/` — Markdown pages plus `!!!meta.json`; the in-app help under `apps/server/src/assets/doc_notes/` and `apps/standalone/src/assets/help_meta.json` are **generated from it and never hand-edited**. Edit the Markdown by hand or in the editor (`pnpm edit-docs:edit-docs`), then run `pnpm edit-docs:sync-docs` so the HTML and both help metas follow. A page's shape (a new page, an image, a rename, a move) is meta work — the **`writing-documentation` skill**'s `docs.mjs` does it (`new`, `image`, `rename`, `move`, `delete`) and audits the trees (`check`); load the skill before touching `docs/`
++- `docs/User Guide/` — Markdown pages plus `!!!meta.json`; the in-app help artifacts `apps/server/src/assets/help/help_meta.json` and `help_content.json` are **generated from it and never hand-edited**. Edit the Markdown by hand or in the editor (`pnpm edit-docs:edit-docs`), then run `pnpm edit-docs:sync-docs` so both artifacts follow. A page's shape (a new page, an image, a rename, a move) is meta work — the **`writing-documentation` skill**'s `docs.mjs` does it (`new`, `image`, `rename`, `move`, `delete`) and audits the trees (`check`); load the skill before touching `docs/`
+ - `docs/Developer Guide/` and `docs/Release Notes/` — Safe for direct Markdown editing (also normalized by `sync-docs`)
+### In-app help (the `_help` subtree)
+
- The User Guide is exported **once**, as markdown. `edit-docs` derives two artifacts from that export and commits them to `apps/server/src/assets/help/`:
-
- - `help_meta.json` — the note tree: ids, titles, types, labels, and each page's `source` (its markdown file) and `dir` (for folder notes, which have no file of their own and are linked by directory)
- - `help_content.json` — each page rendered to HTML, keyed by note ID, with links rewritten to `#root/_help_<noteId>` and assets to `{{helpAssets}}/<path>`
-
- Both are **generated** — never hand-edit them; run `pnpm edit-docs:edit-docs` and let the export rewrite them. The generators are `apps/edit-docs/src/help_meta_generator.ts` and `help_bundle_generator.ts`, both pure and unit-tested.
++Help pages are **virtual notes** (`packages/trilium-core/src/services/virtual_notes.ts`): they exist only in becca, are never persisted or synced, and are read-only through an inheritable `readOnly` label on `_help`. `edit-docs` renders them from the Markdown into the two artifacts above; their images stay in `docs/User Guide/` and every packaging path (server, desktop, standalone) copies them itself. Load the **`in-app-help` skill** before touching the pipeline or its providers.
+
- Help pages are **virtual notes** (`services/virtual_notes.ts`): they exist only in becca, are never persisted or synced, and are read-only via an inheritable `readOnly` label on the `_help` root. Content reaches them through `InAppHelpProvider.getHelpContent()`, and `getHelpAssetBase()` decides where the `{{helpAssets}}` placeholder points — that is how one bundle serves every platform.
+ ### A user-facing change is documented in the same change
- **Images and attachments live only in `docs/User Guide/`** and are not committed anywhere else, so **every packaging path needs its own copy step**. There are four, and missing one fails only in that one place:
+ Any change to what the user sees or does — a feature, a button moved or removed, a keyboard shortcut, a
+ label, an option, a default, where a feature is configured — **is not finished until the User Guide
+ describes the new state, in the same commit or PR as the code.** The docs are a deliverable, not a
+ follow-up. Before reporting the work done: `node .claude/skills/writing-documentation/docs.mjs impact
+ --diff` (plus `impact "<feature name>"` for names the diff cannot know) lists the pages that mention the
+ changed UI strings and the help pages wired from the touched components; read every hit and edit what
+ describes an affordance that changed; a feature no page covers gets a page (`docs.mjs new`). Then
+ `docs.mjs sync` and `docs.mjs check`. Release notes are the maintainer's at release time — not on a branch.
- | Where | Runtime | Build |
- |---|---|---|
- | server | `getHelpAssetDir()` reads `docs/User Guide` when `isDev` | `apps/server/scripts/build.ts` copies it into `assets/help/` |
- | desktop | same (it runs the server) | `apps/desktop/scripts/build.ts` needs its **own** copy — it copies `apps/server/src/assets`, which is not where these live |
- | standalone | dev middleware in `vite.config.mts` | `copyHelpAssetsPlugin` in the same file |
- | mobile | inherits the standalone dist (`webDir`) | — |
+ Two traps this catches:
- Adding a static asset route also means adding it to the **dev allowlist** in `apps/server/src/routes/assets.ts` — see the warning under Server-Side Static Assets.
+ - **The doc named the wrong place to begin with.** Verify where a control actually mounts by grepping for
+ the component, not by inferring it from an i18n namespace or from another doc page — `NoteBadges` is
+ keyed `breadcrumb_badges.*` and renders in the title row.
+ - **A capability gate has a blast radius.** Widening one (a note type added to a list a widget switches
+ on) can surface panels, bars and menu entries the change never mentioned. Grep the gate's other readers
+ and say what else now appears.
- ## Key Entry Points
+ ## Recipes
- - `apps/server/src/main.ts` — Server startup
- - `apps/client/src/desktop.ts` — Client initialization
- - `packages/trilium-core/src/becca/becca.ts` — Backend data management
- - `apps/client/src/services/froca.ts` — Frontend cache
- - `apps/server/src/routes/routes.ts` — API route registration
- - `packages/trilium-core/src/services/sql/sql.ts` — Database abstraction
+ ### Storing User Preferences
+ **No `localStorage`** — preferences are synced options. To add one: (1) type in `OptionDefinitions`, `packages/commons/src/lib/options_interface.ts`; (2) default in `defaultOptions`, `packages/trilium-core/src/services/options_init.ts`; (3) **whitelist it in `ALLOWED_OPTIONS`**, `packages/trilium-core/src/routes/api/options.ts` — otherwise the API rejects writes with "Option 'X' is not allowed to be changed"; (4) a control in the matching settings pane (`apps/client/src/widgets/type_widgets/options/*.tsx`) plus its English key; (5) read/write via `useTriliumOption` / `useTriliumOptionBool` / `useTriliumOptionInt` / `useTriliumOptionJson`. Details: `docs/Developer Guide/Developer Guide/Concepts/Options/Creating a new option.md`.
### Adding Hidden System Notes
- The hidden subtree (`_hidden`) contains system notes with predictable IDs (prefixed with `_`). Defined in `apps/server/src/services/hidden_subtree.ts` via the `HiddenSubtreeItem` interface from `@triliumnext/commons`.
-
- 1. Add the note definition to `buildHiddenSubtreeDefinition()` in `apps/server/src/services/hidden_subtree.ts`
- 2. Add a translation key for the title in `apps/server/src/assets/translations/en/server.json` under `"hidden-subtree"`
- 3. The note is auto-created on startup by `checkHiddenSubtree()` — uses deterministic IDs so all sync cluster instances generate the same structure
- 4. Key properties: `id` (must start with `_`), `title`, `type`, `icon` (format: `bx-icon-name` without `bx ` prefix), `attributes`, `children`, `content`
- 5. Use `enforceAttributes: true` to keep attributes in sync, `enforceBranches: true` for correct placement, `enforceDeleted: true` to remove deprecated notes
- 6. For launcher bar entries, see `hidden_subtree_launcherbar.ts`; for templates, see `hidden_subtree_templates.ts`
+ The `_hidden` subtree holds system notes with deterministic `_`-prefixed IDs so every sync instance builds the same tree; `checkHiddenSubtree()` creates them at startup. Add the `HiddenSubtreeItem` (from `@triliumnext/commons`) to `buildHiddenSubtreeDefinition()` in `packages/trilium-core/src/services/hidden_subtree.ts` — `id` (starts with `_`), `title` (key under `"hidden-subtree"` in `server.json`), `type`, `icon` (`bx-name`, no `bx ` prefix), `attributes`, `children`, `content`; `enforceAttributes` / `enforceBranches` / `enforceDeleted: true` keep attributes, placement and removals in sync. Launcher-bar entries: `hidden_subtree_launcherbar.ts`; templates: `hidden_subtree_templates.ts`.
### Writing to Notes from Server Services
- - `note.setContent()` requires a CLS (Continuation Local Storage) context — wrap calls in `cls.init(() => { ... })` (from `apps/server/src/services/cls.ts`)
+ - `note.setContent()` requires a CLS (Continuation Local Storage) context — wrap calls in `cls.init(() => { ... })` (from `packages/trilium-core/src/services/context.ts`)
- Operations called from Express routes already have CLS context; standalone services (schedulers, Electron IPC handlers) do not
### Adding New LLM Tools
- Tools are defined using `defineTools()` in `apps/server/src/services/llm/tools/` and automatically registered for both the LLM chat and MCP server.
-
- 1. Add the tool definition in the appropriate module (`note_tools.ts`, `attribute_tools.ts`, `attachment_tools.ts`, `hierarchy_tools.ts`) or create a new module
- 2. Each tool needs: `description`, `inputSchema` (Zod), `execute` function, and optionally `mutates: true` for write operations
- 3. If creating a new module, wrap tools in `defineTools({...})` and add the registry to `allToolRegistries` in `tools/index.ts`
- 4. Add a client-side friendly name in `apps/client/src/translations/en/translation.json` under `llm.tools.<tool_name>` — use **imperative tense** (e.g. "Search notes", "Create note", "Get attributes"), not present continuous
- 5. Use ETAPI (`apps/server/src/etapi/`) as inspiration for what fields to expose, but **do not import ETAPI mappers** — inline the field mappings directly in the tool so the LLM layer stays decoupled from the API layer
-
- ### Updating PDF.js
- The viewer under `packages/pdfjs-viewer/viewer/` is vendored from the pdf.js GitHub release matching the `pdfjs-dist` dependency, and pdf.js refuses to start when the two versions disagree — so a bump must always be followed by a re-vendor. `src/vendored_viewer.spec.ts` fails when they drift.
-
- **This is automated**: the weekly `update-pdfjs-viewer` workflow bumps `pdfjs-dist`, re-vendors, verifies, and opens a single PR carrying both. Renovate is deliberately disabled for `pdfjs-dist` (see `renovate.json`) because a bare version bump is never usable on its own. To do it by hand:
- 1. Update the `pdfjs-dist` version in `packages/pdfjs-viewer/package.json`
- 2. Run `pnpm --filter pdfjs-viewer update-viewer`
- 3. Run `pnpm --filter pdfjs-viewer test` and `pnpm --filter pdfjs-viewer e2e` to verify
- 4. Commit all changes including the updated viewer files
-
- `update-viewer.ts` re-applies our patches to `viewer.html` (custom stylesheet/script, relaxed `style-src-elem` CSP) and throws if an upstream markup change means it can no longer find them.
-
- ### Database Migrations
- - Add migration scripts in `apps/server/src/migrations/`
- - Update schema in `apps/server/src/assets/db/schema.sql`
+ Tools are `defineTools({...})` registries in `packages/trilium-core/src/services/llm/tools/` (`note_tools`, `attribute_tools`, `attachment_tools`, `hierarchy_tools`, …), served to both the LLM chat and the MCP server. Each tool: `description`, Zod `inputSchema`, `execute`, `mutates: true` for writes. A new module goes into `allToolRegistries` in `tools/index.ts`; Node-only tools (in-app docs) live in `apps/server/src/services/llm/tools/` and register via `registerToolRegistryLoader()` (a lazy dynamic-import loader — see `registerServerLlmExtensions` in `apps/server/src/services/llm/index.ts`) so the tool stack stays out of the startup path. Add the client label under `llm.tools.<tool_name>` in imperative tense ("Search notes"). Mirror ETAPI's field choices but **don't import ETAPI mappers** — inline them so the LLM layer stays decoupled.
### Server-Side Static Assets
- - Static assets (templates, SQL, translations, etc.) go in `apps/server/src/assets/`
- - Access them at runtime via `RESOURCE_DIR` from `apps/server/src/services/resource_dir.ts` (e.g. `path.join(RESOURCE_DIR, "llm", "skills", "file.md")`)
- - **Do not use `import.meta.url`/`fileURLToPath`** to resolve file paths — the server is bundled into CJS for production, so `import.meta.url` will not point to the source directory
- - **Do not use `__dirname` with relative paths** from source files — after bundling, `__dirname` points to the bundle output, not the original source tree
+ Node-side assets (templates, translations, prompts) live in `apps/server/src/assets/` and are read via `RESOURCE_DIR` from `apps/server/src/services/resource_dir.ts` (`path.join(RESOURCE_DIR, "llm", "prompts", …)`); assets core itself reads (`schema.sql`, LLM skills) live in `packages/trilium-core/src/assets/`. **Never resolve paths with `import.meta.url`/`fileURLToPath` or `__dirname` + relative path** — the server bundles to `dist/main.mjs` plus lazy `chunks/`, so both point at the bundle (or at whichever chunk the module landed in), not the source tree.
+#### A new static route needs a dev path too, and a 200 does not mean it works
+
+In dev, Vite's middleware owns whole URL prefixes and answers anything it does not recognise with `index.html`. A missing static route therefore returns **200 with `text/html`**, not a 404 — so `curl -o /dev/null -w "%{http_code}"`, and any test that only checks the status, passes while every asset is broken. **Check `Content-Type` (or the body), never the status alone.**
+
+Two places apply the fallback, and both need the route added explicitly:
+
+- **server** — `apps/server/src/routes/assets.ts` mounts Vite on `/${assetUrlFragment}/` with an allowlist (`/images/`, `/doc_notes/`, `/help/`) of prefixes that fall through to the static mounts. A path not on that list is swallowed
+- **standalone** — `apps/standalone/vite.config.mts`; `viteStaticCopy` targets are served in dev, but anything copied by a custom plugin needs its own `configureServer` middleware (see `copyHelpAssetsPlugin` and `pdfjsServePlugin`). A plugin marked `apply: "build"` does nothing under `standalone:start`
+
## MCP Server
- - Trilium exposes an MCP (Model Context Protocol) server at `http://localhost:8080/mcp`, configured in `.mcp.json`
- - The MCP server is **only available when the Trilium server is running** (`pnpm run server:start`)
- - It requires an ETAPI token on every request — create one in Options → ETAPI and export it as `TRILIUM_ETAPI_TOKEN` before starting Claude Code (`.mcp.json` reads that variable). Without it the endpoint answers `401`
- - It provides tools for reading, searching, and modifying notes directly from the AI assistant
- - Use it to interact with actual note data when developing or debugging note-related features
-
- ## Build System Notes
- - Uses pnpm for monorepo management
- - Vite for fast development builds
- - ESBuild for production optimization
- - pnpm workspaces for dependency management
- - Docker support with multi-stage builds
-
- ### Two TypeScript versions, on purpose
- The root `package.json` declares **both** `typescript` (6.x) and `@typescript/native` (an alias of `typescript@7`). Do not "deduplicate" them by bumping `typescript` to 7:
-
- - **`typescript` 6.x is the library.** TypeScript 7 is the native Go port and its package no longer exports the JS compiler API (`exports["."]` is just a version stub). Everything that does `require("typescript")` needs 6.x: TypeDoc, typescript-eslint, and — the one that also ships to users — `packages/codemirror`, which runs the real language service in the browser for script-note IntelliSense.
- - **`@typescript/native` is the compiler binary**, used only by `scripts/filter-tsc-output.mts` behind `pnpm typecheck`. It builds the whole project graph in roughly a seventh of the time 6.x takes.
- - pnpm gives `node_modules/.bin/tsc` to the alias, so a bare `tsc` on the command line is **7**, not the 6.x that tooling loads. That is also what keeps `.tsbuildinfo` in one format — the two majors cannot read each other's, and mixing them forces a full rebuild every time.
-
- **Do not switch to `@typescript/typescript6`.** Microsoft's documented side-by-side layout aliases `typescript` to that compatibility shim so the native compiler can own the `tsc` bin name. It does not fit here, for two reasons that only show up at build time:
-
- - The shim ships five files and **no `lib.*.d.ts`**, so the 96 `typescript/lib/lib.*.d.ts?raw` imports in `packages/codemirror/src/type_completion/ts_lib_files.ts` fail to resolve and the client build dies.
- - Working around that by keeping a real `typescript` under `packages/codemirror` splits resolution: `@typescript/vfs` and `@valtown/codemirror-ts` are hoisted to the root and follow the shim, while codemirror's own source follows its nested copy. Two physical paths means the 3.3 MB compiler is bundled **twice** into the lazy script-note chunk (measured: client `dist` 69 M → 72 M).
- The official layout assumes the only consumer of the `typescript` name is tooling. This repo also bundles it into a browser app, so the plain package has to stay.
+ Trilium exposes an MCP server at `http://localhost:8080/mcp` (`.mcp.json`) — only while `pnpm server:start` is running, and only with an ETAPI token exported as `TRILIUM_ETAPI_TOKEN` before starting Claude Code (otherwise `401`; create one in Options → ETAPI). Use it to read/search/modify real note data when developing note-related features.
diff --cc apps/client/src/widgets/sidebar/RightPanelContainer.tsx
index e17b258e1d,b6fd790093..72fcc3584d
--- a/apps/client/src/widgets/sidebar/RightPanelContainer.tsx
+++ b/apps/client/src/widgets/sidebar/RightPanelContainer.tsx
@@@ -238,14 -240,9 +240,9 @@@ function useItems(rightPaneVisible: boo
enabled: !!note,
tab: "connections"
},
- {
- el: <SimilarNotes />,
- enabled: !!note,
- tab: "connections"
- },
{
el: <TableOfContents />,
- enabled: (noteType === "text" || noteType === "doc" || isPdf || noteType === "llmChat" || !!note?.isMarkdown()),
+ enabled: (noteType === "text" || isPdf || noteType === "llmChat" || !!note?.isMarkdown()),
tab: "outline"
},
{
diff --cc apps/edit-docs/package.json
index 0f00478b33,3ee46439ba..3be4920d46
--- a/apps/edit-docs/package.json
+++ b/apps/edit-docs/package.json
@@@ -19,6 -19,7 +19,7 @@@
"test": "vitest",
"test-build": "vitest --config vitest.build.config.mts",
"edit-docs": "cross-env TRILIUM_PORT=37741 TRILIUM_DATA_DIR=data TRILIUM_INTEGRATION_TEST=memory-no-store tsx ../../scripts/electron-start.mts src/edit-docs.ts",
+ "sync-docs": "cross-env TRILIUM_DATA_DIR=data TRILIUM_INTEGRATION_TEST=memory-no-store TRILIUM_ENV=dev TRILIUM_RESOURCE_DIR=../server/src tsx src/sync-docs.ts",
- "edit-demo": "cross-env TRILIUM_PORT=37744 TRILIUM_DATA_DIR=data TRILIUM_INTEGRATION_TEST=memory-no-store DOCS_ROOT=../../../docs USER_GUIDE_ROOT=\"../../server/src/assets/doc_notes/en/User Guide\" tsx ../../scripts/electron-start.mts src/edit-demo.ts"
+ "edit-demo": "cross-env TRILIUM_PORT=37744 TRILIUM_DATA_DIR=data TRILIUM_INTEGRATION_TEST=memory-no-store DOCS_ROOT=../../../docs tsx ../../scripts/electron-start.mts src/edit-demo.ts"
}
}
diff --cc apps/edit-docs/src/docs_pipeline.spec.ts
index 0000000000,c27b78fedb..b3f21d3b1d
mode 000000,100644..100644
--- a/apps/edit-docs/src/docs_pipeline.spec.ts
+++ b/apps/edit-docs/src/docs_pipeline.spec.ts
@@@ -1,0 -1,93 +1,36 @@@
+ import { describe, expect, it } from "vitest";
+
-import { normalizeLineEndings, rewriteHelpLinks } from "./docs_pipeline.js";
-
-describe("rewriteHelpLinks", () => {
- it("prefixes plain help-note links with _help_", () => {
- const input = `<a class="reference-link" href="#root/iPIMuisry3hd">Text</a>`;
- expect(rewriteHelpLinks(input)).toBe(`<a class="reference-link" href="#root/_help_iPIMuisry3hd">Text</a>`);
- });
-
- it("does not prefix canonical hidden-subtree notes that already start with an underscore", () => {
- // `_optionsTextNotes` keeps its canonical ID in production; prefixing it would produce the
- // broken `_help__optionsTextNotes` link reported in issue #9646.
- const input = `<a href="#root/_hidden/_options/_optionsTextNotes">Text Notes</a>`;
- expect(rewriteHelpLinks(input)).toBe(input);
- });
-
- it("leaves both options links untouched while still prefixing a sibling help link", () => {
- const input = [
- `<a href="#root/_help_4TIF1oA4VQRO">Options</a>`,
- `<a href="#root/_hidden/_options/_optionsTextNotes">Text Notes</a>`,
- `<a href="#root/_hidden/_options/_optionsCodeNotes">Code Notes</a>`
- ].join(" ");
- const result = rewriteHelpLinks(input);
-
- expect(result).not.toContain("_help__");
- expect(result).toContain("#root/_hidden/_options/_optionsTextNotes");
- expect(result).toContain("#root/_hidden/_options/_optionsCodeNotes");
- });
-
- it("reduces the note path the editor writes to the target ID alone", () => {
- // What a link created in the editor looks like: a full path whose intermediate IDs exist
- // only in the docs instance. An import rewrites the same link to `#root/<noteId>`, so
- // without this the exported HTML alternated between the two forms.
- const input = [
- `<a class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/R9pX4DGra2Vt">Sharing</a>`,
- `<a class="reference-link" href="#root/jdjRLhLV3TtI/YjerxU7Aii8X">Troubleshooting</a>`
- ].join(" ");
- const expected = [
- `<a class="reference-link" href="#root/_help_R9pX4DGra2Vt">Sharing</a>`,
- `<a class="reference-link" href="#root/_help_YjerxU7Aii8X">Troubleshooting</a>`
- ].join(" ");
- expect(rewriteHelpLinks(input)).toBe(expected);
- });
-
- it("reduces a path whose target is already prefixed, as a previously exported link is", () => {
- const input = `<a href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_hrZ1D00cLbal">Internal links</a>`;
- expect(rewriteHelpLinks(input)).toBe(`<a href="#root/_help_hrZ1D00cLbal">Internal links</a>`);
- });
-
- it("keeps a query suffix on the link it rewrites", () => {
- const input = `<a href="#root/pOsGYCXsbNQG/R9pX4DGra2Vt?viewMode=source">Sharing</a>`;
- expect(rewriteHelpLinks(input)).toBe(`<a href="#root/_help_R9pX4DGra2Vt?viewMode=source">Sharing</a>`);
- });
-
- it("is idempotent for already-prefixed help links", () => {
- const input = `<a href="#root/_help_iPIMuisry3hd">Text</a>`;
- expect(rewriteHelpLinks(input)).toBe(input);
- });
-});
++import { normalizeLineEndings } from "./docs_pipeline.js";
+
+ describe("normalizeLineEndings", () => {
+ const encoder = new TextEncoder();
+ const decoder = new TextDecoder();
+
+ it("rewrites CRLF to LF and keeps a lone CR, LF and trailing CR", () => {
+ const input = encoder.encode("# Title\r\n\r\nA line.\nAnother\rline.\r");
+ expect(decoder.decode(normalizeLineEndings(input))).toBe("# Title\n\nA line.\nAnother\rline.\r");
+ });
+
+ it("keeps multi-byte characters intact", () => {
+ const input = encoder.encode("Ștergere\r\nnotițe 😀\r\n");
+ expect(decoder.decode(normalizeLineEndings(input))).toBe("Ștergere\nnotițe 😀\n");
+ });
+
+ it("returns the same content when there is no CRLF to rewrite", () => {
+ const input = encoder.encode("Already normalized.\n");
+ expect(normalizeLineEndings(input)).toBe(input);
+ });
+
+ it("leaves binary content untouched", () => {
+ // A PNG header, whose byte 4 is the NUL that marks the content as binary, followed by
+ // pixel data that happens to contain a CRLF pair.
+ const input = new Uint8Array([0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a, 0x00, 0x0d, 0x0a, 0xff]);
+ expect(normalizeLineEndings(input)).toBe(input);
+ });
+
+ it("normalizes content whose NUL sits past the 8000-byte detection window", () => {
+ const prefix = "a".repeat(8000);
+ const input = encoder.encode(`${prefix}\r\n\0`);
+ expect(decoder.decode(normalizeLineEndings(input))).toBe(`${prefix}\n\0`);
+ });
+ });
diff --cc apps/edit-docs/src/docs_pipeline.ts
index 0000000000,41179ebaba..8da205ae11
mode 000000,100644..100644
--- a/apps/edit-docs/src/docs_pipeline.ts
+++ b/apps/edit-docs/src/docs_pipeline.ts
@@@ -1,0 -1,370 +1,328 @@@
+ /**
+ * The import/export half of edit-docs, with no Electron dependency: `edit-docs.ts` runs it
+ * behind a window, `sync-docs.ts` runs it headless.
+ */
-import { BackupService, initializeCore, type AdvancedExportOptions, type MessagingProvider, type NoteMeta, type NoteMetaFile } from "@triliumnext/core";
++import { BackupService, initializeCore, type MessagingProvider, type NoteMeta, type NoteMetaFile } from "@triliumnext/core";
+ import AsyncLocalStorageExecutionContext from "@triliumnext/server/src/cls_provider.js";
+ import NodejsCryptoProvider from "@triliumnext/server/src/crypto_provider.js";
+ import ServerPlatformProvider from "@triliumnext/server/src/platform_provider.js";
+ import { serverImageProvider } from "@triliumnext/server/src/services/image_provider.js";
+ import BetterSqlite3Provider from "@triliumnext/server/src/sql_provider.js";
+ import NodejsZipProvider from "@triliumnext/server/src/zip_provider.js";
+ import { type Archiver, ZipArchive } from "archiver";
+ import { createWriteStream, readFileSync, type WriteStream } from "fs";
+ import fs from "fs/promises";
+ import { load } from "js-yaml";
+ import path from "path";
+
+ import { deferred } from "../../../packages/commons/src/index.js";
-import { parseNoteMetaFile, serverTextNoteHandler, standaloneTextNoteHandler, stripAppVersion } from "./help_meta_generator.js";
++import { buildHelpBundle } from "./help_bundle_generator.js";
++import { buildHelpMeta, stripAppVersion } from "./help_meta_generator.js";
+
+ export interface NoteMapping {
+ rootNoteId: string;
+ path: string;
- format: "markdown" | "html";
++ format: "markdown";
+ ignoredFiles?: string[];
+ exportOnly?: boolean;
++ /**
++ * Where to write the in-app help tree derived from this mapping's export, if it is the one
++ * backing the User Guide. Relative to the configuration file.
++ */
++ helpMeta?: string;
++ /** Where to write the rendered content of that tree. Relative to the configuration file. */
++ helpContent?: string;
+ }
+
+ export interface Config {
+ baseUrl: string;
+ noteMappings: NoteMapping[];
+ }
+
+ /**
+ * Reads `edit-docs-config.yaml`: the given path, else the current directory, else the repository
+ * root. Mapping paths resolve against the config file's directory.
+ */
+ export async function loadConfig(configPath?: string): Promise<Config> {
+ let resolvedPath = configPath
+ ? path.resolve(configPath)
+ : path.join(process.cwd(), "edit-docs-config.yaml");
+
+ const exists = await fs.access(resolvedPath).then(() => true).catch(() => false);
+ if (!exists && !configPath) {
+ resolvedPath = path.join(__dirname, "../../../edit-docs-config.yaml");
+ }
+
+ const config = load(await fs.readFile(resolvedPath, "utf-8")) as Config;
+ const configDir = path.dirname(resolvedPath);
+ return {
+ baseUrl: config.baseUrl,
+ noteMappings: config.noteMappings.map((mapping) => ({
+ ...mapping,
- path: path.resolve(configDir, mapping.path)
++ path: path.resolve(configDir, mapping.path),
++ helpMeta: mapping.helpMeta ? path.resolve(configDir, mapping.helpMeta) : undefined,
++ helpContent: mapping.helpContent ? path.resolve(configDir, mapping.helpContent) : undefined
+ }))
+ };
+ }
+
+ // Stub backup service (not used in edit-docs, but required by initializeCore)
+ class StubBackupService extends BackupService {
+ constructor() {
+ super({ getOption: () => "", getOptionOrNull: () => null, getOptionBool: () => false, setOption: () => {} });
+ }
+ scheduleBackups(): void {}
+ async backupNow(_name: string): Promise<string> {
+ throw new Error("Backup not supported in edit-docs");
+ }
+ async getExistingBackups() {
+ return [];
+ }
+ async getBackupContent(_filePath: string): Promise<Uint8Array | null> {
+ return null;
+ }
+ }
+
+ /**
+ * Initializes core against an in-memory database. `messaging` is the IPC provider when a window
+ * is attached; headless runs pass none.
+ */
+ export async function initializeDocsCore(messaging?: MessagingProvider) {
+ const dbProvider = new BetterSqlite3Provider();
+ dbProvider.loadFromMemory();
+
+ const { serverZipExportProviderFactory } = await import("@triliumnext/server/src/services/export/zip/factory.js");
+
+ await initializeCore({
+ dbConfig: {
+ provider: dbProvider,
+ isReadOnly: false,
+ async onTransactionCommit() {
+ if (!messaging) {
+ return;
+ }
+ const { ws } = await import("@triliumnext/core");
+ ws.sendTransactionEntityChangesToAllClients();
+ },
+ onTransactionRollback: () => {}
+ },
+ crypto: new NodejsCryptoProvider(),
+ zip: new NodejsZipProvider(),
+ zipExportProviderFactory: serverZipExportProviderFactory,
+ executionContext: new AsyncLocalStorageExecutionContext(),
+ platform: new ServerPlatformProvider(),
+ schema: readFileSync(require.resolve("@triliumnext/core/src/assets/schema.sql"), "utf-8"),
+ translations: (await import("@triliumnext/server/src/services/i18n.js")).initializeTranslationsWithParams,
+ messaging,
+ getDemoArchive: async () => null,
+ backup: new StubBackupService(),
+ image: serverImageProvider
+ });
+ }
+
+ export async function importData(path: string) {
+ const buffer = await createImportZip(path);
+ const { zipImportService, TaskContext, becca } = (await import("@triliumnext/core"));
+ const context = new TaskContext("no-progress-reporting", "importNotes", null);
+
+ const rootNote = becca.getRoot();
+ if (!rootNote) {
+ throw new Error("Missing root note for import.");
+ }
+ await zipImportService.importZip(context, buffer, rootNote, {
+ preserveIds: true
+ });
+ }
+
+ /** Imports every mapping that is not `exportOnly`, in config order. */
+ export async function importMappings(mappings: NoteMapping[]) {
+ for (const mapping of mappings) {
+ if (!mapping.exportOnly) {
+ await importData(mapping.path);
+ }
+ }
+ }
+
+ /** Exports every mapping, in config order, replacing each target directory. */
+ export async function exportMappings(mappings: NoteMapping[], baseUrl: string) {
+ for (const mapping of mappings) {
- const ignoredFiles = mapping.ignoredFiles ? new Set(mapping.ignoredFiles) : undefined;
- await exportData(mapping.rootNoteId, mapping.format, mapping.path, baseUrl, ignoredFiles);
++ await exportData(mapping, baseUrl);
+ }
+ }
+
-export async function exportData(noteId: string, format: "markdown" | "html", outputPath: string, baseUrl: string, ignoredFiles?: Set<string>) {
++export async function exportData(mapping: NoteMapping, baseUrl: string) {
++ const { path: outputPath, ignoredFiles: ignoredFileNames } = mapping;
++ const ignoredFiles = ignoredFileNames ? new Set(ignoredFileNames) : undefined;
+ const zipFilePath = "output.zip";
+
+ try {
+ await fs.rm(outputPath, { recursive: true, force: true });
+ await fs.mkdir(outputPath, { recursive: true });
+
+ // First export as zip.
+ const { zipExportService } = (await import("@triliumnext/core"));
+
- const exportOpts: AdvancedExportOptions = {};
- if (format === "html") {
- exportOpts.skipHtmlTemplate = true;
- exportOpts.customRewriteLinks = (originalRewriteLinks, getNoteTargetUrl) => {
- return (content: string, noteMeta: NoteMeta) => {
- content = content.replace(/src="[^"]*api\/images\/([a-zA-Z0-9_]+)\/[^"]*"/g, (match, targetNoteId) => {
- const url = getNoteTargetUrl(targetNoteId, noteMeta);
-
- return url ? `src="${url}"` : match;
- });
-
- content = content.replace(/src="[^"]*api\/attachments\/([a-zA-Z0-9_]+)\/image\/[^"]*"/g, (match, targetAttachmentId) => {
- const url = findAttachment(targetAttachmentId);
-
- return url ? `src="${url}"` : match;
- });
-
- content = content.replace(/href="[^"]*#root[^"]*attachmentId=([a-zA-Z0-9_]+)\/?"/g, (match, targetAttachmentId) => {
- const url = findAttachment(targetAttachmentId);
-
- return url ? `href="${url}"` : match;
- });
-
- content = rewriteHelpLinks(content);
-
- return content;
-
- function findAttachment(targetAttachmentId: string) {
- let url;
-
- const attachmentMeta = (noteMeta.attachments || []).find((attMeta) => attMeta.attachmentId === targetAttachmentId);
- if (attachmentMeta) {
- // easy job here, because attachment will be in the same directory as the note's data file.
- url = attachmentMeta.dataFileName;
- } else {
- console.info(`Could not find attachment meta object for attachmentId '${targetAttachmentId}'`);
- }
- return url;
- }
- };
- };
- }
-
- await zipExportService.exportToZipFile(noteId, format, zipFilePath, exportOpts);
++ await zipExportService.exportToZipFile(mapping.rootNoteId, mapping.format, zipFilePath, {});
+ await extractZip(zipFilePath, outputPath, ignoredFiles);
+ } finally {
+ await fs.rm(zipFilePath, { force: true });
+ }
+
- await cleanUpMeta(outputPath, format === "html", baseUrl);
++ await cleanUpMeta(outputPath, mapping, baseUrl);
+ }
+
-async function cleanUpMeta(outputPath: string, minify: boolean, baseUrl: string) {
++/**
++ * Normalizes the freshly exported `!!!meta.json` so it doesn't churn between runs, and — for the
++ * mapping backing the User Guide — derives the in-app help tree and its rendered content.
++ */
++async function cleanUpMeta(outputPath: string, mapping: NoteMapping, baseUrl: string) {
+ const metaPath = path.join(outputPath, "!!!meta.json");
+ const meta = JSON.parse(await fs.readFile(metaPath, "utf-8")) as NoteMetaFile;
+ for (const file of meta.files) {
+ file.notePosition = 1;
+ traverse(file);
+ }
+
+ function traverse(el: NoteMeta) {
+ for (const child of el.children || []) {
+ traverse(child);
+ }
+
+ el.isExpanded = false;
++ }
+
- // Rewrite web view URLs that point to root.
- if (el.type === "webView" && minify) {
- const srcAttr = el.attributes.find(attr => attr.name === "webViewSrc");
- if (srcAttr.value.startsWith("/")) {
- srcAttr.value = baseUrl + srcAttr.value;
- }
- }
++ await fs.writeFile(metaPath, JSON.stringify(stripAppVersion(meta), null, 4));
++
++ if (!mapping.helpMeta && !mapping.helpContent) {
++ return;
+ }
+
- if (minify) {
- const subtree = parseNoteMetaFile(meta, serverTextNoteHandler, baseUrl);
- await fs.writeFile(metaPath, JSON.stringify(subtree));
++ const { meta: helpMeta, sources } = buildHelpMeta(meta, baseUrl);
+
- // Generate standalone meta: webView-based, pointing to online docs.
- const standaloneSubtree = parseNoteMetaFile(meta, standaloneTextNoteHandler, baseUrl);
- const standaloneMetaPath = path.resolve(__dirname, "../../standalone/src/assets/help_meta.json");
- await fs.writeFile(standaloneMetaPath, JSON.stringify(standaloneSubtree));
- } else {
- await fs.writeFile(metaPath, JSON.stringify(stripAppVersion(meta), null, 4));
++ if (mapping.helpMeta) {
++ await writeJson(mapping.helpMeta, helpMeta);
+ }
++
++ if (mapping.helpContent) {
++ const { markdownImportService } = await import("@triliumnext/core");
++ const bundle = buildHelpBundle(
++ helpMeta,
++ sources,
++ (source) => {
++ try {
++ return readFileSync(path.join(outputPath, source), "utf-8");
++ } catch {
++ return null;
++ }
++ },
++ (markdown, title) => markdownImportService.renderToHtml(markdown, title)
++ );
++
++ await writeJson(mapping.helpContent, bundle);
++ }
++}
++
++/** Writes JSON with one entry per line, so a docs change shows up as the pages it touched. */
++async function writeJson(filePath: string, value: unknown) {
++ await fs.mkdir(path.dirname(filePath), { recursive: true });
++ await fs.writeFile(filePath, JSON.stringify(value, null, 4));
+ }
+
+ async function createImportZip(path: string) {
+ const inputFile = "input.zip";
+ const archive = new ZipArchive({
+ zlib: { level: 0 }
+ });
+
+ archive.directory(path, "/");
+
+ const outputStream = createWriteStream(inputFile);
+ archive.pipe(outputStream);
+ await waitForEnd(archive, outputStream);
+
+ try {
+ return await fs.readFile(inputFile);
+ } finally {
+ await fs.rm(inputFile);
+ }
+ }
+
+ function waitForEnd(archive: Archiver, stream: WriteStream) {
+ return new Promise<void>((res, rej) => {
+ stream.on("finish", res);
+ stream.on("error", rej);
+ archive.on("error", rej);
+ archive.finalize().catch(rej);
+ });
+ }
+
-/**
- * Rewrites internal `#root/...` note links in exported help HTML so that they resolve
- * against the help subtree once imported into a production Trilium instance.
- *
- * In the edit-docs instance the help notes carry plain, randomly generated IDs, but in
- * production they live under the `_help` subtree with a `_help_` prefix. This adds that
- * prefix to the link's target note ID, and reduces the link to that ID alone: the editor
- * writes a full note path when a link is created, whose intermediate IDs belong to the
- * docs instance and match nothing in the tree a reader has, leaving the client to fall
- * back to the note's own path. The importer writes the same single-ID form, so a note
- * exported straight after an edit now matches one that has been through an import.
- */
-export function rewriteHelpLinks(content: string): string {
- return content.replace(/href="([^"]*#root)(?:[a-zA-Z0-9_/]*\/)?([a-zA-Z0-9_]+)([^"]*)"/g,
- (match, prefix: string, targetNoteId: string, suffix: string) => {
- if (targetNoteId.startsWith("_help_")) {
- return `href="${prefix}/${targetNoteId}${suffix}"`;
- }
-
- // Canonical hidden-subtree notes (e.g. _options, _optionsTextNotes) keep their IDs in
- // production, so they already start with an underscore, and their path is a real one.
- // Only help notes (random alphanumeric IDs) get the `_help_` prefix; prefixing the
- // others would produce broken `_help__optionsTextNotes`-style links (see issue #9646).
- if (targetNoteId.startsWith("_")) {
- return match;
- }
- return `href="${prefix}/_help_${targetNoteId}${suffix}"`;
- });
-}
-
+ export async function createZipFromDirectory(dirPath: string, zipPath: string) {
+ const archive = new ZipArchive({ zlib: { level: 5 } });
+ const outputStream = createWriteStream(zipPath);
+ archive.directory(dirPath, false);
+ archive.pipe(outputStream);
+ await waitForEnd(archive, outputStream);
+ }
+
+ export async function extractZip(zipFilePath: string, outputPath: string, ignoredFiles?: Set<string>) {
+ const promise = deferred<void>();
+ setTimeout(async () => {
+ const { getZipProvider } = (await import("@triliumnext/core"));
+ const zipProvider = getZipProvider();
+ const buffer = await fs.readFile(zipFilePath);
+ await zipProvider.readZipFile(buffer, async (entry, readContent) => {
+ // We ignore directories since they can appear out of order anyway.
+ if (!entry.fileName.endsWith("/") && !ignoredFiles?.has(entry.fileName)) {
+ const destPath = path.join(outputPath, entry.fileName);
+ const fileContent = await readContent();
+
+ await fs.mkdir(path.dirname(destPath), { recursive: true });
+ await fs.writeFile(destPath, normalizeLineEndings(fileContent));
+ }
+ });
+ promise.resolve();
+ }, 1000);
+ await promise;
+ }
+
+ /**
+ * Rewrites CRLF line endings to LF, so that `extractZip` writes the same bytes on Windows as it
- * does elsewhere. The exported trees (`docs/`, the help HTML, the demo) are stored with LF, and
++ * does elsewhere. The exported trees (`docs/`, the demo) are stored with LF, and
+ * Git only hides the difference once a file is staged.
+ *
+ * Binary entries such as images keep their bytes. They are detected the way Git detects them: a
+ * NUL byte within the first {@link BINARY_DETECTION_LENGTH} bytes marks the content as binary.
+ */
+ export function normalizeLineEndings(content: Uint8Array): Uint8Array {
+ if (isBinary(content)) {
+ return content;
+ }
+
+ const normalized = new Uint8Array(content.length);
+ let length = 0;
+ for (const [index, byte] of content.entries()) {
+ if (byte === CARRIAGE_RETURN && content[index + 1] === LINE_FEED) {
+ continue;
+ }
+
+ normalized[length++] = byte;
+ }
+
+ return length === content.length ? content : normalized.subarray(0, length);
+ }
+
+ const NUL = 0x00;
+ const LINE_FEED = 0x0a;
+ const CARRIAGE_RETURN = 0x0d;
+ const BINARY_DETECTION_LENGTH = 8000;
+
+ function isBinary(content: Uint8Array) {
+ const end = Math.min(content.length, BINARY_DETECTION_LENGTH);
+ for (let index = 0; index < end; index++) {
+ if (content[index] === NUL) {
+ return true;
+ }
+ }
+
+ return false;
+ }
diff --cc apps/edit-docs/src/help_meta_generator.spec.ts
index 0a5d3f12cc,6272508bbb..1368712f82
--- a/apps/edit-docs/src/help_meta_generator.spec.ts
+++ b/apps/edit-docs/src/help_meta_generator.spec.ts
@@@ -1,62 -1,48 +1,62 @@@
-import type { HiddenSubtreeItem } from "@triliumnext/commons";
+import type { HelpMetaItem } from "@triliumnext/commons";
- import type { NoteMeta } from "@triliumnext/core";
+ import type { NoteMeta, NoteMetaFile } from "@triliumnext/core";
import { describe, expect, it } from "vitest";
- import { buildHelpMeta } from "./help_meta_generator.js";
-import { parseNoteMetaFile, serverTextNoteHandler, standaloneTextNoteHandler, stripAppVersion } from "./help_meta_generator.js";
-
-describe("Help meta generation (server)", () => {
- it("preserves custom folder icon", () => {
- const child: NoteMeta = {
- isClone: false,
- noteId: "yoAe4jV2yzbd",
- notePath: [ "OkOZllzB3fqN", "yoAe4jV2yzbd" ],
- title: "Features",
- notePosition: 40,
- prefix: null,
- isExpanded: false,
- type: "text",
- mime: "text/html",
- attributes: [
- { type: "label", name: "iconClass", value: "bx bx-star", isInheritable: false, position: 10 }
- ],
- format: "html",
- attachments: [],
- dirFileName: "Features",
- children: []
- };
- const root: NoteMeta = {
- isClone: false, noteId: "root", notePath: ["root"], title: "Root",
- notePosition: 1, prefix: null, isExpanded: false, type: "text",
- mime: "text/html", attributes: [], format: "html", attachments: [],
- dirFileName: "Root", children: [child]
- };
-
- const metaFile = { formatVersion: 2, appVersion: "0.103.0", files: [root] };
- const items = parseNoteMetaFile(metaFile, serverTextNoteHandler);
- const icon = items[0]?.attributes?.find((a) => a.name === "iconClass");
- expect(icon?.value).toBe("bx bx-star");
++import { buildHelpMeta, stripAppVersion } from "./help_meta_generator.js";
+
+const BASE_URL = "https://docs.triliumnotes.org";
+
+/** Wraps the given notes in a "User Guide" export root, mirroring the real markdown export. */
+function metaFileOf(children: NoteMeta[], rootAttributes: NoteMeta["attributes"] = []): { formatVersion: number; appVersion: string; files: NoteMeta[] } {
+ const root: NoteMeta = {
+ isClone: false, noteId: "root", notePath: ["root"], title: "User Guide",
+ notePosition: 1, prefix: null, isExpanded: false, type: "text", mime: "text/html",
+ attributes: rootAttributes, format: "markdown", attachments: [],
+ dataFileName: "User Guide.md", dirFileName: "User Guide", children
+ };
+ return { formatVersion: 2, appVersion: "0.103.0", files: [root] };
+}
+
+const labelOf = (item: HelpMetaItem | undefined, name: string) =>
+ item?.attributes?.find((a) => a.name === name)?.value;
+
+describe("buildHelpMeta", () => {
+ it("resolves structure, icons and content sources", () => {
+ const page: NoteMeta = {
+ isClone: false, noteId: "text1", title: "Text", type: "text", mime: "text/html",
+ attributes: [{ type: "label", name: "iconClass", value: "bx bx-star", isInheritable: false, position: 10 }],
+ format: "markdown", dataFileName: "Text.md", children: []
+ };
+ const folder: NoteMeta = {
+ isClone: false, noteId: "types", title: "Note Types", type: "text", mime: "text/html",
+ attributes: [], format: "markdown", dirFileName: "Note Types", children: [page]
+ };
+
+ const { meta: items, sources } = buildHelpMeta(metaFileOf([folder]));
+ const folderItem = items[0];
+ const pageItem = folderItem?.children?.[0];
+
+ // A note with no data file of its own is a folder: no source, but a directory, which is
+ // the only path other pages can link to it by.
+ expect(folderItem?.id).toBe("_help_types");
+ expect(folderItem?.type).toBe("book");
+ expect(sources._help_types?.source).toBeUndefined();
+ expect(sources._help_types?.dir).toBe("User Guide/Note Types");
+ expect(labelOf(folderItem, "iconClass")).toBe("bx bx-folder");
+
+ // Sources are relative to the export directory, which already is the root note's folder,
+ // so the root contributes exactly one path segment.
+ expect(pageItem?.id).toBe("_help_text1");
+ expect(pageItem?.type).toBe("text");
+ expect(sources._help_text1?.source).toBe("User Guide/Note Types/Text.md");
+ expect(labelOf(pageItem, "iconClass")).toBe("bx bx-star");
});
- it("resolves a cloned note's iconClass and docName to the primary occurrence", () => {
+ it("resolves a clone's icon and source to the primary occurrence", () => {
// The same note is placed under two folders: a primary occurrence (isClone:false) carrying
- // a custom icon, and a clone (isClone:true) with no attributes and a ".clone" data file.
- // Both occurrences map to the same noteId, so the runtime hidden-subtree check enforces one
- // set of attributes; if the generator emits different iconClass/docName per occurrence, that
- // check flip-flops them on every run. The clone must therefore inherit the primary's values.
+ // a custom icon and the real file, and a clone (isClone:true) with no attributes and a
+ // ".clone" data file. Both are the same note, so both must describe it identically —
+ // otherwise the clone would point at a file that only exists to satisfy the export.
const primary: NoteMeta = {
isClone: false, noteId: "nix", title: "Nix flake", type: "text", mime: "text/html",
attributes: [{ type: "label", name: "iconClass", value: "bx bxl-tux", isInheritable: false, position: 10 }],
@@@ -72,78 -58,268 +72,95 @@@
};
const server: NoteMeta = {
isClone: false, noteId: "server", title: "Server Installation", type: "text", mime: "text/html",
- attributes: [], format: "html", dirFileName: "Server Installation", children: [clone]
- };
- const root: NoteMeta = {
- isClone: false, noteId: "root", title: "User Guide", type: "text", mime: "text/html",
- attributes: [], format: "html", dirFileName: "User Guide", children: [desktop, server]
+ attributes: [], format: "markdown", dirFileName: "Server Installation", children: [clone]
};
- const metaFile = { formatVersion: 2, appVersion: "0.103.0", files: [root] };
- const items = parseNoteMetaFile(metaFile, serverTextNoteHandler);
-
+ const { meta: items, sources } = buildHelpMeta(metaFileOf([desktop, server]));
const primaryItem = items.find((i) => i.id === "_help_desktop")?.children?.[0];
const cloneItem = items.find((i) => i.id === "_help_server")?.children?.[0];
+
expect(primaryItem?.id).toBe("_help_nix");
expect(cloneItem?.id).toBe("_help_nix");
-
- const iconOf = (it?: HiddenSubtreeItem) => it?.attributes?.find((a) => a.name === "iconClass")?.value;
- const docNameOf = (it?: HiddenSubtreeItem) => it?.attributes?.find((a) => a.name === "docName")?.value;
-
- // The clone inherits the primary's custom icon rather than falling back to "bx bx-file".
- expect(iconOf(primaryItem)).toBe("bx bxl-tux");
- expect(iconOf(cloneItem)).toBe("bx bxl-tux");
- // Both point at the same documentation file (the primary's), not the clone's ".clone" path.
- expect(docNameOf(cloneItem)).toBe(docNameOf(primaryItem));
+ expect(labelOf(cloneItem, "iconClass")).toBe("bx bxl-tux");
+ // Both occurrences are the one note, so they leave one source between them — the primary's
+ // file rather than the ".clone" copy the export wrote beside it.
+ expect(sources._help_nix?.source).toBe("User Guide/Desktop Installation/Nix flake.md");
});
- it("generates docUrl from shareAlias when baseUrl is provided", () => {
- const meta: NoteMeta = {
- isClone: false,
- noteId: "rootNote123",
- notePath: [ "rootNote123" ],
- title: "User Guide",
- notePosition: 1,
- prefix: null,
- isExpanded: false,
- type: "text",
- mime: "text/html",
- attributes: [
- { type: "label", name: "shareAlias", value: "user-guide", isInheritable: false, position: 10 }
- ],
- format: "html",
- dataFileName: "User Guide.html",
- dirFileName: "User Guide",
- attachments: [],
- children: [
- {
- isClone: false,
- noteId: "childNote456",
- notePath: [ "rootNote123", "childNote456" ],
- title: "Feature Highlights",
- notePosition: 10,
- prefix: null,
- isExpanded: false,
- type: "text",
- mime: "text/html",
- attributes: [
- { type: "label", name: "shareAlias", value: "feature-highlights", isInheritable: false, position: 10 }
- ],
- format: "html",
- dataFileName: "Feature Highlights.html",
- attachments: [],
- children: []
- }
- ]
+ it("derives docUrl from the share alias chain, and only when a base URL is given", () => {
+ const page: NoteMeta = {
+ isClone: false, noteId: "highlights", title: "Feature Highlights", type: "text", mime: "text/html",
+ attributes: [{ type: "label", name: "shareAlias", value: "feature-highlights", isInheritable: false, position: 10 }],
+ format: "markdown", dataFileName: "Feature Highlights.md", children: []
};
+ const rootAlias: NoteMeta["attributes"] = [
+ { type: "label", name: "shareAlias", value: "user-guide", isInheritable: false, position: 10 }
+ ];
- const metaFile = { formatVersion: 2, appVersion: "0.103.0", files: [meta] };
- const items = parseNoteMetaFile(metaFile, serverTextNoteHandler, "https://docs.triliumnotes.org");
+ const { meta: withBase } = buildHelpMeta(metaFileOf([page], rootAlias), BASE_URL);
+ expect(labelOf(withBase[0], "docUrl")).toBe("https://docs.triliumnotes.org/user-guide/feature-highlights");
- const child = items[0];
- const docUrl = child?.attributes?.find((a) => a.name === "docUrl");
- expect(docUrl?.value).toBe("https://docs.triliumnotes.org/user-guide/feature-highlights");
+ const { meta: withoutBase } = buildHelpMeta(metaFileOf([page], rootAlias));
+ expect(labelOf(withoutBase[0], "docUrl")).toBeUndefined();
});
- it("omits docUrl when no baseUrl is provided", () => {
- const meta: NoteMeta = {
- isClone: false,
- noteId: "rootNote123",
- notePath: [ "rootNote123" ],
- title: "User Guide",
- notePosition: 1,
- prefix: null,
- isExpanded: false,
- type: "text",
- mime: "text/html",
- attributes: [
- { type: "label", name: "shareAlias", value: "user-guide", isInheritable: false, position: 10 }
- ],
- format: "html",
- dataFileName: "User Guide.html",
- dirFileName: "User Guide",
- attachments: [],
- children: [
- {
- isClone: false,
- noteId: "childNote456",
- notePath: [ "rootNote123", "childNote456" ],
- title: "Feature Highlights",
- notePosition: 10,
- prefix: null,
- isExpanded: false,
- type: "text",
- mime: "text/html",
- attributes: [
- { type: "label", name: "shareAlias", value: "feature-highlights", isInheritable: false, position: 10 }
- ],
- format: "html",
- dataFileName: "Feature Highlights.html",
- attachments: [],
- children: []
- }
- ]
+ it("keeps web views pointing at the online docs and gives them no source", () => {
+ const embedded: NoteMeta = {
+ isClone: false, noteId: "embedded", title: "Embedded", type: "webView", mime: "",
+ attributes: [{ type: "label", name: "webViewSrc", value: "/user-guide/embedded", isInheritable: false, position: 10 }],
+ format: "markdown", dataFileName: "Embedded.md", children: []
};
- const metaFile = { formatVersion: 2, appVersion: "0.103.0", files: [meta] };
- const items = parseNoteMetaFile(metaFile, serverTextNoteHandler);
-
- const child = items[0];
- const docUrl = child?.attributes?.find((a) => a.name === "docUrl");
- expect(docUrl).toBeUndefined();
- });
-
- it("hides note that is hidden from share tree", () => {
- const meta: NoteMeta = {
- isClone: false,
- noteId: "yoAe4jV2yzbd",
- notePath: [ "OkOZllzB3fqN", "yoAe4jV2yzbd" ],
- title: "Features",
- notePosition: 40,
- prefix: null,
- isExpanded: false,
- type: "text",
- mime: "text/html",
- attributes: [
- { type: "label", name: "shareHiddenFromTree", value: "", isInheritable: false, position: 10 }
- ],
- format: "html",
- attachments: [],
- dirFileName: "Features",
- children: []
- };
+ const { meta: items, sources } = buildHelpMeta(metaFileOf([embedded]), BASE_URL);
- const metaFile = { formatVersion: 2, appVersion: "0.103.0", files: [meta] };
- const items = parseNoteMetaFile(metaFile, serverTextNoteHandler);
- expect(items).toHaveLength(0);
+ expect(items[0]?.type).toBe("webView");
+ expect(sources._help_embedded?.source).toBeUndefined();
+ // Root-relative sources are stored that way in the notes; the docs origin is applied here.
+ expect(labelOf(items[0], "webViewSrc")).toBe("https://docs.triliumnotes.org/user-guide/embedded");
});
-});
-describe("Help meta generation (standalone)", () => {
- it("converts text notes with URL to webView", () => {
- const child: NoteMeta = {
- isClone: false,
- noteId: "childNote456",
- notePath: [ "rootNote123", "childNote456" ],
- title: "Feature Highlights",
- notePosition: 10,
- prefix: null,
- isExpanded: false,
- type: "text",
- mime: "text/html",
- attributes: [
- { type: "label", name: "shareAlias", value: "feature-highlights", isInheritable: false, position: 10 }
- ],
- format: "html",
- dataFileName: "Feature Highlights.html",
- attachments: [],
- children: []
- };
- const root: NoteMeta = {
- isClone: false, noteId: "root", notePath: ["root"], title: "Root",
- notePosition: 1, prefix: null, isExpanded: false, type: "text",
- mime: "text/html", attributes: [
- { type: "label", name: "shareAlias", value: "root", isInheritable: false, position: 10 }
- ], format: "html", attachments: [],
- dirFileName: "Root", children: [child]
+ it("keeps the mime of code notes so their content is not treated as markdown", () => {
+ const script: NoteMeta = {
+ isClone: false, noteId: "script", title: "Example", type: "code", mime: "application/javascript;env=backend",
+ attributes: [], format: "markdown", dataFileName: "Example.js", children: []
};
- const metaFile = { formatVersion: 2, appVersion: "0.103.0", files: [root] };
- const items = parseNoteMetaFile(metaFile, standaloneTextNoteHandler, "https://docs.triliumnotes.org");
+ const { meta: items, sources } = buildHelpMeta(metaFileOf([script]));
- expect(items).toHaveLength(1);
- expect(items[0].type).toBe("webView");
- expect(items[0].enforceAttributes).toBe(true);
- expect(items[0].attributes).toContainEqual({
- type: "label", name: "webViewSrc", value: "https://docs.triliumnotes.org/root/feature-highlights"
- });
- expect(items[0].attributes?.find(a => a.name === "docName")).toBeUndefined();
+ expect(items[0]?.type).toBe("code");
+ expect(items[0]?.mime).toBe("application/javascript;env=backend");
+ expect(sources._help_script?.source).toBe("User Guide/Example.js");
});
- it("excludes text notes without URL", () => {
- const child: NoteMeta = {
- isClone: false,
- noteId: "childNote456",
- notePath: [ "rootNote123", "childNote456" ],
- title: "Feature Highlights",
- notePosition: 10,
- prefix: null,
- isExpanded: false,
- type: "text",
- mime: "text/html",
- attributes: [],
- format: "html",
- dataFileName: "Feature Highlights.html",
- attachments: [],
- children: []
- };
- const root: NoteMeta = {
- isClone: false, noteId: "root", notePath: ["root"], title: "Root",
- notePosition: 1, prefix: null, isExpanded: false, type: "text",
- mime: "text/html", attributes: [], format: "html", attachments: [],
- dirFileName: "Root", children: [child]
+ it("hides notes that are hidden from the share tree", () => {
+ const hidden: NoteMeta = {
+ isClone: false, noteId: "hidden", title: "Features", type: "text", mime: "text/html",
+ attributes: [{ type: "label", name: "shareHiddenFromTree", value: "", isInheritable: false, position: 10 }],
+ format: "markdown", dirFileName: "Features", children: []
};
- const metaFile = { formatVersion: 2, appVersion: "0.103.0", files: [root] };
- const items = parseNoteMetaFile(metaFile, standaloneTextNoteHandler);
- expect(items).toHaveLength(0);
+ expect(buildHelpMeta(metaFileOf([hidden])).meta).toHaveLength(0);
});
- it("preserves folder notes", () => {
- const child: NoteMeta = {
- isClone: false,
- noteId: "folderNote",
- notePath: [ "root", "folderNote" ],
- title: "Section",
- notePosition: 1,
- prefix: null,
- isExpanded: false,
- type: "text",
- mime: "text/html",
- attributes: [],
- format: "html",
- attachments: [],
- dirFileName: "Section",
- children: []
- };
- const root: NoteMeta = {
- isClone: false, noteId: "root", notePath: ["root"], title: "Root",
- notePosition: 1, prefix: null, isExpanded: false, type: "text",
- mime: "text/html", attributes: [], format: "html", attachments: [],
- dirFileName: "Root", children: [child]
- };
-
- const metaFile = { formatVersion: 2, appVersion: "0.103.0", files: [root] };
- const items = parseNoteMetaFile(metaFile, standaloneTextNoteHandler);
-
- expect(items).toHaveLength(1);
- expect(items[0].type).toBe("book");
+ it("returns nothing when the export has no files", () => {
+ expect(buildHelpMeta({ formatVersion: 2, appVersion: "0.103.0", files: undefined as never }))
+ .toEqual({ meta: [], sources: {} });
});
});
+
+ describe("stripAppVersion", () => {
+ it("drops the version stamp and keeps everything else the docs metadata carries", () => {
+ const meta = {
+ formatVersion: 2,
+ appVersion: "0.105.0",
+ files: [{ noteId: "abc", title: "Note", attributes: [] }]
+ } as unknown as NoteMetaFile;
+
+ const stripped = stripAppVersion(meta);
+
+ expect("appVersion" in stripped).toBe(false);
+ expect(stripped).toStrictEqual({ formatVersion: 2, files: meta.files });
- // The input is left alone: the minified branch of the export reads the same object.
++ // The input is left alone: the help tree is derived from the same object afterwards.
+ expect(meta.appVersion).toBe("0.105.0");
+ });
+ });
diff --cc apps/edit-docs/src/help_meta_generator.ts
index 7c56fd8db2,de89a594a9..33821255dd
--- a/apps/edit-docs/src/help_meta_generator.ts
+++ b/apps/edit-docs/src/help_meta_generator.ts
@@@ -21,123 -46,93 +21,134 @@@ export function buildHelpMeta(noteMetaF
}
const metaRoot = noteMetaFile.files[0];
- const docNameRoot = "/" + (metaRoot.dirFileName ?? "");
- // A note cloned into several help locations appears once per location, but the runtime
- // hidden-subtree check enforces a single set of attributes per noteId. The per-occurrence
- // `iconClass`/`docName` would therefore conflict and flip-flop on every check. Index the
- // primary (non-clone) occurrence's values up front so every clone can reuse them.
+ // A note cloned into several help locations appears once per location, but only one of the
+ // occurrences is the real thing: the others carry no attributes and a ".clone" data file.
+ // Index the primary occurrence's values up front so every clone can reuse them.
const canonicalByNoteId = new Map<string, CanonicalOccurrence>();
- indexPrimaryOccurrences(metaRoot, docNameRoot, canonicalByNoteId);
+ indexPrimaryOccurrences(metaRoot, "", canonicalByNoteId);
+
+ // Sources are relative to the export directory, which is the root note's own directory, so
+ // the walk starts empty and picks up that directory on its first step down. The documentation
+ // root doubles as the parent URL every page's share alias is appended to.
+ const sources: HelpSources = {};
+ const parsedMetaRoot = parseNoteMeta(metaRoot, "", canonicalByNoteId, sources, baseUrl, baseUrl);
+ return { meta: parsedMetaRoot?.children ?? [], sources };
+}
- const parsedMetaRoot = parseNoteMeta(metaRoot, handleTextNote, docNameRoot, canonicalByNoteId, baseUrl);
- return parsedMetaRoot?.children ?? [];
+/** The help tree, and the export files each of its notes was built from. */
+export interface HelpMetaResult {
+ meta: HelpMetaItem[];
+ sources: HelpSources;
+}
+
+/**
+ * Where each note's content came from, by note ID. Only the build has any use for it: the bundler
+ * reads the pages through it and resolves the links between them, and then it is thrown away
+ * rather than shipped.
+ */
+export type HelpSources = Record<string, HelpPageSource>;
+
+export interface HelpPageSource {
+ /**
+ * Content file, relative to the markdown export root (e.g. `User Guide/Note Types/Text.md`).
+ * Absent for folders and web views, which have no file of their own. Clones point at the
+ * primary occurrence's file rather than their own `.clone` copy.
+ */
+ source?: string;
+ /**
+ * Directory this note's children live in, relative to the markdown export root. Set for every
+ * note that has one, and the only way to address a folder note: it has no file of its own, so
+ * pages link to it by its directory.
+ */
+ dir?: string;
}
+ /**
+ * Drops the app version the exporter stamps onto a meta file. Nothing reads it back — neither the
+ * importer nor {@link parseNoteMetaFile} — while it moves on every release, so keeping it rewrites
+ * the committed documentation metadata for a field no code consults. An export a user takes of
+ * their own notes keeps it, as a record of the build that wrote the zip.
+ */
+ export function stripAppVersion(meta: NoteMetaFile): Omit<NoteMetaFile, "appVersion"> {
+ const { appVersion, ...rest } = meta;
+ return rest;
+ }
+
interface CanonicalOccurrence {
iconClass: string;
- docPath?: string;
+ source?: string;
}
-function parseNoteMeta(noteMeta: NoteMeta, handleTextNote: TextNoteHandler, docNameRoot: string, canonicalByNoteId: Map<string, CanonicalOccurrence>, parentUrl?: string): HiddenSubtreeItem | null {
- const item: HiddenSubtreeItem = {
- id: `_help_${noteMeta.noteId}`,
- title: noteMeta.title ?? "",
- type: "doc",
- attributes: []
- };
-
- // Handle folder notes
- if (!noteMeta.dataFileName) {
- item.type = "book";
- }
-
- // Build the URL for this note
+function parseNoteMeta(
+ noteMeta: NoteMeta,
+ sourceRoot: string,
+ canonicalByNoteId: Map<string, CanonicalOccurrence>,
+ sources: HelpSources,
+ baseUrl?: string,
+ parentUrl?: string
+): HelpMetaItem | null {
+ const attributes: HiddenSubtreeAttribute[] = [];
+
+ // Build the online URL for this note; only notes with a share alias of their own are
+ // published, the rest just pass their parent's URL down to their children.
const shareAlias = noteMeta.attributes?.find((a) => a.type === "label" && a.name === "shareAlias")?.value;
const currentUrl = parentUrl && shareAlias ? `${parentUrl}/${shareAlias}` : parentUrl;
- const noteUrl = shareAlias ? currentUrl : undefined;
- // Handle attributes
for (const attribute of noteMeta.attributes ?? []) {
+ if (attribute.name === "shareHiddenFromTree") {
+ return null;
+ }
+
if (attribute.name === "webViewSrc") {
- item.attributes?.push({
+ attributes.push({
type: "label",
- name: attribute.name,
- value: attribute.value
+ name: "webViewSrc",
+ // Web views pointing inside the documentation are stored root-relative.
+ value: absolutiseUrl(attribute.value, baseUrl)
});
}
+ }
- if (attribute.name === "shareHiddenFromTree") {
- return null;
- }
+ if (shareAlias && currentUrl) {
+ attributes.push({ type: "label", name: "docUrl", value: currentUrl });
}
- // Clones share the underlying note, so resolve their per-occurrence icon/docName to the
- // primary occurrence's values; otherwise the two occurrences would enforce conflicting ones.
+ // Clones share the underlying note, so resolve their icon and content file to the primary
+ // occurrence's; otherwise the two occurrences would describe the same note differently.
const canonical = noteMeta.isClone ? canonicalByNoteId.get(noteMeta.noteId ?? "") : undefined;
- const iconClass = canonical?.iconClass ?? computeIconClass(noteMeta);
+ attributes.push({
+ type: "label",
+ name: "iconClass",
+ value: canonical?.iconClass ?? computeIconClass(noteMeta)
+ });
- // Handle text notes
- if (noteMeta.type === "text" && noteMeta.dataFileName) {
- const docPath = canonical?.docPath ?? computeDocPath(docNameRoot, noteMeta.dataFileName);
- if (!handleTextNote(item, docPath, noteUrl)) {
- return null;
- }
+ const item: HelpMetaItem = {
+ id: `_help_${noteMeta.noteId}`,
+ title: noteMeta.title ?? "",
+ type: resolveType(noteMeta),
+ attributes
+ };
+
+ if (item.type === "code") {
+ item.mime = noteMeta.mime;
}
- // Handle web views
- if (noteMeta.type === "webView") {
- item.type = "webView";
- item.enforceAttributes = true;
+ const source = item.type === "text" || item.type === "code"
+ ? canonical?.source ?? computeSource(sourceRoot, noteMeta.dataFileName)
+ : undefined;
+ const dir = noteMeta.dirFileName ? computeSource(sourceRoot, noteMeta.dirFileName) : undefined;
+
+ if (source || dir) {
+ sources[item.id] = { source, dir };
}
- // Handle children
if (noteMeta.children) {
- const children: HiddenSubtreeItem[] = [];
+ const childSourceRoot = noteMeta.dirFileName ? `${sourceRoot}/${noteMeta.dirFileName}` : sourceRoot;
+ const children: HelpMetaItem[] = [];
+
for (const childMeta of noteMeta.children) {
- const newDocNameRoot = noteMeta.dirFileName ? `${docNameRoot}/${noteMeta.dirFileName}` : docNameRoot;
- const child = parseNoteMeta(childMeta, handleTextNote, newDocNameRoot, canonicalByNoteId, currentUrl);
+ const child = parseNoteMeta(childMeta, childSourceRoot, canonicalByNoteId, sources, baseUrl, currentUrl);
if (child) {
children.push(child);
}
diff --cc apps/edit-docs/src/sync-docs.ts
index 0000000000,6c9e89365e..5f27c53d53
mode 000000,100644..100644
--- a/apps/edit-docs/src/sync-docs.ts
+++ b/apps/edit-docs/src/sync-docs.ts
@@@ -1,0 -1,73 +1,73 @@@
+ /**
+ * Regenerates every export target in `edit-docs-config.yaml` from the Markdown trees, with no
+ * window: the same import and export that `edit-docs.ts` runs after an edit, so a page edited
- * by hand gets its normalized Markdown, the help HTML under `doc_notes` and the standalone
- * `help_meta.json` without opening Electron.
++ * by hand gets its normalized Markdown and the in-app help artifacts under `assets/help` without
++ * opening Electron.
+ *
+ * pnpm edit-docs:sync-docs [-- -c <config>]
+ *
+ * The import rejects a tree whose `!!!meta.json` and files disagree (a `.md` with no entry, a
+ * missing `dataFileName`), and that rejection is the check: an error here means the tree would
+ * also crash edit-docs at start-up.
+ */
+ import { cls } from "@triliumnext/core";
+
+ import { exportMappings, importMappings, initializeDocsCore, loadConfig } from "./docs_pipeline.js";
+
+ function parseArgs() {
+ const args = process.argv.slice(2);
+ let configPath: string | undefined;
+
+ for (let i = 0; i < args.length; i++) {
+ if (args[i] === "--config" || args[i] === "-c") {
+ configPath = args[i + 1];
+ if (!configPath) {
+ console.error("Error: --config/-c requires a path argument");
+ process.exit(1);
+ }
+ i++;
+ } else if (args[i] === "--help" || args[i] === "-h") {
+ console.log("Usage: sync-docs [-c <edit-docs-config.yaml>]");
+ process.exit(0);
+ }
+ }
+
+ return { configPath };
+ }
+
+ async function main() {
+ const { configPath } = parseArgs();
+ const config = await loadConfig(configPath);
+
+ await initializeDocsCore();
+
+ const { sql_init, becca_loader: beccaLoader, erase: eraseService } = await import("@triliumnext/core");
+ await new Promise<void>((resolve, reject) => {
+ cls.init(async () => {
+ try {
+ cls.ignoreEntityChangeIds();
+ await sql_init.createInitialDatabase(true);
+ await beccaLoader.beccaLoaded;
+
+ console.log("Importing", config.noteMappings.filter((m) => !m.exportOnly).map((m) => m.path).join(", "));
+ await importMappings(config.noteMappings);
+
+ eraseService.eraseUnusedAttachmentsNow();
+
+ console.log("Exporting", config.noteMappings.map((m) => m.path).join(", "));
+ await exportMappings(config.noteMappings, config.baseUrl);
+ resolve();
+ } catch (e) {
+ reject(e);
+ }
+ });
+ });
+ }
+
+ main().then(
+ () => process.exit(0),
+ (e) => {
+ console.error("Error syncing documentation:", e);
+ process.exit(1);
+ }
+ );
diff --cc apps/server/src/assets/help/help_content.json
index cbe6497b62,0000000000..c60c319390
mode 100644,000000..100644
--- a/apps/server/src/assets/help/help_content.json
+++ b/apps/server/src/assets/help/help_content.json
@@@ -1,267 -1,0 +1,288 @@@
+{
- "_help_BOCnjTMBCoxW": "<p>This section presents the most important changes by version. For a full set of changes, please consult the change log of each release. For purposes of brevity, beta versions are skipped and the features gathered to the nearest stable version.</p><ul><li>v0.101.0:<ul><li>A&nbsp;<a class=\"reference-link\" href=\"#root/_help_IjZS7iK5EXtb\">New Layout</a>&nbsp;has been introduced, making significant modifications to the UI/UX such as integrating the ribbon and the floating buttons into other UI elements and introducing new functionality such as the&nbsp;<a class=\"reference-link\" href=\"#root/_help_I6p2a06hdnL6\">Breadcrumb</a>.</li></ul></li><li>v0.97.0:<ul><li>Books are now&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>.</li><li><a class=\"reference-link\" href=\"#root/_help_2FvYrpmOXm29\">Table</a>&nbsp;is a new collection type displaying notes and attributes in an editable grid.</li><li><a class=\"reference-link\" href=\"#root/_help_ZjLYv08Rp3qC\">Quick edit</a>&nbsp;is introduced, adding a new way to edit notes in a popup instead of opening a new tab. It also integrates well with&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>.</li></ul></li><li>v0.96.0:<ul><li><a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;gain premium features thanks to a collaboration with the CKEditor team:<ul><li><a class=\"reference-link\" href=\"#root/_help_ZlN4nump6EbW\">Slash Commands</a></li><li><a class=\"reference-link\" href=\"#root/_help_pwc194wlRzcH\">Text Snippets</a></li></ul></li></ul></li><li>v0.95.0:<ul><li>A more friendly theme was introduced for&nbsp;<a class=\"reference-link\" href=\"#root/_help_R9pX4DGra2Vt\">Sharing</a>, with search, expandable tree, night mode and more.</li></ul></li><li>v0.94.0:<ul><li>Added integration with&nbsp;<a class=\"reference-link\" href=\"#root/_help_GBBMSlVSOIGP\">AI</a>&nbsp;(using self-hosted LLMs such as Ollama or industry standards such as ChatGPT).</li></ul></li><li>v0.92.5:<ul><li>Windows binaries are now signed.</li><li><a class=\"reference-link\" href=\"#root/_help_7DAiwaf8Z7Rz\">Multi-factor authentication with TOTP</a>&nbsp;was introduced.</li></ul></li><li>v0.92.4:<ul><li>macOS binaries are now signed.</li><li><a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes can now have adjustable&nbsp;<a class=\"reference-link\" href=\"#root/_help_veGu4faJErEM\">Content language &amp; Right-to-left support</a>.</li><li><a class=\"reference-link\" href=\"#root/_help_NRnIZmSMc5sj\">Printing &amp; Exporting as PDF</a></li><li><a class=\"reference-link\" href=\"#root/_help_rC3pL2aptaRE\">Zen mode</a></li><li><a class=\"reference-link\" href=\"#root/_help_xWbu3jpNWapp\">Calendar</a>, allowing notes to be displayed in a monthly grid based on start and end dates.</li></ul></li><li>v0.91.5:<ul><li>Significant improvements for mobile.</li><li><a class=\"reference-link\" href=\"#root/_help_AgjCISero73a\">Footnotes</a>&nbsp;are now supported in&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes.</li><li>Mermaid diagrams can now be inserted inline within&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes.</li><li>The TriliumNext theme is introduced, bringing a more modern design to the application.</li><li><a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map</a>, displaying notes as markers on a geographical map for easy trip planning.</li></ul></li><li>v0.90.8:<ul><li>A new note type was introduced:&nbsp;<a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a></li></ul></li></ul>",
- "_help_poXkQfguuA0U": "<p>To install Trilium on your desktop, follow these steps:</p><ol><li><strong>Download the Latest Release</strong>: Obtain the appropriate binary release for your operating system from the <a href=\"https://github.com/TriliumNext/Trilium/releases/latest\">latest release page</a> on GitHub.</li><li><strong>Extract the Package</strong>: Unzip the downloaded package to a location of your choice.</li><li><strong>Run the Application</strong>: Launch Trilium by executing the <code spellcheck=\"false\">trilium</code> executable found within the unzipped folder.</li></ol><h2>Startup Scripts</h2><p>Trilium offers various startup scripts to customize your experience:</p><ul><li><code spellcheck=\"false\">trilium-no-cert-check</code>: Starts Trilium without validating <a href=\"#root/_help_l2VkvOwUNfZj\">TLS certificates</a>, useful if connecting to a server with a self-signed certificate.<ul><li>Alternatively, set the <code spellcheck=\"false\">NODE_TLS_REJECT_UNAUTHORIZED=0</code> environment variable before starting Trilium.</li></ul></li><li><code spellcheck=\"false\">trilium-portable</code>: Launches Trilium in portable mode, where the <a href=\"#root/_help_tAassRL4RSQL\">data directory</a> is created within the application's directory, making it easy to move the entire setup. Electron's internal data (caches, dictionaries, etc.) is also stored within the data directory, so no files are written to the system's roaming profile.</li><li><code spellcheck=\"false\">trilium-safe-mode</code>: Boots Trilium in \"safe mode,\" disabling any startup scripts that might cause the application to crash.</li></ul><h2>Synchronization</h2><p>For Trilium desktop users who wish to synchronize their data with a server instance, refer to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_cbkrhQjrkKrh\">Synchronization</a>&nbsp;guide for detailed instructions.</p>",
- "_help_nRqcgfTb97uV": "<p>Sometimes, setting up a <a href=\"#root/_help_WOcw2SLH6tbX\">dedicated server installation</a> is not feasible. The desktop application ships with a fully functional server instance by default.</p><p>For security reasons, this feature is <strong>not enabled</strong> by default. To enable it, enable <em>Network access</em> in&nbsp;<a class=\"reference-link\" href=\"#root/_help_fiHicjpHjIRJ\">Security</a>.</p><p>After enabling network access and restarting the application, you can access this web interface locally by navigating to <a href=\"http://localhost:37840/login\">http://localhost:37840/login</a>.</p><aside class=\"admonition note\"><p>The server embedded in the desktop application will only run as long as the desktop application itself is running. So closing the application will also close the server. To overcome this, you can try hiding the application in the system tray.</p></aside><h2>Mobile interface</h2><p>By default, this will display the desktop user interface, even on mobile. To switch to the mobile version, simply go to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;and select “Switch to the mobile version”.</p><h2>Allowing the port externally on Windows with Windows Defender Firewall</h2><p>First, find out the IP of your desktop server by running <code spellcheck=\"false\">ipconfig</code> in your local terminal. Then try accessing <code spellcheck=\"false\">http://&lt;ip&gt;:37840/login</code> on another device. If it doesn't work, then most likely the port is blocked by your operating system's firewall.</p><p>If you use Windows Defender Firewall:</p><ol><li>Go to Windows's start menu and look for “Windows Defender Firewall with Advanced Security”.</li><li>Go to “Inbound Rules” on the left tree, and select “New Rule” in the “Actions” sidebar on the right.</li><li>Select “Port” and press “Next”.</li><li>Type in <code spellcheck=\"false\">37840</code> in the “Specific local ports” section and then press “Next”.</li><li>Leave “Allow the connection” checked and press “Next”.</li><li>Configure the networks to apply to (check all if unsure) and then press “Next”.</li><li>Add an appropriate name to the rule (e.g. “Trilium Notes”) and press “Finish”.</li></ol><aside class=\"admonition warning\"><p>Since v0.104.0, the port used by Trilium is accessible only on <code spellcheck=\"false\">localhost</code>. To enable across the local network, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_swSFivWk6KkA\">Network Access</a>.</p></aside>",
- "_help_Rp0q8bSP6Ayl": "<p>The desktop version of Trilium supports all three main operating systems:</p><ul><li>Windows<ul><li>Windows 11 is officially supported.</li><li>Windows on ARM is also supported</li></ul></li><li>Linux:<ul><li>Most modern distributions are supported, including NixOS.</li><li>ARM is supported in <code spellcheck=\"false\">aarch64</code> (no ARM v7 support).</li></ul></li><li>macOS<ul><li>Minimum supported operating system: macOS Monterey</li><li>Both Intel and Apple Silicon devices are supported.</li></ul></li></ul>",
- "_help_Un4wj2Mak2Ky": "<p>Since TriliumNext 0.94.1, the desktop and server applications can be built using <a href=\"https://nixos.org/\">Nix</a>.</p><h2>System requirements</h2><p>Installation of Nix on Mac or Linux (<a href=\"https://nixos.org/download/\">download page</a>). About 3-4 gigabytes of additional storage space, for build artifacts.</p><h2>Run directly</h2><p>Using <a href=\"https://nix.dev/manual/nix/stable/command-ref/new-cli/nix3-run.html\">nix run</a>, the desktop app can be started as: <code spellcheck=\"false\">nix run github:TriliumNext/Trilium/v0.95.0</code></p><p>Running the server requires explicitly specifying the desired package: <code spellcheck=\"false\">nix run github:TriliumNext/Trilium/v0.95.0#server</code></p><p>Instead of a version (<code spellcheck=\"false\">v0.95.0</code> above), you can also specify a commit hash (or a branch name). This makes it easy to test development builds.</p><h2>Install on NixOS</h2><p>Add to your <code spellcheck=\"false\">flake.nix</code>:</p><pre><code class=\"language-text-x-trilium-auto\">{\n inputs = {\n nixpkgs.url = # ...;\n trilium-notes = {\n url = \"github:TriliumNext/Trilium/v0.95.0\";\n inputs.nixpkgs.follows = \"nixpkgs\";\n };\n };\n\n outputs =\n {\n self,\n # ...\n trilium-notes,\n ...\n }:\n {\n nixosConfigurations = {\n \"nixos\" = nixpkgs.lib.nixosSystem {\n system = \"x86_64-linux\";\n modules = [\n ./configuration.nix\n ];\n specialArgs = {\n inherit\n trilium-notes\n ;\n };\n };\n };\n };\n}\n</code></pre><p>Add to your <code spellcheck=\"false\">configuration.nix</code>:</p><pre><code class=\"language-text-x-trilium-auto\">{\n # ...\n trilium-notes,\n ...\n}:\n\n{\n # ...\n\n services.trilium-server.package = trilium-notes.packages.x86_64-linux.server;\n\n environment.systemPackages = [\n trilium-notes.packages.x86_64-linux.desktop\n ];\n}</code></pre><p>The flake aims to be compatible with the latest NixOS stable and unstable.</p>",
- "_help_swSFivWk6KkA": "<p>Prior to v0.104.0, the <a href=\"#root/_help_poXkQfguuA0U\">desktop application</a> would also open a network port so that it can offer access to&nbsp;<a class=\"reference-link\" href=\"#root/_help_pgxEVkzLl1OP\">ETAPI (REST API)</a>&nbsp;or even use it as a web server (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRqcgfTb97uV\">Using the desktop application as a server</a>).</p><p>In order to reduce the attack surface, Trilium now enables these services only for the local device (e.g. <code spellcheck=\"false\">localhost</code>) instead of serving them over the LAN.</p><p>To better understand what is affected, refer to the following table:</p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Feature</th>\n<th>Network access OFF</th>\n<th>Network access ON</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><a class=\"reference-link\" href=\"#root/_help_MtPxeAWVAzMg\">Web Clipper</a></td>\n<td>🔒️ <code spellcheck=\"false\">localhost</code> only (still accessible to the browser extension on the same device)</td>\n<td>🌐 <code spellcheck=\"false\">localhost</code> + LAN</td>\n</tr>\n<tr>\n<td><a class=\"reference-link\" href=\"#root/_help_pgxEVkzLl1OP\">ETAPI (REST API)</a></td>\n<td>🔒️ <code spellcheck=\"false\">localhost</code> only</td>\n<td>🌐 <code spellcheck=\"false\">localhost</code> + LAN</td>\n</tr>\n<tr>\n<td><a href=\"#root/_help_GBBMSlVSOIGP\">LLM MCP</a> (only if enabled in settings)</td>\n<td>🔒️ <code spellcheck=\"false\">localhost</code> only (needs auth)</td>\n<td>🌐 <code spellcheck=\"false\">localhost</code> + LAN (needs auth)</td>\n</tr>\n<tr>\n<td><a href=\"#root/_help_nRqcgfTb97uV\">Web app</a></td>\n<td>❌️ completely disabled (403), only the desktop app is usable.</td>\n<td>🌐 <code spellcheck=\"false\">localhost</code> + LAN</td>\n</tr>\n<tr>\n<td><a class=\"reference-link\" href=\"#root/_help_R9pX4DGra2Vt\">Sharing</a>&nbsp;notes</td>\n<td>❌️ completely disabled (403), if you are using&nbsp;<a class=\"reference-link\" href=\"#root/_help_cbkrhQjrkKrh\">Synchronization</a>&nbsp;this will still work as part of the <a href=\"#root/_help_WOcw2SLH6tbX\">server</a>.</td>\n<td>🌐 <code spellcheck=\"false\">localhost</code> + LAN</td>\n</tr>\n</tbody></table></figure>",
- "_help_7iwde4lsKc6O": "<aside class=\"admonition note\"><p>Automatic startup and better integration with the system tray was introduced in v0.104.0. Versions prior to that only have the system tray option which could be found in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Others</em>.</p></aside><h2>Tray icon</h2><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:332/71;\" src=\"{{helpAssets}}/User%20Guide/Installation%20%26%20Setup/Desktop%20Installation/Tray%20icon%20%26%20automatic%20startup_image.png\" width=\"332\" height=\"71\"></figure><p>The desktop application has native integration with the system tray on all operating systems.</p><p>The tray icon is enabled by default, but it can be toggled from&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Desktop</em>.</p><p>The tray icon has the following functionality:</p><ul><li>When clicked, the last window is hidden (minimized to the tray icon). Clicking it again will reveal that window.</li><li>Right clicking reveals the following options:<ul><li>Each window can be individually shown or hidden, identified by their active note.</li><li>New windows can be opened.</li><li>A new note can be created directly, which will be created in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_S0Fos78ZfcY7\">Note Inbox</a>&nbsp;(or&nbsp;<a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a>&nbsp;if an inbox is not available).</li><li>Today's day note can be opened.</li><li>Bookmarks and recent notes are displayed in a sub-menu and clicking them navigates to that note.</li><li>Quitting the application.</li></ul></li></ul><h3>Closing to system tray</h3><p>This is an option which is not enabled by default and it allows a specific behavior: instead of exiting the application when the last window has been closed, the last window is instead hidden with the tray icon remaining available.</p><p>This option requires the tray icon to be enabled, otherwise it has no effect.</p><h2>Automatic startup</h2><p>Two options control the automatic startup functionality in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Startup</em>:</p><ul><li>When <em>Launch on startup</em> is enabled, the application will automatically start up when logging into the current user.<ul><li>Note that on Linux support depends on the desktop environment. Feel free to <a href=\"#root/_help_wy8So3yZZlH9\">report</a> any issues.</li></ul></li><li>If <em>Start minimized to tray</em> is also enabled, the application will start up in the background and can be revealed from the tray icon.<ul><li>This only applies if <em>Launch on startup</em> is enabled, manual starts are not impacted by this option.</li></ul></li></ul>",
- "_help_hvRfsDr591WP": "<h2>Trilium only shows a blank window</h2><p>Trilium uses Electron which is based on Chromium (the open-source alternative to Google Chrome); in order to improve performance it makes use of <em>GPU acceleration</em>. In some cases, a GPU incompatibility (especially on older models of integrated graphics) can cause nothing to render at all, resulting in a blank window.&nbsp;</p><p>To bypass this, try running Trilium with the following command line argument:</p><pre><code class=\"language-text-x-trilium-auto\">trilium --disable-gpu</code></pre><p>If that doesn't work, try the following commands as well:</p><ul><li><code spellcheck=\"false\">trilium --disable-gpu-compositing</code></li><li><code spellcheck=\"false\">ELECTRON_OZONE_PLATFORM_HINT=x11 trilium</code> (this one forces the rendering to X11 on Wayland)</li></ul><p>If Trilium renders fine after this, Trilium offers a built-in option to disable GPU acceleration: go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Appearance</em>, look for the <em>Performance</em> section and then uncheck <em>Hardware acceleration (GPU)</em>.</p>",
- "_help_WOcw2SLH6tbX": "<p>This guide outlines the steps to install Trilium on your own server. You might consider this option if you want to set up <a href=\"#root/_help_cbkrhQjrkKrh\">synchronization</a> or use Trilium in a browser - accessible from anywhere.</p><h2>Installation Options</h2><p>There are several ways to install Trilium on a server, each with its own advantages:</p><ul><li><strong>Recommended</strong>: <a href=\"#root/_help_rWX5eY045zbE\">Docker Installation</a> - Available for <strong>AMD64</strong> and <strong>ARM</strong> architectures.</li><li><a href=\"#root/_help_3tW6mORuTHnB\">Packaged Server Installation</a></li><li><a href=\"https://www.pikapods.com/pods?run=trilium-next\">PikaPods managed hosting</a></li><li><a href=\"#root/_help_J1Bb6lVlwU5T\">Manual Installation</a></li><li><a href=\"#root/_help_DCmT6e7clMoP\">Kubernetes</a></li><li><a href=\"https://www.cloudron.io/store/com.github.trilium.cloudronapp.html\">Cloudron</a></li><li><a href=\"https://homelabos.com/docs/software/trilium/\">HomelabOS</a></li><li><a href=\"#root/_help_moVgBcoxE3EK\">NixOS Module</a></li></ul><p>The server installation includes both web and <a href=\"#root/_help_RDslemsQ6gCp\">mobile frontends</a>.</p><h2>Configuration</h2><p>After setting up your server installation, you may want to configure settings such as the port or enable <a href=\"#root/_help_l2VkvOwUNfZj\">TLS</a>. Configuration is managed via the Trilium <code spellcheck=\"false\">config.ini</code> file, which is located in the <a href=\"#root/_help_tAassRL4RSQL\">data directory</a> by default. To begin customizing your setup, copy the provided <code spellcheck=\"false\">config-sample.ini</code> file with default values to <code spellcheck=\"false\">config.ini</code>.</p><p>You can also review the <a href=\"#root/_help_Gzjqa934BdH4\">configuration</a> file to provide all <code spellcheck=\"false\">config.ini</code> values as environment variables instead.</p><h3>Config Location</h3><p>By default, <code spellcheck=\"false\">config.ini</code>, the <a href=\"#root/_help_wX4HbRucYSDD\">database</a>, and other important Trilium data files are stored in the <a href=\"#root/_help_tAassRL4RSQL\">data directory</a>. If you prefer a different location, you can change it by setting the <code spellcheck=\"false\">TRILIUM_DATA_DIR</code> environment variable:</p><pre><code class=\"language-text-x-trilium-auto\">export TRILIUM_DATA_DIR=/home/myuser/data/my-trilium-data</code></pre><h3>Disabling Authentication</h3><p>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_0hzsNCP31IAB\">Authentication</a>.</p><h2>Reverse Proxy Setup</h2><p>To configure a reverse proxy for Trilium, you can use either <strong>nginx</strong> or <strong>Apache</strong>. You can also check out the documentation stored in the Reverse proxy folder.</p><h3>nginx</h3><p>Add the following configuration to your <code spellcheck=\"false\">nginx</code> setup to proxy requests to Trilium:</p><pre><code class=\"language-text-x-trilium-auto\">location /trilium/ {\n proxy_pass http://127.0.0.1:8080/;\n proxy_http_version 1.1;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection 'upgrade';\n proxy_set_header Host $host;\n proxy_cache_bypass $http_upgrade;\n}</code></pre><p>To avoid limiting the size of payloads, include this in the <code spellcheck=\"false\">server {}</code> block:</p><pre><code class=\"language-text-x-trilium-auto\"># Set to 0 for unlimited. Default is 1M.\nclient_max_body_size 0;</code></pre><h3>Apache</h3><p>For an Apache setup, refer to the <a href=\"#root/_help_fDLvzOx29Pfg\">Apache proxy setup</a> guide.</p>",
- "_help_3tW6mORuTHnB": "<p>This is essentially Trilium sources + node modules + node.js runtime packaged into one 7z file.</p><h2>Steps</h2><ul><li>SSH into your server</li><li>use <code spellcheck=\"false\">wget</code> (or <code spellcheck=\"false\">curl</code>) to download latest <code spellcheck=\"false\">TriliumNotes-Server-[VERSION]-linux-x64.tar.xz</code> (copy link from <a href=\"https://github.com/TriliumNext/Trilium/releases\">release page</a>, notice <code spellcheck=\"false\">-Server</code> suffix) on your server.</li><li>unpack the archive, e.g. using <code spellcheck=\"false\">tar -xf -d TriliumNotes-Server-[VERSION]-linux-x64.tar.xz</code></li><li><code spellcheck=\"false\">cd trilium-linux-x64-server</code></li><li><code spellcheck=\"false\">./trilium.sh</code></li><li>you can open the browser and open http://[your-server-hostname]:8080 and you should see Trilium initialization page</li></ul><p>The problem with above steps is that once you close the SSH connection, the Trilium process is terminated. To avoid that, you have two options:</p><ul><li>Kill it (with e.g. <kbd>Ctrl</kbd> + <kbd>C</kbd>) and run again like this: <code spellcheck=\"false\">nohup ./trilium.sh &amp;</code>. (nohup keeps the process running in the background, <code spellcheck=\"false\">&amp;</code> runs it in the background)</li><li>Configure systemd to automatically run Trilium in the background on every boot</li></ul><h2>Configure Trilium to auto-run on boot with systemd</h2><ul><li>After downloading, extract and move Trilium:</li></ul><pre><code class=\"language-text-x-trilium-auto\">tar -xvf TriliumNotes-Server-[VERSION]-linux-x64.tar.xz\nsudo mv trilium-linux-x64-server /opt/trilium</code></pre><ul><li>Create the service:</li></ul><pre><code class=\"language-text-x-trilium-auto\">sudo nano /etc/systemd/system/trilium.service</code></pre><ul><li>Paste this into the file (replace the user and group as needed):</li></ul><pre><code class=\"language-text-x-trilium-auto\">[Unit]\nDescription=Trilium Daemon\nAfter=syslog.target network.target\n\n[Service]\nUser=xxx\nGroup=xxx\nType=simple\nExecStart=/opt/trilium/trilium.sh\nWorkingDirectory=/opt/trilium/\n\nTimeoutStopSec=20\n# KillMode=process leads to error, according to https://www.freedesktop.org/software/systemd/man/systemd.kill.html\nRestart=always\n\n[Install]\nWantedBy=multi-user.target</code></pre><ul><li>Save the file (CTRL-S) and exit (CTRL-X)</li><li>Enable and launch the service:</li></ul><pre><code class=\"language-text-x-trilium-auto\">sudo systemctl enable --now -q trilium</code></pre><ul><li>You can now open a browser to http://[your-server-hostname]:8080 and you should see the Trilium initialization page.</li></ul><h2>Simple Autoupdate for Server</h2><p>Run as the same User Trilium runs</p><p>if you run as root please remove 'sudo' from the commands</p><p>requires \"jq\" <code spellcheck=\"false\">apt install jq</code></p><p>It will stop the service above, overwrite everything (i expect no config.ini), and start service It also creates a version file in the Trilium directory so it updates only with a newer Version</p><pre><code class=\"language-text-x-trilium-auto\">#!/bin/bash\n\n# Configuration\nREPO=\"TriliumNext/Trilium\"\nPATTERN=\"TriliumNotes-Server-.*-linux-x64.tar.xz\"\nDOWNLOAD_DIR=\"/var/tmp/trilium_download\"\nOUTPUT_DIR=\"/opt/trilium\"\nSERVICE_NAME=\"trilium\"\nVERSION_FILE=\"$OUTPUT_DIR/version.txt\"\n\n# Ensure dependencies are installed\ncommand -v curl &gt;/dev/null 2&gt;&amp;1 || { echo \"Error: curl is required\"; exit 1; }\ncommand -v jq &gt;/dev/null 2&gt;&amp;1 || { echo \"Error: jq is required\"; exit 1; }\ncommand -v tar &gt;/dev/null 2&gt;&amp;1 || { echo \"Error: tar is required\"; exit 1; }\n\n# Create download directory\nmkdir -p \"$DOWNLOAD_DIR\" || { echo \"Error: Cannot create $DOWNLOAD_DIR\"; exit 1; }\n\n# Get the latest release version\nLATEST_VERSION=$(curl -sL https://api.github.com/repos/$REPO/releases/latest | jq -r '.tag_name')\nif [ -z \"$LATEST_VERSION\" ]; then\n echo \"Error: Could not fetch latest release version\"\n exit 1\nfi\n\n# Check current installed version (from version.txt or existing tarball)\nCURRENT_VERSION=\"\"\nif [ -f \"$VERSION_FILE\" ]; then\n CURRENT_VERSION=$(cat \"$VERSION_FILE\")\nelif [ -f \"$DOWNLOAD_DIR/TriliumNotes-Server-$LATEST_VERSION-linux-x64.tar.xz\" ]; then\n CURRENT_VERSION=\"$LATEST_VERSION\"\nfi\n\n# Compare versions\nif [ \"$CURRENT_VERSION\" = \"$LATEST_VERSION\" ]; then\n echo \"Latest version ($LATEST_VERSION) is already installed\"\n exit 0\nfi\n\n# Download the latest release\nLATEST_URL=$(curl -sL https://api.github.com/repos/$REPO/releases/latest | jq -r \".assets[] | select(.name | test(\\\"$PATTERN\\\")) | .browser_download_url\")\nif [ -z \"$LATEST_URL\" ]; then\n echo \"Error: No asset found matching pattern '$PATTERN'\"\n exit 1\nfi\n\nFILE_NAME=$(basename \"$LATEST_URL\")\nFILE_PATH=\"$DOWNLOAD_DIR/$FILE_NAME\"\n\n# Download if not already present\nif [ -f \"$FILE_PATH\" ]; then\n echo \"Latest release $FILE_NAME already downloaded\"\nelse\n curl -LO --output-dir \"$DOWNLOAD_DIR\" \"$LATEST_URL\" || { echo \"Error: Download failed\"; exit 1; }\n echo \"Downloaded $FILE_NAME to $DOWNLOAD_DIR\"\nfi\n\n# Extract the tarball\nEXTRACT_DIR=\"$DOWNLOAD_DIR/extracted\"\nmkdir -p \"$EXTRACT_DIR\"\ntar -xJf \"$FILE_PATH\" -C \"$EXTRACT_DIR\" || { echo \"Error: Extraction failed\"; exit 1; }\n\n# Find the extracted directory (e.g., TriliumNotes-Server-0.97.2-linux-x64)\nINNER_DIR=$(find \"$EXTRACT_DIR\" -maxdepth 1 -type d -name \"TriliumNotes-Server-*-linux-x64\" | head -n 1)\nif [ -z \"$INNER_DIR\" ]; then\n echo \"Error: Could not find extracted directory matching TriliumNotes-Server-*-linux-x64\"\n exit 1\nfi\n\n# Stop the trilium-server service\nif systemctl is-active --quiet \"$SERVICE_NAME\"; then\n echo \"Stopping $SERVICE_NAME service...\"\n sudo systemctl stop \"$SERVICE_NAME\" || { echo \"Error: Failed to stop $SERVICE_NAME\"; exit 1; }\nfi\n\n# Copy contents to /opt/trilium, overwriting existing files\necho \"Copying contents from $INNER_DIR to $OUTPUT_DIR...\"\nsudo mkdir -p \"$OUTPUT_DIR\"\nsudo cp -r \"$INNER_DIR\"/* \"$OUTPUT_DIR\"/ || { echo \"Error: Copy failed\"; exit 1; }\necho \"$LATEST_VERSION\" | sudo tee \"$VERSION_FILE\" &gt;/dev/null\necho \"Files copied to $OUTPUT_DIR\"\n\n# Start the trilium-server service\necho \"Starting $SERVICE_NAME service...\"\nsudo systemctl start \"$SERVICE_NAME\" || { echo \"Error: Failed to start $SERVICE_NAME\"; exit 1; }\n\n# Clean up\nrm -rf \"$EXTRACT_DIR\"\necho \"Cleanup complete. Trilium updated to $LATEST_VERSION.\"</code></pre><h2>Common issues</h2><h3>Outdated glibc</h3><pre><code class=\"language-text-x-trilium-auto\">Error: /usr/lib64/libstdc++.so.6: version `GLIBCXX_3.4.21' not found (required by /var/www/virtual/.../node_modules/@mlink/scrypt/build/Release/scrypt.node)\n at Object.Module._extensions..node (module.js:681:18)\n at Module.load (module.js:565:32)\n at tryModuleLoad (module.js:505:12)</code></pre><p>If you get an error like this, you need to either upgrade your glibc (typically by upgrading to up-to-date distribution version) or use some other <a href=\"#root/_help_WOcw2SLH6tbX\">server installation</a> method.</p><h2>TLS</h2><p>Don't forget to <a href=\"#root/_help_l2VkvOwUNfZj\">configure TLS</a>, which is required for secure usage!</p>",
- "_help_rWX5eY045zbE": "<p>Official docker images are published on docker hub for <strong>AMD64</strong>, <strong>ARMv7</strong> and <strong>ARM64/v8</strong>: <a href=\"https://hub.docker.com/r/triliumnext/trilium/\">https://hub.docker.com/r/triliumnext/trilium/</a></p><h2>Prerequisites</h2><p>Ensure Docker is installed on your system.</p><p>If you need help installing Docker, reference the <a href=\"https://docs.docker.com/engine/install/\">Docker Installation Docs</a></p><p><strong>Note:</strong> Trilium's Docker container requires root privileges to operate correctly.</p><aside class=\"admonition warning\"><p>If you're using a SMB/CIFS share or folder as your Trilium data directory, <a href=\"https://github.com/TriliumNext/Notes/issues/415#issuecomment-2344824400\">you'll need</a> to add the mount options of <code spellcheck=\"false\">nobrl</code> and <code spellcheck=\"false\">noperm</code> when mounting your SMB share.</p></aside><h2>Running with Docker Compose</h2><h3>Grab the latest docker-compose.yml:</h3><pre><code class=\"language-text-x-trilium-auto\">wget https://raw.githubusercontent.com/TriliumNext/Trilium/master/docker-compose.yml</code></pre><p>Optionally, edit the <code spellcheck=\"false\">docker-compose.yml</code> file to configure the container settings prior to starting it. Unless configured otherwise, the data directory will be <code spellcheck=\"false\">~/trilium-data</code> and the container will be accessible at port 8080.</p><h3>Start the container:</h3><p>Run the following command to start the container in the background:</p><pre><code class=\"language-text-x-trilium-auto\">docker compose up -d</code></pre><h2>Running without Docker Compose / Further Configuration</h2><h3>Pulling the Docker Image</h3><p>To pull the image, use the following command, replacing <code spellcheck=\"false\">[VERSION]</code> with the desired version or tag, such as <code spellcheck=\"false\">v0.91.6</code> or just <code spellcheck=\"false\">latest</code>. (See published tag names at <a href=\"https://hub.docker.com/r/triliumnext/trilium/tags\">https://hub.docker.com/r/triliumnext/trilium/tags</a>.):</p><pre><code class=\"language-text-x-trilium-auto\">docker pull triliumnext/trilium:v0.91.6</code></pre><p><strong>Warning:</strong> Avoid using the \"latest\" tag, as it may automatically upgrade your instance to a new minor version, potentially disrupting sync setups or causing other issues.</p><h3>Preparing the Data Directory</h3><p>Trilium requires a directory on the host system to store its data. This directory must be mounted into the Docker container with write permissions.</p><h3>Running the Docker Container</h3><h4>Local Access Only</h4><p>Run the container to make it accessible only from the localhost. This setup is suitable for testing or when using a proxy server like Nginx or Apache.</p><pre><code class=\"language-text-x-trilium-auto\">sudo docker run -t -i -p 127.0.0.1:8080:8080 -v ~/trilium-data:/home/node/trilium-data triliumnext/trilium:[VERSION]</code></pre><ol><li>Verify the container is running using <code spellcheck=\"false\">docker ps</code>.</li><li>Access Trilium via a web browser at <code spellcheck=\"false\">127.0.0.1:8080</code>.</li></ol><h4>Local Network Access</h4><p>To make the container accessible only on your local network, first create a new Docker network:</p><pre><code class=\"language-text-x-trilium-auto\">docker network create -d macvlan -o parent=eth0 --subnet 192.168.2.0/24 --gateway 192.168.2.254 --ip-range 192.168.2.252/27 mynet</code></pre><p>Then, run the container with the network settings:</p><pre><code class=\"language-text-x-trilium-auto\">docker run --net=mynet -d -p 127.0.0.1:8080:8080 -v ~/trilium-data:/home/node/trilium-data triliumnext/trilium:-latest</code></pre><p>To set a different user ID (UID) and group ID (GID) for the saved data, use the <code spellcheck=\"false\">USER_UID</code> and <code spellcheck=\"false\">USER_GID</code> environment variables:</p><pre><code class=\"language-text-x-trilium-auto\">docker run --net=mynet -d -p 127.0.0.1:8080:8080 -e \"USER_UID=1001\" -e \"USER_GID=1001\" -v ~/trilium-data:/home/node/trilium-data triliumnext/trilium:-latest</code></pre><p>Find the local IP address using <code spellcheck=\"false\">docker inspect [container_name]</code> and access the service from devices on the local network.</p><pre><code class=\"language-text-x-trilium-auto\">docker ps\ndocker inspect [container_name]</code></pre><h4>Global Access</h4><p>To allow access from any IP address, run the container as follows:</p><pre><code class=\"language-text-x-trilium-auto\">docker run -d -p 0.0.0.0:8080:8080 -v ~/trilium-data:/home/node/trilium-data triliumnext/trilium:[VERSION]</code></pre><p>Stop the container with <code spellcheck=\"false\">docker stop &lt;CONTAINER ID&gt;</code>, where the container ID is obtained from <code spellcheck=\"false\">docker ps</code>.</p><h3>Custom Data Directory</h3><p>For a custom data directory, use:</p><pre><code class=\"language-text-x-trilium-auto\">-v ~/YourOwnDirectory:/home/node/trilium-data triliumnext/trilium:[VERSION]</code></pre><p>If you want to run your instance in a non-default way, please use the volume switch as follows: <code spellcheck=\"false\">-v ~/YourOwnDirectory:/home/node/trilium-data triliumnext/trilium:&lt;VERSION&gt;</code>. It is important to be aware of how Docker works for volumes, with the first path being your own and the second the one to virtually bind to. <a href=\"https://docs.docker.com/storage/volumes/\">https://docs.docker.com/storage/volumes/</a> The path before the colon is the host directory, and the path after the colon is the container's path. More details can be found in the <a href=\"https://docs.docker.com/storage/volumes/\">Docker Volumes Documentation</a>.</p><h2>Reverse Proxy</h2><ol><li><a href=\"#root/_help_ud6MShXL4WpO\">Nginx</a></li><li><a href=\"#root/_help_fDLvzOx29Pfg\">Apache</a></li></ol><h3>Note on --user Directive</h3><p>The <code spellcheck=\"false\">--user</code> directive is unsupported. Instead, use the <code spellcheck=\"false\">USER_UID</code> and <code spellcheck=\"false\">USER_GID</code> environment variables to set the appropriate user and group IDs.</p><h3>Note on timezones</h3><p>If you are having timezone issues and you are not using docker-compose, you may need to add a <code spellcheck=\"false\">TZ</code> environment variable with the <a href=\"https://en.wikipedia.org/wiki/List_of_tz_database_time_zones\">TZ identifier</a> of your local timezone.</p><h2>Rootless Docker Image</h2><aside class=\"admonition note\"><p>Please keep in mind that the data directory is at <code spellcheck=\"false\">/home/trilium/trilium-data</code> instead of the typical <code spellcheck=\"false\">/home/node/trilium-data</code>. This is because a new user is created and used to run Trilium within the rootless containers.</p></aside><p>If you would prefer to run Trilium without having to run the Docker container as <code spellcheck=\"false\">root</code>, you can use either of the provided Debian (default) and Alpine-based images with the <code spellcheck=\"false\">rootless</code> tag.&nbsp;</p><p><em><strong>If you're unsure, stick to the “rootful” Docker image referenced above.</strong></em></p><p>Below are some commands to pull the rootless images:</p><pre><code class=\"language-text-x-trilium-auto\"># For Debian-based image\ndocker pull triliumnext/trilium:rootless\n\n# For Alpine-based image\ndocker pull triliumnext/trilium:rootless-alpine</code></pre><h3>Why Rootless?</h3><p>Running containers as non-root is a security best practice that reduces the potential impact of container breakouts. If an attacker manages to escape the container, they'll only have the permissions of the non-root user instead of full root access to the host.</p><h3>How It Works</h3><p>The rootless Trilium image:</p><ol><li>Creates a non-root user (<code spellcheck=\"false\">trilium</code>) during build time</li><li>Configures the application to run as this non-root user</li><li>Allows runtime customization of the user's UID/GID via Docker's <code spellcheck=\"false\">--user</code> flag</li><li>Does not require a separate Docker <code spellcheck=\"false\">entrypoint</code> script</li></ol><h3>Usage</h3><h4><strong>Using docker-compose (Recommended)</strong></h4><pre><code class=\"language-text-x-trilium-auto\"># Run with default UID/GID (1000:1000)\ndocker-compose -f docker-compose.rootless.yml up -d\n\n# Run with custom UID/GID (e.g., match your host user)\nTRILIUM_UID=$(id -u) TRILIUM_GID=$(id -g) docker-compose -f docker-compose.rootless.yml up -d\n\n# Specify a custom data directory\nTRILIUM_DATA_DIR=/path/to/your/data TRILIUM_UID=$(id -u) TRILIUM_GID=$(id -g) docker-compose -f docker-compose.rootless.yml up -d\n</code></pre><h4><strong>Using Docker CLI</strong></h4><pre><code class=\"language-text-x-trilium-auto\"># Build the image\ndocker build -t triliumnext/trilium:rootless -f apps/server/Dockerfile.rootless .\n\n# Run with default UID/GID (1000:1000)\ndocker run -d --name trilium -p 8080:8080 -v ~/trilium-data:/home/trilium/trilium-data triliumnext/trilium:rootless\n\n# Run with custom UID/GID\ndocker run -d --name trilium -p 8080:8080 --user $(id -u):$(id -g) -v ~/trilium-data:/home/trilium/trilium-data triliumnext/trilium:rootless\n</code></pre><h3>Environment Variables</h3><ul><li><code spellcheck=\"false\">TRILIUM_UID</code>: UID to use for the container process (passed to Docker's <code spellcheck=\"false\">--user</code> flag)</li><li><code spellcheck=\"false\">TRILIUM_GID</code>: GID to use for the container process (passed to Docker's <code spellcheck=\"false\">--user</code> flag)</li><li><code spellcheck=\"false\">TRILIUM_DATA_DIR</code>: Path to the data directory inside the container (default: <code spellcheck=\"false\">/home/node/trilium-data</code>)</li></ul><p>For a complete list of configuration environment variables (network settings, authentication, sync, etc.), see&nbsp;<a class=\"reference-link\" href=\"#root/_help_Gzjqa934BdH4\">Configuration (config.ini or environment variables)</a>.</p><h3>Volume Permissions</h3><p>If you encounter permission issues with the data volume, ensure that:</p><ol><li>The host directory has appropriate permissions for the UID/GID you're using</li><li>You're setting both <code spellcheck=\"false\">TRILIUM_UID</code> and <code spellcheck=\"false\">TRILIUM_GID</code> to match the owner of the host directory</li></ol><pre><code class=\"language-text-x-trilium-auto\"># For example, if your data directory is owned by UID 1001 and GID 1001:\nTRILIUM_UID=1001 TRILIUM_GID=1001 docker-compose -f docker-compose.rootless.yml up -d\n</code></pre><h3>Considerations</h3><ul><li>The container starts with a specific UID/GID which can be customized at runtime</li><li>Unlike the traditional setup, this approach does not use a separate entrypoint script with <code spellcheck=\"false\">usermod</code>/<code spellcheck=\"false\">groupmod</code> commands</li><li>The container cannot modify its own UID/GID at runtime, which is a security feature of rootless containers</li></ul><h3>Available Rootless Images</h3><p>Two rootless variants are provided:</p><ol><li><strong>Debian-based</strong> (default): Uses the Debian Bullseye Slim base image<ul><li>Dockerfile: <code spellcheck=\"false\">apps/server/Dockerfile.rootless</code></li><li>Recommended for most users</li></ul></li><li><strong>Alpine-based</strong>: Uses the Alpine base image for smaller size<ul><li>Dockerfile: <code spellcheck=\"false\">apps/server/Dockerfile.alpine.rootless</code></li><li>Smaller image size, but may have compatibility issues with some systems</li></ul></li></ol><h3>Building Custom Rootless Images</h3><p>If you would prefer, you can also customize the UID/GID at build time:</p><pre><code class=\"language-text-x-trilium-auto\"># For Debian-based image with custom UID/GID\ndocker build --build-arg USER=myuser --build-arg UID=1001 --build-arg GID=1001 \\\n -t triliumnext/trilium:rootless-custom -f apps/server/Dockerfile.rootless .\n\n# For Alpine-based image with custom UID/GID\ndocker build --build-arg USER=myuser --build-arg UID=1001 --build-arg GID=1001 \\\n -t triliumnext/trilium:alpine-rootless-custom -f apps/server/Dockerfile.alpine.rootless .\n</code></pre><p>Available build arguments:</p><ul><li><code spellcheck=\"false\">USER</code>: Username for the non-root user (default: trilium)</li><li><code spellcheck=\"false\">UID</code>: User ID for the non-root user (default: 1000)</li><li><code spellcheck=\"false\">GID</code>: Group ID for the non-root user (default: 1000)</li></ul>",
- "_help_moVgBcoxE3EK": "<p>This page describes configuring the Trilium module included in NixOS.</p><h2>Requirements</h2><p><a href=\"https://nixos.org/\">NixOS</a> installation.</p><h2>Configuration</h2><p>Add this to your <code spellcheck=\"false\">configuration.nix</code>:</p><pre><code class=\"language-text-x-trilium-auto\">services.trilium-server.enable = true;\n\n# default data directory: /var/lib/trilium\n#services.trilium-server.dataDir = \"/var/lib/trilium-sync-server\";\n\n# default bind address: 127.0.0.1, port 8080\n#services.trilium-server.host = \"0.0.0.0\";\n#services.trilium-server.port = 12783;</code></pre><p>Uncomment any option you would like to change.</p><p>See the <a href=\"https://search.nixos.org/options?channel=unstable&amp;from=0&amp;size=50&amp;sort=relevance&amp;type=packages&amp;query=trilium-server\">NixOS options list</a> for more options (including nginx reverse proxy configuration).</p>",
- "_help_J1Bb6lVlwU5T": "<aside class=\"admonition warning\"><p>This page describes manually installing Trilium on your server. <strong>Note that this is a not well supported way to install Trilium, problems may appear, information laid out here is quite out of date. It is recommended to use either</strong>&nbsp;<a class=\"reference-link\" href=\"#root/_help_rWX5eY045zbE\">Docker Server Installation</a>&nbsp;<strong>or</strong>&nbsp;<a class=\"reference-link\" href=\"#root/_help_3tW6mORuTHnB\">Packaged server installation</a><strong>.</strong></p></aside><h2>Requirements</h2><p>Trilium is a node.js application. Supported (tested) version of node.js is latest 14.X.X and 16.X.X. Trilium might work with older versions as well.</p><p>You can check your node version with this command (node.js needs to be installed):</p><pre><code class=\"language-text-x-trilium-auto\">node --version</code></pre><p>If your Linux distribution has only an outdated version of node.js, you can take a look at the installation instruction on node.js website, which covers most popular distributions.</p><h3>Dependencies</h3><p>There are some dependencies required. You can see command for Debian and its derivatives (like Ubuntu) below:</p><pre><code class=\"language-text-x-trilium-auto\">sudo apt install libpng16-16 libpng-dev pkg-config autoconf libtool build-essential nasm libx11-dev libxkbfile-dev</code></pre><h2>Installation</h2><h3>Download</h3><p>You can either download source code zip/tar from <a href=\"https://github.com/TriliumNext/Trilium/releases/latest\">https://github.com/TriliumNext/Trilium/releases/latest</a>.</p><p>For the latest version including betas, clone Git repository <strong>from</strong> <code spellcheck=\"false\">main</code> <strong>branch</strong> with:</p><pre><code class=\"language-text-x-trilium-auto\">git clone -b main https://github.com/triliumnext/trilium.git</code></pre><h2>Installation</h2><pre><code class=\"language-text-x-trilium-auto\">cd trilium\n\n# download all node dependencies\nnpm install\n\n# make sure the better-sqlite3 binary is there\nnpm rebuild\n\n# bundles &amp; minifies frontend JavaScript\nnpm run webpack</code></pre><h2>Run</h2><pre><code class=\"language-text-x-trilium-auto\">cd trilium\n\n# using nohup to make sure trilium keeps running after user logs out\nnohup TRILIUM_ENV=dev node src/www &amp;</code></pre><p>The application by default starts up on port 8080, so you can open your browser and navigate to <a href=\"http://localhost:8080\">http://localhost:8080</a> to access Trilium (replace \"localhost\" with your hostname).</p><h2>TLS</h2><p>Don't forget to <a href=\"#root/_help_l2VkvOwUNfZj\">configure TLS</a> which is required for secure usage!</p>",
- "_help_DCmT6e7clMoP": "<p>As Trilium can be run in Docker it also can be deployed in Kubernetes. You can either use our Helm chart, a community Helm chart, or roll your own Kubernetes deployment.</p><p>The recommended way is to use a Helm chart.</p><h2>Root privileges</h2><aside class=\"admonition note\"><p>The Trilium container at this time needs to be run with root privileges. It will swap to UID and GID <code spellcheck=\"false\">1000:1000</code> to run the <code spellcheck=\"false\">node</code> process after execution though, so the main process doesn't run with root privileges.</p></aside><p>The Trilium docker container needs to be run with root privileges. The node process inside the container will be started with reduced privileges (uid:gid 1000:1000) after some initialization logic. Please make sure that you don't use a security context (PodSecurityContext) which changes the user ID. To use a different uid:gid for file storage and the application, please use the <code spellcheck=\"false\">USER_UID</code> &amp; <code spellcheck=\"false\">USER_GID</code> environment variables.</p><p>The docker image will also fix the permissions of <code spellcheck=\"false\">/home/node</code> so you don't have to use an init container.</p><h2>Helm Charts</h2><p><a href=\"https://github.com/TriliumNext/helm-charts\">Official Helm chart</a> from TriliumNext Unofficial helm chart by <a href=\"https://github.com/ohdearaugustin\">ohdearaugustin</a>: <a href=\"https://github.com/ohdearaugustin/charts\">https://github.com/ohdearaugustin/charts</a></p><h2>Adding a Helm repository</h2><p>Below is an example of how</p><pre><code class=\"language-text-x-trilium-auto\">helm repo add trilium https://triliumnext.github.io/helm-charts\n\"trilium\" has been added to your repositories</code></pre><h2>How to install a chart</h2><p>After reviewing the <a href=\"https://github.com/TriliumNext/helm-charts/blob/main/charts/trilium/values.yaml\"><code spellcheck=\"false\">values.yaml</code></a> from the Helm chart, modifying as required and then creating your own:</p><pre><code class=\"language-text-x-trilium-auto\">helm install --create-namespace --namespace trilium trilium trilium/trilium -f values.yaml</code></pre><p>For more information on using Helm, please refer to the Helm documentation, or create a Discussion in the TriliumNext GitHub Organization.</p>",
- "_help_klCWNks3ReaQ": "<p>Trilium does not support multiple users. In order to have two or more persons with their own set of notes, multiple server instances must be set up. It is also not possible to use multiple <a href=\"#root/_help_cbkrhQjrkKrh\">sync</a> servers.</p><p>To allow multiple server instances on a single physical server:</p><ul><li><p>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_3tW6mORuTHnB\">Packaged version for Linux</a>&nbsp;or&nbsp;<a class=\"reference-link\" href=\"#root/_help_J1Bb6lVlwU5T\">Manually</a>, if starting the server manually just specify a different port and data directory per instance:</p><pre><code class=\"language-text-x-trilium-auto\">TRILIUM_NETWORK_PORT=8080 TRILIUM_DATA_DIR=/path/to/your/data-dir-A /opt/trilium/trilium.sh</code></pre><p>For a second instance:</p><pre><code class=\"language-text-x-trilium-auto\">TRILIUM_NETWORK_PORT=8081 TRILIUM_DATA_DIR=/path/to/your/data-dir-B /opt/trilium/trilium.sh</code></pre><p>If using <code spellcheck=\"false\">systemd</code>, then set the <a href=\"https://serverfault.com/questions/413397/how-to-set-environment-variable-in-systemd-service\">environment variables in the service configuration</a>.</p></li><li><p>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_rWX5eY045zbE\">Using Docker</a>, simply use two different containers, each with their own port binding and data directory.</p></li><li><p>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_moVgBcoxE3EK\">On NixOS</a>, the only possible way is to use Docker OCI containers or at least one NixOS container with its own service definition.</p></li></ul><p>For support or additional context, see the related <a href=\"https://github.com/orgs/TriliumNext/discussions/1642#discussioncomment-12768808\">GitHub Discussion</a>.</p>",
- "_help_vcjrb3VVYPZI": "<p>Trilium is typically exposed to the internet behind a <strong>reverse proxy</strong>, which handles TLS termination, presents a single public entry point, and (optionally) lets you host multiple instances under one domain. Trilium itself keeps running on plain HTTP on its local port; the proxy sits in front of it.</p><p>This section collects provider-specific guides and the configuration that applies regardless of which proxy you use.</p><h2>Provider guides</h2><ul><li><a class=\"reference-link\" href=\"#root/_help_ud6MShXL4WpO\">Nginx</a></li><li><a class=\"reference-link\" href=\"#root/_help_5ERVJb9s4FRD\">Traefik</a></li><li><a class=\"reference-link\" href=\"#root/_help_fDLvzOx29Pfg\">Apache using Docker</a></li></ul><h2>Applies to every proxy</h2><p>Regardless of the proxy you choose, make sure of the following:</p><ul><li><strong>Forward the WebSocket upgrade.</strong> Trilium uses a WebSocket for synchronization and live UI updates. Your proxy must pass the <code spellcheck=\"false\">Upgrade</code> and <code spellcheck=\"false\">Connection</code> headers through, otherwise the client will appear to load but never receive updates.</li><li><strong>Configure the trusted proxy.</strong> So that Trilium sees the real client IP (for rate limiting, logging, and secure cookies) rather than the proxy's address. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_LLzSMXACKhUs\">Trusted proxy</a>.</li><li><strong>Terminate TLS at the proxy.</strong> See&nbsp;<a class=\"reference-link\" href=\"#root/_help_l2VkvOwUNfZj\">HTTPS (TLS)</a>.</li></ul><h2>Putting an authentication proxy in front of Trilium</h2><p>Some setups place a <strong>forward-auth / SSO layer</strong> (Authelia, Authentik, oauth2-proxy, or an OIDC plugin) at the proxy so that <em>every</em> request must pass an interactive login first.</p><p>This <strong>breaks synchronization and initial setup.</strong> Sync is a machine-to-machine process that runs unattended in the background — it has no browser and cannot complete an interactive login challenge. When the proxy intercepts a sync request, it returns its HTML login page instead of the expected JSON, and the client fails with an error such as:</p><pre><code class=\"language-text-x-trilium-auto\">Sync failed: Request to GET https://trilium.example.com/api/setup/status failed,\nerror: Unexpected token '&lt;', \"&lt;!doctype \"... is not valid JSON\n</code></pre><p>There are two ways to resolve this:</p><ul><li><strong>Preferred, use Trilium's built-in authentication.</strong> Don't gate Trilium at the proxy at all. Trilium can authenticate the web interface itself, including via <a href=\"#root/_help_x1lQNKQBqLcA\">OpenID Connect</a>. This leaves the sync endpoints free to authenticate the way they're designed to.</li><li><strong>Exempt the sync endpoints from the proxy's authentication.</strong> If you must keep auth at the proxy, exclude these paths from the forward-auth check:<ul><li><code spellcheck=\"false\">/api/setup/*</code></li><li><code spellcheck=\"false\">/api/login/sync</code></li><li><code spellcheck=\"false\">/api/sync/*</code></li></ul></li></ul><aside class=\"admonition note\"><p>This is safe: Trilium authenticates these endpoints itself. Sync uses a challenge-free HMAC handshake based on a shared secret, and the one-time setup seed request is password-protected — so exempting them at the proxy does not expose unauthenticated access to your data.</p></aside><p>An example for Nginx, where <code spellcheck=\"false\">/auth</code> is your forward-auth endpoint:</p><pre><code class=\"language-text-x-trilium-auto\">server {\n # ... TLS, server_name, etc. ...\n\n # Sync and setup endpoints authenticate themselves — skip forward-auth.\n location ~ ^/api/(sync|login/sync|setup) {\n auth_request off;\n proxy_set_header Host $host;\n proxy_set_header X-Real-IP $remote_addr;\n proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\n proxy_set_header X-Forwarded-Proto $scheme;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection \"upgrade\";\n proxy_pass http://trilium;\n }\n\n # Everything else goes through forward-auth.\n location / {\n auth_request /auth;\n proxy_set_header Host $host;\n proxy_set_header X-Real-IP $remote_addr;\n proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\n proxy_set_header X-Forwarded-Proto $scheme;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection \"upgrade\";\n proxy_pass http://trilium;\n }\n}</code></pre>",
- "_help_ud6MShXL4WpO": "<p>Configure Nginx proxy and HTTPS. The operating system here is Ubuntu.</p><h2>Installing Nginx</h2><p>Download Nginx and remove Apache2</p><pre><code class=\"language-text-x-trilium-auto\">sudo apt-get install nginx\nsudo apt-get remove apache2</code></pre><h2>Build the configuration file</h2><ol><li><p>First, create the configuration file:</p><pre><code class=\"language-text-x-trilium-auto\">cd /etc/nginx/conf.d\nvim default.conf</code></pre></li><li><p>Fill the file with the context shown below, part of the setting show be changed. Then you can enjoy your web with HTTPS forced and proxy.</p><pre><code class=\"language-text-x-trilium-auto\"># This part configures, where your Trilium server is running\nupstream trilium {\n zone trilium 64k;\n server 127.0.0.1:8080; # change it to a different hostname and port if non-default is used\n keepalive 2;\n}\n\n# This part is for proxy and HTTPS configure\nserver {\n listen 443 ssl;\n server_name trilium.example.net; #change trilium.example.net to your domain without HTTPS or HTTP.\n ssl_certificate /etc/ssl/note/example.crt; #change /etc/ssl/note/example.crt to your path of crt file.\n ssl_certificate_key /etc/ssl/note/example.net.key; #change /etc/ssl/note/example.net.key to your path of key file.\n ssl_session_cache builtin:1000 shared:SSL:10m;\n ssl_protocols TLSv1 TLSv1.1 TLSv1.2;\n ssl_ciphers HIGH:!aNULL:!eNULL:!EXPORT:!CAMELLIA:!DES:!MD5:!PSK:!RC4;\n ssl_prefer_server_ciphers on;\n access_log /var/log/nginx/access.log; #check the path of access.log, if it doesn't fit your file, change it\n\n location / {\n proxy_set_header Host $host;\n proxy_set_header X-Real-IP $remote_addr;\n proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\n proxy_set_header X-Forwarded-Proto $scheme;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection \"upgrade\";\n proxy_pass http://trilium;\n proxy_read_timeout 90;\n }\n}\n\n# This part is for HTTPS forced\nserver {\n listen 80;\n server_name trilium.example.net; # change to your domain\n return 301 https://$server_name$request_uri;\n}</code></pre></li></ol><h2>Serving under a different path</h2><p>Alternatively if you want to serve the instance under a different path (useful e.g. if you want to serve multiple instances), update the location block like so:</p><ul><li>update the location with your desired path (make sure to not leave a trailing slash \"/\", if your <code spellcheck=\"false\">proxy_pass</code> does not end on a slash as well)</li><li>add the <code spellcheck=\"false\">proxy_cookie_path</code> directive with the same path: this allows you to stay logged in at multiple instances at the same time.</li></ul><pre><code class=\"language-text-x-trilium-auto\"> location /trilium/instance-one {\n rewrite /trilium/instance-one/(.*) /$1 break;\n proxy_set_header Host $host;\n proxy_set_header X-Real-IP $remote_addr;\n proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\n proxy_set_header X-Forwarded-Proto $scheme;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection \"upgrade\";\n proxy_pass http://trilium;\n proxy_cookie_path / /trilium/instance-one\n proxy_read_timeout 90;\n }</code></pre><h2>Configuring the trusted proxy</h2><p>After setting up a reverse proxy, make sure to configure the&nbsp;<a class=\"reference-link\" href=\"#root/_help_LLzSMXACKhUs\">Trusted proxy</a>.</p>",
- "_help_fDLvzOx29Pfg": "<p>This tutorial assumes that you have created a DNS A record for <code spellcheck=\"false\">trilium.yourdomain.com</code> that you want to use for your Trilium server.</p><h2>Docker setup</h2><p>Download docker image and create container</p><pre><code class=\"language-text-x-trilium-auto\"> docker pull triliumnext/trilium:[VERSION]\n docker create --name trilium -t -p 127.0.0.1:8080:8080 -v ~/trilium-data:/home/node/trilium-data triliumnext/trilium:[VERSION]</code></pre><h2>Configuring the Apache proxy</h2><ol><li><p>Enable apache proxy modules</p><pre><code class=\"language-text-x-trilium-auto\"> a2enmod ssl\n a2enmod proxy\n a2enmod proxy_http\n a2enmod proxy_wstunnel</code></pre></li><li><p>Create a new let's encrypt certificate</p><pre><code class=\"language-text-x-trilium-auto\"> sudo certbot certonly -d trilium.mydomain.com</code></pre><p>Choose standalone (2) and note the location of the created certificates (typically /etc/letsencrypt/live/...)</p></li><li><p>Create a new virtual host file for apache (you may want to use <code spellcheck=\"false\">apachectl -S</code> to determine the server root location, mine is /etc/apache2)</p><pre><code class=\"language-text-x-trilium-auto\"> sudo nano /etc/apache2/sites-available/trilium.yourdomain.com.conf</code></pre><p>Paste (and customize) the following text into the configuration file</p><pre><code class=\"language-text-x-trilium-auto\"> \n ServerName http://trilium.yourdomain.com\n RewriteEngine on\n RewriteRule ^ https://%{SERVER_NAME}%{REQUEST_URI} [END,QSA,R=permanent]\n \n \n ServerName https://trilium.yourdomain.com\n RewriteEngine On\n RewriteCond %{HTTP:Connection} Upgrade [NC]\n RewriteCond %{HTTP:Upgrade} websocket [NC]\n RewriteRule /(.*) ws://localhost:8080/$1 [P,L]\n AllowEncodedSlashes NoDecode\n ProxyPass / http://localhost:8080/ nocanon\n ProxyPassReverse / http://localhost:8080/\n SSLCertificateFile /etc/letsencrypt/live/trilium.yourdomain.com/fullchain.pem\n SSLCertificateKeyFile /etc/letsencrypt/live/trilium.yourdomain.com/privkey.pem\n Include /etc/letsencrypt/options-ssl-apache.conf\n </code></pre></li><li><p>Enable the virtual host with <code spellcheck=\"false\">sudo a2ensite trilium.yourdomain.com.conf</code></p></li><li><p>Reload apache2 with <code spellcheck=\"false\">sudo systemctl reload apache2</code></p></li></ol><h2>Configuring the trusted proxy</h2><p>After setting up a reverse proxy, make sure to configure the&nbsp;<a class=\"reference-link\" href=\"#root/_help_LLzSMXACKhUs\">Trusted proxy</a>.</p><h2>Setup the systemd service to start up the server</h2><p>Create and enable a systemd service to start the docker container on boot</p><ol><li><p>Create a new empty file called <code spellcheck=\"false\">/lib/systemd/system/trilium.service</code> with the contents</p><pre><code class=\"language-text-x-trilium-auto\"> [Unit]\n Description=Trilium Server\n Requires=docker.service\n After=docker.service\n\n [Service]\n Restart=always\n ExecStart=/usr/bin/docker start -a trilium\n ExecStop=/usr/bin/docker stop -t 2 trilium\n\n [Install]\n WantedBy=local.target</code></pre></li><li><p>Install, enable and start service</p><pre><code class=\"language-text-x-trilium-auto\"> sudo systemctl daemon-reload\n sudo systemctl enable trilium.service\n sudo systemctl start trilium.service</code></pre></li></ol>",
- "_help_LLzSMXACKhUs": "<p>If you are running the Trilium server under a <a href=\"#root/_help_vcjrb3VVYPZI\">reverse proxy</a>, it's important to configure it as a trusted proxy so that the application can correctly identify the real IP address of the clients (for authentication and rate limiting purposes).</p><p>To do so, simply modify&nbsp;<a class=\"reference-link\" href=\"#root/_help_Gzjqa934BdH4\">Configuration (config.ini or environment variables)</a>&nbsp;and set:</p><pre><code class=\"language-text-x-trilium-auto\">[Network]\ntrustedReverseProxy=true</code></pre><p>This will use the left-most IP in the <code spellcheck=\"false\">X-Forwarded-For</code> header. Alternatively, instead of <code spellcheck=\"false\">true</code> use the IP address of the reverse proxy or Express.js shortcuts such as:</p><pre><code class=\"language-text-x-trilium-auto\">loopback(127.0.0.1/8, ::1/128), linklocal(169.254.0.0/16, fe80::/10), uniquelocal(10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16, fc00::/7)</code></pre><p>For more information, consult <a href=\"https://expressjs.com/en/guide/behind-proxies.html\">Express behind proxies</a>.</p>",
- "_help_5ERVJb9s4FRD": "<p>The goal of this article is to configure Traefik proxy and HTTPS. See <a href=\"https://github.com/TriliumNext/Trilium/issues/7768#issuecomment-3539165814\">#7768</a> for reference.</p><h2>Breaking change in Traefik 3.6.4</h2><p>Traefik 3.6.4 introduced a <a href=\"https://doc.traefik.io/traefik/migrate/v3/#encoded-characters-in-request-path\">breaking change</a> regarding how percent-encoded characters are handled in URLs. More specifically some URLs used by Trilium (such as <code spellcheck=\"false\">search/%23workspace%20%23!template</code>) are automatically rejected by Traefik, resulting in HTTP 400 errors.</p><p>To solve this, the Traefik <a href=\"https://doc.traefik.io/traefik/getting-started/configuration-overview/#the-install-configuration\"><strong>static</strong> configuration</a> must be modified in order to allow those characters:</p><pre><code class=\"language-text-x-yaml\">entryPoints:\n web:\n http:\n encodedCharacters:\n allowEncodedSlash: true\n allowEncodedHash: true</code></pre><aside class=\"admonition tip\"><p>If you still have issues, depending on how Trilium is used (especially regarding search), you might need to enable more encoded character groups. For more information, see <a href=\"https://github.com/TriliumNext/Trilium/issues/7968\">the relevant GitHub issue</a>; feel free to report your findings.</p></aside><h3>Build the docker-compose file</h3><p>Setting up Traefik as reverse proxy requires setting the following labels:</p><pre><code class=\"language-text-x-yaml\"> labels:\n - traefik.enable=true\n - traefik.http.routers.trilium.entrypoints=https\n - traefik.http.routers.trilium.rule=Host(`trilium.mydomain.tld`)\n - traefik.http.routers.trilium.tls=true\n - traefik.http.routers.trilium.service=trilium\n - traefik.http.services.trilium.loadbalancer.server.port=8080\n # scheme must be HTTP instead of the usual HTTPS because Trilium listens on HTTP internally\n - traefik.http.services.trilium.loadbalancer.server.scheme=http\n - traefik.docker.network=proxy\n # forward HTTP to HTTPS\n - traefik.http.routers.trilium.middlewares=trilium-headers@docker\n - traefik.http.middlewares.trilium-headers.headers.customrequestheaders.X-Forwarded-Proto=https</code></pre><h3>Setup needed environment variables</h3><p>After setting up a reverse proxy, make sure to configure the&nbsp;<a class=\"reference-link\" href=\"#root/_help_LLzSMXACKhUs\">Trusted proxy</a>.</p><h3>Example <code spellcheck=\"false\">docker-compose.yaml</code></h3><pre><code class=\"language-text-x-yaml\">services:\n trilium:\n image: triliumnext/trilium\n container_name: trilium\n networks:\n - traefik-proxy\n environment:\n - TRILIUM_NETWORK_TRUSTEDREVERSEPROXY=my-traefik-host-ip # e.g., 172.18.0.0/16\n volumes:\n - /path/to/data:/home/node/trilium-data\n - /etc/timezone:/etc/timezone:ro\n - /etc/localtime:/etc/localtime:ro\n labels:\n - traefik.enable=true\n - traefik.http.routers.trilium.entrypoints=https\n - traefik.http.routers.trilium.rule=Host(`trilium.mydomain.tld`)\n - traefik.http.routers.trilium.tls=true\n - traefik.http.routers.trilium.service=trilium\n - traefik.http.services.trilium.loadbalancer.server.port=8080\n # scheme must be HTTP instead of the usual HTTPS because of how trilium works\n - traefik.http.services.trilium.loadbalancer.server.scheme=http\n - traefik.docker.network=traefik-proxy\n # Tell Trilium the original request was HTTPS\n - traefik.http.routers.trilium.middlewares=trilium-headers@docker\n - traefik.http.middlewares.trilium-headers.headers.customrequestheaders.X-Forwarded-Proto=https\n\nnetworks:\n traefik-proxy:\n external: true</code></pre>",
- "_help_l2VkvOwUNfZj": "<p>Configuring TLS is essential for <a href=\"#root/_help_WOcw2SLH6tbX\">server installation</a> in Trilium. This guide details the steps to set up TLS within Trilium itself.</p><aside class=\"admonition tip\"><p>While Trilium supports HTTPS on its own, it's generally a good idea to use a <a href=\"#root/_help_vcjrb3VVYPZI\">reverse proxy</a> instead with TLS termination. You can follow a <a href=\"https://www.digitalocean.com/community/tutorials/how-to-secure-nginx-with-let-s-encrypt-on-ubuntu-20-04\">guide like this</a> for such setups.</p></aside><h2>Obtaining a TLS Certificate</h2><p>You have two options for obtaining a TLS certificate:</p><ul><li><strong>Recommended</strong>: Obtain a TLS certificate signed by a root certificate authority. For personal use, <a href=\"https://letsencrypt.org\">Let's Encrypt</a> is an excellent choice. It is free, automated, and straightforward. Certbot can facilitate automatic TLS setup.</li><li>Generate a self-signed certificate. This option is not recommended due to the additional complexity of importing the certificate into all machines connecting to the server.</li></ul><h2>Modifying <code spellcheck=\"false\">config.ini</code></h2><p>Once you have your certificate, modify the <code spellcheck=\"false\">config.ini</code> file in the <a href=\"#root/_help_tAassRL4RSQL\">data directory</a> to configure Trilium to use it:</p><pre><code class=\"language-text-x-trilium-auto\">[Network]\nport=8080\n# Set to true for TLS/SSL/HTTPS (secure), false for HTTP (insecure).\nhttps=true\n# Path to the certificate (run \"bash bin/generate-cert.sh\" to generate a self-signed certificate).\n# Relevant only if https=true\ncertPath=/[username]/.acme.sh/[hostname]/fullchain.cer\nkeyPath=/[username]/.acme.sh/[hostname]/example.com.key</code></pre><p>You can also review the <a href=\"#root/_help_Gzjqa934BdH4\">configuration</a> file to provide all <code spellcheck=\"false\">config.ini</code> values as environment variables instead. For example, you can configure TLS using environment variables:</p><pre><code class=\"language-text-x-trilium-auto\">export TRILIUM_NETWORK_HTTPS=true\nexport TRILIUM_NETWORK_CERTPATH=/path/to/cert.pem\nexport TRILIUM_NETWORK_KEYPATH=/path/to/key.pem</code></pre><p>The above example shows how this is set up in an environment where the certificate was generated using Let's Encrypt's ACME utility. Your paths may differ. For Docker installations, ensure these paths are within a volume or another directory accessible by the Docker container, such as <code spellcheck=\"false\">/home/node/trilium-data/[DIR IN DATA DIRECTORY]</code>.</p><p>After configuring <code spellcheck=\"false\">config.ini</code>, restart Trilium and access the hostname using \"https\".</p><h2>Self-Signed Certificate</h2><p>If you opt to use a self-signed certificate for your server instance, note that the desktop instance will not trust it by default.</p><p>To bypass this, disable certificate validation by setting the following environment variable (for Linux):</p><pre><code class=\"language-text-x-trilium-auto\">export NODE_TLS_REJECT_UNAUTHORIZED=0\ntrilium</code></pre><p>Trilium provides scripts to start in this mode, such as <code spellcheck=\"false\">trilium-no-cert-check.bat</code> for Windows.</p><p><strong>Warning</strong>: Disabling TLS certificate validation is insecure. Proceed only if you fully understand the implications.</p>",
- "_help_0hzsNCP31IAB": "<h2>Disabling authentication</h2><p>If you are running Trilium on <code spellcheck=\"false\">localhost</code> only or if authentication is handled by another component, you can disable Trilium’s authentication by adding the following to <code spellcheck=\"false\">config.ini</code>:</p><pre><code class=\"language-text-x-trilium-auto\">[General]\nnoAuthentication=true</code></pre><p>Disabling authentication will bypass even the&nbsp;<a class=\"reference-link\" href=\"#root/_help_7DAiwaf8Z7Rz\">Multi-Factor Authentication</a>&nbsp;since v0.94.1.</p><h2>Understanding how the session works</h2><p>Once logged into Trilium, the application will store this information about the login into a cookie on the browser, but also as a session on the server.</p><p>If “Remember me” is checked, then the login will expire in 21 days. This period can be adjusted by modifying the <code spellcheck=\"false\">Session.cookieMaxAge</code> value in <code spellcheck=\"false\">config.ini</code>. For example, to have the session expire in one day:</p><pre><code class=\"language-text-x-trilium-auto\">[Session]\ncookieMaxAge=86400</code></pre><p>When “Remember me” is unchecked, the behavior is different. At client/browser level the authentication does not have any expiration date, but it will be automatically cleared as soon as the user closes the browser. Nevertheless, the server will also dismiss this authentication in around 24 hours from the <em>last interaction with the application</em>.</p><h2>Viewing active sessions</h2><p>The login sessions are now stored in the same&nbsp;<a class=\"reference-link\" href=\"#root/_help_wX4HbRucYSDD\">Database</a>&nbsp;as the user data. In order to view which sessions are active, open the&nbsp;<a class=\"reference-link\" href=\"#root/_help_YKWqdJhzi2VY\">SQL Console</a>&nbsp;and run the following query:</p><pre><code class=\"language-text-x-trilium-auto\">SELECT * FROM sessions</code></pre><p>Expired sessions are periodically cleaned by the server, generally an hourly interval.</p><h2>See also</h2><ul><li><a class=\"reference-link\" href=\"#root/_help_7DAiwaf8Z7Rz\">Multi-Factor Authentication</a></li></ul>",
- "_help_lwAX5SvbrK2g": "<aside class=\"admonition important\"><p>If you forget your password:</p><ul><li>Protected notes are irretrievable without the password.</li><li>Unprotected notes can be recovered.</li></ul></aside><p>There are two options, both involving access to the device that is running your server.</p><h3>By disabling authentication</h3><ol><li>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_0hzsNCP31IAB\">Authentication</a>&nbsp;on how to disable the authentication.</li><li>Restart the server.</li><li>Go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ Password → Reset password.</li><li>Re-enable authentication by following step (1) in reverse.</li><li>Restart the server.</li><li>Log in with the new password.</li></ol><h3>By altering the database</h3><ol><li><p>Access the <a href=\"#root/_help_wX4HbRucYSDD\">database</a> file in the <a href=\"#root/_help_tAassRL4RSQL\">data directory</a>. Open the <code spellcheck=\"false\">document.db</code> file with an SQLite client (e.g., <a href=\"https://sqlitebrowser.org/\">DB Browser</a>).</p></li><li><p>Execute the following queries:</p><pre><code class=\"language-text-x-trilium-auto\">UPDATE options SET value = '77/twC5O00cuQgNC63VK32qOKKYwj21ev3jZDXoytVU=' WHERE name = 'passwordVerificationSalt';\nUPDATE options SET value = '710BMasZCAgibzIc07X4P9Q4TeBd4ONnqJOho+pWcBM=' WHERE name = 'passwordDerivedKeySalt';\nUPDATE options SET value = 'Eb8af1/T57b89lCRuS97tPEl4CwxsAWAU7YNJ77oY+s=' WHERE name = 'passwordVerificationHash';\nUPDATE options SET value = 'QpC8XoiYYeqHPtHKRtbNxfTHsk+pEBqVBODYp0FkPBa22tlBBKBMigdLu5GNX8Uu' WHERE name = 'encryptedDataKey';</code></pre></li><li><p>After executing the changes, commit/write the changes. <strong>This sets the password to</strong> <code spellcheck=\"false\">**password**</code><strong>, allowing you to log in again.</strong></p></li><li><p>Go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Password</em> → <em>Change password</em> and replace the unsafe password.</p></li></ol><h2>Handling protected notes</h2><p>When the password is reset, the protected notes are permanently lost due to the fact that they are encrypted with your password so there is no way for Trilium to recover them.</p><p>For pre-existing protected notes (now unrecoverable), consider deleting them or exporting the unprotected notes. Then, delete <code spellcheck=\"false\">document.db</code> and start fresh.</p>",
++ "_help_BOCnjTMBCoxW": "<p>This section presents the most important changes by version. For a full set of changes, please consult the change log of each release. For purposes of brevity, beta versions are skipped and the features gathered to the nearest stable version.</p><ul><li>v0.105.0:<ul><li>Text notes now have a&nbsp;<a class=\"reference-link\" href=\"#root/_help_VRoP0g1uHHc2\">In-editor AI assistant</a>&nbsp;for quick proof-reading and other text-based operations that don't require a full chat.</li></ul></li><li>v0.101.0:<ul><li>A&nbsp;new layout&nbsp;has been introduced, making significant modifications to the UI/UX such as integrating the ribbon and the floating buttons into other UI elements and introducing new functionality such as the&nbsp;<a class=\"reference-link\" href=\"#root/_help_I6p2a06hdnL6\">Breadcrumb</a>.</li></ul></li><li>v0.97.0:<ul><li>Books are now&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>.</li><li><a class=\"reference-link\" href=\"#root/_help_2FvYrpmOXm29\">Table</a>&nbsp;is a new collection type displaying notes and attributes in an editable grid.</li><li><a class=\"reference-link\" href=\"#root/_help_ZjLYv08Rp3qC\">Quick edit</a>&nbsp;is introduced, adding a new way to edit notes in a popup instead of opening a new tab. It also integrates well with&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>.</li></ul></li><li>v0.96.0:<ul><li><a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;gain premium features thanks to a collaboration with the CKEditor team:<ul><li><a class=\"reference-link\" href=\"#root/_help_ZlN4nump6EbW\">Slash Commands</a></li><li><a class=\"reference-link\" href=\"#root/_help_pwc194wlRzcH\">Text Snippets</a></li></ul></li></ul></li><li>v0.95.0:<ul><li>A more friendly theme was introduced for&nbsp;<a class=\"reference-link\" href=\"#root/_help_R9pX4DGra2Vt\">Sharing</a>, with search, expandable tree, night mode and more.</li></ul></li><li>v0.94.0:<ul><li>Added integration with&nbsp;<a class=\"reference-link\" href=\"#root/_help_GBBMSlVSOIGP\">AI</a>&nbsp;(using self-hosted LLMs such as Ollama or industry standards such as ChatGPT).</li></ul></li><li>v0.92.5:<ul><li>Windows binaries are now signed.</li><li><a class=\"reference-link\" href=\"#root/_help_7DAiwaf8Z7Rz\">Multi-factor authentication with TOTP</a>&nbsp;was introduced.</li></ul></li><li>v0.92.4:<ul><li>macOS binaries are now signed.</li><li><a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes can now have adjustable&nbsp;<a class=\"reference-link\" href=\"#root/_help_veGu4faJErEM\">Content language &amp; Right-to-left support</a>.</li><li><a class=\"reference-link\" href=\"#root/_help_NRnIZmSMc5sj\">Printing &amp; Exporting as PDF</a></li><li><a class=\"reference-link\" href=\"#root/_help_rC3pL2aptaRE\">Zen mode</a></li><li><a class=\"reference-link\" href=\"#root/_help_xWbu3jpNWapp\">Calendar</a>, allowing notes to be displayed in a monthly grid based on start and end dates.</li></ul></li><li>v0.91.5:<ul><li>Significant improvements for mobile.</li><li><a class=\"reference-link\" href=\"#root/_help_AgjCISero73a\">Footnotes</a>&nbsp;are now supported in&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes.</li><li>Mermaid diagrams can now be inserted inline within&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes.</li><li>The TriliumNext theme is introduced, bringing a more modern design to the application.</li><li><a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map</a>, displaying notes as markers on a geographical map for easy trip planning.</li></ul></li><li>v0.90.8:<ul><li>A new note type was introduced:&nbsp;<a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a></li></ul></li></ul>",
++ "_help_poXkQfguuA0U": "<p>To install Trilium on your desktop, follow these steps:</p><ol><li><strong>Download the Latest Release</strong>: Obtain the appropriate binary release for your operating system from the <a href=\"https://github.com/TriliumNext/Trilium/releases/latest\">latest release page</a> on GitHub.</li><li><strong>Extract the Package</strong>: Unzip the downloaded package to a location of your choice.</li><li><strong>Run the Application</strong>: Launch Trilium by executing the <code>trilium</code> executable found within the unzipped folder.</li></ol><h2>Installing from Flathub</h2><p>On Linux, Trilium is also available on <a href=\"https://flathub.org/en/apps/org.triliumnotes.Trilium\">Flathub</a>, for both x86_64 and ARM (aarch64). Install it from your software center (e.g. GNOME Software or KDE Discover), or from a terminal:</p><pre><code class=\"language-text-x-sh\">flatpak install flathub org.triliumnotes.Trilium</code></pre><p>Updates arrive through the software center or <code>flatpak update</code>, like any other Flatpak.</p><p>The Flathub version runs in a sandbox and keeps its <a href=\"#root/_help_tAassRL4RSQL\">data directory</a> in <code>~/.var/app/org.triliumnotes.Trilium/data/trilium-data</code>. It cannot see the data directory of a <code>.deb</code>, <code>.rpm</code>, AppImage or <code>.zip</code> installation (<code>~/.local/share/trilium-data</code>), so it starts with an empty database. To bring existing notes over:</p><ol><li><p>Close Trilium, in both the old installation and the Flatpak.</p></li><li><p>Copy the old data directory into the sandbox:</p><pre><code class=\"language-text-x-sh\">mkdir -p ~/.var/app/org.triliumnotes.Trilium/data\ncp -a ~/.local/share/trilium-data ~/.var/app/org.triliumnotes.Trilium/data/</code></pre></li><li><p>Start the Flatpak version.</p></li></ol><p>If <code>~/.var/app/org.triliumnotes.Trilium/data/trilium-data</code> already exists because the Flatpak version was started before, remove or rename it first.</p><h2>Startup Scripts</h2><p>Trilium offers various startup scripts to customize your experience:</p><ul><li><code>trilium-no-cert-check</code>: Starts Trilium without validating <a href=\"#root/_help_l2VkvOwUNfZj\">TLS certificates</a>, useful if connecting to a server with a self-signed certificate.<ul><li>Alternatively, set the <code>NODE_TLS_REJECT_UNAUTHORIZED=0</code> environment variable before starting Trilium.</li></ul></li><li><code>trilium-portable</code>: Launches Trilium in portable mode, where the <a href=\"#root/_help_tAassRL4RSQL\">data directory</a> is created within the application's directory, making it easy to move the entire setup. Electron's internal data (caches, dictionaries, etc.) is also stored within the data directory, so no files are written to the system's roaming profile.</li><li><code>trilium-safe-mode</code>: Boots Trilium in \"safe mode,\" disabling any startup scripts that might cause the application to crash.</li></ul><h2>Synchronization</h2><p>For Trilium desktop users who wish to synchronize their data with a server instance, refer to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_cbkrhQjrkKrh\">Synchronization</a>&nbsp;guide for detailed instructions.</p>",
++ "_help_nRqcgfTb97uV": "<p>Sometimes, setting up a <a href=\"#root/_help_WOcw2SLH6tbX\">dedicated server installation</a> is not feasible. The desktop application ships with a fully functional server instance by default.</p><p>For security reasons, this feature is <strong>not enabled</strong> by default. To enable it, enable <em>Network access</em> in&nbsp;<a class=\"reference-link\" href=\"#root/_help_fiHicjpHjIRJ\">Security</a>.</p><p>After enabling network access and restarting the application, you can access this web interface locally by navigating to <a href=\"http://localhost:37840/login\">http://localhost:37840/login</a>.</p><aside class=\"admonition note\"><p>The server embedded in the desktop application will only run as long as the desktop application itself is running. So closing the application will also close the server. To overcome this, you can try hiding the application in the system tray.</p></aside><h2>Mobile interface</h2><p>By default, this will display the desktop user interface, even on mobile. To switch to the mobile version, simply go to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;and select “Switch to the mobile version”.</p><h2>Allowing the port externally on Windows with Windows Defender Firewall</h2><p>First, find out the IP of your desktop server by running <code>ipconfig</code> in your local terminal. Then try accessing <code>http://&lt;ip&gt;:37840/login</code> on another device. If it doesn't work, then most likely the port is blocked by your operating system's firewall.</p><p>If you use Windows Defender Firewall:</p><ol><li>Go to Windows's start menu and look for “Windows Defender Firewall with Advanced Security”.</li><li>Go to “Inbound Rules” on the left tree, and select “New Rule” in the “Actions” sidebar on the right.</li><li>Select “Port” and press “Next”.</li><li>Type in <code>37840</code> in the “Specific local ports” section and then press “Next”.</li><li>Leave “Allow the connection” checked and press “Next”.</li><li>Configure the networks to apply to (check all if unsure) and then press “Next”.</li><li>Add an appropriate name to the rule (e.g. “Trilium Notes”) and press “Finish”.</li></ol><aside class=\"admonition warning\"><p>Since v0.104.0, the port used by Trilium is accessible only on <code>localhost</code>. To enable across the local network, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_swSFivWk6KkA\">Network Access</a>.</p></aside>",
++ "_help_Rp0q8bSP6Ayl": "<p>The desktop version of Trilium supports all three main operating systems:</p><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-windows\"></span>&nbsp;Windows</p><div class=\"trilium-tab-panel\"><ul><li>Windows 11 is officially supported.</li><li>Windows on ARM is also supported</li></ul></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-tux\"></span>&nbsp;Linux</p><div class=\"trilium-tab-panel\"><ul><li>Most modern distributions are supported, including NixOS.</li><li>ARM is supported in <code>aarch64</code> (no ARM v7 support).</li></ul></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-apple\"></span>&nbsp;macOS</p><div class=\"trilium-tab-panel\"><ul><li>Minimum supported operating system: macOS Ventura</li><li>Both Intel and Apple Silicon devices are supported.</li></ul></div></section></div>",
++ "_help_Un4wj2Mak2Ky": "<p>Since TriliumNext 0.94.1, the desktop and server applications can be built using <a href=\"https://nixos.org/\">Nix</a>.</p><h2>System requirements</h2><p>Installation of Nix on Mac or Linux (<a href=\"https://nixos.org/download/\">download page</a>). About 3-4 gigabytes of additional storage space, for build artifacts.</p><h2>Run directly</h2><p>Using <a href=\"https://nix.dev/manual/nix/stable/command-ref/new-cli/nix3-run.html\">nix run</a>, the desktop app can be started as: <code>nix run github:TriliumNext/Trilium/v0.95.0</code></p><p>Running the server requires explicitly specifying the desired package: <code>nix run github:TriliumNext/Trilium/v0.95.0#server</code></p><p>Instead of a version (<code>v0.95.0</code> above), you can also specify a commit hash (or a branch name). This makes it easy to test development builds.</p><h2>Install on NixOS</h2><p>Add to your <code>flake.nix</code>:</p><pre><code class=\"language-text-x-trilium-auto\">{\n inputs = {\n nixpkgs.url = # ...;\n trilium-notes = {\n url = \"github:TriliumNext/Trilium/v0.95.0\";\n inputs.nixpkgs.follows = \"nixpkgs\";\n };\n };\n\n outputs =\n {\n self,\n # ...\n trilium-notes,\n ...\n }:\n {\n nixosConfigurations = {\n \"nixos\" = nixpkgs.lib.nixosSystem {\n system = \"x86_64-linux\";\n modules = [\n ./configuration.nix\n ];\n specialArgs = {\n inherit\n trilium-notes\n ;\n };\n };\n };\n };\n}\n</code></pre><p>Add to your <code>configuration.nix</code>:</p><pre><code class=\"language-text-x-trilium-auto\">{\n # ...\n trilium-notes,\n ...\n}:\n\n{\n # ...\n\n services.trilium-server.package = trilium-notes.packages.x86_64-linux.server;\n\n environment.systemPackages = [\n trilium-notes.packages.x86_64-linux.desktop\n ];\n}</code></pre><p>The flake aims to be compatible with the latest NixOS stable and unstable.</p>",
++ "_help_swSFivWk6KkA": "<p>Prior to v0.104.0, the <a href=\"#root/_help_poXkQfguuA0U\">desktop application</a> would also open a network port so that it can offer access to&nbsp;<a class=\"reference-link\" href=\"#root/_help_pgxEVkzLl1OP\">ETAPI (REST API)</a>&nbsp;or even use it as a web server (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRqcgfTb97uV\">Using the desktop application as a server</a>).</p><p>In order to reduce the attack surface, Trilium now enables these services only for the local device (e.g. <code>localhost</code>) instead of serving them over the LAN.</p><p>To better understand what is affected, refer to the following table:</p><figure class=\"table\"><table><thead><tr><th>Feature</th><th>Network access OFF</th><th>Network access ON</th></tr></thead><tbody><tr><td><a class=\"reference-link\" href=\"#root/_help_MtPxeAWVAzMg\">Web Clipper</a></td><td>🔒️ <code>localhost</code> only (still accessible to the browser extension on the same device)</td><td>🌐 <code>localhost</code> + LAN</td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_pgxEVkzLl1OP\">ETAPI (REST API)</a></td><td>🔒️ <code>localhost</code> only</td><td>🌐 <code>localhost</code> + LAN</td></tr><tr><td><a href=\"#root/_help_GBBMSlVSOIGP\">LLM MCP</a> (only if enabled in settings)</td><td>🔒️ <code>localhost</code> only (needs auth)</td><td>🌐 <code>localhost</code> + LAN (needs auth)</td></tr><tr><td><a href=\"#root/_help_nRqcgfTb97uV\">Web app</a></td><td>❌️ completely disabled (403), only the desktop app is usable.</td><td>🌐 <code>localhost</code> + LAN</td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_R9pX4DGra2Vt\">Sharing</a>&nbsp;notes</td><td>❌️ completely disabled (403), if you are using&nbsp;<a class=\"reference-link\" href=\"#root/_help_cbkrhQjrkKrh\">Synchronization</a>&nbsp;this will still work as part of the <a href=\"#root/_help_WOcw2SLH6tbX\">server</a>.</td><td>🌐 <code>localhost</code> + LAN</td></tr></tbody></table></figure>",
++ "_help_7iwde4lsKc6O": "<aside class=\"admonition note\"><p>Automatic startup and better integration with the system tray was introduced in v0.104.0. Versions prior to that only have the system tray option which could be found in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Others</em>.</p></aside><h2>Tray icon</h2><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:332/71;\" src=\"{{helpAssets}}/User%20Guide/Installation%20%26%20Setup/Desktop%20Installation/Tray%20icon%20%26%20automatic%20startup_image.png\" width=\"332\" height=\"71\"></figure><p>The desktop application has native integration with the system tray on all operating systems.</p><p>The tray icon is enabled by default, but it can be toggled from&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Desktop</em>.</p><p>The tray icon has the following functionality:</p><ul><li>When clicked, the last window is hidden (minimized to the tray icon). Clicking it again will reveal that window.</li><li>Right clicking reveals the following options:<ul><li>Each window can be individually shown or hidden, identified by their active note.</li><li>New windows can be opened.</li><li>A new note can be created directly, which will be created in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_S0Fos78ZfcY7\">Note Inbox</a>&nbsp;(or&nbsp;<a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a>&nbsp;if an inbox is not available).</li><li>Today's day note can be opened.</li><li>Bookmarks and recent notes are displayed in a sub-menu and clicking them navigates to that note.</li><li>Quitting the application.</li></ul></li></ul><h3>Closing to system tray</h3><p>This is an option which is not enabled by default and it allows a specific behavior: instead of exiting the application when the last window has been closed, the last window is instead hidden with the tray icon remaining available.</p><p>This option requires the tray icon to be enabled, otherwise it has no effect.</p><h2>Automatic startup</h2><p>Two options control the automatic startup functionality in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Startup</em>:</p><ul><li>When <em>Launch on startup</em> is enabled, the application will automatically start up when logging into the current user.<ul><li>Note that on Linux support depends on the desktop environment. Feel free to <a href=\"#root/_help_wy8So3yZZlH9\">report</a> any issues.</li></ul></li><li>If <em>Start minimized to tray</em> is also enabled, the application will start up in the background and can be revealed from the tray icon.<ul><li>This only applies if <em>Launch on startup</em> is enabled, manual starts are not impacted by this option.</li></ul></li></ul><h3>Linux: custom launch command for packagers</h3><p>On Linux, <em>Launch on startup</em> writes a <code>trilium.desktop</code> entry to the user's autostart directory (<code>$XDG_CONFIG_HOME/autostart</code>, usually <code>~/.config/autostart</code>). Its <code>Exec</code> line points to the AppImage when running from one, or to the running executable otherwise.</p><p>Distribution packages that run Trilium on a system-wide Electron (for example <code>electron /usr/lib/trilium/app.asar</code>) cannot rely on the running executable, since it is the bare Electron binary, which starts without Trilium. Such packages can set the <code>TRILIUM_LAUNCH_EXEC</code> environment variable, typically in their wrapper script, to the full command that starts Trilium:</p><pre><code class=\"language-text-x-trilium-auto\">export TRILIUM_LAUNCH_EXEC='electron \"/usr/lib/trilium/app.asar\"'</code></pre><p>The value is written to the <code>Exec</code> line as-is, so any paths containing spaces must already be quoted. When <em>Start minimized to tray</em> is enabled, <code>--start-hidden</code> is appended to it. <code>TRILIUM_LAUNCH_EXEC</code> takes precedence over both the AppImage path and the running executable.</p>",
++ "_help_hvRfsDr591WP": "<h2>Trilium only shows a blank window</h2><p>Trilium uses Electron which is based on Chromium (the open-source alternative to Google Chrome); in order to improve performance it makes use of <em>GPU acceleration</em>. In some cases, a GPU incompatibility (especially on older models of integrated graphics) can cause nothing to render at all, resulting in a blank window.&nbsp;</p><p>To bypass this, try running Trilium with the following command line argument:</p><pre><code class=\"language-text-x-trilium-auto\">trilium --disable-gpu</code></pre><p>If that doesn't work, try the following commands as well:</p><ul><li><code>trilium --disable-gpu-compositing</code></li><li><code>ELECTRON_OZONE_PLATFORM_HINT=x11 trilium</code> (this one forces the rendering to X11 on Wayland)</li></ul><p>If Trilium renders fine after this, Trilium offers a built-in option to disable GPU acceleration: go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Appearance</em>, look for the <em>Performance</em> section and then uncheck <em>Hardware acceleration (GPU)</em>.</p>",
++ "_help_WOcw2SLH6tbX": "<p>This guide outlines the steps to install Trilium on your own server. You might consider this option if you want to set up <a href=\"#root/_help_cbkrhQjrkKrh\">synchronization</a> or use Trilium in a browser - accessible from anywhere.</p><h2>Installation Options</h2><p>There are several ways to install Trilium on a server, each with its own advantages:</p><ul><li><strong>Recommended</strong>: <a href=\"#root/_help_rWX5eY045zbE\">Docker Installation</a> - Available for <strong>AMD64</strong> and <strong>ARM</strong> architectures.</li><li><a href=\"#root/_help_3tW6mORuTHnB\">Packaged Server Installation</a></li><li><a href=\"https://www.pikapods.com/pods?run=trilium-next\">PikaPods managed hosting</a></li><li><a href=\"#root/_help_J1Bb6lVlwU5T\">Manual Installation</a></li><li><a href=\"#root/_help_DCmT6e7clMoP\">Kubernetes</a></li><li><a href=\"https://www.cloudron.io/store/com.github.trilium.cloudronapp.html\">Cloudron</a></li><li><a href=\"https://homelabos.com/docs/software/trilium/\">HomelabOS</a></li><li><a href=\"#root/_help_moVgBcoxE3EK\">NixOS Module</a></li></ul><p>The server installation includes both web and <a href=\"#root/_help_RDslemsQ6gCp\">mobile frontends</a>.</p><h2>Configuration</h2><p>After setting up your server installation, you may want to configure settings such as the port or enable <a href=\"#root/_help_l2VkvOwUNfZj\">TLS</a>. Configuration is managed via the Trilium <code>config.ini</code> file, which is located in the <a href=\"#root/_help_tAassRL4RSQL\">data directory</a> by default. To begin customizing your setup, copy the provided <code>config-sample.ini</code> file with default values to <code>config.ini</code>.</p><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><h3>Config Location</h3><p>By default, <code>config.ini</code>, the <a href=\"#root/_help_wX4HbRucYSDD\">database</a>, and other important Trilium data files are stored in the <a href=\"#root/_help_tAassRL4RSQL\">data directory</a>. If you prefer a different location, you can change it by setting the <code>TRILIUM_DATA_DIR</code> environment variable:</p><pre><code class=\"language-text-x-trilium-auto\">export TRILIUM_DATA_DIR=/home/myuser/data/my-trilium-data</code></pre><h3>Disabling Authentication</h3><p>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_0hzsNCP31IAB\">Authentication</a>.</p><h2>Reverse Proxy Setup</h2><p>To configure a reverse proxy for Trilium, you can use either <strong>nginx</strong> or <strong>Apache</strong>. You can also check out the documentation stored in the Reverse proxy folder.</p><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">nginx</p><div class=\"trilium-tab-panel\"><p>Add the following configuration to your <code>nginx</code> setup to proxy requests to Trilium:</p><pre><code class=\"language-text-x-trilium-auto\">location /trilium/ {\n proxy_pass http://127.0.0.1:8080/;\n proxy_http_version 1.1;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection 'upgrade';\n proxy_set_header Host $host;\n proxy_cache_bypass $http_upgrade;\n}</code></pre><p>To avoid limiting the size of payloads, include this in the <code>server {}</code> block:</p><pre><code class=\"language-text-x-trilium-auto\"># Set to 0 for unlimited. Default is 1M.\nclient_max_body_size 0;</code></pre></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Apache</p><div class=\"trilium-tab-panel\"><p>For an Apache setup, refer to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_fDLvzOx29Pfg\">Apache using Docker</a>&nbsp;guide.</p></div></section></div>",
++ "_help_3tW6mORuTHnB": "<p>This is essentially Trilium sources + node modules + node.js runtime packaged into one 7z file.</p><h2>Steps</h2><ul><li>SSH into your server</li><li>use <code>wget</code> (or <code>curl</code>) to download latest <code>TriliumNotes-Server-[VERSION]-linux-x64.tar.xz</code> (copy link from <a href=\"https://github.com/TriliumNext/Trilium/releases\">release page</a>, notice <code>-Server</code> suffix) on your server.</li><li>unpack the archive, e.g. using <code>tar -xf -d TriliumNotes-Server-[VERSION]-linux-x64.tar.xz</code></li><li><code>cd trilium-linux-x64-server</code></li><li><code>./trilium.sh</code></li><li>you can open the browser and open http://[your-server-hostname]:8080 and you should see Trilium initialization page</li></ul><p>The problem with above steps is that once you close the SSH connection, the Trilium process is terminated. To avoid that, you have two options:</p><ul><li>Kill it (with e.g. <kbd>Ctrl</kbd> + <kbd>C</kbd>) and run again like this: <code>nohup ./trilium.sh &amp;</code>. (nohup keeps the process running in the background, <code>&amp;</code> runs it in the background)</li><li>Configure systemd to automatically run Trilium in the background on every boot</li></ul><h2>Configure Trilium to auto-run on boot with systemd</h2><ul><li>After downloading, extract and move Trilium:</li></ul><pre><code class=\"language-text-x-trilium-auto\">tar -xvf TriliumNotes-Server-[VERSION]-linux-x64.tar.xz\nsudo mv trilium-linux-x64-server /opt/trilium</code></pre><ul><li>Create the service:</li></ul><pre><code class=\"language-text-x-trilium-auto\">sudo nano /etc/systemd/system/trilium.service</code></pre><ul><li>Paste this into the file (replace the user and group as needed):</li></ul><pre><code class=\"language-text-x-trilium-auto\">[Unit]\nDescription=Trilium Daemon\nAfter=syslog.target network.target\n\n[Service]\nUser=xxx\nGroup=xxx\nType=simple\nExecStart=/opt/trilium/trilium.sh\nWorkingDirectory=/opt/trilium/\n\nTimeoutStopSec=20\n# KillMode=process leads to error, according to https://www.freedesktop.org/software/systemd/man/systemd.kill.html\nRestart=always\n\n[Install]\nWantedBy=multi-user.target</code></pre><ul><li>Save the file (CTRL-S) and exit (CTRL-X)</li><li>Enable and launch the service:</li></ul><pre><code class=\"language-text-x-trilium-auto\">sudo systemctl enable --now -q trilium</code></pre><ul><li>You can now open a browser to http://[your-server-hostname]:8080 and you should see the Trilium initialization page.</li></ul><h2>Simple auto-update for Server</h2><p>The script is available in&nbsp;<a class=\"reference-link\" href=\"#root/_help_ZNAjFcxqHr9V\">Simple auto-update for server</a>.</p><ul><li><p>Run as the same User Trilium runs.</p><ul><li>If you run as <code>root</code> please remove <code>sudo</code> from the commands.</li></ul></li><li><p>Requires <code>jq</code>:</p><pre><code class=\"language-text-x-sh\">apt install jq</code></pre></li></ul><p>It will stop the service above, overwrite everything (expecting no <code>config.ini</code>), and start service. It also creates a version file in the Trilium directory so it updates only with a newer version.</p><h2>Common issues</h2><h3>Outdated glibc</h3><pre><code class=\"language-text-x-trilium-auto\">Error: /usr/lib64/libstdc++.so.6: version `GLIBCXX_3.4.21' not found (required by /var/www/virtual/.../node_modules/@mlink/scrypt/build/Release/scrypt.node)\n at Object.Module._extensions..node (module.js:681:18)\n at Module.load (module.js:565:32)\n at tryModuleLoad (module.js:505:12)</code></pre><p>If you get an error like this, you need to either upgrade your glibc (typically by upgrading to up-to-date distribution version) or use some other <a href=\"#root/_help_WOcw2SLH6tbX\">server installation</a> method.</p><h2>TLS</h2><p>Don't forget to <a href=\"#root/_help_l2VkvOwUNfZj\">configure TLS</a>, which is required for secure usage!</p>",
++ "_help_ZNAjFcxqHr9V": "#!/bin/bash\n\n# Configuration\nREPO=\"TriliumNext/Trilium\"\nPATTERN=\"TriliumNotes-Server-.*-linux-x64.tar.xz\"\nDOWNLOAD_DIR=\"/var/tmp/trilium_download\"\nOUTPUT_DIR=\"/opt/trilium\"\nSERVICE_NAME=\"trilium\"\nVERSION_FILE=\"$OUTPUT_DIR/version.txt\"\n\n# Ensure dependencies are installed\ncommand -v curl >/dev/null 2>&1 || { echo \"Error: curl is required\"; exit 1; }\ncommand -v jq >/dev/null 2>&1 || { echo \"Error: jq is required\"; exit 1; }\ncommand -v tar >/dev/null 2>&1 || { echo \"Error: tar is required\"; exit 1; }\n\n# Create download directory\nmkdir -p \"$DOWNLOAD_DIR\" || { echo \"Error: Cannot create $DOWNLOAD_DIR\"; exit 1; }\n\n# Get the latest release version\nLATEST_VERSION=$(curl -sL https://api.github.com/repos/$REPO/releases/latest | jq -r '.tag_name')\nif [ -z \"$LATEST_VERSION\" ]; then\n echo \"Error: Could not fetch latest release version\"\n exit 1\nfi\n\n# Check current installed version (from version.txt or existing tarball)\nCURRENT_VERSION=\"\"\nif [ -f \"$VERSION_FILE\" ]; then\n CURRENT_VERSION=$(cat \"$VERSION_FILE\")\nelif [ -f \"$DOWNLOAD_DIR/TriliumNotes-Server-$LATEST_VERSION-linux-x64.tar.xz\" ]; then\n CURRENT_VERSION=\"$LATEST_VERSION\"\nfi\n\n# Compare versions\nif [ \"$CURRENT_VERSION\" = \"$LATEST_VERSION\" ]; then\n echo \"Latest version ($LATEST_VERSION) is already installed\"\n exit 0\nfi\n\n# Download the latest release\nLATEST_URL=$(curl -sL https://api.github.com/repos/$REPO/releases/latest | jq -r \".assets[] | select(.name | test(\\\"$PATTERN\\\")) | .browser_download_url\")\nif [ -z \"$LATEST_URL\" ]; then\n echo \"Error: No asset found matching pattern '$PATTERN'\"\n exit 1\nfi\n\nFILE_NAME=$(basename \"$LATEST_URL\")\nFILE_PATH=\"$DOWNLOAD_DIR/$FILE_NAME\"\n\n# Download if not already present\nif [ -f \"$FILE_PATH\" ]; then\n echo \"Latest release $FILE_NAME already downloaded\"\nelse\n curl -LO --output-dir \"$DOWNLOAD_DIR\" \"$LATEST_URL\" || { echo \"Error: Download failed\"; exit 1; }\n echo \"Downloaded $FILE_NAME to $DOWNLOAD_DIR\"\nfi\n\n# Extract the tarball\nEXTRACT_DIR=\"$DOWNLOAD_DIR/extracted\"\nmkdir -p \"$EXTRACT_DIR\"\ntar -xJf \"$FILE_PATH\" -C \"$EXTRACT_DIR\" || { echo \"Error: Extraction failed\"; exit 1; }\n\n# Find the extracted directory (e.g., TriliumNotes-Server-0.97.2-linux-x64)\nINNER_DIR=$(find \"$EXTRACT_DIR\" -maxdepth 1 -type d -name \"TriliumNotes-Server-*-linux-x64\" | head -n 1)\nif [ -z \"$INNER_DIR\" ]; then\n echo \"Error: Could not find extracted directory matching TriliumNotes-Server-*-linux-x64\"\n exit 1\nfi\n\n# Stop the trilium-server service\nif systemctl is-active --quiet \"$SERVICE_NAME\"; then\n echo \"Stopping $SERVICE_NAME service...\"\n sudo systemctl stop \"$SERVICE_NAME\" || { echo \"Error: Failed to stop $SERVICE_NAME\"; exit 1; }\nfi\n\n# Copy contents to /opt/trilium, overwriting existing files\necho \"Copying contents from $INNER_DIR to $OUTPUT_DIR...\"\nsudo mkdir -p \"$OUTPUT_DIR\"\nsudo cp -r \"$INNER_DIR\"/* \"$OUTPUT_DIR\"/ || { echo \"Error: Copy failed\"; exit 1; }\necho \"$LATEST_VERSION\" | sudo tee \"$VERSION_FILE\" >/dev/null\necho \"Files copied to $OUTPUT_DIR\"\n\n# Start the trilium-server service\necho \"Starting $SERVICE_NAME service...\"\nsudo systemctl start \"$SERVICE_NAME\" || { echo \"Error: Failed to start $SERVICE_NAME\"; exit 1; }\n\n# Clean up\nrm -rf \"$EXTRACT_DIR\"\necho \"Cleanup complete. Trilium updated to $LATEST_VERSION.\"",
++ "_help_rWX5eY045zbE": "<p>Official docker images are published on docker hub for <strong>AMD64</strong>, <strong>ARMv7</strong> and <strong>ARM64/v8</strong>: <a href=\"https://hub.docker.com/r/triliumnext/trilium/\">https://hub.docker.com/r/triliumnext/trilium/</a></p><h2>Prerequisites</h2><p>Ensure Docker is installed on your system.</p><p>If you need help installing Docker, reference the <a href=\"https://docs.docker.com/engine/install/\">Docker Installation Docs</a></p><p>By default, the container starts as root, prepares the data directory and then runs Trilium as an unprivileged user. It can also run entirely without root, as described in <em>Running as a non-root user</em> below.</p><aside class=\"admonition warning\"><p>If you're using a SMB/CIFS share or folder as your Trilium data directory, <a href=\"https://github.com/TriliumNext/Notes/issues/415#issuecomment-2344824400\">you'll need</a> to add the mount options of <code>nobrl</code> and <code>noperm</code> when mounting your SMB share.</p></aside><h2>Running with Docker Compose</h2><h3>Grab the latest docker-compose.yml:</h3><pre><code class=\"language-text-x-trilium-auto\">wget https://raw.githubusercontent.com/TriliumNext/Trilium/master/docker-compose.yml</code></pre><p>Optionally, edit the <code>docker-compose.yml</code> file to configure the container settings prior to starting it. Unless configured otherwise, the data directory will be <code>trilium-data</code> next to <code>docker-compose.yml</code> and the container will be accessible at port 8080.</p><p>To keep the data somewhere else, edit the <code>volumes</code> entry in <code>docker-compose.yml</code> and change the host path before the colon (for example <code>- /srv/trilium-data:/home/node/trilium-data</code>). Leave the path after the colon unchanged.</p><h3>Start the container:</h3><p>Run the following command to start the container in the background:</p><pre><code class=\"language-text-x-trilium-auto\">docker compose up -d</code></pre><h2>Running without Docker Compose / Further Configuration</h2><h3>Pulling the Docker Image</h3><p>To pull the image, use the following command, replacing <code>[VERSION]</code> with the desired version or tag, such as <code>v0.91.6</code> or just <code>latest</code>. (See published tag names at <a href=\"https://hub.docker.com/r/triliumnext/trilium/tags\">https://hub.docker.com/r/triliumnext/trilium/tags</a>.):</p><pre><code class=\"language-text-x-trilium-auto\">docker pull triliumnext/trilium:v0.91.6</code></pre><p><strong>Warning:</strong> Avoid using the \"latest\" tag, as it may automatically upgrade your instance to a new minor version, potentially disrupting sync setups or causing other issues.</p><h3>Preparing the Data Directory</h3><p>Trilium requires a directory on the host system to store its data. This directory must be mounted into the Docker container with write permissions.</p><h3>Running the Docker Container</h3><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Local Access Only</p><div class=\"trilium-tab-panel\"><p>Run the container to make it accessible only from the localhost. This setup is suitable for testing or when using a proxy server like Nginx or Apache.</p><pre><code class=\"language-text-x-sh\">sudo docker run -t -i -p 127.0.0.1:8080:8080 \\\n\t-v ~/trilium-data:/home/node/trilium-data \\\n\ttriliumnext/trilium:[VERSION]</code></pre><ol><li>Verify the container is running using <code>docker ps</code>.</li><li>Access Trilium via a web browser at <code>127.0.0.1:8080</code>.</li></ol></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Local Network Access</p><div class=\"trilium-tab-panel\"><p>To make the container accessible only on your local network, first create a new Docker network:</p><pre><code class=\"language-text-x-sh\">docker network create -d macvlan -o parent=eth0 --subnet 192.168.2.0/24 --gateway 192.168.2.254 --ip-range 192.168.2.252/27 mynet</code></pre><p>Then, run the container with the network settings:</p><pre><code class=\"language-text-x-sh\">docker run --net=mynet -d -p 127.0.0.1:8080:8080 -v ~/trilium-data:/home/node/trilium-data triliumnext/trilium:-latest</code></pre><p>To set a different user ID (UID) and group ID (GID) for the saved data, use the <code>USER_UID</code> and <code>USER_GID</code> environment variables:</p><pre><code class=\"language-text-x-sh\">docker run --net=mynet -d -p 127.0.0.1:8080:8080 -e \"USER_UID=1001\" -e \"USER_GID=1001\" -v ~/trilium-data:/home/node/trilium-data triliumnext/trilium:-latest</code></pre><p>Find the local IP address using <code>docker inspect [container_name]</code> and access the service from devices on the local network.</p><pre><code class=\"language-text-x-sh\">docker ps\ndocker inspect [container_name]</code></pre></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Global Access</p><div class=\"trilium-tab-panel\"><p>To allow access from any IP address, run the container as follows:</p><pre><code class=\"language-text-x-sh\">docker run -d -p 0.0.0.0:8080:8080 \\\n\t-v ~/trilium-data:/home/node/trilium-data \\\n\ttriliumnext/trilium:[VERSION]</code></pre><p>Stop the container with <code>docker stop &lt;CONTAINER ID&gt;</code>, where the container ID is obtained from <code>docker ps</code>.</p></div></section></div><h3>Custom Data Directory</h3><p>For a custom data directory, use:</p><pre><code class=\"language-text-x-trilium-auto\">-v ~/YourOwnDirectory:/home/node/trilium-data triliumnext/trilium:[VERSION]</code></pre><p>If you want to run your instance in a non-default way, please use the volume switch as follows: <code>-v ~/YourOwnDirectory:/home/node/trilium-data triliumnext/trilium:&lt;VERSION&gt;</code>. It is important to be aware of how Docker works for volumes, with the first path being your own and the second the one to virtually bind to. <a href=\"https://docs.docker.com/storage/volumes/\">https://docs.docker.com/storage/volumes/</a> The path before the colon is the host directory, and the path after the colon is the container's path. More details can be found in the <a href=\"https://docs.docker.com/storage/volumes/\">Docker Volumes Documentation</a>.</p><h2>Reverse Proxy</h2><ol><li><a href=\"#root/_help_ud6MShXL4WpO\">Nginx</a></li><li><a href=\"#root/_help_fDLvzOx29Pfg\">Apache</a></li></ol><h3>Note on timezones</h3><p>If you are having timezone issues and you are not using docker-compose, you may need to add a <code>TZ</code> environment variable with the <a href=\"https://en.wikipedia.org/wiki/List_of_tz_database_time_zones\">TZ identifier</a> of your local timezone.</p><h3>Other environment variables</h3><p>For the complete list of environment variables Trilium reads (network settings, authentication, sync, etc.), see&nbsp;<a class=\"reference-link\" href=\"#root/_help_Gzjqa934BdH4\">Configuration (config.ini or environment variables)</a>.</p><h2>Running as a non-root user</h2><p>By default, the container starts as root, gives the data directory to the <code>node</code> user (UID and GID <code>1000</code>, or the values of <code>USER_UID</code> and <code>USER_GID</code>) and then runs Trilium as that user. Some environments do not allow a container to start as root at all, for example rootless Docker or Podman, or Kubernetes with <code>runAsNonRoot</code>. Starting with v0.107.0, the same image can run entirely as a non-root user instead.</p><p>To run Trilium as a non-root user, set the user with Docker's <code>--user</code> flag:</p><pre><code class=\"language-text-x-sh\">docker run -d -p 8080:8080 --user 1000:1000 -v /srv/trilium-data:/home/node/trilium-data triliumnext/trilium:[VERSION]</code></pre><p>With Docker Compose, add <code>user:</code> to the service in <code>docker-compose.yml</code>:</p><pre><code class=\"language-text-x-yaml\">services:\n trilium:\n user: \"1000:1000\"</code></pre><p>The image also runs with a read-only root filesystem and without any capabilities, for example with <code>--read-only --tmpfs /tmp --cap-drop ALL --security-opt no-new-privileges</code>.</p><p>Without root, the container cannot change the ownership of files, so:</p><ul><li><p>The data directory on the host must exist and belong to that user before the container starts. If the directory is missing, Docker creates it as root, and Trilium cannot write to it. For example:</p><pre><code class=\"language-text-x-sh\">mkdir -p /srv/trilium-data\nsudo chown 1000:1000 /srv/trilium-data</code></pre></li><li><p>A named volume instead of a host directory only works for UID <code>1000</code>: Docker gives a new volume the owner of the image's data directory, which is the <code>node</code> user.</p></li><li><p><code>USER_UID</code> and <code>USER_GID</code> are ignored. The user comes from <code>--user</code> or <code>user:</code> alone.</p></li></ul><p>If Trilium cannot use its data directory, it stops at startup and prints which directory or files it cannot use, who owns them, and the command that fixes it.</p><aside class=\"admonition note\"><p>An installation that ran as root leaves its files owned by UID <code>1000</code>, or by <code>USER_UID</code> if it was set. To switch it to <code>--user</code>, either use that same UID, or give the data directory to the new user first, for example with <code>sudo chown -R 1001:1001 /srv/trilium-data</code>.</p></aside>",
++ "_help_moVgBcoxE3EK": "<p>This page describes configuring the Trilium module included in NixOS.</p><h2>Requirements</h2><p><a href=\"https://nixos.org/\">NixOS</a> installation.</p><h2>Configuration</h2><p>Add this to your <code>configuration.nix</code>:</p><pre><code class=\"language-text-x-trilium-auto\">services.trilium-server.enable = true;\n\n# default data directory: /var/lib/trilium\n#services.trilium-server.dataDir = \"/var/lib/trilium-sync-server\";\n\n# default bind address: 127.0.0.1, port 8080\n#services.trilium-server.host = \"0.0.0.0\";\n#services.trilium-server.port = 12783;</code></pre><p>Uncomment any option you would like to change.</p><p>See the <a href=\"https://search.nixos.org/options?channel=unstable&amp;from=0&amp;size=50&amp;sort=relevance&amp;type=packages&amp;query=trilium-server\">NixOS options list</a> for more options (including nginx reverse proxy configuration).</p>",
++ "_help_J1Bb6lVlwU5T": "<aside class=\"admonition warning\"><p>This page describes manually installing Trilium on your server. <strong>Note that this is a not well supported way to install Trilium, problems may appear, information laid out here is quite out of date. It is recommended to use either</strong>&nbsp;<a class=\"reference-link\" href=\"#root/_help_rWX5eY045zbE\">Docker Server Installation</a>&nbsp;<strong>or</strong>&nbsp;<a class=\"reference-link\" href=\"#root/_help_3tW6mORuTHnB\">Packaged server installation</a><strong>.</strong></p></aside><h2>Requirements</h2><p>Trilium is a node.js application. Supported (tested) version of node.js is latest 14.X.X and 16.X.X. Trilium might work with older versions as well.</p><p>You can check your node version with this command (node.js needs to be installed):</p><pre><code class=\"language-text-x-trilium-auto\">node --version</code></pre><p>If your Linux distribution has only an outdated version of node.js, you can take a look at the installation instruction on node.js website, which covers most popular distributions.</p><h3>Dependencies</h3><p>There are some dependencies required. You can see command for Debian and its derivatives (like Ubuntu) below:</p><pre><code class=\"language-text-x-trilium-auto\">sudo apt install libpng16-16 libpng-dev pkg-config autoconf libtool build-essential nasm libx11-dev libxkbfile-dev</code></pre><h2>Installation</h2><h3>Download</h3><p>You can either download source code zip/tar from <a href=\"https://github.com/TriliumNext/Trilium/releases/latest\">https://github.com/TriliumNext/Trilium/releases/latest</a>.</p><p>For the latest version including betas, clone Git repository <strong>from</strong> <code>main</code> <strong>branch</strong> with:</p><pre><code class=\"language-text-x-trilium-auto\">git clone -b main https://github.com/triliumnext/trilium.git</code></pre><h2>Installation</h2><pre><code class=\"language-text-x-trilium-auto\">cd trilium\n\n# download all node dependencies\nnpm install\n\n# make sure the better-sqlite3 binary is there\nnpm rebuild\n\n# bundles &amp; minifies frontend JavaScript\nnpm run webpack</code></pre><h2>Run</h2><pre><code class=\"language-text-x-trilium-auto\">cd trilium\n\n# using nohup to make sure trilium keeps running after user logs out\nnohup TRILIUM_ENV=dev node src/www &amp;</code></pre><p>The application by default starts up on port 8080, so you can open your browser and navigate to <a href=\"http://localhost:8080\">http://localhost:8080</a> to access Trilium (replace \"localhost\" with your hostname).</p><h2>TLS</h2><p>Don't forget to <a href=\"#root/_help_l2VkvOwUNfZj\">configure TLS</a> which is required for secure usage!</p>",
++ "_help_DCmT6e7clMoP": "<p>As Trilium can be run in Docker it also can be deployed in Kubernetes. You can either use our Helm chart, a community Helm chart, or roll your own Kubernetes deployment.</p><p>The recommended way is to use a Helm chart.</p><h2>Root privileges</h2><p>By default, the Trilium container starts as root, gives the data directory to UID and GID <code>1000:1000</code> and then runs Trilium with those reduced privileges, so no init container is needed to fix the permissions. To use a different UID and GID, set the <code>USER_UID</code> and <code>USER_GID</code> environment variables.</p><p>Starting with v0.107.0, the container can also run without root, which a <code>restricted</code> Pod Security Standard requires. Set the user in the pod's security context, and <code>fsGroup</code> so that Kubernetes gives the volume to that group:</p><pre><code class=\"language-text-x-yaml\">securityContext:\n runAsUser: 1000\n runAsGroup: 1000\n runAsNonRoot: true\n fsGroup: 1000</code></pre><p>In that mode <code>USER_UID</code> and <code>USER_GID</code> are ignored. See the section on running as a non-root user in&nbsp;<a class=\"reference-link\" href=\"#root/_help_rWX5eY045zbE\">Using Docker</a> for what the data directory needs.</p><h2>Helm Charts</h2><p><a href=\"https://github.com/TriliumNext/helm-charts\">Official Helm chart</a> from TriliumNext Unofficial helm chart by <a href=\"https://github.com/ohdearaugustin\">ohdearaugustin</a>: <a href=\"https://github.com/ohdearaugustin/charts\">https://github.com/ohdearaugustin/charts</a></p><h2>Adding a Helm repository</h2><p>Below is an example of how</p><pre><code class=\"language-text-x-trilium-auto\">helm repo add trilium https://triliumnext.github.io/helm-charts\n\"trilium\" has been added to your repositories</code></pre><h2>How to install a chart</h2><p>After reviewing the <a href=\"https://github.com/TriliumNext/helm-charts/blob/main/charts/trilium/values.yaml\"><code>values.yaml</code></a> from the Helm chart, modifying as required and then creating your own:</p><pre><code class=\"language-text-x-trilium-auto\">helm install --create-namespace --namespace trilium trilium trilium/trilium -f values.yaml</code></pre><p>For more information on using Helm, please refer to the Helm documentation, or create a Discussion in the TriliumNext GitHub Organization.</p>",
++ "_help_klCWNks3ReaQ": "<p>Trilium does not support multiple users. In order to have two or more persons with their own set of notes, multiple server instances must be set up. It is also not possible to use multiple <a href=\"#root/_help_cbkrhQjrkKrh\">sync</a> servers.</p><p>To allow multiple server instances on a single physical server:</p><ul><li><p>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_3tW6mORuTHnB\">Packaged version for Linux</a>&nbsp;or&nbsp;<a class=\"reference-link\" href=\"#root/_help_J1Bb6lVlwU5T\">Manually</a>, if starting the server manually just specify a different port and data directory per instance:</p><pre><code class=\"language-text-x-trilium-auto\">TRILIUM_NETWORK_PORT=8080 TRILIUM_DATA_DIR=/path/to/your/data-dir-A /opt/trilium/trilium.sh</code></pre><p>For a second instance:</p><pre><code class=\"language-text-x-trilium-auto\">TRILIUM_NETWORK_PORT=8081 TRILIUM_DATA_DIR=/path/to/your/data-dir-B /opt/trilium/trilium.sh</code></pre><p>If using <code>systemd</code>, then set the <a href=\"https://serverfault.com/questions/413397/how-to-set-environment-variable-in-systemd-service\">environment variables in the service configuration</a>.</p></li><li><p>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_rWX5eY045zbE\">Using Docker</a>, simply use two different containers, each with their own port binding and data directory.</p></li><li><p>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_moVgBcoxE3EK\">On NixOS</a>, the only possible way is to use Docker OCI containers or at least one NixOS container with its own service definition.</p></li></ul><p>For support or additional context, see the related <a href=\"https://github.com/orgs/TriliumNext/discussions/1642#discussioncomment-12768808\">GitHub Discussion</a>.</p>",
++ "_help_vcjrb3VVYPZI": "<p>Trilium is typically exposed to the internet behind a <strong>reverse proxy</strong>, which handles TLS termination, presents a single public entry point, and (optionally) lets you host multiple instances under one domain. Trilium itself keeps running on plain HTTP on its local port; the proxy sits in front of it.</p><p>This section collects provider-specific guides and the configuration that applies regardless of which proxy you use.</p><h2>Provider guides</h2><ul><li><a class=\"reference-link\" href=\"#root/_help_ud6MShXL4WpO\">Nginx</a></li><li><a class=\"reference-link\" href=\"#root/_help_5ERVJb9s4FRD\">Traefik</a></li><li><a class=\"reference-link\" href=\"#root/_help_fDLvzOx29Pfg\">Apache using Docker</a></li></ul><h2>Applies to every proxy</h2><p>Regardless of the proxy you choose, make sure of the following:</p><ul><li><strong>Forward the WebSocket upgrade.</strong> Trilium uses a WebSocket for synchronization and live UI updates. Your proxy must pass the <code>Upgrade</code> and <code>Connection</code> headers through, otherwise the client will appear to load but never receive updates.</li><li><strong>Configure the trusted proxy.</strong> So that Trilium sees the real client IP (for rate limiting, logging, and secure cookies) rather than the proxy's address. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_LLzSMXACKhUs\">Trusted proxy</a>.</li><li><strong>Terminate TLS at the proxy.</strong> See&nbsp;<a class=\"reference-link\" href=\"#root/_help_l2VkvOwUNfZj\">HTTPS (TLS)</a>.</li></ul><h2>Putting an authentication proxy in front of Trilium</h2><p>Some setups place a <strong>forward-auth / SSO layer</strong> (Authelia, Authentik, oauth2-proxy, or an OIDC plugin) at the proxy so that <em>every</em> request must pass an interactive login first.</p><p>This <strong>breaks synchronization and initial setup.</strong> Sync is a machine-to-machine process that runs unattended in the background — it has no browser and cannot complete an interactive login challenge. When the proxy intercepts a sync request, it returns its HTML login page instead of the expected JSON, and the client fails with an error such as:</p><pre><code class=\"language-text-x-trilium-auto\">Sync failed: Request to GET https://trilium.example.com/api/setup/status failed,\nerror: Unexpected token '&lt;', \"&lt;!doctype \"... is not valid JSON\n</code></pre><p>There are two ways to resolve this:</p><ul><li><strong>Preferred, use Trilium's built-in authentication.</strong> Don't gate Trilium at the proxy at all. Trilium can authenticate the web interface itself, including via <a href=\"#root/_help_x1lQNKQBqLcA\">OpenID Connect</a>. This leaves the sync endpoints free to authenticate the way they're designed to.</li><li><strong>Exempt the sync endpoints from the proxy's authentication.</strong> If you must keep auth at the proxy, exclude these paths from the forward-auth check:<ul><li><code>/api/setup/*</code></li><li><code>/api/login/sync</code></li><li><code>/api/sync/*</code></li></ul></li></ul><aside class=\"admonition note\"><p>This is safe: Trilium authenticates these endpoints itself. Sync uses a challenge-free HMAC handshake based on a shared secret, and the one-time setup seed request is password-protected — so exempting them at the proxy does not expose unauthenticated access to your data.</p></aside><p>An example for Nginx, where <code>/auth</code> is your forward-auth endpoint:</p><pre><code class=\"language-text-x-trilium-auto\">server {\n # ... TLS, server_name, etc. ...\n\n # Sync and setup endpoints authenticate themselves — skip forward-auth.\n location ~ ^/api/(sync|login/sync|setup) {\n auth_request off;\n proxy_set_header Host $host;\n proxy_set_header X-Real-IP $remote_addr;\n proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\n proxy_set_header X-Forwarded-Proto $scheme;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection \"upgrade\";\n proxy_pass http://trilium;\n }\n\n # Everything else goes through forward-auth.\n location / {\n auth_request /auth;\n proxy_set_header Host $host;\n proxy_set_header X-Real-IP $remote_addr;\n proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\n proxy_set_header X-Forwarded-Proto $scheme;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection \"upgrade\";\n proxy_pass http://trilium;\n }\n}</code></pre>",
++ "_help_ud6MShXL4WpO": "<p>Configure Nginx proxy and HTTPS. The operating system here is Ubuntu.</p><h2>Installing Nginx</h2><p>Download Nginx and remove Apache2</p><pre><code class=\"language-text-x-trilium-auto\">sudo apt-get install nginx\nsudo apt-get remove apache2</code></pre><h2>Build the configuration file</h2><ol><li><p>First, create the configuration file:</p><pre><code class=\"language-text-x-trilium-auto\">cd /etc/nginx/conf.d\nvim default.conf</code></pre></li><li><p>Fill the file with the context shown below, part of the setting show be changed. Then you can enjoy your web with HTTPS forced and proxy.</p><pre><code class=\"language-text-x-trilium-auto\"># This part configures, where your Trilium server is running\nupstream trilium {\n zone trilium 64k;\n server 127.0.0.1:8080; # change it to a different hostname and port if non-default is used\n keepalive 2;\n}\n\n# This part is for proxy and HTTPS configure\nserver {\n listen 443 ssl;\n server_name trilium.example.net; #change trilium.example.net to your domain without HTTPS or HTTP.\n ssl_certificate /etc/ssl/note/example.crt; #change /etc/ssl/note/example.crt to your path of crt file.\n ssl_certificate_key /etc/ssl/note/example.net.key; #change /etc/ssl/note/example.net.key to your path of key file.\n ssl_session_cache builtin:1000 shared:SSL:10m;\n ssl_protocols TLSv1 TLSv1.1 TLSv1.2;\n ssl_ciphers HIGH:!aNULL:!eNULL:!EXPORT:!CAMELLIA:!DES:!MD5:!PSK:!RC4;\n ssl_prefer_server_ciphers on;\n access_log /var/log/nginx/access.log; #check the path of access.log, if it doesn't fit your file, change it\n\n location / {\n proxy_set_header Host $host;\n proxy_set_header X-Real-IP $remote_addr;\n proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\n proxy_set_header X-Forwarded-Proto $scheme;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection \"upgrade\";\n proxy_pass http://trilium;\n proxy_read_timeout 90;\n }\n}\n\n# This part is for HTTPS forced\nserver {\n listen 80;\n server_name trilium.example.net; # change to your domain\n return 301 https://$server_name$request_uri;\n}</code></pre></li></ol><h2>Serving under a different path</h2><p>Alternatively if you want to serve the instance under a different path (useful e.g. if you want to serve multiple instances), update the location block like so:</p><ul><li>update the location with your desired path (make sure to not leave a trailing slash \"/\", if your <code>proxy_pass</code> does not end on a slash as well)</li><li>add the <code>proxy_cookie_path</code> directive with the same path: this allows you to stay logged in at multiple instances at the same time.</li></ul><pre><code class=\"language-text-x-trilium-auto\"> location /trilium/instance-one {\n rewrite /trilium/instance-one/(.*) /$1 break;\n proxy_set_header Host $host;\n proxy_set_header X-Real-IP $remote_addr;\n proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\n proxy_set_header X-Forwarded-Proto $scheme;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection \"upgrade\";\n proxy_pass http://trilium;\n proxy_cookie_path / /trilium/instance-one\n proxy_read_timeout 90;\n }</code></pre><h2>Configuring the trusted proxy</h2><p>After setting up a reverse proxy, make sure to configure the&nbsp;<a class=\"reference-link\" href=\"#root/_help_LLzSMXACKhUs\">Trusted proxy</a>.</p>",
++ "_help_fDLvzOx29Pfg": "<p>This tutorial assumes that you have created a DNS A record for <code>trilium.yourdomain.com</code> that you want to use for your Trilium server.</p><h2>Docker setup</h2><p>Download docker image and create container</p><pre><code class=\"language-text-x-trilium-auto\"> docker pull triliumnext/trilium:[VERSION]\n docker create --name trilium -t -p 127.0.0.1:8080:8080 -v ~/trilium-data:/home/node/trilium-data triliumnext/trilium:[VERSION]</code></pre><h2>Configuring the Apache proxy</h2><ol><li><p>Enable apache proxy modules</p><pre><code class=\"language-text-x-trilium-auto\"> a2enmod ssl\n a2enmod proxy\n a2enmod proxy_http\n a2enmod proxy_wstunnel</code></pre></li><li><p>Create a new let's encrypt certificate</p><pre><code class=\"language-text-x-trilium-auto\"> sudo certbot certonly -d trilium.mydomain.com</code></pre><p>Choose standalone (2) and note the location of the created certificates (typically /etc/letsencrypt/live/...)</p></li><li><p>Create a new virtual host file for apache (you may want to use <code>apachectl -S</code> to determine the server root location, mine is /etc/apache2)</p><pre><code class=\"language-text-x-trilium-auto\"> sudo nano /etc/apache2/sites-available/trilium.yourdomain.com.conf</code></pre><p>Paste (and customize) the following text into the configuration file</p><pre><code class=\"language-text-x-trilium-auto\"> \n ServerName http://trilium.yourdomain.com\n RewriteEngine on\n RewriteRule ^ https://%{SERVER_NAME}%{REQUEST_URI} [END,QSA,R=permanent]\n \n \n ServerName https://trilium.yourdomain.com\n RewriteEngine On\n RewriteCond %{HTTP:Connection} Upgrade [NC]\n RewriteCond %{HTTP:Upgrade} websocket [NC]\n RewriteRule /(.*) ws://localhost:8080/$1 [P,L]\n AllowEncodedSlashes NoDecode\n ProxyPass / http://localhost:8080/ nocanon\n ProxyPassReverse / http://localhost:8080/\n SSLCertificateFile /etc/letsencrypt/live/trilium.yourdomain.com/fullchain.pem\n SSLCertificateKeyFile /etc/letsencrypt/live/trilium.yourdomain.com/privkey.pem\n Include /etc/letsencrypt/options-ssl-apache.conf\n </code></pre></li><li><p>Enable the virtual host with <code>sudo a2ensite trilium.yourdomain.com.conf</code></p></li><li><p>Reload apache2 with <code>sudo systemctl reload apache2</code></p></li></ol><h2>Configuring the trusted proxy</h2><p>After setting up a reverse proxy, make sure to configure the&nbsp;<a class=\"reference-link\" href=\"#root/_help_LLzSMXACKhUs\">Trusted proxy</a>.</p><h2>Setup the systemd service to start up the server</h2><p>Create and enable a systemd service to start the docker container on boot</p><ol><li><p>Create a new empty file called <code>/lib/systemd/system/trilium.service</code> with the contents</p><pre><code class=\"language-text-x-trilium-auto\"> [Unit]\n Description=Trilium Server\n Requires=docker.service\n After=docker.service\n\n [Service]\n Restart=always\n ExecStart=/usr/bin/docker start -a trilium\n ExecStop=/usr/bin/docker stop -t 2 trilium\n\n [Install]\n WantedBy=local.target</code></pre></li><li><p>Install, enable and start service</p><pre><code class=\"language-text-x-trilium-auto\"> sudo systemctl daemon-reload\n sudo systemctl enable trilium.service\n sudo systemctl start trilium.service</code></pre></li></ol>",
++ "_help_LLzSMXACKhUs": "<p>If you are running the Trilium server under a <a href=\"#root/_help_vcjrb3VVYPZI\">reverse proxy</a>, it's important to configure it as a trusted proxy so that the application can correctly identify the real IP address of the clients (for authentication and rate limiting purposes).</p><p>To do so, simply modify&nbsp;<a class=\"reference-link\" href=\"#root/_help_Gzjqa934BdH4\">Configuration (config.ini or environment variables)</a>&nbsp;and set:</p><pre><code class=\"language-text-x-trilium-auto\">[Network]\ntrustedReverseProxy=true</code></pre><p>This will use the left-most IP in the <code>X-Forwarded-For</code> header. Alternatively, instead of <code>true</code> use the IP address of the reverse proxy or Express.js shortcuts such as:</p><pre><code class=\"language-text-x-trilium-auto\">loopback(127.0.0.1/8, ::1/128), linklocal(169.254.0.0/16, fe80::/10), uniquelocal(10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16, fc00::/7)</code></pre><p>For more information, consult <a href=\"https://expressjs.com/en/guide/behind-proxies.html\">Express behind proxies</a>.</p>",
++ "_help_5ERVJb9s4FRD": "<p>The goal of this article is to configure Traefik proxy and HTTPS. See <a href=\"https://github.com/TriliumNext/Trilium/issues/7768#issuecomment-3539165814\">#7768</a> for reference.</p><h2>Breaking change in Traefik 3.6.4</h2><p>Traefik 3.6.4 introduced a <a href=\"https://doc.traefik.io/traefik/migrate/v3/#encoded-characters-in-request-path\">breaking change</a> regarding how percent-encoded characters are handled in URLs. Trilium puts the title of an image or attachment in its URL path, so one whose title contains <code>#</code> or <code>/</code> is requested at a path such as <code>/api/images/…/diagram%231.png</code>. Traefik rejects these paths with HTTP 400, and the image does not load. Search is not affected, because it sends its text in a query parameter.</p><p>The easiest solution is to update to Traefik 3.6.7 or later which reverts this configuration change. Alternatively, the configuration can be changed according to the section below.</p><details class=\"trilium-collapsible\"><summary>Configuration change</summary><p>To solve this, the Traefik <a href=\"https://doc.traefik.io/traefik/getting-started/configuration-overview/#the-install-configuration\"><strong>static</strong> configuration</a> must be modified in order to allow those characters:</p><pre><code class=\"language-text-x-yaml\">entryPoints:\n web:\n http:\n encodedCharacters:\n allowEncodedSlash: true\n allowEncodedHash: true</code></pre><aside class=\"admonition tip\"><p>If images still fail to load, you might need to enable more encoded character groups. For more information, see <a href=\"https://github.com/TriliumNext/Trilium/issues/7968\">the relevant GitHub issue</a>; feel free to report your findings.</p></aside></details><h3>Build the docker-compose file</h3><p>Setting up Traefik as reverse proxy requires setting the following labels:</p><pre><code class=\"language-text-x-yaml\"> labels:\n - traefik.enable=true\n - traefik.http.routers.trilium.entrypoints=https\n - traefik.http.routers.trilium.rule=Host(`trilium.mydomain.tld`)\n - traefik.http.routers.trilium.tls=true\n - traefik.http.routers.trilium.service=trilium\n - traefik.http.services.trilium.loadbalancer.server.port=8080\n # scheme must be HTTP instead of the usual HTTPS because Trilium listens on HTTP internally\n - traefik.http.services.trilium.loadbalancer.server.scheme=http\n - traefik.docker.network=proxy\n # forward HTTP to HTTPS\n - traefik.http.routers.trilium.middlewares=trilium-headers@docker\n - traefik.http.middlewares.trilium-headers.headers.customrequestheaders.X-Forwarded-Proto=https</code></pre><h3>Setup needed environment variables</h3><p>After setting up a reverse proxy, make sure to configure the&nbsp;<a class=\"reference-link\" href=\"#root/_help_LLzSMXACKhUs\">Trusted proxy</a>.</p><h3>Example <code>docker-compose.yaml</code></h3><pre><code class=\"language-text-x-yaml\">services:\n trilium:\n image: triliumnext/trilium\n container_name: trilium\n networks:\n - traefik-proxy\n environment:\n - TRILIUM_NETWORK_TRUSTEDREVERSEPROXY=my-traefik-host-ip # e.g., 172.18.0.0/16\n volumes:\n - /path/to/data:/home/node/trilium-data\n - /etc/timezone:/etc/timezone:ro\n - /etc/localtime:/etc/localtime:ro\n labels:\n - traefik.enable=true\n - traefik.http.routers.trilium.entrypoints=https\n - traefik.http.routers.trilium.rule=Host(`trilium.mydomain.tld`)\n - traefik.http.routers.trilium.tls=true\n - traefik.http.routers.trilium.service=trilium\n - traefik.http.services.trilium.loadbalancer.server.port=8080\n # scheme must be HTTP instead of the usual HTTPS because of how trilium works\n - traefik.http.services.trilium.loadbalancer.server.scheme=http\n - traefik.docker.network=traefik-proxy\n # Tell Trilium the original request was HTTPS\n - traefik.http.routers.trilium.middlewares=trilium-headers@docker\n - traefik.http.middlewares.trilium-headers.headers.customrequestheaders.X-Forwarded-Proto=https\n\nnetworks:\n traefik-proxy:\n external: true</code></pre>",
++ "_help_l2VkvOwUNfZj": "<p>Configuring TLS is essential for <a href=\"#root/_help_WOcw2SLH6tbX\">server installation</a> in Trilium. This guide details the steps to set up TLS within Trilium itself.</p><aside class=\"admonition tip\"><p>While Trilium supports HTTPS on its own, it's generally a good idea to use a <a href=\"#root/_help_vcjrb3VVYPZI\">reverse proxy</a> instead with TLS termination. You can follow a <a href=\"https://www.digitalocean.com/community/tutorials/how-to-secure-nginx-with-let-s-encrypt-on-ubuntu-20-04\">guide like this</a> for such setups.</p></aside><h2>Obtaining a TLS Certificate</h2><p>You have two options for obtaining a TLS certificate:</p><ul><li><strong>Recommended</strong>: Obtain a TLS certificate signed by a root certificate authority. For personal use, <a href=\"https://letsencrypt.org\">Let's Encrypt</a> is an excellent choice. It is free, automated, and straightforward. Certbot can facilitate automatic TLS setup.</li><li>Generate a self-signed certificate. This option is not recommended due to the additional complexity of importing the certificate into all machines connecting to the server.</li></ul><h2>Modifying <code>config.ini</code></h2><p>Once you have your certificate, modify the <code>config.ini</code> file in the <a href=\"#root/_help_tAassRL4RSQL\">data directory</a> to configure Trilium to use it:</p><pre><code class=\"language-text-x-trilium-auto\">[Network]\nport=8080\n# Set to true for TLS/SSL/HTTPS (secure), false for HTTP (insecure).\nhttps=true\n# Path to the certificate (run \"bash bin/generate-cert.sh\" to generate a self-signed certificate).\n# Relevant only if https=true\ncertPath=/[username]/.acme.sh/[hostname]/fullchain.cer\nkeyPath=/[username]/.acme.sh/[hostname]/example.com.key</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. For example, you can configure TLS using environment variables:</p><pre><code class=\"language-text-x-trilium-auto\">export TRILIUM_NETWORK_HTTPS=true\nexport TRILIUM_NETWORK_CERTPATH=/path/to/cert.pem\nexport TRILIUM_NETWORK_KEYPATH=/path/to/key.pem</code></pre><p>The above example shows how this is set up in an environment where the certificate was generated using Let's Encrypt's ACME utility. Your paths may differ. For Docker installations, ensure these paths are within a volume or another directory accessible by the Docker container, such as <code>/home/node/trilium-data/[DIR IN DATA DIRECTORY]</code>.</p><p>After configuring <code>config.ini</code>, restart Trilium and access the hostname using \"https\".</p><h2>Self-Signed Certificate</h2><p>If you opt to use a self-signed certificate for your server instance, note that the desktop instance will not trust it by default.</p><p>To bypass this, disable certificate validation by setting the following environment variable (for Linux):</p><pre><code class=\"language-text-x-trilium-auto\">export NODE_TLS_REJECT_UNAUTHORIZED=0\ntrilium</code></pre><p>Trilium provides scripts to start in this mode, such as <code>trilium-no-cert-check.bat</code> for Windows.</p><p><strong>Warning</strong>: Disabling TLS certificate validation is insecure. Proceed only if you fully understand the implications.</p>",
++ "_help_0hzsNCP31IAB": "<h2>Disabling authentication</h2><p>If you are running Trilium on <code>localhost</code> only or if authentication is handled by another component, you can disable Trilium’s authentication by adding the following to <code>config.ini</code>:</p><pre><code class=\"language-text-x-trilium-auto\">[General]\nnoAuthentication=true</code></pre><p>Disabling authentication will bypass even the&nbsp;<a class=\"reference-link\" href=\"#root/_help_7DAiwaf8Z7Rz\">Multi-Factor Authentication</a>&nbsp;since v0.94.1.</p><h2>Understanding how the session works</h2><p>Once logged into Trilium, the application will store this information about the login into a cookie on the browser, but also as a session on the server.</p><p>If “Remember me” is checked, then the login will expire in 21 days. This period can be adjusted by modifying the <code>Session.cookieMaxAge</code> value in <code>config.ini</code>. For example, to have the session expire in one day:</p><pre><code class=\"language-text-x-trilium-auto\">[Session]\ncookieMaxAge=86400</code></pre><p>When “Remember me” is unchecked, the behavior is different. At client/browser level the authentication does not have any expiration date, but it will be automatically cleared as soon as the user closes the browser. Nevertheless, the server will also dismiss this authentication in around 24 hours from the <em>last interaction with the application</em>.</p><h2>Viewing active sessions</h2><p>The login sessions are now stored in the same&nbsp;<a class=\"reference-link\" href=\"#root/_help_wX4HbRucYSDD\">Database</a>&nbsp;as the user data. In order to view which sessions are active, open the&nbsp;<a class=\"reference-link\" href=\"#root/_help_YKWqdJhzi2VY\">SQL Console</a>&nbsp;and run the following query:</p><pre><code class=\"language-text-x-trilium-auto\">SELECT * FROM sessions</code></pre><p>Expired sessions are periodically cleaned by the server, generally an hourly interval.</p><h2>See also</h2><ul><li><a class=\"reference-link\" href=\"#root/_help_7DAiwaf8Z7Rz\">Multi-Factor Authentication</a></li></ul>",
++ "_help_lwAX5SvbrK2g": "<aside class=\"admonition important\"><p>If you forget your password:</p><ul><li>Protected notes are irretrievable without the password.</li><li>Unprotected notes can be recovered.</li></ul></aside><p>There are two options, both involving access to the device that is running your server.</p><h3>By disabling authentication</h3><ol><li>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_0hzsNCP31IAB\">Authentication</a>&nbsp;on how to disable the authentication.</li><li>Restart the server.</li><li>Go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ Password → Reset password.</li><li>Re-enable authentication by following step (1) in reverse.</li><li>Restart the server.</li><li>Log in with the new password.</li></ol><h3>By altering the database</h3><ol><li><p>Access the <a href=\"#root/_help_wX4HbRucYSDD\">database</a> file in the <a href=\"#root/_help_tAassRL4RSQL\">data directory</a>. Open the <code>document.db</code> file with an SQLite client (e.g., <a href=\"https://sqlitebrowser.org/\">DB Browser</a>).</p></li><li><p>Execute the following queries:</p><pre><code class=\"language-text-x-trilium-auto\">UPDATE options SET value = '77/twC5O00cuQgNC63VK32qOKKYwj21ev3jZDXoytVU=' WHERE name = 'passwordVerificationSalt';\nUPDATE options SET value = '710BMasZCAgibzIc07X4P9Q4TeBd4ONnqJOho+pWcBM=' WHERE name = 'passwordDerivedKeySalt';\nUPDATE options SET value = 'Eb8af1/T57b89lCRuS97tPEl4CwxsAWAU7YNJ77oY+s=' WHERE name = 'passwordVerificationHash';\nUPDATE options SET value = 'QpC8XoiYYeqHPtHKRtbNxfTHsk+pEBqVBODYp0FkPBa22tlBBKBMigdLu5GNX8Uu' WHERE name = 'encryptedDataKey';</code></pre></li><li><p>After executing the changes, commit/write the changes. <strong>This sets the password to</strong> <code>**password**</code><strong>, allowing you to log in again.</strong></p></li><li><p>Go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Password</em> → <em>Change password</em> and replace the unsafe password.</p></li></ol><h2>Handling protected notes</h2><p>When the password is reset, the protected notes are permanently lost due to the fact that they are encrypted with your password so there is no way for Trilium to recover them.</p><p>For pre-existing protected notes (now unrecoverable), consider deleting them or exporting the unprotected notes. Then, delete <code>document.db</code> and start fresh.</p>",
+ "_help_7DAiwaf8Z7Rz": "<p>Multi-factor authentication (MFA) is a security process that requires users to provide two or more verification factors to gain access to a system, application, or account. This adds an extra layer of protection beyond just using a password.</p><p>By requiring more than one verification method, MFA helps reduce the risk of unauthorized access, even if someone has obtained your password. It’s highly recommended for securing sensitive information stored in your notes.</p><h2>Relationship to OpenID Connect (OIDC)</h2><p>Multi-factor authentication makes your Trilium login safer by requiring an additional proof of identity apart from your password.&nbsp;<a class=\"reference-link\" href=\"#root/_help_x1lQNKQBqLcA\">Signing in with OpenID Connect</a>&nbsp;is a different concept which delegates your authentication to an external provider (e.g. your Google provider, or a self-hosted one such as Authelia). These authentication providers might provide their own security features such as TOTP or passkeys.</p><h2>Time-based one-time password (TOTP)</h2><p>TOTP (Time-Based One-Time Password) is a security feature that generates a unique, temporary code on your device, like a smartphone, which changes every 30 seconds. You use this code, along with your password, to log into your account, making it much harder for anyone else to access them.</p><ol><li>Go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Password &amp; Auth.</em></li><li>Make sure <em>Sign-in with</em> has <em>Local password</em> selected.</li><li>In the <em>Two-factor authentication</em> section, press <em>Set up.</em></li><li>Scan the QR code or manually enter the code in your authenticator app.</li><li>Enter the verification code from your authenticator app to confirm that the setup was successful and press <em>Verify &amp; continue</em>.</li><li>Save the recovery codes, then tick the confirmation and press <em>Finish setup</em>.</li><li>Re-login will be required after TOTP setup is finished (After you refreshing the page).</li></ol><h2>Recovery codes</h2><p>Recovery codes can be used in place of the TOTP if you lose access to your authenticator. Trilium provides 8 different recovery codes, each recovery code can be used once.</p><p>To use a recovery code, simply login with your password and use the recovery code as the security token.</p><p>The initial set of recovery codes is generated when setting up your TOTP for the first time. They can be regenerated at any time by going to &nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Password &amp; Auth</em> and pressing the <em>Regenerate recovery codes</em> button. This will generate a new set of recovery codes while at the same time disabling the previous ones.</p>",
- "_help_x1lQNKQBqLcA": "<p>OpenID is a standardized way to let you log into websites using an account from another service, like Google or Authelia, to verify your identity.</p><p>When OpenID is activated, the password-based authentication in Trilium is replaced with a button that connects using your provider. This means that the configuration of&nbsp;<a class=\"reference-link\" href=\"#root/_help_7DAiwaf8Z7Rz\">Multi-factor authentication with TOTP</a>&nbsp;no longer takes effect, since your provider has to handle any multi-factor authentication.</p><h2>Setup</h2><p>Setting up authentication with OpenID connect is a two-step process:</p><ol><li>First the Trilium server must be configured with information about your authentication provider such as the URL, client ID and secret.</li><li>Second, the user must connect from options to create a link between the account on the provider and the one Trilium has.</li></ol><h3>Configuring the authentication provider</h3><ol><li><p>First, make sure the authentication provider (e.g. Google, Authelia) is configured properly. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_IgkTHSaFfq6A\">Setting up with various providers</a>&nbsp;for concrete examples.</p><ol><li>The redirect URL of Trilium is <code spellcheck=\"false\">https://&lt;your-trilium-domain&gt;/callback</code>.</li><li>You should obtain the base URL, client ID and client secret.</li></ol></li><li><p>Set the following information using&nbsp;<a class=\"reference-link\" href=\"#root/_help_Gzjqa934BdH4\">Configuration (config.ini or environment variables)</a>:</p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Configuration</th>\n<th><code spellcheck=\"false\">config.ini</code> in <code spellcheck=\"false\">[MultiFactorAuthentication]</code> section</th>\n<th>Environment variable</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody><tr>\n<td>Base URL*</td>\n<td><code spellcheck=\"false\">oauthBaseUrl</code></td>\n<td><code spellcheck=\"false\">TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHBASEURL</code></td>\n<td>The URL of your Trilium instance (e.g. <code spellcheck=\"false\">https://example.com</code>).</td>\n</tr>\n<tr>\n<td>Client ID*</td>\n<td><code spellcheck=\"false\">oauthClientId</code></td>\n<td><code spellcheck=\"false\">TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTID</code></td>\n<td>The client ID from your provider configuration.</td>\n</tr>\n<tr>\n<td>Client Secret*</td>\n<td><code spellcheck=\"false\">oauthClientSecret</code></td>\n<td><code spellcheck=\"false\">TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTSECRET</code></td>\n<td>The client secret from your provider configuration.</td>\n</tr>\n<tr>\n<td>Client auth method</td>\n<td><code spellcheck=\"false\">oauthClientAuthMethod</code></td>\n<td><code spellcheck=\"false\">TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTAUTHMETHOD</code></td>\n<td>Token-endpoint auth method: <code spellcheck=\"false\">client_secret_basic</code> or <code spellcheck=\"false\">client_secret_post</code>. Empty auto-detects. &nbsp;Only needed if sign-in fails with a <code spellcheck=\"false\">WWW-Authenticate</code> or <code spellcheck=\"false\">invalid_client</code> error.</td>\n</tr>\n<tr>\n<td>ID token algorithm</td>\n<td><code spellcheck=\"false\">oauthIdTokenSigningAlg</code></td>\n<td><code spellcheck=\"false\">TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHIDTOKENSIGNINGALG</code></td>\n<td><span style=\"color:rgb(32,32,32)\">The algorithm your provider signs ID tokens with, e.g.</span> <code spellcheck=\"false\">RS256</code><span style=\"color:rgb(32,32,32)\">,</span> <code spellcheck=\"false\">EdDSA</code><span style=\"color:rgb(32,32,32)\">,</span> <code spellcheck=\"false\">ES256</code><span style=\"color:rgb(32,32,32)\">. Empty auto-detects from the provider. Only needed if sign-in fails with an</span> <code spellcheck=\"false\">unexpected JWT alg</code> <span style=\"color:rgb(32,32,32)\">error.</span></td>\n</tr>\n</tbody></table></figure><p>Asterisk (*) marks a required field</p></li><li><p>The default OAuth issuer is Google. To use other services such as Authentik or Auth0, you can configure the settings via <code spellcheck=\"false\">oauthIssuerBaseUrl</code>, <code spellcheck=\"false\">oauthIssuerName</code>, and <code spellcheck=\"false\">oauthIssuerIcon</code> in the <code spellcheck=\"false\">config.ini</code> file. Alternatively, these values can be set using environment variables:</p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Configuration</th>\n<th><code spellcheck=\"false\">config.ini</code> in <code spellcheck=\"false\">[MultiFactorAuthentication]</code> section</th>\n<th>Environment variable</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody><tr>\n<td>Issuer base URL</td>\n<td><code spellcheck=\"false\">oauthIssuerBaseUrl</code></td>\n<td><code spellcheck=\"false\">TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERBASEURL</code></td>\n<td>Either the issuer itself (<code spellcheck=\"false\">https://auth.example.com</code>) or a full discovery URL (<code spellcheck=\"false\">https://auth.example.com/.well-known/openid-configuration</code>). <br> <br>A URL containing <code spellcheck=\"false\">/.well-known/</code> is used as-is<span style=\"color:rgb(32,32,32)\">, which is convenient when your provider hands you a discovery URL to copy. A trailing slash may be included or omitted; Trilium matches whichever spelling the provider advertises.</span> <br> <br>Use the full form when your provider advertises an issuer that differs from the path serving its discovery document, such as Authentik in \"global\" issuer mode.</td>\n</tr>\n<tr>\n<td>Issuer name</td>\n<td><code spellcheck=\"false\">oauthIssuerName</code></td>\n<td><code spellcheck=\"false\">TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERNAME</code></td>\n<td>The name of your authentication provider, used for reference on the login screen and in settings. Default is “Google”.</td>\n</tr>\n<tr>\n<td>Issuer icon</td>\n<td><code spellcheck=\"false\">oauthIssuerIcon</code></td>\n<td><code spellcheck=\"false\">TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERICON</code></td>\n<td>Optionally, the URL to a logo of the provider. By default it will try to obtain the favicon from the website, so it's optional.</td>\n</tr>\n</tbody></table></figure><p>All the fields here are optional, since the default OAuth issuer is Google.</p></li><li><p>Restart the server so that the changes are applied.</p></li></ol><aside class=\"admonition note\"><p>Legacy environment variables are also supported: <code spellcheck=\"false\">TRILIUM_OAUTH_BASE_URL</code>, <code spellcheck=\"false\">TRILIUM_OAUTH_CLIENT_ID</code>, <code spellcheck=\"false\">TRILIUM_OAUTH_CLIENT_SECRET</code>, and for customizing the provider: <code spellcheck=\"false\">TRILIUM_OAUTH_ISSUER_BASE_URL</code>, <code spellcheck=\"false\">TRILIUM_OAUTH_ISSUER_NAME</code>, <code spellcheck=\"false\">TRILIUM_OAUTH_ISSUER_ICON</code>, <code spellcheck=\"false\">TRILIUM_OAUTH_CLIENT_AUTH_METHOD</code>, <code spellcheck=\"false\">TRILIUM_OAUTH_ID_TOKEN_SIGNING_ALG</code> .</p></aside><h2>Connecting to the authentication provider</h2><p>Once the server has been configured at the previous step, the next step is to create a link between your account on the authentication provider and the Trilium instance. This makes sure that only you can access the Trilium instance, and not just any other valid account.</p><p>To do so:</p><ol><li>Go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Password &amp; Auth.</em></li><li>In the <em>Sign-in with</em> field, choose <em>OpenID Connect provider.</em></li><li>In the <em>OpenID Connect</em> section, look for the <em>Connect account</em> button.</li><li>This will redirect you to your authentication provider, where you can sign in or confirm the action if needed.</li><li>Once you are authenticated you will be redirected back to the Trilium application.</li></ol><h2>Logging out</h2><p>When logging out of Trilium, a request is made to the authentication provider to log out from there as well. This feature depends on the authentication provider, so it may not be honored (Google and Authelia are known cases in which they don't respect the logout feature).</p><h2>Switching providers</h2><p>When switching providers (e.g. going from Google to Authelia), it's important to take the following steps:</p><ol><li>Go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Password &amp; Auth</em>.</li><li>In the <em>OpenID Connect</em> section, press the <em>Disconnect</em> button.</li><li>Wait for the section to indicate that you are disconnected.</li><li>Change the configuration pointing to the new provider.</li><li>Restart your server.</li><li>Repeat the normal steps to connect to the authentication provider.</li></ol><p>Failing to disconnect before switching providers might temporarily lock you in, as you will not be able to login (credentials won't match). Should this happen:</p><ol><li>Modify the server configuration again to your old provider.</li><li>Restart the server and follow the disconnect instructions above.</li><li>Modify the server configuration again to your new provider.</li><li>Restart again the server.</li></ol><h2>Deactivating OpenID Connect temporarily</h2><p>To disable the OpenID Connect authentication and instead rely on the local password temporarily, you must:</p><ol><li>Modify the <code spellcheck=\"false\">config.ini</code> or environment variables (depending on how you set up the provider information) and temporarily deactivate the multi-factor authentication section by renaming <code spellcheck=\"false\">[MultiFactorAuthentication]</code> to something else (e.g. <code spellcheck=\"false\">[MultiFactorAuthentication.bak]</code>.</li><li>Restart the server for the changes to take effect.</li></ol><h2>Troubleshooting</h2><h3>Setup fails with a <code spellcheck=\"false\">WWW-Authenticate</code> or <code spellcheck=\"false\">invalid_client</code> error</h3><p>Your provider disagrees with Trilium about how client credentials should be sent to the token endpoint. Set <code spellcheck=\"false\">oauthClientAuthMethod</code> to <code spellcheck=\"false\">client_secret_post</code> (or <code spellcheck=\"false\">client_secret_basic</code> if it's already set to post) and restart. Providers vary: some reject <code spellcheck=\"false\">client_secret_post</code> outright because the method is fixed when the client is registered (e.g. Authelia), so if one value doesn't work, try the other.</p><h3>Setup fails with <code spellcheck=\"false\">invalid user</code></h3><p>If you are running behind a <a href=\"#root/_help_vcjrb3VVYPZI\">reverse proxy</a>, a buffer overflow can also cause this issue. Here is a sample fix for&nbsp;<a class=\"reference-link\" href=\"#root/_help_ud6MShXL4WpO\">Nginx</a>: </p><pre><code class=\"language-text-x-trilium-auto\">proxy_buffer_size 128k;\nproxy_buffers 4 256k;\nproxy_busy_buffers_size 256k;</code></pre><h3>Setup fails with an <code spellcheck=\"false\">unexpected JWT alg</code> error</h3><p>Depending on your version the message reads <code spellcheck=\"false\">unexpected JWT \"alg\" header parameter</code> or <code spellcheck=\"false\">unexpected JWT alg received, expected RS256, got: EdDSA</code>. Both mean the same thing: your provider signs ID tokens with an algorithm other than RS256. Pocket ID (Ed25519) and Kanidm (ES256) do this.</p><p>From v0.104.2 Trilium detects the algorithm from your provider automatically, and the log records the outcome (<code spellcheck=\"false\">OAuth: the issuer does not sign ID tokens with RS256; expecting ES256</code>). If detection can't reach the provider it falls back to RS256, so check that the issuer URL is correct and reachable first. Should it still fail, set <code spellcheck=\"false\">oauthIdTokenSigningAlg</code> explicitly to the algorithm your provider uses.</p><h3>Setup fails with <code spellcheck=\"false\">OAUTH_RESPONSE_IS_NOT_CONFORM</code></h3><p>Make sure the base URL is correct and that the identity provider actually supports OpenID Connect. Some providers such as GitHub offer only OAuth 2.0.</p>",
- "_help_IgkTHSaFfq6A": "<aside class=\"admonition note\"><p>This page contains instructions on how to set up&nbsp;<a class=\"reference-link\" href=\"#root/_help_x1lQNKQBqLcA\">Signing in with OpenID Connect</a>&nbsp;with various providers such as Authelia, GitLab, Google. Note that while the configuration reference is correct and up to date, the steps to create the OAuth application might differ slightly as providers change their UI.</p></aside><h2>Authelia</h2><ol><li><p>Generate a client secret:</p><pre><code class=\"language-text-x-trilium-auto\">authelia crypto hash generate pbkdf2 --variant sha512 --random --random.length 72 --random.charset rfc3986\n</code></pre><p><code spellcheck=\"false\">Random Password</code> goes to Trilium, <code spellcheck=\"false\">Digest</code> (the <code spellcheck=\"false\">$pbkdf2-sha512$…</code> string) goes to Authelia.</p></li><li><p>Add a client under <code spellcheck=\"false\">identity_providers.oidc.clients</code> in Authelia's <code spellcheck=\"false\">configuration.yml</code>, replacing <code spellcheck=\"false\">&lt;server&gt;</code> with the URL of your Trilium instance:</p><pre><code class=\"language-text-x-yaml\">identity_providers:\n oidc:\n clients:\n - client_id: 'trilium'\n client_name: 'Trilium'\n client_secret: '&lt;Digest&gt;'\n public: false\n authorization_policy: 'two_factor'\n redirect_uris:\n - 'https://&lt;server&gt;/callback'\n scopes:\n - 'openid'\n - 'profile'\n - 'email'</code></pre><p>Unlike GitLab, <code spellcheck=\"false\">client_id</code> is a name you choose rather than one the provider generates.</p></li><li><p>Restart Authelia.</p></li></ol><p>Adjust <code spellcheck=\"false\">config.ini</code>, using the <code spellcheck=\"false\">Random Password</code> from step 1:</p><pre><code class=\"language-text-x-trilium-auto\">[MultiFactorAuthentication]\noauthBaseUrl=https://&lt;server&gt;\noauthClientId=&lt;ClientId&gt;\noauthClientSecret=&lt;RandomPassword&gt;\noauthIssuerBaseUrl=https://&lt;server&gt;\noauthIssuerName=Authelia</code></pre><aside class=\"admonition important\"><p>Do <strong>not</strong> set <code spellcheck=\"false\">oauthClientAuthMethod</code> for Authelia. It defaults confidential clients to <code spellcheck=\"false\">client_secret_basic</code> and rejects any other method with <code spellcheck=\"false\">invalid_client</code>, which is the default Trilium already uses. This is the opposite of the GitLab case below.</p></aside><h2>GitLab (self-hosted or cloud)</h2><ol><li>Go to user settings on <a href=\"https://gitlab.com/-/user_settings/applications\">gitlab.com</a> or your own self-hosted instance.</li><li>Press <em>Add new application</em>.</li><li>Give it a name (e.g. Trilium).</li><li>Set <em>Redirect URI</em> to <code spellcheck=\"false\">https://&lt;server&gt;/callback</code></li><li>Make sure <em>Confidential</em> is checked and <em>Device authorization grant</em> is unchecked.</li><li>Under scopes, check <em>openid</em>, <em>profile</em> and <em>email</em> (they should be near the end).</li><li>Save the application and copy the <em>Application ID</em> and <em>Secret</em>.</li></ol><p>Adjust <code spellcheck=\"false\">config.ini</code> as follows, replacing <code spellcheck=\"false\">&lt;ApplicationId&gt;</code> and <code spellcheck=\"false\">&lt;Secret&gt;</code> with the values from the last step as well as the <code spellcheck=\"false\">&lt;server&gt;</code> with a URL to your Trilium instance.</p><pre><code class=\"language-text-x-trilium-auto\">[MultiFactorAuthentication]\noauthBaseUrl=https://&lt;server&gt;\noauthClientId=&lt;ApplicationId&gt;\noauthClientSecret=&lt;Secret&gt;\noauthIssuerBaseUrl=https://gitlab.com\noauthIssuerName=GitLab\noauthClientAuthMethod=client_secret_post\n</code></pre><aside class=\"admonition important\"><p>If you are using a self-hosted instance of GitLab, make sure to also update <code spellcheck=\"false\">oauthIssuerBaseUrl</code>, and keep the <code spellcheck=\"false\">oauthClientAuthMethod</code> line above.</p><p>GitLab's token endpoint does not decode credentials sent via HTTP Basic, so without <code spellcheck=\"false\">oauthClientAuthMethod</code>, sign-in fails with a <code spellcheck=\"false\">server responded with a challenge in the WWW-Authenticate HTTP Header</code> error. Trilium applies this automatically for <code spellcheck=\"false\">gitlab.com</code>, but a self-hosted issuer URL cannot be detected.</p></aside><h2>Kanidm</h2><ol><li><p>Create the client, add the redirect URL and grant the scopes, replacing <code spellcheck=\"false\">&lt;server&gt;</code> with the URL of your Trilium instance and <code spellcheck=\"false\">&lt;group&gt;</code> with an existing Kanidm group whose members may sign in:</p><pre><code class=\"language-text-x-trilium-auto\">kanidm system oauth2 create trilium \"Trilium\" \"https://&lt;server&gt;\"\nkanidm system oauth2 add-redirect-url trilium \"https://&lt;server&gt;/callback\"\nkanidm system oauth2 update-scope-map trilium &lt;group&gt; openid profile email</code></pre><p>The <code spellcheck=\"false\">openid</code> scope is mandatory; without it Kanidm treats the client as plain OAuth 2.0.</p></li><li><p>Read the client secret:</p><pre><code class=\"language-text-x-trilium-auto\">kanidm system oauth2 show-basic-secret trilium</code></pre></li></ol><p>Adjust <code spellcheck=\"false\">config.ini</code> as follows, replacing <code spellcheck=\"false\">&lt;idm&gt;</code> with the URL of your Kanidm instance and <code spellcheck=\"false\">&lt;BasicSecret&gt;</code> with the value from step 2:</p><pre><code class=\"language-text-x-trilium-auto\">[MultiFactorAuthentication]\noauthBaseUrl=https://&lt;server&gt;\noauthClientId=trilium\noauthClientSecret=&lt;BasicSecret&gt;\noauthIssuerBaseUrl=https://&lt;idm&gt;/oauth2/openid/trilium\noauthIssuerName=Kanidm</code></pre><p>The client name you chose in step 1 is both the client ID and the last path segment of the issuer URL, so the two must match.</p><aside class=\"admonition important\"><p>Kanidm signs ID tokens with ES256, not RS256. Trilium detects this from the provider on v0.105.0 and later, so no extra configuration is needed. Do <strong>not</strong> run <code spellcheck=\"false\">kanidm system oauth2 warning-enable-legacy-crypto</code>, it downgrades the client to RS256 and disables ES256 entirely. On older Trilium versions sign-in fails with an <code spellcheck=\"false\">unexpected JWT alg</code> error.</p></aside><h2>Pocket ID</h2><aside class=\"admonition important\"><p>Pocket ID is passwordless, signing in requires a passkey. Register one and confirm you can sign in to Pocket ID itself <em>before</em> switching Trilium over to OpenID Connect, otherwise you may find yourself unable to authenticate at either end.</p></aside><ol><li>Sign in to Pocket ID as an administrator and go to <em>OIDC Clients</em> → <em>Add OIDC Client</em>.</li><li>Give it a name (e.g. Trilium).</li><li>Set <em>Callback URLs</em> to <code spellcheck=\"false\">https://&lt;server&gt;/callback</code>, replacing <code spellcheck=\"false\">&lt;server&gt;</code> with the URL of your Trilium instance.</li><li>Save, then copy the <em>Client ID</em>, <em>Client Secret</em> and <em>OIDC Discovery URL</em>.</li></ol><p>Adjust <code spellcheck=\"false\">config.ini</code> as follows, using the values from step 4:</p><pre><code class=\"language-text-x-trilium-auto\">[MultiFactorAuthentication]\noauthBaseUrl=https://&lt;server&gt;\noauthClientId=&lt;ClientID&gt;\noauthClientSecret=&lt;ClientSecret&gt;\noauthIssuerBaseUrl=&lt;OIDCDiscoveryURL&gt;\noauthIssuerName=Pocket ID</code></pre><aside class=\"admonition note\"><p>Pocket ID gives you an <em>OIDC Discovery URL</em> ending in <code spellcheck=\"false\">/.well-known/openid-configuration</code>. On v0.105.0 and later you can paste it as-is. On earlier versions, remove that suffix and use only the part before it.</p></aside><aside class=\"admonition important\"><p>Pocket ID generates an RS256 signing key on first start, which works without further configuration. If you rotate it to Ed25519 (<code spellcheck=\"false\">pocket-id key-rotate --alg EdDSA --crv Ed25519</code>), ID tokens are signed with EdDSA instead. Trilium detects this automatically on v0.105.0 and later; older versions fail with <code spellcheck=\"false\">unexpected JWT alg received, expected RS256, got: EdDSA</code>.</p></aside><h2>GitHub</h2><p>GitHub cannot be used as an identity provider because it is plain OAuth 2.0 and not OpenID Connect, so it will fail with <code spellcheck=\"false\">OAUTH_RESPONSE_IS_NOT_CONFORM</code>.</p><h2>Google</h2><ol><li>Go to <a href=\"https://console.cloud.google.com/auth/clients\">Google Cloud's Clients</a> dashboard and select <em>Create client</em>.</li><li>For <em>Application type,</em> select <em>Web application</em>.</li><li>In <em>Authorized redirect URIs</em>, set &nbsp;<code spellcheck=\"false\">https://&lt;server&gt;/callback</code>.</li><li>Press <em>Create</em> and copy <em>Client ID</em> and <em>Client secret</em>.</li></ol><p>Adjust <code spellcheck=\"false\">config.ini</code> as follows, replacing <code spellcheck=\"false\">&lt;ClientID&gt;</code> and <code spellcheck=\"false\">&lt;ClientSecret&gt;</code> with the values from the last step as well as the <code spellcheck=\"false\">&lt;server&gt;</code> with a URL to your Trilium instance.</p><pre><code class=\"language-text-x-trilium-auto\">[MultiFactorAuthentication]\noauthBaseUrl=https://&lt;server&gt;\noauthClientId=&lt;ClientID&gt;\noauthClientSecret=&lt;ClientSecret&gt;</code></pre>",
++ "_help_x1lQNKQBqLcA": "<p>OpenID is a standardized way to let you log into websites using an account from another service, like Google or Authelia, to verify your identity.</p><p>When OpenID is activated, the password-based authentication in Trilium is replaced with a button that connects using your provider. This means that the configuration of&nbsp;<a class=\"reference-link\" href=\"#root/_help_7DAiwaf8Z7Rz\">Multi-factor authentication with TOTP</a>&nbsp;no longer takes effect, since your provider has to handle any multi-factor authentication.</p><h2>Setup</h2><p>Setting up authentication with OpenID connect is a two-step process:</p><ol><li>First the Trilium server must be configured with information about your authentication provider such as the URL, client ID and secret.</li><li>Second, the user must connect from options to create a link between the account on the provider and the one Trilium has.</li></ol><h3>Configuring the authentication provider</h3><ol><li><p>First, make sure the authentication provider (e.g. Google, Authelia) is configured properly. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_IgkTHSaFfq6A\">Setting up with various providers</a>&nbsp;for concrete examples.</p><ol><li>The redirect URL of Trilium is <code>https://&lt;your-trilium-domain&gt;/callback</code>.</li><li>You should obtain the base URL, client ID and client secret.</li></ol></li><li><p>Set the following information using&nbsp;<a class=\"reference-link\" href=\"#root/_help_Gzjqa934BdH4\">Configuration (config.ini or environment variables)</a>:</p><figure class=\"table\"><table><thead><tr><th>Configuration</th><th><code>config.ini</code> in <code>[MultiFactorAuthentication]</code> section</th><th>Environment variable</th><th>Description</th></tr></thead><tbody><tr><td>Base URL*</td><td><code>oauthBaseUrl</code></td><td><code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHBASEURL</code></td><td>The URL of your Trilium instance (e.g. <code>https://example.com</code>).</td></tr><tr><td>Client ID*</td><td><code>oauthClientId</code></td><td><code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTID</code></td><td>The client ID from your provider configuration.</td></tr><tr><td>Client Secret*</td><td><code>oauthClientSecret</code></td><td><code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTSECRET</code></td><td>The client secret from your provider configuration.</td></tr><tr><td>Client auth method</td><td><code>oauthClientAuthMethod</code></td><td><code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTAUTHMETHOD</code></td><td>Token-endpoint auth method: <code>client_secret_basic</code> or <code>client_secret_post</code>. Empty auto-detects. &nbsp;Only needed if sign-in fails with a <code>WWW-Authenticate</code> or <code>invalid_client</code> error.</td></tr><tr><td>ID token algorithm</td><td><code>oauthIdTokenSigningAlg</code></td><td><code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHIDTOKENSIGNINGALG</code></td><td><span style=\"color:rgb(32,32,32);\">The algorithm your provider signs ID tokens with, e.g.</span> <code>RS256</code><span style=\"color:rgb(32,32,32);\">,</span> <code>EdDSA</code><span style=\"color:rgb(32,32,32);\">,</span> <code>ES256</code><span style=\"color:rgb(32,32,32);\">. Empty auto-detects from the provider. Only needed if sign-in fails with an</span> <code>unexpected JWT alg</code> <span style=\"color:rgb(32,32,32);\">error.</span></td></tr></tbody></table></figure><p>Asterisk (*) marks a required field</p></li><li><p>The default OAuth issuer is Google. To use other services such as Authentik or Auth0, you can configure the settings via <code>oauthIssuerBaseUrl</code>, <code>oauthIssuerName</code>, and <code>oauthIssuerIcon</code> in the <code>config.ini</code> file. Alternatively, these values can be set using environment variables:</p><figure class=\"table\"><table><thead><tr><th>Configuration</th><th><code>config.ini</code> in <code>[MultiFactorAuthentication]</code> section</th><th>Environment variable</th><th>Description</th></tr></thead><tbody><tr><td>Issuer base URL</td><td><code>oauthIssuerBaseUrl</code></td><td><code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERBASEURL</code></td><td>Either the issuer itself (<code>https://auth.example.com</code>) or a full discovery URL (<code>https://auth.example.com/.well-known/openid-configuration</code>). <br> <br>A URL containing <code>/.well-known/</code> is used as-is<span style=\"color:rgb(32,32,32);\">, which is convenient when your provider hands you a discovery URL to copy. A trailing slash may be included or omitted; Trilium matches whichever spelling the provider advertises.</span> <br> <br>Use the full form when your provider advertises an issuer that differs from the path serving its discovery document, such as Authentik in \"global\" issuer mode.</td></tr><tr><td>Issuer name</td><td><code>oauthIssuerName</code></td><td><code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERNAME</code></td><td>The name of your authentication provider, used for reference on the login screen and in settings. Default is “Google”.</td></tr><tr><td>Issuer icon</td><td><code>oauthIssuerIcon</code></td><td><code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERICON</code></td><td>Optionally, the URL to a logo of the provider. By default it will try to obtain the favicon from the website, so it's optional.</td></tr></tbody></table></figure><p>All the fields here are optional, since the default OAuth issuer is Google.</p></li><li><p>Optionally, tune the following advanced settings. All are optional and have sensible defaults:</p><figure class=\"table\"><table><thead><tr><th>Configuration</th><th><code>config.ini</code> in <code>[MultiFactorAuthentication]</code> section</th><th>Environment variable</th><th>Description</th></tr></thead><tbody><tr><td>HTTP timeout</td><td><code>oauthHttpTimeout</code></td><td><code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHHTTPTIMEOUT</code></td><td>Timeout in milliseconds for the provider HTTP requests (discovery, token exchange, userinfo). Defaults to <code>30000</code> (30s). Raise this if your provider cold-starts slowly and you are occasionally asked to sign in twice. Minimum accepted value is <code>500</code>.</td></tr><tr><td>Scopes</td><td><code>oauthScope</code></td><td><code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHSCOPE</code></td><td>Space-separated list of OIDC scopes requested at login. Defaults to <code>openid profile email</code>. <code>openid</code> is required and is prepended automatically if you omit it.</td></tr></tbody></table></figure><p>The OIDC session lifetime is automatically bound to Trilium's own session cookie lifetime (the <code>cookieMaxAge</code> setting in the <code>[Session]</code> section, 21 days by default), so a single sign-in stays valid for as long as your Trilium session does rather than expiring early on the OIDC library's shorter internal defaults.</p></li><li><p>Restart the server so that the changes are applied.</p></li></ol><aside class=\"admonition note\"><p>Legacy environment variables are also supported: <code>TRILIUM_OAUTH_BASE_URL</code>, <code>TRILIUM_OAUTH_CLIENT_ID</code>, <code>TRILIUM_OAUTH_CLIENT_SECRET</code>, and for customizing the provider: <code>TRILIUM_OAUTH_ISSUER_BASE_URL</code>, <code>TRILIUM_OAUTH_ISSUER_NAME</code>, <code>TRILIUM_OAUTH_ISSUER_ICON</code>, <code>TRILIUM_OAUTH_HTTP_TIMEOUT</code>, <code>TRILIUM_OAUTH_SCOPE</code>, <code>TRILIUM_OAUTH_CLIENT_AUTH_METHOD</code>, <code>TRILIUM_OAUTH_ID_TOKEN_SIGNING_ALG</code>.</p></aside><h2>Connecting to the authentication provider</h2><p>Once the server has been configured at the previous step, the next step is to create a link between your account on the authentication provider and the Trilium instance. This makes sure that only you can access the Trilium instance, and not just any other valid account.</p><p>To do so:</p><ol><li>Go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Password &amp; Auth.</em></li><li>In the <em>Sign-in with</em> field, choose <em>OpenID Connect provider.</em></li><li>In the <em>OpenID Connect</em> section, look for the <em>Connect account</em> (<span class=\"tn-icon bx bx-log-in\"></span>) button.</li><li>This will redirect you to your authentication provider, where you can sign in or confirm the action if needed.</li><li>Once you are authenticated you will be redirected back to the Trilium application.</li></ol><h2>Logging out</h2><p>When logging out of Trilium, a request is made to the authentication provider to log out from there as well. This feature depends on the authentication provider, so it may not be honored (Google and Authelia are known cases in which they don't respect the logout feature).</p><h2>Switching providers</h2><p>When switching providers (e.g. going from Google to Authelia), it's important to take the following steps:</p><ol><li>Go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Password &amp; Auth</em>.</li><li>In the <em>OpenID Connect</em> section, press the <em>Disconnect</em> (<span class=\"tn-icon bx bx-trash\"></span>) button.</li><li>Wait for the section to indicate that you are disconnected.</li><li>Change the configuration pointing to the new provider.</li><li>Restart your server.</li><li>Repeat the normal steps to connect to the authentication provider.</li></ol><p>Failing to disconnect before switching providers might temporarily lock you in, as you will not be able to login (credentials won't match). Should this happen:</p><ol><li>Modify the server configuration again to your old provider.</li><li>Restart the server and follow the disconnect instructions above.</li><li>Modify the server configuration again to your new provider.</li><li>Restart again the server.</li></ol><h2>Deactivating OpenID Connect temporarily</h2><p>To disable the OpenID Connect authentication and instead rely on the local password temporarily, you must:</p><ol><li>Modify the <code>config.ini</code> or environment variables (depending on how you set up the provider information) and temporarily deactivate the multi-factor authentication section by renaming <code>[MultiFactorAuthentication]</code> to something else (e.g. <code>[MultiFactorAuthentication.bak]</code>.</li><li>Restart the server for the changes to take effect.</li></ol><h2>Troubleshooting</h2><h3>Setup fails with a <code>WWW-Authenticate</code> or <code>invalid_client</code> error</h3><p>Your provider disagrees with Trilium about how client credentials should be sent to the token endpoint. Set <code>oauthClientAuthMethod</code> to <code>client_secret_post</code> (or <code>client_secret_basic</code> if it's already set to post) and restart. Providers vary: some reject <code>client_secret_post</code> outright because the method is fixed when the client is registered (e.g. Authelia), so if one value doesn't work, try the other.</p><h3>Setup fails with <code>invalid user</code></h3><p>If you are running behind a <a href=\"#root/_help_vcjrb3VVYPZI\">reverse proxy</a>, a buffer overflow can also cause this issue. Here is a sample fix for&nbsp;<a class=\"reference-link\" href=\"#root/_help_ud6MShXL4WpO\">Nginx</a>: </p><pre><code class=\"language-text-x-trilium-auto\">proxy_buffer_size 128k;\nproxy_buffers 4 256k;\nproxy_busy_buffers_size 256k;</code></pre><h3>Setup fails with an <code>unexpected JWT alg</code> error</h3><p>Depending on your version the message reads <code>unexpected JWT \"alg\" header parameter</code> or <code>unexpected JWT alg received, expected RS256, got: EdDSA</code>. Both mean the same thing: your provider signs ID tokens with an algorithm other than RS256. Pocket ID (Ed25519) and Kanidm (ES256) do this.</p><p>From v0.104.2 Trilium detects the algorithm from your provider automatically, and the log records the outcome (<code>OAuth: the issuer does not sign ID tokens with RS256; expecting ES256</code>). If detection can't reach the provider it falls back to RS256, so check that the issuer URL is correct and reachable first. Should it still fail, set <code>oauthIdTokenSigningAlg</code> explicitly to the algorithm your provider uses.</p><h3>Setup fails with <code>OAUTH_RESPONSE_IS_NOT_CONFORM</code></h3><p>Make sure the base URL is correct and that the identity provider actually supports OpenID Connect. Some providers such as GitHub offer only OAuth 2.0.</p>",
++ "_help_IgkTHSaFfq6A": "<p>This page contains instructions on how to set up&nbsp;<a class=\"reference-link\" href=\"#root/_help_x1lQNKQBqLcA\">Signing in with OpenID Connect</a>&nbsp;with various providers such as Authelia, GitLab, Google.</p><aside class=\"admonition note\"><p>While the configuration reference is correct and up to date, the steps to create the OAuth application might differ slightly as providers change their UI.</p></aside><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Authelia</p><div class=\"trilium-tab-panel\"><ol><li><p>Generate a client secret:</p><pre><code class=\"language-text-x-trilium-auto\">authelia crypto hash generate pbkdf2 --variant sha512 --random --random.length 72 --random.charset rfc3986\n</code></pre><p><code>Random Password</code> goes to Trilium, <code>Digest</code> (the <code>$pbkdf2-sha512$…</code> string) goes to Authelia.</p></li><li><p>Add a client under <code>identity_providers.oidc.clients</code> in Authelia's <code>configuration.yml</code>, replacing <code>&lt;server&gt;</code> with the URL of your Trilium instance:</p><pre><code class=\"language-text-x-yaml\">identity_providers:\n oidc:\n clients:\n - client_id: 'trilium'\n client_name: 'Trilium'\n client_secret: '&lt;Digest&gt;'\n public: false\n authorization_policy: 'two_factor'\n redirect_uris:\n - 'https://&lt;server&gt;/callback'\n scopes:\n - 'openid'\n - 'profile'\n - 'email'</code></pre><p>Unlike GitLab, <code>client_id</code> is a name you choose rather than one the provider generates.</p></li><li><p>Restart Authelia.</p></li></ol><p>Adjust <code>config.ini</code>, using the <code>Random Password</code> from step 1:</p><pre><code class=\"language-text-x-trilium-auto\">[MultiFactorAuthentication]\noauthBaseUrl=https://&lt;server&gt;\noauthClientId=&lt;ClientId&gt;\noauthClientSecret=&lt;RandomPassword&gt;\noauthIssuerBaseUrl=https://&lt;server&gt;\noauthIssuerName=Authelia</code></pre><aside class=\"admonition important\"><p>Do <strong>not</strong> set <code>oauthClientAuthMethod</code> for Authelia. It defaults confidential clients to <code>client_secret_basic</code> and rejects any other method with <code>invalid_client</code>, which is the default Trilium already uses. This is the opposite of the GitLab case below.</p></aside></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-gitlab\"></span>&nbsp;GitLab</p><div class=\"trilium-tab-panel\"><ol><li>Go to user settings on <a href=\"https://gitlab.com/-/user_settings/applications\">gitlab.com</a> or your own self-hosted instance.</li><li>Press <em>Add new application</em>.</li><li>Give it a name (e.g. Trilium).</li><li>Set <em>Redirect URI</em> to <code>https://&lt;server&gt;/callback</code></li><li>Make sure <em>Confidential</em> is checked and <em>Device authorization grant</em> is unchecked.</li><li>Under scopes, check <em>openid</em>, <em>profile</em> and <em>email</em> (they should be near the end).</li><li>Save the application and copy the <em>Application ID</em> and <em>Secret</em>.</li></ol><p>Adjust <code>config.ini</code> as follows, replacing <code>&lt;ApplicationId&gt;</code> and <code>&lt;Secret&gt;</code> with the values from the last step as well as the <code>&lt;server&gt;</code> with a URL to your Trilium instance.</p><pre><code class=\"language-text-x-trilium-auto\">[MultiFactorAuthentication]\noauthBaseUrl=https://&lt;server&gt;\noauthClientId=&lt;ApplicationId&gt;\noauthClientSecret=&lt;Secret&gt;\noauthIssuerBaseUrl=https://gitlab.com\noauthIssuerName=GitLab\noauthClientAuthMethod=client_secret_post\n</code></pre><aside class=\"admonition important\"><p>If you are using a self-hosted instance of GitLab, make sure to also update <code>oauthIssuerBaseUrl</code>, and keep the <code>oauthClientAuthMethod</code> line above.</p><p>GitLab's token endpoint does not decode credentials sent via HTTP Basic, so without <code>oauthClientAuthMethod</code>, sign-in fails with a <code>server responded with a challenge in the WWW-Authenticate HTTP Header</code> error. Trilium applies this automatically for <code>gitlab.com</code>, but a self-hosted issuer URL cannot be detected.</p></aside></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Kanidm</p><div class=\"trilium-tab-panel\"><ol><li><p>Create the client, add the redirect URL and grant the scopes, replacing <code>&lt;server&gt;</code> with the URL of your Trilium instance and <code>&lt;group&gt;</code> with an existing Kanidm group whose members may sign in:</p><pre><code class=\"language-text-x-trilium-auto\">kanidm system oauth2 create trilium \"Trilium\" \"https://&lt;server&gt;\"\nkanidm system oauth2 add-redirect-url trilium \"https://&lt;server&gt;/callback\"\nkanidm system oauth2 update-scope-map trilium &lt;group&gt; openid profile email</code></pre><p>The <code>openid</code> scope is mandatory; without it Kanidm treats the client as plain OAuth 2.0.</p></li><li><p>Read the client secret:</p><pre><code class=\"language-text-x-trilium-auto\">kanidm system oauth2 show-basic-secret trilium</code></pre></li></ol><p>Adjust <code>config.ini</code> as follows, replacing <code>&lt;idm&gt;</code> with the URL of your Kanidm instance and <code>&lt;BasicSecret&gt;</code> with the value from step 2:</p><pre><code class=\"language-text-x-trilium-auto\">[MultiFactorAuthentication]\noauthBaseUrl=https://&lt;server&gt;\noauthClientId=trilium\noauthClientSecret=&lt;BasicSecret&gt;\noauthIssuerBaseUrl=https://&lt;idm&gt;/oauth2/openid/trilium\noauthIssuerName=Kanidm</code></pre><p>The client name you chose in step 1 is both the client ID and the last path segment of the issuer URL, so the two must match.</p><aside class=\"admonition important\"><p>Kanidm signs ID tokens with ES256, not RS256. Trilium detects this from the provider on v0.105.0 and later, so no extra configuration is needed. Do <strong>not</strong> run <code>kanidm system oauth2 warning-enable-legacy-crypto</code>, it downgrades the client to RS256 and disables ES256 entirely. On older Trilium versions sign-in fails with an <code>unexpected JWT alg</code> error.</p></aside></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Pocket ID</p><div class=\"trilium-tab-panel\"><aside class=\"admonition important\"><p>Pocket ID is passwordless, signing in requires a passkey. Register one and confirm you can sign in to Pocket ID itself <em>before</em> switching Trilium over to OpenID Connect, otherwise you may find yourself unable to authenticate at either end.</p></aside><ol><li>Sign in to Pocket ID as an administrator and go to <em>OIDC Clients</em> → <em>Add OIDC Client</em>.</li><li>Give it a name (e.g. Trilium).</li><li>Set <em>Callback URLs</em> to <code>https://&lt;server&gt;/callback</code>, replacing <code>&lt;server&gt;</code> with the URL of your Trilium instance.</li><li>Save, then copy the <em>Client ID</em>, <em>Client Secret</em> and <em>OIDC Discovery URL</em>.</li></ol><p>Adjust <code>config.ini</code> as follows, using the values from step 4:</p><pre><code class=\"language-text-x-trilium-auto\">[MultiFactorAuthentication]\noauthBaseUrl=https://&lt;server&gt;\noauthClientId=&lt;ClientID&gt;\noauthClientSecret=&lt;ClientSecret&gt;\noauthIssuerBaseUrl=&lt;OIDCDiscoveryURL&gt;\noauthIssuerName=Pocket ID</code></pre><aside class=\"admonition note\"><p>Pocket ID gives you an <em>OIDC Discovery URL</em> ending in <code>/.well-known/openid-configuration</code>. On v0.105.0 and later you can paste it as-is. On earlier versions, remove that suffix and use only the part before it.</p></aside><aside class=\"admonition important\"><p>Pocket ID generates an RS256 signing key on first start, which works without further configuration. If you rotate it to Ed25519 (<code>pocket-id key-rotate --alg EdDSA --crv Ed25519</code>), ID tokens are signed with EdDSA instead. Trilium detects this automatically on v0.105.0 and later; older versions fail with <code>unexpected JWT alg received, expected RS256, got: EdDSA</code>.</p></aside></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span style=\"--tn-color:#e64d4d;color:#e64d4d;\"><span class=\"tn-icon bx bx-x\"></span>&nbsp;GitHub</span></p><div class=\"trilium-tab-panel\"><p>GitHub cannot be used as an identity provider because it is plain OAuth 2.0 and not OpenID Connect, so it will fail with <code>OAUTH_RESPONSE_IS_NOT_CONFORM</code>.</p></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-google\"></span>&nbsp;Google</p><div class=\"trilium-tab-panel\"><ol><li>Go to <a href=\"https://console.cloud.google.com/auth/clients\">Google Cloud's Clients</a> dashboard and select <em>Create client</em>.</li><li>For <em>Application type,</em> select <em>Web application</em>.</li><li>In <em>Authorized redirect URIs</em>, set &nbsp;<code>https://&lt;server&gt;/callback</code>.</li><li>Press <em>Create</em> and copy <em>Client ID</em> and <em>Client secret</em>.</li></ol><p>Adjust <code>config.ini</code> as follows, replacing <code>&lt;ClientID&gt;</code> and <code>&lt;ClientSecret&gt;</code> with the values from the last step as well as the <code>&lt;server&gt;</code> with a URL to your Trilium instance.</p><pre><code class=\"language-text-x-trilium-auto\">[MultiFactorAuthentication]\noauthBaseUrl=https://&lt;server&gt;\noauthClientId=&lt;ClientID&gt;\noauthClientSecret=&lt;ClientSecret&gt;</code></pre></div></section></div>",
+ "_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> &nbsp;and sign up.</li><li>In the “Available Apps” section, look for \"TriliumNext<br>&nbsp;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&nbsp;<a class=\"reference-link\" href=\"#root/_help_cbkrhQjrkKrh\">Synchronization</a>&nbsp;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 spellcheck=\"false\">aarch64</code>).</li></ul><h2>Legacy ARM support</h2><p>The Docker builds also provide <code spellcheck=\"false\">linux/arm/v7</code> and <code spellcheck=\"false\">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 spellcheck=\"false\">armv7</code> and <code spellcheck=\"false\">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 Options -&gt; Sync tab -&gt; Sync configuration, and set the \"Server instance address\" to your sync server's address. Click Save.</li></ol><p><img src=\"{{helpAssets}}/User%20Guide/Installation%20%26%20Setup/Synchronization_sync-config.png\" alt=\"screenshot of the sync settings options modal\"></p><ol><li><strong>Testing Sync</strong>: Click the \"Test sync\" button to verify the connection to the sync server. If successful, the client will start pushing all data to the server instance. 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></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 correct username and password for authentication.</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&nbsp;<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&nbsp;<a class=\"reference-link\" href=\"#root/_help_swSFivWk6KkA\">Network Access</a>&nbsp;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 spellcheck=\"false\">NODE_TLS_REJECT_UNAUTHORIZED</code> environment variable set to <code spellcheck=\"false\">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 spellcheck=\"false\">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_resized image-style-align-right\" 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><p>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;is displayed as a sidebar. To display the sidebar, press the button in the top-left of the screen.</p><ul><li>There is also a swipe gesture that can be done from the left of the screen, but the browser's navigation gesture interferes with it most of the time (depending on the platform).</li><li>Press and hold a note to display the&nbsp;<a class=\"reference-link\" href=\"#root/_help_YtSN43OrfzaA\">Note tree contextual menu</a>.</li></ul></li><li><p>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_Ms1nauBra7gq\">Quick search</a>&nbsp;bar is also displayed at the top of the note tree.</p></li><li><p>The full&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>&nbsp;function can be triggered either from either the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;or from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>, if configured.</p></li><li><p>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>&nbsp;is displayed at the bottom of the screen.</p><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><p>Most of the note-related actions are grouped in the horizontal dots icon on the top-right of the note.</p></li><li><p>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_3seOhtN8uLIY\">Tabs</a>&nbsp;are grouped under a tab switcher in the&nbsp;<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.</p></li><li><p>Since v0.100.0,&nbsp;<a class=\"reference-link\" href=\"#root/_help_luNhaphA37EO\">Split View</a>&nbsp;can also be used in mobile view, but with a maximum of two panes at once. The splits are displayed vertically instead of horizontally.</p></li><li><p>Starting with v0.102.0, the&nbsp;<a class=\"reference-link\" href=\"#root/_help_IjZS7iK5EXtb\">New Layout</a>&nbsp;is enforced on mobile. This brings features such as the note badges, note type switcher or collection properties which would otherwise not be available.</p></li></ul><h2>Installing as a PWA</h2><p>The mobile view can be set up as a PWA. While this does not offer any offline capabilities, it will display the application in full-screen and makes it easy to access via your mobile phone's home screen.</p><h3>On iOS with Safari</h3><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 “Add to Home Screen”.</li><li>Press “Add” and the web app will be available.</li></ol><h3>On Android with Google Chrome</h3><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><h3>On Android with Brave</h3><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><h3>On Samsung Browser</h3><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><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&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRqcgfTb97uV\">Using the desktop application as a server</a>. To access it go to <code spellcheck=\"false\">http://&lt;ip&gt;: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 spellcheck=\"false\">?mobile</code> or <code spellcheck=\"false\">?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/Desktop Version</em> in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>.</p><h2>Scripting</h2><p>You can alter the behavior with&nbsp;<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 spellcheck=\"false\">#run=mobileStartup</code>.</p><p>Custom&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>&nbsp;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 screenshot (with crop tool) from either popup or context menu</li><li>create short text note from popup</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&nbsp;<a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a>&nbsp;but you can override that by setting the <a href=\"#root/_help_zEY4DaJG4YT5\">label</a> <code spellcheck=\"false\">clipperInbox</code>, on any other note.</p><p>If there's multiple clippings from the same page (and on the same day), then they will be added to the same note.</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 screenshot: <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>E</kbd> (Mac: <kbd>⌘</kbd>+<kbd>⇧</kbd>+<kbd>E</kbd>)</li></ul><p>To set custom shortcuts, follow the directions for your browser.</p><ul><li><strong>Firefox</strong>: <code spellcheck=\"false\">about:addons</code> → Gear icon ⚙️ → Manage extension shortcuts</li><li><strong>Chrome</strong>: <code spellcheck=\"false\">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 scans a port range on the local computer to find a desktop Trilium instance.</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><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 spellcheck=\"false\">web-clipper-extension</code>.</li></ul><h3>For Chrome</h3><ol><li>Download <code spellcheck=\"false\">trilium-web-clipper-[x.y.z]-chrome.zip</code>.</li><li>Extract the archive.</li><li>In Chrome, navigate to <code spellcheck=\"false\">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><h3>For Firefox</h3><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 spellcheck=\"false\">about:config</code> and change <code spellcheck=\"false\">xpinstall.signatures.required</code> to <code spellcheck=\"false\">false</code>.</p></aside><ol><li>Navigate to <code spellcheck=\"false\">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 spellcheck=\"false\">trilium-web-clipper-[x.y.z]-firefox.zip</code>.</li><li>Press the <em>Add</em> button to confirm.</li></ol><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_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&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <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&nbsp;<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 correct username and password for authentication.</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&nbsp;<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&nbsp;<a class=\"reference-link\" href=\"#root/_help_swSFivWk6KkA\">Network Access</a>&nbsp;for information on how to do so.</p></aside><h2>Proxy Configuration</h2><p>Two proxy setups are supported:</p><ul><li><strong>Explicit Proxy Configuration</strong>: Set the proxy server in Options / Sync. Only unauthenticated proxy servers are supported.</li><li><strong>System Proxy Settings</strong>: If no proxy server is explicitly configured, Trilium will use the system proxy settings.</li></ul><h2>Troubleshooting</h2><h3>Date/Time Synchronization</h3><p>For successful synchronization, both client and server must have the same date and time, with a tolerance of up to five minutes.</p><h3>Certificate Issues</h3><p>When using TLS, Trilium will verify the server certificate. If verification fails (e.g., due to self-signed certificates or certain corporate proxies), you can run the Trilium client with the <code>NODE_TLS_REJECT_UNAUTHORIZED</code> environment variable set to <code>0</code>:</p><pre><code class=\"language-text-x-trilium-auto\">export NODE_TLS_REJECT_UNAUTHORIZED=0</code></pre><p>This will disable TLS certificate verification, significantly reducing security and exposing the setup to MITM attacks. It is strongly recommended to use a valid signed server certificate. Newer Trilium versions include a script called <code>trilium-no-cert-check.sh</code> for this purpose.</p><h3>Conflict Resolution</h3><p>If you edit the same note on multiple instances before synchronization, Trilium resolves conflicts by retaining the newer change and discarding the older one. The older version remains accessible in <a href=\"#root/_help_vZWERwf8U3nx\">note revisions</a>, allowing data recovery if needed.</p><h3>Hash Check</h3><p>After each synchronization, Trilium computes a hash of all synced data on both the client and the sync server. If there is a discrepancy, Trilium will automatically initiate a recovery mechanism to resolve the issue.</p>",
++ "_help_RDslemsQ6gCp": "<figure class=\"image image-style-align-right image_resized\" style=\"width:33.52%;\"><img style=\"aspect-ratio:1242/2688;\" src=\"{{helpAssets}}/User%20Guide/Installation%20%26%20Setup/Mobile%20Frontend_IMG_1765.PNG\" width=\"1242\" height=\"2688\"></figure><p>Trilium has a mobile web frontend which is optimized for touch based devices - smartphones and tablets. It is activated automatically during login process based on browser detection.</p><p>Mobile frontend is limited in features compared to the full desktop version. See below for more details on this.</p><h2>Layout basics</h2><p>Unlike the desktop version, the mobile version has a slightly different UI meant to better fit the constrained screens of a mobile phone.</p><p>Here is a non-exhaustive list of differences between the desktop version and the mobile one:</p><ul><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;is displayed as a sidebar. To display the sidebar, press the button in the top-left of the screen.<ul><li>There is also a swipe gesture that can be done from the left of the screen, but the browser's navigation gesture interferes with it most of the time (depending on the platform).</li><li>Press and hold a note to display the&nbsp;<a class=\"reference-link\" href=\"#root/_help_YtSN43OrfzaA\">Note tree contextual menu</a>.</li></ul></li><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_Ms1nauBra7gq\">Quick search</a>&nbsp;bar is also displayed at the top of the note tree.</li><li>The full&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>&nbsp;function can be triggered either from either the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;or from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>, if configured.</li><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>&nbsp;is displayed at the bottom of the screen.<ul><li>The launch bar uses a different configuration for icons than the desktop version. See the dedicated page for more information on how to configure it.</li></ul></li><li>Most of the note-related actions are grouped in the horizontal dots icon on the top-right of the note.</li><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_3seOhtN8uLIY\">Tabs</a>&nbsp;are grouped under a tab switcher in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>, where the tabs are displayed in a full-screen grid with preview for easy switching, as well as additional options such as reopening closed tabs.</li><li>Since v0.100.0,&nbsp;<a class=\"reference-link\" href=\"#root/_help_luNhaphA37EO\">Split View</a>&nbsp;can also be used in mobile view, but with a maximum of two panes at once. The splits are displayed vertically instead of horizontally.</li></ul><h2>Installing as a PWA</h2><p>The mobile view can be set up as a PWA. While this does not offer any offline capabilities, it will display the application in full-screen and makes it easy to access via your mobile phone's home screen.</p><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-apple\"></span>&nbsp;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>&nbsp;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>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&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRqcgfTb97uV\">Using the desktop application as a server</a>. To access it go to <code>http://&lt;ip&gt;: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/Desktop Version</em> in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>.</p><h2>Scripting</h2><p>You can alter the behavior with&nbsp;<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&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>&nbsp;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&nbsp;<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&nbsp;<a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a>&nbsp;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>&nbsp;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>&nbsp;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&nbsp;<a class=\"reference-link\" href=\"#root/_help_wX4HbRucYSDD\">Database</a>&nbsp;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 spellcheck=\"false\">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&nbsp;<a class=\"reference-link\" href=\"#root/_help_wX4HbRucYSDD\">Database</a>&nbsp;to cloud / different computer etc.</p><p>Note that&nbsp;<a class=\"reference-link\" href=\"#root/_help_cbkrhQjrkKrh\">Synchronization</a>&nbsp;provides also some backup capabilities by its nature of distributing the data to other computers.</p><h2>Downloading backup</h2><p>You can download an existing backup by going to Settings &gt; Backup &gt; Existing backups &gt; Download</p><h2>Restoring backup</h2><p>Let's assume you want to restore the weekly backup, 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\" from \"Menu\" in upper left corner and looking at \"data directory\"<ul><li>I'll refer to <code spellcheck=\"false\">~/trilium-data</code> as data directory from now on</li></ul></li><li>find <code spellcheck=\"false\">~/trilium-data/backup/backup-weekly.db</code> - this is the&nbsp;<a class=\"reference-link\" href=\"#root/_help_wX4HbRucYSDD\">Database</a>&nbsp;backup</li><li>at this point stop/kill Trilium</li><li>delete <code spellcheck=\"false\">~/trilium-data/document.db</code>, <code spellcheck=\"false\">~/trilium-data/document.db-wal</code> and <code spellcheck=\"false\">~/trilium-data/document.db-shm</code> (latter two files are auto generated)</li><li>copy and rename this <code spellcheck=\"false\">~/trilium-data/backup/backup-weekly.db</code> to <code spellcheck=\"false\">~/trilium-data/document.db</code></li><li>make sure that the file is writable, e.g. with <code spellcheck=\"false\">chmod 600 document.db</code></li><li>start Trilium again</li></ul><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><h2>Disabling backup</h2><p>Although this is not recommended, it is possible to disable backup in <code spellcheck=\"false\">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 spellcheck=\"false\">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>",
- "_help_tAassRL4RSQL": "<p>Data directory contains:</p><ul><li><code spellcheck=\"false\">document.db</code> - <a href=\"#root/_help_wX4HbRucYSDD\">database</a></li><li><code spellcheck=\"false\">config.ini</code> - instance level settings like port on which the Trilium application runs</li><li><code spellcheck=\"false\">backup</code> - contains automatically <a href=\"#root/_help_ODY7qQn5m2FT\">backup</a> of documents</li><li><code spellcheck=\"false\">log</code> - contains application log files</li></ul><h2>Location of the data directory</h2><p>Easy way how to find out which data directory Trilium uses is to look at the \"About Trilium Notes\" dialog (from \"Menu\" in upper left corner):</p><p><img src=\"{{helpAssets}}/User%20Guide/Installation%20%26%20Setup/Data%20directory_image.jpg\"></p><p>Here's how the location is decided:</p><p>Data directory is normally named <code spellcheck=\"false\">trilium-data</code> and it is stored in:</p><ul><li><code spellcheck=\"false\">/home/[user]/.local/share</code> for Linux</li><li><code spellcheck=\"false\">C:\\Users\\[user]\\AppData\\Roaming</code> for Windows Vista and up</li><li><code spellcheck=\"false\">/Users/[user]/Library/Application Support</code> for Mac OS</li><li>user's home is a fallback if some of the paths above don't exist</li><li>user's home is also a default setup for [[docker|Docker server installation]]</li></ul><p>If you want to back up your Trilium data, just backup this single directory - it contains everything you need.</p><h3>Changing the location of data directory</h3><p>If you want to use some other location for the data directory than the default one, you may change it via <code spellcheck=\"false\">TRILIUM_DATA_DIR</code> environment variable to some other location:</p><h3>Windows</h3><ol><li>Press the Windows key on your keyboard.</li><li>Search and select “Edit the system variables”.</li><li>Press the “Environment Variables…” button in the bottom-right of the newly opened screen.</li><li>On the top section (\"User variables for [user]\"), press the “New…” button.</li><li>In the <em>Variable name</em> field insert <code spellcheck=\"false\">TRILIUM_DATA_DIR</code>.</li><li>Press the <em>Browse Directory…</em> button and select the new directory where to store the database.</li><li>Close all the windows by pressing the <em>OK</em> button for each of them.</li></ol><h4>Linux</h4><pre><code class=\"language-text-x-trilium-auto\">export TRILIUM_DATA_DIR=/home/myuser/data/my-trilium-data</code></pre><h4>Mac OS X</h4><p>You need to create a <code spellcheck=\"false\">.plist</code> file under <code spellcheck=\"false\">~/Library/LaunchAgents</code> to load it properly each login.</p><p>To load it manually, you need to use <code spellcheck=\"false\">launchctl setenv TRILIUM_DATA_DIR &lt;yourpath&gt;</code></p><p>Here is a pre-defined template, where you just need to add your path to:</p><pre><code class=\"language-text-x-trilium-auto\"> Label\n set.trilium.env\n RunAtLoad\n \n ProgramArguments\n \n launchctl\n setenv\n TRILIUM_DATA_DIR\n /Users/YourUserName/Library/Application Support/trilium-data </code></pre><h3>Create a script to run with specific data directory</h3><p>An alternative to globally setting environment variable is to run only the Trilium Notes with this environment variable. This then allows for different setup styles like two <a href=\"#root/_help_wX4HbRucYSDD\">database</a> instances or \"portable\" installation.</p><p>To do this in Unix-based systems simply run <code spellcheck=\"false\">trilium</code> like this:</p><pre><code class=\"language-text-x-trilium-auto\">TRILIUM_DATA_DIR=/home/myuser/data/my-trilium-data trilium</code></pre><p>You can then save the above command as a shell script on your path for convenience.</p><h2>Electron user data directory (desktop only)</h2><p>When running the desktop application, Electron stores internal data (caches, spell-check dictionaries, session storage, etc.) separately from the Trilium data directory. By default this goes to the system's application data folder (e.g. <code spellcheck=\"false\">%APPDATA%</code> on Windows), which may be undesirable in corporate environments with roaming profiles or when running in portable mode.</p><p>To keep Electron data out of the system's roaming profile, set the <code spellcheck=\"false\">TRILIUM_ELECTRON_DATA_DIR</code> environment variable to an explicit path. The <code spellcheck=\"false\">trilium-portable</code> script does this automatically, pointing it to <code spellcheck=\"false\">trilium-electron-data/</code> next to the application.</p><h2>Fine-grained directory/path location</h2><p>Apart from the data directory, some of the subdirectories of it can be moved elsewhere by changing an environment variable:</p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Environment variable</th>\n<th>Default value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code spellcheck=\"false\">TRILIUM_DOCUMENT_PATH</code></td>\n<td><code spellcheck=\"false\">${TRILIUM_DATA_DIR}/document.db</code></td>\n<td>Path to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_wX4HbRucYSDD\">Database</a>&nbsp;(storing all notes and metadata).</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">TRILIUM_BACKUP_DIR</code></td>\n<td><code spellcheck=\"false\">${TRILIUM_DATA_DIR}/backup</code></td>\n<td>Directory where automated&nbsp;<a class=\"reference-link\" href=\"#root/_help_ODY7qQn5m2FT\">Backup</a>&nbsp;databases are stored.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">TRILIUM_LOG_DIR</code></td>\n<td><code spellcheck=\"false\">${TRILIUM_DATA_DIR}/log</code></td>\n<td>Directory where daily&nbsp;<a class=\"reference-link\" href=\"#root/_help_bnyigUA2UK7s\">Backend (server) logs</a>&nbsp;are stored.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">TRILIUM_TMP_DIR</code></td>\n<td><code spellcheck=\"false\">${TRILIUM_DATA_DIR}/tmp</code></td>\n<td>Directory where temporary files are stored (for example when opening in an external app).</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">TRILIUM_ANONYMIZED_DB_DIR</code></td>\n<td><code spellcheck=\"false\">${TRILIUM_DATA_DIR}/anonymized-db</code></td>\n<td>Directory where a&nbsp;<a class=\"reference-link\" href=\"#root/_help_x59R8J8KV5Bp\">Anonymized Database</a>&nbsp;is stored.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">TRILIUM_CONFIG_INI_PATH</code></td>\n<td><code spellcheck=\"false\">${TRILIUM_DATA_DIR}/config.ini</code></td>\n<td>Path to&nbsp;<a class=\"reference-link\" href=\"#root/_help_Gzjqa934BdH4\">Configuration (config.ini or environment variables)</a>&nbsp;file.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">TRILIUM_ELECTRON_DATA_DIR</code></td>\n<td>System appData</td>\n<td>Directory for Electron internal data (caches, spell-check dictionaries, etc.). Set this in portable mode to avoid writing to the system profile (desktop only).</td>\n</tr>\n</tbody></table></figure>",
- "_help_x0JgW8UqGXvq": "<h2>Layouts</h2><p>Trilium supports two different layouts, based on your preference.</p><h3>Vertical layout</h3><p>The vertical layout is Trilium's original layout:</p><ul><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>&nbsp;is positioned on the left side of the screen, with buttons being laid out vertically.</li><li>The tab bar is at the top, but to the right of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</li><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_Ms1nauBra7gq\">Quick search</a>&nbsp;is at the top of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</li><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;can be collapsed by pressing the <img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/3_Vertical%20and%20horizontal%20layout_image.png\"> button at the bottom of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</li><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;can be accessed via the <img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/2_Vertical%20and%20horizontal%20layout_image.png\"> icon at the top of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</li></ul><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/1_Vertical%20and%20horizontal%20layout_image.jpg\"></p><h3>Horizontal layout</h3><p>The horizontal layout is a more traditional layout, since it bears similarity with other applications. In this mode:</p><ul><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>&nbsp;is at the top of the screen, with the buttons laid horizontally.</li><li>The tab bar is at the top of the screen, but now covers the entirety of the width, allowing for more tabs to be displayed at once.</li><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_Ms1nauBra7gq\">Quick search</a>&nbsp;is now part of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>. It can be moved around according to preference and even removed if needed.</li><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;can be collapsed by pressing the small <img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/1_Vertical%20and%20horizontal%20layout_image.png\"> button to the left of the first tab.</li><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;can be accessed via the <img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Vertical%20and%20horizontal%20layout_image.png\"> button at the end of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</li></ul><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Vertical%20and%20horizontal%20layout_image.jpg\"></p><h2>Changing the layout</h2><p>Go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;and look for the <em>Appearance</em> option on the left. Then look for the <em>Layout</em> section, where there is the possibility to switch between the two available layouts.</p><p>Selecting an option will immediately apply the new layout by reloading the window.</p>",
++ "_help_ODY7qQn5m2FT": "<p>Trilium supports simple backup scheme where it saves copy of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_wX4HbRucYSDD\">Database</a>&nbsp;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&nbsp;<a class=\"reference-link\" href=\"#root/_help_wX4HbRucYSDD\">Database</a>&nbsp;to cloud / different computer etc.</p><p>Note that&nbsp;<a class=\"reference-link\" href=\"#root/_help_cbkrhQjrkKrh\">Synchronization</a>&nbsp;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>&nbsp;On the desktop app &amp; web client</p><div class=\"trilium-tab-panel\"><ol><li>Go to&nbsp;<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>&nbsp;On the standalone client</p><div class=\"trilium-tab-panel\"><ol><li>Go to&nbsp;<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&nbsp;<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&nbsp;<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&nbsp;<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 (&nbsp;<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&nbsp;<a class=\"reference-link\" href=\"#root/_help_wX4HbRucYSDD\">Database</a>&nbsp;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&nbsp;<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.&nbsp;</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&nbsp;<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&nbsp;<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&nbsp;<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>",
++ "_help_tAassRL4RSQL": "<p>Data directory contains:</p><ul><li><code>document.db</code> - <a href=\"#root/_help_wX4HbRucYSDD\">database</a></li><li><code>config.ini</code> - instance level settings like port on which the Trilium application runs</li><li><code>backup</code> - contains automatically <a href=\"#root/_help_ODY7qQn5m2FT\">backup</a> of documents</li><li><code>log</code> - contains application log files</li></ul><h2>Location of the data directory</h2><p>Easy way how to find out which data directory Trilium uses is to look at the \"About Trilium Notes\" dialog (from \"Menu\" in upper left corner):</p><p><img src=\"{{helpAssets}}/User%20Guide/Installation%20%26%20Setup/Data%20directory_image.jpg\"></p><p>Here's how the location is decided:</p><p>Data directory is normally named <code>trilium-data</code> and it is stored in:</p><ul><li><code>/home/[user]/.local/share</code> for Linux</li><li><code>/home/[user]/.var/app/org.triliumnotes.Trilium/data</code> for the Flathub version on Linux</li><li><code>C:\\Users\\[user]\\AppData\\Roaming</code> for Windows Vista and up</li><li><code>/Users/[user]/Library/Application Support</code> for Mac OS</li><li>user's home is a fallback if some of the paths above don't exist</li><li>user's home is also a default setup for [[docker|Docker server installation]]</li></ul><p>If you want to back up your Trilium data, just backup this single directory - it contains everything you need.</p><h3>Changing the location of data directory</h3><p>If you want to use some other location for the data directory than the default one, you may change it via <code>TRILIUM_DATA_DIR</code> environment variable to some other location:</p><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-windows\"></span>&nbsp;Windows</p><div class=\"trilium-tab-panel\"><ol><li>Press the&nbsp;<span class=\"tn-icon bx bxl-windows\"></span> key on your keyboard.</li><li>Search and select <em>Edit the system variables</em>.</li><li>Press the <em>Environment Variables…</em> button in the bottom-right of the newly opened screen.</li><li>On the top section (<em>User variables for [user]</em>), press the <em>New…</em> button.</li><li>In the <em>Variable name</em> field insert <code>TRILIUM_DATA_DIR</code>.</li><li>Press the <em>Browse Directory…</em> button and select the new directory where to store the database.</li><li>Close all the windows by pressing the <em>OK</em> button for each of them.</li></ol></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-tux\"></span>&nbsp;Linux</p><div class=\"trilium-tab-panel\"><p>Trilium reads <code>TRILIUM_DATA_DIR</code> when it starts, so the variable must be set in the environment that launches it.</p><aside class=\"admonition note\"><p>Setting the variable does not move existing notes. To keep them, close Trilium and copy the old data directory to the new location first. Trilium creates the last folder of the path if it is missing, but not its parent folders.</p></aside><p><strong>Desktop application (.deb, .rpm, AppImage or .zip)</strong></p><p>To use the new location however Trilium is started (from the application menu, a desktop shortcut, at login or from a terminal), set the variable for the whole session:</p><ol><li><p>Create the file <code>~/.config/environment.d/trilium.conf</code> with the following content, using the full path (<code>~</code> is not expanded in this file):</p><pre><code class=\"language-text-x-trilium-auto\">TRILIUM_DATA_DIR=/home/myuser/data/my-trilium-data</code></pre></li><li><p>Log out and log back in.</p></li></ol><p>This works on desktops started by <code>systemd</code>, which covers most distributions running GNOME or KDE Plasma. On other systems, add the following line to <code>~/.profile</code> instead, then log out and log back in:</p><pre><code class=\"language-text-x-sh\">export TRILIUM_DATA_DIR=\"$HOME/data/my-trilium-data\"</code></pre><p>The same line in <code>~/.bashrc</code> (or your shell's equivalent) only applies when Trilium is started from a terminal, not from the application menu.</p><p><strong>Flatpak (Flathub)</strong></p><p>The Flathub version runs in a sandbox that cannot see the rest of the file system, so it needs access to the folder as well as the variable:</p><pre><code class=\"language-text-x-sh\">flatpak override --user \\\n --env=TRILIUM_DATA_DIR=/home/myuser/data/my-trilium-data \\\n --filesystem=/home/myuser/data/my-trilium-data:create \\\n org.triliumnotes.Trilium</code></pre><p>To return to the default location, run <code>flatpak override --user --reset org.triliumnotes.Trilium</code>. This also removes any other overrides set for Trilium.</p><p><strong>Server running as a systemd service</strong></p><p>Add an <code>Environment=</code> line to the <code>[Service]</code> section of the unit file described in&nbsp;<a class=\"reference-link\" href=\"#root/_help_3tW6mORuTHnB\">Packaged version for Linux</a>:</p><pre><code class=\"language-text-x-trilium-auto\">[Service]\nEnvironment=TRILIUM_DATA_DIR=/var/lib/trilium-data</code></pre><p>Then reload and restart the service:</p><pre><code class=\"language-text-x-sh\">sudo systemctl daemon-reload\nsudo systemctl restart trilium</code></pre><p>The user set in <code>User=</code> must be able to write to the folder. For Docker, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_rWX5eY045zbE\">Using Docker</a>&nbsp;instead.</p></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-apple\"></span>&nbsp;macOS</p><div class=\"trilium-tab-panel\"><p>You need to create a <code>.plist</code> file under <code>~/Library/LaunchAgents</code> to load it properly each login.</p><p>To load it manually, you need to use <code>launchctl setenv TRILIUM_DATA_DIR &lt;yourpath&gt;</code></p><p>Here is a pre-defined template, where you just need to add your path to:</p><pre><code class=\"language-text-xml\">&lt;?xml version=\"1.0\" encoding=\"UTF-8\"?&gt;\n&lt;!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\"&gt;\n&lt;plist version=\"1.0\"&gt;\n&lt;dict&gt;\n &lt;key&gt;Label&lt;/key&gt;\n &lt;string&gt;set.trilium.env&lt;/string&gt;\n &lt;key&gt;RunAtLoad&lt;/key&gt;\n &lt;true/&gt;\n &lt;key&gt;ProgramArguments&lt;/key&gt;\n &lt;array&gt;\n &lt;string&gt;/bin/launchctl&lt;/string&gt;\n &lt;string&gt;setenv&lt;/string&gt;\n &lt;string&gt;TRILIUM_DATA_DIR&lt;/string&gt;\n &lt;string&gt;/Users/YourUserName/Library/Application Support/trilium-data&lt;/string&gt;\n &lt;/array&gt;\n&lt;/dict&gt;\n&lt;/plist&gt;\n</code></pre></div></section></div><h3>Create a script to run with specific data directory</h3><p>An alternative to globally setting environment variable is to run only the Trilium Notes with this environment variable. This then allows for different setup styles like two <a href=\"#root/_help_wX4HbRucYSDD\">database</a> instances or \"portable\" installation.</p><p>To do this in Unix-based systems simply run <code>trilium</code> like this:</p><pre><code class=\"language-text-x-trilium-auto\">TRILIUM_DATA_DIR=/home/myuser/data/my-trilium-data trilium</code></pre><p>You can then save the above command as a shell script on your path for convenience.</p><h2>Electron user data directory (desktop only)</h2><p>When running the desktop application, Electron stores internal data (caches, spell-check dictionaries, session storage, etc.) separately from the Trilium data directory. By default this goes to the system's application data folder (e.g. <code>%APPDATA%</code> on Windows), which may be undesirable in corporate environments with roaming profiles or when running in portable mode.</p><p>To keep Electron data out of the system's roaming profile, set the <code>TRILIUM_ELECTRON_DATA_DIR</code> environment variable to an explicit path. The <code>trilium-portable</code> script does this automatically, pointing it to <code>trilium-electron-data/</code> next to the application.</p><h2>Fine-grained directory/path location</h2><p>Apart from the data directory, some of the subdirectories of it can be moved elsewhere by changing an environment variable:</p><figure class=\"table\"><table><thead><tr><th>Environment variable</th><th>Default value</th><th>Description</th></tr></thead><tbody><tr><td><code>TRILIUM_DOCUMENT_PATH</code></td><td><code>${TRILIUM_DATA_DIR}/document.db</code></td><td>Path to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_wX4HbRucYSDD\">Database</a>&nbsp;(storing all notes and metadata).</td></tr><tr><td><code>TRILIUM_BACKUP_DIR</code></td><td><code>${TRILIUM_DATA_DIR}/backup</code></td><td>Directory where automated&nbsp;<a class=\"reference-link\" href=\"#root/_help_ODY7qQn5m2FT\">Backup</a>&nbsp;databases are stored.</td></tr><tr><td><code>TRILIUM_LOG_DIR</code></td><td><code>${TRILIUM_DATA_DIR}/log</code></td><td>Directory where daily&nbsp;<a class=\"reference-link\" href=\"#root/_help_bnyigUA2UK7s\">Backend (server) logs</a>&nbsp;are stored.</td></tr><tr><td><code>TRILIUM_TMP_DIR</code></td><td><code>${TRILIUM_DATA_DIR}/tmp</code></td><td>Directory where temporary files are stored (for example when opening in an external app).</td></tr><tr><td><code>TRILIUM_ANONYMIZED_DB_DIR</code></td><td><code>${TRILIUM_DATA_DIR}/anonymized-db</code></td><td>Directory where a&nbsp;<a class=\"reference-link\" href=\"#root/_help_x59R8J8KV5Bp\">Anonymized Database</a>&nbsp;is stored.</td></tr><tr><td><code>TRILIUM_RESOURCES_DIR</code></td><td><code>${TRILIUM_DATA_DIR}/resources</code></td><td>Directory where <a class=\"reference-link\" href=\"#root/_help_ebyr7ES2SwOW\">Downloaded resources</a> are stored, such as the speech recognition models.</td></tr><tr><td><code>TRILIUM_CONFIG_INI_PATH</code></td><td><code>${TRILIUM_DATA_DIR}/config.ini</code></td><td>Path to&nbsp;<a class=\"reference-link\" href=\"#root/_help_Gzjqa934BdH4\">Configuration (config.ini or environment variables)</a>&nbsp;file.</td></tr><tr><td><code>TRILIUM_ELECTRON_DATA_DIR</code></td><td>System appData</td><td>Directory for Electron internal data (caches, spell-check dictionaries, etc.). Set this in portable mode to avoid writing to the system profile (desktop only).</td></tr></tbody></table></figure>",
++ "_help_ebyr7ES2SwOW": "<p>Downloaded resources are large files that some features need but that do not ship with Trilium, such as the speech recognition models used to transcribe meetings. Trilium downloads them the first time a feature needs them, and keeps them on the device for later use.</p><p>Currently, only&nbsp;<a class=\"reference-link\" href=\"#root/_help_Y84QCbArmK3z\">Meeting transcription</a>&nbsp;on the desktop application uses downloaded resources:</p><figure class=\"table\"><table><thead><tr><th>Resource</th><th>Size</th><th>License</th><th>Used for</th></tr></thead><tbody><tr><td>Parakeet TDT 0.6B v3 (standard)</td><td>0.6 GB</td><td>CC-BY-4.0</td><td>Recognizing speech, with the <em>Standard</em> model.</td></tr><tr><td>Parakeet TDT 0.6B v3 (high accuracy)</td><td>2.4 GB</td><td>CC-BY-4.0</td><td>Recognizing speech, with the <em>High accuracy</em> model.</td></tr><tr><td>Silero VAD</td><td>0.6 MB</td><td>MIT</td><td>Detecting when someone speaks.</td></tr><tr><td>TitaNet</td><td>40 MB</td><td>Apache-2.0</td><td>Telling speakers apart, while <em>Identify speakers</em> is on.</td></tr></tbody></table></figure><h2>Downloading resources</h2><p>When a feature needs resources that are not on the device yet, Trilium asks before downloading them. The dialog lists each resource with what it is used for, where it is downloaded from, its license and its size, followed by the total download size and the free space on the disk.</p><ul><li>To start the download, press <em>Download</em>. Each resource shows its progress, and the feature continues once all of them are downloaded.</li><li>To stop the download, press <em>Cancel</em> or close the dialog. The files already downloaded are kept, and the next download continues where this one stopped, even within a large file.</li><li>If the disk does not have enough free space, the dialog says so and the download cannot be started.</li></ul><p>Every file is checked against a checksum built into Trilium before it is used, so a file that was damaged or altered during the download is discarded.</p><aside class=\"admonition note\"><p>Downloaded resources are not synchronized. Each device that uses a feature downloads its resources separately, even when the notes are kept in sync through <a class=\"reference-link\" href=\"#root/_help_cbkrhQjrkKrh\">Synchronization</a>.</p></aside><h2>Managing downloaded resources</h2><p>To see the downloaded resources, go to <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Downloaded resources</em>. Each resource that was downloaded, or partly downloaded by an interrupted download, is listed with the space it takes on the disk and its status. Below the list, <em>Space used</em> shows the space they take in total, and how much free space is left on the disk.</p><ul><li>To open the folder of a resource, press the <span class=\"tn-icon bx bx-folder-open\"></span> button (desktop only).</li><li>To delete a resource, press the <span class=\"tn-icon bx bx-trash\"></span> button. If a feature needs it again, it is downloaded again.</li></ul><p>The list also shows, faded out, anything else in the resources folder:</p><ul><li><em>Older version</em>: the files of an earlier version of a resource. When a resource is updated, the new version is downloaded into a new folder, and the old one is left behind.</li><li><em>Not used</em>: a resource that no feature of this installation uses, for example one downloaded by a feature that was removed.</li><li><em>Unknown</em>: any other file or folder, for example one copied there by hand.</li></ul><p>These can be deleted in the same way.</p><aside class=\"admonition warning\"><p>If a server and a desktop application share the same data directory, a resource used by only one of them shows as <em>Not used</em> in the other. Deleting it there removes it for both.</p></aside><h2>Location</h2><p>The resources are stored in the <code>resources</code> folder of the <a class=\"reference-link\" href=\"#root/_help_tAassRL4RSQL\">Data directory</a>, one folder per resource. To store them elsewhere, set the <code>TRILIUM_RESOURCES_DIR</code> environment variable to another folder before starting Trilium.</p><h2>Installing without an Internet connection</h2><p>To install a resource on a device that cannot download it, copy its folder from the <code>resources</code> folder of a device that already has it into the same place on the other device. The next time a feature asks to download it, press <em>Download</em>: the files already in place are checked against their checksums and kept, and only the missing ones are downloaded.</p>",
++ "_help_x0JgW8UqGXvq": "<p>Trilium supports two different layouts, based on your preference.</p><h3>Vertical layout</h3><p>The vertical layout is Trilium's original layout:</p><ul><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>&nbsp;is positioned on the left side of the screen, with buttons being laid out vertically.</li><li>The tab bar is at the top, but to the right of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</li><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_Ms1nauBra7gq\">Quick search</a>&nbsp;is at the top of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</li><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;can be collapsed by pressing the&nbsp;<span class=\"tn-icon bx bx-chevrons-left\"></span> button at the bottom of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</li><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;can be accessed via the&nbsp;<span class=\"tn-icon cke cke-trilium\"></span> icon at the top of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</li></ul><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/1_Vertical%20and%20horizontal%20layout_image.jpg\"></p><h3>Horizontal layout</h3><p>The horizontal layout is a more traditional layout, since it bears similarity with other applications. In this mode:</p><ul><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>&nbsp;is at the top of the screen, with the buttons laid horizontally.</li><li>The tab bar is at the top of the screen, but now covers the entirety of the width, allowing for more tabs to be displayed at once.</li><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_Ms1nauBra7gq\">Quick search</a>&nbsp;is now part of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>. It can be moved around according to preference and even removed if needed.</li><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;can be collapsed by pressing the small&nbsp;<span class=\"tn-icon bx bx-sidebar\"></span> button to the left of the first tab.</li><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;can be accessed via the&nbsp;<span class=\"tn-icon bx bx-menu\"></span> button at the end of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</li></ul><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Vertical%20and%20horizontal%20layout_image.jpg\"></p><h2>Changing the layout</h2><p>Go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;and look for the <em>Appearance</em> option on the left. Then look for the <em>Layout</em> section, where there is the possibility to switch between the two available layouts.</p><p>Clicking an option will immediately apply the selected layout by reloading the window.</p>",
+ "_help_x3i7MxGccDuM": "<p>The global menu configures the current window (zoom, keeping the window on top) and offers access to some more advanced options.</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Global%20menu_image.jpg\"></p><h2>Accessing the global menu</h2><p>See&nbsp;<a href=\"#root/_help_x0JgW8UqGXvq\">Vertical and horizontal layout</a>&nbsp;since the position of the global menu is changed based on which layout has been selected.</p>",
- "_help_oPVyFC7WL2Lp": "<p>This page explains how to manipulate the note tree in TriliumNext, focusing on moving notes.</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree_image.jpg\"></p><h2>Drag and Drop</h2><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree_drag-and-drop.gif\" alt=\"Drag and drop example\"></p><p>You can easily rearrange the note tree by dragging and dropping notes, as demonstrated in the example above.</p><h2>Keyboard Manipulation</h2><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree_move-note-with-keyboard.gif\" alt=\"Example of using keyboard keys to move a note\">Trilium offers efficient keyboard-based manipulation using the following <a href=\"#root/_help_A9Oc6YKKc65v\">shortcuts</a>:</p><ul><li><kbd>Ctrl</kbd> + <kbd><span>↑</span></kbd> and <kbd>Ctrl</kbd> +<kbd><span>↓</span></kbd>: Move the note up or down in the order.</li><li><kbd>Ctrl</kbd>+<kbd><span>←</span></kbd>: Move the note up in the hierarchy by changing its parent to the note's grandparent.</li><li><kbd>Ctrl</kbd>+<kbd><span>→</span></kbd>: Move the note down in the hierarchy by setting its parent to the note currently above it (this action is best understood through a demo or hands-on experience).</li><li><kbd><span>←</span></kbd> and <kbd><span>→</span></kbd>: Expand and collapse a sub-tree.</li></ul><h2>Context Menu</h2><p>You can also move notes using the familiar cut and paste functions available in the context menu, or with the associated keyboard <a href=\"#root/_help_A9Oc6YKKc65v\">shortcuts</a>: <code spellcheck=\"false\">CTRL-C</code> ( <a href=\"#root/_help_IakOLONlIfGI\">copy</a>), <kbd>Ctrl</kbd> + <kbd>X</kbd> (cut) and <kbd>Ctrl</kbd> + <kbd>V</kbd> (paste).</p><p>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_YtSN43OrfzaA\">Note tree contextual menu</a>&nbsp;for more information.</p><h2>Tree Settings</h2><p>Click the tree icon in the tree toolbar to open the tree settings popup. It contains the following options:</p><ul><li><strong>Hide archived notes</strong>: When enabled, archived notes are not shown in the tree.</li><li><strong>Automatically collapse notes</strong>: When enabled, notes are collapsed after a period of inactivity to keep the tree tidy.</li><li><strong>Follow active note</strong>: When enabled (default), the tree automatically scrolls and expands parent nodes to keep the currently active note visible. When disabled, the tree is fully detached from navigation — only the background highlight of the active note is updated, but the tree viewport and its expanded/collapsed state are never changed by navigation. Use the crosshair button to manually jump the tree to the active note at any time.</li></ul><h2>Keyboard shortcuts</h2><p>The note tree comes with multiple keyboard shortcuts to make editing faster, consult the dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_DvdZhoQZY9Yd\">Keyboard shortcuts</a>&nbsp;section.</p>",
- "_help_YtSN43OrfzaA": "<figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:269/608;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree/1_Note%20tree%20contextual%20menu_image.png\" width=\"269\" height=\"608\"></figure><p>The <em>note tree menu</em> can be accessed by right-clicking in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</p><h2>Interaction</h2><p>The contextual menu can operate:</p><ul><li>On a single note, by right clicking it in the note tree.</li><li>On multiple notes, by selecting them first. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_yTjUdsOi4CIE\">Multiple selection</a>&nbsp;on how to do so.<ul><li>When right clicking, do note that usually the note being right clicked is also included in the affected notes, regardless of whether it was selected or not.</li></ul></li></ul><h2>Available options</h2><aside class=\"admonition note\"><p>When multiple notes are selected, only a subset of notes will be active. The ones that do support multiple notes will mention this in the list below.</p></aside><ul><li><strong>Open in a new tab</strong><ul><li>Will open a single note in a new <a href=\"#root/_help_3seOhtN8uLIY\">tab</a>.</li></ul></li><li><strong>Open in a new split</strong><ul><li>Will open a split to the right with the given note within the current tab.</li></ul></li><li><strong>Hoist note</strong><ul><li>Will focus the note tree on this note. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_OR8WJ7Iz9K4U\">Note Hoisting</a>&nbsp;for more information.</li></ul></li><li><strong>Insert note after</strong><ul><li>Allows easy creation of a note with a specified <a href=\"#root/_help_KSZ04uQ2D1St\">note type</a>.</li><li><a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>&nbsp;will also be present (if any) at the end of the list.</li><li>The note will be added on the same level of hierarchy as the note selected.</li></ul></li><li><strong>Insert child note</strong><ul><li>Same as <em>Insert note after</em>, but the note will be created as a child of the selected note.</li></ul></li><li><strong>Protect subtree</strong><ul><li>Will mark this note and all of its descendents as protected. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_bwg0e8ewQMak\">Protected Notes</a>&nbsp;for more information.</li></ul></li><li><strong>Unprotect subtree</strong><ul><li>Will unprotect this note and all of its descendents.</li></ul></li><li><strong>Cut</strong><ul><li>Will place the given notes in clipboard.</li><li>Use one of the two paste functions (or the keyboard shortcuts) to move them to the desired location.</li></ul></li><li><strong>Copy / clone</strong><ul><li>Will place the given notes in clipboard.</li><li>Use one of the two paste functions (or the keyboard shortcuts) to copy them to the desired location.</li><li>Note that the copy function here works according to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_IakOLONlIfGI\">Cloning Notes</a>&nbsp;functionality (i.e. the note itself will be present in two locations at once, and editing it in one place will edit it everywhere).</li><li>To simply create a duplicate note that can be modified independently, look for <em>Duplicate subtree</em>.</li></ul></li><li><strong>Paste into</strong><ul><li>If there are any notes in clipboard, they will be pasted as child notes to the right-clicked one.</li></ul></li><li><strong>Paste after</strong><ul><li>If there are any notes in clipboard, they will be pasted underneath the right-clicked one.</li></ul></li><li><strong>Move to…</strong><ul><li>Will display a modal to specify where to move the desired notes.</li></ul></li><li><strong>Clone to…</strong><ul><li>Will display a modal to specify where to <a href=\"#root/_help_IakOLONlIfGI\">clone</a> the desired notes.</li></ul></li><li><strong>Duplicate</strong><ul><li>Creates a copy of the note and its descendants.</li><li>This process is different from&nbsp;<a class=\"reference-link\" href=\"#root/_help_IakOLONlIfGI\">Cloning Notes</a>&nbsp;since the duplicated note can be edited independently from the original.</li><li>An alternative to this, if done regularly, would be&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>.</li></ul></li><li><strong>Archive/Unarchive</strong><ul><li>Marks a note as <a href=\"#root/_help_MKmLg5x6xkor\">archived</a>.</li><li>If the note is already archived, it will be unarchived instead.</li><li>Multiple notes can be selected as well. However, all the selected notes must be in the same state (archived or not), otherwise the option will be disabled.</li></ul></li><li><strong>Delete</strong><ul><li>Will delete the given notes, asking for confirmation first.</li><li>In the dialog, the following options can be configured:<ul><li><em>Delete also all clones</em> to ensure that the note will be deleted everywhere if it has been placed into multiple locations (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_IakOLONlIfGI\">Cloning Notes</a>).</li><li><em>Erase notes permanently</em> will ensure that the note cannot be recovered from&nbsp;<a class=\"reference-link\" href=\"#root/_help_r5JGHN99bVKn\">Recent Changes</a>.</li></ul></li></ul></li><li><strong>Import into note</strong><ul><li>Opens the <a href=\"#root/_help_mHbBMPDPkVV5\">import</a> dialog and places the imported notes as child notes of the selected one.</li></ul></li><li><strong>Export</strong><ul><li>Opens the <a href=\"#root/_help_mHbBMPDPkVV5\">export</a> dialog for the selected notes.</li></ul></li><li><strong>Search in subtree</strong><ul><li>Opens a full&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>&nbsp;with it preconfigured to only look into this note and its descendants (the <em>Ancestor</em> field).</li></ul></li></ul><h2>Advanced options</h2><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:231/263;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree/Note%20tree%20contextual%20menu_image.png\" width=\"231\" height=\"263\"></figure><p>The advanced options menu offers some of the less frequently used actions for notes.</p><p>To access these options, first look for the <em>Advanced</em> option in the contextual menu to reveal a sub-menu with:</p><ul><li><strong>Apply bulk actions</strong><ul><li>Opens the&nbsp;<a class=\"reference-link\" href=\"#root/_help_ivYnonVFBxbQ\">Bulk Actions</a>&nbsp;dialog, to apply actions such as adding labels or moving notes to multiple notes at once (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_yTjUdsOi4CIE\">Multiple selection</a>).</li></ul></li><li><strong>Edit branch prefix</strong><ul><li>Opens a dialog to assign a name to be able to distinguish <a href=\"#root/_help_IakOLONlIfGI\">clones</a>, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_TBwsyfadTA18\">Branch prefix</a>&nbsp;for more information.</li></ul></li><li><strong>Convert to attachment</strong><ul><li>Converts the selected notes to&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>&nbsp;of their parent notes.</li><li>This functional is most useful when dealing with image&nbsp;<a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a>&nbsp;notes that were imported from an external source or an older version of Trilium.</li></ul></li><li><strong>Expand subtree</strong><ul><li>Expands all the child notes in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</li></ul></li><li><strong>Collapse subtree</strong><ul><li>Collapses all the child notes in the note tree.</li></ul></li><li><strong>Sort by…</strong><ul><li>Opens a dialog to sort all the child notes of the selected note.</li><li>The sorting is done only once, there is an automatic sorting mechanism as well that can be set using&nbsp;<a class=\"reference-link\" href=\"#root/_help_zEY4DaJG4YT5\">Attributes</a>.</li><li>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_aGlEvb9hyDhS\">Sorting Notes</a>&nbsp;for more information.</li></ul></li><li><strong>Copy note path to clipboard</strong><ul><li>Copies a URL fragment representing the full path to this branch for a note, such as <code spellcheck=\"false\">#root/Hb2E70L7HPuf/4sRFgMZhYFts/2IVuShedRJ3U/LJVMvKXOFv7n</code>.</li><li>The URL to manually create&nbsp;<a class=\"reference-link\" href=\"#root/_help_QEAPj01N5f7w\">Links</a>&nbsp;within notes, or for note&nbsp;<a class=\"reference-link\" href=\"#root/_help_wArbEsdSae6g\">Navigation</a>.</li></ul></li><li><strong>Recent changes in subtree</strong><ul><li>This will open&nbsp;<a class=\"reference-link\" href=\"#root/_help_r5JGHN99bVKn\">Recent Changes</a>, but filtered to only the changes related to this note or one of its descendants.</li></ul></li></ul>",
++ "_help_oPVyFC7WL2Lp": "<p>This page explains how to manipulate the note tree in TriliumNext, focusing on moving notes.</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree_image.jpg\"></p><h2>Drag and Drop</h2><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree_drag-and-drop.gif\" alt=\"Drag and drop example\"></p><p>You can easily rearrange the note tree by dragging and dropping notes, as demonstrated in the example above.</p><h3>Importing files</h3><p>A file or archive can easily be imported into Trilium just by dragging it inside the note tree.</p><p>Note that a drag &amp; drop always imports with <em>safe import</em> on, meaning that some features such as scripts are disabled in the upcoming notes. To bypass that, use the dedicated <a href=\"#root/_help_mHbBMPDPkVV5\">import</a> feature (right click → <em>Import into note</em>).</p><p>Unlike the import dialog, the drag &amp; drop also has some basic auto-detection of the import. For example, dragging a .zip file with a <code>.obsidian</code> folder in it will automatically trigger a dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_iWD7wiIuMtgV\">Obsidian</a>&nbsp;import.</p><h2>Keyboard Manipulation</h2><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree_move-note-with-keyboard.gif\" alt=\"Example of using keyboard keys to move a note\">Trilium offers efficient keyboard-based manipulation using the following <a href=\"#root/_help_A9Oc6YKKc65v\">shortcuts</a>:</p><ul><li><kbd>Ctrl</kbd> + <kbd>↑</kbd> and <kbd>Ctrl</kbd> +<kbd>↓</kbd>: Move the note up or down in the order.</li><li><kbd>Ctrl</kbd>+<kbd>←</kbd>: Move the note up in the hierarchy by changing its parent to the note's grandparent.</li><li><kbd>Ctrl</kbd>+<kbd>→</kbd>: Move the note down in the hierarchy by setting its parent to the note currently above it (this action is best understood through a demo or hands-on experience).</li><li><kbd>←</kbd> and <kbd>→</kbd>: Expand and collapse a sub-tree.</li></ul><h2>Context Menu</h2><p>You can also move notes using the familiar cut and paste functions available in the context menu, or with the associated keyboard <a href=\"#root/_help_A9Oc6YKKc65v\">shortcuts</a>: <code>CTRL-C</code> ( <a href=\"#root/_help_IakOLONlIfGI\">copy</a>), <kbd>Ctrl</kbd> + <kbd>X</kbd> (cut) and <kbd>Ctrl</kbd> + <kbd>V</kbd> (paste).</p><p>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_YtSN43OrfzaA\">Note tree contextual menu</a>&nbsp;for more information.</p><h2>Tree Settings</h2><p>Click the tree icon in the tree toolbar to open the tree settings popup. It contains the following options:</p><ul><li><em>Hide archived notes</em>: When enabled, archived notes are not shown in the tree.</li><li><em>Automatically collapse notes</em>: When enabled, notes are collapsed after a period of inactivity to keep the tree tidy.</li><li><em>Follow active note</em>: When enabled (default), the tree automatically scrolls and expands parent nodes to keep the currently active note visible. When disabled, the tree is fully detached from navigation — only the background highlight of the active note is updated, but the tree viewport and its expanded/collapsed state are never changed by navigation. Use the crosshair button to manually jump the tree to the active note at any time.</li></ul><h2>Keyboard shortcuts</h2><p>The note tree comes with multiple keyboard shortcuts to make editing faster, consult the dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_DvdZhoQZY9Yd\">Keyboard shortcuts</a>&nbsp;section.</p>",
++ "_help_YtSN43OrfzaA": "<figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:269/608;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree/1_Note%20tree%20contextual%20menu_image.png\" width=\"269\" height=\"608\"></figure><p>The <em>note tree menu</em> can be accessed by right-clicking in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</p><h2>Interaction</h2><p>The contextual menu can operate:</p><ul><li>On a single note, by right clicking it in the note tree.</li><li>On multiple notes, by selecting them first. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_yTjUdsOi4CIE\">Multiple selection</a>&nbsp;on how to do so.<ul><li>When right clicking, do note that usually the note being right clicked is also included in the affected notes, regardless of whether it was selected or not.</li></ul></li></ul><h2>Available options</h2><aside class=\"admonition note\"><p>When multiple notes are selected, only a subset of notes will be active. The ones that do support multiple notes will mention this in the list below.</p></aside><p>The most frequent actions stand side by side at the top of the menu, each as an icon over its name. Use <kbd>←</kbd> and <kbd>→</kbd>, or <kbd>↑</kbd> and <kbd>↓</kbd>, to move between them.</p><ul><li><strong>Cut</strong><ul><li>Will place the given notes in clipboard.</li><li>Use one of the two paste functions (or the keyboard shortcuts) to move them to the desired location.</li></ul></li><li><strong>Clone</strong><ul><li>Will place the given notes in clipboard.</li><li>Use one of the two paste functions (or the keyboard shortcuts) to copy them to the desired location.</li><li>Note that the copy function here works according to the <a class=\"reference-link\" href=\"#root/_help_IakOLONlIfGI\">Cloning Notes</a> functionality (i.e. the note itself will be present in two locations at once, and editing it in one place will edit it everywhere).</li><li>To simply create a duplicate note that can be modified independently, look for <em>Duplicate</em>.</li></ul></li><li><strong>Paste into</strong><ul><li>Pastes the notes in clipboard as child notes of the right-clicked one.</li><li>Shown only after notes have been cut or cloned.</li></ul></li><li><strong>Paste after</strong><ul><li>Pastes the notes in clipboard underneath the right-clicked one.</li><li>Shown only after notes have been cut or cloned.</li></ul></li><li><strong>Delete…</strong><ul><li>Will delete the given notes, asking for confirmation first.</li><li>In the dialog, the following options can be configured:<ul><li><em>Delete also all clones</em> to ensure that the note will be deleted everywhere if it has been placed into multiple locations (see <a class=\"reference-link\" href=\"#root/_help_IakOLONlIfGI\">Cloning Notes</a>).</li><li><em>Erase notes permanently</em> will ensure that the note cannot be recovered from <a class=\"reference-link\" href=\"#root/_help_r5JGHN99bVKn\">Recent Changes</a>.</li></ul></li></ul></li></ul><p>The rest of the menu lists its options one per row:</p><ul><li><strong>Open note</strong><ul><li>Clicking it opens the note in a new <a href=\"#root/_help_3seOhtN8uLIY\">tab</a>.</li><li>Hovering it or clicking its arrow opens a submenu with the places the note can be opened in: <em>Open in a new tab</em>, <em>Open in a new split</em> (to the right of the note, within the current tab) and <em>Open in a new window</em>.</li></ul></li><li><strong>Quick edit</strong><ul><li>Opens the note in <a class=\"reference-link\" href=\"#root/_help_ZjLYv08Rp3qC\">Quick edit</a>, over the current one.</li></ul></li><li><strong>Hoist note</strong><ul><li>Will focus the note tree on this note. See <a class=\"reference-link\" href=\"#root/_help_OR8WJ7Iz9K4U\">Note Hoisting</a> for more information.</li></ul></li><li><strong>Insert note after</strong><ul><li>Allows easy creation of a note with a specified <a href=\"#root/_help_KSZ04uQ2D1St\">note type</a>.</li><li>The <em>Code</em> submenu starts with the scripting notes, each a code note set up for its role: <em>Custom CSS</em> (with <code>#appCss</code>), <em>Widget</em> (with <code>#widget</code> and a starting skeleton) and <em>Backend script</em>. The enabled code languages follow.</li><li><a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a> are grouped in the <em>Collection</em> submenu. The note types created less often, the <a class=\"reference-link\" href=\"#root/_help_B2ORr7OVEZtc\">Snippets</a> and the AI quick action are in the <em>More</em> submenu.</li><li><a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a> will also be present (if any) at the end of the list.</li><li>To find an entry quickly, type into the search box at the top of the submenu, or just start typing while the submenu is open. The submenu then lists every matching entry, including those inside its own submenus (such as a code language or a collection), each with the submenu it comes from. Use <kbd>↑</kbd> and <kbd>↓</kbd> to pick a match, <kbd>Enter</kbd> to create it, and <kbd>Esc</kbd> to clear the search.</li><li>The note will be added on the same level of hierarchy as the note selected.</li></ul></li><li><strong>Insert child note</strong><ul><li>Same as <em>Insert note after</em>, but the note will be created as a child of the selected note.</li></ul></li><li><strong>Move to…</strong><ul><li>Will display a modal to specify where to move the desired notes.</li></ul></li><li><strong>Clone to…</strong><ul><li>Will display a modal to specify where to <a href=\"#root/_help_IakOLONlIfGI\">clone</a> the desired notes.</li></ul></li><li><strong>Duplicate</strong><ul><li>Creates a copy of the note and its descendants, placed right after the original.</li><li>When the note has child notes, the item also has an arrow, set apart by a divider. Hovering the item or clicking the arrow opens a submenu:<ul><li><em>Note and its children</em> does the same as clicking <em>Duplicate</em>.</li><li><em>This note only</em> copies the note with its content and attributes, but without any of its child notes. Links and relations to the original children keep pointing at them.</li></ul></li><li>This process is different from <a class=\"reference-link\" href=\"#root/_help_IakOLONlIfGI\">Cloning Notes</a> since the duplicated note can be edited independently from the original.</li><li>An alternative to this, if done regularly, would be <a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>.</li></ul></li><li><strong>Archive/Unarchive</strong><ul><li>Marks a note as <a href=\"#root/_help_MKmLg5x6xkor\">archived</a>.</li><li>If the note is already archived, it will be unarchived instead.</li><li>Multiple notes can be selected as well. However, all the selected notes must be in the same state (archived or not), otherwise the option will be disabled.</li></ul></li><li><strong>Protect subtree/Unprotect subtree</strong><ul><li>On a note that is not protected, <em>Protect subtree</em> marks this note and all of its descendants as protected. On a protected note, the item reads <em>Unprotect subtree</em> and unprotects them instead. See <a class=\"reference-link\" href=\"#root/_help_bwg0e8ewQMak\">Protected Notes</a> for more information.</li><li>Hovering the item or clicking its arrow opens a submenu with both actions, for instance to unprotect the protected notes below a note that is not protected itself.</li></ul></li><li><strong>Import into note…</strong><ul><li>Opens the <a href=\"#root/_help_mHbBMPDPkVV5\">import</a> dialog and places the imported notes as child notes of the selected one.</li></ul></li><li><strong>Export…</strong><ul><li>Opens the <a href=\"#root/_help_mHbBMPDPkVV5\">export</a> dialog for the selected notes.</li></ul></li><li><strong>Search in subtree</strong><ul><li>Opens a full&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>&nbsp;with it preconfigured to only look into this note and its descendants (the <em>Ancestor</em> field).</li></ul></li></ul><h2>Advanced options</h2><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:231/263;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree/Note%20tree%20contextual%20menu_image.png\" width=\"231\" height=\"263\"></figure><p>The advanced options menu offers some of the less frequently used actions for notes.</p><p>To access these options, first look for the <em>Advanced</em> option at the bottom of the contextual menu to reveal a sub-menu with:</p><ul><li><strong>Apply bulk actions…</strong><ul><li>Opens the&nbsp;<a class=\"reference-link\" href=\"#root/_help_ivYnonVFBxbQ\">Bulk Actions</a>&nbsp;dialog, to apply actions such as adding labels or moving notes to multiple notes at once (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_yTjUdsOi4CIE\">Multiple selection</a>).</li></ul></li><li><strong>Edit branch prefix…</strong><ul><li>Opens a dialog to assign a name to be able to distinguish <a href=\"#root/_help_IakOLONlIfGI\">clones</a>, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_TBwsyfadTA18\">Branch prefix</a>&nbsp;for more information.</li></ul></li><li><strong>Convert to attachment…</strong><ul><li>Converts the selected notes to&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>&nbsp;of their parent notes.</li><li>This functional is most useful when dealing with image&nbsp;<a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a>&nbsp;notes that were imported from an external source or an older version of Trilium.</li></ul></li><li><strong>Expand subtree</strong><ul><li>Expands all the child notes in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</li></ul></li><li><strong>Collapse subtree</strong><ul><li>Collapses all the child notes in the note tree.</li></ul></li><li><strong>Sort by…</strong><ul><li>Opens a dialog to sort all the child notes of the selected note.</li><li>The sorting is done only once, there is an automatic sorting mechanism as well that can be set using&nbsp;<a class=\"reference-link\" href=\"#root/_help_zEY4DaJG4YT5\">Attributes</a>.</li><li>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_aGlEvb9hyDhS\">Sorting Notes</a>&nbsp;for more information.</li></ul></li><li><strong>Copy note path to clipboard</strong><ul><li>Copies a URL fragment representing the full path to this branch for a note, such as <code>#root/Hb2E70L7HPuf/4sRFgMZhYFts/2IVuShedRJ3U/LJVMvKXOFv7n</code>.</li><li>The URL to manually create&nbsp;<a class=\"reference-link\" href=\"#root/_help_QEAPj01N5f7w\">Links</a>&nbsp;within notes, or for note&nbsp;<a class=\"reference-link\" href=\"#root/_help_wArbEsdSae6g\">Navigation</a>.</li></ul></li><li><strong>Recent changes in subtree</strong><ul><li>This will open&nbsp;<a class=\"reference-link\" href=\"#root/_help_r5JGHN99bVKn\">Recent Changes</a>, but filtered to only the changes related to this note or one of its descendants.</li></ul></li></ul>",
+ "_help_yTjUdsOi4CIE": "<p>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, it's possible to select multiple notes at one time. This won't affect the currently displayed note, but it allows to do batch operations.</p><h2>Types of multiple selection</h2><figure class=\"image image-style-align-right image_resized\" style=\"width:28.54%;\"><img style=\"aspect-ratio:335/306;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree/Multiple%20selection_image.png\" width=\"335\" height=\"306\"></figure><h3>Selecting notes one by one</h3><p>To individually select each note, press the <kbd>Alt</kbd> key and click on the note to be selected.</p><p>The selected notes will be indicated via a different background color and an icon.</p><h3>Selecting notes in a sequence</h3><figure class=\"image image-style-align-right image_resized\" style=\"width:29.24%;\"><img style=\"aspect-ratio:233/205;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree/Multiple%20selection_image.jpg\" width=\"233\" height=\"205\"></figure><p>When notes are in a sequence (e.g. one underneath the other), the entire selection can be made just by selecting the first and the last item instead of individually clicking all the notes.</p><p>To do so, first select the note to start the selection with. Then hold <kbd>Shift</kbd> and click on the note to end the selection with. All the notes between the start and the end note will be selected as well.</p><h2>Selected notes vs. active note</h2><p>There is a distinction between <em>selected notes</em> and the <em>active note</em>:</p><ul><li><em>Selected notes</em> are simply the notes that were selected in the multiple section process (i.e. either via <kbd>Alt</kbd> or <kbd>Shift</kbd>).</li><li>The <em>active note</em> is simply the note that whose content is being displayed to the right of the tree.<ul><li><p>Visually, it's identified in the tree by having a different background color and a subtle shadow.</p></li><li><p>The active note can also be selected case in which the icon and background will also change:</p><img class=\"image_resized\" style=\"aspect-ratio:317/223;width:35.1%;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree/1_Multiple%20selection_image.png\" width=\"317\" height=\"223\"></li></ul></li></ul>",
+ "_help_DvdZhoQZY9Yd": "<p>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;comes with multiple keyboard shortcuts to make editing faster:</p><h2>Navigation within the tree</h2><ul><li><kbd><span>↑</span></kbd> and <kbd><span>↑</span></kbd> to navigate between notes.</li><li><kbd><span>←</span></kbd> to collapse a note with children, or <kbd><span>→</span></kbd> to expand it.</li><li><kbd><span>←</span></kbd> on a note with no children to navigate to its parent.</li></ul><h2>Opening notes</h2><ul><li><kbd>Click</kbd> to open the note in the current tab.</li><li><kbd>Ctrl</kbd>+<kbd>Click</kbd> or <kbd>Middle click</kbd> to open the note in a new tab.</li><li><kbd>Ctrl</kbd>+<kbd>Right click</kbd> to open the note in&nbsp;<a class=\"reference-link\" href=\"#root/_help_ZjLYv08Rp3qC\">Quick edit</a>.</li></ul><h2>Clipboard management</h2><ul><li><kbd>Ctrl</kbd>+<kbd>C</kbd> to copy one or more notes based on selection (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_IakOLONlIfGI\">Cloning Notes</a>).</li><li><kbd>Ctrl</kbd>+<kbd>X</kbd> to cut one or more notes (for moving them).</li><li><kbd>Ctrl</kbd>+<kbd>V</kbd> to paste them somewhere (which results in a copy or move based on the shortcut used).</li></ul><h2>Moving notes</h2><ul><li><kbd>Ctrl</kbd> + <kbd><span>↑</span></kbd> , <kbd>Ctrl</kbd> + <kbd><span>↓</span></kbd> - move note up/down in the note list.</li><li><kbd>Ctrl</kbd> + <kbd><span>←</span></kbd> - move note up in the note tree.</li><li><kbd>Ctrl</kbd>+<kbd><span>→</span></kbd> - move note down in the note tree.</li><li><kbd>Del</kbd> - deletes note and optionally its subtree (asked in the dialog).</li></ul><h2>Multiple selection</h2><p>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_yTjUdsOi4CIE\">Multiple selection</a>&nbsp;for more information about how selection works.</p><ul><li><kbd>Alt</kbd>+<kbd>Click</kbd> – add a single note to the current selection.</li><li><kbd>Shift</kbd>+<kbd>Click</kbd> – select a range of notes, starting from the current note (the highlighted one) to the one that is being clicked.</li><li><kbd>Shift</kbd>+<kbd><span>↑</span></kbd>, <kbd>Shift</kbd>+<kbd><span>↓</span></kbd> – multi-select not above/below.</li><li><kbd>Ctrl</kbd>+<kbd>A</kbd> – select all notes in the current level</li></ul>",
+ "_help_wyaGBBQrl4i3": "<figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:328/45;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree/1_Hiding%20the%20subtree_image.png\" width=\"328\" height=\"45\"><figcaption>An example of a collection with a relatively large number of children that are hidden from the tree.</figcaption></figure><p>The tree works well when the notes are structured in a hierarchy so that the number of items stays small. When a note has a large number of notes (in the order of thousands or tens of thousands), two problems arise:</p><ul><li>Navigating between notes becomes cumbersome and the tree itself gets cluttered with a large amount of notes.</li><li>The large amount of notes can slow down the application considerably.</li></ul><p>Since v0.102.0, Trilium allows the tree to hide the child notes of particular notes. This works for both&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>&nbsp;and normal notes.</p><h2>Interaction</h2><p>When the subtree of a note is hidden, there are a few subtle changes:</p><ul><li>To indicate that the subtree is hidden, the note will not have an expand button and it will display the number of children to the right.</li><li>It's not possible to add a new note directly from the tree.<ul><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>, it's best to use the built-in mechanism to create notes (for example by creating a new point on a geo-map, or by adding a new row in a table).</li><li>For normal notes, it's still possible to create children via other means such as using the&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;system.</li></ul></li><li>Notes can be dragged from outside the note, case in which they will be cloned into it.<ul><li>Instead of switching to the child notes that were copied, the parent note is highlighted instead.</li><li>A notification will indicate this behavior.</li></ul></li><li>Similarly, features such as cut/copy and then paste into the note will also work.</li></ul><h2>Spotlighting</h2><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:322/83;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree/Hiding%20the%20subtree_image.png\" width=\"322\" height=\"83\"></figure><p>Even if the subtree of a note is hidden, if a child note manages to become active, it will still appear inside the tree in a special state called <em>spotlighted</em>.</p><p>During this state, the note remains under its normal hierarchy, so that its easy to tell its location. In addition, this means that:</p><ul><li>The note position is clearly visible when using the&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>.</li><li>The note can still be operated on from the tree, such as adding a&nbsp;<a class=\"reference-link\" href=\"#root/_help_TBwsyfadTA18\">Branch prefix</a>&nbsp;or moving it outside the collection.</li></ul><p>The note appears in italics to indicate its temporary display. When switching to another note, the spotlighted note will disappear.</p><aside class=\"admonition note\"><p>Only one note can be highlighted at the time. When working with multiple notes such as dragging them into the collection, no note will be spotlighted. This is intentional to avoid displaying a partial state of the subtree.</p></aside><h2>Working with collections</h2><p>For large collections, it can be helpful to hide their child notes for performance reasons or de-cluttering the tree.</p><p>To toggle this behavior:</p><ul><li>Open the collection and in&nbsp;<a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>, look for <em>Hide child notes in tree</em>.</li><li>Right click the collection note in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and select <em>Advanced</em> → <em>Show subtree</em>.</li></ul><h2>Working with normal notes</h2><p>It's possible to hide the subtree for normal notes as well, not just collections. To do so, right click the note in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and select <em>Advanced</em> → <em>Hide subtree.</em></p>",
- "_help_BlN9DFI679QC": "<p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon_image.jpg\"></p><p>The ribbon allows changing options, attributes and viewing information about the current note.</p><h2>Settings</h2><p>It is possible to change whether some ribbon items will be automatically open when navigating to a new note. To do so, in&nbsp;<a href=\"#root/_help_4TIF1oA4VQRO\">Settings</a>, go to <em>Appearance</em> and look for the <em>Ribbon widgets</em> section.</p><h2>Formatting</h2><p>If you are using the <em>Fixed</em> formatting toolbar, all the formatting buttons for text notes will appear here. See&nbsp;<a href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>&nbsp;for more information.</p><h2>Tabs</h2><h3>Basic Properties</h3><ul><li><em><strong>Note type</strong></em> allows changing the <a href=\"#root/_help_KSZ04uQ2D1St\">note type</a> of a note.<ul><li>Generally this is desirable only if the note is empty.</li><li>As a more advanced use, it's possible to change the note type in order to modify the <a href=\"#root/_help_4FahAwuGTAwC\">source code</a> of a note.</li></ul></li><li><em><strong>Protect the note</strong></em> toggles whether the current note is encrypted and accessible only by entering the protected session. See&nbsp;<a href=\"#root/_help_bwg0e8ewQMak\">Protected Notes</a>&nbsp;for more information.</li><li><em><strong>Editable</strong></em> changes whether the current note:<ul><li>Enters <a href=\"#root/_help_CoFPLs3dRlXc\">read-only mode</a> automatically if the note is too big (default behavior).</li><li>Is always in read-only mode (however it can still be edited temporarily).</li><li>Is always editable, regardless of its size.</li></ul></li><li><em><strong>Bookmark</strong></em> toggles the display of the current note into the&nbsp;<a href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>&nbsp;for easy access. See&nbsp;<a href=\"#root/_help_u3YFHC9tQlpm\">Bookmarks</a>&nbsp;for more information.</li><li><em><strong>Shared</strong></em> toggles whether the current note is publicly accessible if you have a <a href=\"#root/_help_WOcw2SLH6tbX\">server instance</a> set up. See&nbsp;<a href=\"#root/_help_R9pX4DGra2Vt\">Sharing</a>&nbsp;for more information.</li><li><em><strong>Template</strong></em> toggles whether the current note is considered a template and can be used to easily create notes with the same content. See&nbsp;<a href=\"#root/_help_KC1HB96bqqHX\">Template</a>&nbsp;for more information.</li><li><em><strong>Language</strong></em> changes the main language of the current note, mostly useful for spell checking or right-to-left support. See&nbsp;<a href=\"#root/_help_veGu4faJErEM\">Content language &amp; Right-to-left support</a>&nbsp;for more information.</li></ul><h3>Owned Attributes</h3><p>This section allows editing the labels and relations of a note. For more information, see&nbsp;<a href=\"#root/_help_zEY4DaJG4YT5\">Attributes</a>.</p><p>The plus button to the right offers a simplified way to insert labels and relations, via a graphical input. From this menu, it's also possible to define label and relation definitions (see&nbsp;<a href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>).</p><h3>Inherited Attributes</h3><p>This section displays the attributes which are applied to this note via&nbsp;<a href=\"#root/_help_bwZpz2ajCEwO\">Attribute Inheritance</a>. It is not possible to alter the attributes from this section.</p><h3>Note Paths</h3><p>This section displays all the places where the current note has been cloned to. Here the current note can also be cloned to a new location (similar to the&nbsp;<a href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>) See&nbsp;<a href=\"#root/_help_IakOLONlIfGI\">Cloning Notes</a>&nbsp;for more information.</p><h3>Note Map</h3><p>The note map displays all the relations of the current note to other notes, as well as the subtree structure. See&nbsp;<a href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;for more information.</p><h3>Similar Notes</h3><p>This section lists all the notes that are similar to the current one. See&nbsp;<a href=\"#root/_help_xWtq5NUHOwql\">Similar Notes</a>&nbsp;for more information.</p><h3>Note Info</h3><p>This section displays information about the current note:</p><ul><li>The <a href=\"#root/_help_m1lbrzyKDaRB\">internal ID</a> of the note.</li><li>The <a href=\"#root/_help_KSZ04uQ2D1St\">type of the note</a>, as well as its MIME type (used mostly for exporting notes).</li><li>The created and modification dates.</li><li>The estimated size of the note in the&nbsp;<a href=\"#root/_help_wX4HbRucYSDD\">Database</a>, as well as its children count and size.</li></ul><h3>Edited notes</h3><p>This section pops automatically when entering a <a href=\"#root/_help_l0tKav7yLHGF\">day note</a> and shows the notes that were edited that day.</p><p>It is possible to disable this behavior from settings, by going to&nbsp;<a class=\"reference-link\" href=\"#root/_hidden/_options/_optionsAppearance\">Appearance</a>&nbsp;settings and looking for the <em>Ribbon widgets</em> section.</p>",
- "_help_3seOhtN8uLIY": "<figure class=\"image image-style-align-center\"><img style=\"aspect-ratio:1119/43;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/2_Tabs_image.png\" width=\"1119\" height=\"43\"></figure><p>In Trilium, tabs allow easy switching between notes.</p><h2>Layout</h2><p>Depending on the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x0JgW8UqGXvq\">Vertical and horizontal layout</a>:</p><ul><li>For the vertical layout, the tabs will be placed at the top but to the right of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</li><li>For the horizontal layout, the tabs will be placed at the top in full-width, above the&nbsp;<a href=\"#root/_help_oPVyFC7WL2Lp\">note tree</a>, allowing for more tabs to be comfortably displayed.</li></ul><h2>Interaction</h2><ul><li>To create a new tab, press the <img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/1_Tabs_image.png\"> button that is to the right of the last tab.</li><li>To close a tab, press the corresponding <img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Tabs_image.png\"> button.</li><li>For multitasking, tabs can be used alongside&nbsp;<a class=\"reference-link\" href=\"#root/_help_luNhaphA37EO\">Split View</a>. Each tab can have one or more notes, displayed horizontally.</li><li>Tabs can be reordered by drag-and-dropping it into a new position.</li><li>An existing tab can be displayed in a new window by dragging the tab upwards or downwards. It is not possible to combine tabs back into another window.</li></ul><h2>Keyboard interaction</h2><p>Since tabs are a commonly used feature, there are multiple keyboard shortcuts that can be used:</p><ul><li><kbd>Ctrl</kbd>+<kbd>T</kbd> to open a new tab.</li><li><kbd>Ctrl</kbd>+<kbd>W</kbd> to close the current tab.</li><li><kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>T</kbd> to reopen the last closed tab.</li><li><kbd>Ctrl</kbd>+<kbd>Tab</kbd> and <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Tab</kbd> to go to the next or previous tab.</li><li><kbd>Ctrl</kbd>+<kbd>1</kbd>, <kbd>Ctrl</kbd>+<kbd>2</kbd>, up to <kbd>Ctrl</kbd>+<kbd>9</kbd> to activate the first, second and up to ninth tab.</li><li>There is also a shortcut to go to the last tab, but it is not assigned a key by default.</li></ul><h2>Mobile</h2><figure class=\"image image-style-align-right image_resized\" style=\"width:34.12%;\"><img style=\"aspect-ratio:1242/2688;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Tabs_IMG_1767.PNG\" width=\"1242\" height=\"2688\"></figure><p>Tabs are also supported on the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RDslemsQ6gCp\">Mobile Frontend</a>.</p><p>Since v0.102.0, the tabs are displayed by pressing the dedicated tab switcher button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>. In this view the tabs are laid out on a grid with a preview of the note content.</p><p>The context menu button at the top-right of the popup allows creating a new tab, reopening the last closed tab and closing all the tabs.</p><p><a class=\"reference-link\" href=\"#root/_help_luNhaphA37EO\">Split View</a>s are also indicated in the tab switcher, with two titles displayed in a tab.</p><aside class=\"admonition note\"><p>Versions prior to v0.102.0 also supported tabs, but they were displayed directly above the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>. The decision to use a more mobile-like tab switcher was taken because the original tab bar could not support many tabs at once and the new design better aligns with how mobile applications handle tabs.</p></aside>",
- "_help_xYmIYSP6wE3F": "<h2>Position of the Launch bar</h2><p>On desktop, depending on the layout selected, the launcher bar will either be on the left side of the screen with buttons displayed vertically or at the top of the screen. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_x0JgW8UqGXvq\">Vertical and horizontal layout</a>&nbsp;for more information.</p><p>On mobile, the launch bar will always be at the bottom.</p><p>If there are too many items in the launch bar to fit the screen, it will become scrollable.</p><h2>Terminology</h2><ul><li><strong>Launcher</strong>: a button that can be (or is) displayed on the launch bar.</li><li><strong>Available Launcher</strong>: a launcher that is not displayed on the launch bar, but can be added.</li><li><strong>Visible Launcher</strong>: a launcher that is currently displayed on the launch bar.</li></ul><h2>Configuring the desktop Launch bar</h2><p>There are two ways to configure the launch bar:</p><ul><li>Right click in the empty space between launchers on the launch bar and select <em>Configure Launchbar.</em></li><li>Click on the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;and select <em>Configure Launchbar</em>.</li></ul><p>This will open a new tab with the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;listing the launchers.</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Launch%20Bar_image.jpg\"></p><p>Expanding <em>Available Launchers</em> section will show the list of launchers that are not displayed on the launch bar. The <em>Visible Launchers</em> will show the ones that are currently displayed.</p><h2>Configuring the mobile launch bar</h2><p>The launch bar on mobile uses a different configuration from the desktop one. The reasoning is that not all desktop icons are available on mobile, and fewer icons fit on a mobile screen.</p><p>To configure the launch bar on mobile, go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;and select <em>Configure Launchbar</em>.</p><p>The configure the mobile launch bar while on the desktop (especially useful to configure more complicated launchers such as scripts or custom widgets), go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;→ Advanced → Show Hidden Subtree and look for the <em>Mobile Launch Bar</em> section. While in the hidden subtree, it's also possible to drag launchers between the <em>Mobile Launch Bar</em> and (Desktop) <em>Launch Bar</em> sections.</p><h3>Adding/removing and reordering launchers</h3><p>To display a new launcher in the launch bar, first look for it in the <em>Available Launchers</em> section. Then right click it and select <em>Move to visible launchers</em>. It is also possible to drag and drop the item manually.</p><p>Similarly, to remove it from the launch bar, simply look for it in <em>Visible Launchers</em> then right click it and select <em>Move to available launchers</em> or use drag-and-drop.</p><p>Drag-and-drop the items in the&nbsp;tree&nbsp;in order to change their order. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;for more interaction options, including using keyboard shortcuts.</p><h2>Customizing the launcher</h2><ul><li>The icon of a launcher can be changed just like a normal note. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_p9kXRFAkwN4o\">Note Icons</a>&nbsp;for more information.</li><li>The title of the launcher can also be changed.</li></ul><h3>Resetting</h3><p>Resetting allows restoring the original configuration of Trilium for the launcher bar, or for a portion of it. Simply right click a launcher (or even the entire <em>Launch Bar</em> section) and select <em>Reset</em> to bring it back to the original state.</p><h3>Creating new launchers / types of launchers</h3><p>Right click either the <em>Available launchers</em> or <em>Visible launchers</em> sections and select one of the options:</p><ol><li><p><strong>Note Launcher</strong><br>A note launcher will simply navigate to a specified note.</p><ol><li>Set the <code spellcheck=\"false\">target</code> promoted attribute to the note to navigate to.</li><li>Optionally, set <code spellcheck=\"false\">hoistedNote</code> to hoist a particular note. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_OR8WJ7Iz9K4U\">Note Hoisting</a>&nbsp;for more information.</li><li>Optionally, set a <code spellcheck=\"false\">keyboardShortcut</code> to trigger the launcher.</li></ol></li><li><p><strong>Script Launcher</strong><br>An advanced launcher which will run a script upon pressing. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_CdNpE2pqjmI6\">Scripting</a>&nbsp;for more information.</p><ol><li>Set <code spellcheck=\"false\">script</code> to point to the desired script to run.</li><li>Optionally, set a <code spellcheck=\"false\">keyboardShortcut</code> to trigger the launcher.</li></ol></li><li><p><strong>Custom Widget</strong></p><p>Allows defining a custom widget to be rendered inside the launcher. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_SynTBQiBsdYJ\">Widget Basics</a>&nbsp;for more information.</p></li><li><p><strong>Spacers</strong><br>Launchers that create some distance between other launchers for better visual distinction.</p></li></ol><p>Launchers are configured via predefined&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>.</p>",
- "_help_8YBEPzcpUgxw": "<p>To the right of the&nbsp;<a href=\"#root/_help_BlN9DFI679QC\">Ribbon</a>&nbsp;there are a few more buttons: <img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Note%20buttons_image.png\"></p><ul><li>The Note Revisions button displays the&nbsp;<a href=\"#root/_help_vZWERwf8U3nx\">Note Revisions</a>&nbsp;for that particular note.</li><li>The contextual menu offers commands for the note or its subtree, such as import, export, viewing the&nbsp;<a href=\"#root/_help_4FahAwuGTAwC\">Note source code</a>&nbsp;or&nbsp;<a href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>.</li></ul><p>On the&nbsp;<a class=\"reference-link\" href=\"#root/_help_IjZS7iK5EXtb\">New Layout</a>, the button area is populated by some more buttons that are specific to the current note. For example, for Image and&nbsp;<a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a>&nbsp;notes, the download and copy buttons were relocated there.</p>",
- "_help_4TIF1oA4VQRO": "<figure class=\"image image-style-align-center\"><img style=\"aspect-ratio:1189/709;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Options_image.png\" width=\"1189\" height=\"709\"></figure><p>The Options section allows the configuration of the TriliumNext client and server.</p><h2>Entering options</h2><p>The Options can be accessed via:</p><ul><li>The&nbsp;<a href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>, by selecting the <em>Options</em> item.</li><li>The <img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/1_Options_image.png\"> button in the&nbsp;<a href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>&nbsp;which can optionally be hidden if not desirable.</li><li>Optionally, a keyboard shortcut can be defined, but it is not assigned by default.</li><li>By clicking on this link:&nbsp;<a class=\"reference-link\" href=\"#root/_hidden/_options\">Options</a>.</li></ul><p>Once in the options section, simply select one of the option categories using the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</p><h2>Exiting options</h2><p>When entering the options, they are opened in a new <a href=\"#root/_help_3seOhtN8uLIY\">tab</a>. To close them, simply close the tab.</p><h2>Options when using sync</h2><p>When using&nbsp;<a class=\"reference-link\" href=\"#root/_help_cbkrhQjrkKrh\">Synchronization</a>, some of the options will be kept in sync across all the devices while others can be changed independently.</p><p>Generally, the options that relate to appearance are intentionally kept not synced in order to allow per-client customization (layout orientation, theme, vertical/horizontal layout, code block themes).</p>",
- "_help_luNhaphA37EO": "<p>In Trilium, is possible to work with two or more notes side-by-side.</p><figure class=\"image image-style-align-center\"><img style=\"aspect-ratio:1398/1015;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Split%20View_2_Split%20View_image.png\" width=\"1398\" height=\"1015\"></figure><h2><strong>Interactions</strong></h2><ul><li>Press the <img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Split%20View_Split%20View_image.png\"> button to the right of a note's title to open a new split to the right of it.<ul><li>It is possible to have as many splits as desired, simply press again the button.</li><li>Only horizontal splits are possible, vertical or drag &amp; dropping is not supported.</li></ul></li><li>When at least one split is open, press the <img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Split%20View_3_Split%20View_image.png\"> button next to it to close it.</li><li>Use the <img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Split%20View_4_Split%20View_image.png\"> or the <img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Split%20View_1_Split%20View_image.png\"> button to move around the splits.</li><li>Each <a href=\"#root/_help_3seOhtN8uLIY\">tab</a> has its own split view configuration (e.g. one tab can have two notes in a split view, whereas the others are one-note views).<ul><li>The tab will indicate only the title of the main note (the first one in the list).</li></ul></li></ul><h2>Splits and the note tree &amp; hoisting</h2><p>Clicking on the content of a split will focus that split. While focused, the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;will also indicate the note that is being edited.</p><p>It is possible for each of the splits to have their own&nbsp;<a class=\"reference-link\" href=\"#root/_help_OR8WJ7Iz9K4U\">Note Hoisting</a>.</p><p>When a new split is created, it will share the same note hoisting as the previous one. An easy solution to this is to simply hoist the notes after the split is created.</p><p>This is generally quite useful for reorganizing notes from one place to the other, by hoisting the old place in the first split and hoisting the new place to the second one. This will allow easy cut and paste without the tree jumping around from switching between notes.</p><h2>Mobile support</h2><p>Since v0.100.0, it's possible to have a split view on the mobile view as well, with the following differences from the desktop version of the split:</p><ul><li>On smartphones, the split views are laid out vertically (one on the top and one on the bottom), instead of horizontally as on the desktop.</li><li>There can be only one split open per tab.</li><li>It's not possible to resize the two split panes.</li><li>When the keyboard is opened, the active note will be “maximized”, thus allowing for more space even when a split is open. When the keyboard is closed, the splits become equal in size again.</li></ul><p>Interaction:</p><ul><li>To create a new split, click the three dots button on the right of the note title and select <em>Create new split</em>.<ul><li>This option will only be available if there is no split already open in the current tab.</li></ul></li><li>To close a split, click the three dots button on the right of the note title and select <em>Close this pane</em>.<ul><li>Note that this option will only be available on the second note in the split (the one at the bottom on smartphones, the one on the right on tablets).</li></ul></li><li>When long-pressing a link, a contextual menu will show up with an option to <em>Open note in a new split</em>.<ul><li>If there's already a split, the option will replace the existing split instead.</li></ul></li></ul>",
- "_help_XpOYSgsLkTJy": "<figure class=\"image image-style-align-center\"><img style=\"aspect-ratio:893/144;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons_image.png\" width=\"893\" height=\"144\"></figure><p>Depending on the current note, a panel will appear near the top-right of the note, right underneath the&nbsp;<a class=\"reference-link\" href=\"#root/_help_BlN9DFI679QC\">Ribbon</a>. These buttons offer additional interaction that is specific to that particular note.</p><p>For example:</p><ul><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a>, there are buttons to download the SVG representation of the note, or to copy a reference to the note for pasting it a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;note.</li><li>For <a href=\"#root/_help_CoFPLs3dRlXc\">read-only notes</a>, there is a button to temporarily edit the note for quick modifications.</li></ul><h2>Interaction</h2><p>The floating button area can be collapsed by pressing the two right arrows at the end of the section.</p>",
- "_help_RnaPdbciOfeq": "<figure class=\"image\"><img style=\"aspect-ratio:1990/1168;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/1_Right%20Sidebar_image.png\" width=\"1990\" height=\"1168\"></figure><p>The right sidebar displays specific content for the current note. The sidebar is grouped into multiple tabs:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_2dcGDhp9WFKb\">Outline tab</a>, which displays the table of contents, highlights and other navigation-related sections depending on the note type.</li><li><a class=\"reference-link\" href=\"#root/_help_uNtgN0cUKEBc\">Attributes tab</a>, which provides a visual editor for the current note's&nbsp;<a class=\"reference-link\" href=\"#root/_help_zEY4DaJG4YT5\">Attributes</a>.</li><li><a class=\"reference-link\" href=\"#root/_help_LrKznOtw9cQD\">AI chat tab</a>, which uses the&nbsp;<a class=\"reference-link\" href=\"#root/_help_GBBMSlVSOIGP\">AI</a>&nbsp;integration to chat, with optional access to the current note.</li><li><a class=\"reference-link\" href=\"#root/_help_KRlZFoIH0j6p\">Connections tab</a>, which groups together the note map, note paths, backlinks and similar notes.</li></ul><aside class=\"admonition warning\"><p>There are currently two types of sidebars; the documentation here refers only to the one defined in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_IjZS7iK5EXtb\">New Layout</a>. The old layout has a different sidebar mechanism which only shows the table of contents and highlights.</p></aside><h2>Toggling the right sidebar</h2><p>There are two ways to toggle the right sidebar:</p><ul><li>Via the <img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Right%20Sidebar_image.png\" width=\"25\" height=\"21\"> icon near the title bar, which toggles whether the sidebar is docked.</li><li>Via the <em>Toggle right pane</em> <a href=\"#root/_help_A9Oc6YKKc65v\">keyboard shortcut</a>, which is not assigned by default.</li></ul><h2>Peeking the sidebar</h2><p>There is a small strip near the right edge of the app which shows an arrow icon.</p><ul><li>When the sidebar is hidden, pressing the edge will <em>peek</em> the sidebar.<ul><li>In this mode the sidebar is shown temporarily above the content, without shifting the content of your notes.</li><li>Clicking outside the sidebar while in peek mode will simply hide the sidebar. Same goes for the X button and clicking on the right edge.</li><li>Pressing the pin icon will dock the sidebar.</li></ul></li><li>When the sidebar is docked, pressing the edge will hide the sidebar (similar to the toggle icon at the top).</li></ul>",
- "_help_2dcGDhp9WFKb": "<p>The Outline tab appears in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>&nbsp;and displays the headings and highlights for the current note.</p><h2>Table of contents</h2><p>The table of contents displays the titles / headings in the current note and allows easy navigation.</p><p>The following note types are supported:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a></li><li><a class=\"reference-link\" href=\"#root/_help_6RM1Q7ppFVoj\">Markdown</a></li><li><a class=\"reference-link\" href=\"#root/_help_XJGJrpu7F9sh\">PDFs</a></li><li><a class=\"reference-link\" href=\"#root/_help_GBBMSlVSOIGP\">AI</a>&nbsp;chat notes</li><li>The pages of the in-app documentation</li></ul><figure class=\"image image-style-align-right image_resized\" style=\"width:47%;\"><img style=\"aspect-ratio:556/205;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Right%20Sidebar/1_Outline%20tab_image.png\" width=\"556\" height=\"205\"></figure><h3>Interaction</h3><ul><li>Clicking on a heading will scroll the document to the position of the heading.</li><li>Pressing the close button will dismiss the table of contents but it can be shown again from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_XpOYSgsLkTJy\">Floating buttons</a>&nbsp;section.</li></ul><h3>Configuration</h3><aside class=\"admonition note\"><p>This section is relevant only for the old layout, the&nbsp;<a class=\"reference-link\" href=\"#root/_help_IjZS7iK5EXtb\">New Layout</a>&nbsp;shows the table of contents regardless of the number of headings.</p></aside><ul><li>To change the option globally, go to&nbsp;<a class=\"reference-link\" href=\"#root/_hidden/_options/_optionsTextNotes\">Text Notes</a>&nbsp;options, look for the <em>Table of Contents</em> section and configure the minimum amount of headings that need to be present in the current note in order for the table of contents to show:<ul><li>To always hide it, set the value to a really large number (e.g. 10000).</li><li>To always display it if there's at least a single heading, set the value to 1.</li></ul></li><li>Use&nbsp;<a class=\"reference-link\" href=\"#root/_help_zEY4DaJG4YT5\">Attributes</a>&nbsp;to configure the table of contents for a particular note:<ul><li><code spellcheck=\"false\">#toc=show</code> will show the table of contents for that note regardless of the global settings.</li><li>Similarly, <code spellcheck=\"false\">#toc=hide</code> will always hide the table of contents for that note.</li></ul></li></ul><h2>Highlights</h2><figure class=\"image image-style-align-right image_resized\" style=\"width:46.04%;\"><img style=\"aspect-ratio:489/240;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Right%20Sidebar/Outline%20tab_image.png\" width=\"489\" height=\"240\"></figure><p>Similar to the&nbsp;table of contents, but instead of headings this feature will list highlighted text from a text note and allow easy navigation to them.</p><p>Unlike table of contents which supports multiple note types, the highlights are specific to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes.</p><p>Highlighted text is defined as:</p><ul><li>Bold text.</li><li>Italic text.</li><li>Underlined text.</li><li>Text with a foreground color set.</li><li>Text with a background color/highlight set.</li></ul><h3>Interaction</h3><ul><li>Clicking on a highlighted text will scroll the document to its position.</li><li>For the old layout only, pressing the close button will dismiss the list of highlights but it can be shown again from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_XpOYSgsLkTJy\">Floating buttons</a>&nbsp;section.</li></ul><h3>Configuration</h3><ul><li>Globally, it's possible to toggle the display of each category of highlighted text (as defined above)&nbsp;<ul><li>For the new layout, pressing the gear button in the top-right part of the section will reveal a menu to toggle between the highlight categories.</li><li>Alternatively, they can be changed by going to&nbsp;<a class=\"reference-link\" href=\"#root/_hidden/_options/_optionsTextNotes\">Text Notes</a>&nbsp;settings and looking for the <em>Highlights List</em> section.</li></ul></li><li>For the old layout only, to suppress the display of highlighted text for one specific note, use&nbsp;<a class=\"reference-link\" href=\"#root/_help_zEY4DaJG4YT5\">Attributes</a>&nbsp;to add the <code spellcheck=\"false\">#hideHighlightWidget</code> label.</li></ul><h2>PDF-specific outline</h2><p>When&nbsp;<a class=\"reference-link\" href=\"#root/_help_XJGJrpu7F9sh\">PDFs</a>&nbsp;are opened in Trilium, the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>&nbsp;is augmented with PDF-specific navigation, with the following features:</p><ul><li>Table of contents/outline<ul><li>All the headings and “bookmarks” will be displayed hierarchically.</li><li>The heading on the current page is also highlighted (note that it can be slightly offset depending on how many headings are on the same page).</li><li>Clicking on a heading will jump to the corresponding position in the PDF.</li></ul></li><li>Pages<ul><li>A preview of all the pages with a small thumbnail.</li><li>Clicking on a page will automatically navigate to that page.</li></ul></li><li>Annotations<ul><li>Highlight and comment annotations are listed here.</li><li>For the old layout, this feature is not directly available, however there is a listing of comments directly in the PDF toolbar.</li></ul></li><li>Attachments<ul><li>If the PDF has its own attachments (not to be confused with Trilium's&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>), they will be displayed in a list.</li><li>Some information such as the name and size of the attachment are displayed.</li><li>It's possible to download the attachment by clicking on the download button.</li></ul></li><li>Layers<ul><li>A less common feature, if the PDF has toggle-able layers, these layers will be displayed in a list here.</li><li>It's possible to toggle the visibility for each individual layer.</li></ul></li></ul>",
- "_help_uNtgN0cUKEBc": "<figure class=\"image image-style-align-right image_resized\" style=\"width:34.71%;\"><img style=\"aspect-ratio:596/1688;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Right%20Sidebar/Attributes%20tab_image.png\" width=\"596\" height=\"1688\"></figure><p>The attributes tab provides a more graphical way to view and edit <a href=\"#root/_help_zEY4DaJG4YT5\">attributes</a>.</p><h2>Sections</h2><p>The following information is displayed in sections:</p><ul><li><em>Owned attributes</em>, contains a list of the attributes that belong to this note.</li><li><em>Inherited attributes</em> are attributes that apply to the current note but come through&nbsp;<a class=\"reference-link\" href=\"#root/_help_bwZpz2ajCEwO\">Attribute Inheritance</a>.</li><li><em>Definitions</em> describe the type of attributes and are used in&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_2FvYrpmOXm29\">Table</a>&nbsp;collections.</li></ul><h2>Owned attributes</h2><p>Every item is structured as such:</p><ul><li>The icon of each item indicates whether it's a <a href=\"#root/_help_HI6GBBIduIgv\">label</a> or a <a href=\"#root/_help_Cq5X6iKQop6R\">relation</a> (link to another note).</li><li>The first text is the name of the label.</li><li>The value of the attribute is displayed after the name, if present.<ul><li>The value is shown in a graphical way: a relation's value is a clickable note link; a color label shows a color chip.</li></ul></li></ul><p>System attributes (that have a special meaning in Trilium) show a small cog near the icon and are grouped separately from the user-defined ones.</p><p>Interaction:</p><ul><li>Clicking on the item (apart from the value and links) reveals a dedicated popup where the name, value and&nbsp;<a class=\"reference-link\" href=\"#root/_help_bwZpz2ajCEwO\">Attribute Inheritance</a>&nbsp;can be defined.</li><li>The value of the attributes can be edited in-place:<ul><li>The input box follows the type defined in a corresponding label definition (date, color, dropdown, numbers), as well as for system attributes that have a specific type (e.g. <code spellcheck=\"false\">color</code>).</li><li>For labels, clicking on the value edits its in-place.<ul><li>Press <kbd>Enter</kbd> to confirm or click outside the input box, or <kbd>Esc</kbd> to dismiss.</li><li>For multi-line text, <kbd>Ctrl</kbd>+<kbd>Enter</kbd> confirms whereas <kbd>Enter</kbd> creates a newline.</li></ul></li><li>For boolean values, clicking on the checkbox will toggle its state.</li><li>For labels without a value, a value can be added by clicking on the <em>No value</em> text which appears while the mouse is hovered on the item.</li><li>For relations, there is a dedicated pencil button instead.</li></ul></li><li>An attribute can be deleted by pressing the X button to its right, which only appears while hovered. A confirmation screen is displayed first to ensure the attribute is not accidentally deleted.</li></ul><p>Attributes can be added in two ways:</p><ul><li>A new label, relation or attribute definition can be added from the + button near the title of the section. This shows the full detail popup.</li><li>To quickly add a label or a relation directly from the sidebar, click the <em>Add attribute</em> item at the end of the list.<ul><li>The name field will be focused first. By default, a label will be created instead but it can be toggled to a relation by typing <kbd>~</kbd> or pressing the icon (similarly, typing <code spellcheck=\"false\">#</code> will switch back to a label instead of a relation).</li><li>Once the name is filled, press <kbd>Enter</kbd> to continue to the value. Type in a value if desired and then press <kbd>Enter</kbd> again to create the attribute.</li><li>Clicking outside the editor will also create the attribute, but only if a name is specified.</li></ul></li></ul><h2>Inherited attributes</h2><p>Inherited labels or relations are shown in the same fashion as <em>Owned attributes</em>.</p><p>The only differences are:</p><ul><li>To the right of the inherited attribute there is a link to the note where the attribute comes from, as well as an icon to indicate that it's inheritable.</li><li>Clicking on an inherited attribute will reveal the same popup as owned attributes, but it is not editable. To edit it, first navigate to the note where the attribute is defined.</li></ul><h2>Definitions</h2><p>For attribute definition (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>):</p><ul><li>The icon indicates the type of the attribute (text, number).<ul><li>If an attribute is promoted, it has a small chevron icon overlaid on top of it.</li></ul></li><li>The name indicates the name of the attribute it defines (without the <code spellcheck=\"false\">label:</code> or <code spellcheck=\"false\">relation:</code> prefix).</li><li>To the right of the name a short summary is displayed which indicates the display name (alias), whether it has multiple values or an inverse relation.</li><li>Clicking on a definition reveals a popup, where the name, type, display name and other aspects can be configured.</li><li>A new label or relation definition can be added from the + button near the title of the section.</li><li>For inherited definition, there is a link to the note where the definition comes from, as well as an icon to indicate that it's inherited.</li></ul><h2>Mobile</h2><p>The attributes can also be edited visually on mobile, but not as part of the sidebar. Go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note buttons</a>&nbsp;and select <em>Note attributes</em>.</p>",
++ "_help_3seOhtN8uLIY": "<figure class=\"image image-style-align-center\"><img style=\"aspect-ratio:1119/43;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Tabs_image.png\" width=\"1119\" height=\"43\"></figure><p>In Trilium, tabs allow easy switching between notes.</p><h2>Layout</h2><p>Depending on the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x0JgW8UqGXvq\">Vertical and horizontal layout</a>:</p><ul><li>For the vertical layout, the tabs will be placed at the top but to the right of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</li><li>For the horizontal layout, the tabs will be placed at the top in full-width, above the&nbsp;<a href=\"#root/_help_oPVyFC7WL2Lp\">note tree</a>, allowing for more tabs to be comfortably displayed.</li></ul><h2>Interaction</h2><ul><li>To create a new tab, press the&nbsp;<span class=\"tn-icon bx bx-plus\"></span> button that is to the right of the last tab.</li><li>To close a tab, press the corresponding&nbsp;<span class=\"tn-icon bx bx-x\"></span> button.</li><li>For multitasking, tabs can be used alongside&nbsp;<a class=\"reference-link\" href=\"#root/_help_luNhaphA37EO\">Split View</a>. Each tab can have one or more notes, displayed horizontally.</li><li>Tabs can be reordered by drag-and-dropping it into a new position.</li><li>An existing tab can be displayed in a new window by dragging the tab upwards or downwards. It is not possible to combine tabs back into another window.</li></ul><h2>Keyboard interaction</h2><p>Since tabs are a commonly used feature, there are multiple keyboard shortcuts that can be used:</p><ul><li><kbd>Ctrl</kbd>+<kbd>T</kbd> to open a new tab.</li><li><kbd>Ctrl</kbd>+<kbd>W</kbd> to close the current tab.</li><li><kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>T</kbd> to reopen the last closed tab.</li><li><kbd>Ctrl</kbd>+<kbd>Tab</kbd> and <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Tab</kbd> to go to the next or previous tab.</li><li><kbd>Ctrl</kbd>+<kbd>1</kbd>, <kbd>Ctrl</kbd>+<kbd>2</kbd>, up to <kbd>Ctrl</kbd>+<kbd>9</kbd> to activate the first, second and up to ninth tab.</li><li>There is also a shortcut to go to the last tab, but it is not assigned a key by default.</li></ul><h2>Mobile</h2><figure class=\"image image-style-align-right image_resized\" style=\"width:34.12%;\"><img style=\"aspect-ratio:1242/2688;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Tabs_IMG_1767.PNG\" width=\"1242\" height=\"2688\"></figure><p>Tabs are also supported on the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RDslemsQ6gCp\">Mobile Frontend</a>.</p><p>Since v0.102.0, the tabs are displayed by pressing the dedicated tab switcher button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>. In this view the tabs are laid out on a grid with a preview of the note content.</p><p>The context menu button at the top-right of the popup allows creating a new tab, reopening the last closed tab and closing all the tabs.</p><p><a class=\"reference-link\" href=\"#root/_help_luNhaphA37EO\">Split View</a>s are also indicated in the tab switcher, with two titles displayed in a tab.</p><aside class=\"admonition note\"><p>Versions prior to v0.102.0 also supported tabs, but they were displayed directly above the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>. The decision to use a more mobile-like tab switcher was taken because the original tab bar could not support many tabs at once and the new design better aligns with how mobile applications handle tabs.</p></aside>",
++ "_help_xYmIYSP6wE3F": "<h2>Position of the Launch bar</h2><p>On desktop, depending on the layout selected, the launcher bar will either be on the left side of the screen with buttons displayed vertically or at the top of the screen. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_x0JgW8UqGXvq\">Vertical and horizontal layout</a>&nbsp;for more information.</p><p>On mobile, the launch bar will always be at the bottom.</p><p>If there are too many items in the launch bar to fit the screen, it will become scrollable.</p><h2>Terminology</h2><ul><li><strong>Launcher</strong>: a button that can be (or is) displayed on the launch bar.</li><li><strong>Available Launcher</strong>: a launcher that is not displayed on the launch bar, but can be added.</li><li><strong>Visible Launcher</strong>: a launcher that is currently displayed on the launch bar.</li></ul><h2>Configuring the desktop Launch bar</h2><p>There are two ways to configure the launch bar:</p><ul><li>Right click in the empty space between launchers on the launch bar and select <em>Configure Launchbar…</em></li><li>Click on the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;and select <em>Configure Launchbar</em>.</li></ul><p>This will open a new tab with the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;listing the launchers.</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Launch%20Bar_image.jpg\"></p><p>Expanding <em>Available Launchers</em> section will show the list of launchers that are not displayed on the launch bar. The <em>Visible Launchers</em> will show the ones that are currently displayed.</p><h2>Configuring the mobile launch bar</h2><p>The launch bar on mobile uses a different configuration from the desktop one. The reasoning is that not all desktop icons are available on mobile, and fewer icons fit on a mobile screen.</p><p>To configure the launch bar on mobile, go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;and select <em>Configure Launchbar</em>.</p><p>The configure the mobile launch bar while on the desktop (especially useful to configure more complicated launchers such as scripts or custom widgets), go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;→ Advanced → Show Hidden Subtree and look for the <em>Mobile Launch Bar</em> section. While in the hidden subtree, it's also possible to drag launchers between the <em>Mobile Launch Bar</em> and (Desktop) <em>Launch Bar</em> sections.</p><h3>Adding/removing and reordering launchers</h3><p>To display a new launcher in the launch bar, first look for it in the <em>Available Launchers</em> section. Then right click it and select <em>Move to visible launchers</em>. It is also possible to drag and drop the item manually.</p><p>Similarly, to remove it from the launch bar, simply look for it in <em>Visible Launchers</em> then right click it and select <em>Move to available launchers</em> or use drag-and-drop.</p><p>Drag-and-drop the items in the&nbsp;tree&nbsp;in order to change their order. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;for more interaction options, including using keyboard shortcuts.</p><h2>Customizing the launcher</h2><ul><li>The icon of a launcher can be changed just like a normal note. See&nbsp;<a href=\"#root/_help_p9kXRFAkwN4o\">note icons</a>&nbsp;for more information.</li><li>The title of the launcher can also be changed.</li></ul><h3>Resetting</h3><p>Resetting allows restoring the original configuration of Trilium for the launcher bar, or for a portion of it. Simply right click a launcher (or even the entire <em>Launch Bar</em> section) and select <em>Reset</em> to bring it back to the original state.</p><h3>Creating new launchers / types of launchers</h3><p>Right click either the <em>Available launchers</em> or <em>Visible launchers</em> sections and select one of the options:</p><ol><li><p><strong>Note Launcher</strong><br>A note launcher will simply navigate to a specified note.</p><ol><li>Set the <code>target</code> promoted attribute to the note to navigate to.</li><li>Optionally, set <code>hoistedNote</code> to hoist a particular note. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_OR8WJ7Iz9K4U\">Note Hoisting</a>&nbsp;for more information.</li><li>Optionally, set a <code>keyboardShortcut</code> to trigger the launcher.</li></ol></li><li><p><strong>Script Launcher</strong><br>An advanced launcher which will run a script upon pressing. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_CdNpE2pqjmI6\">Scripting</a>&nbsp;for more information.</p><ol><li>Set <code>script</code> to point to the desired script to run.</li><li>Optionally, set a <code>keyboardShortcut</code> to trigger the launcher.</li></ol></li><li><p><strong>Custom Widget</strong></p><p>Allows defining a custom widget to be rendered inside the launcher. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_SynTBQiBsdYJ\">Widget Basics</a>&nbsp;for more information.</p></li><li><p><strong>Spacers</strong><br>Launchers that create some distance between other launchers for better visual distinction.</p></li></ol><p>Launchers are configured via predefined&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>.</p>",
++ "_help_8YBEPzcpUgxw": "<figure class=\"image image-style-align-right image_resized\" style=\"width:25.95%;\"><img style=\"aspect-ratio:402/988;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Note%20menu_image.png\" width=\"402\" height=\"988\"></figure><p>The note menu contains various actions and configurations for the current note. It can be found in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_1P8QXI5edXNd\">Note buttons</a>&nbsp;area (to the right of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_l7pigIGu01K2\">Title</a>).</p><p>Every split has a note menu of its own, which acts on the note displayed in that split. Entries that don't apply to the current note are still listed but grayed out, while entries that only exist for some notes (described in <em>Note-specific entries</em>) appear only on those notes.</p><h2>Navigating the note</h2><ul><li><span class=\"tn-icon bx bx-search\"></span>&nbsp;<em>Search in note</em> opens the&nbsp;<a class=\"reference-link\" href=\"#root/_help_McngOG2jbUWX\">Search in note</a>&nbsp;bar, to find and replace text inside the current note. On the desktop application, the same bar opens with <kbd>Ctrl</kbd>+<kbd>F</kbd>.<ul><li>It is available on&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>,&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>,&nbsp;<a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_GWHEkY4I4OE3\">Spreadsheets</a>&nbsp;notes,&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>, PDF files, and any note displayed as&nbsp;<a class=\"reference-link\" href=\"#root/_help_4FahAwuGTAwC\">Note source</a>.</li></ul></li><li><span class=\"tn-icon bx bx-paperclip\"></span>&nbsp;<em>Note attachments</em> switches the note to the list of its&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>, where they can be uploaded, opened, downloaded, renamed or deleted.</li><li><span class=\"tn-icon bx bxs-network-chart\"></span>&nbsp;<em>Note map</em> opens the&nbsp;<a class=\"reference-link\" href=\"#root/_help_KRlZFoIH0j6p\">Connections tab</a>&nbsp;of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>, which shows the&nbsp;<a class=\"reference-link\" href=\"#root/_help_BCkXAVs63Ttv\">Note Map (Link map, Tree map)</a>&nbsp;centered on the current note.</li></ul><h2>Note properties</h2><p>The toggles in this section take effect immediately:</p><ul><li><span class=\"tn-icon bx bx-share-alt\"></span>&nbsp;<em>Shared</em> publishes the note via&nbsp;<a class=\"reference-link\" href=\"#root/_help_R9pX4DGra2Vt\">Sharing</a>, by cloning it into the <em>Shared Notes</em> tree.<ul><li>Turning it off removes the clone from that tree. If the note exists only as a shared note, Trilium asks for confirmation, since unsharing it deletes it.</li><li>The toggle is unavailable on the root note, on the <em>Shared Notes</em> note itself, and on system notes.</li></ul></li><li><span class=\"tn-icon bx bx-lock-alt\"></span>&nbsp;<em>Protect the note</em> encrypts the note, turning it into one of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_bwg0e8ewQMak\">Protected Notes</a>. If no protected session is active, Trilium asks for the password first. Only the current note is affected, not its children.</li><li><span class=\"tn-icon bx bx-bookmark\"></span>&nbsp;<em>Bookmark</em> adds the note to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_u3YFHC9tQlpm\">Bookmarks</a>&nbsp;that are displayed in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>, or removes it from them.</li><li><span class=\"tn-icon bx bx-copy-alt\"></span>&nbsp;<em>Template</em> marks the note as one of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>&nbsp;(by adding the <code>#template</code> label), which makes it available when creating a new note.</li><li><span class=\"tn-icon bx bx-expand-horizontal\"></span>&nbsp;<em>Full width</em> lets the note use the whole width of the window instead of the limit set in&nbsp;<a class=\"reference-link\" href=\"#root/_help_t596jLvPrqkS\">Content width</a>&nbsp;by adding the <code>#fullContentWidth</code> label. It is not listed for note types that are always displayed at full width.</li></ul><p>The two submenus in this section:</p><ul><li><span class=\"tn-icon bx bx-file\"></span>&nbsp;<em>Note type</em> changes the type of the note to any of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_KSZ04uQ2D1St\">Note Types</a>; the current one is checked. If the note already has content, Trilium asks for confirmation first, since the content generally doesn't carry over.&nbsp;<a class=\"reference-link\" href=\"#root/_help_jludwdW7N4hg\">Converting between note types</a>.<ul><li>For a&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note, the language is chosen in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlJ73vBCjWDw\">Status bar</a>&nbsp;instead.</li></ul></li><li><span class=\"tn-icon bx bx-edit-alt\"></span>&nbsp;<em>Editable</em> controls when the note opens as read-only (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_CoFPLs3dRlXc\">Read-Only Notes</a>):<ul><li><em>Auto</em> (the default): the note is editable, unless it is long enough to be opened as read-only automatically.</li><li><em>Read-only</em>: the note always opens as read-only, but can still be edited after pressing <em>Edit note</em>.</li><li><em>Always Editable</em>: the note is always editable, regardless of its length.</li></ul></li></ul><h2>Importing, exporting and printing</h2><ul><li><span class=\"tn-icon bx bx-import\"></span>&nbsp;<em>Import files</em> opens the import dialog, which imports files as children of the current note. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_mHbBMPDPkVV5\">Import &amp; Export</a>. It is unavailable on&nbsp;<a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a>&nbsp;notes.</li><li><span class=\"tn-icon bx bx-export\"></span>&nbsp;<em>Export note</em> opens the export dialog with <em>Only this note</em> selected; select <em>This note &amp; all descendants</em> there to export the whole subtree.</li><li><span class=\"tn-icon bx bx-printer\"></span><em>Print note…</em> prints the note. On the desktop application this entry reads <em>Print/export to PDF…</em> and can also save the note as a PDF file. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_NRnIZmSMc5sj\">Printing &amp; Exporting as PDF</a>, including which note types and collections can be printed.</li></ul><p>Some note types add their own export formats right below <em>Export note</em>:</p><ul><li><span class=\"tn-icon bx bxs-file-image\"></span><em>Export as image</em>, on&nbsp;<a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a>&nbsp;notes, downloads the diagram as <em>PNG (raster)</em> or <em>SVG (vector)</em>.</li><li><span class=\"tn-icon bx bxs-spreadsheet\"></span><em>Export to Excel (.xlsx)</em> and <em>Export to CSV (.csv)</em>, on&nbsp;<a class=\"reference-link\" href=\"#root/_help_GWHEkY4I4OE3\">Spreadsheets</a>, download the spreadsheet in those formats.</li></ul><h2>Revisions</h2><p>These entries manage the&nbsp;<a class=\"reference-link\" href=\"#root/_help_vZWERwf8U3nx\">Note Revisions</a>&nbsp;of the note:</p><ul><li><span class=\"tn-icon bx bx-history\"></span><em>Note revisions…</em> opens the revisions dialog, where previous versions can be previewed, compared with the current one, downloaded or restored.</li><li><span class=\"tn-icon bx bx-save\"></span><em>Save revision</em> saves a revision of the note right away, instead of waiting for the next automatic snapshot.</li><li><span class=\"tn-icon bx bx-purchase-tag\"></span><em>Save named revision…</em> also saves a revision right away, but first asks for a short description of the changes, which is shown in the revisions dialog.</li></ul><h2>Note-specific entries</h2><p>The following entries only appear on some notes:</p><ul><li><span class=\"tn-icon bx bx-pencil\"></span><em>Edit note</em> appears at the top of the menu when the note is currently read-only. It enables editing until the note is closed.</li><li><span class=\"tn-icon bx bx-align-justify\"></span><em>Word wrap</em> appears at the top of the menu on&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;notes, and sets whether long lines wrap in this note:<ul><li><em>Auto</em> (the default) follows&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Code Notes</em> → <em>Wrap lines in code notes</em>.</li><li><em>On</em> and <em>Off</em> override it for this note only, by setting the <code>#wrapLines</code> label.</li></ul></li><li><span class=\"tn-icon bx bx-paperclip\"></span><em>Convert into attachment</em> appears on an image note that has no children and a single parent which is a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;note. After a confirmation, it turns the image into an attachment of its parent note and opens it there. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>.</li><li><span class=\"tn-icon bx bx-extension\"></span><em>Re-render note</em> appears on a&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>, and runs its script again to refresh the output.</li><li><span class=\"tn-icon bx bx-cog\"></span><em>Board properties</em> appears on a&nbsp;<a class=\"reference-link\" href=\"#root/_help_CtBQqbwXDx1w\">Kanban Board</a>, and configures its columns, card attributes and card templates.</li><li><span class=\"tn-icon bx bx-cog\"></span><em>Calendar properties</em> appears on a&nbsp;<a class=\"reference-link\" href=\"#root/_help_xWbu3jpNWapp\">Calendar</a> that creates events, and configures its event templates.</li><li><span class=\"tn-icon bx bx-cog\"></span><em>Geo map properties</em> appears on a&nbsp;<a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map</a>, and configures its map settings and the image of an <a href=\"#root/_help_ZRDXGc0nAIh4\">image map</a>.</li><li><span class=\"tn-icon bx bx-cog\"></span><em>Table properties</em> appears on a <a class=\"reference-link\" href=\"#root/_help_2FvYrpmOXm29\">Table</a>, and configures which notes it shows.</li></ul><h2>Advanced</h2><p>The <span class=\"tn-icon bx bx-wrench\"></span><em>Advanced</em> submenu groups the actions that are needed less often:</p><ul><li><p><span class=\"tn-icon bx bx-file-find\"></span><em>Open note externally</em> (desktop application only) saves the note to a temporary file and opens it in the application that the operating system associates with it. Trilium watches the file, and offers to upload the modified version back into the note. It is unavailable on&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a>&nbsp;notes.</p></li><li><p><span class=\"tn-icon bx bx-customize\"></span><em>Open note custom</em> (desktop application only, Windows and Linux) works like <em>Open note externally</em>, but lets you pick the application to open the file with.</p></li><li><p><span class=\"tn-icon bx bx-code\"></span><em>Note source</em> shows the&nbsp;<a class=\"reference-link\" href=\"#root/_help_4FahAwuGTAwC\">Note source</a>, the content of the note exactly as it is stored.</p></li><li><p><span class=\"tn-icon bx bxl-markdown\"></span><em>Convert to Markdown Note</em> (on text notes) and <em>Convert to Text Note</em> (on Markdown notes) switch the note between rich text and Markdown. After a confirmation, Trilium saves a revision and converts the content; the revision allows going back if some formatting was lost. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_jludwdW7N4hg\">Converting between note types</a>.</p></li><li><p><span class=\"tn-icon bx bx-collapse-alt\"></span><em>Compress images</em> opens a dialog that reduces the size of the images in the note. It lists the images found and how much space they take, and offers to:</p><ul><li>Resize the images larger than a chosen size.</li><li>Keep, or compress, JPEG images.</li><li>Keep, optimize, or convert to JPEG the PNG images.</li><li><em>Process child notes as well</em>, to include the images of the notes beneath this one.</li></ul><p>Compressing cannot be undone. Images can also be compressed automatically on upload, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_mT0HEkOsz6i1\">Images</a>.</p></li><li><p><span class=\"tn-icon bx bx-text\"></span><em>View OCR text</em> (on image and file notes) shows the text extracted from the note via&nbsp;<a class=\"reference-link\" href=\"#root/_help_TiQbQDgP8L5t\">Text Extraction (OCR)</a>. If the note has not been processed yet, the dialog offers to <em>Process OCR</em>.</p></li><li><p><span class=\"tn-icon bx bx-world\"></span><em>Open note on server</em> (desktop application only, listed when&nbsp;<a class=\"reference-link\" href=\"#root/_help_cbkrhQjrkKrh\">Synchronization</a>&nbsp;is configured) opens the same note on the sync server, in the web browser.</p></li></ul><h2>Deleting the note</h2><p><span class=\"tn-icon bx bx-trash\"></span><em>Delete note</em> opens the deletion dialog for the current note and its subtree. The dialog lists the notes that will be deleted and the relations that will be broken, and offers to:</p><ul><li>Also delete the other clones of the note, if it is cloned elsewhere. Otherwise, only the current placement is removed and the note stays in its other locations. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_IakOLONlIfGI\">Cloning Notes</a>.</li><li><em>Erase permanently</em> instead of the usual soft deletion. This cannot be undone.</li></ul><p>Notes deleted without erasing can be brought back, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_5Ct4MAJTS4tQ\">Restoring Deleted Notes</a>.</p><h2>Limitations</h2><ul><li>The note menu is not available on launchers.</li><li>On the notes of&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;and of the in-app help, most entries are grayed out, since these notes cannot be imported into, exported, deleted or have revisions.</li><li>The <a href=\"#note-properties\">Note properties</a> section is only listed when the note itself is displayed, not its&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>&nbsp;or its&nbsp;<a class=\"reference-link\" href=\"#root/_help_4FahAwuGTAwC\">Note source</a>.</li><li>In&nbsp;<a class=\"reference-link\" href=\"#root/_help_ZjLYv08Rp3qC\">Quick edit</a>, <em>Search in note</em>, <em>Note map</em>, <em>Full width</em> and <em>Convert into attachment</em> are not listed.</li></ul><h2>Mobile support</h2><p>On the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RDslemsQ6gCp\">Mobile Frontend</a>, the note menu opens as a sheet from the bottom of the screen. Besides the entries above, it contains the items that the desktop layout places elsewhere:</p><ul><li><em>Backlinks</em> and <em>Note paths</em>, at the top, which open the&nbsp;<a class=\"reference-link\" href=\"#root/_help_wfGXLmm7x27z\">Backlinks</a>&nbsp;and the other locations of the note.</li><li>The custom buttons of the note type (such as <span class=\"tn-icon bx bx-download\"></span><em>Download</em> on a&nbsp;<a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a>).</li><li><em>Insert child note</em>, which creates a note under the current one.</li><li><em>Create new split</em> and <em>Close this pane</em>, to manage the&nbsp;<a class=\"reference-link\" href=\"#root/_help_luNhaphA37EO\">Split View</a>.</li><li><em>Note attributes</em>, which opens the attributes of the note.</li><li>On&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes, the content language (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_veGu4faJErEM\">Content language &amp; Right-to-left support</a>); on&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;notes, the language of the code.</li><li><em>Note info</em> and&nbsp;<a class=\"reference-link\" href=\"#root/_help_xWtq5NUHOwql\">Similar Notes</a>.</li><li><em>Note map</em> opens the map in a popup instead of the right sidebar.</li></ul>",
++ "_help_1P8QXI5edXNd": "<p>The note buttons is an area at the top-right of a note with a few buttons:</p><ul><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>&nbsp;which offers commands for the note or its subtree, such as import, export, viewing the&nbsp;<a href=\"#root/_help_4FahAwuGTAwC\">Note source code</a>&nbsp;or&nbsp;<a href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>.</li><li><a class=\"reference-link\" href=\"#root/_help_luNhaphA37EO\">Split View</a>&nbsp;controls<ul><li><span class=\"tn-icon bx bx-dock-right\"></span>&nbsp;to open a new split</li><li><span class=\"tn-icon bx bx-chevron-right\"></span>/<span class=\"tn-icon bx bx-chevron-left\"></span> to move the pane around</li><li><span class=\"tn-icon bx bx-x\"></span>&nbsp;to close the pane.</li></ul></li><li>On some note types such as&nbsp;<a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a>&nbsp;and images, there are dedicated buttons (e.g.&nbsp;<span class=\"tn-icon bx bx-download\"></span> to download the file locally).</li></ul>",
++ "_help_4TIF1oA4VQRO": "<figure class=\"image image-style-align-center\"><img style=\"aspect-ratio:1189/709;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Options_image.png\" width=\"1189\" height=\"709\"></figure><p>The Options section allows the configuration of the TriliumNext client and server.</p><h2>Entering options</h2><p>The Options can be accessed via:</p><ul><li>The&nbsp;<a href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>, by selecting the <em>Options</em> item.</li><li>The&nbsp;<span class=\"tn-icon bx bx-cog\"></span> button in the&nbsp;<a href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>&nbsp;which can optionally be hidden if not desirable.</li><li>Optionally, a keyboard shortcut can be defined, but it is not assigned by default.</li><li>By clicking on this link:&nbsp;<a class=\"reference-link\" href=\"#root/_hidden/_options\">Options</a>.</li></ul><p>Once in the options section, simply select one of the option categories using the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</p><h2>Exiting options</h2><p>When entering the options, they are opened in a new <a href=\"#root/_help_3seOhtN8uLIY\">tab</a>. To close them, simply close the tab.</p><h2>Options when using sync</h2><p>When using&nbsp;<a class=\"reference-link\" href=\"#root/_help_cbkrhQjrkKrh\">Synchronization</a>, some of the options will be kept in sync across all the devices while others can be changed independently.</p><p>Generally, the options that relate to appearance are intentionally kept not synced in order to allow per-client customization (layout orientation, theme, vertical/horizontal layout, code block themes).</p>",
++ "_help_luNhaphA37EO": "<p>In Trilium, is possible to work with two or more notes side-by-side.</p><figure class=\"image image-style-align-center\"><img style=\"aspect-ratio:1398/1015;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Split%20View_2_Split%20View_image.png\" width=\"1398\" height=\"1015\"></figure><h2>Interactions</h2><ul><li>Press the&nbsp;<span class=\"tn-icon bx bx-dock-right\"></span> button to the right of a note's title to open a new split to the right of it.<ul><li>It is possible to have as many splits as desired, simply press again the button.</li><li>Only horizontal splits are possible, vertical or drag &amp; dropping is not supported.</li></ul></li><li>When at least one split is open, press the&nbsp;<span class=\"tn-icon bx bx-x\"></span> button next to it to close it.</li><li>Use the&nbsp;<span class=\"tn-icon bx bx-chevron-right\"></span> or the&nbsp;<span class=\"tn-icon bx bx-chevron-left\"></span> button to move around the splits.</li><li>Creating, closing and moving a split can also be triggered from a <a href=\"#root/_help_A9Oc6YKKc65v\">keyboard shortcut</a> (<em>Create New Split</em>, <em>Close Active Split</em>, <em>Move Split Left</em> and <em>Move Split Right</em>, all unassigned by default) or through the <a href=\"#root/_help_F1r9QtzQLZqm\">command palette</a>.</li><li>The focus can be moved from one split to the one next to it with the <em>Focus Split to the Left</em> and <em>Focus Split to the Right</em> actions, which stop at either end of the tab instead of continuing into the next tab. They are unassigned by default as well.</li><li>Each <a href=\"#root/_help_3seOhtN8uLIY\">tab</a> has its own split view configuration (e.g. one tab can have two notes in a split view, whereas the others are one-note views).<ul><li>The tab's title will indicate all the note titles, in the order of the splits from the left to right and separated by a bullet symbol.</li><li>The tab's icon will indicate the icon of the last active split, which will be automatically focused when clicking on the tab.</li></ul></li></ul><h2>Splits and the note tree &amp; hoisting</h2><p>Clicking on the content of a split will focus that split. While focused, the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;will also indicate the note that is being edited.</p><p>It is possible for each of the splits to have their own&nbsp;<a class=\"reference-link\" href=\"#root/_help_OR8WJ7Iz9K4U\">Note Hoisting</a>.</p><p>When a new split is created, it will share the same note hoisting as the previous one. An easy solution to this is to simply hoist the notes after the split is created.</p><p>This is generally quite useful for reorganizing notes from one place to the other, by hoisting the old place in the first split and hoisting the new place to the second one. This will allow easy cut and paste without the tree jumping around from switching between notes.</p><h2>Mobile support</h2><p>Since v0.100.0, it's possible to have a split view on the mobile view as well, with the following differences from the desktop version of the split:</p><ul><li>On smartphones, the split views are laid out vertically (one on the top and one on the bottom), instead of horizontally as on the desktop.</li><li>There can be only one split open per tab.</li><li>It's not possible to resize the two split panes.</li><li>When the keyboard is opened, the active note will be “maximized”, thus allowing for more space even when a split is open. When the keyboard is closed, the splits become equal in size again.</li></ul><p>Interaction:</p><ul><li>To create a new split, click the three dots button on the right of the note title and select <em>Create new split</em>.<ul><li>This option will only be available if there is no split already open in the current tab.</li></ul></li><li>To close a split, click the three dots button on the right of the note title and select <em>Close this pane</em>.<ul><li>Note that this option will only be available on the second note in the split (the one at the bottom on smartphones, the one on the right on tablets).</li></ul></li><li>When long-pressing a link, a contextual menu will show up with an option to <em>Open note in a new split</em>.<ul><li>If there's already a split, the option will replace the existing split instead.</li></ul></li></ul>",
++ "_help_RnaPdbciOfeq": "<figure class=\"image\"><img style=\"aspect-ratio:1990/1168;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Right%20Sidebar_image.png\" width=\"1990\" height=\"1168\"></figure><p>The right sidebar displays specific content for the current note. The sidebar is grouped into multiple tabs:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_2dcGDhp9WFKb\">Outline tab</a>, which displays the table of contents, highlights and other navigation-related sections depending on the note type.</li><li><a class=\"reference-link\" href=\"#root/_help_uNtgN0cUKEBc\">Attributes tab</a>, which provides a visual editor for the current note's&nbsp;<a class=\"reference-link\" href=\"#root/_help_zEY4DaJG4YT5\">Attributes</a>.</li><li><a class=\"reference-link\" href=\"#root/_help_LrKznOtw9cQD\">AI chat tab</a>, which uses the&nbsp;<a class=\"reference-link\" href=\"#root/_help_GBBMSlVSOIGP\">AI</a>&nbsp;integration to chat, with optional access to the current note.</li><li><a class=\"reference-link\" href=\"#root/_help_KRlZFoIH0j6p\">Connections tab</a>, which groups together the note map, note paths, backlinks and similar notes.</li></ul><h2>Toggling the right sidebar</h2><p>There are two ways to toggle the right sidebar:</p><ul><li>Via the&nbsp;<span class=\"tn-icon bx bx-sidebar bx-flip-horizontal\"></span> icon near the title bar, which toggles whether the sidebar is docked.</li><li>Via the <em>Toggle right pane</em> <a href=\"#root/_help_A9Oc6YKKc65v\">keyboard shortcut</a>, which is not assigned by default.</li></ul><h2>Peeking the sidebar</h2><p>There is a small strip near the right edge of the app which shows an arrow icon.</p><ul><li>When the sidebar is hidden, pressing the edge will <em>peek</em> the sidebar.<ul><li>In this mode the sidebar is shown temporarily above the content, without shifting the content of your notes.</li><li>Clicking outside the sidebar while in peek mode will simply hide the sidebar. Same goes for the X button and clicking on the right edge.</li><li>Pressing the pin icon will dock the sidebar.</li></ul></li><li>When the sidebar is docked, pressing the edge will hide the sidebar (similar to the toggle icon at the top).</li></ul>",
++ "_help_2dcGDhp9WFKb": "<p>The Outline tab appears in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>&nbsp;and displays the headings and highlights for the current note.</p><h2>Table of contents</h2><p>The table of contents displays the titles / headings in the current note and allows easy navigation.</p><p>The following note types are supported:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a></li><li><a class=\"reference-link\" href=\"#root/_help_6RM1Q7ppFVoj\">Markdown</a></li><li><a class=\"reference-link\" href=\"#root/_help_XJGJrpu7F9sh\">PDFs</a></li><li><a class=\"reference-link\" href=\"#root/_help_GBBMSlVSOIGP\">AI</a>&nbsp;chat notes</li><li>The pages of the in-app documentation</li></ul><figure class=\"image image-style-align-right image_resized\" style=\"width:47%;\"><img style=\"aspect-ratio:556/205;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Right%20Sidebar/1_Outline%20tab_image.png\" width=\"556\" height=\"205\"></figure><h3>Interaction</h3><ul><li>Clicking on a heading will scroll the document to the position of the heading.</li><li>As the document is scrolled, the heading being read is highlighted and the list scrolls to keep it in view. If that heading is hidden inside a collapsed section, the collapsed heading is highlighted instead.</li><li>Nested items can be collapsed by pressing the corresponding&nbsp;<span class=\"tn-icon bx bx-chevron-down\"></span> button.</li></ul><h2>Highlights</h2><figure class=\"image image-style-align-right image_resized\" style=\"width:46.04%;\"><img style=\"aspect-ratio:489/240;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Right%20Sidebar/Outline%20tab_image.png\" width=\"489\" height=\"240\"></figure><p>Similar to the&nbsp;table of contents, but instead of headings this feature will list highlighted text from a text note and allow easy navigation to them.</p><p>Unlike table of contents which supports multiple note types, the highlights are specific to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes.</p><p>Highlighted text is defined as:</p><ul><li>Bold text.</li><li>Italic text.</li><li>Underlined text.</li><li>Text with a foreground color set.</li><li>Text with a background color/highlight set.</li></ul><h3>Interaction</h3><ul><li>Clicking on a highlighted text will scroll the document to its position.</li></ul><h3>Configuration</h3><ul><li>Globally, it's possible to toggle the display of each category of highlighted text (as defined above)&nbsp;<ul><li>Pressing the gear button in the top-right part of the section will reveal a menu to toggle between the highlight categories.</li><li>Alternatively, they can be changed by going to&nbsp;<a class=\"reference-link\" href=\"#root/_hidden/_options/_optionsTextNotes\">Text Notes</a>&nbsp;settings and looking for the <em>Highlights List</em> section.</li></ul></li></ul><h2>PDF-specific outline</h2><p>When&nbsp;<a class=\"reference-link\" href=\"#root/_help_XJGJrpu7F9sh\">PDFs</a>&nbsp;are opened in Trilium, the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>&nbsp;is augmented with PDF-specific navigation, with the following features:</p><ul><li>Table of contents/outline<ul><li>All the headings and “bookmarks” will be displayed hierarchically.</li><li>The heading on the current page is also highlighted (note that it can be slightly offset depending on how many headings are on the same page).</li><li>Clicking on a heading will jump to the corresponding position in the PDF.</li></ul></li><li>Pages<ul><li>A preview of all the pages with a small thumbnail.</li><li>Clicking on a page will automatically navigate to that page.</li><li>Right-clicking a page and selecting <em>Copy reference</em> copies a link that opens the PDF at that page.</li></ul></li><li>Annotations<ul><li>Highlight and comment annotations are listed here.</li><li>Right-clicking an annotation and selecting <em>Copy reference</em> copies a link that opens the PDF at that annotation.</li></ul></li><li>Attachments<ul><li>If the PDF has its own attachments (not to be confused with Trilium's&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>), they will be displayed in a list.</li><li>Some information such as the name and size of the attachment are displayed.</li><li>It's possible to download the attachment by clicking on the download button.</li></ul></li><li>Layers<ul><li>A less common feature, if the PDF has toggle-able layers, these layers will be displayed in a list here.</li><li>It's possible to toggle the visibility for each individual layer.</li></ul></li></ul>",
++ "_help_uNtgN0cUKEBc": "<figure class=\"image image-style-align-right image_resized\" style=\"width:34.71%;\"><img style=\"aspect-ratio:596/1688;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Right%20Sidebar/Attributes%20tab_image.png\" width=\"596\" height=\"1688\"></figure><p>The attributes tab provides a more graphical way to view and edit <a href=\"#root/_help_zEY4DaJG4YT5\">attributes</a>.</p><h2>Sections</h2><p>The following information is displayed in sections:</p><ul><li><em>Owned attributes</em>, contains a list of the attributes that belong to this note.</li><li><em>Inherited attributes</em> are attributes that apply to the current note but come through&nbsp;<a class=\"reference-link\" href=\"#root/_help_bwZpz2ajCEwO\">Attribute Inheritance</a>.</li><li><em>Definitions</em> describe the type of attributes and are used in&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_2FvYrpmOXm29\">Table</a>&nbsp;collections.</li></ul><h2>Owned attributes</h2><p>Every item is structured as such:</p><ul><li>The icon of each item indicates whether it's a <a href=\"#root/_help_HI6GBBIduIgv\">label</a> (<span class=\"tn-icon bx bx-hash\"></span>) or a <a href=\"#root/_help_Cq5X6iKQop6R\">relation</a> (<span class=\"tn-icon bx bx-transfer\"></span>, link to another note).</li><li>The first text is the name of the label.</li><li>The value of the attribute is displayed after the name, if present.<ul><li>The value is shown in a graphical way: a relation's value is a clickable note link; a color label shows a color chip.</li></ul></li></ul><p>System attributes (that have a special meaning in Trilium) show a small <span class=\"tn-icon bx bx-cog\"></span> cog near the icon and are grouped separately from the user-defined ones.</p><p>Interaction:</p><ul><li>Clicking on the item (apart from the value and links) reveals a dedicated popup where the name, value and&nbsp;<a class=\"reference-link\" href=\"#root/_help_bwZpz2ajCEwO\">Attribute Inheritance</a>&nbsp;can be defined.</li><li>The value of the attributes can be edited in-place:<ul><li>The input box follows the type defined in a corresponding label definition (date, color, dropdown, numbers), as well as for system attributes that have a specific type (e.g. <code>color</code>).</li><li>For labels, clicking on the value edits its in-place.<ul><li>Press <kbd>Enter</kbd> to confirm or click outside the input box, or <kbd>Esc</kbd> to dismiss.</li><li>For multi-line text, <kbd>Ctrl</kbd>+<kbd>Enter</kbd> confirms whereas <kbd>Enter</kbd> creates a newline.</li></ul></li><li>For checkbox attributes, clicking on the checkbox will toggle its state.</li><li>For labels without a value, a value can be added by clicking on the <em>No value</em> text which appears while the mouse is hovered on the item.</li><li>For relations, there is a dedicated <span class=\"tn-icon bx bx-pencil\"></span> button instead.</li></ul></li><li>An attribute can be deleted by pressing the <span class=\"tn-icon bx bx-trash\"></span> button to its right, which only appears while hovered. A confirmation screen is displayed first to ensure the attribute is not accidentally deleted.</li></ul><p>Attributes can be added in two ways:</p><ul><li>A new label, relation or attribute definition can be added from the <span class=\"tn-icon bx bx-plus\"></span> button near the title of the section. This shows the full detail popup.</li><li>To quickly add a label or a relation directly from the sidebar, click the <em>Add attribute</em> (<span class=\"tn-icon bx bx-plus\"></span>) item at the end of the list.<ul><li>The name field will be focused first. By default, a label will be created instead but it can be toggled to a relation by typing <kbd>~</kbd> or pressing the <span class=\"tn-icon bx bx-hash\"></span> icon (similarly, typing <code>#</code> will switch back to a label instead of a relation).</li><li>Once the name is filled, press <kbd>Enter</kbd> to continue to the value. Type in a value if desired and then press <kbd>Enter</kbd> again to create the attribute.</li><li>Clicking outside the editor will also create the attribute, but only if a name is specified.</li></ul></li></ul><h2>Inherited attributes</h2><p>Inherited labels or relations are shown in the same fashion as <em>Owned attributes</em>.</p><p>The only differences are:</p><ul><li>To the right of the inherited attribute there is a link to the note where the attribute comes from, as well as an <span class=\"tn-icon bx bx-sitemap\"></span> icon to indicate that it's inheritable.</li><li>Clicking on an inherited attribute will reveal the same popup as owned attributes, but it is not editable. To edit it, first navigate to the note where the attribute is defined.</li></ul><h2>Definitions</h2><p>For attribute definition (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>):</p><ul><li>The icon indicates the type of the attribute (text, number).<ul><li>If an attribute is promoted, it has a small <span class=\"tn-icon bx bx-chevron-up\"></span> chevron icon overlaid on top of it.</li></ul></li><li>The name indicates the name of the attribute it defines (without the <code>label:</code> or <code>relation:</code> prefix).</li><li>To the right of the name a short summary is displayed which indicates the display name (alias), whether it has multiple values or an inverse relation.</li><li>Clicking on a definition reveals a popup, where the name, type, display name and other aspects can be configured.</li><li>A new label or relation definition can be added from the <span class=\"tn-icon bx bx-plus\"></span> button near the title of the section.</li><li>For inherited definition, there is a link to the note where the definition comes from, as well as an <span class=\"tn-icon bx bx-sitemap\"></span> icon to indicate that it's inherited.</li></ul><h2>Mobile</h2><p>The attributes can also be edited visually on mobile, but not as part of the sidebar. Go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>&nbsp;and select <em>Note attributes</em>.</p>",
+ "_help_LrKznOtw9cQD": "<p>Once the&nbsp;<a class=\"reference-link\" href=\"#root/_help_GBBMSlVSOIGP\">AI</a>&nbsp;integration is activated, a <em>Chat</em> entry will appear in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>.</p><ul><li>Unlike the dedicated note type, the side bar has optional access to the current note, making it easy to ask for information or modifications to a note without having to search for the note first.<ul><li>To toggle whether the current note is visible to the AI, simply click on the file icon at the bottom of the chat interface.</li></ul></li><li>On the top-right of the sidebar there are three buttons:<ul><li>Create a new conversation.</li><li>Go to a previous conversation</li><li>Save the current conversation as a dedicated note in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a>, which turns it into a dedicated chat note.</li></ul></li></ul><aside class=\"admonition note\"><p>The sidebar chats are stored in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_2mUhVmZK8RF3\">Hidden Notes</a>&nbsp;and can be seen in the <em>AI Chat History</em> section.</p></aside>",
- "_help_KRlZFoIH0j6p": "<figure class=\"image image-style-align-right image_resized\" style=\"width:33.35%;\"><img style=\"aspect-ratio:490/1801;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Right%20Sidebar/Connections%20tab_image.png\" width=\"490\" height=\"1801\"></figure><p>The connections tab groups together all the information about the current note and how it relates to other notes, in four different sections.</p><aside class=\"admonition note\"><p>It's generally best to keep only the desired sections expanded as each of the sections have to retrieve additional data that might not otherwise be needed. While collapsed, the sections do not retrieve any additional data.</p></aside><h2>Note map</h2><p>The note map displays a graph which shows the relation between the current notes and other notes on the hierarchy. There are two types of visualizations, which can be selected from the top-right part of the section:</p><ul><li>The <em>Link map</em>, which displays the <a href=\"#root/_help_Cq5X6iKQop6R\">relations</a> between notes.</li><li>The <em>Tree map</em>, which displays the hierarchical structure.</li></ul><p>The sidebar will remember which visualization is selected, as a global option. Note that note maps also have a <code spellcheck=\"false\">#mapType</code> which describes which visualization to use, but the sidebar deliberately ignores that to keep consistency when switching between notes.</p><p>The map can also be expanded by pressing the button in the top-right of the section. When expanded, the map is displayed in a separate dialog. Alternatively, all other sections can be collapsed, which will make the note map taller and the sidebar can be dragged to make for more lateral space.</p><p>The note map view inside the sidebar is deliberately more compact in order to fit the space: the link map would also show notes that don't have a link to the current note from the hierarchy (creating a cloud of dots) but this is only shown while the map is expanded. Similarly, the link strength and pin configuration buttons are not displayed here.</p><p>See also:</p><ul><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_bdUJEHsAPYQR\">Note Map</a>&nbsp;note type</li><li><a class=\"reference-link\" href=\"#root/_help_BCkXAVs63Ttv\">Note Map (Link map, Tree map)</a>&nbsp;for more information on the concept as a whole.</li></ul><h2>Note paths</h2><p>The note paths section displays the locations in which the current note is <a href=\"#root/_help_IakOLONlIfGI\">cloned</a>. Each segment of the note path is clickable, in order to navigate to that note or clone.</p><p>A new clone can be created from the top-right button.</p><h2>Backlinks</h2><p>Backlinks list the notes that refer to the current note, as well as a preview of the content where the reference to the note is made.</p><p>For more information, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_wfGXLmm7x27z\">Backlinks</a>.</p><h2>Similar notes</h2><p>Displays a list of notes that appear similar based on the content of the notes and their attributes. For more information, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_xWtq5NUHOwql\">Similar Notes</a>.</p>",
- "_help_r5JGHN99bVKn": "<figure class=\"image image-style-align-center image_resized\" style=\"width:50%;\"><img style=\"aspect-ratio:988/572;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/1_Recent%20Changes_image.png\" width=\"988\" height=\"572\"></figure><h2>Accessing the recent changes</h2><ul><li>For an overview of the changes across all documents, press the <img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Recent%20Changes_image.png\" width=\"25\" height=\"21\"> button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.<ul><li>If there is a <a href=\"#root/_help_OR8WJ7Iz9K4U\">hoisted note</a> or a <a href=\"#root/_help_9sRHySam5fXb\">workspace</a>, the list of recent changes will be limited to the descendents of the hoisted note, or the workspace.</li></ul></li><li>To limit the list of recent changes to a note and its descendants, look for the corresponding option in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_YtSN43OrfzaA\">Note tree contextual menu</a>&nbsp;→ Advanced.</li></ul><h2>Interaction</h2><ul><li>Notes which were changed will appear in reverse chronological order (latest update first).</li><li>The title of the note is displayed, as well as the note path. Clicking on the note title will dismiss the dialog and navigate to that particular note.</li><li>Deleted notes will also be listed here, at their time of deletion. Press the <em>Undelete</em> link next to them in order to recover them.</li></ul>",
++ "_help_KRlZFoIH0j6p": "<figure class=\"image image-style-align-right image_resized\" style=\"width:33.35%;\"><img style=\"aspect-ratio:490/1801;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Right%20Sidebar/Connections%20tab_image.png\" width=\"490\" height=\"1801\"></figure><p>The connections tab groups together all the information about the current note and how it relates to other notes, in four different sections.</p><aside class=\"admonition note\"><p>It's generally best to keep only the desired sections expanded as each of the sections have to retrieve additional data that might not otherwise be needed. While collapsed, the sections do not retrieve any additional data.</p></aside><h2>Note map</h2><p>The note map displays a graph which shows the relation between the current notes and other notes on the hierarchy. There are two types of visualizations, which can be selected from the top-right part of the section:</p><ul><li>The <em>Link map</em> (<span class=\"tn-icon bx bx-network-chart\"></span>), which displays the <a href=\"#root/_help_Cq5X6iKQop6R\">relations</a> between notes.</li><li>The <em>Tree map</em> (<span class=\"tn-icon bx bx-sitemap\"></span>), which displays the hierarchical structure.</li></ul><p>The sidebar will remember which visualization is selected, as a global option. Note that note maps also have a <code>#mapType</code> which describes which visualization to use, but the sidebar deliberately ignores that to keep consistency when switching between notes.</p><p>The map can also be expanded by pressing the <span class=\"tn-icon bx bx-expand-alt\"></span> button in the top-right of the section. When expanded, the map is displayed in a separate dialog. Alternatively, all other sections can be collapsed, which will make the note map taller and the sidebar can be dragged to make for more lateral space.</p><p>The note map view inside the sidebar is deliberately more compact in order to fit the space: the link map would also show notes that don't have a link to the current note from the hierarchy (creating a cloud of dots) but this is only shown while the map is expanded. Similarly, the link strength and pin configuration buttons are not displayed here.</p><p>See also:</p><ul><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_bdUJEHsAPYQR\">Note Map</a>&nbsp;note type</li><li><a class=\"reference-link\" href=\"#root/_help_BCkXAVs63Ttv\">Note Map (Link map, Tree map)</a>&nbsp;for more information on the concept as a whole.</li></ul><h2>Note paths</h2><p>The note paths section displays the locations in which the current note is <a href=\"#root/_help_IakOLONlIfGI\">cloned</a>. Each segment of the note path is clickable, in order to navigate to that note or clone. The root note is shown as its icon, the same as in the <a class=\"reference-link\" href=\"#root/_help_I6p2a06hdnL6\">Breadcrumb</a>; hovering it shows its title.</p><p>A new clone can be created from the <span class=\"tn-icon bx bx-duplicate\"></span> button at the top-right.</p><h2>Backlinks</h2><p>Backlinks list the notes that refer to the current note, as well as a preview of the content where the reference to the note is made.</p><p>For more information, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_wfGXLmm7x27z\">Backlinks</a>.</p><h2>Similar notes</h2><p>Displays a list of notes that appear similar based on the content of the notes and their attributes. For more information, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_xWtq5NUHOwql\">Similar Notes</a>.</p>",
++ "_help_r5JGHN99bVKn": "<figure class=\"image image-style-align-center image_resized\" style=\"width:50%;\"><img style=\"aspect-ratio:988/572;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Recent%20Changes_image.png\" width=\"988\" height=\"572\"></figure><h2>Accessing the recent changes</h2><ul><li>For an overview of the changes across all documents, press the&nbsp;<span class=\"tn-icon bx bx-history\"></span> button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.<ul><li>If there is a <a href=\"#root/_help_OR8WJ7Iz9K4U\">hoisted note</a> or a <a href=\"#root/_help_9sRHySam5fXb\">workspace</a>, the list of recent changes will be limited to the descendents of the hoisted note, or the workspace.</li></ul></li><li>To limit the list of recent changes to a note and its descendants, look for the corresponding option in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_YtSN43OrfzaA\">Note tree contextual menu</a>&nbsp;→ Advanced.</li></ul><h2>Interaction</h2><ul><li>Notes which were changed will appear in reverse chronological order (latest update first).</li><li>The title of the note is displayed, as well as the note path. Clicking on the note title will dismiss the dialog and navigate to that particular note.</li><li>Deleted notes will also be listed here, at their time of deletion. Press the <em>Undelete</em> link next to them in order to recover them.</li></ul>",
+ "_help_ny318J39E5Z0": "<p>Zoom applies to the entire UI, including text.</p><p>On the desktop application, use the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;to zoom in/out.</p><p>On both web browser and the desktop, the keyboard shortcuts <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>+</kbd> and <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>-</kbd> can be used.</p><h2>Adjusting the text size instead</h2><p>As an alternative to the zoom, the text size can be individually adjusted by going to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Appearance</em>.</p>",
- "_help_lgKX7r3aL30x": "<figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:505/261;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tooltip_image.png\" width=\"505\" height=\"261\"></figure><p>The note tooltip is a convenience feature which displays a popup when hovering over an <a href=\"#root/_help_hrZ1D00cLbal\">internal link</a> to another note.</p><p>The following information is displayed:</p><ul><li>The note path, at the top of the popup.</li><li>The title of the note.<ul><li>Clicking on the title will open the note in the current tab.</li><li>Holding <kbd>Ctrl</kbd> pressed while clicking the title will open in a new tab instead of the current one.</li></ul></li><li>A snippet of the content will be displayed as well.</li><li>A button to <a href=\"#root/_help_ZjLYv08Rp3qC\">quickly edit</a> the note in a popup.</li></ul><p>The tooltip can be found in multiple places, including:</p><ul><li>In&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes, when hovering over&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;.</li><li><a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>: <ul><li><a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map View</a>, when hovering over a marker.</li><li><a class=\"reference-link\" href=\"#root/_help_xWbu3jpNWapp\">Calendar View</a>, when hovering over an event.</li><li><a class=\"reference-link\" href=\"#root/_help_2FvYrpmOXm29\">Table View</a>, when hovering over a note title, or over a <a href=\"#root/_help_Cq5X6iKQop6R\">relation</a>.</li></ul></li></ul>",
- "_help_IjZS7iK5EXtb": "<p>The <em>New layout</em> is a series of UI/UX changes that were introduced in v0.101.0 that heavily change both existing UI elements, as well as adding some new ones. The goal of this new layout is to modernize the application and to make it more intuitive but at the same time to reduce clutter.</p><h2>Newly introduced features</h2><h3>Status bar</h3><p>At the bottom of the window there is a new bar called the <em>Status bar</em>. This bar houses multiple items such as the Breadcrumb navigation and information and settings about the current note, such as the <a href=\"#root/_help_veGu4faJErEM\">content language</a> and&nbsp;<a class=\"reference-link\" href=\"#root/_help_zEY4DaJG4YT5\">Attributes</a>.</p><p>For more information, consult the <a href=\"#root/_help_AlJ73vBCjWDw\">dedicated page</a>.</p><figure class=\"image\"><img style=\"aspect-ratio:1150/27;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/5_New%20Layout_image.png\" width=\"1150\" height=\"27\"></figure><h3>Inline title</h3><p>In previous versions of Trilium, the title bar was fixed at all times. In the new layout, there is both a fixed title bar and one that scrolls with the text. The newly introduced title is called the <em>Inline title</em> and it displays the title in a larger font, while also displaying additional information such as the creation and the modification date.</p><p>Whenever the title is scrolled past, the fixed title is shown instead.</p><p>This only affects&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;notes. Note types that take the entirety of the screen such as&nbsp;<a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a>&nbsp;will always have only the fixed title bar.</p><p>Depending on the note type, the inline title will also present some more interactive options such as being able to switch the note type (see below).</p><figure class=\"image\"><img style=\"aspect-ratio:899/122;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/New%20Layout_image.png\" width=\"899\" height=\"122\"><figcaption>The <em>Inline title</em>, which is displayed at the top of the note and can be scrolled past.</figcaption></figure><figure class=\"image\"><img style=\"aspect-ratio:910/104;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/4_New%20Layout_image.png\" width=\"910\" height=\"104\"><figcaption>The fixed title bar. The title only appears after scrolling past the <em>Inline title</em>.</figcaption></figure><h3>New note type switcher</h3><p>When a new&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;or&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note is created, a note type switcher will appear below the <em>Inline title</em>. Apart from changing the note type, it's also possible to apply a <a href=\"#root/_help_KC1HB96bqqHX\">template</a>.</p><p>The switcher will disappear as soon as a text is entered.</p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/6_New%20Layout_image.png\" width=\"735\" height=\"143\"><h3>Note badges</h3><p>Note badges appear near the fixed note title and indicate important information about the note such as whether it is read-only. Some of the badges are also interactive.</p><figure class=\"image\"><img style=\"aspect-ratio:910/49;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/3_New%20Layout_image.png\" width=\"910\" height=\"49\"></figure><p>The following badges are available:</p><ul><li><strong>Read-only badge</strong>, which will be shown if the note is not editable due to either automatic read-only or manual read-only. Clicking on the badge will temporarily edit the note (similar to the Edit <a href=\"#root/_help_XpOYSgsLkTJy\">floating button</a>).</li><li><strong>Share badge</strong>, which will indicate that the current note is shared. The badge will also indicate if the share is on the local network (for the desktop application without&nbsp;<a class=\"reference-link\" href=\"#root/_help_cbkrhQjrkKrh\">Synchronization</a>&nbsp;set up) or publicly accessible (for the server).</li><li><strong>Web clip badge</strong>, which will indicate if the note was clipped using the&nbsp;<a class=\"reference-link\" href=\"#root/_help_MtPxeAWVAzMg\">Web Clipper</a>. The badge acts as a link, so it can be clicked on to navigate to the page or right clicked for more options.</li><li><strong>Execute badge</strong>, for <a href=\"#root/_help_CdNpE2pqjmI6\">scripts</a> or <a href=\"#root/_help_YKWqdJhzi2VY\">saved SQL queries</a> which have an execute button or a description.</li></ul><p>Some of these badges replace the dedicated panels at the top of the note.</p><h3>Collapsible sections</h3><figure class=\"image\"><img style=\"aspect-ratio:496/265;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/1_New%20Layout_image.png\" width=\"496\" height=\"265\"></figure><p>The following sections have been made collapsible:</p><ul><li><em>Promoted Attributes</em><ul><li>For full-height notes such as&nbsp;<a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a>, the promoted attributes are collapsed by default to make room.</li><li>The keyboard shortcut previously used to trigger the promoted attributes ribbon tab (which was no longer working) has been repurposed to toggle the promoted attributes instead.</li></ul></li><li><em>Edited Notes</em>, which appears for&nbsp;<a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a>&nbsp;is now shown underneath the title.<ul><li>Whether the section is collapsed or not depends on the choice in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ Appearance.</li></ul></li><li><em>Search Properties</em>, which appears for the full&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a>.</li></ul><h3>Save status indicator</h3><p><img class=\"image-style-align-right\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/2_New%20Layout_image.png\" width=\"168\" height=\"47\">To the right of the note title, a temporary indicators appears after making a change to the document that indicates whether the document has been saved.</p><p>It indicates the following states:</p><ul><li><em>Unsaved</em>, if the changes will be saved soon.</li><li><em>Saving</em>, if the changes are being saved.</li><li><em>Saved</em>, if all the changes were successfully saved to the server.</li><li><em>Error</em>, if the changes could not be saved, for example due to a communication server with the server.</li></ul><p>After all changes have been saved, the indicator will hide automatically after a few seconds.</p><h2>Changing to the existing layout</h2><h3>Removal of the ribbon</h3><p>The most significant change is the removal of the ribbon. All the actions and options from the ribbon were integrated in other places in the application.</p><p>Here's how all the different tabs that were once part of the ribbon are now available in the new layout:</p><ul><li>“Formatting toolbar” was relocated to the top of the page.<ul><li>Instead of having one per split, now there is a single formatting toolbar per tab. This allows more space for the toolbar items.</li></ul></li><li>“Owned attributes” and “Inherited attributes” were merged and moved to the status bar region (displayed one above the other).</li><li>“Basic Properties” were integrated in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note buttons</a>&nbsp;menu.<ul><li>The only exception here is the Language combo box which can now be found in the status bar (top-right of the screen).</li></ul></li><li>“File” and “Image” tabs<ul><li>The buttons were moved to the right of the note title, as dedicated entries in&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note buttons</a>.</li><li>The info section has been merged into the <em>Note info</em> section of the status bar.</li></ul></li><li>Edited notes<ul><li>Moved underneath the title, displayed under a collapsible area and the notes are represented as badges/chips.</li><li>Whether the section is expanded or collapsed depends on the “Edited Notes ribbon tab will automatically open on day notes” setting from Options → Appearance.</li></ul></li><li>Search definition tab<ul><li>Moved underneath the title under a collapsible area.</li><li>Expanded by default for new searches, collapsed for saved searches.</li></ul></li><li>The Note map is now available in the Note actions menu.<ul><li>Instead of opening into a panel in the ribbon, the note map now opens in the sidebar, in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_KRlZFoIH0j6p\">Connections tab</a>&nbsp;where it can also be maximized.</li></ul></li><li>“Note info” tab was moved to a small (i) icon in the status bar.</li><li>“Similar notes” tab<ul><li>Instead of opening into a panel in the ribbon, the similar notes are now shown in the sidebar, in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_KRlZFoIH0j6p\">Connections tab</a>.</li></ul></li><li>The Collection properties tab were relocated under the note title and grouped into:<ul><li>A combo box to quickly switch between views.</li><li>Individual settings for the current view in a submenu.</li></ul></li><li>Some smaller ribbon tabs were converted to badges that appear near the note title in the breadcrumb section:<ul><li>Original URL indicator for clipped web pages (<code spellcheck=\"false\">#pageUrl</code>).</li><li>SQL and script execute buttons.</li></ul></li></ul><aside class=\"admonition note\"><p>The ribbon keyboard shortcuts (e.g. <code spellcheck=\"false\">toggleRibbonTabClassicEditor</code>) have been repurposed to work on the new layout, where they will toggle the appropriate panel.</p></aside><h3>Removal of the floating buttons</h3><p>Most of the buttons were relocated to the right of the note title, in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note buttons</a>&nbsp;area, with the exception of:</p><ul><li>The Edit button is displayed near the note title, as a badge.</li><li><em>Backlinks</em> are now displayed in the sidebar, in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_KRlZFoIH0j6p\">Connections tab</a>.<ul><li>Alternatively, the backlinks count is displayed in the status bar and when clicked the sidebar opens at the right section.</li></ul></li><li>Relation map zoom buttons are now part of the relation map itself.</li><li>Export image to PNG/SVG are now in the Note actions menu, in the <em>Export as image</em> option.</li></ul><h3>Changes to the sidebar</h3><p>The sidebar (also known as the right pane) also received some important changes.</p><p>Most importantly, v0.105.0 splits the sidebar into multiple tabs with additional functionality:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_2dcGDhp9WFKb\">Outline tab</a>, which gathers the table of contents and highlights lists.</li><li><a class=\"reference-link\" href=\"#root/_help_uNtgN0cUKEBc\">Attributes tab</a>, which provides a graphical method of editing labels, relations and (promoted) attribute definitions.</li><li>A dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_LrKznOtw9cQD\">AI chat tab</a>.</li><li><a class=\"reference-link\" href=\"#root/_help_KRlZFoIH0j6p\">Connections tab</a>, which groups together the note map, note paths, backlinks and similar notes.</li></ul><p>The previous iteration of the sidebar would appear contextually, depending on whether there are any items to be displayed. This caused occasional content shifts when moving between two panes in a split view. In the new layout, the sidebar acts more like the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;pane, remaining visible even if there is nothing to display.</p><p>In order to toggle the sidebar, there is a new button on the top-right side of the screen, near the window buttons (on Windows and Linux).</p><p>Now each section of the sidebar (e.g. “Table of Contents”, “Highlights list”) is individually collapsible and will remember whether it was collapsed.</p><p>Some sidebar items also have a contextual menu, indicated by the three dots on the title. For example, the highlights filter can be adjusted directly from that menu.&nbsp;</p><p>Custom widgets are still supported. For custom scripts, the three dots menu allows quick navigation to the corresponding script note.</p><h2>How to toggle the new layout</h2><p>Starting with v0.101.0, this new layout is enabled by default. It is possible to fall back to the old layout by going to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ Appearance and selecting <em>Old layout</em>.</p><aside class=\"admonition important\"><p>Since a new layout was introduced, this becomes the standard one. The <em>Old layout</em> is considered deprecated and will not receive new features (for example, the breadcrumb) as we focus on the new one. At some point the old layout will be removed entirely, as maintaining two layouts with major differences creates a maintenance burden.</p></aside>",
- "_help_I6p2a06hdnL6": "<figure class=\"image\"><img style=\"aspect-ratio:1150/27;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/New%20Layout/Breadcrumb_image.png\" width=\"1150\" height=\"27\"></figure><p>The breadcrumb allows quickly viewing the note hierarchy of the current note and navigating through it.</p><p>It is part of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlJ73vBCjWDw\">Status bar</a>, displayed in the bottom-left of the screen.</p><h2>Layout and Interaction</h2><ul><li>If a note or workspace is hoisted, a badge will appear on the left-most side.<ul><li>Clicking on the badge will un-hoist the note/workspace.</li></ul></li><li>The left-most icon represents the root note, or the hoisted note or workspace.<ul><li>Clicking the icon will jump to the root note.</li><li>Right clicking the icon will display a menu that allows opening the note in a new tab, split, etc.</li></ul></li><li>Each segment shows the title of a note in the current note hierarchy.<ul><li>Clicking the icon will jump to that note.</li><li>Right clicking will open a menu with multiple options such as opening the note in a different tab/split/window, hoisting, moving/cloning the note, duplicating as well as changing the color of the note.</li></ul></li><li>Clicking the arrow next to each segment will reveal the child notes of the segment on the left.<ul><li>Clicking on an icon will navigate to that particular note.</li><li>It's also possible to create a new child note from here.</li><li>The menu can optionally hide the archived notes.</li></ul></li><li>If the current note is deep within a hierarchy, the segments will collapse into a […] button in order not to occupy too much space.<ul><li>Clicking this button will display each collapsed entry as a menu item. Clicking on it will navigate to that particular note.</li></ul></li><li>Right clicking on an empty space to the right of the breadcrumb (before the other status bar items) will reveal another menu that allows:<ul><li>Toggling whether archived notes are displayed in the breadcrumb and in the note tree.</li><li>Copying the current note path to clipboard.</li></ul></li></ul>",
- "_help_AlJ73vBCjWDw": "<p>The status bar displays information about the current note and allows changing settings related to it such as configuring the language or attributes.</p><h2>Layout and interaction</h2><p>On the left side, the&nbsp;<a class=\"reference-link\" href=\"#root/_help_I6p2a06hdnL6\">Breadcrumb</a>&nbsp;is displayed which indicates the current note as well as its parent notes and allows for quick navigation throughout the hierarchy.</p><p>On the right side, specific sections will show depending on the type of the current note.</p><ol><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;notes, the language mode of the note is indicated (e.g. JavaScript, plain text), as well as allowing easy switching to another mode.</li><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes, the content language is displayed and can be changed, thus configuring the spell-check and the right-to-left support.<ol><li>Note that this applies to the entire note and not the selection, unlike some text editors.</li></ol></li><li>If a note is placed in multiple places in the tree (cloned), the number of the note paths will be displayed.<ol><li>Clicking it will reveal the full list of note paths in the sidebar's&nbsp;<a class=\"reference-link\" href=\"#root/_help_KRlZFoIH0j6p\">Connections tab</a>.</li></ol></li><li>If a note has attachments, their number will be displayed.<ol><li>Clicking on it will reveal the list of attachments in a new tab.</li></ol></li><li>If a note is linked from other text notes (backlinks), the number of backlinks will be displayed.<ol><li>Clicking on it will show the list of notes that link to this note, as well as an excerpt of where the note is referenced in the sidebar's&nbsp;<a class=\"reference-link\" href=\"#root/_help_KRlZFoIH0j6p\">Connections tab</a>.</li></ol></li></ol><p>Regardless of note type, the following items will always be displayed if there is a note:</p><ol><li>Note info, which displays:<ol><li>The creation/modification date of the note.</li><li>The type and MIME of the note.</li><li>The note ID.</li><li>An estimation of the note size of the note itself and its children.</li><li>A button to reveal the Similar notes in the sidebar's&nbsp;<a class=\"reference-link\" href=\"#root/_help_KRlZFoIH0j6p\">Connections tab</a>.</li></ol></li></ol><aside class=\"admonition note\"><p>When pressing a button which reveals the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>, it has a specific behavior if the sidebar is hidden: the sidebar will be peeked instead of docked. Regardless the sidebar will be switched to the appropriate tab and the corresponding section will be highlighted.</p></aside>",
- "_help_SL5f1Auq7sVN": "<p>Split view is a feature of&nbsp;<a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_6RM1Q7ppFVoj\">Markdown</a>&nbsp;notes which displays both the source code on one side and the preview of the content on the other.</p><p><a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a>&nbsp;also allow changing between a horizontal or a vertical split, to accommodate for the various sizes of diagrams.</p><h2>Display modes and interaction</h2><p>The split comes with three different display modes:</p><ul><li><em>Split view</em>, in which both the source code is available on one side and can be edited, and the preview is available on the other side.<ul><li>In this mode, the size of either the source pane or the preview pane can be adjusted by dragging the small border between them.</li></ul></li><li><em>Source view</em> which shows the source code on the entire screen for a more focused editing experience.</li><li><em>Preview</em> which displays only the rendering of the diagram or text in full screen, especially useful for read-only notes.</li></ul><p>These buttons can be found near the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note buttons</a>&nbsp;section on the&nbsp;<a class=\"reference-link\" href=\"#root/_help_IjZS7iK5EXtb\">New Layout</a>, or in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_XpOYSgsLkTJy\">Floating buttons</a>&nbsp;on the old layout.</p><p>The display node is stored at note level.</p><h2>Relation to read-only notes</h2><p>If a note is marked as <a href=\"#root/_help_CoFPLs3dRlXc\">read-only</a>, the source view will not be editable. While in preview mode, marking a note as read-only has no effect since the preview itself is not editable.</p>",
- "_help_t596jLvPrqkS": "<p>Some note types such as&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>,&nbsp;<a class=\"reference-link\" href=\"#root/_help_iRwzGnHPzonm\">Relation Map</a>, and saved search intentionally limit the width of the content.</p><p>This might appear surprising at first, but the idea is to make text fit well on wider screens without appearing distorted. This is especially the case if the document contains&nbsp;<a class=\"reference-link\" href=\"#root/_help_mT0HEkOsz6i1\">Images</a>, tables or other width-dependent elements.</p><h2>Configuring the content width and alignment</h2><p>The content width is expressed in pixels and can be changed from&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Appearance</em> → <em>Content Width</em> and adjusting the <em>Max content width</em> section.</p><p>To effectively disable the content width limitation, simply set the width to a value larger than your screen size (e.g. 9999).</p><p>By default, the content is aligned to the left, but it can be centered horizontally by checking <em>Keep content centered</em> from the same section as the content width.</p><h2>Adjusting at note level</h2><p>For notes with large elements such as&nbsp;<a class=\"reference-link\" href=\"#root/_help_NdowYOC1GFKS\">Tables</a>, it sometimes makes sense to avoid the content width without affecting other notes. To do so:</p><ul><li>Since v0.104.0 in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_IjZS7iK5EXtb\">New Layout</a>&nbsp;only, go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note buttons</a>&nbsp;and toggle <em>Full width</em>.</li><li>Or manually apply the <code spellcheck=\"false\">fullContentWidth</code> <a href=\"#root/_help_HI6GBBIduIgv\">label</a> to the note.</li></ul><aside class=\"admonition note\"><p>Some <a href=\"#root/_help_KSZ04uQ2D1St\">note types</a> are full width by default, such as the&nbsp;<a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a>. In that case the <em>Full width</em> toggle will not be displayed and the label will have no effect.</p></aside>",
- "_help_BFs8mudNFgCS": "<p>Note is a central entity in Trilium. Main attributes of note are <a href=\"#root/_help_l7pigIGu01K2\">title</a> and content.</p><h3>Note types</h3><p>The main note type is a rich-text note type called&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>. For diagrams and drawing there is&nbsp;<a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a>.</p><p>There are also more complex note types such as&nbsp;<a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a>,&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>&nbsp;that usually go hand-in-hand with&nbsp;<a class=\"reference-link\" href=\"#root/_help_CdNpE2pqjmI6\">Scripting</a>.</p><p>In Trilium there's no specific \"folder\" note type. Any note can have children and thus be a folder.</p><h3>Root note</h3><p>There's one special note called \"root note\" which is root of the note tree. All other notes are placed below it in the structure.</p><h3>Tree structure</h3><p>Importantly, note itself doesn't carry information on its placement in note tree. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_IakOLONlIfGI\">Cloning Notes</a>&nbsp;for details.</p><p>Tree structure of notes can resemble file system - but compared to that notes in Trilium can act as both file and directory - meaning that note can both have its own content and have children. \"Leaf note\" is a note which doesn't have any children.</p><h3>Deleting / undeleting notes</h3><p>When you delete a note in Trilium, it is actually only marked for deletion (soft-delete) - the actual content, title, attributes etc. are not deleted, only hidden.</p><p>Within (by default) 7 days, it is possible to undelete these soft-deleted notes - open the&nbsp;<a class=\"reference-link\" href=\"#root/_help_r5JGHN99bVKn\">Recent Changes</a>&nbsp;dialog, and you will see a list of all modified notes including the deleted ones. Notes available for undeletion have a link to do so. This is kind of \"trash can\" functionality known from e.g. Windows.</p><p>Clicking an undelete will recover the note, its content and attributes - note should be just as before being deleted. This action will also undelete note's children which have been deleted in the same action.</p><p>To be able to undelete a note, it is necessary that deleted note's parent must be undeleted (otherwise there's no place where we can undelete it to). This might become a problem when you delete more notes in succession - the solution is then undelete in the reverse order of your deletion.</p><p>After the 7 days (configurable) the notes will be \"erased\" - their title, content, revisions and attributes will be erased, and it will not be possible anymore to recover them (unless you restore a&nbsp;<a class=\"reference-link\" href=\"#root/_help_ODY7qQn5m2FT\">Backup</a>).</p><h2>See also</h2><ul><li><a class=\"reference-link\" href=\"#root/_help_CoFPLs3dRlXc\">Read-Only Notes</a></li></ul>",
- "_help_l7pigIGu01K2": "<p>Alongside its content, the <strong>title</strong> is one of the two main attributes of a <a href=\"#root/_help_BFs8mudNFgCS\">note</a>. It's the short, human-readable name shown in the editable field at the top of every note, and it's what identifies the note throughout the interface (in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, in tabs, in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_I6p2a06hdnL6\">Breadcrumb</a>&nbsp;and win&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>.</p><p>Internally, notes are identified by a unique&nbsp;<a class=\"reference-link\" href=\"#root/_help_m1lbrzyKDaRB\">Note ID</a>&nbsp;rather than by their title, so the title is purely for your benefit. This has a few consequences:</p><ul><li><strong>Titles don't have to be unique.</strong> You can have any number of notes that share the same title without conflict.</li><li><strong>Renaming a note never breaks links to it.</strong> Links between notes point at the underlying note, so changing a title leaves existing links intact (they'll simply display the new title).</li><li><strong>The title can be left empty.</strong> Notes with no title display a placeholder (<em>type note's title here…</em>) but are otherwise perfectly valid.</li></ul><p>In addition:</p><ul><li>There is no limitation on the length of the title, however in exports the title might get trimmed.</li><li>There are no forbidden symbols, unsupported characters will get trimmed when exporting.</li><li>When exporting to a ZIP file, a meta file will contain the full title which will be recognized by Trilium when importing again.</li></ul><h3>Editing the title</h3><p>To rename a note, simply click into the title field and type. Changes are saved automatically as you type.</p><p>You can also begin editing the title directly from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;by selecting a note and pressing <kbd>Enter</kbd> (see <em>Edit note title</em> in&nbsp;<a class=\"reference-link\" href=\"#root/_help_A9Oc6YKKc65v\">Keyboard Shortcuts</a>), which focuses the title field for the active note.</p><aside class=\"admonition note\"><p>Titles may contain any characters, including Unicode and emoji. For security, any HTML in the title is stripped automatically, so the title is always treated as plain text.</p></aside><h3>Easily navigating between the title and the content</h3><p>When the cursor is in the title field, pressing <kbd>Enter</kbd> moves focus into the note's content. For&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes this also inserts a fresh empty paragraph at the very top of the document, so you can start writing immediately — much like other note-taking apps.</p><p>This makes it possible to create a note, type its title, press <kbd>Enter</kbd>, and continue straight into the body without reaching for the mouse.</p><h3>Working with new notes</h3><p>When you create a new note it's given a default title (<em>new note</em>) which is pre-selected, so you can type a name right away to replace it. The default title for new notes can be customized per-section — see&nbsp;<a class=\"reference-link\" href=\"#root/_help_47ZrP6FNuoG8\">Default Note Title</a>.</p><p>If you decide you don't want the note after all, pressing <kbd>Escape</kbd> while the title of a freshly created note is still focused will discard it.</p><h3>Automatically generated titles</h3><p>Some notes get their titles assigned automatically rather than typed:</p><ul><li><strong>Day, week, month and year notes</strong> in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a>&nbsp;are named from a configurable date pattern.</li><li><a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a>&nbsp;notes are named after the search they perform.</li><li>When a note is duplicated, a suffix is appended to the copy's title to tell it apart from the original.</li></ul><h3>Protected notes</h3><p>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_bwg0e8ewQMak\">Protected Notes</a>, the title is <em>not</em> encrypted — only the content is. The title therefore remains visible in the tree and tabs even when no protected session is active. While locked, however, the title field is read-only and cannot be edited until you enter your password.</p><h2>Protected notes</h2><p>The titles of&nbsp;<a class=\"reference-link\" href=\"#root/_help_bwg0e8ewQMak\">Protected Notes</a>&nbsp;are encrypted along with their content. Before entering your password, Trilium cannot decrypt the title, so it is shown as <code spellcheck=\"false\">[protected]</code> in instead and the title cannot be modified.</p><p>Once you enter your password and a protected session is active, the real title is decrypted and displayed, and becomes editable again.</p>",
- "_help_p9kXRFAkwN4o": "<h2>Icons</h2><figure class=\"image image-style-align-right image_resized\" style=\"width:48.4%;\"><img style=\"aspect-ratio:1089/995;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/Note%20Icons%20%26%20Colors_image.png\" width=\"1089\" height=\"995\"></figure><p>Icons are useful for distinguishing notes and are displayed near the note title, as well as in various places such as the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>,&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;or the&nbsp;<a class=\"reference-link\" href=\"#root/_help_F1r9QtzQLZqm\">Jump to &amp; command palette</a>.</p><p>While editing a note, click on the icon next to the title to bring up a chooser gallery.</p><p>Icons can be inherited through the use of&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>, or&nbsp;<a class=\"reference-link\" href=\"#root/_help_bwZpz2ajCEwO\">Attribute Inheritance</a>.</p><aside class=\"admonition note\"><p>At the technical level, they are set by the <code spellcheck=\"false\">iconClass</code> attribute which adds a CSS class to the note. For example <code spellcheck=\"false\">#iconClass=\"bx bx-calendar\"</code> will show a calendar instead of the default page or folder icon. Looking up and remembering the CSS class names is not necessary.</p></aside><h2>Colors</h2><p>Notes can also carry a custom color. Similar to the note icon, this color will be shown in various places such as the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>.</p><p>To set a custom color, right click on the note in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and select a predefined color from there or use the color picker (last option).</p><p>Alternatively, a custom color can be set manually through the <code spellcheck=\"false\">#color</code> <a href=\"#root/_help_HI6GBBIduIgv\">label</a>, whose value must be a valid hex color including the leading <code spellcheck=\"false\">#</code> (e.g. <code spellcheck=\"false\">#ff0000</code> for red). This color can be carried over across multiple notes via&nbsp;<a class=\"reference-link\" href=\"#root/_help_bwZpz2ajCEwO\">Attribute Inheritance</a>.</p>",
- "_help_0vhv7lsOLy82": "<p>A <a href=\"#root/_help_BFs8mudNFgCS\">note</a> in Trilium can <em>own</em> one or more attachments, which can be either images or files. These attachments can be displayed or linked within the note that owns them.</p><p>This can be especially useful to include dependencies for your <a href=\"#root/_help_CdNpE2pqjmI6\">scripts</a>. The&nbsp;<a class=\"reference-link\" href=\"#root/_help_R7abl2fc6Mxi\">Weight Tracker</a>&nbsp;shows how to use <a href=\"https://chartjs.org/\">chartjs</a> which is attached to the script note.</p><p>Each note exclusively owns its attachments, meaning attachments cannot be shared or linked from one note to another. If an attachment link is copied to a different note, the attachment itself is duplicated, and the copies are managed independently thereafter.</p><p>Attachments, especially image files, are the recommended method for embedding visuals in notes. It is important to link image attachments within the text of the owning note; otherwise, they will be automatically deleted after a configurable timeout period if not referenced.</p><h2>Types of attachments</h2><p>There are two different types of attachment:</p><ul><li><em>User content</em>, representing files or images that are uploaded and part of the content of the note.</li><li><em>System attachments</em> which are used internally by Trilium and can be of multiple types, including:<ul><li><a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>&nbsp;to store information about views such as the column information for the&nbsp;<a class=\"reference-link\" href=\"#root/_help_CtBQqbwXDx1w\">Kanban Board</a>.</li><li>Icons and cover images for&nbsp;<a class=\"reference-link\" href=\"#root/_help_UmgZAfcltxkS\">Link Previews</a>.</li><li>Debug information for some importers such as&nbsp;<a class=\"reference-link\" href=\"#root/_help_GnhlmrATVqcH\">Microsoft OneNote</a>&nbsp;(only if the debug flag was enabled at import time).</li></ul></li></ul><p>The system attachments are displayed at the end of the attachments list, in a dedicated section (<em>Generated by Trilium</em>).</p><h2>Converting notes to attachments</h2><p><a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a>&nbsp;notes can be easily converted to attachments of the parent note.</p><p>To do so:</p><ul><li>For a single note, press the context menu from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note buttons</a>&nbsp;and select <em>Convert into attachment</em>.</li><li>For multiple notes, select the given notes in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, right click → Advanced → Convert to attachment.</li></ul><h2>Attachment previews</h2><p>Attachments share the same content preview for images, videos, PDFs, etc. as the&nbsp;<a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a>&nbsp;note type.</p>",
- "_help_IakOLONlIfGI": "<h2>Motivation</h2><p>Trilium's core feature is the ability to structure your notes into hierarchical tree-like structure.</p><p>It is expected then that you'll have an elaborate and deep note hierarchy - each subtree will represent a more refined and specialized view of your knowledge base.</p><p>This is a pretty powerful approach, but it also carries a hidden assumption that each \"subtopic\" is \"owned\" by one parent. I'll illustrate this with an example - let's say my basic structure is this:</p><ul><li>Technology<ul><li>Programming<ul><li>Kotlin</li><li>JavaScript</li></ul></li><li>Operating systems<ul><li>Linux</li><li>Windows</li></ul></li></ul></li></ul><p>Now, I'm starting to learn about <a href=\"https://en.wikipedia.org/wiki/Bash_(Unix_shell)\">Bash</a> and would like to create notes related to this topic. But now I'm facing a problem of where to categorize this. The issue here is that Bash is both a programming language and a tool (shell) very much tied into Linux. It seems it belongs to both of these, I can't (and don't want to) choose one over the other.</p><h2>Solution</h2><p>The solution to the problem shown above is to allow notes to have multiple parents.</p><p>I call these \"clones\", but that is a bit misleading - there's no original and cloned note - the notes in both of the parents categories are identical.</p><p>Another misleading thing about \"cloning\" is that it suggests that a copy of the note has been made. That's not really true, the note itself stays in just one original, it is just referenced in multiple places in the tree hierarchy. So changing it in one category changes it in all the others, because they're all the same note.</p><p>Here's the final structure with cloning:</p><ul><li>Technology<ul><li>Programming<ul><li>Kotlin</li><li>JavaScript</li><li>Bash<ul><li>some sub-notes ...</li></ul></li></ul></li><li>Operating systems<ul><li>Linux<ul><li>Bash<ul><li>some sub-notes ...</li></ul></li></ul></li><li>Windows</li></ul></li></ul></li></ul><p>So now the \"Bash\" subtree appears on multiple locations in the hierarchy. Both the Bash subtrees are the same and contain the same sub-categories and notes.</p><h3>Demo</h3><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/Cloning%20Notes_create-clone.gif\"></p><p>In the demo, you can see how a clone can be created using the context menu. It's possible to do this also using the Add Link dialog or with <kbd>Ctrl</kbd>+<kbd>C</kbd> and <kbd>Ctrl</kbd>+<kbd>V</kbd> <a href=\"#root/_help_A9Oc6YKKc65v\">keyboard shortcuts</a>.</p><p>You can view the list of all available clones:</p><ul><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_KRlZFoIH0j6p\">Connections tab</a>&nbsp;for the&nbsp;<a class=\"reference-link\" href=\"#root/_help_IjZS7iK5EXtb\">New Layout</a>.</li><li>For the old layout, in the \"Note Paths\" tab in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_BlN9DFI679QC\">Ribbon</a>.</li></ul><p>Titles of cloned notes in the tree view have an asterisk to the right to easily see that the note is also placed into some other location.</p><h2>Deleting notes/clones</h2><p>With clones, it might not be immediately obvious how deleting works.</p><p>If you try to delete a note, it works like this:</p><ol><li>if the note has multiple clones, delete just this clone and leave the actual note (and its other clones) as it is.</li><li>if this note doesn't have any other clones, delete the note<ul><li>Run the whole process starting with 1. on all note's children notes</li></ul></li></ol>",
++ "_help_lgKX7r3aL30x": "<figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:505/261;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tooltip_image.png\" width=\"505\" height=\"261\"></figure><p>The note tooltip is a convenience feature which displays a popup when hovering over an <a href=\"#root/_help_hrZ1D00cLbal\">internal link</a> to another note.</p><p>The following information is displayed:</p><ul><li>The note path, at the top of the popup.</li><li>The title of the note.<ul><li>Clicking on the title will open the note in the current tab.</li><li>Holding <kbd>Ctrl</kbd> pressed while clicking the title will open in a new tab instead of the current one.</li></ul></li><li>A snippet of the content will be displayed as well.</li><li>A button to <a href=\"#root/_help_ZjLYv08Rp3qC\">quickly edit</a> the note in a popup.</li></ul><p>For a link to an <a href=\"#root/_help_0vhv7lsOLy82\">attachment</a>, the tooltip shows the attachment instead: its title after the path of the note that owns it, a line giving its size (for example <em>Attachment • 20.59 MiB</em>), a preview of its content where one is available, and the quick edit button opening the attachment.</p><p>The tooltip can be found in multiple places, including:</p><ul><li>In&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes, when hovering over&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;.</li><li><a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>: <ul><li><a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map View</a>, when hovering over a marker.</li><li><a class=\"reference-link\" href=\"#root/_help_xWbu3jpNWapp\">Calendar View</a>, when hovering over an event.</li><li><a class=\"reference-link\" href=\"#root/_help_2FvYrpmOXm29\">Table View</a>, when hovering over a note title, or over a <a href=\"#root/_help_Cq5X6iKQop6R\">relation</a>.</li></ul></li></ul>",
++ "_help_SL5f1Auq7sVN": "<p>Split view is a feature of&nbsp;<a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_6RM1Q7ppFVoj\">Markdown</a>&nbsp;notes which displays both the source code on one side and the preview of the content on the other.</p><p><a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a>&nbsp;also allow changing between a horizontal or a vertical split, to accommodate for the various sizes of diagrams.</p><h2>Display modes and interaction</h2><p>The split comes with three different display modes which can be toggled from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_1P8QXI5edXNd\">Note buttons</a>&nbsp;area:</p><ul><li><span class=\"tn-icon bx bxs-dock-left\"></span>&nbsp;<em>(Split view)</em>, in which both the source code is available on one side and can be edited, and the preview is available on the other side.<ul><li>In this mode, the size of either the source pane or the preview pane can be adjusted by dragging the small border between them.</li></ul></li><li><span class=\"tn-icon bx bx-code\"></span>&nbsp;(<em>Source view)</em> which shows the source code on the entire screen for a more focused editing experience.</li><li><span class=\"tn-icon bx bx-show\"></span>&nbsp;<em>(Preview)</em> which displays only the rendering of the diagram or text in full screen, especially useful for read-only notes.</li></ul><p>The display node is stored at note level.</p><h2>Relation to read-only notes</h2><p>If a note is marked as <a href=\"#root/_help_CoFPLs3dRlXc\">read-only</a>, the source view will not be editable. While in preview mode, marking a note as read-only has no effect since the preview itself is not editable.</p>",
++ "_help_t596jLvPrqkS": "<p>Some note types (such as&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;and saved search) intentionally limit the width of the content.</p><p>This might appear surprising at first, but the idea is to make text fit well on wider screens without appearing distorted. This is especially the case if the document contains&nbsp;<a class=\"reference-link\" href=\"#root/_help_mT0HEkOsz6i1\">Images</a>, tables or other width-dependent elements.</p><h2>Configuring the content width and alignment</h2><p>The content width is expressed in pixels and can be changed from&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Appearance</em> → <em>Content Width</em> and adjusting the <em>Max content width</em> section.</p><p>To effectively disable the content width limitation, simply set the width to a value larger than your screen size (e.g. 9999).</p><p>By default, the content is aligned to the left, but it can be centered horizontally by checking <em>Keep content centered</em> from the same section as the content width.</p><h2>Adjusting at note level</h2><p>For notes with large elements such as&nbsp;<a class=\"reference-link\" href=\"#root/_help_NdowYOC1GFKS\">Tables</a>, it sometimes makes sense to avoid the content width without affecting other notes. To do so:</p><ul><li>Go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>&nbsp;and toggle <em>Full width</em>.</li><li>Or manually apply the <code>fullContentWidth</code> <a href=\"#root/_help_HI6GBBIduIgv\">label</a> to the note.</li></ul><p>Since v0.107.0, a single table can also be made wider than the content width, in which case it scrolls sideways. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_NdowYOC1GFKS\">Tables</a>.</p><aside class=\"admonition note\"><p>Some <a href=\"#root/_help_KSZ04uQ2D1St\">note types</a> are full width by default, such as the&nbsp;<a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a>. In that case the <em>Full width</em> toggle will not be displayed and the label will have no effect.</p></aside><h2>Shared notes</h2><p>On a <a href=\"#root/_help_R9pX4DGra2Vt\">shared page</a>, a text note is shown at a fixed reading width, whatever the width configured in Options, and the navigation tree, the content and the table of contents are kept together in a column centered on a wide screen. A note with <code>fullContentWidth</code>, or of a type that is full width in the application, uses the whole width of the window there, with the navigation tree and the table of contents at its edges.</p>",
++ "_help_jcQVxzYybYgz": "<figure class=\"image image-style-align-right image_resized\" style=\"width:44.65%;\"><img style=\"aspect-ratio:514/291;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Note%20contextual%20menu_image.png\" width=\"514\" height=\"291\"></figure><p>Right-clicking the content of some note types such as&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;or&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;reveals a contextual menu.</p><h2>Features</h2><ul><li>On the&nbsp;<a class=\"reference-link\" href=\"#root/_help_poXkQfguuA0U\">Desktop Installation</a>, the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oBo3iHIZnbG2\">Spell Check</a>&nbsp;suggestions are shown when right clicking on a misspelled word.</li><li>The selected text can be searched either with a search engine (configured from&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>) or <a href=\"#root/_help_eIg8jdvaoNNd\">inside Trilium</a>.</li><li>Basic clipboard functionality (cut, copy, paste).</li><li>Copying the selected text as&nbsp;<a class=\"reference-link\" href=\"#root/_help_Oau6X9rCuegd\">Markdown</a>.</li><li>Performing quick operations using the&nbsp;<a class=\"reference-link\" href=\"#root/_help_VRoP0g1uHHc2\">In-editor AI assistant</a>.</li></ul><h2>Differences between desktop and web</h2><p>The <a href=\"#root/_help_WOcw2SLH6tbX\">web version</a> behaves slightly different due to limitations imposed by web browsers:</p><ul><li>When no text is selected or a word is right-clicked, the browser's default contextual menu is displayed.<ul><li>This is intentional since it preserves the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oBo3iHIZnbG2\">Spell Check</a>&nbsp;functionality.</li></ul></li><li>When a text is selected, a reduced menu is displayed instead which features only the functionality that is available within the browser version<ul><li><em>Paste</em> is not available since the browser doesn't expose it, use <kbd>Ctrl</kbd>+<kbd>V</kbd> instead.</li><li>The browser menu can be triggered anyway by pressing <kbd>Shift</kbd> + <kbd>Right click</kbd>.</li></ul></li></ul>",
++ "_help_AlJ73vBCjWDw": "<p>The status bar displays information about the current note and allows changing settings related to it such as configuring the language or attributes.</p><h2>Layout and interaction</h2><p>On the left side, the&nbsp;<a class=\"reference-link\" href=\"#root/_help_I6p2a06hdnL6\">Breadcrumb</a>&nbsp;is displayed which indicates the current note as well as its parent notes and allows for quick navigation throughout the hierarchy.</p><p>On the right side, specific sections will show depending on the type of the current note.</p><ol><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;notes, the language mode of the note is indicated (e.g. JavaScript, plain text), as well as allowing easy switching to another mode.</li><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes, the content language is displayed and can be changed, thus configuring the spell-check and the right-to-left support.<ol><li>Note that this applies to the entire note and not the selection, unlike some text editors.</li></ol></li><li>If a note is placed in multiple places in the tree (cloned), the number of the note paths will be displayed.<ol><li>Clicking it opens a popup with the full list of note paths, from which the note can also be cloned to a new location. The same list is available in the sidebar's&nbsp;<a class=\"reference-link\" href=\"#root/_help_KRlZFoIH0j6p\">Connections tab</a>.</li></ol></li><li>If a note has attachments, their number will be displayed.<ol><li>Clicking on it will reveal the list of attachments in a new tab.</li></ol></li><li>If a note is linked from other text notes (backlinks), the number of backlinks will be displayed.<ol><li>Clicking on it opens a popup with the list of notes that link to this note, as well as an excerpt of where the note is referenced. The same list is available in the sidebar's&nbsp;<a class=\"reference-link\" href=\"#root/_help_KRlZFoIH0j6p\">Connections tab</a>.</li></ol></li></ol><p>Regardless of note type, the following items will always be displayed if there is a note:</p><ol><li>Note info, which displays:<ol><li>The creation/modification date of the note.</li><li>The type and MIME of the note.</li><li>The note ID.</li><li>An estimation of the note size of the note itself and its children.</li><li>A button to reveal the Similar notes in the sidebar's&nbsp;<a class=\"reference-link\" href=\"#root/_help_KRlZFoIH0j6p\">Connections tab</a>.</li></ol></li></ol><aside class=\"admonition note\"><p>When pressing a button which reveals the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>, it has a specific behavior if the sidebar is hidden: the sidebar will be peeked instead of docked. Regardless the sidebar will be switched to the appropriate tab and the corresponding section will be highlighted.</p></aside>",
++ "_help_I6p2a06hdnL6": "<figure class=\"image\"><img style=\"aspect-ratio:1150/27;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/UI%20Elements/Breadcrumb_image.png\" width=\"1150\" height=\"27\"></figure><p>The breadcrumb allows quickly viewing the note hierarchy of the current note and navigating through it.</p><p>It is part of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlJ73vBCjWDw\">Status bar</a>, displayed in the bottom-left of the screen.</p><h2>Layout and Interaction</h2><ul><li>If a note or workspace is hoisted, a badge will appear on the left-most side.<ul><li>Clicking on the badge will un-hoist the note/workspace.</li></ul></li><li>The left-most icon represents the root note, or the hoisted note or workspace.<ul><li>Clicking the icon will jump to the root note.</li><li>Right clicking the icon will display a menu that allows opening the note in a new tab, split, etc.</li></ul></li><li>Each segment shows the title of a note in the current note hierarchy.<ul><li>Clicking the icon will jump to that note.</li><li>Right clicking will open a menu with multiple options such as opening the note in a different tab/split/window, hoisting, moving/cloning the note, duplicating as well as changing the color of the note.</li></ul></li><li>Clicking the arrow next to each segment will reveal the child notes of the segment on the left.<ul><li>Clicking on an icon will navigate to that particular note.</li><li>It's also possible to create a new child note from here.</li><li>The menu can optionally hide the archived notes.</li></ul></li><li>If the current note is deep within a hierarchy, the segments will collapse into a […] button in order not to occupy too much space.<ul><li>Clicking this button will display each collapsed entry as a menu item. Clicking on it will navigate to that particular note.</li></ul></li><li>Right clicking on an empty space to the right of the breadcrumb (before the other status bar items) will reveal another menu that allows:<ul><li>Toggling whether archived notes are displayed in the breadcrumb and in the note tree.</li><li>Copying the current note path to clipboard.</li></ul></li></ul>",
++ "_help_BFs8mudNFgCS": "<p>Note is a central entity in Trilium. Main attributes of note are <a href=\"#root/_help_l7pigIGu01K2\">title</a> and content.</p><h3>Note types</h3><p>The main note type is a rich-text note type called&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>. For diagrams and drawing there is&nbsp;<a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a>.</p><p>There are also more complex note types such as&nbsp;<a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a>,&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>&nbsp;that usually go hand-in-hand with&nbsp;<a class=\"reference-link\" href=\"#root/_help_CdNpE2pqjmI6\">Scripting</a>.</p><p>In Trilium there's no specific \"folder\" note type. Any note can have children and thus be a folder. To make a note that only shows its children, like a folder in other applications, use a <a class=\"reference-link\" href=\"#root/_help_8QqnMzx393bx\">Grid View</a> or <a class=\"reference-link\" href=\"#root/_help_mULW0Q3VojwY\">List View</a> collection. See also <a class=\"reference-link\" href=\"#root/_help_i6dbnitykE5D\">FAQ</a>.</p><h3>Root note</h3><p>There's one special note called \"root note\" which is root of the note tree. All other notes are placed below it in the structure.</p><h3>Tree structure</h3><p>Importantly, note itself doesn't carry information on its placement in note tree. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_IakOLONlIfGI\">Cloning Notes</a>&nbsp;for details.</p><p>Tree structure of notes can resemble file system - but compared to that notes in Trilium can act as both file and directory - meaning that note can both have its own content and have children. \"Leaf note\" is a note which doesn't have any children.</p><h3>Deleting / undeleting notes</h3><p>When you delete a note in Trilium, it is actually only marked for deletion (soft-delete) - the actual content, title, attributes etc. are not deleted, only hidden.</p><p>Within (by default) 7 days, it is possible to undelete these soft-deleted notes - open the&nbsp;<a class=\"reference-link\" href=\"#root/_help_r5JGHN99bVKn\">Recent Changes</a>&nbsp;dialog, and you will see a list of all modified notes including the deleted ones. Notes available for undeletion have a link to do so. This is kind of \"trash can\" functionality known from e.g. Windows.</p><p>Clicking an undelete will recover the note, its content and attributes - note should be just as before being deleted. This action will also undelete note's children which have been deleted in the same action.</p><p>To be able to undelete a note, it is necessary that deleted note's parent must be undeleted (otherwise there's no place where we can undelete it to). This might become a problem when you delete more notes in succession - the solution is then undelete in the reverse order of your deletion.</p><p>After the 7 days (configurable) the notes will be \"erased\" - their title, content, revisions and attributes will be erased, and it will not be possible anymore to recover them (unless you restore a&nbsp;<a class=\"reference-link\" href=\"#root/_help_ODY7qQn5m2FT\">Backup</a>).</p><h2>See also</h2><ul><li><a class=\"reference-link\" href=\"#root/_help_CoFPLs3dRlXc\">Read-Only Notes</a></li></ul>",
++ "_help_l7pigIGu01K2": "<p>Alongside its content, the <strong>title</strong> is one of the two main attributes of a <a href=\"#root/_help_BFs8mudNFgCS\">note</a>. It's the short, human-readable name shown in the editable field at the top of every note, and it's what identifies the note throughout the interface (in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, in tabs, in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_I6p2a06hdnL6\">Breadcrumb</a>&nbsp;and win&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>.</p><p>Internally, notes are identified by a unique&nbsp;<a class=\"reference-link\" href=\"#root/_help_m1lbrzyKDaRB\">Note ID</a>&nbsp;rather than by their title, so the title is purely for your benefit. This has a few consequences:</p><ul><li><strong>Titles don't have to be unique.</strong> You can have any number of notes that share the same title without conflict.</li><li><strong>Renaming a note never breaks links to it.</strong> Links between notes point at the underlying note, so changing a title leaves existing links intact (they'll simply display the new title).</li><li><strong>The title can be left empty.</strong> Notes with no title display a placeholder (<em>type note's title here…</em>) but are otherwise perfectly valid.</li></ul><p>In addition:</p><ul><li>There is no limitation on the length of the title, however in exports the title might get trimmed.</li><li>There are no forbidden symbols, unsupported characters will get trimmed when exporting.</li><li>When exporting to a ZIP file, a meta file will contain the full title which will be recognized by Trilium when importing again.</li></ul><h2>Inline title</h2><p><a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes have a special title bar behavior in which the <a href=\"#root/_help_l7pigIGu01K2\">note title</a> is initially displayed in a larger font, while also displaying additional information such as the creation and the modification date.</p><p>Whenever the title is scrolled past, the fixed title is shown instead.</p><p>Note types that take the entirety of the screen, such as&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a>, will always have only the fixed title bar.</p><p>Under the note title, the&nbsp;<a class=\"reference-link\" href=\"#root/_help_m3VlURMSeOrd\">New note type switcher</a>&nbsp;appears if the note is empty.</p><figure class=\"image\"><img style=\"aspect-ratio:899/122;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/Title_image.png\" width=\"899\" height=\"122\"><figcaption>The <em>Inline title</em>, which is displayed at the top of the note and can be scrolled past.</figcaption></figure><figure class=\"image\"><img style=\"aspect-ratio:910/104;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/1_Title_image.png\" width=\"910\" height=\"104\"><figcaption>The fixed title bar. The title only appears after scrolling past the <em>Inline title</em>.</figcaption></figure><h3>Editing the title</h3><p>To rename a note, simply click into the title field and type. Changes are saved automatically as you type.</p><p>You can also begin editing the title directly from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;by selecting a note and pressing <kbd>Enter</kbd> (see <em>Edit note title</em> in&nbsp;<a class=\"reference-link\" href=\"#root/_help_A9Oc6YKKc65v\">Keyboard Shortcuts</a>), which focuses the title field for the active note.</p><aside class=\"admonition note\"><p>Titles may contain any characters, including Unicode and emoji. For security, any HTML in the title is stripped automatically, so the title is always treated as plain text.</p></aside><h3>Easily navigating between the title and the content</h3><p>When the cursor is in the title field, pressing <kbd>Enter</kbd> moves focus into the note's content. For&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes this also inserts a fresh empty paragraph at the very top of the document, so you can start writing immediately — much like other note-taking apps.</p><p>This makes it possible to create a note, type its title, press <kbd>Enter</kbd>, and continue straight into the body without reaching for the mouse.</p><h3>Working with new notes</h3><p>When you create a new note it's given a default title (<em>new note</em>) which is pre-selected, so you can type a name right away to replace it. The default title for new notes can be customized per-section — see&nbsp;<a class=\"reference-link\" href=\"#root/_help_47ZrP6FNuoG8\">Default Note Title</a>.</p><p>If you decide you don't want the note after all, pressing <kbd>Escape</kbd> while the title of a freshly created note is still focused will discard it.</p><h3>Automatically generated titles</h3><p>Some notes get their titles assigned automatically rather than typed:</p><ul><li><strong>Day, week, month and year notes</strong> in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a>&nbsp;are named from a configurable date pattern.</li><li><a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a>&nbsp;notes are named after the search they perform.</li><li>When a note is duplicated, a suffix is appended to the copy's title to tell it apart from the original.</li></ul><h3>Protected notes</h3><p>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_bwg0e8ewQMak\">Protected Notes</a>, the title is <em>not</em> encrypted — only the content is. The title therefore remains visible in the tree and tabs even when no protected session is active. While locked, however, the title field is read-only and cannot be edited until you enter your password.</p><p>The titles of&nbsp;<a class=\"reference-link\" href=\"#root/_help_bwg0e8ewQMak\">Protected Notes</a>&nbsp;are encrypted along with their content. Before entering your password, Trilium cannot decrypt the title, so it is shown as <code>[protected]</code> in instead and the title cannot be modified.</p><p>Once you enter your password and a protected session is active, the real title is decrypted and displayed, and becomes editable again.</p>",
++ "_help_p9kXRFAkwN4o": "<h2>Icons</h2><figure class=\"image image-style-align-right image_resized\" style=\"width:48.4%;\"><img style=\"aspect-ratio:1089/995;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/Note%20Icons%20%26%20Colors_image.png\" width=\"1089\" height=\"995\"></figure><p>Icons are useful for distinguishing notes and are displayed near the note title, as well as in various places such as the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>,&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;or the&nbsp;<a class=\"reference-link\" href=\"#root/_help_F1r9QtzQLZqm\">Jump to &amp; command palette</a>.</p><p>While editing a note, click on the icon next to the title to bring up a chooser gallery.</p><p>Icons can be inherited through the use of&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>, or&nbsp;<a class=\"reference-link\" href=\"#root/_help_bwZpz2ajCEwO\">Attribute Inheritance</a>.</p><aside class=\"admonition note\"><p>At the technical level, they are set by the <code>iconClass</code> attribute which adds a CSS class to the note. For example <code>#iconClass=\"bx bx-calendar\"</code> will show a calendar instead of the default page or folder icon. Looking up and remembering the CSS class names is not necessary.</p></aside><h2>Colors</h2><p>Notes can also carry a custom color. Similar to the note icon, this color will be shown in various places such as the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>.</p><p>To set a custom color, right click on the note in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and select a predefined color from there or use the color picker (last option).</p><p>Alternatively, a custom color can be set manually through the <code>#color</code> <a href=\"#root/_help_HI6GBBIduIgv\">label</a>, whose value must be a valid hex color including the leading <code>#</code> (e.g. <code>#ff0000</code> for red). This color can be carried over across multiple notes via&nbsp;<a class=\"reference-link\" href=\"#root/_help_bwZpz2ajCEwO\">Attribute Inheritance</a>.</p>",
++ "_help_0vhv7lsOLy82": "<p>A <a href=\"#root/_help_BFs8mudNFgCS\">note</a> in Trilium can <em>own</em> one or more attachments, which can be either images or files. These attachments can be displayed or linked within the note that owns them.</p><p>This can be especially useful to include dependencies for your <a href=\"#root/_help_CdNpE2pqjmI6\">scripts</a>. The&nbsp;<a class=\"reference-link\" href=\"#root/_help_R7abl2fc6Mxi\">Weight Tracker</a>&nbsp;shows how to use <a href=\"https://chartjs.org/\">chartjs</a> which is attached to the script note.</p><p>Each note exclusively owns its attachments, meaning attachments cannot be shared or linked from one note to another. If an attachment link is copied to a different note, the attachment itself is duplicated, and the copies are managed independently thereafter.</p><p>Attachments, especially image files, are the recommended method for embedding visuals in notes. It is important to link image attachments within the text of the owning note; otherwise, they will be automatically deleted after a configurable timeout period if not referenced.</p><h2>Types of attachments</h2><p>There are two different types of attachment:</p><ul><li><em>User content</em>, representing files or images that are uploaded and part of the content of the note.</li><li><em>System attachments</em> which are used internally by Trilium and can be of multiple types, including:<ul><li><a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>&nbsp;to store information about views such as the column information for the&nbsp;<a class=\"reference-link\" href=\"#root/_help_CtBQqbwXDx1w\">Kanban Board</a>.</li><li>Icons and cover images for&nbsp;<a class=\"reference-link\" href=\"#root/_help_UmgZAfcltxkS\">Link Previews</a>.</li><li>Debug information for some importers such as&nbsp;<a class=\"reference-link\" href=\"#root/_help_GnhlmrATVqcH\">Microsoft OneNote</a>&nbsp;(only if the debug flag was enabled at import time).</li></ul></li></ul><p>The system attachments are displayed at the end of the attachments list, in a dedicated section (<em>Generated by Trilium</em>).</p><h2>Attaching files from a text note</h2><p>To attach files to a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;note and embed them in its content, press the <span class=\"tn-icon cke cke-paper-clip\"></span><em>Attach file</em> button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>, next to the <span class=\"tn-icon cke cke-image-upload\"></span>image upload button, and select one or more files (see <em>Embedding an attachment</em> below). The arrow beside the button lists the same action as <em>Attach and embed file</em>, followed by <em>Attach file as a link</em>, which links the files instead. Both actions are also available as <em>Attach file as a link</em> and <em>Attach and embed file</em> in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_ZlN4nump6EbW\">Slash Commands</a>.</p><p>When files are attached as links:</p><ul><li>Each file becomes an attachment of the note, and a link to it is inserted at the cursor. Several files produce several links, separated by a space.</li><li>While a file uploads, its link shows the file name and a toast shows the progress.</li><li>Pictures appear as links rather than images, and are attached exactly as they are, without being compressed. To display a picture in the text, use the image upload button instead (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_mT0HEkOsz6i1\">Images</a>).</li></ul><p>Dragging a file that is not a picture from the file explorer onto the text also attaches it and inserts a link to it.</p><h2>Acting on an attachment link</h2><p>Right-clicking a link to an attachment shows the ways to open it, followed by actions on the attachment: opening it externally, downloading it, uploading a new revision, renaming or deleting it, and converting it into a note.</p><p>Links follow changes to their attachment: renaming it updates the title they show, and deleting it removes them from the text notes open for editing at that moment. Converting it into a note turns its links into links to the new note.</p><h2>Embedding an attachment</h2><p>An attachment can be shown in the text instead of linked, the way&nbsp;<a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>&nbsp;shows a note: a picture is displayed, a PDF, a video or a document is previewed, and a code or text file is shown with syntax highlighting. An embedded code file can also be edited in place (see <em>Editing an include in place</em> in&nbsp;<a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>).</p><ul><li>To attach files and embed them straight away, press the <span class=\"tn-icon cke cke-paper-clip\"></span><em>Attach file</em> button. Each file gets an embed of its own, which shows the file name while the file uploads.</li><li>To embed an attachment that is already linked, right-click a link to it in a text note being edited and select <em>Convert link to an embed</em>, at the end of the menu.</li><li>A drawing canvas, inserted with <span class=\"tn-icon bx bx-pen\"></span><em>Drawing canvas</em> in the <span class=\"tn-icon cke cke-plus\"></span><em>Insert</em> menu, is an embed of a <code>Canvas.excalidraw</code> attachment that can be drawn on in place. An attached Excalidraw file (<code>.excalidraw</code>) is embedded as a drawing canvas too (see <em>Drawing canvases</em> in&nbsp;<a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>).</li><li>An embed gets the box size that suits the attachment, as a new included note does (see <em>Box sizes</em> there). To change its size, select the embed and use the box size menu in its toolbar, or the <em>Size</em> submenu of its <span class=\"tn-icon bx bx-dots-vertical-rounded\"></span><em>More actions</em> menu. A <em>Small</em>, <em>Medium</em> or <em>Expandable</em> embed can also be resized by dragging its handles (see <em>Resizing</em> there).</li><li>An embed can have a caption, as an included note can (see <em>Caption</em> there).</li><li>To show only the attachment, select the embed and press the&nbsp;<span class=\"tn-icon bx bx-window-alt\"></span> (<em>Show title)</em> button in its toolbar, as for an included note (see <em>Title</em> there).</li><li>To open the attachment in a new tab, press the&nbsp;<span class=\"tn-icon bx bx-link-external\"></span> (<em>Open in new tab)</em> button at the end of the embed's title.</li><li>An embed of size <em>Tiny</em> shows only the title of the attachment and its size, in a single row. Its buttons are <span class=\"tn-icon bx bx-file-find\"></span><em>Open externally</em> and <span class=\"tn-icon bx bx-download\"></span><em>Download</em>.</li><li>To show an embed of size <em>Medium</em> or <em>Full</em> on the whole screen, press the&nbsp;<span class=\"tn-icon bx bx-fullscreen\"></span> (<em>Fullscreen)</em> button at the end of its title. To return, press&nbsp;<span class=\"tn-icon bx bx-exit\"></span> (<em>Exit fullscreen)</em> in the top-right corner, or <kbd>Esc</kbd>.</li><li>To turn the embed back into a link, select it and press the <span class=\"tn-icon cke cke-link\"></span><em>Convert to link</em> button in its toolbar. <em>Convert to link</em> also ends the menu that right-clicking the title row of the embed or pressing its <span class=\"tn-icon bx bx-dots-vertical-rounded\"></span><em>More actions</em> button opens.</li></ul><p>An embed follows its attachment like a link does. Converting the attachment into a note turns the embed into an included note. In a <a href=\"#root/_help_R9pX4DGra2Vt\">shared note</a>, an embedded picture is displayed with its caption, a drawing canvas as a picture of the drawing, and any other attachment, or a picture in a <em>Tiny</em> embed, appears as a link to download it.</p><h2>Converting notes to attachments</h2><p><a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a>&nbsp;notes can be easily converted to attachments of the parent note.</p><p>To do so:</p><ul><li>For a single note, press the context menu from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>&nbsp;and select <em>Convert into attachment</em>.</li><li>For multiple notes, select the given notes in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, right click → Advanced → <em>Convert to attachment…</em>.</li></ul><h2>Attachment previews</h2><p>Attachments share the same content preview for images, videos, PDFs, etc. as the&nbsp;<a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a>&nbsp;note type.</p>",
++ "_help_IakOLONlIfGI": "<h2>Motivation</h2><p>Trilium's core feature is the ability to structure your notes into hierarchical tree-like structure.</p><p>It is expected then that you'll have an elaborate and deep note hierarchy - each subtree will represent a more refined and specialized view of your knowledge base.</p><p>This is a pretty powerful approach, but it also carries a hidden assumption that each \"subtopic\" is \"owned\" by one parent. I'll illustrate this with an example - let's say my basic structure is this:</p><ul><li>Technology<ul><li>Programming<ul><li>Kotlin</li><li>JavaScript</li></ul></li><li>Operating systems<ul><li>Linux</li><li>Windows</li></ul></li></ul></li></ul><p>Now, I'm starting to learn about <a href=\"https://en.wikipedia.org/wiki/Bash_(Unix_shell)\">Bash</a> and would like to create notes related to this topic. But now I'm facing a problem of where to categorize this. The issue here is that Bash is both a programming language and a tool (shell) very much tied into Linux. It seems it belongs to both of these, I can't (and don't want to) choose one over the other.</p><h2>Solution</h2><p>The solution to the problem shown above is to allow notes to have multiple parents.</p><p>I call these \"clones\", but that is a bit misleading - there's no original and cloned note - the notes in both of the parents categories are identical.</p><p>Another misleading thing about \"cloning\" is that it suggests that a copy of the note has been made. That's not really true, the note itself stays in just one original, it is just referenced in multiple places in the tree hierarchy. So changing it in one category changes it in all the others, because they're all the same note.</p><p>Here's the final structure with cloning:</p><ul><li>Technology<ul><li>Programming<ul><li>Kotlin</li><li>JavaScript</li><li>Bash<ul><li>some sub-notes ...</li></ul></li></ul></li><li>Operating systems<ul><li>Linux<ul><li>Bash<ul><li>some sub-notes ...</li></ul></li></ul></li><li>Windows</li></ul></li></ul></li></ul><p>So now the \"Bash\" subtree appears on multiple locations in the hierarchy. Both the Bash subtrees are the same and contain the same sub-categories and notes.</p><h3>Demo</h3><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/Cloning%20Notes_create-clone.gif\"></p><p>In the demo, you can see how a clone can be created using the context menu. It's possible to do this also using the Add Link dialog or with <kbd>Ctrl</kbd>+<kbd>C</kbd> and <kbd>Ctrl</kbd>+<kbd>V</kbd> <a href=\"#root/_help_A9Oc6YKKc65v\">keyboard shortcuts</a>.</p><p>You can view the list of all available clones:</p><ul><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlJ73vBCjWDw\">Status bar</a>, by looking for the&nbsp;<span class=\"tn-icon bx bx-directions\"></span> icon.</li><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_KRlZFoIH0j6p\">Connections tab</a>&nbsp;of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>, by looking at the <em>Note paths</em> section.</li></ul><p>Titles of cloned notes in the tree view have an asterisk to the right to easily see that the note is also placed into some other location.</p><h2>Deleting notes/clones</h2><p>With clones, it might not be immediately obvious how deleting works.</p><p>If you try to delete a note, it works like this:</p><ol><li>if the note has multiple clones, delete just this clone and leave the actual note (and its other clones) as it is.</li><li>if this note doesn't have any other clones, delete the note<ul><li>Run the whole process starting with 1. on all note's children notes</li></ul></li></ol>",
+ "_help_TBwsyfadTA18": "<p>Since a single note can appear into multiple places in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;via a process called&nbsp;<a class=\"reference-link\" href=\"#root/_help_IakOLONlIfGI\">Cloning Notes</a>, it's recommended to choose a generalized name that fits into all locations instead of something more specific to avoid confusion.</p><p>In some cases this isn't possible so Trilium provides \"branch prefixes\", which is shown before the note name in the tree and as such provides a specific kind of context.</p><p>The prefix is location-specific, so it's displayed only in the note tree.</p>",
+ "_help_bwg0e8ewQMak": "<p>Trilium is designed to store a wide variety of data, including sensitive information such as personal journals, credentials, or confidential documents. To safeguard this type of content, Trilium offers the option to protect notes, which involves the following measures:</p><ul><li><strong>Encryption:</strong> Protected notes are encrypted using a key derived from your password. This ensures that without the correct password, protected notes remain indecipherable. Even if someone gains access to your Trilium <a href=\"#root/_help_wX4HbRucYSDD\">database</a>, they won't be able to read your encrypted notes.</li><li><strong>Time-limited access:</strong> To access protected notes, you must first enter your password, which decrypts the note for reading and writing. However, after a specified period of inactivity (10 minutes by default), the note is unloaded from memory, requiring you to re-enter your password to access it again.<ul><li>The session timeout is extended automatically while you're interacting with the protected note, so if you're actively editing, the session remains open. However, if you switch to an unprotected note, the session timer starts, and the session expires after 10 minutes of inactivity unless you return to the protected notes.</li></ul></li><li><strong>Protection scope:</strong> Protected notes ensure the confidentiality of their content and partially their integrity. While unauthorized users cannot read or edit protected notes, they can still delete or move them outside of the protected session.</li></ul><h2>Using Protected Notes</h2><p>By default, notes are unprotected. To protect a note, simply click on the shield icon next to the note's title, as shown here:</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/Protected%20Notes_protecting-note.gif\" alt=\"example animation of unlocking protected notes\"></p><h2>What is Encrypted?</h2><p>Trilium encrypts the data within protected notes but not their metadata. Specifically:</p><p><strong>Encrypted:</strong></p><ul><li>Note title</li><li>Note content</li><li>Images</li><li>File attachments</li></ul><p><strong>Not encrypted:</strong></p><ul><li>Note structure (i.e., it remains visible that there are protected notes)</li><li>Metadata, such as the last modified date</li><li><a href=\"#root/_help_zEY4DaJG4YT5\">Attributes</a></li></ul><h2>Encryption Details</h2><p>The following steps outline how encryption and decryption work in Trilium:</p><ol><li>The user enters a password.</li><li>The password is passed through the <a href=\"https://en.wikipedia.org/wiki/Scrypt\">scrypt</a> algorithm along with a \"password verification\" <a href=\"https://en.wikipedia.org/wiki/Salt_(cryptography)\">salt</a> to confirm that the password is correct.</li><li>The password is then processed again through scrypt with an \"encryption\" salt, which generates a hash.<ul><li>Scrypt is used for <a href=\"https://en.wikipedia.org/wiki/Key_stretching\">key stretching</a> to make the password harder to guess.</li></ul></li><li>The generated hash is used to decrypt the actual <em>data encryption key</em>.<ul><li>The data encryption key is encrypted using <a href=\"https://en.wikipedia.org/wiki/Advanced_Encryption_Standard\">AES-128</a> with a random <a href=\"https://en.wikipedia.org/wiki/Initialization_vector\">IV</a>.</li><li>The data encryption key is randomly generated during the <a href=\"#root/_help_wX4HbRucYSDD\">database</a> initialization and remains constant throughout the document’s lifetime. When the password is changed, only this key is re-encrypted.</li></ul></li><li>The data encryption key is then used to decrypt the actual content of the note, including its title and body.<ul><li>The encryption algorithm used is AES-128 with <a href=\"https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation\">CBC mode</a>, where a unique IV is generated for each encryption operation and stored with the cipher text.</li></ul></li></ol><h2>Sharing Protected Notes</h2><p>Protected notes cannot be shared in the same way as regular notes. Their encryption ensures that only authorized users with the correct password can access them.</p>",
- "_help_MKmLg5x6xkor": "<p>Archived notes are notes which have <code spellcheck=\"false\">archived</code> <a href=\"#root/_help_zEY4DaJG4YT5\">attribute</a> - either directly or <a href=\"#root/_help_bwZpz2ajCEwO\">inherited</a>.</p><p>Such notes are then by default not shown in the autocomplete and in the full text <a href=\"#root/_help_eIg8jdvaoNNd\">search</a>.</p><p>This can be useful for notes which are no longer very useful but still valuable enough to keep around without them getting too much in the way.</p><p>You can control whether archived notes are displayed in the note tree with a setting:</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/Archived%20Notes_hide-archived.png\"></p>",
- "_help_vZWERwf8U3nx": "<figure class=\"image\"><img style=\"aspect-ratio:2089/1515;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/2_Note%20Revisions_image.png\" width=\"2089\" height=\"1515\"></figure><p>Trilium supports seamless versioning of notes by storing snapshots (\"revisions\") of notes at regular intervals.</p><h2>Displaying the revisions</h2><ul><li>On the&nbsp;<a class=\"reference-link\" href=\"#root/_help_IjZS7iK5EXtb\">New Layout</a>, press the <a href=\"#root/_help_8YBEPzcpUgxw\">note context menu</a> and select <em>Note revisions…</em></li><li>On the old layout, press directly the <img class=\"image_resized\" style=\"aspect-ratio:27/25;width:2.32%;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/1_Note%20Revisions_image.png\" width=\"27\" height=\"25\"> button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note buttons</a>&nbsp;area.</li></ul><h2>Interaction</h2><aside class=\"admonition note\"><p>This documentation matches the redesign of the note revisions dialog on v0.103.0, older versions have a similar dialog but with some differences.</p></aside><ul><li>The full list of revisions are displayed on the left in reverse chronological order.<ul><li>The revisions are grouped by the date the revision was taken.</li><li>This list does not contain the <em>current state</em> of the note, so it is possible to have notes with no revisions/snapshots saved.</li></ul></li><li>The icon of a revision indicates the <em>source</em> of that revision (e.g. a <img class=\"image_resized\" style=\"aspect-ratio:20/21;width:2.49%;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/Note%20Revisions_image.png\" width=\"20\" height=\"21\"> icon for a manually saved revision).</li><li>Pressing the […] on the top-right of the dialog displays multiple options, including:<ul><li>Saving a new revision now.</li><li>Checking the interval and limit for this note (see below).</li><li>Deleting all the revisions of this note.</li></ul></li><li>For supported notes (text, code), changes are highlighted. This behavior can be toggled via the <em>Highlight changes</em> at the top of the dialog.<ul><li>The highlighted changes are relative to the <strong>current state of the note</strong>, not to the revision prior to this one.</li></ul></li><li>For any given revision, the buttons on the top-right allow operating on it:<ul><li>Deleting the revision.</li><li>Downloading the revision locally.</li><li>Restoring the revision, which replaces the current content of the note with the one from the revision. Another revision is saved containing the current content of the note.</li></ul></li></ul><h2>Named revisions</h2><p>Named revisions are a new feature of Trilium v0.103.0 which allows adding a short description of what the changes in the snapshot contain.</p><p>In the list of note revisions:</p><ul><li>The name of the revision is displayed underneath the time of the revision in the sidebar, as well as at the top of the dialog where it is displayed in full.</li><li>Clicking on the edit button near the name of the revision allows it to be changed.</li></ul><p>To create a named revision, either:</p><ul><li>Go to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note buttons</a>, select <em>Save named revision…</em>, enter the name of revision and confirm.</li><li>Use the corresponding <a href=\"#root/_help_A9Oc6YKKc65v\">keyboard shortcut</a> or the&nbsp;<a class=\"reference-link\" href=\"#root/_help_F1r9QtzQLZqm\">Jump to...</a>&nbsp;command with the same name.</li><li>Save a revision normally, and adjust the name afterwards from the note revision list.</li></ul><h2>When revisions are saved</h2><p>Revisions are saved:</p><ul><li>Automatically at a fixed interval. This behavior can be configured (see below).</li><li>Manually, by:<ul><li>Going to the press the <a href=\"#root/_help_8YBEPzcpUgxw\">note context menu</a> and select <em>Save revision.</em></li><li>Using the <em>Force Save Revision</em> <a href=\"#root/_help_A9Oc6YKKc65v\">keyboard shortcut</a>.</li><li>In the <em>Revisions</em> dialog, pressing the […] button in the top-right and selecting <em>Save a revision now</em>.</li></ul></li></ul><p>Additionally, revisions can also come from somewhere else, and this is indicated via the icon of the revision:</p><ul><li>Generated externally, by&nbsp;<a class=\"reference-link\" href=\"#root/_help_pgxEVkzLl1OP\">ETAPI (REST API)</a>.</li><li>A modification created by&nbsp;<a class=\"reference-link\" href=\"#root/_help_GBBMSlVSOIGP\">AI</a>.</li><li>A revision is restored, causing the existing note content to be saved as a revision to prevent potential data loss.</li></ul><h4>Snapshot interval</h4><p>Time interval of taking note snapshot is configurable in the Options -&gt; Other dialog. This provides a trade-off between more revisions and more data to store.</p><p>To turn off note versioning for a particular note (or sub-tree), add <code spellcheck=\"false\">disableVersioning</code> <a href=\"#root/_help_zEY4DaJG4YT5\">label</a> to the note.</p><h4>Maximum revisions</h4><p>The limit on the number of note snapshots can be configured in the Options -&gt; Other dialog. The note revision snapshot number limit refers to the maximum number of revisions that can be saved for each note. Where -1 means no limit, 0 means delete all revisions. You can set the maximum revisions for a single note through the <code spellcheck=\"false\">versioningLimit=X</code> label.</p><p>The note limit will not take effect immediately; it will only apply when the note is modified.</p><p>You can click the <em>Erase excess revision snapshots now</em> button to apply the changes immediately.</p>",
- "_help_aGlEvb9hyDhS": "<h2>Manual sorting</h2><p>You can sort notes by right-clicking the parent note in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and selecting Advanced -&gt; Sort notes by ... This will sort existing notes, but will not automatically sort future notes added to this parent note.</p><p>The sorting dialog allows:</p><ul><li>Sorting by title, creation or modification date.</li><li>Changing sorting direction can also be adjusted (ascending or descending).</li><li>Ensuring folders are displayed at the top.</li><li>Natural sort, based on the sorting rules of a particular language.</li></ul><h2>Automatic/Permanent Sorting</h2><p>Child notes can be automatically sorted by attaching specific <a href=\"#root/_help_zEY4DaJG4YT5\">labels</a> to the parent note:</p><table>\n <thead>\n <tr>\n <th>Label</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td><code spellcheck=\"false\">#sorted</code></td>\n <td><p>Keeps child notes sorted by title alphabetically.</p><p>When given a value, it will sort by the value of another label instead. If one of the child notes doesn't have the specified label, the title will be used for them instead.</p></td>\n </tr>\n <tr>\n <td><code spellcheck=\"false\">#sortDirection</code></td>\n <td><p>If <code spellcheck=\"false\">sorted</code> is applied, specifies the direction of the sort:</p><ul><li><code spellcheck=\"false\">ASC</code>, ascending (default)</li><li><code spellcheck=\"false\">DESC</code>, descending</li></ul></td>\n </tr>\n <tr>\n <td><code spellcheck=\"false\">#sortFoldersFirst</code></td>\n <td>If <code spellcheck=\"false\">sorted</code> is applied, folders (notes with children) will be sorted as a group at the top, and the rest will be sorted.</td>\n </tr>\n <tr>\n <td><code spellcheck=\"false\">#sortNatural</code></td>\n <td>Sort numbers naturally instead of alphabetically, so 2 comes before 10.</td>\n </tr>\n <tr>\n <td><code spellcheck=\"false\">#sortLocale</code></td>\n <td>The language code driving the natural sort (e.g. <code spellcheck=\"false\">zh-CN</code>, <code spellcheck=\"false\">de</code>). Only meaningful together with <code spellcheck=\"false\">#sortNatural</code>.</td>\n </tr>\n <tr>\n <td><code spellcheck=\"false\">#top</code></td>\n <td>If <code spellcheck=\"false\">sorted</code> is applied to the parent note, keeps given note on top in its parent.</td>\n </tr>\n <tr>\n <td><code spellcheck=\"false\">#bottom</code></td>\n <td>If <code spellcheck=\"false\">sorted</code> is applied to the parent note, keeps given note on bottom in its parent.</td>\n </tr>\n </tbody>\n</table><p>Sorting is done by comparing note properties or specific labels on child notes. There are four sorting levels, with the first having the highest priority. Lower priority levels are applied only if higher priority comparisons result in equality.</p><ol><li><strong>Top Label Sorting</strong>: Child notes with the <code spellcheck=\"false\">#top</code> label will appear at the top of the folder.</li><li><strong>Bottom Label Sorting</strong>: (Introduced in Trilium 0.62) Child notes with the <code spellcheck=\"false\">#bottom</code> label will appear at the bottom of the folder.</li><li><strong>Property/Label-Based Sorting</strong>: Sorting is based on the parent note's <code spellcheck=\"false\">#sorted</code> label:<ul><li><strong>Default Sorting</strong>: If <code spellcheck=\"false\">#sorted</code> has no value, notes are sorted alphabetically.</li><li><strong>Property Sorting</strong>: If <code spellcheck=\"false\">#sorted</code> is set to <code spellcheck=\"false\">title</code>, <code spellcheck=\"false\">dateModified</code>, or <code spellcheck=\"false\">dateCreated</code>, notes are sorted based on the specified property.</li><li><strong>Label Sorting</strong>: If <code spellcheck=\"false\">#sorted</code> has any other value, this value is treated as the name of a child note's label, and sorting is based on the values of this label. For example, setting <code spellcheck=\"false\">#sorted=myOrder</code> on the parent note and using <code spellcheck=\"false\">#myOrder=001</code>, <code spellcheck=\"false\">#myOrder=002</code>, etc., on child notes.</li></ul></li><li><strong>Alphabetical Sorting</strong>: Used as a last resort when other criteria result in equality.</li></ol><p>All comparisons are made string-wise (e.g., \"1\" &lt; \"2\" or \"2020-10-10\" &lt; \"2021-01-15\", but also \"2\" &gt; \"10\").</p>",
- "_help_NRnIZmSMc5sj": "<figure class=\"image\"><img style=\"aspect-ratio:2023/1488;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/1_Printing%20%26%20Exporting%20as%20PDF_image.png\" width=\"2023\" height=\"1488\"><figcaption>Screenshot of the Print preview functionality introduced in v0.103.0.</figcaption></figure><p>Trilium allows printing notes to a real printer, or generating a structured PDF for a single note or for multiple notes through&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>.</p><p>Note that not all note types are printable as of now. We do plan to increase the coverage of supported note types in the future.</p><p>Printing and exporting as PDF are not perfect. Due to technical limitations, and sometimes even browser or Electron glitches the text might appear cut off in some circumstances.&nbsp;</p><h2>Printing a note or exporting as PDF on the desktop</h2><aside class=\"admonition note\"><p>Versions prior to v0.103.0 had two different options, one for printing and another one for exporting to PDF. With the introduction of the print preview, these functions have been unified.</p></aside><p>On the desktop application of Trilium it is possible to export a note as PDF. To print a note:</p><ul><li>Press the menu button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note buttons</a>&nbsp;area and select <em>Print note</em>.</li><li>Alternatively, printing can be triggered from a <a href=\"#root/_help_A9Oc6YKKc65v\">keyboard shortcut</a> (unassigned by default) or through the <a href=\"#root/_help_F1r9QtzQLZqm\">command palette</a>.</li></ul><p>This will trigger the print preview screen next.</p><h3>Print preview &amp; print options</h3><p>The print preview dialog allows the following printing options to be adjusted:</p><ul><li><p>The printer to use</p><ul><li><em>Save as PDF</em> generates a PDF that is structured (maintains a table of contents, keeps the text selectable). Prefer this over other virtual PDF printers that ship with the operating system.</li></ul></li><li><p>Page orientation: <em>Portrait</em> (default) or <em>Landscape</em>.</p></li><li><p>Page size</p></li><li><p>Scale the entire content from 10% to 200% to improve the fit within the page.</p></li><li><p>Margins, which can be removed completely or adjusted individually for all the four edges.</p></li><li><p>Print only a subset of pages. Individual page numbers are separated by colons and hyphen-based ranges are supported (e.g. 3-5 for pages 3 to 5).</p></li></ul><p>Additional interaction:</p><ul><li><em>Print using system dialog</em> allows setting more options that are otherwise not available in Trilium.</li></ul><aside class=\"admonition note\"><p>Most of the options here (expect printer &amp; which pages to print) are managed at note level through&nbsp;<a class=\"reference-link\" href=\"#root/_help_zEY4DaJG4YT5\">Attributes</a>&nbsp;(such as <code spellcheck=\"false\">#printLandscape</code>, <code spellcheck=\"false\">#printPageSize</code>, <code spellcheck=\"false\">#printScale</code>, <code spellcheck=\"false\">#printMargins</code>).</p><p>This means that the print settings will be restored when printing the same note. There are no default settings that can be configured for all the notes, but this can be achieved via <a href=\"#root/_help_bwZpz2ajCEwO\">inheritable attributes</a>.</p></aside><h2>Printing on the browser</h2><p>This feature allows printing of notes. It works on both the desktop client, but also on the web.</p><p>To print a note, select the <img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/Printing%20%26%20Exporting%20as%20PDF_image.png\" width=\"29\" height=\"31\"> button to the right of the note and select <em>Print note</em>. Depending on the size and type of the note, this can take up to a few seconds. Afterwards you will be redirected to the system/browser printing dialog.</p><p>On the server or PWA (mobile), the option is not available due to technical constraints and it will be hidden.</p><h2>Reporting issues with the rendering</h2><p>Should you encounter any visual issues in the resulting PDF file (e.g. a table does not fit properly, there is cut off text, etc.) feel free to <a href=\"#root/_help_wy8So3yZZlH9\">report the issue</a>. In this case, it's best to offer a sample note (click on the <img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/Printing%20%26%20Exporting%20as%20PDF_image.png\" width=\"29\" height=\"31\"> button, select Export note → This note and all of its descendants → HTML in ZIP archive). Make sure not to accidentally leak any personal information.</p><p>Consider adjusting font sizes and using <a href=\"#root/_help_CohkqWQC1iBv\">page breaks</a> to work around the layout.</p><aside class=\"admonition tip\"><p>Although direct export as PDF is not available in the browser version of the application, it's still possible to generate a PDF by selecting the <em>Print</em> option instead and selecting “Save to PDF” as the printer (depending on the browser). Generally, Mozilla Firefox has better printing capabilities.</p></aside><h3>Automatic opening of the file</h3><p>When the PDF is exported, it is automatically opened with the system default application for easy preview.</p><p>Note that if you are using Linux with the GNOME desktop environment, sometimes the default application might seem incorrect (such as opening in GIMP). This is because it uses Gnome's “Recommended applications” list.</p><p>To solve this, you can change the recommended application for PDFs via this command line. First, list the available applications via <code spellcheck=\"false\">gio mime application/pdf</code> and then set the desired one. For example to use GNOME's Evince:</p><pre><code class=\"language-text-x-trilium-auto\">gio mime application/pdf</code></pre><h2>Printing multiple notes</h2><p>Since v0.100.0, it is possible to print more than one note at the time by using&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>:</p><ol><li>First create a collection.</li><li>Configure it to use&nbsp;<a class=\"reference-link\" href=\"#root/_help_mULW0Q3VojwY\">List View</a>.</li><li>Print the collection note normally.</li></ol><p>The resulting collection will contain all the children of the collection, while maintaining the hierarchy.</p><aside class=\"admonition note\"><p>Not all note types are supported when printing or exporting to PDF. When an unsupported note is encountered, it is skipped. At the end, if any of the notes were skipped, a message will be displayed with the possibility of viewing the full list of skipped notes. The same limitations as the ones described in <em>Constraints &amp; limitations</em> apply.</p></aside><h2>Keyboard shortcut</h2><p>It's possible to trigger both printing and export as PDF from the keyboard by going to&nbsp;<em>Keyboard shortcuts</em>&nbsp;in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;and assigning a key combination for:</p><ul><li><em>Print Active Note</em></li><li><em>Export Active Note as PDF</em></li></ul><h2>Constraints &amp; limitations</h2><p>Not all&nbsp;<a class=\"reference-link\" href=\"#root/_help_KSZ04uQ2D1St\">Note Types</a>&nbsp;are supported when printing, in which case the <em>Print</em> and <em>Export as PDF</em> options will be disabled.</p><ul><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;notes:<ul><li>Line numbers are not printed.</li><li>Syntax highlighting is enabled, however a default theme (Visual Studio) is enforced.</li></ul></li><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>, the following are supported:<ul><li><a class=\"reference-link\" href=\"#root/_help_mULW0Q3VojwY\">List View</a>, allowing to print multiple notes at once while preserving hierarchy (similar to a book).</li><li><a class=\"reference-link\" href=\"#root/_help_zP3PMqaG71Ct\">Presentation</a>, where each slide/sub-note is displayed.<ul><li>Most note types are supported, especially the ones that have an image representation such as&nbsp;<a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a>.</li></ul></li><li><a class=\"reference-link\" href=\"#root/_help_2FvYrpmOXm29\">Table</a>, where the table is rendered in a print-friendly way.<ul><li>Tables that are too complex (especially if they have multiple columns) might not fit properly, however tables with a large number of rows are supported thanks to pagination.</li><li>Consider printing in landscape mode, or using <code spellcheck=\"false\">#printLandscape</code> if exporting to PDF.</li></ul></li><li>The rest of the collections are not supported, but we plan to add support for all the collection types at some point.</li></ul></li><li>Using&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlhDUqhENtH7\">Custom app-wide CSS</a>&nbsp;for printing is no longer supported, instead a custom <code spellcheck=\"false\">printCss</code> relation needs to be used (see below).</li></ul><h2>Customizing the print CSS</h2><p>As an advanced use case, it's possible to customize the CSS used for printing such as adjusting the fonts, sizes or margins. Note that&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlhDUqhENtH7\">Custom app-wide CSS</a>&nbsp;will not work for printing.</p><p>To do so:</p><ul><li>Create a CSS <a href=\"#root/_help_6f9hih2hXXZk\">code note</a>.</li><li>On the note being printed, apply the <code spellcheck=\"false\">~printCss</code> relation to point to the newly created CSS code note.</li><li>To apply the CSS to multiple notes, consider using <a href=\"#root/_help_bwZpz2ajCEwO\">inheritable attributes</a> or&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>.</li></ul><p>For example, to change the font of the document from the one defined by the theme or the user to a serif one:</p><pre><code class=\"language-text-x-trilium-auto\">body {\n\t--print-font-family: serif;\n --print-font-size: 11pt;\n}</code></pre><aside class=\"admonition important\"><p>When altering <code spellcheck=\"false\">--print-font-family</code>, make sure the change is done at <code spellcheck=\"false\">body</code> level and not <code spellcheck=\"false\">:root</code>, since otherwise it won't be picked up due to specificity rules.</p></aside><p>To remark:</p><ul><li>Multiple CSS notes can be add by using multiple <code spellcheck=\"false\">~printCss</code> relations.</li><li>If the note pointing to the <code spellcheck=\"false\">printCss</code> doesn't have the right note type or mime type, it will be ignored.</li><li>If migrating from a previous version where&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlhDUqhENtH7\">Custom app-wide CSS</a>, there's no need for <code spellcheck=\"false\">@media print {</code>  since the style-sheet is used only for printing.</li></ul><h2>Under the hood</h2><p>Both printing and exporting as PDF use the same mechanism: a note is rendered individually in a separate webpage that is then sent to the browser or the Electron application either for printing or exporting as PDF.</p><p>The webpage that renders a single note can actually be accessed in a web browser. For example <code spellcheck=\"false\">http://localhost:8080/#root/WWRGzqHUfRln/RRZsE9Al8AIZ?ntxId=0o4fzk</code> becomes <code spellcheck=\"false\">http://localhost:8080/?print#root/WWRGzqHUfRln/RRZsE9Al8AIZ</code>.</p><p>Accessing the print note in a web browser allows for easy debugging to understand why a particular note doesn't render well. The mechanism for rendering is similar to the one used in&nbsp;<a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a>.</p><ol><li><sup><strong><a href=\"#fnrefsr779u3zm6\">^</a></strong></sup></li></ol>",
- "_help_CoFPLs3dRlXc": "<p>Some note types such as&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;notes in Trilium can be set to read-only. When a note is in read-only mode, it is presented to the user in a non-editable view, with the option to switch to editing mode if needed.</p><h2>Automatic read-only mode</h2><p>For optimization purposes, Trilium will automatically set very large notes to read-only. Displaying such lengthy notes in editing mode can slow down performance, especially when editing is unnecessary.</p><p>This behavior can be disabled on a per-note basis, by following the instructions of the next section.</p><p>In addition, it's possible to change the number of characters at which the automatic read-only mode will trigger in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;by going to the options for&nbsp;<a class=\"reference-link\" href=\"#root/_hidden/_options/_optionsTextNotes\">Text Notes</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_hidden/_options/_optionsCodeNotes\">Code Notes</a>.</p><h2>Changing a note's read-only behavior</h2><p>Via the&nbsp;<a class=\"reference-link\" href=\"#root/_help_BlN9DFI679QC\">Ribbon</a>, by going to the <em>Basic Properties</em> tab and looking for the <em>Editable</em> selection. The following options are possible:</p><ul><li><strong>Auto</strong><br>This is the default behavior in which the note will be editable by default, unless it becomes large enough to trigger read-only mode.</li><li><strong>Read-only</strong><br>The note will be always marked as read-only, regardless of its size. Nevertheless, it's still possible to temporarily edit the note if needed. This is generally useful for notes that are not prone to change.</li><li><strong>Always Editable</strong><br>This option will bypass the automatic read-only activation for this particular note. It's useful for large notes that are frequently edited.</li></ul><p>If the <em>Editable</em> section is missing from the ribbon, then the note type does not support read-only mode.</p><h3>Manually setting the options</h3><p>Apart from using the ribbon as previously mentioned, it's also possible to use <a href=\"#root/_help_zEY4DaJG4YT5\">labels</a> to change the behavior:</p><ul><li>To set as read-only, apply the <code spellcheck=\"false\">readOnly</code> label to the note.</li><li>To disable automatic read-only (always editable), apply the <code spellcheck=\"false\">autoReadOnlyDisabled</code> label.</li></ul><h2>Temporarily editing a read-only note</h2><p>When accessing a read-only note, it's possible to temporarily edit it by using the <img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/Read-Only%20Notes_image.png\"> button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_XpOYSgsLkTJy\">Floating buttons</a>&nbsp;area.</p><p>When pressed, the note will become editable but will become read-only again after navigating to a different note.</p><h2>Special read-only behavior</h2><p>Some note types have a special behavior based on whether the read-only mode is enabled:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a>&nbsp;will hide the Mermaid source code and display the diagram preview in full-size. In this case, the read-only mode can be easily toggled on or off via a dedicated button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_XpOYSgsLkTJy\">Floating buttons</a>&nbsp;area.</li><li><a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map</a>&nbsp;will disallow all interaction that would otherwise change the map (dragging notes, adding new items).</li></ul>",
- "_help_0ESUbbAxVnoK": "<figure class=\"image\"><img style=\"aspect-ratio:990/590;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/Note%20List_image.png\" width=\"990\" height=\"590\"></figure><p>When a note has one or more child notes, they will be listed at the end of the note for easy navigation.</p><h2>Configuration</h2><ul><li>To hide the note list for a particular note, simply apply the <code spellcheck=\"false\">hideChildrenOverview</code> <a href=\"#root/_help_zEY4DaJG4YT5\">label</a>.</li><li>For some view types, such as Grid view, only a subset of notes will be displayed and pagination can be used to navigate through all of them for performance reasons. To adjust the number of notes per page, set <code spellcheck=\"false\">pageSize</code> to the desired number.</li></ul><h2>View types</h2><p>The view types dictate how the child notes are represented. By default, the notes will be displayed in a grid, however there are also some other view types available.</p><p>Generally the view type can only be changed in a&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>&nbsp;note from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_BlN9DFI679QC\">Ribbon</a>, but it can also be changed manually on any type of note using the <code spellcheck=\"false\">#viewType</code> attribute.</p>",
- "_help_S0Fos78ZfcY7": "<p>The inbox is the default destination for quickly captured notes. When a note is created without picking a location first, it lands in the inbox. This makes it easy to quickly capture notes and sort them later.</p><h2>Where the inbox is used</h2><ul><li>The <em>New note</em> button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</li><li>The global <em>Create note into inbox</em> shortcut (default <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>P</kbd>).</li><li>The <em>New note</em> action in the <a href=\"#root/_help_7iwde4lsKc6O\">tray icon menu</a>.</li><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_MtPxeAWVAzMg\">Web Clipper</a>&nbsp;extension.</li></ul><h2>Setting a note inbox</h2><p>To create a note inbox, apply the <code spellcheck=\"false\">#inbox</code> <a href=\"#root/_help_HI6GBBIduIgv\">label</a> to it.</p><p>Only one note should carry this label. If there are multiple notes, only one will be used by the application.</p><aside class=\"admonition note\"><p>If there is no inbox note, Trilium will fall back to today's <a href=\"#root/_help_l0tKav7yLHGF\">day note</a> instead.</p></aside><h2>Workspace inboxes</h2><p>Each <a href=\"#root/_help_9sRHySam5fXb\">workspace</a> can have its own inbox, set via the <code spellcheck=\"false\">#workspaceInbox</code> label.</p><p>When a new note is created while hoisted in a workspace, the location is determined in the following order:</p><ul><li>A note carrying the <code spellcheck=\"false\">#workspaceInbox</code> label in that workspace.</li><li>A note carrying the <code spellcheck=\"false\">#inbox</code> within that workspace.</li><li>The workspace root note itself.</li></ul>",
- "_help_5Ct4MAJTS4tQ": "<p>Deleted notes are listed in the \"Deleted Notes\" dialog (<strong>Global Menu → Show Deleted Notes</strong>) and can be restored by pressing the \"<strong>undelete</strong>\" link.</p><p>If a note has child notes, they will be restored along with it. Should the original location no longer exist (e.g. the parent has been deleted), the note will be restored into the default location for new notes (<a class=\"reference-link\" href=\"#root/_help_S0Fos78ZfcY7\">Note Inbox</a>).</p><aside class=\"admonition note\"><p>When a note is hoisted in the tree, the dialog will only display notes deleted from the subtree of that hoisted note.</p></aside><p>To permanently erase deleted notes and clear the list, press the three-dots menu and select <strong>\"Erase deleted notes now\"</strong>.</p><p>Deleted notes are permanently erased after a certain amount of time (7 days by default). To change this interval, press the three-dots menu and select <strong>\"Deleted Notes Settings\"</strong>.</p>",
- "_help_kBrnXNG3Hplm": "<p>This page explains the basic concepts related to the tree structure of notes in TriliumNext.</p><h2>Note</h2><p>A note is the central entity in TriliumNext. For more details, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_BFs8mudNFgCS\">Notes</a>.</p><h2>Branch</h2><p>A branch describes the placement of a note within the note tree. Essentially, it is a tuple of <code spellcheck=\"false\">parentNoteId</code> and <code spellcheck=\"false\">noteId</code>, indicating that the given note is placed as a child under the specified parent note.</p><p>Each note can have multiple branches, meaning any note can be placed in multiple locations within the tree. This concept is referred to as&nbsp;<a class=\"reference-link\" href=\"#root/_help_IakOLONlIfGI\">Cloning Notes</a>.</p><h2>Prefix</h2><p>A prefix is a branch-specific title modifier for a note. If you place your note in two different locations within the tree and want to alter the title slightly in one of those placements, you can use a prefix.</p><p>To edit a prefix, right-click on the note in the tree pane and select <em>Edit branch prefix</em>.</p><p>The prefix is not part of the note itself and is not encrypted when the note is protected. This can be useful if you want part of the title to remain visible in the tree for easier navigation, even when the note is protected.</p><h2>Subtree</h2><p>A subtree consists of a particular note (the subtree root) and all its children and descendants. Some operations, such as exporting, work on entire subtrees.</p>",
- "_help_MMiBEQljMQh2": "<p>One of the Trilium's goals is to provide fast and comfortable navigation between notes.</p><h2>Backwards and forward</h2><p>You can use alt-left and alt-right to move back and forward in history of viewed pages.</p><p>This works identically to browser backwards / forwards, it's actually using built-in browser support for this.</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Navigation/Note%20Navigation_image.jpg\"></p><h2>Jump to note</h2><p>This is useful to quickly find and view arbitrary notes - click on <code spellcheck=\"false\">Jump to</code> button on the top or press <kbd>Ctrl</kbd> + <kbd>J</kbd> . Then type part of the note name and autocomplete will help you pick the desired note.</p><p>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_F1r9QtzQLZqm\">Jump to Note</a>&nbsp;for more information.</p>",
- "_help_Ms1nauBra7gq": "<figure class=\"image image-style-align-center\"><img style=\"aspect-ratio:659/256;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Navigation/Quick%20search_image.png\" width=\"659\" height=\"256\"></figure><p>The <em>Quick search</em> function does a full-text search (that is, it searches through the content of notes and not just the title of a note) and displays the result in an easy-to-access manner.</p><p>The alternative to the quick search is the&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>&nbsp;function, which opens in a dedicated tab and has support for advanced queries.</p><p>For even faster navigation, it's possible to use&nbsp;<a class=\"reference-link\" href=\"#root/_help_F1r9QtzQLZqm\">Jump to...</a>&nbsp;which will only search through the note titles instead of the content.</p><h2>Layout</h2><p>Based on the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x0JgW8UqGXvq\">Vertical and horizontal layout</a>, the quick search is placed:</p><ul><li>On the vertical layout, it is displayed right above the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</li><li>On the horizontal layout, it is displayed in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>, where it can be positioned just like any other icon.</li></ul><h2>Search Features</h2><p>Quick search includes the following features:</p><h3>Content Previews</h3><p>Search results now display a 200-character preview of the note content below the note title. This preview shows the context where your search terms appear, making it easier to identify the right note without opening it.</p><h3>Infinite Scrolling</h3><p>Results are loaded progressively as you scroll:</p><ul><li>Initial display shows 15 results</li><li>Scrolling near the bottom automatically loads 10 more results</li><li>Continue scrolling to load all matching notes</li></ul><h3>Visual Features</h3><ul><li><strong>Highlighting</strong>: Search terms appear in bold with accent colors</li><li><strong>Separation</strong>: Results are separated with dividers</li><li><strong>Theme Support</strong>: Highlighting colors adapt to light/dark themes</li></ul><h3>Search Behavior</h3><p>Quick search uses progressive search:</p><ol><li>Shows exact matches first</li><li>Includes fuzzy matches when exact results are fewer than 5</li><li>Exact matches appear before fuzzy matches</li></ol><h3>Keyboard Navigation</h3><ul><li>Press <code spellcheck=\"false\">Enter</code> to open the first result</li><li>Use arrow keys to navigate through results</li><li>Press <code spellcheck=\"false\">Escape</code> to close the quick search</li></ul><h2>Using Quick Search</h2><ol><li><strong>Typo tolerance</strong>: Search finds results despite minor typos</li><li><strong>Content previews</strong>: 200-character snippets show match context</li><li><strong>Infinite scrolling</strong>: Additional results load on scroll</li><li><strong>Specific terms</strong>: Specific search terms return more focused results</li><li><strong>Match locations</strong>: Bold text indicates where matches occur</li></ol><h2>Quick Search - Exact Match Operator</h2><p>Quick Search now supports the exact match operator (<code spellcheck=\"false\">=</code>) at the beginning of your search query. This allows you to search for notes where the title or content exactly matches your search term, rather than just containing it.</p><h3>Usage</h3><p>To use exact match in Quick Search:</p><ol><li>Start your search query with the <code spellcheck=\"false\">=</code> operator</li><li>Follow it immediately with your search term (no space after <code spellcheck=\"false\">=</code>)</li></ol><h4>Examples</h4><ul><li><code spellcheck=\"false\">=example</code> - Finds notes with title exactly \"example\" or content exactly \"example\"</li><li><code spellcheck=\"false\">=Project Plan</code> - Finds notes with title exactly \"Project Plan\" or content exactly \"Project Plan\"</li><li><code spellcheck=\"false\">='hello world'</code> - Use quotes for multi-word exact matches</li></ul><h4>Comparison with Regular Search</h4><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Query</th>\n<th>Behavior</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code spellcheck=\"false\">example</code></td>\n<td>Finds all notes containing \"example\" anywhere in title or content</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">=example</code></td>\n<td>Finds only notes where the title equals \"example\" or content equals \"example\" exactly</td>\n</tr>\n</tbody></table></figure><h3>Technical Details</h3><p>When you use the <code spellcheck=\"false\">=</code> operator:</p><ul><li>The search performs an exact match on note titles</li><li>For note content, it looks for exact matches of the entire content</li><li>Partial word matches are excluded</li><li>The search is case-insensitive</li></ul><h3>Limitations</h3><ul><li>The <code spellcheck=\"false\">=</code> operator must be at the very beginning of the search query</li><li>Spaces after <code spellcheck=\"false\">=</code> will treat it as a regular search</li><li>Multiple <code spellcheck=\"false\">=</code> operators (like <code spellcheck=\"false\">==example</code>) are treated as regular text search</li></ul><h3>Use Cases</h3><p>This feature is particularly useful when:</p><ul><li>You know the exact title of a note</li><li>You want to find notes with specific, complete content</li><li>You need to distinguish between notes with similar but not identical titles</li><li>You want to avoid false positives from partial matches</li></ul><h3>Related Features</h3><ul><li>For more complex exact matching queries, use the full <a href=\"#root/_help_eIg8jdvaoNNd\">Search</a> functionality</li><li>For fuzzy matching (finding results despite typos), use the <code spellcheck=\"false\">~=</code> operator in the full search</li><li>For partial matches with wildcards, use operators like <code spellcheck=\"false\">*=*</code>, <code spellcheck=\"false\">=*</code>, or <code spellcheck=\"false\">*=</code> in the full search</li></ul>",
- "_help_F1r9QtzQLZqm": "<figure class=\"image image-style-align-center\"><img style=\"aspect-ratio:991/403;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Navigation/1_Jump%20to%20%26%20command%20palette_image.png\" width=\"991\" height=\"403\"></figure><h2>Jump to Note</h2><p>The <em>Jump to Note</em> function allows easy navigation between notes by searching for their title. In addition to that, it can also trigger a full search or create notes.</p><p>To enter the “Jump to” dialog:</p><ul><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>, press <img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Navigation/2_Jump%20to%20%26%20command%20palette_image.png\"> button.</li><li>Using the keyboard, press <kbd>Ctrl</kbd> + <kbd>J</kbd>.</li></ul><p>In addition to searching for notes, it is also possible to search for commands. See the dedicated section below for more information.</p><h3>Interaction</h3><ul><li>By default, when there is no text entered it will display the most recent notes.</li><li>Using the keyboard, use the up or down arrow keys to navigate between items. Press <kbd>Enter</kbd> to open the desired note.</li><li>If the note doesn't exist, it's possible to create it by typing the desired note title and selecting the <em>Create and link child note</em> option.</li></ul><h2>Recent notes</h2><p>Jump to note also has the ability to show the list of recently viewed / edited notes and quickly jump to it.</p><p>To access this functionality, click on <code spellcheck=\"false\">Jump to</code> button on the top. By default, (when nothing is entered into autocomplete), this dialog will show the list of recent notes.</p><p>Alternatively you can click on the \"time\" icon on the right.</p><h2>Command Palette</h2><figure class=\"image image-style-align-center\"><img style=\"aspect-ratio:982/524;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Navigation/Jump%20to%20%26%20command%20palette_image.png\" width=\"982\" height=\"524\"></figure><p>The command palette is a feature which allows easy execution of various commands that can be found throughout the application, such as from menus or keyboard shortcuts. This feature integrates directly into the “Jump to” dialog.</p><h3>Interaction</h3><p>To trigger the command palette:</p><ul><li>Press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>J</kbd> to display the command palette directly.</li><li>If in the “Jump to” dialog, type <code spellcheck=\"false\">&gt;</code> in the search to switch to the command palette.</li></ul><p>Interaction:</p><ul><li>Type a few words to filter between commands.</li><li>Use the up and down arrows on the keyboard or the mouse to select a command.</li><li>Press <kbd>Enter</kbd> to execute the command.</li></ul><p>To exit the command palette:</p><ul><li>Remove the <code spellcheck=\"false\">&gt;</code> in the search to go back to the note search.</li><li>Press <kbd>Esc</kbd> to dismiss the dialog entirely.</li></ul><h3>Options available</h3><p>Currently the following options are displayed:</p><ul><li>Most of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_A9Oc6YKKc65v\">Keyboard Shortcuts</a>&nbsp;have an entry, with the exception of those that are too specific to be run from a dialog.</li><li>Some additional options which are not yet available as keyboard shortcuts, but can be accessed from various menus such as: exporting a note, showing attachments, searching for notes or configuring the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</li></ul><h3>Limitations</h3><p>Currently it's not possible to define custom actions that are displayed in the command palette. In the future this might change by integrating the options in the launch bar, which can be customized if needed.</p>",
- "_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>Accessing the search</h2><ul><li>From the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>, look for the dedicated search button.</li><li>To limit the search to a note and its children, select <em>Search from subtree</em> from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_YtSN43OrfzaA\">Note tree contextual menu</a>&nbsp;or press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>S</kbd>.</li></ul><h2>Interaction</h2><p>To search for notes, click on the magnifying glass icon on the toolbar 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 options</em> buttons, as described in the follow-up section.</li><li>Press <em>Search</em> to trigger the search. The results are displayed below the search configuration pane.</li><li>The <em>Search &amp; Execute actions</em> button 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> will create a new note with the search configuration. For more information, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a>.</li></ol><h2>Search options</h2><p>Click on which search option to apply from the Add search option section.</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 X button to the right of it.</li></ul><p>The options available are:</p><ol><li>Search script<ol><li>This feature allows writing a&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note that will handle the search on its own.</li></ol></li><li>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>Include archived<ol><li><a class=\"reference-link\" href=\"#root/_help_MKmLg5x6xkor\">Archived Notes</a>&nbsp;will also be included in the results, whereas otherwise they would be ignored.</li></ol></li><li>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>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>Debug<ol><li>This will print additional information in the server log (see&nbsp;<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><li>Action<ol><li>Apart from just searching, it is also possible to apply actions such as to add a label or a relation to the notes that have been matched by the search.</li><li>Unlike other search configurations, here it's possible to apply the same action multiple times (i.e. in order to be able to apply multiple labels to notes).</li><li>The actions given are the same as the ones in&nbsp;<a class=\"reference-link\" href=\"#root/_help_ivYnonVFBxbQ\">Bulk Actions</a>, which is an alternative for operating directly with notes within the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</li><li>After defining the actions, first press <em>Search</em> to check the matched notes and then press <em>Search &amp; Execute actions</em> to trigger the actions.</li></ol></li></ol><h3>Simple Note Search Examples</h3><ul><li><code spellcheck=\"false\">rings tolkien</code>: Full-text search to find notes containing both \"rings\" and \"tolkien\".</li><li><code spellcheck=\"false\">\"The Lord of the Rings\" Tolkien</code>: Full-text search where \"The Lord of the Rings\" must match exactly.</li><li><code spellcheck=\"false\">note.content *=* rings OR note.content *=* tolkien</code>: Find notes containing \"rings\" or \"tolkien\" in their content.</li><li><code spellcheck=\"false\">towers #book</code>: Combine full-text and attribute search to find notes containing \"towers\" and having the \"book\" label.</li><li><code spellcheck=\"false\">towers #book or #author</code>: Search for notes containing \"towers\" and having either the \"book\" or \"author\" label.</li><li><code spellcheck=\"false\">towers #!book</code>: Search for notes containing \"towers\" and not having the \"book\" label.</li><li><code spellcheck=\"false\">#book #publicationYear = 1954</code>: Find notes with the \"book\" label and \"publicationYear\" set to 1954.</li><li><code spellcheck=\"false\">#genre *=* fan</code>: Find notes with the \"genre\" label containing the substring \"fan\". Additional operators include <code spellcheck=\"false\">*=*</code> for \"contains\", <code spellcheck=\"false\">=*</code> for \"starts with\", <code spellcheck=\"false\">*=</code> for \"ends with\", and <code spellcheck=\"false\">!=</code> for \"is not equal to\".</li><li><code spellcheck=\"false\">#book #publicationYear &gt;= 1950 #publicationYear &lt; 1960</code>: Use numeric operators to find all books published in the 1950s.</li><li><code spellcheck=\"false\">#dateNote &gt;= 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 spellcheck=\"false\">~author.title *=* Tolkien</code>: Find notes related to an author whose title contains \"Tolkien\".</li><li><code spellcheck=\"false\">#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 spellcheck=\"false\">note.content %= '\\\\d{2}:\\\\d{2} (PM|AM)'</code>: Find notes that mention a time. Backslashes in a regex must be escaped.</li></ul><h3>Fuzzy Search</h3><p>Trilium supports fuzzy search operators that find results with typos or spelling variations:</p><ul><li><code spellcheck=\"false\">#title ~= trilim</code>: Fuzzy exact match - finds notes with titles like \"Trilium\" even if you typed \"trilim\" (with typo)</li><li><code spellcheck=\"false\">#content ~* progra</code>: Fuzzy contains match - finds notes containing words like \"program\", \"programmer\", \"programming\" even with slight misspellings</li><li><code spellcheck=\"false\">note.content ~* develpment</code>: Will find notes containing \"development\" despite the typo</li></ul><p><strong>Important notes about fuzzy search:</strong></p><ul><li>Fuzzy search requires at least 3 characters in the search term</li><li>Maximum edit distance is 2 characters (number of character changes needed)</li><li>Diacritics are normalized (e.g., \"café\" matches \"cafe\")</li><li>Fuzzy matches work best for finding content with minor typos or spelling variations</li></ul><h3>Advanced Use Cases</h3><ul><li><code spellcheck=\"false\">~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 spellcheck=\"false\">~author.title *= Tolkien OR (#publicationDate &gt;= 1954 AND #publicationDate &lt;= 1960)</code>: Use boolean expressions and parentheses to group expressions. Note that expressions starting with a parenthesis need an \"expression separator sign\" (# or ~) prepended.</li><li><code spellcheck=\"false\">note.parents.title = 'Books'</code>: Find notes with a parent named \"Books\".</li><li><code spellcheck=\"false\">note.parents.parents.title = 'Books'</code>: Find notes with a grandparent named \"Books\".</li><li><code spellcheck=\"false\">note.ancestors.title = 'Books'</code>: Find notes with an ancestor named \"Books\".</li><li><code spellcheck=\"false\">note.children.title = 'sub-note'</code>: Find notes with a child named \"sub-note\".</li></ul><h3>Search with Note Properties</h3><p>Notes have properties that can be used in searches, such as <code spellcheck=\"false\">noteId</code>, <code spellcheck=\"false\">dateModified</code>, <code spellcheck=\"false\">dateCreated</code>, <code spellcheck=\"false\">isProtected</code>, <code spellcheck=\"false\">type</code>, <code spellcheck=\"false\">title</code>, <code spellcheck=\"false\">text</code>, <code spellcheck=\"false\">content</code>, <code spellcheck=\"false\">rawContent</code>, <code spellcheck=\"false\">ownedLabelCount</code>, <code spellcheck=\"false\">labelCount</code>, <code spellcheck=\"false\">ownedRelationCount</code>, <code spellcheck=\"false\">relationCount</code>, <code spellcheck=\"false\">ownedRelationCountIncludingLinks</code>, <code spellcheck=\"false\">relationCountIncludingLinks</code>, <code spellcheck=\"false\">ownedAttributeCount</code>, <code spellcheck=\"false\">attributeCount</code>, <code spellcheck=\"false\">targetRelationCount</code>, <code spellcheck=\"false\">targetRelationCountIncludingLinks</code>, <code spellcheck=\"false\">parentCount</code>, <code spellcheck=\"false\">childrenCount</code>, <code spellcheck=\"false\">isArchived</code>, <code spellcheck=\"false\">contentSize</code>, <code spellcheck=\"false\">noteSize</code>, and <code spellcheck=\"false\">revisionCount</code>.</p><p>These properties can be accessed via the <code spellcheck=\"false\">note.</code> prefix, e.g., <code spellcheck=\"false\">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 spellcheck=\"false\">publicationDate</code> in descending order.</li><li>Use <code spellcheck=\"false\">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.ancestor.title = 'Tolkien')</code></pre><p>This query finds all book notes not in the \"Tolkien\" subtree.</p><h2>Progressive Search Strategy</h2><p>Trilium uses a progressive search strategy that performs exact matching first, then adds fuzzy matching when needed.</p><h3>How Progressive Search Works</h3><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><h3>Search Performance</h3><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>Under the Hood</h2><h3>Label and Relation Shortcuts</h3><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><h3>Separating Full-Text and Attribute Parts</h3><p>Search syntax allows combining full-text search with attribute-based search. For example, <code spellcheck=\"false\">tolkien #book</code> contains:</p><ol><li>Full-text tokens - <code spellcheck=\"false\">tolkien</code></li><li>Attribute expressions - <code spellcheck=\"false\">#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><h3>Escaping Special Characters</h3><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><h3>Type Coercion</h3><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 spellcheck=\"false\">#publicationYear &gt;= 1960</code> convert string values to numbers for comparison.</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 spellcheck=\"false\">http://localhost:8080/#?searchString=abc</code></p><h2>Search Configuration</h2><h3>Parameters</h3><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code spellcheck=\"false\">MIN_FUZZY_TOKEN_LENGTH</code></td>\n<td>3</td>\n<td>Minimum characters for fuzzy matching</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">MAX_EDIT_DISTANCE</code></td>\n<td>2</td>\n<td>Maximum character changes allowed</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">RESULT_SUFFICIENCY_THRESHOLD</code></td>\n<td>5</td>\n<td>Minimum exact results before fuzzy fallback</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">MAX_CONTENT_SIZE</code></td>\n<td>10MB</td>\n<td>Maximum note content size for search processing</td>\n</tr>\n</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>Fuzzy matching requires tokens of at least 3 characters</li></ul>",
- "_help_u3YFHC9tQlpm": "<p>Frequently used notes can be bookmarked, which will make them appear in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>&nbsp;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&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>&nbsp;configuration from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;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 and assign it the <code spellcheck=\"false\">#bookmarkFolder</code> label.</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 sub-menus.</p>",
++ "_help_MKmLg5x6xkor": "<p>Archived notes are notes which have <code>archived</code> <a href=\"#root/_help_zEY4DaJG4YT5\">attribute</a> - either directly or <a href=\"#root/_help_bwZpz2ajCEwO\">inherited</a>.</p><p>Such notes are then by default not shown in the autocomplete and in the full text <a href=\"#root/_help_eIg8jdvaoNNd\">search</a>.</p><p>This can be useful for notes which are no longer very useful but still valuable enough to keep around without them getting too much in the way.</p><p>You can control whether archived notes are displayed in the note tree with a setting:</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/Archived%20Notes_hide-archived.png\"></p>",
++ "_help_vZWERwf8U3nx": "<figure class=\"image\"><img style=\"aspect-ratio:2089/1515;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/Note%20Revisions_image.png\" width=\"2089\" height=\"1515\"></figure><p>Trilium supports seamless versioning of notes by storing snapshots (\"revisions\") of notes at regular intervals.</p><p>To display the revisions, press the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>&nbsp;and select <em>Note revisions…</em> (<span class=\"tn-icon bx bx-history\"></span>).</p><h2>Interaction</h2><aside class=\"admonition note\"><p>This documentation matches the redesign of the note revisions dialog on v0.103.0, older versions have a similar dialog but with some differences.</p></aside><ul><li>The full list of revisions are displayed on the left in reverse chronological order.<ul><li>The revisions are grouped by the date the revision was taken.</li><li>This list does not contain the <em>current state</em> of the note, so it is possible to have notes with no revisions/snapshots saved.</li></ul></li><li>The icon of a revision indicates the <em>source</em> of that revision (e.g. a&nbsp;<span class=\"tn-icon bx bx-save\"></span> icon for a manually saved revision).</li><li>Pressing the <span class=\"tn-icon bx bx-dots-horizontal-rounded\"></span> button on the top-right of the dialog displays multiple options, including:<ul><li><span class=\"tn-icon bx bx-save\"></span> Saving a new revision now.</li><li>Checking the interval and limit for this note (see below).</li><li><span class=\"tn-icon bx bx-trash\"></span> Deleting all the revisions of this note.</li></ul></li><li>For supported notes (text, code), changes are highlighted. This behavior can be toggled via the <em>Highlight changes</em> at the top of the dialog.<ul><li>The highlighted changes are relative to the <strong>current state of the note</strong>, not to the revision prior to this one.</li></ul></li><li>For any given revision, the buttons on the top-right allow operating on it:<ul><li><span class=\"tn-icon bx bx-trash\"></span> Deleting the revision.</li><li><span class=\"tn-icon bx bx-download\"></span> Downloading the revision locally.</li><li><span class=\"tn-icon bx bx-history\"></span> Restoring the revision, which replaces the current content of the note with the one from the revision. Another revision is saved containing the current content of the note.</li></ul></li></ul><h2>Named revisions</h2><p>Named revisions are a new feature of Trilium v0.103.0 which allows adding a short description of what the changes in the snapshot contain.</p><p>In the list of note revisions:</p><ul><li>The name of the revision is displayed underneath the time of the revision in the sidebar, as well as at the top of the dialog where it is displayed in full.</li><li>Clicking on the <span class=\"tn-icon bx bx-edit-alt\"></span> edit button near the name of the revision allows it to be changed.</li></ul><p>To create a named revision, either:</p><ul><li>Go to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>, select <em>Save named revision…</em> (<span class=\"tn-icon bx bx-purchase-tag\"></span>), enter the name of revision and confirm.</li><li>Use the corresponding <a href=\"#root/_help_A9Oc6YKKc65v\">keyboard shortcut</a> or the&nbsp;<a class=\"reference-link\" href=\"#root/_help_F1r9QtzQLZqm\">Jump to &amp; command palette</a>&nbsp;command with the same name.</li><li>Save a revision normally, and adjust the name afterwards from the note revision list.</li></ul><h2>When revisions are saved</h2><p>Revisions are saved:</p><ul><li>Automatically at a fixed interval. This behavior can be configured (see below).</li><li>Manually, by:<ul><li>Going to the <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> and selecting <em>Save revision</em> (<span class=\"tn-icon bx bx-save\"></span>).</li><li>Using the <em>Force Save Revision</em> <a href=\"#root/_help_A9Oc6YKKc65v\">keyboard shortcut</a>.</li><li>In the <em>Note Revisions</em> dialog, pressing the <span class=\"tn-icon bx bx-dots-horizontal-rounded\"></span> button in the top-right and selecting <em>Save a revision now</em>.</li></ul></li></ul><p>Additionally, revisions can also come from somewhere else, and this is indicated via the icon of the revision:</p><ul><li><span class=\"tn-icon bx bx-code-alt\"></span> Generated externally, by&nbsp;<a class=\"reference-link\" href=\"#root/_help_pgxEVkzLl1OP\">ETAPI (REST API)</a>.</li><li><span class=\"tn-icon bx bx-bot\"></span> A modification created by&nbsp;<a class=\"reference-link\" href=\"#root/_help_GBBMSlVSOIGP\">AI</a>.</li><li><span class=\"tn-icon bx bx-history\"></span> A revision is restored, causing the existing note content to be saved as a revision to prevent potential data loss.</li></ul><h4>Snapshot interval</h4><p>Time interval of taking note snapshot is configurable in the Options → Other dialog. This provides a trade-off between more revisions and more data to store.</p><p>To turn off note versioning for a particular note (or sub-tree), add <code>disableVersioning</code> <a href=\"#root/_help_zEY4DaJG4YT5\">label</a> to the note.</p><h4>Maximum revisions</h4><p>The limit on the number of note snapshots can be configured in the Options → Other dialog. The note revision snapshot number limit refers to the maximum number of revisions that can be saved for each note. Where -1 means no limit, 0 means delete all revisions. You can set the maximum revisions for a single note through the <code>versioningLimit=X</code> label.</p><p>The note limit will not take effect immediately; it will only apply when the note is modified.</p><p>You can click the <em>Erase now</em> button under <em>Erase excess revision snapshots</em> to apply the changes immediately.</p>",
++ "_help_aGlEvb9hyDhS": "<h2>Manual sorting</h2><p>You can sort notes by right-clicking the parent note in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and selecting Advanced -&gt; Sort notes by ... This will sort existing notes, but will not automatically sort future notes added to this parent note.</p><p>The sorting dialog allows:</p><ul><li>Sorting by title, creation or modification date, or by the value of a label on the child notes.</li><li>Sorting by several such criteria in turn, each ascending or descending: the next level only decides between notes the previous ones left equal.</li><li>Ensuring folders are displayed at the top.</li><li>Natural sort, based on the sorting rules of a particular language.</li></ul><h2>Automatic/Permanent Sorting</h2><p>Child notes can be automatically sorted by attaching specific <a href=\"#root/_help_zEY4DaJG4YT5\">labels</a> to the parent note:</p><figure class=\"table\"><table><thead><tr><th>Label</th><th>Description</th></tr></thead><tbody><tr><td><code>#sorted</code></td><td><p>Keeps child notes sorted by title alphabetically.</p><p>When given a value, it will sort by other criteria instead: a comma-separated list of levels, each <code>title</code>, <code>dateCreated</code>, <code>dateModified</code> or the name of a label on the child notes, optionally followed by <code>asc</code> or <code>desc</code>, as in a search's <code>orderBy</code>. For example <code>#sorted=\"priority desc, dueDate\"</code> sorts by priority, highest first, and notes of equal priority by due date. A child note without a level's label sorts after every child that has it, whichever direction the level runs in. When neither note has the label, the next level decides.</p></td></tr><tr><td><code>#sortDirection</code></td><td><p>If <code>sorted</code> is applied, specifies the direction of the sort:</p><ul><li><code>ASC</code>, ascending (default)</li><li><code>DESC</code>, descending</li></ul><p>A level of <code>sorted</code> followed by its own <code>asc</code> or <code>desc</code> keeps that direction regardless.</p></td></tr><tr><td><code>#sortFoldersFirst</code></td><td>If <code>sorted</code> is applied, folders (notes with children) will be sorted as a group at the top (at the bottom when <code>#sortDirection</code> is <code>desc</code>), and the rest will be sorted.</td></tr><tr><td><code>#sortNatural</code></td><td>Sort numbers naturally instead of alphabetically, so 2 comes before 10.</td></tr><tr><td><code>#sortLocale</code></td><td>The language code driving the natural sort (e.g. <code>zh-CN</code>, <code>de</code>). Only meaningful together with <code>#sortNatural</code>.</td></tr><tr><td><code>#top</code></td><td>If <code>sorted</code> is applied to the parent note, keeps given note on top in its parent.</td></tr><tr><td><code>#bottom</code></td><td>If <code>sorted</code> is applied to the parent note, keeps given note on bottom in its parent.</td></tr></tbody></table></figure><p>Sorting is done by comparing note properties or specific labels on child notes. There are four sorting levels, with the first having the highest priority. Lower priority levels are applied only if higher priority comparisons result in equality.</p><ol><li><strong>Top Label Sorting</strong>: Child notes with the <code>#top</code> label will appear at the top of the folder.</li><li><strong>Bottom Label Sorting</strong>: (Introduced in Trilium 0.62) Child notes with the <code>#bottom</code> label will appear at the bottom of the folder.</li><li><strong>Property/Label-Based Sorting</strong>: Sorting is based on the parent note's <code>#sorted</code> label:<ul><li><strong>Default Sorting</strong>: If <code>#sorted</code> has no value, notes are sorted alphabetically.</li><li><strong>Property Sorting</strong>: If <code>#sorted</code> is set to <code>title</code>, <code>dateModified</code>, or <code>dateCreated</code>, notes are sorted based on the specified property.</li><li><strong>Label Sorting</strong>: If <code>#sorted</code> has any other value, this value is treated as the name of a child note's label, and sorting is based on the values of this label. For example, setting <code>#sorted=myOrder</code> on the parent note and using <code>#myOrder=001</code>, <code>#myOrder=002</code>, etc., on child notes.</li><li><strong>Multi-Level Sorting</strong>: Several of the above can be combined, separated by commas; each level is applied only where the previous ones are equal. Every level can carry its own direction as a word after the name, <code>asc</code> or <code>desc</code>, otherwise it follows <code>#sortDirection</code>. For example <code>#sorted=\"priority desc, area, dateCreated\"</code> sorts by priority, highest first, then by area, then by creation date.</li></ul></li><li><strong>Alphabetical Sorting</strong>: Used as a last resort when other criteria result in equality.</li></ol><p>All comparisons are made string-wise (e.g., \"1\" &lt; \"2\" or \"2020-10-10\" &lt; \"2021-01-15\", but also \"2\" &gt; \"10\").</p>",
++ "_help_NRnIZmSMc5sj": "<figure class=\"image\"><img style=\"aspect-ratio:2023/1488;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/Printing%20%26%20Exporting%20as%20PDF_image.png\" width=\"2023\" height=\"1488\"><figcaption>Screenshot of the Print preview functionality introduced in v0.103.0.</figcaption></figure><p>Trilium allows printing notes to a real printer, or generating a structured PDF for a single note or for multiple notes through&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>.</p><p>Note that not all note types are printable as of now. We do plan to increase the coverage of supported note types in the future.</p><p>Printing and exporting as PDF are not perfect. Due to technical limitations, and sometimes even browser or Electron glitches the text might appear cut off in some circumstances.&nbsp;</p><h2>Printing a note or exporting as PDF on the desktop</h2><aside class=\"admonition note\"><p>Versions prior to v0.103.0 had two different options, one for printing and another one for exporting to PDF. With the introduction of the print preview, these functions have been unified.</p></aside><p>On the desktop application of Trilium it is possible to export a note as PDF. To print a note:</p><ul><li>Press the menu button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>&nbsp;and select <em>Print note</em>.</li><li>Alternatively, printing can be triggered from a <a href=\"#root/_help_A9Oc6YKKc65v\">keyboard shortcut</a> (unassigned by default) or through the <a href=\"#root/_help_F1r9QtzQLZqm\">command palette</a>.</li></ul><p>This will trigger the print preview screen next.</p><h3>Print preview &amp; print options</h3><p>The print preview dialog allows the following printing options to be adjusted:</p><ul><li>The printer to use<ul><li><em>Save as PDF</em> generates a PDF that is structured (maintains a table of contents, keeps the text selectable). Prefer this over other virtual PDF printers that ship with the operating system.</li></ul></li><li>Page orientation: <em>Portrait</em> (default) or <em>Landscape</em>.</li><li>Page size</li><li>Scale the entire content from 10% to 200% to improve the fit within the page.</li><li>Margins, which can be removed completely or adjusted individually for all the four edges.</li><li>Print only a subset of pages. Individual page numbers are separated by colons and hyphen-based ranges are supported (e.g. 3-5 for pages 3 to 5).</li></ul><p>Additional interaction:</p><ul><li><em>Print using system dialog</em> allows setting more options that are otherwise not available in Trilium.</li></ul><p>If the note cannot be rendered with the current options, or stops making progress for 30 seconds, the preview is replaced by an error message. Adjust the options to try again.</p><aside class=\"admonition note\"><p>Most of the options here (except printer &amp; which pages to print) are managed at note level through&nbsp;<a class=\"reference-link\" href=\"#root/_help_zEY4DaJG4YT5\">Attributes</a>&nbsp;(such as <code>#printLandscape</code>, <code>#printPageSize</code>, <code>#printScale</code>, <code>#printMargins</code>).</p><p>This means that the print settings will be restored when printing the same note. There are no default settings that can be configured for all the notes, but this can be achieved via <a href=\"#root/_help_bwZpz2ajCEwO\">inheritable attributes</a>.</p></aside><h2>Printing on the browser</h2><p>This feature allows printing of notes. It works on both the desktop client, but also on the web.</p><p>To print a note, click the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>&nbsp;and select <em>Print note</em>. Depending on the size and type of the note, this can take up to a few seconds. Afterwards you will be redirected to the system/browser printing dialog.</p><p>On the server or PWA (mobile), the option is not available due to technical constraints and it will be hidden.</p><h2>Reporting issues with the rendering</h2><p>Should you encounter any visual issues in the resulting PDF file (e.g. a table does not fit properly, there is cut off text, etc.) feel free to <a href=\"#root/_help_wy8So3yZZlH9\">report the issue</a>. In this case, it's best to offer a sample note (click on the&nbsp;<span class=\"tn-icon cke cke-three-vertical-dots\"></span> button, select <em>Export note</em> → <em>This note and all of its descendants</em> → <em>HTML in ZIP archive</em>). Make sure not to accidentally leak any personal information.</p><p>Consider adjusting font sizes and using <a href=\"#root/_help_CohkqWQC1iBv\">page breaks</a> to work around the layout.</p><aside class=\"admonition tip\"><p>Although direct export as PDF is not available in the browser version of the application, it's still possible to generate a PDF by selecting the <em>Print</em> option instead and selecting “Save to PDF” as the printer (depending on the browser). Generally, Mozilla Firefox has better printing capabilities.</p></aside><h3>Automatic opening of the file</h3><p>When the PDF is exported, it is automatically opened with the system default application for easy preview.</p><p>Note that if you are using Linux with the GNOME desktop environment, sometimes the default application might seem incorrect (such as opening in GIMP). This is because it uses Gnome's “Recommended applications” list.</p><p>To solve this, you can change the recommended application for PDFs via this command line. First, list the available applications via <code>gio mime application/pdf</code> and then set the desired one. For example to use GNOME's Evince:</p><pre><code class=\"language-text-x-trilium-auto\">gio mime application/pdf</code></pre><h2>Printing multiple notes</h2><p>Since v0.100.0, it is possible to print more than one note at the time by using&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>:</p><ol><li>First create a collection.</li><li>Configure it to use&nbsp;<a class=\"reference-link\" href=\"#root/_help_mULW0Q3VojwY\">List View</a>.</li><li>Print the collection note normally.</li></ol><p>The resulting collection will contain all the children of the collection, while maintaining the hierarchy.</p><aside class=\"admonition note\"><p>Not all note types are supported when printing or exporting to PDF. When an unsupported note is encountered, it is skipped. At the end, if any of the notes were skipped, a message will be displayed with the possibility of viewing the full list of skipped notes. The same limitations as the ones described in <em>Constraints &amp; limitations</em> apply.</p></aside><h2>Keyboard shortcut</h2><p>It's possible to trigger both printing and export as PDF from the keyboard by going to&nbsp;<em>Keyboard shortcuts</em>&nbsp;in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;and assigning a key combination for:</p><ul><li><em>Print Active Note</em></li><li><em>Export Active Note as PDF</em></li></ul><h2>Constraints &amp; limitations</h2><p>Not all&nbsp;<a class=\"reference-link\" href=\"#root/_help_KSZ04uQ2D1St\">Note Types</a>&nbsp;are supported when printing, in which case the <em>Print</em> and <em>Export as PDF</em> options will be disabled.</p><ul><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes, font, background and table colors are printed in the shades of light themes, whatever the current theme (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_Gr6xFaF6ioJ5\">General formatting</a>).</li><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;notes:<ul><li>Line numbers are not printed.</li><li>Syntax highlighting is enabled, however a default theme (Visual Studio) is enforced.</li></ul></li><li>A <a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a> is printed as it is displayed, without running its script again, once its <code>~renderNote</code> relation is set.</li><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>, the following are supported:<ul><li><a class=\"reference-link\" href=\"#root/_help_mULW0Q3VojwY\">List View</a>, allowing to print multiple notes at once while preserving hierarchy (similar to a book).</li><li><a class=\"reference-link\" href=\"#root/_help_zP3PMqaG71Ct\">Presentation</a>, where each slide/sub-note is displayed.<ul><li>Most note types are supported, especially the ones that have an image representation such as&nbsp;<a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a>.</li></ul></li><li><a class=\"reference-link\" href=\"#root/_help_2FvYrpmOXm29\">Table</a>, where the table is rendered in a print-friendly way.<ul><li>Tables that are too complex (especially if they have multiple columns) might not fit properly, however tables with a large number of rows are supported thanks to pagination.</li><li>Consider printing in landscape mode, or using <code>#printLandscape</code> if exporting to PDF.</li></ul></li><li>The rest of the collections are not supported, but we plan to add support for all the collection types at some point.</li></ul></li><li>Using&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlhDUqhENtH7\">Custom app-wide CSS</a>&nbsp;for printing is no longer supported, instead a custom <code>printCss</code> relation needs to be used (see below).</li></ul><h2>Customizing the print CSS</h2><p>As an advanced use case, it's possible to customize the CSS used for printing such as adjusting the fonts, sizes or margins. Note that&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlhDUqhENtH7\">Custom app-wide CSS</a>&nbsp;will not work for printing.</p><p>To do so:</p><ul><li>Create a CSS <a href=\"#root/_help_6f9hih2hXXZk\">code note</a>.</li><li>On the note being printed, apply the <code>~printCss</code> relation to point to the newly created CSS code note.</li><li>To apply the CSS to multiple notes, consider using <a href=\"#root/_help_bwZpz2ajCEwO\">inheritable attributes</a> or&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>.</li></ul><p>For example, to change the font of the document from the one defined by the theme or the user to a serif one:</p><pre><code class=\"language-text-x-trilium-auto\">body {\n\t--print-font-family: serif;\n --print-font-size: 11pt;\n}</code></pre><aside class=\"admonition important\"><p>When altering <code>--print-font-family</code>, make sure the change is done at <code>body</code> level and not <code>:root</code>, since otherwise it won't be picked up due to specificity rules.</p></aside><p>To remark:</p><ul><li>Multiple CSS notes can be add by using multiple <code>~printCss</code> relations.</li><li>If the note pointing to the <code>printCss</code> doesn't have the right note type or mime type, it will be ignored.</li><li>If migrating from a previous version where&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlhDUqhENtH7\">Custom app-wide CSS</a>, there's no need for <code>@media print {</code>  since the style-sheet is used only for printing.</li></ul><h2>Under the hood</h2><p>Both printing and exporting as PDF use the same mechanism: a note is rendered individually in a separate webpage that is then sent to the browser or the Electron application either for printing or exporting as PDF.</p><p>The webpage that renders a single note can actually be accessed in a web browser. For example <code>http://localhost:8080/#root/WWRGzqHUfRln/RRZsE9Al8AIZ?ntxId=0o4fzk</code> becomes <code>http://localhost:8080/?print#root/WWRGzqHUfRln/RRZsE9Al8AIZ</code>.</p><p>Accessing the print note in a web browser allows for easy debugging to understand why a particular note doesn't render well. The mechanism for rendering is similar to the one used in&nbsp;<a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a>.</p>",
++ "_help_CoFPLs3dRlXc": "<p>Some note types such as&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>,&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;notes and even some of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>&nbsp;can be set to read-only. When a note is in read-only mode, it is presented to the user in a non-editable view, with the option to switch to editing mode if needed.</p><h2>Automatic read-only mode</h2><p>For optimization purposes, Trilium will automatically set very large notes to read-only. Displaying such lengthy notes in editing mode can slow down performance, especially when editing is unnecessary.</p><p>This behavior can be disabled on a per-note basis, by following the instructions of the next section.</p><p>In addition, it's possible to change the number of characters at which the automatic read-only mode will trigger in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;by going to the options for&nbsp;<a class=\"reference-link\" href=\"#root/_hidden/_options/_optionsTextNotes\">Text Notes</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_hidden/_options/_optionsCodeNotes\">Code Notes</a>.</p><h2>Changing a note's read-only behavior</h2><p>A note's read-only behavior can be changed via&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>&nbsp;→ <em>Editable.</em> The following options are possible:</p><ul><li><strong>Auto</strong><br>This is the default behavior in which the note will be editable by default, unless it becomes large enough to trigger read-only mode.</li><li><strong>Read-only</strong><br>The note will be always marked as read-only, regardless of its size. Nevertheless, it's still possible to temporarily edit the note if needed. This is generally useful for notes that are not prone to change.</li><li><strong>Always Editable</strong><br>This option will bypass the automatic read-only activation for this particular note. It's useful for large notes that are frequently edited.</li></ul><p>If the <em>Editable</em> section is missing from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>, then the note type does not support read-only mode.</p><h3>Manually setting the options</h3><p>Apart from using the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>&nbsp;as previously mentioned, it's also possible to use <a href=\"#root/_help_zEY4DaJG4YT5\">labels</a> to change the behavior:</p><ul><li>To set as read-only, apply the <code>readOnly</code> label to the note.</li><li>To disable automatic read-only (always editable), apply the <code>autoReadOnlyDisabled</code> label.</li></ul><h2>Temporarily editing a read-only note</h2><p>When accessing a read-only note, it's possible to temporarily edit it pressing the <em>Read-only</em> badge.</p><p>When pressed, the note will become editable but will become read-only again after navigating to a different note.</p>",
++ "_help_0ESUbbAxVnoK": "<figure class=\"image\"><img style=\"aspect-ratio:990/590;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/Note%20List_image.png\" width=\"990\" height=\"590\"></figure><p>When a note has one or more child notes, they will be listed at the end of the note for easy navigation.</p><h2>Configuration</h2><ul><li>To hide the note list for a particular note, simply apply the <code>hideChildrenOverview</code> <a href=\"#root/_help_zEY4DaJG4YT5\">label</a>.</li><li>For some view types, such as Grid view, only a subset of notes will be displayed and pagination can be used to navigate through all of them for performance reasons. To adjust the number of notes per page, set <code>pageSize</code> to the desired number.</li></ul><h2>View types</h2><p>The view types dictate how the child notes are represented. By default, the notes will be displayed in a grid, however there are also some other view types available.</p><p>Generally the view type can only be changed from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>, but it can also be changed manually on any type of note using the <code>#viewType</code> <a href=\"#root/_help_HI6GBBIduIgv\">label</a>.</p>",
++ "_help_S0Fos78ZfcY7": "<p>The inbox is the default destination for quickly captured notes. When a note is created without picking a location first, it lands in the inbox. This makes it easy to quickly capture notes and sort them later.</p><h2>Where the inbox is used</h2><ul><li>The <em>New note</em> button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</li><li>The global <em>Create note into inbox</em> shortcut (default <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>P</kbd>).</li><li>The <em>New note</em> action in the <a href=\"#root/_help_7iwde4lsKc6O\">tray icon menu</a>.</li><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_MtPxeAWVAzMg\">Web Clipper</a>&nbsp;extension.</li><li>The <em>Create note</em> option offered when a search finds no match, in&nbsp;<a class=\"reference-link\" href=\"#root/_help_F1r9QtzQLZqm\">Jump to &amp; command palette</a>, in an empty tab and in the <code>@</code> completion of a text note.</li></ul><h2>Setting a note inbox</h2><p>To create a note inbox, apply the <code>#inbox</code> <a href=\"#root/_help_HI6GBBIduIgv\">label</a> to it.</p><p>Only one note should carry this label. If there are multiple notes, only one will be used by the application.</p><aside class=\"admonition note\"><p>If there is no inbox note, Trilium will fall back to today's <a href=\"#root/_help_l0tKav7yLHGF\">day note</a>, creating it and its calendar ancestors as needed. If the journal has been removed altogether, the note is created at the top level instead of a new journal being built for it.</p></aside><h2>Workspace inboxes</h2><p>Each <a href=\"#root/_help_9sRHySam5fXb\">workspace</a> can have its own inbox, set via the <code>#workspaceInbox</code> label.</p><p>When a new note is created while hoisted in a workspace, the location is determined in the following order:</p><ul><li>A note carrying the <code>#workspaceInbox</code> label in that workspace.</li><li>A note carrying the <code>#inbox</code> within that workspace.</li><li>Today's <a href=\"#root/_help_l0tKav7yLHGF\">day note</a>, if the workspace has a <code>#workspaceCalendarRoot</code>.</li><li>The workspace root note itself.</li></ul>",
++ "_help_5Ct4MAJTS4tQ": "<p>Deleted notes are listed in the <em>Deleted Notes</em> dialog (<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> → <em>Show Deleted Notes</em>) and can be restored by pressing the <em>undelete</em> link.</p><p>If a note has child notes, they will be restored along with it. Should the original location no longer exist (e.g. the parent has been deleted), the note will be restored into the default location for new notes (<a class=\"reference-link\" href=\"#root/_help_S0Fos78ZfcY7\">Note Inbox</a>).</p><aside class=\"admonition note\"><p>When a note is hoisted in the tree, the dialog will only display notes deleted from the subtree of that hoisted note.</p></aside><p>To permanently erase deleted notes and clear the list, press the three-dots menu and select <em>Erase deleted notes now</em>.</p><p>Deleted notes are permanently erased after a certain amount of time (7 days by default). To change this interval, press the three-dots menu and select <em>Deleted Notes Settings</em>.</p>",
++ "_help_m3VlURMSeOrd": "<p>When an empty&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;note is created, a note type switcher will appear below the&nbsp;inline&nbsp;<a class=\"reference-link\" href=\"#root/_help_l7pigIGu01K2\">Title</a>. Apart from changing the note type, it's also possible to apply a <a href=\"#root/_help_KC1HB96bqqHX\">template</a>:</p><ul><li><span class=\"tn-icon bx bxl-markdown\"></span>&nbsp;<em>Markdown</em> and&nbsp;<span class=\"tn-icon bx bx-pen\"></span> <em>Canvas</em> switch the note to that type in one click.</li><li><span class=\"tn-icon bx bx-code\"></span>&nbsp;<em>Code</em> lists the scripting notes (<em>Custom CSS</em>, <em>Widget</em> and <em>Backend script</em>), then the enabled code languages.</li><li><span class=\"tn-icon bx bx-book\"></span>&nbsp;<em>Collection</em> and <span class=\"tn-icon bx bx-copy-alt\"></span><em>Template</em> list the collections and the templates.</li><li><span class=\"tn-icon bx bx-dots-vertical-rounded\"></span>&nbsp;<em>All types</em> displays the same menu as <em>Insert note after</em> in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_YtSN43OrfzaA\">Note tree contextual menu</a>, with every note type and template.</li></ul><p>Typing while the&nbsp;<span class=\"tn-icon bx bx-code\"></span> <em>Code</em>,&nbsp;<span class=\"tn-icon bx bx-copy-alt\"></span> <em>Template</em> or&nbsp;<span class=\"tn-icon bx bx-dots-vertical-rounded\"></span> <em>All types</em> menu is open narrows it down to the matching entries.</p><p>The switcher will disappear as soon as a text is entered.</p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/New%20note%20type%20switcher_image.png\" width=\"735\" height=\"143\">",
++ "_help_B5dihXRDksTk": "<p>Note badges appear near the fixed note title and indicate important information about the note such as whether it is read-only. Some of the badges are also interactive.</p><figure class=\"image\"><img style=\"aspect-ratio:910/49;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/Note%20badges_image.png\" width=\"910\" height=\"49\"></figure><p>The following badges are available:</p><ul><li><span class=\"tn-icon bx bx-lock-alt\"></span>&nbsp;<strong>Read-only badge</strong>, which will be shown if the note is not editable due to either automatic read-only or manual read-only. Clicking on the badge will temporarily edit the note.</li><li><span class=\"tn-icon bx bx-share-alt\"></span>&nbsp;<strong>Share badge</strong>, which will indicate that the current note is shared. The badge will also indicate if the share is on the local network (for the desktop application without&nbsp;<a class=\"reference-link\" href=\"#root/_help_cbkrhQjrkKrh\">Synchronization</a>&nbsp;set up) or publicly accessible (for the server).</li><li><span class=\"tn-icon bx bx-globe\"></span>&nbsp;<strong>Web clip badge</strong>, which will indicate if the note was clipped using the&nbsp;<a class=\"reference-link\" href=\"#root/_help_MtPxeAWVAzMg\">Web Clipper</a>. The badge acts as a link, so it can be clicked on to navigate to the page or right clicked for more options. When the clipper also saved the page's description, its author, or the dates it was published and last updated, clicking the badge shows these details instead, with a link to the page at the top.</li><li><span class=\"tn-icon bx bx-play\"></span>&nbsp;<strong>Execute badge</strong>, for <a href=\"#root/_help_CdNpE2pqjmI6\">scripts</a> or <a href=\"#root/_help_YKWqdJhzi2VY\">saved SQL queries</a> which have an execute button or a description.</li><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_YzMcWlCVeW09\">Active content</a>&nbsp;(e.g. scripts, styles), a dedicated badge will be shown indicating the type of note and with an option to easily enable or disable it.</li></ul>",
++ "_help_Bsm4fyzPJkSc": "<p><img class=\"image-style-align-right\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Notes/Save%20status%20indicator_image.png\" width=\"168\" height=\"47\">To the right of the note title, a temporary indicator appears after making a change to the document which shows whether the document has been saved.</p><p>It indicates the following states:</p><ul><li><span class=\"tn-icon bx bx-pencil\"></span>&nbsp;<em>Unsaved</em>, if the changes will be saved soon.</li><li><span class=\"tn-icon bx bx-loader\"></span>&nbsp;<em>Saving</em>, if the changes are being saved.</li><li><span class=\"tn-icon bx bx-check\"></span>&nbsp;<em>Saved</em>, if all the changes were successfully saved to the server.</li><li><span class=\"tn-icon bx bx-error\"></span>&nbsp;<em>Error</em>, if the changes could not be saved, for example due to a communication server with the server.</li></ul><p>After all changes have been saved, the indicator will hide automatically after a few seconds.</p>",
++ "_help_kBrnXNG3Hplm": "<p>This page explains the basic concepts related to the tree structure of notes in TriliumNext.</p><h2>Note</h2><p>A note is the central entity in TriliumNext. For more details, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_BFs8mudNFgCS\">Notes</a>.</p><h2>Branch</h2><p>A branch describes the placement of a note within the note tree. Essentially, it is a tuple of <code>parentNoteId</code> and <code>noteId</code>, indicating that the given note is placed as a child under the specified parent note.</p><p>Each note can have multiple branches, meaning any note can be placed in multiple locations within the tree. This concept is referred to as&nbsp;<a class=\"reference-link\" href=\"#root/_help_IakOLONlIfGI\">Cloning Notes</a>.</p><h2>Prefix</h2><p>A prefix is a branch-specific title modifier for a note. If you place your note in two different locations within the tree and want to alter the title slightly in one of those placements, you can use a prefix.</p><p>To edit a prefix, right-click on the note in the tree pane and select <em>Edit branch prefix</em>.</p><p>The prefix is not part of the note itself and is not encrypted when the note is protected. This can be useful if you want part of the title to remain visible in the tree for easier navigation, even when the note is protected.</p><h2>Subtree</h2><p>A subtree consists of a particular note (the subtree root) and all its children and descendants. Some operations, such as exporting, work on entire subtrees.</p>",
++ "_help_MMiBEQljMQh2": "<p>One of the Trilium's goals is to provide fast and comfortable navigation between notes.</p><h2>Backwards and forward</h2><p>You can use alt-left and alt-right to move back and forward in history of viewed pages.</p><p>This works identically to browser backwards / forwards, it's actually using built-in browser support for this.</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Navigation/Note%20Navigation_image.jpg\"></p><h2>Jump to note</h2><p>This is useful to quickly find and view arbitrary notes - click on <code>Jump to</code> button on the top or press <kbd>Ctrl</kbd> + <kbd>J</kbd> . Then type part of the note name and autocomplete will help you pick the desired note.</p><p>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_F1r9QtzQLZqm\">Jump to Note</a>&nbsp;for more information.</p>",
++ "_help_Ms1nauBra7gq": "<figure class=\"image image-style-align-center\"><img style=\"aspect-ratio:659/256;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Navigation/Quick%20search_image.png\" width=\"659\" height=\"256\"></figure><p>The <em>Quick search</em> function does a full-text search (that is, it searches through the content of notes and not just the title of a note) and displays the result in an easy-to-access manner.</p><p>The alternative to the quick search is the&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>&nbsp;function, which opens in a dedicated tab and has support for advanced queries.</p><p>For even faster navigation, it's possible to use&nbsp;<a class=\"reference-link\" href=\"#root/_help_F1r9QtzQLZqm\">Jump to &amp; command palette</a>&nbsp;which will only search through the note titles instead of the content.</p><h2>Layout</h2><p>Based on the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x0JgW8UqGXvq\">Vertical and horizontal layout</a>, the quick search is placed:</p><ul><li>On the vertical layout, it is displayed right above the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</li><li>On the horizontal layout, it is displayed in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>, where it can be positioned just like any other icon.</li></ul><h2>Search Features</h2><p>Quick search includes the following features:</p><h3>Content Previews</h3><p>Search results now display a 200-character preview of the note content below the note title. This preview shows the context where your search terms appear, making it easier to identify the right note without opening it.</p><h3>All results in one list</h3><p>Quick search lists up to 200 matching notes in a single scrollable list, so the scrollbar shows how many results there are and how far through them you are.</p><h3>Continuing in the full search</h3><p>To refine a query with the options of the full <a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>, click <em>Show in full search</em> below the results, or press <kbd>Ctrl</kbd>+<kbd>Enter</kbd> in the search field. The full search opens in a new tab with the same query. The button stays below the list, however far the results are scrolled.</p><h3>Visual Features</h3><ul><li><strong>Highlighting</strong>: Search terms appear in bold with accent colors</li><li><strong>Separation</strong>: Results are separated with dividers</li><li><strong>Theme Support</strong>: Highlighting colors adapt to light/dark themes</li></ul><h3>Search Behavior</h3><p>Quick search uses progressive search:</p><ol><li>Shows exact matches first</li><li>Includes fuzzy matches when exact results are fewer than 5</li><li>Exact matches appear before fuzzy matches</li></ol><h3>Search Scope</h3><p>Quick search covers only the subtree you are currently working in:</p><ul><li>Without hoisting, it covers the whole note tree.</li><li>Under a <a href=\"#root/_help_OR8WJ7Iz9K4U\">hoisted note</a> or inside a <a href=\"#root/_help_9sRHySam5fXb\">workspace</a>, it covers only that subtree.</li><li>Notes that exist only in the hidden tree, such as the built-in help pages and the launch bar configuration, are not returned. Hoist into the help to search it, or use <a href=\"#root/_help_F1r9QtzQLZqm\">Jump to…</a>, which searches titles across the hidden tree.</li></ul><p>To search the whole database while hoisted, use the full&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>&nbsp;and leave <em>Ancestor</em> field empty.</p><h3>Keyboard Navigation</h3><ul><li>Press <kbd>Enter</kbd> in the search field to search, or to refresh the results already shown.</li><li>Press <kbd>Down</kbd> in the search field to move to the first result, then <kbd>Up</kbd> and <kbd>Down</kbd> to move between results. <kbd>Up</kbd> on the first result returns to the search field.</li><li>Press <kbd>Page Down</kbd> and <kbd>Page Up</kbd> to move through the results a page at a time.</li><li>Press <kbd>Enter</kbd> on a result to open it.</li><li>Press <kbd>Ctrl</kbd>+<kbd>Enter</kbd> to open the query in the full search.</li><li>Press <kbd>Escape</kbd> to close the results.</li></ul><p>To see these shortcuts on screen, click the <kbd>?</kbd> button below the results, or press <kbd>Alt</kbd>+<kbd>F1</kbd> while the search field is focused.</p><h2>Using Quick Search</h2><ol><li><strong>Typo tolerance</strong>: Search finds results despite minor typos</li><li><strong>Content previews</strong>: 200-character snippets show match context</li><li><strong>Specific terms</strong>: Specific search terms return more focused results</li><li><strong>Match locations</strong>: Bold text indicates where matches occur</li></ol><h2>Quick Search - Exact Match Operator</h2><p>Quick Search shares the same search engine as the full&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>, so the exact match operator (<code>=</code>) behaves identically in both. Start your query with <code>=</code> (no space after it) to switch from the default \"contains\" behavior to exact whole-word or phrase matching.</p><p><strong>What</strong> <code>**=**</code> <strong>actually does:</strong> it finds notes where the title or content contains your term as a <strong>whole word or phrase</strong>, ignoring surrounding punctuation. It does <strong>not</strong> require the whole note to equal your term, and it does <strong>not</strong> do substring or fuzzy matching.</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>synchronize the database now</code></td><td>Yes</td><td>default search matches the substring</td></tr><tr><td><code>=sync</code></td><td><code>see (sync) mode</code></td><td>Yes</td><td><code>=</code> matches the whole word <code>sync</code>, punctuation ignored</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>=\"project plan\"</code></td><td><code>the (project plan) is ready to share</code></td><td>Yes</td><td>quote a multi-word phrase to match it exactly</td></tr></tbody></table></figure><p>The search is case- and diacritic-insensitive. For the complete explanation of the three matching modes, fuzzy operators and relevance ranking, see <a href=\"#root/_help_eIg8jdvaoNNd\">How search matches your text</a> in the full Search documentation.</p><h3>Limitations</h3><ul><li>The <code>=</code> operator must be at the very beginning of the search query.</li><li>A space immediately after <code>=</code> is treated as a regular search.</li><li>Multiple <code>=</code> operators (like <code>==example</code>) are treated as regular text search.</li></ul><h3>Related Features</h3><ul><li>For attribute, property, boolean and ordering queries, use the full <a href=\"#root/_help_eIg8jdvaoNNd\">Search</a> functionality.</li><li>For fuzzy matching (finding results despite typos), use the <code>~=</code> or <code>~*</code> operators in the full search.</li><li>For partial matches with wildcards, use operators like <code>*=*</code>, <code>=*</code>, or <code>*=</code> in the full search.</li></ul>",
++ "_help_F1r9QtzQLZqm": "<figure class=\"image image-style-align-center\"><img style=\"aspect-ratio:991/403;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Navigation/1_Jump%20to%20%26%20command%20palette_image.png\" width=\"991\" height=\"403\"></figure><h2>Jump to Note</h2><p>The <em>Jump to Note</em> function allows easy navigation between notes by searching for their title. In addition to that, it can also trigger a full search or create notes.</p><p>To enter the “Jump to” dialog:</p><ul><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>, press&nbsp;<span class=\"tn-icon bx bx-send\"></span> button.</li><li>Using the keyboard, press <kbd>Ctrl</kbd> + <kbd>J</kbd>.</li></ul><p>In addition to searching for notes, it is also possible to search for commands. See the dedicated section below for more information.</p><h3>Interaction</h3><ul><li>By default, when there is no text entered it will display the most recent notes.</li><li>Using the keyboard, use the up or down arrow keys to navigate between items. Press <kbd>Enter</kbd> to open the desired note.</li><li>If the note doesn't exist, it's possible to create it by typing the desired note title and selecting one of two options:<ul><li><em>Create note</em> places it in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_S0Fos78ZfcY7\">Note Inbox</a>: the note labelled <code>#inbox</code>, today's&nbsp;<a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a>&nbsp;if there is none, or the top level if there is no journal either. While hoisted into a&nbsp;<a class=\"reference-link\" href=\"#root/_help_9sRHySam5fXb\">Workspaces</a>, the workspace's own inbox is used, then today's day note if the workspace has a <code>#workspaceCalendarRoot</code>, otherwise the workspace root itself. The option names the destination, so it is always visible before the note is created.</li><li><em>Create child note</em> places it under the note that is currently open.</li></ul></li><li>When the title search does not find a note, the bar below the results offers two ways to search further. It stays below the list, however far the results are scrolled. Both are hidden while the field is empty or lists commands.<ul><li>The <em>Include note contents</em> switch searches the content of the notes as well as their titles, and lists what it finds in place of the current results, without leaving the dialog. It stays on while the query changes, until it is switched off. Press <kbd>Shift</kbd>+<kbd>Enter</kbd> to switch it from the keyboard.</li><li><em>Show in full search</em> opens the query in the full <a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>, in a new tab, where its options can refine it. Press <kbd>Ctrl</kbd>+<kbd>Enter</kbd> to run it from the keyboard.</li></ul></li><li>To see the keys the results answer to, click the <kbd>?</kbd> button below the results, or press <kbd>Alt</kbd>+<kbd>F1</kbd> while the search field is focused.</li><li>On a wide enough desktop window, the note highlighted in the results is previewed on their right: its path, title, attributes and the start of its content. The preview follows the highlight as it moves through the results, and is left out for the command palette.</li><li>The options to create a note are listed after the notes. When no note matches, the list says so above them. <kbd>Enter</kbd> opens the note that matches best, or creates the note when none matches. Otherwise, press <kbd>↑</kbd> from the first note to reach the options to create a note.</li></ul><h2>Recent notes</h2><p>Jump to note also has the ability to show the list of recently viewed / edited notes and quickly jump to it.</p><p>To access this functionality, click on <code>Jump to</code> button on the top. By default, (when nothing is entered into autocomplete), this dialog will show the list of recent notes.</p><p>The recent notes are grouped by when they were last visited: <em>Today</em>, <em>Yesterday</em>, <em>Past 7 days</em>, <em>Past 30 days</em> and <em>Older</em>. The same list, with the same groups, opens in any note field that is focused while empty.</p><h2>Command Palette</h2><figure class=\"image image-style-align-center\"><img style=\"aspect-ratio:982/524;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Navigation/Jump%20to%20%26%20command%20palette_image.png\" width=\"982\" height=\"524\"></figure><p>The command palette is a feature which allows easy execution of various commands that can be found throughout the application, such as from menus or keyboard shortcuts. This feature integrates directly into the “Jump to” dialog.</p><h3>Interaction</h3><p>To trigger the command palette:</p><ul><li>Press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>J</kbd> to display the command palette directly.</li><li>If in the “Jump to” dialog, type <code>&gt;</code> in the search to switch to the command palette.</li></ul><p>Interaction:</p><ul><li>Type a few words to filter between commands.</li><li>Use the up and down arrows on the keyboard or the mouse to select a command.</li><li>Press <kbd>Enter</kbd> to execute the command.</li></ul><p>To exit the command palette:</p><ul><li>Remove the <code>&gt;</code> in the search to go back to the note search.</li><li>Press <kbd>Esc</kbd> to dismiss the dialog entirely.</li></ul><h3>Options available</h3><p>Currently the following options are displayed:</p><ul><li>Most of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_A9Oc6YKKc65v\">Keyboard Shortcuts</a>&nbsp;have an entry, with the exception of those that are too specific to be run from a dialog.</li><li>Some additional options which are not yet available as keyboard shortcuts, but can be accessed from various menus such as: exporting a note, showing attachments, searching for notes or configuring the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</li></ul><h3>Limitations</h3><p>Currently it's not possible to define custom actions that are displayed in the command palette. In the future this might change by integrating the options in the launch bar, which can be customized if needed.</p>",
++ "_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>&nbsp;which can be found in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>&nbsp;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>&nbsp;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&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>&nbsp;view (e.g. grid, list, calendar, table).</li></ul></li><li>Some&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>&nbsp;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&nbsp;<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&nbsp;<a class=\"reference-link\" href=\"#root/_help_YtSN43OrfzaA\">Note tree contextual menu</a>&nbsp;or press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>S</kbd>.</li><li>Go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_F1r9QtzQLZqm\">Jump to &amp; 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&nbsp;<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> buttons, 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 &amp; Execute actions</em> (<span class=\"tn-icon bx bxs-zap\"></span>) button 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>) button will create a new note with the search configuration. For more information, see&nbsp;<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><h3>Error highlighting &amp; 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&nbsp;<a class=\"reference-link\" href=\"#root/_help_Ms1nauBra7gq\">Quick search</a>&nbsp;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 on which search option to apply from the <em>Add search option</em> section.</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&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;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>&nbsp;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&nbsp;<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><li><span class=\"tn-icon bx bxs-zap\"></span> Action<ol><li>Apart from just searching, it is also possible to apply actions such as to add a label or a relation to the notes that have been matched by the search.</li><li>Unlike other search configurations, here it's possible to apply the same action multiple times (i.e. in order to be able to apply multiple labels to notes).</li><li>The actions given are the same as the ones in&nbsp;<a class=\"reference-link\" href=\"#root/_help_ivYnonVFBxbQ\">Bulk Actions</a>, which is an alternative for operating directly with notes within the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</li><li>After defining the actions, first press <em>Search</em> to check the matched notes and then press <em>Search &amp; Execute actions</em> to trigger the actions.</li></ol></li></ol><h2>Viewing search results</h2><p>Results appear below the search pane as a list of <strong>snippet cards</strong>. Each card shows the note title and a short excerpt of the text that matched.</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:&nbsp;</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</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.</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></ul><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 &gt;= 1950 #publicationYear &lt; 1960</code>: Use numeric operators to find all books published in the 1950s.</li><li><code>#dateNote &gt;= 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 &gt;= 1954 AND #publicationDate &lt;= 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&nbsp;<a class=\"reference-link\" href=\"#root/_help_Oxyb6jOjjVNL\">Under the hood</a>&nbsp;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 &gt;= 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&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>&nbsp;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&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>&nbsp;configuration from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;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 and assign it the <code>#bookmarkFolder</code> label.</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 sub-menus.</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><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&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;to the newly selected note, or navigating between two different&nbsp;<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&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>&nbsp;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&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>.</li><li>Note that the&nbsp;<a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a>&nbsp;will not be displayed, except for notes of type&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>.</li><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes, depending on user preference, both the floating and classic editors are supported. See&nbsp;<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&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;are also displayed.<ul><li>This integrates well with&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>&nbsp;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&nbsp;<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&nbsp;<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&nbsp;<a class=\"reference-link\" href=\"#root/_help_lgKX7r3aL30x\">Note Tooltip</a>, press the quick edit icon.</li><li>In&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>:<ul><li>For&nbsp;<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&nbsp;<a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a>&nbsp;root, clicking on the day number will open the popup for that day note.</li></ul></li><li>For&nbsp;<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&nbsp;<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>",
- "_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:&nbsp;</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Navigation/1_Workspaces_image.jpg\"></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>\n<thead>\n<tr>\n<th>Label</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code spellcheck=\"false\">workspace</code></td>\n<td>Marks this note as a workspace, button to enter the workspace is controlled by this</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">workspaceIconClass</code></td>\n<td>defines box icon CSS class which will be used in tab when hoisted to this note</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">workspaceTabBackgroundColor</code></td>\n<td>CSS color used in the note tab when hoisted to this note, 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>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">workspaceCalendarRoot</code></td>\n<td>Marking a note with this label will define a new per-workspace calendar for&nbsp;<a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a>. If there's no such note, the global calendar will be used.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">workspaceTemplate</code></td>\n<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>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">workspaceSearchHome</code></td>\n<td>new search notes will be created as children of this note when hoisted to some ancestor of this workspace note</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">workspaceInbox</code></td>\n<td>Default inbox location for new notes when hoisted to some ancestor of this workspace note. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_S0Fos78ZfcY7\">Note Inbox</a>&nbsp;for more information.</td>\n</tr>\n</tbody></table></figure>",
- "_help_xWtq5NUHOwql": "<figure class=\"image image-style-align-right image_resized\" style=\"width:50.46%;\"><img style=\"aspect-ratio:538/290;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Navigation/Similar%20Notes_image.png\" width=\"538\" height=\"290\"></figure><p>The Similar Notes feature tries to identify notes that relate to the current note by looking at the content of the notes, their relationships, as well as the date they were created.</p><p>To access the list of similar notes:</p><ul><li>On the&nbsp;<a class=\"reference-link\" href=\"#root/_help_IjZS7iK5EXtb\">New Layout</a>, go to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_KRlZFoIH0j6p\">Connections tab</a>&nbsp;in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>&nbsp;and look for the corresponding section.</li><li>On the old layout, press the <em>Similar Notes</em> tab in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_BlN9DFI679QC\">Ribbon</a>.</li></ul><h2>Interaction</h2><ul><li>Hover over a note to see a short preview of the note.</li><li>Click over a note to open it in the current view.</li><li><kbd>Ctrl</kbd> + click a note to open it in a separate tab.</li></ul>",
- "_help_McngOG2jbUWX": "<figure class=\"image image_resized\" style=\"width:100%;\"><img style=\"aspect-ratio:898/93;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Navigation/Search%20in%20note_image.png\" width=\"898\" height=\"93\"></figure><p>Local search allows you to search within the currently displayed note.&nbsp;</p><h2>Alternatives</h2><ul><li>Pressing Ctrl+F while in a browser while not focused in a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;or a&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note will trigger the browser's native search. This will also find text that is part of Trilium's UI.</li><li>Pressing Ctrl+F in a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;note will reveal&nbsp;<a class=\"reference-link\" href=\"#root/_help_MI26XDLSAlCD\">CKEditor</a>'s search functionality.</li></ul><h2>Accessing the search</h2><ul><li>On desktop, press<kbd>Ctrl</kbd> + <kbd>F</kbd></li><li>From the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note buttons</a>, look for the context menu and select <em>Search in note</em>.</li></ul><h2>Interaction</h2><ul><li>Finding:<ul><li>Fill in the <em>Find in text…</em> with the text to search for.</li><li>The search will be executed automatically in the background.</li><li>Use up and down arrows of the text box to navigate between results.</li></ul></li><li>Replacing:<ul><li>Fill in the <em>Find in text</em>… field with the text to replace.</li><li>Fill in the <em>Replace with…</em> field the text to replace it with.</li><li>Press <em>Replace</em> to replace only the current result.</li><li>Press <em>Replace all</em> to replace all of them at once.</li></ul></li><li>Options:<ul><li><em>Case sensitive</em> – the search will distinguish upper case characters from lower case (e.g. searching for Hello will not match <code spellcheck=\"false\">hello</code>).</li><li><em>Match words</em> - the search will find only exact word matches (e.g. searching for <code spellcheck=\"false\">Java</code> will not match <code spellcheck=\"false\">JavaScript</code>).</li></ul></li></ul>",
- "_help_A9Oc6YKKc65v": "<p>This is supposed to be a complete list of keyboard shortcuts. Note that some of these may work only in certain contexts (e.g. in tree pane or note editor).</p><p>It is also possible to configure most keyboard shortcuts in Options -&gt; Keyboard shortcuts. Using <code spellcheck=\"false\">global:</code> prefix, you can assign a shortcut which will work even without Trilium being in focus (requires app restart to take effect).</p><h2>Tree</h2><p>See the corresponding section:&nbsp;<a class=\"reference-link\" href=\"#root/_help_DvdZhoQZY9Yd\">Keyboard shortcuts</a></p><h2>Note navigation</h2><ul><li><kbd>Alt</kbd> + <kbd><span>←</span></kbd>, <kbd>Alt</kbd> + <kbd><span>→</span></kbd> – go back / forwards in the history</li><li><kbd>Ctrl</kbd> + <kbd>J</kbd> – show <a href=\"#root/_help_MMiBEQljMQh2\">\"Jump to\" dialog</a></li><li><kbd>Ctrl</kbd> + <kbd>.</kbd> – scroll to current note (useful when you scroll away from your note or your focus is currently in the editor)</li><li><kbd><span>Backspace</span></kbd> – jumps to parent note</li><li><kbd>Alt</kbd> + <kbd>C</kbd> – collapse whole note tree</li><li><kbd>Alt</kbd> + <kbd>-</kbd> (alt with minus sign) – collapse subtree (if some subtree takes too much space on tree pane you can collapse it)</li><li>you can define a <a href=\"#root/_help_zEY4DaJG4YT5\">label</a> <code spellcheck=\"false\">#keyboardShortcut</code> with e.g. value <kbd>Ctrl</kbd> + <kbd>I</kbd> . Pressing this keyboard combination will then bring you to the note on which it is defined. Note that Trilium must be reloaded/restarted (<kbd>Ctrl</kbd> + <kbd>R</kbd> ) for changes to be in effect.</li></ul><p>See demo of some of these features in <a href=\"#root/_help_MMiBEQljMQh2\">note navigation</a>.</p><h2>Tabs</h2><ul><li><kbd>Ctrl</kbd> + <kbd>🖱 Left click</kbd> – (or middle mouse click) on note link opens note in a new tab</li></ul><p>Only in desktop (electron build):</p><ul><li><kbd>Ctrl</kbd> + <kbd>T</kbd> – opens empty tab</li><li><kbd>Ctrl</kbd> + <kbd>W</kbd> – closes active tab</li><li><kbd>Ctrl</kbd> + <kbd>Tab</kbd> – activates next tab</li><li><kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>Tab</kbd> – activates previous tab</li></ul><h2>Creating notes</h2><ul><li><kbd>CTRL</kbd>+<kbd>O</kbd> – creates new note after the current note</li><li><kbd>CTRL</kbd>+<kbd>P</kbd> – creates new sub-note into current note</li><li><kbd>F2</kbd> – edit&nbsp;<a class=\"reference-link\" href=\"#root/_help_TBwsyfadTA18\">Branch prefix</a>&nbsp;of current note clone</li></ul><h2>Editing notes</h2><aside class=\"admonition note\"><p>For keyboard shortcuts specific to&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes, refer to&nbsp;<a class=\"reference-link\" href=\"#root/_help_oiVPnW8QfnvS\">Keyboard shortcuts</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_QrtTYPmdd1qq\">Markdown-like formatting</a>.</p></aside><ul><li><kbd>Enter</kbd> in tree pane switches from tree pane into note title. Enter from note title switches focus to text editor. <kbd>Ctrl</kbd>+<kbd>.</kbd> switches back from editor to tree pane.</li><li><kbd>Ctrl</kbd>+<kbd>.</kbd> – jump away from the editor to tree pane and scroll to current note</li></ul><h2>Runtime shortcuts</h2><p>These are hooked in Electron to be similar to native browser keyboard shortcuts.</p><ul><li><kbd>F5</kbd>, <kbd>Ctrl</kbd>+<kbd>R</kbd> – reloads Trilium front-end</li><li><kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd> – show developer tools</li><li><kbd>Ctrl</kbd>+<kbd>F</kbd> – show search dialog</li><li><kbd>Ctrl</kbd>+<kbd>-</kbd> – zoom out</li><li><kbd>Ctrl</kbd>+<kbd>=</kbd> – zoom in</li></ul><h2>Other</h2><ul><li><kbd>Alt</kbd> + <kbd>O</kbd> – show SQL console (use only if you know what you're doing)</li><li><kbd>Alt</kbd> + <kbd>M</kbd> – distraction-free mode - display only note editor, everything else is hidden</li><li><kbd>F11</kbd> – toggle full screen</li><li><kbd>Ctrl</kbd> + <kbd>S</kbd> – toggle <a href=\"#root/_help_eIg8jdvaoNNd\">search</a> form in tree pane</li><li><kbd>Alt</kbd> +<kbd>A</kbd> – show note <a href=\"#root/_help_zEY4DaJG4YT5\">attributes</a> dialog</li></ul>",
- "_help_Wy267RK4M69c": "<h2>Default Themes</h2><p>Trilium comes with a couple pre-installed color themes, with the default being a light theme. To switch to a dark theme or any other available theme, navigate to the Options menu (accessible via the app icon in the top-left corner), select the Appearance tab, and choose your preferred theme.</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Themes_dark-theme.png\" alt=\"Dark Theme\"></p><h2>Creating Custom CSS Themes</h2><p>Trilium supports custom user themes, allowing you to personalize the application's appearance. To create a custom theme, follow these steps:</p><ol><li><strong>Create a CSS Code Note</strong>: Start by creating a new <a href=\"#root/_help_6f9hih2hXXZk\">code note</a> with the <code spellcheck=\"false\">CSS</code> type.</li><li><strong>Annotate with</strong> <code spellcheck=\"false\">#appTheme</code>: Add the <a href=\"#root/_help_zEY4DaJG4YT5\">attribute</a> <code spellcheck=\"false\">#appTheme=my-theme-name</code> to your note, where <code spellcheck=\"false\">my-theme-name</code> is the name of your custom theme.</li><li><strong>Define Your Styles</strong>: Write your custom CSS within the note. Below is an example of a custom theme:</li></ol><pre><code class=\"language-text-x-trilium-auto\">@font-face {\n font-family: 'Raleway';\n font-style: normal;\n font-weight: 400;\n src: url('/custom/fonts/raleway.woff2') format('woff2');\n}\n\n:root {\n --main-font-family: 'Raleway' !important;\n --main-font-size: normal;\n --tree-font-family: inherit;\n --tree-font-size: normal;\n --detail-font-family: inherit;\n --detail-font-size: normal;\n --detail-text-font-family: 'Garamond' !important;\n\n --main-background-color: #404552;\n --main-text-color: #AFB8C6;\n --main-border-color: #AFB8C6;\n --accented-background-color: #383C4A;\n --more-accented-background-color: #2F343F;\n --header-background-color: #383C4A;\n --button-background-color: #2F343F;\n --button-disabled-background-color: #404552;\n --button-border-color: #333;\n --button-text-color: #AFB8C6;\n --button-border-radius: 2px;\n --primary-button-background-color: #6c757d;\n --primary-button-text-color: white;\n --primary-button-border-color: #6c757d;\n --muted-text-color: #86919F;\n --input-text-color: #AFB8C6;\n --input-background-color: #404552;\n --hover-item-text-color: white;\n --hover-item-background-color: #4877B1;\n --active-item-text-color: white;\n --active-item-background-color: #4877B1;\n --menu-text-color: #AFB8C6;\n --menu-background-color: #383C4A;\n --tooltip-background-color: #383C4A;\n --link-color: lightskyblue;\n --modal-background-color: #404552;\n --modal-backdrop-color: black;\n --scrollbar-border-color: rgba(175, 184, 198, 0.5);\n}\n\nbody .note-detail-text {\n font-size: 120%;\n}\n\nbody .CodeMirror {\n filter: invert(100%) hue-rotate(180deg);\n}</code></pre><h3>Activating Your Custom Theme</h3><p>Once you've created your custom theme:</p><ol><li>Go to \"Menu\" -&gt; \"Options\" -&gt; \"Appearance.\"</li><li>In the theme selection dropdown, you should see your custom theme listed under the name you provided with the <code spellcheck=\"false\">#appTheme</code> <a href=\"#root/_help_zEY4DaJG4YT5\">label</a>.</li><li>Select your custom theme to activate it.</li></ol><p>If you make changes to your theme, press <kbd>Ctrl</kbd> + <kbd>R</kbd> to reload the frontend and apply your updates.</p><h3>Sharing and Importing Themes</h3><p>Custom themes can be exported as <code spellcheck=\"false\">.tar</code> archives, which can be shared with other users. However, be cautious when importing themes from untrusted sources, as they may contain executable scripts that could pose security risks.</p><p>An example user theme, <em>Steel Blue</em>, is available in the demo document.</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Themes_steel-blue.png\" alt=\"Steel Blue Theme\"></p><h3>Using Custom CSS for Specific Purposes</h3><p>In addition to full themes, Trilium allows for custom CSS that isn't tied to a theme. This can be particularly useful in scripting contexts, where you might want to modify specific UI elements, such as changing the colors of notes in the tree view.</p><h3>Applying Custom CSS</h3><p>To use custom CSS:</p><ol><li><strong>Create a CSS Code Note</strong>: Create a new&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note with the <code spellcheck=\"false\">CSS</code> type.</li><li><strong>Add the</strong> <code spellcheck=\"false\">appCss</code> <strong>Label</strong>: Annotate the note with the <code spellcheck=\"false\">#appCss</code> <a href=\"#root/_help_zEY4DaJG4YT5\">label</a>.</li><li><strong>Write Your CSS</strong>: Add your custom CSS rules to the note.</li></ol><p>For example:</p><pre><code class=\"language-text-x-trilium-auto\">/* Custom CSS to style specific elements */\n.tree-item {\n color: #ff6347; /* Change tree item color */\n}</code></pre><p>When Trilium's frontend starts, all notes labeled with <code spellcheck=\"false\">appCss</code> are automatically included in the style element of the HTML page.</p><p>After making changes, press <kbd>Ctrl</kbd> + <kbd>R</kbd> to reload the frontend and apply your new styles.</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Themes_image.jpg\"></p><h3>Styling Specific Notes in the Tree</h3><p>To apply specific styles to certain notes in the tree:</p><ul><li><strong>Use the</strong> <code spellcheck=\"false\">cssClass</code> <strong>Attribute</strong>: Add the <code spellcheck=\"false\">cssClass</code> <a href=\"#root/_help_zEY4DaJG4YT5\">attribute</a> to a note, and assign it a value representing the desired CSS class.</li><li><strong>Define an</strong> <code spellcheck=\"false\">iconClass</code>: You can also define a custom icon for a note using the <code spellcheck=\"false\">iconClass</code> attribute, selecting from <a href=\"https://boxicons.com\">Box Icons</a> or your own custom classes.</li></ul><p>For example, if you want to style notes of a specific type, such as notes containing PNG images, you can target them with classes like <code spellcheck=\"false\">type-image mime-image-png</code>.</p><h3>User-Provided Themes</h3><p>A gallery of user-created themes is available, showcasing the variety of customizations that the Trilium community has developed. For more information, check the&nbsp;<a class=\"reference-link\" href=\"#root/_help_VbjZvtUek0Ln\">Theme Gallery</a>.</p><h3>Asset Path Management</h3><p>When referencing built-in assets like images in your custom themes or CSS, you can avoid hardcoding version numbers by using the <code spellcheck=\"false\">vX</code> alias. For example, instead of specifying <code spellcheck=\"false\">/assets/v0.57.0-beta/images/icon-grey.png</code>, you can use <code spellcheck=\"false\">/assets/vX/images/icon-grey.png</code> to keep your theme compatible with future versions of Trilium.</p>",
- "_help_VbjZvtUek0Ln": "<p>These are user-created themes which were made publicly available:</p><h2>Legacy Themes</h2><p>These themes may or may not be compatible with the latest versions of TriliumNext and are based on the original/legacy theme.</p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Theme</th>\n<th>Author</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><a href=\"https://github.com/tobealive/trilium-midnight-theme\">Midnight</a></td>\n<td><a href=\"https://github.com/tobealive\">tobealive</a></td>\n</tr>\n<tr>\n<td><a href=\"https://github.com/tobealive/trilum-eote-theme\">EOTE</a></td>\n<td><a href=\"https://github.com/tobealive\">tobealive</a></td>\n</tr>\n<tr>\n<td><a href=\"https://github.com/Abourass/TriliumThemes\">Trilium Themes</a></td>\n<td><a href=\"https://github.com/Abourass\">Abourass</a></td>\n</tr>\n<tr>\n<td><a href=\"https://github.com/ZMonk91/Material-Dark-Trilium\">MaterialDark</a></td>\n<td><a href=\"https://github.com/ZMonk91\">ZMonk91</a></td>\n</tr>\n<tr>\n<td><a href=\"https://github.com/jaroet/trilium-theme-lightslategray\">lightslategray</a></td>\n<td><a href=\"https://github.com/jaroet\">jaroet</a></td>\n</tr>\n<tr>\n<td><a href=\"https://github.com/raphwriter/trilium-theme-melon\">melon-4</a></td>\n<td><a href=\"https://github.com/raphwriter\">raphwriter</a></td>\n</tr>\n<tr>\n<td><a href=\"https://github.com/Engr-AllanG/trilium-themes\">Neon_Dark</a></td>\n<td><a href=\"https://github.com/Engr-AllanG\">Engr-AllanG</a></td>\n</tr>\n<tr>\n<td><a href=\"https://github.com/Engr-AllanG/trilium-themes\">Coder_Dark</a></td>\n<td><a href=\"https://github.com/Engr-AllanG\">Engr-AllanG</a></td>\n</tr>\n<tr>\n<td><a href=\"https://github.com/idelem/trilium-theme-velvet\">velvet</a></td>\n<td><a href=\"https://github.com/idelem\">idelem</a></td>\n</tr>\n<tr>\n<td><a href=\"https://github.com/SADAVA/trilium-notes-theme-dark-plus\">Dark Plus</a></td>\n<td><a href=\"https://github.com/SADAVA\">SADAVA</a></td>\n</tr>\n<tr>\n<td><a href=\"https://github.com/WKSu/trilium-solarized-theme\">Solarized</a></td>\n<td><a href=\"https://github.com/WKSu\">WKSu</a></td>\n</tr>\n<tr>\n<td><a href=\"https://github.com/en3r0/Trilium-Nord-Theme\">Nord</a></td>\n<td><a href=\"https://github.com/en3r0\">en3r0</a></td>\n</tr>\n<tr>\n<td><a href=\"https://github.com/AllanZyne/trilium-bear-theme\">Bear Note Light</a></td>\n<td><a href=\"https://github.com/AllanZyne\">AllanZyne</a></td>\n</tr>\n<tr>\n<td><a href=\"https://github.com/AllanZyne/trilium-bear-theme\">Bear Note Dark</a></td>\n<td><a href=\"https://github.com/AllanZyne\">AllanZyne</a></td>\n</tr>\n<tr>\n<td><a href=\"https://github.com/Sebiann/miku-hatsune-trilium-theme\">Miku Hatsune</a></td>\n<td><a href=\"https://github.com/Sebiann\">Sebiann</a></td>\n</tr>\n<tr>\n<td><a href=\"https://github.com/cwilliams5/Midnight-Trilium-Dark-Mode\">Midnight</a></td>\n<td><a href=\"https://github.com/cwilliams5\">cwilliams5</a></td>\n</tr>\n<tr>\n<td><a href=\"https://github.com/SiriusXT/trilium-theme-blue\">Blue</a> (light)</td>\n<td><a href=\"https://github.com/SiriusXT\">SiriusXT</a></td>\n</tr>\n<tr>\n<td><a href=\"https://github.com/SiriusXT/trilium-theme-blue\">Blue</a> (dark)</td>\n<td><a href=\"https://github.com/SiriusXT\">SiriusXT</a></td>\n</tr>\n</tbody></table></figure><aside class=\"admonition tip\"><p>If you would like to add your theme to this gallery, write a new post in <a href=\"https://github.com/TriliumNext/Trilium/discussions/categories/show-and-tell\">👐 Show and tell</a>.</p></aside>",
- "_help_gOKqSJgXLcIj": "<figure class=\"image image-style-align-right image_resized\" style=\"width:45.14%;\"><img style=\"aspect-ratio:854/649;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Themes/Icon%20Packs_image.png\" width=\"854\" height=\"649\"></figure><p>By default, Trilium comes with a set of icons called Boxicons v2. Since v0.102.0, custom icon packs allow a wider selection of icons for notes.</p><p>Icon packs are specific to Trilium, so they must either be created from scratch (see below) or imported from a ZIP file from a third-party developer.</p><h2>Sample icon packs</h2><p>The Trilium team maintains a few icon packs that are not shipped with Trilium. These icon packs can be found on the official website on the <a href=\"https://triliumnotes.org/resources\">Resources page</a>.</p><h2>Importing an existing icon pack</h2><aside class=\"admonition note\"><p><strong>Icon packs are third-party content</strong></p><p>Apart from the <a href=\"https://triliumnotes.org/resources\">sample icon packs</a>, the Trilium maintainers are not responsible for keeping icon packs up to date. If you have an issue with a specific icon pack, then the issue must be reported to the third-party developer responsible for it, not the Trilium team.</p></aside><p>To import an icon pack:</p><ol><li>Ideally, create a dedicated spot in your note tree where to place the icon packs.</li><li>Right click the note where to put it and select <em>Import into note</em>.</li><li>Uncheck <em>Safe import</em>.</li><li>Select <em>Import</em>.</li><li><a href=\"#root/_help_s8alTXmpFR61\">Refresh the application</a>.</li></ol><aside class=\"admonition warning\"><p>Since <em>Safe import</em> is disabled, make sure you trust the source as it could contain dangerous third-party scripts. One good way to check if the icon pack is safe is to manually extract the .zip and inspect the file contents. Icon packs should only contain a font file and a JSON file. Other files (especially scripts) are to be considered harmful.</p></aside><h2>Creating an icon pack</h2><p>Creating an icon pack requires some scripting knowledge outside Trilium in order to generate the list of icons. For information, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_g1mlRoU8CsqC\">Creating an icon pack</a>.</p><h2>Using an icon from an icon pack</h2><p>After <a href=\"#root/_help_s8alTXmpFR61\">refreshing the application</a>, the icon pack should be enabled by default. To test this, simply select an existing note or create a new one and try to change the note icon.</p><p>There should be a <em>Filter</em> button to the right of the search bar in the icon list. Clicking it allows filtering by icon pack and the newly imported icon pack should be displayed there.</p><aside class=\"admonition note\"><p>If the icon pack is missing from that list, then most likely there's something wrong with it.</p><ul><li>Try checking the&nbsp;<a class=\"reference-link\" href=\"#root/_help_bnyigUA2UK7s\">Backend (server) logs</a>&nbsp;for clues and make sure that the icon pack has the <code spellcheck=\"false\">#iconPack</code> <a href=\"#root/_help_HI6GBBIduIgv\">label</a> with a value assigned to it (a prefix).</li><li>Icon packs that are <a href=\"#root/_help_bwg0e8ewQMak\">protected</a> are ignored.</li></ul></aside><h2>Integration with the share and export functionality</h2><p>Custom icon packs are also supported by the&nbsp;<a class=\"reference-link\" href=\"#root/_help_R9pX4DGra2Vt\">Sharing</a>&nbsp;feature, where they will be shown in the note tree. However, in order for an icon pack to be visible to the share function, the icon pack note must also be shared.</p><p>If you are using a custom share theme, make sure it supports the <code spellcheck=\"false\">iconPackCss</code>, otherwise icons will not show up. Check the original share template source code for reference.</p><p>Custom icon packs will also be preserved when&nbsp;<a class=\"reference-link\" href=\"#root/_help_ycBFjKrrwE9p\">Exporting static HTML for web publishing</a>. In this case, there's no requirement to make the icon pack shared.</p><h2>What happens if I remove an icon pack</h2><p>If an icon pack is removed or disabled (by removing or altering its <code spellcheck=\"false\">#iconPack</code> label), all the notes that use this icon pack will show in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;with no icon. This won't cause any issues apart from looking strange.</p><p>The solution is to replace the icons with some else, try using&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>&nbsp;which supports bulk actions, to identify the notes with the now deleted icon pack (by looking for the prefix) and changing or removing their <code spellcheck=\"false\">iconClass</code>.</p>",
- "_help_mHbBMPDPkVV5": "<p>Trilium natively supports the following formats for both import and export.</p><h2>Supported formats</h2><ul><li>HTML:<ul><li>This is the main format used by Trilium, where standard tags are used to represent basic formatting and layout (e.g. <code spellcheck=\"false\">&lt;strong&gt;</code>, <code spellcheck=\"false\">&lt;table&gt;</code>, <code spellcheck=\"false\">&lt;pre&gt;</code>).</li><li>Note that HTML is not a standardized format so some more specific features such as admonitions or&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;might not be supported by other applications.</li><li>The notes can also be exported as <a href=\"#root/_help_ycBFjKrrwE9p\">static HTML that can be used for web publishing</a>.</li></ul></li><li><a class=\"reference-link\" href=\"#root/_help_Oau6X9rCuegd\">Markdown</a><ul><li>Most of the formatting is preserved, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_rJ9grSgoExl9\">Supported syntax</a>.</li></ul></li><li>OPML (Outliner Interchange Format)<ul><li>Supports both OPML v1.0 for plain text and v2.0 with HTML support.</li></ul></li></ul><p>To import from other applications such as OneNote, Notion and others, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_ckZ2uNWQmVeX\">Importing data from other applications</a>.</p><h2>Maximum import size</h2><p>Versions prior to v0.104.0 had an upload limit of 250 MiB that could be bypassed via a <code spellcheck=\"false\">TRILIUM_NO_UPLOAD_LIMIT</code> environment variable; with v0.104.0 this limit was removed.</p><p>Nevertheless, there is still a limit for the maximum size of a <strong>single item</strong> (whether it's a&nbsp;<a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a>, an&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>&nbsp;or even a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;note). The limit is approximately 374 MiB and it's determined by the&nbsp;<a class=\"reference-link\" href=\"#root/_help_cbkrhQjrkKrh\">Synchronization</a>&nbsp;protocol. Attempts to import such large files will be refused.</p><p>During large imports or exports, memory consumption might spike but it will remain somewhere around the 2 gigabyte mark. Tested with a 2.4 GB database with ~21k notes.</p><aside class=\"admonition important\"><p>For the&nbsp;<a class=\"reference-link\" href=\"#root/_help_poXkQfguuA0U\">Desktop Installation</a>, there are two distinct import mechanisms:</p><ul><li>A quick import, from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</li><li>The import dialog (via right click in the note tree → <em>Import into note</em> or from&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note buttons</a>).</li></ul><p>When dealing with large files (multi-gigabyte), prefer using the import dialog as it has a special mechanism which makes sure that the file is read directly from disk rather than uploaded again.</p></aside><h2>Exporting the root note</h2><p>The root note is the top-most note. Exporting it behaves just like any other note: right click on it in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and select <em>Export</em>.</p><p>Starting with v0.104.0, when a root note is imported, it will be imported as a child of your existing root note. This behavior makes sure that the import cannot change or overwrite your existing notes.</p><p>You can easily move the notes onto the root using the tree's&nbsp;<a class=\"reference-link\" href=\"#root/_help_yTjUdsOi4CIE\">Multiple selection</a>&nbsp;and delete the redundant root note.</p><table>\n <thead>\n <tr>\n <th scope=\"col\">Before</th>\n <th scope=\"col\">After</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td><ul><li>root<ul><li>one</li><li>two</li></ul></li></ul></td>\n <td><ul><li>root (existing)<ul><li>root (from import)<ul><li>one</li><li>two</li></ul></li></ul></li></ul></td>\n </tr>\n </tbody>\n</table><aside class=\"admonition tip\"><p>Instead of exporting full ZIPs (including the root note), consider using <a href=\"#root/_help_ODY7qQn5m2FT\">backups</a> instead. Backups always contain the entire structure, as well as additional information a ZIP export does not have: maintains note IDs, contains the options/tokens and handle&nbsp;<a class=\"reference-link\" href=\"#root/_help_bwg0e8ewQMak\">Protected Notes</a>&nbsp;better.</p></aside>",
++ "_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&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;to the newly selected note, or navigating between two different&nbsp;<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&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>&nbsp;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&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>.</li><li>Note that the&nbsp;<a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a>&nbsp;will not be displayed, except for notes of type&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>.</li><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes, depending on user preference, both the floating and classic editors are supported. See&nbsp;<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>Search in note</em>, <em>Note map</em>, <em>Full width</em> and <em>Convert into attachment</em>.</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&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;are also displayed.<ul><li>This integrates well with&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>&nbsp;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&nbsp;<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&nbsp;<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&nbsp;<a class=\"reference-link\" href=\"#root/_help_lgKX7r3aL30x\">Note Tooltip</a>, press the quick edit icon.</li><li>In&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>:<ul><li>For&nbsp;<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&nbsp;<a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a>&nbsp;root, clicking on the day number will open the popup for that day note.</li></ul></li><li>For&nbsp;<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&nbsp;<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>",
++ "_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:&nbsp;</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Navigation/1_Workspaces_image.jpg\"></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</td></tr><tr><td><code>workspaceTabBackgroundColor</code></td><td>CSS color used in the note tab when hoisted to this note, 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&nbsp;<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&nbsp;<a class=\"reference-link\" href=\"#root/_help_S0Fos78ZfcY7\">Note Inbox</a>&nbsp;for more information.</td></tr></tbody></table></figure>",
++ "_help_xWtq5NUHOwql": "<figure class=\"image image-style-align-right image_resized\" style=\"width:50.46%;\"><img style=\"aspect-ratio:538/290;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Navigation/Similar%20Notes_image.png\" width=\"538\" height=\"290\"></figure><p>The Similar Notes feature tries to identify notes that relate to the current note by looking at the content of the notes, their relationships, as well as the date they were created.</p><p>To access the list of similar notes:</p><ul><li>Go to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_KRlZFoIH0j6p\">Connections tab</a>&nbsp;in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>&nbsp;and look for the corresponding section.</li><li>Alternatively, press the&nbsp;<span class=\"tn-icon bx bx-info-circle\"></span> in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlJ73vBCjWDw\">Status bar</a>&nbsp;and select <em>Show similar notes</em> which will open a pane at the bottom.</li></ul><h2>Interaction</h2><ul><li>Hover over a note to see a short preview of the note.</li><li>Click over a note to open it in the current view.</li><li><kbd>Ctrl</kbd> + click a note to open it in a separate tab.</li></ul>",
++ "_help_McngOG2jbUWX": "<figure class=\"image image_resized\" style=\"width:100%;\"><img style=\"aspect-ratio:898/93;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Navigation/Search%20in%20note_image.png\" width=\"898\" height=\"93\"></figure><p>Local search allows you to search within the currently displayed note.&nbsp;</p><h2>Alternatives</h2><ul><li>Pressing <kbd>Ctrl</kbd>+<kbd>F</kbd> while in a browser while not focused in a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;or a&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note will trigger the browser's native search. This will also find text that is part of Trilium's UI.</li><li>Pressing <kbd>Ctrl</kbd>+<kbd>F</kbd> in a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;note will reveal&nbsp;<a class=\"reference-link\" href=\"#root/_help_MI26XDLSAlCD\">CKEditor</a>'s search functionality.</li></ul><h2>Accessing the search</h2><ul><li>On desktop, press<kbd>Ctrl</kbd> + <kbd>F</kbd>.</li><li>From the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>, look for the context menu and select <em>Search in note</em>.</li></ul><h2>Interaction</h2><ul><li>Finding:<ul><li>Fill in the <em>Find in text…</em> with the text to search for.</li><li>The search will be executed automatically in the background.</li><li>Use up and down arrows of the text box to navigate between results.</li></ul></li><li>Replacing:<ul><li>Fill in the <em>Find in text</em>… field with the text to replace.</li><li>Fill in the <em>Replace with…</em> field the text to replace it with.</li><li>Press <em>Replace</em> to replace only the current result.</li><li>Press <em>Replace all</em> to replace all of them at once.</li></ul></li><li>Options:<ul><li><em>Case sensitive</em> – the search will distinguish upper case characters from lower case (e.g. searching for Hello will not match <code>hello</code>).</li><li><em>Match words</em> - the search will find only exact word matches (e.g. searching for <code>Java</code> will not match <code>JavaScript</code>).</li></ul></li></ul>",
++ "_help_A9Oc6YKKc65v": "<p>This is supposed to be a complete list of keyboard shortcuts. Note that some of these may work only in certain contexts (e.g. in tree pane or note editor).</p><h2>Configuring keyboard shortcuts</h2><p>It is also possible to configure most keyboard shortcuts in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Shortcuts</em>.</p><p>On the&nbsp;<a class=\"reference-link\" href=\"#root/_help_poXkQfguuA0U\">Desktop Installation</a>, it's also possible to make shortcuts global by pressing on the globe icon near the key combination, which makes the shortcut work even without Trilium being in focus.</p><h3>Keyboard layouts</h3><p>Shortcuts follow the characters printed on the keys of the active keyboard layout. On a French AZERTY keyboard, for example, <kbd>Ctrl</kbd>+<kbd>Z</kbd> is the key labeled Z.</p><p>On a layout that doesn't type Latin letters, such as Russian, Greek or Hebrew, a key that types a letter of that alphabet counts as the key at the same position on a US QWERTY keyboard. <kbd>Ctrl</kbd>+<kbd>J</kbd> is then the key that types <code>о</code> on a Russian keyboard, so shortcuts keep working without switching the layout first.</p><p>Keys that type punctuation still follow their own character. On a Russian keyboard, the key that types <code>.</code> triggers <kbd>Ctrl</kbd>+<kbd>.</kbd>, not the shortcut of the US key at its position.</p><h2>Shortcut reference</h2><aside class=\"admonition note\"><p>All these shortcuts indicate the default key-bindings which can be changed individually from&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Shortcuts.</em></p></aside><h3>Tree</h3><p>See the corresponding section:&nbsp;<a class=\"reference-link\" href=\"#root/_help_DvdZhoQZY9Yd\">Keyboard shortcuts</a></p><h3>Note navigation</h3><ul><li><kbd>Alt</kbd>+<kbd>←</kbd>, <kbd>Alt</kbd>+<kbd>→</kbd> – go back / forwards in the history</li><li><kbd>Ctrl</kbd>+<kbd>J</kbd> – show <a href=\"#root/_help_MMiBEQljMQh2\">\"Jump to\" dialog</a></li><li><kbd>Ctrl</kbd>+<kbd>.</kbd> – scroll to current note (useful when you scroll away from your note or your focus is currently in the editor)</li><li><kbd>Backspace</kbd> – jumps to parent note</li><li><kbd>Alt</kbd>+<kbd>C</kbd> – collapse whole note tree</li><li><kbd>Alt</kbd>+<kbd>-</kbd> (alt with minus sign) – collapse subtree (if some subtree takes too much space on tree pane you can collapse it)</li><li>you can define a <a href=\"#root/_help_zEY4DaJG4YT5\">label</a> <code>#keyboardShortcut</code> with e.g. value <code>Ctrl + I</code> . Pressing this keyboard combination will then bring you to the note on which it is defined. Note that Trilium must be reloaded/restarted (<kbd>Ctrl</kbd>+<kbd>R</kbd> ) for changes to be in effect.</li></ul><p>See demo of some of these features in <a href=\"#root/_help_MMiBEQljMQh2\">note navigation</a>.</p><h3>Tabs</h3><ul><li><kbd>Ctrl</kbd> + <kbd>🖱 Left click</kbd> – (or middle mouse click) on note link opens note in a new tab</li></ul><p>Only in desktop (electron build):</p><ul><li><kbd>Ctrl</kbd>+<kbd>T</kbd> – opens empty tab</li><li><kbd>Ctrl</kbd>+<kbd>W</kbd> – closes active tab</li><li><kbd>Ctrl</kbd>+<kbd>Tab</kbd> – activates next tab</li><li><kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Tab</kbd> – activates previous tab</li></ul><h3>Splits</h3><p><a class=\"reference-link\" href=\"#root/_help_luNhaphA37EO\">Split View</a>&nbsp;can also be controlled through keyboard actions, such as:</p><ul><li>Creating a new split</li><li>Closing the active split</li><li>Moving a split left/right</li><li>Focusing the split to the left/right.</li></ul><p>All these keyboard shortcuts do not have a default set, go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Shortcuts</em> and look for the <em>Split View</em> category.</p><h3>Context menus</h3><p>Every context menu can be operated from the keyboard, however it was opened, for example with the <kbd>Menu</kbd> key in a text note to reach the spelling suggestions. These keys are fixed and cannot be changed in the options.</p><ul><li><kbd>↑</kbd>, <kbd>↓</kbd> – move to the previous / next item, skipping disabled ones and wrapping around at either end</li><li><kbd>Home</kbd>, <kbd>End</kbd> – move to the first / last item</li><li><kbd>→</kbd> – open the submenu of the current item, or move to the next column in a submenu laid out in columns</li><li><kbd>←</kbd> – move to the previous column, or close the submenu and go back to its item</li><li><kbd>Enter</kbd> or <kbd>Space</kbd> – run the current item, or open its submenu</li><li><kbd>Esc</kbd> – close the innermost submenu, then the menu itself</li><li>typing the first letters of an item – jump to the next item whose title starts with them</li></ul><p>With a right-to-left language, <kbd>←</kbd> and <kbd>→</kbd> swap roles.</p><h3>Creating notes</h3><ul><li><kbd>Ctrl</kbd>+<kbd>O</kbd> – creates new note after the current note</li><li><kbd>Ctrl</kbd>+<kbd>P</kbd> – creates new sub-note into current note</li><li><kbd>F2</kbd> – edit the&nbsp;<a class=\"reference-link\" href=\"#root/_help_TBwsyfadTA18\">Branch prefix</a>&nbsp;of current note clone</li></ul><h3>Editing notes</h3><aside class=\"admonition note\"><p>For keyboard shortcuts specific to&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes, refer to&nbsp;<a class=\"reference-link\" href=\"#root/_help_oiVPnW8QfnvS\">Keyboard shortcuts</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_QrtTYPmdd1qq\">Markdown-like formatting</a>.</p></aside><ul><li>Enter in tree pane switches from tree pane into note title. Enter from note title switches focus to text editor. <kbd>Ctrl</kbd>+<kbd>.</kbd> switches back from editor to tree pane.</li><li><kbd>Ctrl</kbd>+<kbd>.</kbd> – jump away from the editor to tree pane and scroll to current note</li></ul><h3>Runtime shortcuts</h3><p>These are hooked in Electron to be similar to native browser keyboard shortcuts.</p><ul><li><kbd>F5</kbd>, <kbd>Ctrl</kbd>+<kbd>R</kbd> – reloads Trilium front-end</li><li><kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd> – show developer tools</li><li><kbd>Ctrl</kbd>+<kbd>F</kbd> – show search dialog</li><li><kbd>Ctrl</kbd>+<kbd>-</kbd> – zoom out</li><li><kbd>Ctrl</kbd>+<kbd>=</kbd> – zoom in</li></ul><h3>Other</h3><ul><li><kbd>Alt</kbd>+<kbd>O</kbd> – show SQL console (use only if you know what you're doing)</li><li><kbd>Alt</kbd>+<kbd>M</kbd> – distraction-free mode - display only note editor, everything else is hidden</li><li><kbd>F11 </kbd> – toggle full screen</li><li><kbd>Ctrl</kbd>+<kbd>S</kbd> – toggle <a href=\"#root/_help_eIg8jdvaoNNd\">search</a> form in tree pane</li><li><kbd>Alt</kbd>+<kbd>A</kbd> – show note <a href=\"#root/_help_zEY4DaJG4YT5\">attributes</a> dialog</li></ul>",
++ "_help_Wy267RK4M69c": "<h2>Default Themes</h2><p>Trilium comes with a couple pre-installed color themes, with the default being a light theme. To switch to a dark theme or any other available theme, navigate to the <span class=\"tn-icon bx bx-cog\"></span> Options menu (accessible via the app icon in the top-left corner), select the Appearance tab, and choose your preferred theme.</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Themes_dark-theme.png\" alt=\"Dark Theme\"></p><p>While a dark theme is active, Trilium asks the Dark Reader browser extension not to darken the page a second time. Dark Reader still darkens the light themes. After switching from a dark theme to a light one, reload the page (<kbd>Ctrl</kbd>+<kbd>R</kbd>) for Dark Reader to take effect again.</p><h2>Creating Custom CSS Themes</h2><p>Trilium supports custom user themes, allowing you to personalize the application's appearance. To create a custom theme, follow these steps:</p><ol><li><strong>Create a CSS Code Note</strong>: Start by creating a new <a href=\"#root/_help_6f9hih2hXXZk\">code note</a> with the <code>CSS</code> type.</li><li><strong>Annotate with</strong> <code>#appTheme</code>: Add the <a href=\"#root/_help_zEY4DaJG4YT5\">attribute</a> <code>#appTheme=my-theme-name</code> to your note, where <code>my-theme-name</code> is the name of your custom theme.</li><li><strong>Define Your Styles</strong>: Write your custom CSS within the note.</li></ol><details class=\"trilium-collapsible\" open=\"\"><summary>Example of a custom theme</summary><pre><code class=\"language-text-x-trilium-auto\">@font-face {\n font-family: 'Raleway';\n font-style: normal;\n font-weight: 400;\n src: url('/custom/fonts/raleway.woff2') format('woff2');\n}\n\n:root {\n --main-font-family: 'Raleway' !important;\n --main-font-size: normal;\n --tree-font-family: inherit;\n --tree-font-size: normal;\n --detail-font-family: inherit;\n --detail-font-size: normal;\n --detail-text-font-family: 'Garamond' !important;\n\n --main-background-color: #404552;\n --main-text-color: #AFB8C6;\n --main-border-color: #AFB8C6;\n --accented-background-color: #383C4A;\n --more-accented-background-color: #2F343F;\n --header-background-color: #383C4A;\n --button-background-color: #2F343F;\n --button-disabled-background-color: #404552;\n --button-border-color: #333;\n --button-text-color: #AFB8C6;\n --button-border-radius: 2px;\n --primary-button-background-color: #6c757d;\n --primary-button-text-color: white;\n --primary-button-border-color: #6c757d;\n --muted-text-color: #86919F;\n --input-text-color: #AFB8C6;\n --input-background-color: #404552;\n --hover-item-text-color: white;\n --hover-item-background-color: #4877B1;\n --active-item-text-color: white;\n --active-item-background-color: #4877B1;\n --menu-text-color: #AFB8C6;\n --menu-background-color: #383C4A;\n --tooltip-background-color: #383C4A;\n --link-color: lightskyblue;\n --modal-background-color: #404552;\n --modal-backdrop-color: black;\n --scrollbar-border-color: rgba(175, 184, 198, 0.5);\n}\n\nbody .note-detail-text {\n font-size: 120%;\n}\n\nbody .CodeMirror {\n filter: invert(100%) hue-rotate(180deg);\n}</code></pre><p>&nbsp;</p></details><p>&nbsp;</p><h3>Activating Your Custom Theme</h3><p>Once you've created your custom theme:</p><ol><li>Go to \"Menu\" -&gt; \"Options\" (<span class=\"tn-icon bx bx-cog\"></span>) -&gt; \"Appearance.\"</li><li>In the theme selection dropdown, you should see your custom theme listed under the name you provided with the <code>#appTheme</code> <a href=\"#root/_help_zEY4DaJG4YT5\">label</a>.</li><li>Select your custom theme to activate it.</li></ol><p>If you make changes to your theme, press Ctrl + R to reload the frontend and apply your updates.</p><h3>Sharing and Importing Themes</h3><p>Custom themes can be exported as <code>.tar</code> archives, which can be shared with other users. However, be cautious when importing themes from untrusted sources, as they may contain executable scripts that could pose security risks.</p><p>An example user theme, <em>Steel Blue</em>, is available in the demo document.</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Themes_steel-blue.png\" alt=\"Steel Blue Theme\"></p><h3>Using Custom CSS for Specific Purposes</h3><p>In addition to full themes, Trilium allows for custom CSS that isn't tied to a theme. This can be particularly useful in scripting contexts, where you might want to modify specific UI elements, such as changing the colors of notes in the tree view.</p><h3>Applying Custom CSS</h3><p>To use custom CSS:</p><ol><li><strong>Create a CSS Code Note</strong>: Create a new&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note with the <code>CSS</code> type.</li><li><strong>Add the</strong> <code>appCss</code> <strong>Label</strong>: Annotate the note with the <code>#appCss</code> <a href=\"#root/_help_zEY4DaJG4YT5\">label</a>.</li><li><strong>Write Your CSS</strong>: Add your custom CSS rules to the note.</li></ol><p>For example:</p><pre><code class=\"language-text-x-trilium-auto\">/* Custom CSS to style specific elements */\n.tree-item {\n color: #ff6347; /* Change tree item color */\n}</code></pre><p>When Trilium's frontend starts, all notes labeled with <code>appCss</code> are automatically included in the style element of the HTML page.</p><p>After making changes, press Ctrl + R to reload the frontend and apply your new styles.</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Themes_image.jpg\"></p><h3>Styling Specific Notes in the Tree</h3><p>To apply specific styles to certain notes in the tree:</p><ul><li><strong>Use the</strong> <code>cssClass</code> <strong>Attribute</strong>: Add the <code>cssClass</code> <a href=\"#root/_help_zEY4DaJG4YT5\">attribute</a> to a note, and assign it a value representing the desired CSS class.</li><li><strong>Define an</strong> <code>iconClass</code>: You can also define a custom icon for a note using the <code>iconClass</code> attribute, selecting from <a href=\"https://boxicons.com\">Box Icons</a> or your own custom classes.</li></ul><p>For example, if you want to style notes of a specific type, such as notes containing PNG images, you can target them with classes like <code>type-image mime-image-png</code>.</p><h3>User-Provided Themes</h3><p>A gallery of user-created themes is available, showcasing the variety of customizations that the Trilium community has developed. For more information, check the&nbsp;<a class=\"reference-link\" href=\"#root/_help_VbjZvtUek0Ln\">Theme Gallery</a>.</p><h3>Asset Path Management</h3><p>When referencing built-in assets like images in your custom themes or CSS, you can avoid hardcoding version numbers by using the <code>vX</code> alias. For example, instead of specifying <code>/assets/v0.57.0-beta/images/icon-grey.png</code>, you can use <code>/assets/vX/images/icon-grey.png</code> to keep your theme compatible with future versions of Trilium.</p>",
++ "_help_VbjZvtUek0Ln": "<p>These are user-created themes which were made publicly available:</p><h2>Legacy Themes</h2><p>These themes may or may not be compatible with the latest versions of TriliumNext and are based on the original/legacy theme.</p><figure class=\"table\"><table><thead><tr><th>Theme</th><th>Author</th></tr></thead><tbody><tr><td><a href=\"https://github.com/tobealive/trilium-midnight-theme\">Midnight</a></td><td><a href=\"https://github.com/tobealive\">tobealive</a></td></tr><tr><td><a href=\"https://github.com/tobealive/trilum-eote-theme\">EOTE</a></td><td><a href=\"https://github.com/tobealive\">tobealive</a></td></tr><tr><td><a href=\"https://github.com/Abourass/TriliumThemes\">Trilium Themes</a></td><td><a href=\"https://github.com/Abourass\">Abourass</a></td></tr><tr><td><a href=\"https://github.com/ZMonk91/Material-Dark-Trilium\">MaterialDark</a></td><td><a href=\"https://github.com/ZMonk91\">ZMonk91</a></td></tr><tr><td><a href=\"https://github.com/jaroet/trilium-theme-lightslategray\">lightslategray</a></td><td><a href=\"https://github.com/jaroet\">jaroet</a></td></tr><tr><td><a href=\"https://github.com/raphwriter/trilium-theme-melon\">melon-4</a></td><td><a href=\"https://github.com/raphwriter\">raphwriter</a></td></tr><tr><td><a href=\"https://github.com/Engr-AllanG/trilium-themes\">Neon_Dark</a></td><td><a href=\"https://github.com/Engr-AllanG\">Engr-AllanG</a></td></tr><tr><td><a href=\"https://github.com/Engr-AllanG/trilium-themes\">Coder_Dark</a></td><td><a href=\"https://github.com/Engr-AllanG\">Engr-AllanG</a></td></tr><tr><td><a href=\"https://github.com/idelem/trilium-theme-velvet\">velvet</a></td><td><a href=\"https://github.com/idelem\">idelem</a></td></tr><tr><td><a href=\"https://github.com/SADAVA/trilium-notes-theme-dark-plus\">Dark Plus</a></td><td><a href=\"https://github.com/SADAVA\">SADAVA</a></td></tr><tr><td><a href=\"https://github.com/WKSu/trilium-solarized-theme\">Solarized</a></td><td><a href=\"https://github.com/WKSu\">WKSu</a></td></tr><tr><td><a href=\"https://github.com/en3r0/Trilium-Nord-Theme\">Nord</a></td><td><a href=\"https://github.com/en3r0\">en3r0</a></td></tr><tr><td><a href=\"https://github.com/AllanZyne/trilium-bear-theme\">Bear Note Light</a></td><td><a href=\"https://github.com/AllanZyne\">AllanZyne</a></td></tr><tr><td><a href=\"https://github.com/AllanZyne/trilium-bear-theme\">Bear Note Dark</a></td><td><a href=\"https://github.com/AllanZyne\">AllanZyne</a></td></tr><tr><td><a href=\"https://github.com/Sebiann/miku-hatsune-trilium-theme\">Miku Hatsune</a></td><td><a href=\"https://github.com/Sebiann\">Sebiann</a></td></tr><tr><td><a href=\"https://github.com/cwilliams5/Midnight-Trilium-Dark-Mode\">Midnight</a></td><td><a href=\"https://github.com/cwilliams5\">cwilliams5</a></td></tr><tr><td><a href=\"https://github.com/SiriusXT/trilium-theme-blue\">Blue</a> (light)</td><td><a href=\"https://github.com/SiriusXT\">SiriusXT</a></td></tr><tr><td><a href=\"https://github.com/SiriusXT/trilium-theme-blue\">Blue</a> (dark)</td><td><a href=\"https://github.com/SiriusXT\">SiriusXT</a></td></tr></tbody></table></figure><aside class=\"admonition tip\"><p>If you would like to add your theme to this gallery, write a new post in <a href=\"https://github.com/TriliumNext/Trilium/discussions/categories/show-and-tell\">👐 Show and tell</a>.</p></aside>",
++ "_help_gOKqSJgXLcIj": "<figure class=\"image image-style-align-right image_resized\" style=\"width:45.14%;\"><img style=\"aspect-ratio:854/649;\" src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Themes/Icon%20Packs_image.png\" width=\"854\" height=\"649\"></figure><p>By default, Trilium comes with a set of icons called Boxicons v2. Since v0.102.0, custom icon packs allow a wider selection of icons for notes.</p><p>Icon packs are specific to Trilium, so they must either be created from scratch (see below) or imported from a ZIP file from a third-party developer.</p><h2>Sample icon packs</h2><p>The Trilium team maintains a few icon packs that are not shipped with Trilium. These icon packs can be found on the official website on the <a href=\"https://triliumnotes.org/resources\">Resources page</a>.</p><h2>Importing an existing icon pack</h2><aside class=\"admonition note\"><p><strong>Icon packs are third-party content</strong></p><p>Apart from the <a href=\"https://triliumnotes.org/resources\">sample icon packs</a>, the Trilium maintainers are not responsible for keeping icon packs up to date. If you have an issue with a specific icon pack, then the issue must be reported to the third-party developer responsible for it, not the Trilium team.</p></aside><p>To import an icon pack:</p><ol><li>Ideally, create a dedicated spot in your note tree where to place the icon packs.</li><li>Right click the note where to put it and select <em>Import into note</em>.</li><li>Uncheck <em>Safe import</em>.</li><li>Select <em>Import</em>.</li><li><a href=\"#root/_help_s8alTXmpFR61\">Refresh the application</a>.</li></ol><aside class=\"admonition warning\"><p>Since <em>Safe import</em> is disabled, make sure you trust the source as it could contain dangerous third-party scripts. One good way to check if the icon pack is safe is to manually extract the .zip and inspect the file contents. Icon packs should only contain a font file and a JSON file. Other files (especially scripts) are to be considered harmful.</p></aside><h2>Creating an icon pack</h2><p>Creating an icon pack requires some scripting knowledge outside Trilium in order to generate the list of icons. For information, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_g1mlRoU8CsqC\">Creating an icon pack</a>.</p><h2>Using an icon from an icon pack</h2><p>After <a href=\"#root/_help_s8alTXmpFR61\">refreshing the application</a>, the icon pack should be enabled by default. To test this, simply select an existing note or create a new one and try to change the note icon.</p><p>There should be a <em>Filter</em> button to the right of the search bar in the icon list. Clicking it allows filtering by icon pack and the newly imported icon pack should be displayed there.</p><aside class=\"admonition note\"><p>If the icon pack is missing from that list, then most likely there's something wrong with it.</p><ul><li>Try checking the&nbsp;<a class=\"reference-link\" href=\"#root/_help_bnyigUA2UK7s\">Backend (server) logs</a>&nbsp;for clues and make sure that the icon pack has the <code>#iconPack</code> <a href=\"#root/_help_HI6GBBIduIgv\">label</a> with a value assigned to it (a prefix).</li><li>Icon packs that are <a href=\"#root/_help_bwg0e8ewQMak\">protected</a> are ignored.</li></ul></aside><h2>Integration with the share and export functionality</h2><p>Custom icon packs are also supported by the&nbsp;<a class=\"reference-link\" href=\"#root/_help_R9pX4DGra2Vt\">Sharing</a>&nbsp;feature, where they will be shown in the note tree. However, in order for an icon pack to be visible to the share function, the icon pack note must also be shared.</p><p>If you are using a custom share theme, make sure it supports the <code>iconPackCss</code>, otherwise icons will not show up. Check the original share template source code for reference.</p><p>Custom icon packs will also be preserved when&nbsp;<a class=\"reference-link\" href=\"#root/_help_ycBFjKrrwE9p\">Exporting static HTML for web publishing</a>. In this case, there's no requirement to make the icon pack shared.</p><h2>What happens if I remove an icon pack</h2><p>If an icon pack is removed or disabled (by removing or altering its <code>#iconPack</code> label), all the notes that use this icon pack will show in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;with no icon. This won't cause any issues apart from looking strange.</p><p>The solution is to replace the icons with some else, try using&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>&nbsp;which supports bulk actions, to identify the notes with the now deleted icon pack (by looking for the prefix) and changing or removing their <code>iconClass</code>.</p>",
++ "_help_w4rMEhJsALlA": "<h2>Using different fonts</h2><p>Trilium comes by default with its own font (<em>Inter</em>), but the font can be adjusted in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Appearance</em>, by checking <em>Use different fonts</em> in the <em>Fonts</em> section.</p><p>The font can be personalized for the following areas of the application:</p><ul><li>Interface text, for most of the UI (menus, toolbars, dialogs).</li><li><a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</li><li>Document text, for the actual content of the notes (especially for&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes).</li><li>Monospace text, e.g. for&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;notes and&nbsp;<a class=\"reference-link\" href=\"#root/_help_QxEyIjRBizuC\">Code blocks</a>.</li></ul><p>Each area also has its own <em>Size</em>. The note tree and document sizes are relative to the interface size, so changing the interface size moves them along with it.</p><p>The list of fonts contains the following items:</p><ul><li><strong>Generic fonts</strong><ul><li><em>Theme defined</em> which uses the font that is embedded with the current <a href=\"#root/_help_Wy267RK4M69c\">theme</a>. For example on the default modern theme, the font is <em>Inter</em>. This does not require the font to be installed.</li><li><em>System default</em> which uses a combination of fonts that works best for the <a href=\"#root/_help_poXkQfguuA0U\">desktop app</a>. For example on Windows it will use <em>Segoe UI</em>.</li><li>Generic font selections for fonts with serifs (e.g. <em>Times New Roman</em>-like), no serifs and monospace.</li></ul></li><li><strong>Web fonts</strong> which appear on the&nbsp;<a class=\"reference-link\" href=\"#root/_help_WOcw2SLH6tbX\">Server Installation</a>, which is a predefined list of fonts and grouped into Sans-serif, serif, monospace and handwriting. The fonts that are not supported by your system (i.e. not installed) are not displayed.</li><li><strong>System fonts</strong> which appear on the&nbsp;<a class=\"reference-link\" href=\"#root/_help_poXkQfguuA0U\">Desktop Installation</a>. Unlike the server fonts which are predefined, the system fonts are listed from your operating system.</li><li><strong>Custom fonts</strong>, allowing any font to be used provided it's imported into Trilium. See the section below for more information.</li></ul><p>Font changes take effect after a reload; the section offers a <em>Reload to apply changes</em> button once something has been changed.</p><h2>Custom fonts</h2><p>A font file imported into Trilium can be used by the application itself, without writing any CSS.</p><h3>Adding a font</h3><ol><li>Import the font file, by dragging it into the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;or through <em>Import into note</em>. TrueType (<code>.ttf</code>), OpenType (<code>.otf</code>) and Web Open Font Format (<code>.woff</code>, <code>.woff2</code>) files are recognized; the note takes the font's name without its extension and is marked with a font icon (an “A” icon).</li><li>Select the resulting note where a preview of a font will be displayed: a specimen line to type your own text into, a slider for its size, a preview in multiple sizes, and the Latin character set.</li><li>Turn on <em>In font picker</em> above the specimen.</li><li>In&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Appearance</em> → <em>Fonts</em>, the font is now offered under <em>Custom fonts</em>, ahead of the built-in families, and can be set for any of the four areas.</li></ol><aside class=\"admonition note\"><p>Embedded OpenType (<code>.eot</code>) files and TrueType collections (<code>.ttc</code>) cannot be drawn by the browser, so they are treated as ordinary files: no preview, and no entry in the picker.</p></aside><h3>How custom fonts behave</h3><ul><li>Each entry is named after its note, so renaming the note renames the entry. The setting refers to the note itself rather than to its name, and keeps working across a rename.</li><li>The font file is an ordinary note, so&nbsp;<a class=\"reference-link\" href=\"#root/_help_cbkrhQjrkKrh\">Synchronization</a>&nbsp;carries it to your other devices. The choice of font is not synced: appearance settings are deliberately kept per-device, so on another device the font is already there and only needs to be selected again.</li><li>A font kept in a <a href=\"#root/_help_bwg0e8ewQMak\">protected note</a> can only be previewed and used while the protected session is open.</li></ul><p>For theme authors, a font can also be embedded in a theme's CSS through&nbsp;<a class=\"reference-link\" href=\"#root/_help_d3fAXQ2diepH\">Custom Resource Providers</a>, which is the route to take when the font should come with the theme rather than be chosen in the settings.</p><h3>Downloading from Google Fonts</h3><p>A large selection of fonts can be easily retrieved from Google Fonts, as follows:</p><ol><li>Go to <a href=\"https://fonts.google.com\">https://fonts.google.com</a>.</li><li>Search for a desired font.</li><li>Press <em>Get font</em> in the top right.</li><li>Check that the list of fonts on the left side corresponds to your selection.</li><li>Press <em>Download all</em>.</li><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, create a note where to store the new fonts.</li><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, drag-and-drop the .zip file directly onto the newly created note and follow the steps from the previous section.</li></ol><h2>Programming ligatures</h2><p>Some fonts support programming ligatures, which will turn character combinations such as <code>!=</code> into <code>≠</code> or <code>-&gt;</code> as <code>→</code> in&nbsp;<a class=\"reference-link\" href=\"#root/_help_QxEyIjRBizuC\">Code blocks</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;notes.</p><p>These are only a display affordance, so copying the text is not affected. Regardless, this feature can be disabled in Trilium by unchecking <em>Programming ligatures</em> in the font settings.</p>",
++ "_help_mHbBMPDPkVV5": "<p>To import a note:</p><ul><li>The easiest way to import is to simply drag &amp; drop a file or an archive into the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.<ul><li>This will automatically detect some formats such as&nbsp;<a class=\"reference-link\" href=\"#root/_help_iWD7wiIuMtgV\">Obsidian</a>.</li><li><em>Safe import</em> is automatically on to prevent accidental running of foreign scripts.</li></ul></li><li>To configure an import, there is a dedicated dialog which can be accessed from either&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;→ <em>Import into note</em> or&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>&nbsp;→ <em>Import into note</em>.<ul><li>This feature allows for dedicated importers for others apps such as&nbsp;<a class=\"reference-link\" href=\"#root/_help_iWD7wiIuMtgV\">Obsidian</a>&nbsp;or&nbsp;<a class=\"reference-link\" href=\"#root/_help_GnhlmrATVqcH\">Microsoft OneNote</a>.</li><li><em>Safe import</em> as well as other options can be configured from the collapsed <em>Options</em> section at the bottom.</li></ul></li></ul><p>To export a note, right click the note in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and select <em>Export</em>. Similarly, in&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>&nbsp;there is a <em>Export note</em> option.</p><h2>Supported formats</h2><p>Trilium natively supports the following formats for both import and export.</p><ul><li>HTML:<ul><li>This is the main format used by Trilium, where standard tags are used to represent basic formatting and layout (e.g. <code>&lt;strong&gt;</code>, <code>&lt;table&gt;</code>, <code>&lt;pre&gt;</code>).</li><li>Note that HTML is not a standardized format so some more specific features such as admonitions or&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;might not be supported by other applications.</li><li>The notes can also be exported as <a href=\"#root/_help_ycBFjKrrwE9p\">static HTML that can be used for web publishing</a>.</li></ul></li><li><a class=\"reference-link\" href=\"#root/_help_Oau6X9rCuegd\">Markdown</a><ul><li>Most of the formatting is preserved, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_rJ9grSgoExl9\">Supported syntax</a>.</li></ul></li><li>OPML (Outliner Interchange Format)<ul><li>Supports both OPML v1.0 for plain text and v2.0 with HTML support.</li></ul></li></ul><p>To import from other applications such as OneNote, Notion and others, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_ckZ2uNWQmVeX\">Importing data from other applications</a>.</p><h2>Maximum import size</h2><p>Versions prior to v0.104.0 had an upload limit of 250 MiB that could be bypassed via a <code>TRILIUM_NO_UPLOAD_LIMIT</code> environment variable; with v0.104.0 this limit was removed.</p><p>Nevertheless, there is still a limit for the maximum size of a <strong>single item</strong> (whether it's a&nbsp;<a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a>, an&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>&nbsp;or even a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;note). The limit is approximately 374 MiB and it's determined by the&nbsp;<a class=\"reference-link\" href=\"#root/_help_cbkrhQjrkKrh\">Synchronization</a>&nbsp;protocol. Attempts to import such large files will be refused.</p><p>During large imports or exports, memory consumption might spike but it will remain somewhere around the 2 gigabyte mark. Tested with a 2.4 GB database with ~21k notes.</p><aside class=\"admonition important\"><p>For the&nbsp;<a class=\"reference-link\" href=\"#root/_help_poXkQfguuA0U\">Desktop Installation</a>, there are two distinct import mechanisms:</p><ul><li>A quick import, from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</li><li>The import dialog (via right click in the note tree → <em>Import into note</em> or from&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>).</li></ul><p>When dealing with large files (multi-gigabyte), prefer using the import dialog as it has a special mechanism which makes sure that the file is read directly from disk rather than uploaded again.</p></aside><h2>Exporting the root note</h2><p>The root note is the top-most note. Exporting it behaves just like any other note: right click on it in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and select <em>Export</em>.</p><p>Starting with v0.104.0, when a root note is imported, it will be imported as a child of your existing root note. This behavior makes sure that the import cannot change or overwrite your existing notes.</p><p>You can easily move the notes onto the root using the tree's&nbsp;<a class=\"reference-link\" href=\"#root/_help_yTjUdsOi4CIE\">Multiple selection</a>&nbsp;and delete the redundant root note.</p><figure class=\"table\"><table><thead><tr><th scope=\"col\">Before</th><th scope=\"col\">After</th></tr></thead><tbody><tr><td><ul><li>root<ul><li>one</li><li>two</li></ul></li></ul></td><td><ul><li>root (existing)<ul><li>root (from import)<ul><li>one</li><li>two</li></ul></li></ul></li></ul></td></tr></tbody></table></figure><aside class=\"admonition tip\"><p>Instead of exporting full ZIPs (including the root note), consider using <a href=\"#root/_help_ODY7qQn5m2FT\">backups</a> instead. Backups always contain the entire structure, as well as additional information a ZIP export does not have: maintains note IDs, contains the options/tokens and handle&nbsp;<a class=\"reference-link\" href=\"#root/_help_bwg0e8ewQMak\">Protected Notes</a>&nbsp;better.</p></aside>",
+ "_help_Oau6X9rCuegd": "<p>Trilium supports Markdown for both import and export, while trying to keep compatibility as high as possible.</p><h2>Import</h2><h3>Clipboard import</h3><p>If you want to import just a chunk of markdown from clipboard, you can do it from editor block menu:</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Import%20%26%20Export/Markdown_markdown-inline-import.gif\"></p><h3>File import</h3><p>You can also import Markdown files from files:</p><ul><li>single markdown file (with .md extension)</li><li>whole tree of markdown files (packaged into <a href=\"https://en.wikipedia.org/wiki/Tar_(computing)\">.zip</a> archive)<ul><li>Markdown files need to be packaged into ZIP archive because browser can't read directories, only single files.</li><li>You can use e.g. <a href=\"https://www.7-zip.org\">7-zip</a> to package directory of markdown files into the ZIP file</li></ul></li></ul><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Import%20%26%20Export/Markdown_markdown-file-import.gif\"></p><h2>Export</h2><h3>Subtree export</h3><p>You can export whole subtree to ZIP archive which will have directory structured modelled after subtree structure:</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Import%20%26%20Export/Markdown_markdown-export-subtree.gif\"></p><h3>Single note export</h3><p>If you want to export just single note without its subtree, you can do it from Note actions menu:</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Import%20%26%20Export/Markdown_markdown-export-note.gif\"></p><h3>Exporting protected notes</h3><p>If you want to export protected notes, enter a protected session first! This will export the notes in an unencrypted form, so if you reimport into Trilium, make sure to re-protect these notes.</p><h2>Supported syntax</h2><p>See the dedicated page:&nbsp;<a class=\"reference-link\" href=\"#root/_help_rJ9grSgoExl9\">Supported syntax</a></p>",
- "_help_rJ9grSgoExl9": "<p><a href=\"https://github.github.com/gfm/\">GitHub-Flavored Markdown</a> is the main syntax that Trilium is following.</p><h2>Images</h2><p>When exporting, images are usually kept in the basic Markdown syntax but will use the HTML syntax if the image has a custom width. Figures are always embedded as HTML.</p><h2>Tables</h2><p>Simple tables are supported with the Markdown syntax. If the table is too complex or contains elements that would render as HTML, the table is also rendered as HTML.</p><h2>Links</h2><p>Standard Markdown links are supported.</p><p>Trilium internal links (that mirror a note's title and display its icon) are embedded as HTML in order to preserve the information on import.</p><h2>Math equations</h2><p>Both inline and display equations are supported, using the <code spellcheck=\"false\">$</code> and <code spellcheck=\"false\">$$</code> syntaxes.</p><h2>Admonitions</h2><p>The Markdown syntax for admonitions as supported by Trilium is the one that GitHub uses, which is as follows:</p><pre><code class=\"language-text-x-trilium-auto\">&gt; [!NOTE]\n&gt; This is a note.\n\n&gt; [!TIP]\n&gt; This is a tip.\n\n&gt; [!IMPORTANT]\n&gt; This is a very important information.\n\n&gt; [!CAUTION]\n&gt; This is a caution.</code></pre><p>There are currently no plans of supporting alternative admonition syntaxes such as <code spellcheck=\"false\">!!! note</code>.</p><h2>Wikilinks</h2><p>Basic support for wikilinks has been added in v0.96.0:</p><ul><li><code spellcheck=\"false\">[[foo/bar]]</code> will look for the <code spellcheck=\"false\">bar.md</code> file in the <code spellcheck=\"false\">foo</code> directory and turn it into an internal link.</li><li><code spellcheck=\"false\">![[foo/baz.png]]</code> will look for the <code spellcheck=\"false\">baz.png</code> file in the <code spellcheck=\"false\">foo</code> directory and turn it into an image.</li></ul><p>This feature is import-only, which means that it will turn wikilinks into Trilium-compatible syntax, but it will not export Trilium Notes into Markdown files with this syntax.</p><aside class=\"admonition important\"><p>The path to pages in wikilinks is resolved relatively to the <em>import root</em> and not the current directory of the note. This is to be inline with other platforms that use wikilinks such as SilverBullet.</p><p>The root path of the import is determined as follows:</p><ul><li>If there is a single directory within the archive at root level, then that directory is considered the root.</li><li>If there are multiple files &amp; directories at root level, then the archive root (containing all of these items) is considered the root.</li></ul></aside><h2>Highlights</h2><p>Background highlights are supported in two ways:</p><ul><li><p>The Markdown <code spellcheck=\"false\">==</code> extension which is supported by other Markdown-based applications such as Obsidian:</p><pre><code class=\"language-text-x-trilium-auto\">==highlighted==</code></pre></li><li><p>The canonical HTML representation of highlights, as supported by Trilium:</p><pre><code class=\"language-text-html\">&lt;span style=\"background-color:hsl(0,0%,100%);\"&gt;Highlighted&lt;/span&gt;</code></pre></li></ul><p>When the yellow highlight is used, import/export prefers the <code spellcheck=\"false\">==</code> syntax whereas the canonical HTML reprepresentation is used otherwise.</p>",
- "_help_ckZ2uNWQmVeX": "<p>Starting with version v0.104.0, Trilium's importer was expanded to application-specific imports. Unlike the standard HTML or&nbsp;<a class=\"reference-link\" href=\"#root/_help_Oau6X9rCuegd\">Markdown</a>&nbsp;import/export, these importers are tailored to support the features and note structure of a particular application.</p><h2>Supported applications</h2><ul><li><a class=\"reference-link\" href=\"#root/_help_GnhlmrATVqcH\">Microsoft OneNote</a>, by connecting to your account using Microsoft Graph.</li><li><a class=\"reference-link\" href=\"#root/_help_Y5mKeJ6dsCld\">Notion</a>, via a ZIP export.</li><li><a class=\"reference-link\" href=\"#root/_help_nhQVuO4zvIxi\">Google Keep</a>, via a ZIP export from <em>Google Takeout</em> (Keep has no dedicated export mechanism).</li><li><a class=\"reference-link\" href=\"#root/_help_syuSEKf2rUGr\">Evernote</a>, via an ENEX export.</li><li><a class=\"reference-link\" href=\"#root/_help_83zmPBJRgfnW\">Anytype</a>, via a JSON export.</li><li><a class=\"reference-link\" href=\"#root/_help_iWD7wiIuMtgV\">Obsidian</a>, via a ZIP of the vault.</li></ul><h2>Importing data from another application</h2><p>To import from an application, there are two ways to access the import dialog:</p><ul><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, right click on a note and select <em>Import into note</em>.</li><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note buttons</a>&nbsp;area, select <em>Import files</em>.</li></ul><p>A list of supported applications will appear at the top, each with their own configuration. Simply click one and proceed with the on-screen instructions.</p><h2>Acknowledgement</h2><ul><li>Trilium's importer is inspired by Obsidian's <a href=\"https://github.com/obsidianmd/obsidian-importer\">Importer plugin</a> (licensed under the MIT license), for example regarding the OneNote connection process or the Notion ID management.</li></ul>",
- "_help_GnhlmrATVqcH": "<p>Trilium allows importing from OneNote. Currently the only mechanism supported is via the Microsoft Graph API which requires you to authenticate in a browser in order for the notes to be obtained by Trilium.</p><h2>Import process</h2><ol><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, right click and select <em>Import into note</em>.</li><li>In the <em>Import from</em> section, select <em>OneNote</em>.</li><li>Press the <em>Connect</em> button:<ol><li>On the desktop app, you will be redirected to Microsoft's authentication screen where you can log into your account.</li><li>On the web app, the process is slightly more involved as it requires copying the code to clipboard, accessing the link, pasting the code and then signing in once more.</li></ol></li><li>After the connection is successful, you should be able to see a list of sections that can be imported. Simply check the ones to import and press the <em>Import selected</em> button.</li><li>Wait for the import to finish.</li></ol><h2>Supported features</h2><p>The following features are preserved by Trilium during the import process:</p><ul><li>Basic formatting (bold, italic, underline, strikethrough, subscript, super script, font sizes, headings, colors, highlights).<ul><li>Black-colored text is intentionally stripped to allow it to work in dark themes.</li></ul></li><li>Inline code is automatically detected and formatted. Paragraphs that use the Code style are also converted to&nbsp;<a class=\"reference-link\" href=\"#root/_help_QxEyIjRBizuC\">Code blocks</a>.<ul><li>Unfortunately the indentation of the code might be lost because the information is simply not present in the data from the Microsoft API.</li></ul></li><li><a class=\"reference-link\" href=\"#root/_help_S6Xx8QIWTV66\">Lists</a>&nbsp;with different bullet types.</li><li><a class=\"reference-link\" href=\"#root/_help_NdowYOC1GFKS\">Tables</a><ul><li>Cell backgrounds are preserved, including a best-effort hue correction because the colors returned by the Graph API are sometimes incorrect.</li><li>Cell widths are also preserved proportionally, with the only difference that tables in Trilium have a percentage-based width, not fixed pixel sizes.</li></ul></li><li>Images and&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>.<ul><li>Screen clippings are also properly supported since v0.104.1, displaying their timestamp as a figure caption.</li></ul></li><li>To-do lists</li><li>Hand-drawing is preserved and displayed as an SVG image inside the note<ul><li>OneNote's default color (black) is special since it also renders as white for dark themes. Since v0.104.1, this is also supported by using a special SVG tweak which reacts to light/dark themes.</li></ul></li><li>Links between other imported pages are converted to&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;if the text of the link matches the name of the page, or plain links otherwise. If the pages are not part of the import, the original <code spellcheck=\"false\">onenote:</code> link is kept.</li><li>Tags (apart from to-do lists) are mildly preserved by converting them to emojis. This loses their searchability. Since Trilium has no concept of inline attributes or badges, this is considered a middle-ground.</li></ul><p>Regarding the note structure:</p><ul><li>The order of the pages within a section is maintained.</li><li>Sub-pages and section groups are maintained by nesting notes in a hierarchical structure.</li><li>Creation and modification of both notes and sections is preserved. The order of section or section groups is not preserved (see limitations).</li></ul><h2>Error management and reporting</h2><p>The OneNote importer uses Microsoft's Graph API which handles the HTML export (that we later post-process for Trilium use). The Graph API itself has to process the OneNote pages before sending them to us, and as such it's a time-consuming operation that is directly proportional to the number of notes and the complexity/size of the notes.</p><p>The Graph API throttles access if it detects too many operations. The importer takes that into account, but sometimes this means that most of the time is spent waiting for the Graph API to unblock access rather than actually importing data.</p><p>In addition, some pages may fail at the Graph API level due to an internal timeout on their side or other issues. Trilium will try to refetch pages in order to avoid that but sometimes pages cannot be retrieved even after multiple retries. In that case, the importer will still create a corresponding note in Trilium but with an error report instead of a content. This preserves&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;and makes it easy to identify and manually fix the pages that failed.</p><p>At the end of the import, the top-level note called <em>OneNote</em> <em>import</em> will contain information about how the import went:</p><ul><li>The number of notes imported;</li><li>The success rate;</li><li>A list of notes that could not be imported, as well as the failure reason;</li><li>Pages whose images/attachments failed to download</li><li>How long the import spent waiting out throttling.</li></ul><p>To avoid cases in which the import is fundamentally broken (e.g. an expired sign-in), the import will error out if it fails to import 6 pages in a row.</p><h2>Attributes</h2><p>Pages imported from OneNote have a few built-in <a href=\"#root/_help_HI6GBBIduIgv\">labels</a>:</p><ul><li><code spellcheck=\"false\">oneNotePageId</code>, with the corresponding page ID in OneNote. This can be used to identify the original OneNote page. Trilium doesn't use it in any way at this moment.</li><li><code spellcheck=\"false\">oneNoteImportFailed</code> attached to notes that couldn't be imported. This can be used to quickly&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>&nbsp;for failed notes.</li></ul><h2>Limitations</h2><h3>Regarding OneNote's freehand structure</h3><p>OneNote is fundamentally different to Trilium in structure because it allows freehand drawing to coexist with text, and text boxes can be placed anywhere in the document (e.g. a common use case is to have columns). Trilium has a document flow mechanism for&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes which means that it can't be freely positioned.</p><p>To cope with this difference, Trilium will flatten the text structure into normal paragraphs. The paragraphs will be ordered visually based on the original position of the text boxes, but their horizontal position will not be preserved. Parallel text such as columns may appear interleaved which can cause problems.</p><p>In addition, drawing in OneNote can be interleaved with text boxes. Text notes in Trilium do not allow for this feature, so all drawing will appear at the end. For some use cases (diagrams, for example) this will work fine, but if you have highlights or other text-dependent drawings they will appear out of order.</p><aside class=\"admonition note\"><p>There are plans to support drawing-heavy notes that interleave with text boxes by converting them to a&nbsp;<a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a>&nbsp;instead.</p></aside><h3>Password-protected sections</h3><p>OneNote supports encryption at section level; when importing a notebook that contains these password-protection sections, Trilium will not be able to read the content of password-protected sections so they will appear empty. This is not a limitation of Trilium, the information is simply not available from the source (Graph API).</p><p>The section itself is kept for reference and all the sections that could not be imported will be shown in the report (the top-level note called <em>OneNote import</em>).</p><p>To unprotect a section in OneNote Desktop, right click on the protected section → <em>Password Protect This Section</em> and press <em>Remove Password</em> and sync. Then reimport either only the protected sessions or the remove everything and start the import from scratch.</p><h2>Other limitations</h2><p>The following are known limitations due to how the information comes from the import (Microsoft Graph API), which means that they cannot be fixed.</p><ul><li>The order of the sections (and section groups) is not available, the sections are ordered by creation date instead.</li><li>Revision history.</li><li>Paragraph indentation, as well as code block indentation.</li><li>Section colors.</li><li>Drawings inside titles, the title might appear incomplete or “Untitled”.</li></ul><h2>Reporting issues</h2><p>When importing notes, you might find that some text is not rendered properly or the structure is not properly maintained. As long as this issue is not a fundamental issue (like the issue with freehand text not being preserved exactly), it's a good idea to <a href=\"#root/_help_wy8So3yZZlH9\">report it</a>.</p><p>When reporting, make sure that you provide the following information:</p><ul><li>Import again the section, checking the debug checkbox before importing. This preserves the original document (and the hand-drawing data if any) as it came through from OneNote's cloud API so that it can be used for comparison.</li><li>Export only the affected page as ZIP, making sure not to accidentally expose any sensitive information.</li><li>Take screenshots of how the note looked like in OneNote and how it ends up in Trilium.</li><li>Attach the ZIP and the screenshots to the issue report.</li></ul>",
- "_help_Y5mKeJ6dsCld": "<p>Trilium can import ZIP exports from Notion while preserving structure and formatting.</p><h2>Import process</h2><p>In Notion, there are two ways to export data:</p><ul><li>To export a single page (and optionally its sub-pages):<ul><li>Select the page to export.</li><li>Press the […] button at the top-right of the window and select <em>Export</em>.</li><li>Ensure the following options are set:<ul><li>Export format: HTML</li><li>Page content: Everything</li><li>Include subpages: On</li><li>Create folders for subpages: On</li></ul></li><li>Press the Export button.</li><li>Wait for the download to finish.</li></ul></li><li>To export an entire workspace, press your user name badge at top-left and select <em>Settings</em>.<ul><li>In the left section, look for the <em>Workspace</em> category and select <em>General</em>.</li><li>In the <em>General</em> settings page, look for the <em>Export</em> section and press the <em>Export</em> button corresponding to <em>Workspace content</em>.</li><li>Ensure the following options are set:<ul><li>Export format: HTML</li><li>Page content: Everything</li><li>Include subpages: On</li><li>Create folders for subpages: On</li></ul></li><li>Press the Export button.</li><li>Wait for the download to finish. Depending on the size of your workspace it might take a while. You will get a downloadable copy via email if takes too long.</li></ul></li></ul><p>In Trilium Notes:</p><ol><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, right click and select <em>Import into note</em>.</li><li>In the <em>Import from</em> section, select <em>Notion</em>.</li><li>Upload the ZIP obtained in the previous step.</li></ol><h2>Supported features</h2><p>The following features are preserved by Trilium during the import process:</p><ul><li>Basic formatting (bold, italic, underline, strikethrough, headings, colors, highlights).</li><li><a class=\"reference-link\" href=\"#root/_help_S6Xx8QIWTV66\">Lists</a></li><li>To-do lists</li><li><a class=\"reference-link\" href=\"#root/_help_mT0HEkOsz6i1\">Images</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>.</li><li>Toggle sections<ul><li>Nested toggle sections are also supported.</li><li>Toggle headings are stripped of their toggle button and become normal headings instead.</li></ul></li><li><a class=\"reference-link\" href=\"#root/_help_YfYAtQBcfo5V\">Math Equations</a>&nbsp;(inline or block)</li><li><a class=\"reference-link\" href=\"#root/_help_UmgZAfcltxkS\">Link Previews</a><ul><li>The icon and image of the links need to be retrieved online since the exports don't carry the images. This operation is done only if <em>Download images automatically</em> is enabled in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Media</em>.</li></ul></li><li><a class=\"reference-link\" href=\"#root/_help_QxEyIjRBizuC\">Code blocks</a>, with a best-effort attempt to restore the language.</li><li><a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a></li><li>Links between other imported pages are converted to&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;if they are part of the same import.</li><li>Databases are imported as&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>&nbsp;(see below).</li><li><a href=\"#root/_help_NwBbFdNZ9h7O\">Admonitions</a> are preserved, including its emoji (added as part of the content).</li><li>Columns are imported as transparent <a href=\"#root/_help_NdowYOC1GFKS\">tables</a>, preserving the column definition.</li><li>Table of content blocks are <em>removed</em>, as the table of contents is already present in the sidebar (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_BFvAtE74rbP6\">Table of contents</a>), as well as in shared notes.</li></ul><h2>Databases</h2><p>Notion databases are imported into&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>, where each item of the database is saved as a page in the collection. Through the use of <a href=\"#root/_help_bwZpz2ajCEwO\">inherited</a>&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>, most of the page properties in Notion are preserved by the import.</p><p>The resulting collection will be&nbsp;<a class=\"reference-link\" href=\"#root/_help_2FvYrpmOXm29\">Table</a>&nbsp;regardless of the original view the database was exported in. That's because the active view is not saved in the export and the table collection is the most compatible with Notion.</p><table>\n <thead>\n <tr>\n <th scope=\"col\">Notion type</th>\n <th scope=\"col\">Trilium</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>Text / Select / Status / Place</td>\n <td>Single-valued <code spellcheck=\"false\">text</code> label</td>\n </tr>\n <tr>\n <td>Number</td>\n <td>Single-valued <code spellcheck=\"false\">number</code> label for plain numbers. Formatted values (currency, percent, thousands separators) are normalized to a bare number, e.g. <code spellcheck=\"false\">$1,200.50</code> → <code spellcheck=\"false\">1200.50</code>.</td>\n </tr>\n <tr>\n <td>ID</td>\n <td>Single-valued <code spellcheck=\"false\">number</code> or <code spellcheck=\"false\">text</code> label (depending on whether a prefix is configured)</td>\n </tr>\n <tr>\n <td>Multi-select</td>\n <td>One text label per option (multi)</td>\n </tr>\n <tr>\n <td>URL / Email / Phone</td>\n <td><code spellcheck=\"false\">url</code> label (<code spellcheck=\"false\">mailto:</code>, <code spellcheck=\"false\">tel:</code> prefix)</td>\n </tr>\n <tr>\n <td>Date</td>\n <td><ul><li><code spellcheck=\"false\">datetime</code> if at least one has time.</li><li><code spellcheck=\"false\">date</code> if only dates.</li><li>Two attributes if any of the dates have an end date.</li></ul></td>\n </tr>\n <tr>\n <td>Checkbox</td>\n <td><code spellcheck=\"false\">boolean</code> label (<code spellcheck=\"false\">true</code>/<code spellcheck=\"false\">false</code>).</td>\n </tr>\n <tr>\n <td>Person</td>\n <td>One text label per user (multi)</td>\n </tr>\n <tr>\n <td>Created by / Edited by</td>\n <td>Single-valued <code spellcheck=\"false\">text</code> label</td>\n </tr>\n <tr>\n <td>Created time / Last edited time</td>\n <td>Assigned to the note's creation and modification date.</td>\n </tr>\n <tr>\n <td>Relation</td>\n <td>Mapped to <a href=\"#root/_help_Cq5X6iKQop6R\">relations</a>, each link resolved to its target note via the existing cross-page map; targets outside the import are dropped.</td>\n </tr>\n <tr>\n <td>Files &amp; Media</td>\n <td>The files are preserved as attachments, and a link to them is prepended to the content of the note for visibility.</td>\n </tr>\n <tr>\n <td>Formulas / Rollup</td>\n <td><p>A <code spellcheck=\"false\">text</code>, <code spellcheck=\"false\">number</code> or <code spellcheck=\"false\">boolean</code> label depending on the value. Dates are rendered as <code spellcheck=\"false\">text</code> because the export doesn't offer any type information.</p><p>The Notion export does not preserve the formula/rollup configuration itself, instead it just exports the value.</p></td>\n </tr>\n <tr>\n <td>Button / Verification / any other type</td>\n <td>Unsupported, they will be dropped from the import.</td>\n </tr>\n </tbody>\n</table><aside class=\"admonition note\"><p><strong>Technical information</strong></p><p>Every page property that can be preserved according to the table above is saved as a label or relation to the corresponding note (except for creation and modification dates which are saved at note level).</p><p>To maintain a similar UX to Notion, every property is also turned into&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;at collection level. This also makes the columns visible in the table collection. The promoted attributes are made inheritable so that they appear when navigating in the child notes as well.</p><p>The names of the labels are intentionally converted to <code spellcheck=\"false\">camelCase</code> to match Trilium's conventions, but the full name of the column is preserved through the <em>Alias</em> mechanism of promoted attributes.</p></aside><h2>Limitations</h2><h3>Missing data from the import</h3><p>The following information is not preserved by the import because it is not available in the export so it cannot be restored:</p><ul><li>The order of the pages and sub-pages.</li><li>Creation/modification dates are restored only when the page includes Created time / Last edited time properties (collection or not); otherwise the import time is used.</li></ul><h3>Cover images and page icon</h3><p>The page icon or emoji is not preserved, with created notes having the default icon. The cover image is not imported at all.</p><h2>Reporting issues</h2><p>When importing your Notion workspace, you might find issues in how a note is imported; in that case consider <a href=\"#root/_help_wy8So3yZZlH9\">reporting</a> it.</p><p>When reporting such an issue make sure to provide the following information:</p><ul><li>A .zip export of the original Notion note (and children if applicable). This allows us to reproduce the issue.</li><li>A screenshot with how it originally looked like before the import and how it looks after the import.</li></ul>",
- "_help_nhQVuO4zvIxi": "<p>Trilium can import notes from Google Keep, preserving their structure and formatting.</p><h2>Import process</h2><p>Google Keep has no native export process, but Google Takeout allows you to download a ZIP of all the notes.</p><p>The first step is to download your Google Keep information:</p><ol><li>Navigate to <a href=\"https://takeout.google.com/\">takeout.google.com</a>.</li><li>In the <em>Create a new export</em> section, press <em>Deselect all.</em></li><li>In the list of data to export, check <em>Keep</em>.</li><li>Scroll all the way down and choose <em>Next step</em>.</li><li>In <em>Choose file type, frequency &amp; destination</em> make sure the following options are set:<ol><li><em>Transfer to</em> is set to <em>Send download link via email</em>.</li><li><em>Frequency</em> is set to <em>Export once</em>.</li><li><em>File type</em> is set to <em>.zip</em>.</li><li><em>File size</em> can remain set to <em>2 GB</em>.</li></ol></li><li>Press <em>Create export</em> and wait for the export to finish.</li></ol><p>Then in Trilium Notes:</p><ol><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, right click and select <em>Import into note</em>.</li><li>In the <em>Import from</em> section, select <em>Google Keep</em>.</li><li>Upload the ZIP obtained in the previous step.</li></ol><h2>Supported features</h2><ul><li>Basic formatting (bold, italic, underline)</li><li><a href=\"#root/_help_p9kXRFAkwN4o\">Note color</a></li><li>Note titles are maintained, if present.<ul><li>In Google Keep it's common for notes not to have a title, case in which the date and time of the note are used as a title.</li></ul></li><li>To-do lists</li><li><a class=\"reference-link\" href=\"#root/_help_mT0HEkOsz6i1\">Images</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>.</li><li>Creation and modification dates are preserved.</li></ul><h2>Limitations</h2><p>Currently the following information is not imported:</p><ul><li>Labels are disregarded.</li><li>Pinned, archived or trashed state is not preserved, all notes are treated the same.</li></ul><h2>Reporting issues</h2><p>When importing your notes from Google Keep, you might encounter some issues with how the notes are imported, or there might be some missing information. In this case, consider <a href=\"#root/_help_wy8So3yZZlH9\">reporting it</a>.</p><p>When reporting such an issue make sure to provide the following information:</p><ul><li>A sample of the note is required to better understand what happened.<ul><li>Because Google Keep has no per-note export, extract the Google Takeout ZIP and copy the files corresponding to the problematic note (<code spellcheck=\"false\">.html</code>, <code spellcheck=\"false\">.json</code> and any attachments if you are able to identify them).</li></ul></li><li>A screenshot with how it originally looked like before the import and how it looks after the import.</li></ul>",
- "_help_syuSEKf2rUGr": "<p>Trilium can import ENEX files, which are used by Evernote for backup/export. One ENEX file represents the content (notes and resources) of one notebook.</p><h2>Import process</h2><p>The first step is to export the data from Evernote:</p><ul><li>To export a single notebook:<ul><li>In the left sidebar, select <em>Notebooks</em>.</li><li>If you have a notebook stack, expand it.</li><li>Right click on a notebook and select <em>Export notebook</em>.</li><li>Make sure the following options are set:<ul><li>File format is set to <em>ENEX format</em>.</li><li>All the options in <em>Export note attributes</em> are checked.</li></ul></li></ul></li><li>To export a bunch of notes (up to 100 notes):<ul><li>In the left sidebar, select <em>Notes</em>.</li><li>In the list of notes, <kbd>Ctrl</kbd>-click individual notes to select them. Alternatively, click on a note and then <kbd>Shift</kbd>-click a more distant note to select all the notes in between.</li><li>At the bottom there should be a floating bar with some options. Select […] → <em>Export.</em></li><li>Make sure the following options are set:<ul><li>File format is set to <em>ENEX format</em>.</li><li>All the options in <em>Export note attributes</em> are checked.</li></ul></li></ul></li><li>To export a single note:<ul><li>Select the note.</li><li>In the top-right, press the […] button and select <em>Export</em>.</li><li>Make sure the following options are set:<ul><li>File format is set to <em>ENEX format</em>.</li><li>All the options in <em>Export note attributes</em> are checked.</li></ul></li></ul></li></ul><aside class=\"admonition tip\"><p>To export multiple notebooks in bulk, consider using a third-party CLI tool called <a href=\"https://github.com/vzhd1701/evernote-backup\">evernote-backup</a></p></aside><p>Once you have your ENEX files, do the following to import them in Trilium:</p><ol><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, right click and select <em>Import into note</em>.</li><li>In the <em>Import from</em> section, select <em>Evernote</em>.</li><li>During the import, you will see \"Import in progress\" message. If the import is successful, the message will change to “Import finished successfully” and then disappear.</li><li>We recommend you to check the imported notes and their attachments to verify that you haven’t lost any data.</li></ol><h2>Supported features</h2><p>The following features are preserved by Trilium during the import process:</p><ul><li>Basic formatting (bold, italic, underline, strikethrough, colors, highlights, superscript, subscript, text alignment, inline code).</li><li>The hierarchy of headings (these are shifted to start with H2 because H1 is reserved for note title, see&nbsp;<a href=\"#root/_help_Gr6xFaF6ioJ5\">Headings</a>)</li><li>To-do lists. The new task format is collapsed to standard to-do lists</li><li><a class=\"reference-link\" href=\"#root/_help_mT0HEkOsz6i1\">Images</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a></li><li><a class=\"reference-link\" href=\"#root/_help_S6Xx8QIWTV66\">Lists</a>&nbsp;(with bullets or with numbers)</li><li><a class=\"reference-link\" href=\"#root/_help_NdowYOC1GFKS\">Tables</a></li><li>Block quotes</li><li><a href=\"#root/_help_NwBbFdNZ9h7O\">Admonitions</a> are preserved, including its emoji (added as part of the content).</li><li><a class=\"reference-link\" href=\"#root/_help_QxEyIjRBizuC\">Code blocks</a>, with a best-effort attempt to restore the language.</li><li><a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a></li><li><a class=\"reference-link\" href=\"#root/_help_YfYAtQBcfo5V\">Math Equations</a></li><li>Toggle sections</li><li>External links</li><li>Internal links are re-written to&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;if the target note is part of the same import.</li></ul><h2>Limitations</h2><ul><li>The size limit of one import is 250Mb. If the total size of your files is larger, you can increase the&nbsp;<a href=\"#root/_help_WOcw2SLH6tbX\">upload limit</a>, or divide your files, and run the import as many times as necessary.</li><li>All resources (except for images) are created as notes’ attachments.</li><li>If you have HTML inside ENEX files, the HTML formatting may be broken or lost after import in Trilium. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_wy8So3yZZlH9\">Reporting issues</a>.</li></ul><h3>Links to other notes</h3><p>Since v0.104.0, the ENEX importer tries to recreate links to other notes automatically by converting their Evernote-specific URLs to Trilium's&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>.</p><p>Since the ENEX format does not provide the unique ID of notes, the note references are determined via their note title.</p><p>Limitations:</p><ul><li>Only notes that are part of the same import will have their links rewritten to reference links, to avoid linking to the wrong note.</li><li>If there are to notes with the same name, internal links will not be created to avoid pointing to the wrong note.</li><li>Links that couldn't be rewritten (e.g. referring to a missing/duplicate note) will be kept with their original <code spellcheck=\"false\">evernote://</code> URL.</li><li>It will not fix links to anchors and links to notes that you renamed in Evernote after you created the links.</li></ul><h4>Post-processing notes</h4><aside class=\"admonition tip\"><p>This script allows rewriting links after the import has been done, and it should also allow finding links between two different imports.</p></aside><p>If you want to restore the internal links in Trilium after you import all of your ENEX files, you can use or adapt this custom script:&nbsp;<a class=\"reference-link\" href=\"#root/_help_dj3j8dG4th4l\">Process internal links by title</a></p><p>The script does the following:</p><ol><li>It finds all Evernote internal links.</li><li>For each one, it checks if its link text matches a note title, and if yes, it replaces the Evernote link with an internal Trilium link. If not, it leaves the Evernote link in place.</li><li>If it finds more than one note with a matching note title, it leaves the Evernote link in place.</li><li>It outputs the results in a log that you can see in the respective code note in Trilium.</li></ol><p>The script has the following limitations:</p><ul><li>It will not fix links to anchors and links to notes that you renamed in Evernote after you created the links.</li><li>Some note titles might not be well identified, even if they exist. This is especially the case if the note title contains some special characters. Should this be problematic, consider&nbsp;<a class=\"reference-link\" href=\"#root/_help_wy8So3yZZlH9\">Reporting issues</a>.</li></ul><h2>Reporting issues</h2><p>When importing your Evernote notebooks, you might find issues in how a note is imported; in that case consider <a href=\"#root/_help_wy8So3yZZlH9\">reporting</a> it.</p><p>When reporting such an issue make sure to provide the following information:</p><ul><li>A <code spellcheck=\"false\">.enex</code> export of the original note. This allows us to reproduce the issue.</li><li>A screenshot with how it originally looked like before the import and how it looks after the import.</li></ul>",
- "_help_dj3j8dG4th4l": "const query = `note.type = \"text\" and note.content *=* \"evernote:///view/\"`;\r\nconst notes = api.searchForNotes(query);\r\n\r\nfor (const note of notes) {\r\n api.log(`Processing note ${note.title}...`);\r\n \r\n const content = note.getContent();\r\n const $ = api.cheerio.load(content);\r\n \r\n $(\"a\").each((i, el) => {\r\n const $el = $(el);\r\n \r\n const url = $el.attr(\"href\");\r\n if (!url.startsWith(\"evernote:///\")) return;\r\n\r\n const text = $el.text();\r\n const matchingNotes = api.searchForNotes(`note.title = \"${text}\"`);\r\n if (matchingNotes.length === 0) {\r\n api.log(`No matching notes for \"${text}...\"`);\r\n return;\r\n }\r\n\r\n if (matchingNotes.length > 1) {\r\n api.log(`Found multiple matching notes for \"${text}\". Skipping.`);\r\n return;\r\n }\r\n\r\n const matchingNote = matchingNotes[0];\r\n \r\n api.log(`Found matching note: ${matchingNote.title} ${matchingNote.noteId}`);\r\n $el.attr(\"href\", `#root/${matchingNote.noteId}`);\r\n $el.addClass(\"reference-link\");\r\n });\r\n note.setContent($(\"body\").html()); \r\n}",
- "_help_83zmPBJRgfnW": "<p>Starting with v0.104.0, Trilium is able to import data from Anytype from JSON imports which preserve most of the formatting and the metainformation.</p><h2>Import process</h2><p>The first step is to export the data from Anytype:</p><ul><li>To export a single page:<ul><li>Select the page to export.</li><li>Press the […] at the top-right of the window and select <em>Export</em>.</li><li>Ensure the following options are set:<ul><li>Export format: Any-Block</li><li>File Format: JSON</li><li>Zip archive: On</li><li>Include linked objects: On</li><li>Include files: On</li><li>Include archived objects: On</li></ul></li></ul></li><li>To export an entire channel:<ul><li>Select the desired channel from the left bar.</li><li>Underneath the channel icon in the left sidebar, press the name of the channel with an arrow and select <em>Channel Settings</em>.</li><li>In the left sidebar, look for the <em>Integrations</em> section and select <em>Export</em>.</li><li>Press <em>Any-Block</em>.</li><li>Ensure the following options are set:<ul><li>File Format: JSON</li><li>Zip archive: On</li><li>Include files: On</li><li>Include archived objects: On</li></ul></li></ul></li></ul><p>In Trilium Notes:</p><ol><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, right click and select <em>Import into note</em>.</li><li>In the <em>Import from</em> section, select <em>Anytype</em>.</li><li>Upload the ZIP.</li></ol><aside class=\"admonition note\"><p>Exporting collections individually can sometimes miss information that would otherwise be picked up from an export of the entire channel. The reason is that Anytype leaves out some information when exporting individual pages/collections.</p></aside><h2>Supported features</h2><p>The following features are preserved by Trilium during the import process:</p><ul><li>Basic formatting (bold, italic, underline, strikethrough, headings, colors, highlights, inline code).</li><li><a class=\"reference-link\" href=\"#root/_help_S6Xx8QIWTV66\">Lists</a>&nbsp;(numbered or bullet)</li><li><a class=\"reference-link\" href=\"#root/_help_mT0HEkOsz6i1\">Images</a>&nbsp;and files are handled as&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>.</li><li>To-do lists</li><li>Toggle sections</li><li><a class=\"reference-link\" href=\"#root/_help_NdowYOC1GFKS\">Tables</a></li><li>Inline&nbsp;<a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a></li><li><a class=\"reference-link\" href=\"#root/_help_YfYAtQBcfo5V\">Math Equations</a></li><li>Highlight blocks are imported as block quotes.</li><li><a class=\"reference-link\" href=\"#root/_help_QxEyIjRBizuC\">Code blocks</a>, with a best-effort attempt to restore the language.</li><li>Links between other imported pages are converted to&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;if they are part of the same import.<ul><li>Applies to both block links and inline links.</li></ul></li><li>Collections are imported as&nbsp;Trilium-native&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>&nbsp;(see below).<ul><li>Files inside collections are imported as&nbsp;<a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a>&nbsp;notes.</li></ul></li><li>Dividers (line, dots) are imported as horizontal rules.</li><li><a href=\"#root/_help_NwBbFdNZ9h7O\">Admonitions</a> are preserved, including its emoji (added as part of the content).</li><li>Creation and modification date of pages is preserved.</li></ul><h2>Collections</h2><p>Collections created in Anytype are imported on a best-effort basis, preserving both the view mode and the page properties as&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>.</p><p>The following view modes are supported:</p><ul><li>List as&nbsp;<a class=\"reference-link\" href=\"#root/_help_mULW0Q3VojwY\">List View</a></li><li>Gallery as&nbsp;<a class=\"reference-link\" href=\"#root/_help_8QqnMzx393bx\">Grid View</a></li><li><a class=\"reference-link\" href=\"#root/_help_xWbu3jpNWapp\">Calendar</a>, preserving the attribute which identifies the date.</li><li><a class=\"reference-link\" href=\"#root/_help_CtBQqbwXDx1w\">Kanban Board</a>, preserving the board group column.</li><li><a class=\"reference-link\" href=\"#root/_help_2FvYrpmOXm29\">Table</a>, also used as fallback for unsupported collection layouts.</li></ul><p>The following types are supported:</p><table>\n <thead>\n <tr>\n <th scope=\"col\">Anytype property type</th>\n <th scope=\"col\">Trilium</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>Text / Select</td>\n <td>Single-valued <code spellcheck=\"false\">text</code> label</td>\n </tr>\n <tr>\n <td>Number</td>\n <td>Single-valued <code spellcheck=\"false\">number</code> label</td>\n </tr>\n <tr>\n <td>Multi-select</td>\n <td>One <code spellcheck=\"false\">text</code> label per option (multi)</td>\n </tr>\n <tr>\n <td>Date / Date with time</td>\n <td><ul><li><code spellcheck=\"false\">datetime</code> if the time is included.</li><li><code spellcheck=\"false\">date</code> if only dates.</li></ul></td>\n </tr>\n <tr>\n <td>File</td>\n <td>The files are preserved as attachments, and a link to them is prepended to the content of the note for visibility.</td>\n </tr>\n <tr>\n <td>Checkbox</td>\n <td><code spellcheck=\"false\">boolean</code> label (<code spellcheck=\"false\">true</code>/<code spellcheck=\"false\">false</code>).</td>\n </tr>\n <tr>\n <td>URL / Email / Phone</td>\n <td><code spellcheck=\"false\">url</code> label (<code spellcheck=\"false\">mailto:</code>, <code spellcheck=\"false\">tel:</code> prefix)</td>\n </tr>\n </tbody>\n</table><h2>Reporting issues</h2><p>When importing your Anytype notes, you might find issues in how a note is imported; in that case consider <a href=\"#root/_help_wy8So3yZZlH9\">reporting</a> it.</p><p>When reporting such an issue make sure to provide the following information:</p><ul><li>A .zip export of the original note (and children if applicable). This allows us to reproduce the issue.</li><li>A screenshot with how it originally looked like before the import and how it looks after the import.</li></ul>",
- "_help_iWD7wiIuMtgV": "<p>Although Obsidian was indirectly supported through the standard&nbsp;<a class=\"reference-link\" href=\"#root/_help_Oau6X9rCuegd\">Markdown</a>&nbsp;import, its vault structure is distinct enough to warrant its own dedicated import channel.</p><h2>Import process</h2><p>The first step is to obtain a .zip of your Obsidian vault:</p><ol><li>First, identify where your Obsidian vault is located. The easiest way to do so is to open Obsidian and right clicking the name of the vault at the bottom of the left sidebar and then selecting <em>Show in system explorer</em>.</li><li>In your system explorer, right click the directory containing your Obsidian vault and compress it to a ZIP file (e.g. on Windows, <em>Compress To</em> → <em>ZIP</em>).</li></ol><aside class=\"admonition tip\"><p>When zipping, you can either ZIP the outer folder of the vault, or the contents of the vault as Trilium will automatically determine the position of the vault in the archive via the <code spellcheck=\"false\">.obsidian</code> directory.</p></aside><p>Then, in Trilium Notes:</p><ol><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, right click and select <em>Import into note</em>.</li><li>In the <em>Import from</em> section, select <em>Obsidian</em>.</li><li>Upload the ZIP obtained in the previous step.</li></ol><h2>Supported features</h2><p>The following features are preserved by Trilium during the import process:</p><ul><li>Folder hierarchy is preserved.</li><li>Basic Markdown formatting (bold, italic, underline, strikethrough, headings).</li><li>Specific Obsidian formatting (highlighting).</li><li><a class=\"reference-link\" href=\"#root/_help_S6Xx8QIWTV66\">Lists</a></li><li>To-do lists</li><li><a class=\"reference-link\" href=\"#root/_help_mT0HEkOsz6i1\">Images</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a><ul><li>Non-Markdown files in the Vault are treated as attachments by default if they are referenced by at least one note.</li><li>Otherwise, they will be imported as&nbsp;<a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a>&nbsp;notes.</li></ul></li><li>Transclusions are converted to&nbsp;<a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>&nbsp;or&nbsp;<a class=\"reference-link\" href=\"#root/_help_mT0HEkOsz6i1\">Images</a>&nbsp;(depending on type).</li><li><a class=\"reference-link\" href=\"#root/_help_YfYAtQBcfo5V\">Math Equations</a>&nbsp;(inline or block)</li><li><a class=\"reference-link\" href=\"#root/_help_QxEyIjRBizuC\">Code blocks</a>, with a best-effort attempt to restore the language.</li><li>Links between pages are converted to&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>.</li><li>Callouts are converted to Trilium's <a href=\"#root/_help_NwBbFdNZ9h7O\">Admonitions</a>.<ul><li>Obsidian has many more types of callouts (<code spellcheck=\"false\">tldr</code>, <code spellcheck=\"false\">question</code>, <code spellcheck=\"false\">attention</code>), these are all mapped to one of Trilium's existing admonition types (e.g. Note, Tip, Important).</li><li>Custom titles are kept and shown as a bold line at the top of the admonition, since there is no concept of admonition title in Trilium.</li><li>Foldable callouts are imported expanded and without a fold marker.</li></ul></li><li>Notes created by the <a href=\"https://github.com/zsviczian/obsidian-excalidraw-plugin\"><em>Excalidraw</em></a> community plugin for Obsidian are converted to&nbsp;<a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a>&nbsp;(same underlying technology).<ul><li>Note that custom features introduced by that plugin will not be supported.</li></ul></li><li>Modification date is preserved via the information obtained from the .zip archive, creation date is not recoverable so it's kept the same as the modification date.</li></ul><h2>Properties</h2><p>Properties are Obsidian's equivalent of&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>. One of the core differences between the two is where the property information is stored (i.e. name and type): in Obsidian everything is stored at vault level and shared across all notes, whereas in Trilium each page can have individual promoted attributes, shared through&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>&nbsp;or&nbsp;<a class=\"reference-link\" href=\"#root/_help_bwZpz2ajCEwO\">Attribute Inheritance</a>.</p><p>Another important difference is that promoted attributes in Trilium are always displayed, even if empty. In Obsidian, these are simply suggested when creating a new property.</p><p>To reconcile all these differences, properties are converted to&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;at note level.</p><p>The following note types are supported:</p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Obsidian type</th>\n<th>Trilium</th>\n</tr>\n</thead>\n<tbody><tr>\n<td>Text or not defined</td>\n<td>Single-valued <code spellcheck=\"false\">text</code> label</td>\n</tr>\n<tr>\n<td>Number</td>\n<td>Single-valued <code spellcheck=\"false\">number</code> label</td>\n</tr>\n<tr>\n<td>Multitext</td>\n<td>Multi-valued <code spellcheck=\"false\">text</code> label</td>\n</tr>\n<tr>\n<td>Checkbox</td>\n<td><code spellcheck=\"false\">boolean</code> label (<code spellcheck=\"false\">true</code>/<code spellcheck=\"false\">false</code>).</td>\n</tr>\n<tr>\n<td>Date</td>\n<td><code spellcheck=\"false\">date</code></td>\n</tr>\n<tr>\n<td>Date &amp; Time</td>\n<td><code spellcheck=\"false\">datetime</code></td>\n</tr>\n</tbody></table></figure><h3>Special properties</h3><p>Obsidian has a few reserved property names, which are treated differently in Trilium as well:</p><ul><li><code spellcheck=\"false\">tags</code>, where every tag is turned into its own <a href=\"#root/_help_HI6GBBIduIgv\">label</a> (e.g. <code spellcheck=\"false\">#one</code>, <code spellcheck=\"false\">#two</code> when <code spellcheck=\"false\">tags: [ one, two ]</code>).</li><li><code spellcheck=\"false\">aliases</code> are simply mapped to individual <code spellcheck=\"false\">#alias</code> labels</li><li><code spellcheck=\"false\">cssclasses</code>, <code spellcheck=\"false\">publish</code>, <code spellcheck=\"false\">permalink</code> are ignored.</li></ul><h2>Limitations</h2><ul><li>Comments (<code spellcheck=\"false\">%%</code> syntax) are simply stripped.</li><li>Obsidian <em>bases</em> functionality is not preserved.<ul><li>The closest equivalent in Trilium would be&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>&nbsp;but they work fundamentally different because bases don't store particular notes, they act more like a&nbsp;<a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a>&nbsp;with a collection view.</li><li>Since the base query format is quite different to Trilium's&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>&nbsp;syntax, it's unlikely they'll ever be supported.</li><li>When a base is encountered, it is simply ignored from the import.</li></ul></li><li>Canvases are not imported.<ul><li>Theoretically they could map to either&nbsp;<a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a>&nbsp;or&nbsp;<a class=\"reference-link\" href=\"#root/_help_iRwzGnHPzonm\">Relation Map</a>&nbsp;but they are too different to reconcile.</li></ul></li><li>Links<ul><li>Links to a specific heading in another note will still point to the right note, but the heading anchor will be dropped.</li><li>Dangling links (pointing to a note that doesn't exist) and ambiguous links (same base name in 2+ notes) are unwrapped to plain text.</li></ul></li></ul>",
- "_help_rC3pL2aptaRE": "<p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/3_Zen%20mode_image.png\"></p><p>Screenshot of Zen Mode activated on a Windows 11 system with native title bar off and background effects on.</p><p>When Zen Mode is activated (pictured on the side), most of the user interface of Trilium is hidden away in order to be able to focus on the content, whether it's for reading or writing.</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/2_Zen%20mode_image.png\"></p><p>Screenshot of the Zen Mode option in the global menu.</p><h2>Activating &amp; deactivating</h2><p>The Zen Mode can be activated by accessing the global menu and selecting the “Zen Mode” option:</p><p>Aside from the global menu, it's also possible to activate this mode by using a keyboard shortcut (which is <kbd>F9</kbd> since TriliumNext 0.92.5 and <kbd>Alt</kbd>+<kbd>Z</kbd> for older versions). Look for <code spellcheck=\"false\">toggleZenMode</code> in the shortcut configuration.</p><p>Once Zen Mode is activated, all the UI elements of the application will be hidden away, including the global menu. In that case, the Zen Mode can be deactivated either by pressing the <img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Zen%20mode_image.png\"> icon in the top-right corner of the window or by pressing the keyboard combination again.</p><p>Do note that, by design, activating or deactivating the Zen Mode applies only to the current window. Restarting the application will also disable the Zen Mode.</p><h2>Moving the window around</h2><p>If “Native title bar” is activated, then the operating system's default title bar can be used to drag the window around. If deactivated, the window can still be moved by dragging the mouse across the top part of the window where the note titles are.</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/1_Zen%20mode_image.png\"></p><p>Screenshot of two notes side-by-side while Zen Mode is active, on Windows 11 with background effects off.</p><h2>Split windows and tabs</h2><p>Tabs are completely hidden, however it's still possible to use keyboard shortcuts such as <code spellcheck=\"false\">firstTab</code> (<kbd>Ctrl</kbd>+<kbd>1</kbd> by default), <code spellcheck=\"false\">secondTab</code> (<kbd>Ctrl</kbd>+<kbd>2</kbd> by default). There are also some newer shortcuts such as <code spellcheck=\"false\">activateNextTab</code> (<kbd>Ctrl</kbd>+<kbd>Tab</kbd>) or <code spellcheck=\"false\">activatePreviousTab</code> (<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Tab</kbd>) that allow easy navigation, however make sure that they are configured properly in the settings.</p><p>For the split view of notes, there are no keyboard shortcuts at the time of writing, but it's still possible to have them in Zen Mode by creating the split while the Zen Mode is off and then reactivating it afterwards.</p>",
- "_help_YzMcWlCVeW09": "<p><em>Active content</em> is a generic name for powerful features in Trilium, these range from customizing the UI to advanced scripting that can alter your notes or even your PC.</p><h2>Safe import</h2><p>Active content problem of safety, especially when this active content comes from a third-party such as if it is downloaded from a website and then imported into Trilium.</p><p>When <a href=\"#root/_help_mHbBMPDPkVV5\">importing</a> .zip archives into Trilium, <em>safe mode</em> is active by default which will try to prevent untrusted code from executing. For example, a <a href=\"#root/_help_MgibgPcfeuGz\">custom widget</a> needs the <code spellcheck=\"false\">#widget</code> <a href=\"#root/_help_HI6GBBIduIgv\">label</a> in order to function; safe import works by renaming that label to <code spellcheck=\"false\">#disabled:widget</code>.</p><h2>Safe mode</h2><p>Sometimes active content can cause issues with the UI or the server, preventing it from functioning properly.&nbsp;<a class=\"reference-link\" href=\"#root/_help_64ZTlUPgEPtW\">Safe mode</a>&nbsp;allows starting Trilium in such a way that active content is not loaded by default at start-up, allowing the user to fix the problematic scripts or widgets.</p><h2>Types of active content</h2><p>These are the types of active content in Trilium, along with a few examples of what untrusted content of that type could cause:</p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Disabled on a safe <a href=\"#root/_help_mHbBMPDPkVV5\">import</a></th>\n<th>Description</th>\n<th>Potential risks of untrusted code</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><a href=\"#root/_help_yIhgI5H7A2Sm\">Front-end scripts</a></td>\n<td>Yes</td>\n<td>Allow running arbitrary code on the client (UI) of Trilium, which can alter the user interface.</td>\n<td>A malicious script can execute server-side code, access un-encrypted notes or change their contents.</td>\n</tr>\n<tr>\n<td><a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a></td>\n<td>Yes</td>\n<td>Can add new UI features to Trilium, for example by adding a new section in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>.</td>\n<td>The UI can be altered in such a way that it can be used to extract sensitive information or it can simply cause the application to crash.</td>\n</tr>\n<tr>\n<td><a class=\"reference-link\" href=\"#root/_help_SPirpZypehBG\">Backend scripts</a></td>\n<td>Yes</td>\n<td>Can run custom code on the server of Trilium (Node.js environment), with full access to the notes and the database.</td>\n<td>Has access to all the unencrypted notes, but with full access to the database it can completely destroy the data. It also has access to execute other applications or alter the files and folders on the server).</td>\n</tr>\n<tr>\n<td><a class=\"reference-link\" href=\"#root/_help_1vHRoWCEjj0L\">Web View</a></td>\n<td>Yes</td>\n<td>Displays a website inside a note.</td>\n<td>Can point to a phishing website which can collect the data (for example on a log in page).</td>\n</tr>\n<tr>\n<td><a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a></td>\n<td>Yes</td>\n<td>Renders custom content inside a note, such as a dashboard or a new editor that is not officially supported by Trilium.</td>\n<td>Can affect the UI similar to front-end scripts or custom widgets since the scripts are not completely encapsulated, or they can act similar to a web view where they can collect data entered by the user.</td>\n</tr>\n<tr>\n<td><a class=\"reference-link\" href=\"#root/_help_AlhDUqhENtH7\">Custom app-wide CSS</a></td>\n<td>No</td>\n<td>Can alter the layout and style of the UI using CSS, applied regardless of theme.</td>\n<td>Generally less problematic than the rest of active content, but a badly written CSS can affect the layout of the application, requiring the use of&nbsp;<a class=\"reference-link\" href=\"#root/_help_64ZTlUPgEPtW\">Safe mode</a>&nbsp;to be able to use the application.</td>\n</tr>\n<tr>\n<td><a href=\"#root/_help_pKK96zzmvBGf\">Custom themes</a></td>\n<td>No</td>\n<td>Can change the style of the entire UI.</td>\n<td>Similar to custom app-wide CSS.</td>\n</tr>\n<tr>\n<td><a class=\"reference-link\" href=\"#root/_help_gOKqSJgXLcIj\">Icon Packs</a></td>\n<td>No</td>\n<td>Introduces new icons that can be used for notes.</td>\n<td>Generally are more contained and less prone to cause issues, but they can cause performance issues (for example if the icon pack has millions of icons in it).</td>\n</tr>\n</tbody></table></figure><h2>Active content badge</h2><p>Starting with v0.102.0, on the&nbsp;<a class=\"reference-link\" href=\"#root/_help_IjZS7iK5EXtb\">New Layout</a>&nbsp;a badge will be displayed near the note title, indicating that an active content is detected. Clicking the badge will reveal a menu with various options related to that content type, for example to open the documentation or to configure the execution of scripts.</p><p>For some active content types, such as backend scripts with custom triggering conditions a toggle button will appear. This makes it possible to easily disable scripts or widgets, but also to re-enable them if an import was made with safe mode active.</p>",
++ "_help_rJ9grSgoExl9": "<p><a href=\"https://github.github.com/gfm/\">GitHub-Flavored Markdown</a> is the main syntax that Trilium is following.</p><h2>Images</h2><p>When exporting, images are usually kept in the basic Markdown syntax but will use the HTML syntax if the image has a custom width. Figures are always embedded as HTML.</p><h2>Tables</h2><p>Simple tables are supported with the Markdown syntax. If the table is too complex or contains elements that would render as HTML, the table is also rendered as HTML.</p><h2>Links</h2><p>Standard Markdown links are supported.</p><p>Trilium internal links (that mirror a note's title and display its icon) are embedded as HTML in order to preserve the information on import.</p><h2>Math equations</h2><p>Both inline and display equations are supported, using the <code>$</code> and <code>$$</code> syntaxes.</p><h2>Admonitions</h2><p>The Markdown syntax for admonitions as supported by Trilium is the one that GitHub uses, which is as follows:</p><pre><code class=\"language-text-x-trilium-auto\">&gt; [!NOTE]\n&gt; This is a note.\n\n&gt; [!TIP]\n&gt; This is a tip.\n\n&gt; [!IMPORTANT]\n&gt; This is a very important information.\n\n&gt; [!CAUTION]\n&gt; This is a caution.</code></pre><p>There are currently no plans of supporting alternative admonition syntaxes such as <code>!!! note</code>.</p><h2>Tabs</h2><p>Tabs use the syntax of <a href=\"https://squidfunk.github.io/mkdocs-material/reference/content-tabs/\">Material for MkDocs</a>: each tab starts with a <code>=== \"Title\"</code> line, followed by its content indented by four spaces. Consecutive tabs form one tabs block, and <code>===!</code> starts a new block right after another one:</p><pre><code class=\"language-text-x-trilium-auto\">=== \"Windows\"\n\n Run the **installer**.\n\n=== \"Linux\"\n\n Use the package.\n\n===! \"Another block\"\n\n This tab starts a separate tabs block.</code></pre><p>Tabs can be nested by indenting the inner tabs inside the content of a tab. A tab title is plain text, so its formatting is not kept on export. For how tabs blocks work in a text note, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_EK2ckIZ74tbT\">Content tabs</a>.</p><h2>Wikilinks</h2><p>Basic support for wikilinks has been added in v0.96.0:</p><ul><li><code>[[foo/bar]]</code> will look for the <code>bar.md</code> file in the <code>foo</code> directory and turn it into an internal link.</li><li><code>![[foo/baz.png]]</code> will look for the <code>baz.png</code> file in the <code>foo</code> directory and turn it into an image.</li></ul><p>This feature is import-only, which means that it will turn wikilinks into Trilium-compatible syntax, but it will not export Trilium Notes into Markdown files with this syntax.</p><aside class=\"admonition important\"><p>The path to pages in wikilinks is resolved relatively to the <em>import root</em> and not the current directory of the note. This is to be inline with other platforms that use wikilinks such as SilverBullet.</p><p>The root path of the import is determined as follows:</p><ul><li>If there is a single directory within the archive at root level, then that directory is considered the root.</li><li>If there are multiple files &amp; directories at root level, then the archive root (containing all of these items) is considered the root.</li></ul></aside><h2>Highlights</h2><p>Background highlights are supported in two ways:</p><ul><li><p>The Markdown <code>==</code> extension which is supported by other Markdown-based applications such as Obsidian:</p><pre><code class=\"language-text-x-trilium-auto\">==highlighted==</code></pre></li><li><p>The canonical HTML representation of highlights, as supported by Trilium:</p><pre><code class=\"language-text-html\">&lt;span style=\"background-color:hsl(0,0%,100%);\"&gt;Highlighted&lt;/span&gt;</code></pre></li></ul><p>When the yellow highlight is used, import/export prefers the <code>==</code> syntax whereas the canonical HTML reprepresentation is used otherwise.</p>",
++ "_help_ckZ2uNWQmVeX": "<p>Starting with version v0.104.0, Trilium's importer was expanded to application-specific imports. Unlike the standard HTML or&nbsp;<a class=\"reference-link\" href=\"#root/_help_Oau6X9rCuegd\">Markdown</a>&nbsp;import/export, these importers are tailored to support the features and note structure of a particular application.</p><h2>Supported applications</h2><ul><li><a class=\"reference-link\" href=\"#root/_help_GnhlmrATVqcH\">Microsoft OneNote</a>, by connecting to your account using Microsoft Graph.</li><li><a class=\"reference-link\" href=\"#root/_help_Y5mKeJ6dsCld\">Notion</a>, via a ZIP export.</li><li><a class=\"reference-link\" href=\"#root/_help_nhQVuO4zvIxi\">Google Keep</a>, via a ZIP export from <em>Google Takeout</em> (Keep has no dedicated export mechanism).</li><li><a class=\"reference-link\" href=\"#root/_help_syuSEKf2rUGr\">Evernote</a>, via an ENEX export.</li><li><a class=\"reference-link\" href=\"#root/_help_83zmPBJRgfnW\">Anytype</a>, via a JSON export.</li><li><a class=\"reference-link\" href=\"#root/_help_iWD7wiIuMtgV\">Obsidian</a>, via a ZIP of the vault.</li></ul><h2>Importing data from another application</h2><p>To import from an application, there are two ways to access the import dialog:</p><ul><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, right click on a note and select <em>Import into note</em>.</li><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>, select <em>Import files</em>.</li></ul><p>A list of supported applications will appear at the top, each with their own configuration. Simply click one and proceed with the on-screen instructions.</p><h2>Acknowledgement</h2><ul><li>Trilium's importer is inspired by Obsidian's <a href=\"https://github.com/obsidianmd/obsidian-importer\">Importer plugin</a> (licensed under the MIT license), for example regarding the OneNote connection process or the Notion ID management.</li></ul>",
++ "_help_GnhlmrATVqcH": "<p>Trilium allows importing from OneNote. Currently the only mechanism supported is via the Microsoft Graph API which requires you to authenticate in a browser in order for the notes to be obtained by Trilium.</p><h2>Import process</h2><ol><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, right click and select <em>Import into note</em>.</li><li>In the <em>Import from</em> section, select&nbsp;<span class=\"tn-icon tn-brand tn-brand-onenote\"></span> <em>OneNote</em>.</li><li>Press the <em>Connect</em> button:<ol><li>On the desktop app, you will be redirected to Microsoft's authentication screen where you can log into your account.</li><li>On the web app, the process is slightly more involved as it requires copying the code to clipboard, accessing the link, pasting the code and then signing in once more.</li></ol></li><li>After the connection is successful, you should be able to see a list of sections that can be imported. Simply check the ones to import and press the <em>Import selected</em> button.</li><li>Wait for the import to finish.</li></ol><h2>Supported features</h2><p>The following features are preserved by Trilium during the import process:</p><ul><li>Basic formatting (bold, italic, underline, strikethrough, subscript, super script, font sizes, headings, colors, highlights).<ul><li>Black-colored text is intentionally stripped to allow it to work in dark themes.</li></ul></li><li>Inline code is automatically detected and formatted. Paragraphs that use the Code style are also converted to&nbsp;<a class=\"reference-link\" href=\"#root/_help_QxEyIjRBizuC\">Code blocks</a>.<ul><li>Unfortunately the indentation of the code might be lost because the information is simply not present in the data from the Microsoft API.</li></ul></li><li><a class=\"reference-link\" href=\"#root/_help_S6Xx8QIWTV66\">Lists</a>&nbsp;with different bullet types.</li><li><a class=\"reference-link\" href=\"#root/_help_NdowYOC1GFKS\">Tables</a><ul><li>Cell backgrounds are preserved, including a best-effort hue correction because the colors returned by the Graph API are sometimes incorrect.</li><li>Cell widths are also preserved proportionally, with the only difference that tables in Trilium have a percentage-based width, not fixed pixel sizes.</li></ul></li><li>Images and&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>.<ul><li>Screen clippings are also properly supported since v0.104.1, displaying their timestamp as a figure caption.</li></ul></li><li>To-do lists</li><li>Hand-drawing is preserved and displayed as an SVG image inside the note<ul><li>OneNote's default color (black) is special since it also renders as white for dark themes. Since v0.104.1, this is also supported by using a special SVG tweak which reacts to light/dark themes.</li></ul></li><li>Links between other imported pages are converted to&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;if the text of the link matches the name of the page, or plain links otherwise. If the pages are not part of the import, the original <code>onenote:</code> link is kept.</li><li>Tags (apart from to-do lists) are preserved by converting them to <a href=\"#root/_help_hD8GawVuazff\">inline icons</a>, which are searchable by the icon's name and can be recolored like any other icon. Some icons are turned into emojis instead.</li></ul><p>Regarding the note structure:</p><ul><li>The order of the pages within a section is maintained.</li><li>Sub-pages and section groups are maintained by nesting notes in a hierarchical structure.</li><li>Creation and modification of both notes and sections is preserved. The order of section or section groups is not preserved (see limitations).</li></ul><h2>Error management and reporting</h2><p>The OneNote importer uses Microsoft's Graph API which handles the HTML export (that we later post-process for Trilium use). The Graph API itself has to process the OneNote pages before sending them to us, and as such it's a time-consuming operation that is directly proportional to the number of notes and the complexity/size of the notes.</p><p>The Graph API throttles access if it detects too many operations. The importer takes that into account, but sometimes this means that most of the time is spent waiting for the Graph API to unblock access rather than actually importing data.</p><p>In addition, some pages may fail at the Graph API level due to an internal timeout on their side or other issues. Trilium will try to refetch pages in order to avoid that but sometimes pages cannot be retrieved even after multiple retries. In that case, the importer will still create a corresponding note in Trilium but with an error report instead of a content. This preserves&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;and makes it easy to identify and manually fix the pages that failed.</p><p>At the end of the import, the top-level note called <em>OneNote</em> <em>import</em> will contain information about how the import went:</p><ul><li>The number of notes imported;</li><li>The success rate;</li><li>A list of notes that could not be imported, as well as the failure reason;</li><li>Pages whose images/attachments failed to download</li><li>How long the import spent waiting out throttling.</li></ul><p>To avoid cases in which the import is fundamentally broken (e.g. an expired sign-in), the import will error out if it fails to import 6 pages in a row.</p><h2>Attributes</h2><p>Pages imported from OneNote have a few built-in <a href=\"#root/_help_HI6GBBIduIgv\">labels</a>:</p><ul><li><code>oneNotePageId</code>, with the corresponding page ID in OneNote. This can be used to identify the original OneNote page. Trilium doesn't use it in any way at this moment.</li><li><code>oneNoteImportFailed</code> attached to notes that couldn't be imported. This can be used to quickly&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>&nbsp;for failed notes.</li></ul><h2>Limitations</h2><h3>Regarding OneNote's freehand structure</h3><p>OneNote is fundamentally different to Trilium in structure because it allows freehand drawing to coexist with text, and text boxes can be placed anywhere in the document (e.g. a common use case is to have columns). Trilium has a document flow mechanism for&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes which means that it can't be freely positioned.</p><p>To cope with this difference, Trilium will flatten the text structure into normal paragraphs. The paragraphs will be ordered visually based on the original position of the text boxes, but their horizontal position will not be preserved. Parallel text such as columns may appear interleaved which can cause problems.</p><p>In addition, drawing in OneNote can be interleaved with text boxes. Text notes in Trilium do not allow for this feature, so all drawing will appear at the end. For some use cases (diagrams, for example) this will work fine, but if you have highlights or other text-dependent drawings they will appear out of order.</p><aside class=\"admonition note\"><p>There are plans to support drawing-heavy notes that interleave with text boxes by converting them to a&nbsp;<a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a>&nbsp;instead.</p></aside><h3>Password-protected sections</h3><p>OneNote supports encryption at section level; when importing a notebook that contains these password-protection sections, Trilium will not be able to read the content of password-protected sections so they will appear empty. This is not a limitation of Trilium, the information is simply not available from the source (Graph API).</p><p>The section itself is kept for reference and all the sections that could not be imported will be shown in the report (the top-level note called <em>OneNote import</em>).</p><p>To unprotect a section in OneNote Desktop, right click on the protected section → <em>Password Protect This Section</em> and press <em>Remove Password</em> and sync. Then re-import either only the protected sections or remove everything and start the import from scratch.</p><h2>Other limitations</h2><p>The following are known limitations due to how the information comes from the import (Microsoft Graph API), which means that they cannot be fixed.</p><ul><li>The order of the sections (and section groups) is not available, the sections are ordered by creation date instead.</li><li>Revision history.</li><li>Paragraph indentation, as well as code block indentation.</li><li>Section colors.</li><li>Drawings inside titles, the title might appear incomplete or “Untitled”.</li></ul><h2>Reporting issues</h2><p>When importing notes, you might find that some text is not rendered properly or the structure is not properly maintained. As long as this issue is not a fundamental issue (like the issue with freehand text not being preserved exactly), it's a good idea to <a href=\"#root/_help_wy8So3yZZlH9\">report it</a>.</p><p>When reporting, make sure that you provide the following information:</p><ul><li>Import again the section, checking the debug checkbox before importing. This preserves the original document (and the hand-drawing data if any) as it came through from OneNote's cloud API so that it can be used for comparison.</li><li>Export only the affected page as ZIP, making sure not to accidentally expose any sensitive information.</li><li>Take screenshots of how the note looked like in OneNote and how it ends up in Trilium.</li><li>Attach the ZIP and the screenshots to the issue report.</li></ul>",
++ "_help_LpvyEIBIAAj7": "<p>OneNote's <em>Tags</em> functionality is imported in Trilium as&nbsp;<a class=\"reference-link\" href=\"#root/_help_hD8GawVuazff\">Icons</a>&nbsp;using the default icon pack or emojis (if there is no suitable replacement).</p><aside class=\"admonition important\"><p>Custom tags are not supported by OneNote's Graph API so Trilium cannot import them.</p></aside><h3>Decorative tags</h3><p>These remain formatted as paragraphs, with the glyph prepended to the text. A paragraph can carry several tags at once, in which case their glyphs stack.</p><figure class=\"table\"><table><thead><tr><th>OneNote tag</th><th><code>data-tag</code></th><th>Imported as</th><th>Searchable as</th></tr></thead><tbody><tr><td>Important</td><td><code>important</code></td><td><span class=\"tn-icon bx bx-star\"></span></td><td><code>star</code></td></tr><tr><td>Critical</td><td><code>critical</code></td><td><span class=\"tn-icon bx bx-error-circle\"></span></td><td><code>error-circle</code></td></tr><tr><td>Question</td><td><code>question</code></td><td><span class=\"tn-icon bx bx-help-circle\"></span></td><td><code>help-circle</code></td></tr><tr><td>Highlight</td><td><code>highlight</code></td><td><span class=\"tn-icon bx bx-highlight\"></span></td><td><code>highlight</code></td></tr><tr><td>Definition</td><td><code>remember-for-later</code></td><td><span class=\"tn-icon bx bx-pin\"></span></td><td><code>pin</code></td></tr><tr><td>Remember for later</td><td><code>remember-for-later</code></td><td><span class=\"tn-icon bx bx-pin\"></span></td><td><code>pin</code></td></tr><tr><td>Remember for blog</td><td><code>remember-for-blog</code></td><td><span class=\"tn-icon bx bx-edit\"></span></td><td><code>edit</code></td></tr><tr><td>Idea</td><td><code>idea</code></td><td><span class=\"tn-icon bx bx-bulb\"></span></td><td><code>bulb</code></td></tr><tr><td>Password</td><td><code>password</code></td><td><span class=\"tn-icon bx bx-key\"></span></td><td><code>key</code></td></tr><tr><td>Contact</td><td><code>contact</code></td><td><span class=\"tn-icon bx bx-user\"></span></td><td><code>user</code></td></tr><tr><td>Address</td><td><code>address</code></td><td><span class=\"tn-icon bx bx-home\"></span></td><td><code>home</code></td></tr><tr><td>Phone number</td><td><code>phone-number</code></td><td><span class=\"tn-icon bx bx-phone\"></span></td><td><code>phone</code></td></tr><tr><td>Web site to visit</td><td><code>web-site-to-visit</code></td><td><span class=\"tn-icon bx bx-globe\"></span></td><td><code>globe</code></td></tr><tr><td>Source for article</td><td><code>source-for-article</code></td><td><span class=\"tn-icon bx bx-news\"></span></td><td><code>news</code></td></tr><tr><td>Send in email</td><td><code>send-in-email</code></td><td><span class=\"tn-icon bx bx-envelope\"></span></td><td><code>envelope</code></td></tr><tr><td>Movie to see</td><td><code>movie-to-see</code></td><td><span class=\"tn-icon bx bx-movie\"></span></td><td><code>movie</code></td></tr><tr><td>Book to read</td><td><code>book-to-read</code></td><td><span class=\"tn-icon bx bx-book\"></span></td><td><code>book</code></td></tr><tr><td>Music to listen to</td><td><code>music-to-listen-to</code></td><td><span class=\"tn-icon bx bx-music\"></span></td><td><code>music</code></td></tr><tr><td>Project A</td><td><code>project-a</code></td><td>🅰️</td><td>🅰️</td></tr><tr><td>Project B</td><td><code>project-b</code></td><td>🅱️</td><td>🅱️</td></tr></tbody></table></figure><h3>Check box tags</h3><p>These become&nbsp;<a class=\"reference-link\" href=\"#root/_help_fASfBrYnquKU\">To-do Lists</a>, with the glyph inside the item with the tick state preserved:</p><figure class=\"table\"><table><thead><tr><th>OneNote tag</th><th><code>data-tag</code></th><th>Imported as</th><th>Searchable as</th></tr></thead><tbody><tr><td>To Do</td><td><code>to-do</code></td><td><em>(none)</em></td><td>—</td></tr><tr><td>To Do priority 1</td><td><code>to-do-priority-1</code></td><td>1️⃣</td><td>1️⃣</td></tr><tr><td>To Do priority 2</td><td><code>to-do-priority-2</code></td><td>2️⃣</td><td>2️⃣</td></tr><tr><td>Discuss with Person A</td><td><code>discuss-with-person-a</code></td><td><span class=\"tn-icon bx bx-message-rounded\"></span></td><td><code>message-rounded</code></td></tr><tr><td>Discuss with Person B</td><td><code>discuss-with-person-b</code></td><td><span class=\"tn-icon bx bx-message-rounded\"></span></td><td><code>message-rounded</code></td></tr><tr><td>Discuss with manager</td><td><code>discuss-with-manager</code></td><td><span class=\"tn-icon bx bx-conversation\"></span></td><td><code>conversation</code></td></tr><tr><td>Schedule meeting</td><td><code>schedule-meeting</code></td><td><span class=\"tn-icon bx bx-calendar\"></span></td><td><code>calendar</code></td></tr><tr><td>Call back</td><td><code>call-back</code></td><td><span class=\"tn-icon bx bx-phone-call\"></span></td><td><code>phone-call</code></td></tr><tr><td>Client request</td><td><code>client-request</code></td><td><span class=\"tn-icon bx bx-clipboard\"></span></td><td><code>clipboard</code></td></tr></tbody></table></figure>",
++ "_help_Y5mKeJ6dsCld": "<p>Trilium can import ZIP exports from Notion while preserving structure and formatting.</p><h2>Import process</h2><p>In Notion, there are two ways to export data:</p><ul><li>To export a single page (and optionally its sub-pages):<ul><li>Select the page to export.</li><li>Press the […] button at the top-right of the window and select <em>Export</em>.</li><li>Ensure the following options are set:<ul><li>Export format: HTML</li><li>Page content: Everything</li><li>Include subpages: On</li><li>Create folders for subpages: On</li></ul></li><li>Press the Export button.</li><li>Wait for the download to finish.</li></ul></li><li>To export an entire workspace, press your user name badge at top-left and select <em>Settings</em>.<ul><li>In the left section, look for the <em>Workspace</em> category and select <em>General</em>.</li><li>In the <em>General</em> settings page, look for the <em>Export</em> section and press the <em>Export</em> button corresponding to <em>Workspace content</em>.</li><li>Ensure the following options are set:<ul><li>Export format: HTML</li><li>Page content: Everything</li><li>Include subpages: On</li><li>Create folders for subpages: On</li></ul></li><li>Press the Export button.</li><li>Wait for the download to finish. Depending on the size of your workspace it might take a while. You will get a downloadable copy via email if takes too long.</li></ul></li></ul><p>In Trilium Notes:</p><ol><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, right click and select <em>Import into note</em> (<span class=\"tn-icon bx bx-import\"></span>).</li><li>In the <em>Import from</em> section, select&nbsp;<span class=\"tn-icon tn-brand tn-brand-notion\"></span> <em>Notion</em>.</li><li>Upload the ZIP obtained in the previous step.</li></ol><h2>Supported features</h2><p>The following features are preserved by Trilium during the import process:</p><ul><li>Basic formatting (bold, italic, underline, strikethrough, headings, colors, highlights).</li><li><a class=\"reference-link\" href=\"#root/_help_S6Xx8QIWTV66\">Lists</a></li><li>To-do lists</li><li><a class=\"reference-link\" href=\"#root/_help_mT0HEkOsz6i1\">Images</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>.</li><li>Toggle sections<ul><li>Nested toggle sections are also supported.</li><li>Toggle headings are stripped of their toggle button and become normal headings instead.</li></ul></li><li><a class=\"reference-link\" href=\"#root/_help_YfYAtQBcfo5V\">Math Equations</a>&nbsp;(inline or block)</li><li><a class=\"reference-link\" href=\"#root/_help_UmgZAfcltxkS\">Link Previews</a><ul><li>The icon and image of the links need to be retrieved online since the exports don't carry the images. This operation is done only if <em>Download images automatically</em> is enabled in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Media</em>.</li></ul></li><li><a class=\"reference-link\" href=\"#root/_help_QxEyIjRBizuC\">Code blocks</a>, with a best-effort attempt to restore the language.</li><li><a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a></li><li>Links between other imported pages are converted to&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;if they are part of the same import.</li><li>Databases are imported as&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>&nbsp;(see below).</li><li><a href=\"#root/_help_NwBbFdNZ9h7O\">Admonitions</a> are preserved, including its emoji (added as part of the content).</li><li>Columns are imported as transparent <a href=\"#root/_help_NdowYOC1GFKS\">tables</a>, preserving the column definition.</li><li>Table of content blocks are <em>removed</em>, as the table of contents is already present in the sidebar (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_BFvAtE74rbP6\">Table of contents</a>), as well as in shared notes.</li></ul><h2>Databases</h2><p>Notion databases are imported into&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>, where each item of the database is saved as a page in the collection. Through the use of <a href=\"#root/_help_bwZpz2ajCEwO\">inherited</a>&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>, most of the page properties in Notion are preserved by the import.</p><p>The resulting collection will be&nbsp;<a class=\"reference-link\" href=\"#root/_help_2FvYrpmOXm29\">Table</a>&nbsp;regardless of the original view the database was exported in. That's because the active view is not saved in the export and the table collection is the most compatible with Notion.</p><figure class=\"table\"><table><thead><tr><th scope=\"col\">Notion type</th><th scope=\"col\">Trilium</th></tr></thead><tbody><tr><td>Text / Select / Status / Place</td><td>Single-valued <code>text</code> label</td></tr><tr><td>Number</td><td>Single-valued <code>number</code> label for plain numbers. Formatted values (currency, percent, thousands separators) are normalized to a bare number, e.g. <code>$1,200.50</code> → <code>1200.50</code>.</td></tr><tr><td>ID</td><td>Single-valued <code>number</code> or <code>text</code> label (depending on whether a prefix is configured)</td></tr><tr><td>Multi-select</td><td>One text label per option (multi)</td></tr><tr><td>URL / Email / Phone</td><td><code>url</code> label (<code>mailto:</code>, <code>tel:</code> prefix)</td></tr><tr><td>Date</td><td><ul><li><code>datetime</code> if at least one has time.</li><li><code>date</code> if only dates.</li><li>Two attributes if any of the dates have an end date.</li></ul></td></tr><tr><td>Checkbox</td><td><code>boolean</code> label (<code>true</code>/<code>false</code>).</td></tr><tr><td>Person</td><td>One text label per user (multi)</td></tr><tr><td>Created by / Edited by</td><td>Single-valued <code>text</code> label</td></tr><tr><td>Created time / Last edited time</td><td>Assigned to the note's creation and modification date.</td></tr><tr><td>Relation</td><td>Mapped to <a href=\"#root/_help_Cq5X6iKQop6R\">relations</a>, each link resolved to its target note via the existing cross-page map; targets outside the import are dropped.</td></tr><tr><td>Files &amp; Media</td><td>The files are preserved as attachments, and a link to them is prepended to the content of the note for visibility.</td></tr><tr><td>Formulas / Rollup</td><td><p>A <code>text</code>, <code>number</code> or <code>boolean</code> label depending on the value. Dates are rendered as <code>text</code> because the export doesn't offer any type information.</p><p>The Notion export does not preserve the formula/rollup configuration itself, instead it just exports the value.</p></td></tr><tr><td>Button / Verification / any other type</td><td>Unsupported, they will be dropped from the import.</td></tr></tbody></table></figure><aside class=\"admonition note\"><p><strong>Technical information</strong></p><p>Every page property that can be preserved according to the table above is saved as a label or relation to the corresponding note (except for creation and modification dates which are saved at note level).</p><p>To maintain a similar UX to Notion, every property is also turned into&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;at collection level. This also makes the columns visible in the table collection. The promoted attributes are made inheritable so that they appear when navigating in the child notes as well.</p><p>The names of the labels are intentionally converted to <code>camelCase</code> to match Trilium's conventions, but the full name of the column is preserved through the <em>Alias</em> mechanism of promoted attributes.</p></aside><h2>Limitations</h2><h3>Missing data from the import</h3><p>The following information is not preserved by the import because it is not available in the export so it cannot be restored:</p><ul><li>The order of the pages and sub-pages.</li><li>Creation/modification dates are restored only when the page includes Created time / Last edited time properties (collection or not); otherwise the import time is used.</li></ul><h3>Cover images and page icon</h3><p>The page icon or emoji is not preserved, with created notes having the default icon. The cover image is not imported at all.</p><h2>Reporting issues</h2><p>When importing your Notion workspace, you might find issues in how a note is imported; in that case consider <a href=\"#root/_help_wy8So3yZZlH9\">reporting</a> it.</p><p>When reporting such an issue make sure to provide the following information:</p><ul><li>A .zip export of the original Notion note (and children if applicable). This allows us to reproduce the issue.</li><li>A screenshot with how it originally looked like before the import and how it looks after the import.</li></ul>",
++ "_help_nhQVuO4zvIxi": "<p>Trilium can import notes from Google Keep, preserving their structure and formatting.</p><h2>Import process</h2><p>Google Keep has no native export process, but Google Takeout allows you to download a ZIP of all the notes.</p><p>The first step is to download your Google Keep information:</p><ol><li>Navigate to <a href=\"https://takeout.google.com/\">takeout.google.com</a>.</li><li>In the <em>Create a new export</em> section, press <em>Deselect all.</em></li><li>In the list of data to export, check <em>Keep</em>.</li><li>Scroll all the way down and choose <em>Next step</em>.</li><li>In <em>Choose file type, frequency &amp; destination</em> make sure the following options are set:<ol><li><em>Transfer to</em> is set to <em>Send download link via email</em>.</li><li><em>Frequency</em> is set to <em>Export once</em>.</li><li><em>File type</em> is set to <em>.zip</em>.</li><li><em>File size</em> can remain set to <em>2 GB</em>.</li></ol></li><li>Press <em>Create export</em> and wait for the export to finish.</li></ol><p>Then in Trilium Notes:</p><ol><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, right click and select <em>Import into note</em>.</li><li>In the <em>Import from</em> section, select&nbsp;<span class=\"tn-icon tn-brand tn-brand-google-keep\"></span> <em>Google Keep</em>.</li><li>Upload the ZIP obtained in the previous step.</li></ol><h2>Supported features</h2><ul><li>Basic formatting (bold, italic, underline)</li><li><a href=\"#root/_help_p9kXRFAkwN4o\">Note color</a></li><li>Note titles are maintained, if present.<ul><li>In Google Keep it's common for notes not to have a title, case in which the date and time of the note are used as a title.</li></ul></li><li>To-do lists</li><li><a class=\"reference-link\" href=\"#root/_help_mT0HEkOsz6i1\">Images</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>.</li><li>Creation and modification dates are preserved.</li></ul><h2>Limitations</h2><p>Currently the following information is not imported:</p><ul><li>Labels are disregarded.</li><li>Pinned, archived or trashed state is not preserved, all notes are treated the same.</li></ul><h2>Reporting issues</h2><p>When importing your notes from Google Keep, you might encounter some issues with how the notes are imported, or there might be some missing information. In this case, consider <a href=\"#root/_help_wy8So3yZZlH9\">reporting it</a>.</p><p>When reporting such an issue make sure to provide the following information:</p><ul><li>A sample of the note is required to better understand what happened.<ul><li>Because Google Keep has no per-note export, extract the Google Takeout ZIP and copy the files corresponding to the problematic note (<code>.html</code>, <code>.json</code> and any attachments if you are able to identify them).</li></ul></li><li>A screenshot with how it originally looked like before the import and how it looks after the import.</li></ul>",
++ "_help_syuSEKf2rUGr": "<p>Trilium can import ENEX files, which are used by Evernote for backup/export. One ENEX file represents the content (notes and resources) of one notebook.</p><h2>Import process</h2><p>The first step is to export the data from Evernote:</p><ul><li>To export a single notebook:<ul><li>In the left sidebar, select <em>Notebooks</em>.</li><li>If you have a notebook stack, expand it.</li><li>Right click on a notebook and select <em>Export notebook</em>.</li><li>Make sure the following options are set:<ul><li>File format is set to <em>ENEX format</em>.</li><li>All the options in <em>Export note attributes</em> are checked.</li></ul></li></ul></li><li>To export a bunch of notes (up to 100 notes):<ul><li>In the left sidebar, select <em>Notes</em>.</li><li>In the list of notes, <kbd>Ctrl</kbd>-click individual notes to select them. Alternatively, click on a note and then <kbd>Shift</kbd>-click a more distant note to select all the notes in between.</li><li>At the bottom there should be a floating bar with some options. Select […] → <em>Export.</em></li><li>Make sure the following options are set:<ul><li>File format is set to <em>ENEX format</em>.</li><li>All the options in <em>Export note attributes</em> are checked.</li></ul></li></ul></li><li>To export a single note:<ul><li>Select the note.</li><li>In the top-right, press the […] button and select <em>Export</em>.</li><li>Make sure the following options are set:<ul><li>File format is set to <em>ENEX format</em>.</li><li>All the options in <em>Export note attributes</em> are checked.</li></ul></li></ul></li></ul><aside class=\"admonition tip\"><p>To export multiple notebooks in bulk, consider using a third-party CLI tool called <a href=\"https://github.com/vzhd1701/evernote-backup\">evernote-backup</a></p></aside><p>Once you have your ENEX files, do the following to import them in Trilium:</p><ol><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, right click and select <em>Import into note</em>.</li><li>In the <em>Import from</em> section, select&nbsp;<span class=\"tn-icon tn-brand tn-brand-evernote\"></span> <em>Evernote</em>.</li><li>During the import, you will see \"Import in progress\" message. If the import is successful, the message will change to “Import finished successfully” and then disappear.</li><li>We recommend you to check the imported notes and their attachments to verify that you haven’t lost any data.</li></ol><h2>Supported features</h2><p>The following features are preserved by Trilium during the import process:</p><ul><li>Basic formatting (bold, italic, underline, strikethrough, colors, highlights, superscript, subscript, text alignment, inline code).</li><li>The hierarchy of headings (these are shifted to start with H2 because H1 is reserved for note title, see&nbsp;<a href=\"#root/_help_Gr6xFaF6ioJ5\">Headings</a>)</li><li>To-do lists. The new task format is collapsed to standard to-do lists</li><li><a class=\"reference-link\" href=\"#root/_help_mT0HEkOsz6i1\">Images</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a></li><li><a class=\"reference-link\" href=\"#root/_help_S6Xx8QIWTV66\">Lists</a>&nbsp;(with bullets or with numbers)</li><li><a class=\"reference-link\" href=\"#root/_help_NdowYOC1GFKS\">Tables</a></li><li>Block quotes</li><li><a href=\"#root/_help_NwBbFdNZ9h7O\">Admonitions</a> are preserved, including its emoji (added as part of the content).</li><li><a class=\"reference-link\" href=\"#root/_help_QxEyIjRBizuC\">Code blocks</a>, with a best-effort attempt to restore the language.</li><li><a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a></li><li><a class=\"reference-link\" href=\"#root/_help_YfYAtQBcfo5V\">Math Equations</a></li><li>Toggle sections</li><li>External links</li><li>Internal links are re-written to&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;if the target note is part of the same import.</li></ul><h2>Limitations</h2><ul><li>The size limit of one import is 250Mb. If the total size of your files is larger, you can increase the&nbsp;<a href=\"#root/_help_WOcw2SLH6tbX\">upload limit</a>, or divide your files, and run the import as many times as necessary.</li><li>All resources (except for images) are created as notes’ attachments.</li><li>If you have HTML inside ENEX files, the HTML formatting may be broken or lost after import in Trilium. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_wy8So3yZZlH9\">Reporting issues</a>.</li></ul><h3>Links to other notes</h3><p>Since v0.104.0, the ENEX importer tries to recreate links to other notes automatically by converting their Evernote-specific URLs to Trilium's&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>.</p><p>Since the ENEX format does not provide the unique ID of notes, the note references are determined via their note title.</p><p>Limitations:</p><ul><li>Only notes that are part of the same import will have their links rewritten to reference links, to avoid linking to the wrong note.</li><li>If there are to notes with the same name, internal links will not be created to avoid pointing to the wrong note.</li><li>Links that couldn't be rewritten (e.g. referring to a missing/duplicate note) will be kept with their original <code>evernote://</code> URL.</li><li>It will not fix links to anchors and links to notes that you renamed in Evernote after you created the links.</li></ul><h4>Post-processing notes</h4><aside class=\"admonition tip\"><p>This script allows rewriting links after the import has been done, and it should also allow finding links between two different imports.</p></aside><p>If you want to restore the internal links in Trilium after you import all of your ENEX files, you can use or adapt this custom script:&nbsp;<a class=\"reference-link\" href=\"#root/_help_dj3j8dG4th4l\">Process internal links by title</a></p><p>The script does the following:</p><ol><li>It finds all Evernote internal links.</li><li>For each one, it checks if its link text matches a note title, and if yes, it replaces the Evernote link with an internal Trilium link. If not, it leaves the Evernote link in place.</li><li>If it finds more than one note with a matching note title, it leaves the Evernote link in place.</li><li>It outputs the results in a log that you can see in the respective code note in Trilium.</li></ol><p>The script has the following limitations:</p><ul><li>It will not fix links to anchors and links to notes that you renamed in Evernote after you created the links.</li><li>Some note titles might not be well identified, even if they exist. This is especially the case if the note title contains some special characters. Should this be problematic, consider&nbsp;<a class=\"reference-link\" href=\"#root/_help_wy8So3yZZlH9\">Reporting issues</a>.</li></ul><h2>Reporting issues</h2><p>When importing your Evernote notebooks, you might find issues in how a note is imported; in that case consider <a href=\"#root/_help_wy8So3yZZlH9\">reporting</a> it.</p><p>When reporting such an issue make sure to provide the following information:</p><ul><li>A <code>.enex</code> export of the original note. This allows us to reproduce the issue.</li><li>A screenshot with how it originally looked like before the import and how it looks after the import.</li></ul>",
++ "_help_dj3j8dG4th4l": "const query = `note.type = \"text\" and note.content *=* \"evernote:///view/\"`;\nconst notes = api.searchForNotes(query);\n\nfor (const note of notes) {\n api.log(`Processing note ${note.title}...`);\n \n const content = note.getContent();\n const root = api.htmlParser.parse(content);\n \n for (const el of root.querySelectorAll(\"a\")) {\n const url = el.getAttribute(\"href\");\n if (!url?.startsWith(\"evernote:///\")) continue;\n\n const text = el.textContent;\n const matchingNotes = api.searchForNotes(`note.title = \"${text}\"`);\n if (matchingNotes.length === 0) {\n api.log(`No matching notes for \"${text}...\"`);\n continue;\n }\n\n if (matchingNotes.length > 1) {\n api.log(`Found multiple matching notes for \"${text}\". Skipping.`);\n continue;\n }\n\n const matchingNote = matchingNotes[0];\n \n api.log(`Found matching note: ${matchingNote.title} ${matchingNote.noteId}`);\n el.setAttribute(\"href\", `#root/${matchingNote.noteId}`);\n el.classList.add(\"reference-link\");\n }\n note.setContent(root.toString()); \n}\n",
++ "_help_83zmPBJRgfnW": "<p>Starting with v0.104.0, Trilium is able to import data from Anytype from JSON imports which preserve most of the formatting and the metainformation.</p><h2>Import process</h2><p>The first step is to export the data from Anytype:</p><ul><li>To export a single page:<ul><li>Select the page to export.</li><li>Press the […] at the top-right of the window and select <em>Export</em>.</li><li>Ensure the following options are set:<ul><li>Export format: Any-Block</li><li>File Format: JSON</li><li>Zip archive: On</li><li>Include linked objects: On</li><li>Include files: On</li><li>Include archived objects: On</li></ul></li></ul></li><li>To export an entire channel:<ul><li>Select the desired channel from the left bar.</li><li>Underneath the channel icon in the left sidebar, press the name of the channel with an arrow and select <em>Channel Settings</em>.</li><li>In the left sidebar, look for the <em>Integrations</em> section and select <em>Export</em>.</li><li>Press <em>Any-Block</em>.</li><li>Ensure the following options are set:<ul><li>File Format: JSON</li><li>Zip archive: On</li><li>Include files: On</li><li>Include archived objects: On</li></ul></li></ul></li></ul><p>In Trilium Notes:</p><ol><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, right click and select <em>Import into note</em>.</li><li>In the <em>Import from</em> section, select&nbsp;<span class=\"tn-icon tn-brand tn-brand-anytype\"></span> <em>Anytype</em>.</li><li>Upload the ZIP.</li></ol><aside class=\"admonition note\"><p>Exporting collections individually can sometimes miss information that would otherwise be picked up from an export of the entire channel. The reason is that Anytype leaves out some information when exporting individual pages/collections.</p></aside><h2>Supported features</h2><p>The following features are preserved by Trilium during the import process:</p><ul><li>Basic formatting (bold, italic, underline, strikethrough, headings, colors, highlights, inline code).</li><li><a class=\"reference-link\" href=\"#root/_help_S6Xx8QIWTV66\">Lists</a>&nbsp;(numbered or bullet)</li><li><a class=\"reference-link\" href=\"#root/_help_mT0HEkOsz6i1\">Images</a>&nbsp;and files are handled as&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>.</li><li>To-do lists</li><li>Toggle sections</li><li><a class=\"reference-link\" href=\"#root/_help_NdowYOC1GFKS\">Tables</a></li><li>Inline&nbsp;<a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a></li><li><a class=\"reference-link\" href=\"#root/_help_YfYAtQBcfo5V\">Math Equations</a></li><li>Highlight blocks are imported as block quotes.</li><li><a class=\"reference-link\" href=\"#root/_help_QxEyIjRBizuC\">Code blocks</a>, with a best-effort attempt to restore the language.</li><li>Links between other imported pages are converted to&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;if they are part of the same import.<ul><li>Applies to both block links and inline links.</li></ul></li><li>Collections are imported as&nbsp;Trilium-native&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>&nbsp;(see below).<ul><li>Files inside collections are imported as&nbsp;<a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a>&nbsp;notes.</li></ul></li><li>Dividers (line, dots) are imported as horizontal rules.</li><li><a href=\"#root/_help_NwBbFdNZ9h7O\">Admonitions</a> are preserved, including its emoji (added as part of the content).</li><li>Creation and modification date of pages is preserved.</li></ul><h2>Collections</h2><p>Collections created in Anytype are imported on a best-effort basis, preserving both the view mode and the page properties as&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>.</p><p>The following view modes are supported:</p><ul><li>List as&nbsp;<a class=\"reference-link\" href=\"#root/_help_mULW0Q3VojwY\">List View</a></li><li>Gallery as&nbsp;<a class=\"reference-link\" href=\"#root/_help_8QqnMzx393bx\">Grid View</a></li><li><a class=\"reference-link\" href=\"#root/_help_xWbu3jpNWapp\">Calendar</a>, preserving the attribute which identifies the date.</li><li><a class=\"reference-link\" href=\"#root/_help_CtBQqbwXDx1w\">Kanban Board</a>, preserving the board group column.</li><li><a class=\"reference-link\" href=\"#root/_help_2FvYrpmOXm29\">Table</a>, also used as fallback for unsupported collection layouts.</li></ul><p>The following types are supported:</p><figure class=\"table\"><table><thead><tr><th scope=\"col\">Anytype property type</th><th scope=\"col\">Trilium</th></tr></thead><tbody><tr><td>Text / Select</td><td>Single-valued <code>text</code> label</td></tr><tr><td>Number</td><td>Single-valued <code>number</code> label</td></tr><tr><td>Multi-select</td><td>One <code>text</code> label per option (multi)</td></tr><tr><td>Date / Date with time</td><td><ul><li><code>datetime</code> if the time is included.</li><li><code>date</code> if only dates.</li></ul></td></tr><tr><td>File</td><td>The files are preserved as attachments, and a link to them is prepended to the content of the note for visibility.</td></tr><tr><td>Checkbox</td><td><code>boolean</code> label (<code>true</code>/<code>false</code>).</td></tr><tr><td>URL / Email / Phone</td><td><code>url</code> label (<code>mailto:</code>, <code>tel:</code> prefix)</td></tr></tbody></table></figure><h2>Reporting issues</h2><p>When importing your Anytype notes, you might find issues in how a note is imported; in that case consider <a href=\"#root/_help_wy8So3yZZlH9\">reporting</a> it.</p><p>When reporting such an issue make sure to provide the following information:</p><ul><li>A .zip export of the original note (and children if applicable). This allows us to reproduce the issue.</li><li>A screenshot with how it originally looked like before the import and how it looks after the import.</li></ul>",
++ "_help_iWD7wiIuMtgV": "<p>Although Obsidian was indirectly supported through the standard&nbsp;<a class=\"reference-link\" href=\"#root/_help_Oau6X9rCuegd\">Markdown</a>&nbsp;import, its vault structure is distinct enough to warrant its own dedicated import channel.</p><h2>Import process</h2><p>The first step is to obtain a .zip of your Obsidian vault:</p><ol><li>First, identify where your Obsidian vault is located. The easiest way to do so is to open Obsidian and right clicking the name of the vault at the bottom of the left sidebar and then selecting <em>Show in system explorer</em>.</li><li>In your system explorer, right click the directory containing your Obsidian vault and compress it to a ZIP file (e.g. on Windows, <em>Compress To</em> → <em>ZIP</em>).</li></ol><aside class=\"admonition tip\"><p>When zipping, you can either ZIP the outer folder of the vault, or the contents of the vault as Trilium will automatically determine the position of the vault in the archive via the <code>.obsidian</code> directory.</p></aside><p>Then, in Trilium Notes:</p><ol><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, right click and select <em>Import into note</em>.</li><li>In the <em>Import from</em> section, select&nbsp;<span class=\"tn-icon tn-brand tn-brand-obsidian\"></span> <em>Obsidian</em>.</li><li>Upload the ZIP obtained in the previous step.</li></ol><p>Alternatively, simply drag &amp; drop the .zip archive in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and Trilium will auto-detect it as an Obsidian import provided there is a <code>.obsidian</code> directory. If not, follow the previous steps instead.</p><h2>Supported features</h2><p>The following features are preserved by Trilium during the import process:</p><ul><li>Folder hierarchy is preserved.</li><li>Basic Markdown formatting (bold, italic, underline, strikethrough, headings).</li><li>Specific Obsidian formatting (highlighting).</li><li><a class=\"reference-link\" href=\"#root/_help_S6Xx8QIWTV66\">Lists</a></li><li>To-do lists</li><li><a class=\"reference-link\" href=\"#root/_help_mT0HEkOsz6i1\">Images</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a><ul><li>Non-Markdown files in the Vault are treated as attachments by default if they are referenced by at least one note.</li><li>Otherwise, they will be imported as&nbsp;<a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a>&nbsp;notes.</li></ul></li><li>Transclusions are converted to&nbsp;<a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>&nbsp;or&nbsp;<a class=\"reference-link\" href=\"#root/_help_mT0HEkOsz6i1\">Images</a>&nbsp;(depending on type).</li><li><a class=\"reference-link\" href=\"#root/_help_YfYAtQBcfo5V\">Math Equations</a>&nbsp;(inline or block)</li><li><a class=\"reference-link\" href=\"#root/_help_QxEyIjRBizuC\">Code blocks</a>, with a best-effort attempt to restore the language.</li><li>Links between pages are converted to&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>.</li><li>Callouts are converted to Trilium's <a href=\"#root/_help_NwBbFdNZ9h7O\">Admonitions</a>.<ul><li>Obsidian has many more types of callouts (<code>tldr</code>, <code>question</code>, <code>attention</code>), these are all mapped to one of Trilium's existing admonition types (e.g. Note, Tip, Important).</li><li>Custom titles are kept and shown as a bold line at the top of the admonition, since there is no concept of admonition title in Trilium.</li><li>Foldable callouts are imported expanded and without a fold marker.</li></ul></li><li>Notes created by the <a href=\"https://github.com/zsviczian/obsidian-excalidraw-plugin\"><em>Excalidraw</em></a> community plugin for Obsidian are converted to&nbsp;<a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a>&nbsp;(same underlying technology).<ul><li>Note that custom features introduced by that plugin will not be supported.</li></ul></li><li>Modification date is preserved via the information obtained from the .zip archive, creation date is not recoverable so it's kept the same as the modification date.</li></ul><h2>Properties</h2><p>Properties are Obsidian's equivalent of&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>. One of the core differences between the two is where the property information is stored (i.e. name and type): in Obsidian everything is stored at vault level and shared across all notes, whereas in Trilium each page can have individual promoted attributes, shared through&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>&nbsp;or&nbsp;<a class=\"reference-link\" href=\"#root/_help_bwZpz2ajCEwO\">Attribute Inheritance</a>.</p><p>Another important difference is that promoted attributes in Trilium are always displayed, even if empty. In Obsidian, these are simply suggested when creating a new property.</p><p>To reconcile all these differences, properties are converted to&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;at note level.</p><p>The following note types are supported:</p><figure class=\"table\"><table><thead><tr><th>Obsidian type</th><th>Trilium</th></tr></thead><tbody><tr><td>Text or not defined</td><td>Single-valued <code>text</code> label</td></tr><tr><td>Number</td><td>Single-valued <code>number</code> label</td></tr><tr><td>Multitext</td><td>Multi-valued <code>text</code> label</td></tr><tr><td>Checkbox</td><td><code>boolean</code> label (<code>true</code>/<code>false</code>).</td></tr><tr><td>Date</td><td><code>date</code></td></tr><tr><td>Date &amp; Time</td><td><code>datetime</code></td></tr></tbody></table></figure><h3>Special properties</h3><p>Obsidian has a few reserved property names, which are treated differently in Trilium as well:</p><ul><li><code>tags</code>, where every tag is turned into its own <a href=\"#root/_help_HI6GBBIduIgv\">label</a> (e.g. <code>#one</code>, <code>#two</code> when <code>tags: [ one, two ]</code>).</li><li><code>aliases</code> are simply mapped to individual <code>#alias</code> labels</li><li><code>cssclasses</code>, <code>publish</code>, <code>permalink</code> are ignored.</li></ul><h2>Limitations</h2><ul><li>Comments (<code>%%</code> syntax) are simply stripped.</li><li>Obsidian <em>bases</em> functionality is not preserved.<ul><li>The closest equivalent in Trilium would be&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>&nbsp;but they work fundamentally different because bases don't store particular notes, they act more like a&nbsp;<a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a>&nbsp;with a collection view.</li><li>Since the base query format is quite different to Trilium's&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>&nbsp;syntax, it's unlikely they'll ever be supported.</li><li>When a base is encountered, it is simply ignored from the import.</li></ul></li><li>Canvases are not imported.<ul><li>Theoretically they could map to either&nbsp;<a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a>&nbsp;or&nbsp;<a class=\"reference-link\" href=\"#root/_help_iRwzGnHPzonm\">Relation Map</a>&nbsp;but they are too different to reconcile.</li></ul></li><li>Links<ul><li>Links to a specific heading in another note will still point to the right note, but the heading anchor will be dropped.</li><li>Dangling links (pointing to a note that doesn't exist) and ambiguous links (same base name in 2+ notes) are unwrapped to plain text.</li></ul></li></ul>",
++ "_help_rC3pL2aptaRE": "<p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/2_Zen%20mode_image.png\"></p><p>Screenshot of Zen Mode activated on a Windows 11 system with native title bar off and background effects on.</p><p>When Zen Mode is activated (pictured on the side), most of the user interface of Trilium is hidden away in order to be able to focus on the content, whether it's for reading or writing.</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/1_Zen%20mode_image.png\"></p><p>Screenshot of the Zen Mode option in the global menu.</p><h2>Activating &amp; deactivating</h2><p>The Zen Mode can be activated by accessing the global menu and selecting the “Zen Mode” option:</p><p>Aside from the global menu, it's also possible to activate this mode by using a keyboard shortcut (which is <kbd>F9</kbd> since TriliumNext 0.92.5 and <kbd>Alt</kbd>+<kbd>Z</kbd> for older versions). Look for <code>toggleZenMode</code> in the shortcut configuration.</p><p>Once Zen Mode is activated, all the UI elements of the application will be hidden away, including the global menu. In that case, the Zen Mode can be deactivated either by pressing the&nbsp;<span class=\"tn-icon bx bxs-yin-yang\"></span> icon in the top-right corner of the window or by pressing the keyboard combination again.</p><p>Do note that, by design, activating or deactivating the Zen Mode applies only to the current window. Restarting the application will also disable the Zen Mode.</p><h2>Moving the window around</h2><p>If “Native title bar” is activated, then the operating system's default title bar can be used to drag the window around. If deactivated, the window can still be moved by dragging the mouse across the top part of the window where the note titles are.</p><p><img src=\"{{helpAssets}}/User%20Guide/Basic%20Concepts%20and%20Features/Zen%20mode_image.png\"></p><p>Screenshot of two notes side-by-side while Zen Mode is active, on Windows 11 with background effects off.</p><h2>Split windows and tabs</h2><p>Tabs are completely hidden, however it's still possible to use keyboard shortcuts such as <code>firstTab</code> (<kbd>Ctrl</kbd>+<kbd>1</kbd> by default), <code>secondTab</code> (<kbd>Ctrl</kbd>+<kbd>2</kbd> by default). There are also some newer shortcuts such as <code>activateNextTab</code> (<kbd>Ctrl</kbd>+<kbd>Tab</kbd>) or <code>activatePreviousTab</code> (<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Tab</kbd>) that allow easy navigation, however make sure that they are configured properly in the settings.</p><p>For the split view of notes, there are no keyboard shortcuts at the time of writing, but it's still possible to have them in Zen Mode by creating the split while the Zen Mode is off and then reactivating it afterwards.</p>",
++ "_help_YzMcWlCVeW09": "<p><em>Active content</em> is a generic name for powerful features in Trilium, these range from customizing the UI to advanced scripting that can alter your notes or even your PC.</p><h2>Safe import</h2><p>Active content problem of safety, especially when this active content comes from a third-party such as if it is downloaded from a website and then imported into Trilium.</p><p>When <a href=\"#root/_help_mHbBMPDPkVV5\">importing</a> .zip archives into Trilium, <em>safe mode</em> is active by default which will try to prevent untrusted code from executing. For example, a <a href=\"#root/_help_MgibgPcfeuGz\">custom widget</a> needs the <code>#widget</code> <a href=\"#root/_help_HI6GBBIduIgv\">label</a> in order to function; safe import works by renaming that label to <code>#disabled:widget</code>.</p><h2>Safe mode</h2><p>Sometimes active content can cause issues with the UI or the server, preventing it from functioning properly.&nbsp;<a class=\"reference-link\" href=\"#root/_help_64ZTlUPgEPtW\">Safe mode</a>&nbsp;allows starting Trilium in such a way that active content is not loaded by default at start-up, allowing the user to fix the problematic scripts or widgets.</p><h2>Types of active content</h2><p>These are the types of active content in Trilium, along with a few examples of what untrusted content of that type could cause:</p><figure class=\"table\"><table><thead><tr><th>Name</th><th>Disabled on a safe <a href=\"#root/_help_mHbBMPDPkVV5\">import</a></th><th>Description</th><th>Potential risks of untrusted code</th></tr></thead><tbody><tr><td><a href=\"#root/_help_yIhgI5H7A2Sm\">Front-end scripts</a></td><td>Yes</td><td>Allow running arbitrary code on the client (UI) of Trilium, which can alter the user interface.</td><td>A malicious script can execute server-side code, access un-encrypted notes or change their contents.</td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a></td><td>Yes</td><td>Can add new UI features to Trilium, for example by adding a new section in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>.</td><td>The UI can be altered in such a way that it can be used to extract sensitive information or it can simply cause the application to crash.</td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_SPirpZypehBG\">Backend scripts</a></td><td>Yes</td><td>Can run custom code on the server of Trilium (Node.js environment), with full access to the notes and the database.</td><td>Has access to all the unencrypted notes, but with full access to the database it can completely destroy the data. It also has access to execute other applications or alter the files and folders on the server).</td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_1vHRoWCEjj0L\">Web View</a></td><td>Yes</td><td>Displays a website inside a note.</td><td>Can point to a phishing website which can collect the data (for example on a log in page).</td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a></td><td>Yes</td><td>Renders custom content inside a note, such as a dashboard or a new editor that is not officially supported by Trilium.</td><td>Can affect the UI similar to front-end scripts or custom widgets since the scripts are not completely encapsulated, or they can act similar to a web view where they can collect data entered by the user.</td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_AlhDUqhENtH7\">Custom app-wide CSS</a></td><td>No</td><td>Can alter the layout and style of the UI using CSS, applied regardless of theme.</td><td>Generally less problematic than the rest of active content, but a badly written CSS can affect the layout of the application, requiring the use of&nbsp;<a class=\"reference-link\" href=\"#root/_help_64ZTlUPgEPtW\">Safe mode</a>&nbsp;to be able to use the application.</td></tr><tr><td><a href=\"#root/_help_pKK96zzmvBGf\">Custom themes</a></td><td>No</td><td>Can change the style of the entire UI.</td><td>Similar to custom app-wide CSS.</td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_gOKqSJgXLcIj\">Icon Packs</a></td><td>No</td><td>Introduces new icons that can be used for notes.</td><td>Generally are more contained and less prone to cause issues, but they can cause performance issues (for example if the icon pack has millions of icons in it).</td></tr></tbody></table></figure><h2>Active content badge</h2><p>If a note is considered to have active content, a badge is shown in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_B5dihXRDksTk\">Note badges</a>&nbsp;area. Clicking the badge will reveal a menu with various options related to that content type, for example to open the documentation or to configure the execution of scripts.</p><p>For some active content types, such as backend scripts with custom triggering conditions a toggle button will appear. This makes it possible to easily disable scripts or widgets, but also to re-enable them if an import was made with safe mode active.</p>",
+ "_help_s3YCWHBfmYuM": "<h2>Choose the setup</h2><p><strong>Local only desktop/laptop</strong> - Allows a single instance on a desktop and will save the notes locally on that desktop.</p><ul><li><a class=\"reference-link\" href=\"#root/_help_poXkQfguuA0U\">Desktop Installation</a></li></ul><p><strong>Server with web only access</strong> - Installs the application on the server and allows access from any web browser on any device, including mobile.</p><ol><li><a class=\"reference-link\" href=\"#root/_help_WOcw2SLH6tbX\">Server Installation</a></li><li><a class=\"reference-link\" href=\"#root/_help_RDslemsQ6gCp\">Mobile Frontend</a>&nbsp;(optional)</li><li><a class=\"reference-link\" href=\"#root/_help_yeEaYqosGLSh\">Third-party cloud hosting</a></li></ol><p><strong>Combination of server and desktop/laptop</strong> - Install the application on both a server, for web access and data synchronisation, and desktop instance(s). This allows all the data to be stored on the server and either accessed from the web browser, or the desktop application. The desktop application will sync and store the data locally so that it can be used when offline.</p><ol><li><a class=\"reference-link\" href=\"#root/_help_WOcw2SLH6tbX\">Server Installation</a></li><li><a class=\"reference-link\" href=\"#root/_help_RDslemsQ6gCp\">Mobile Frontend</a>&nbsp;(optional)</li><li><a class=\"reference-link\" href=\"#root/_help_poXkQfguuA0U\">Desktop Installation</a></li><li><a class=\"reference-link\" href=\"#root/_help_cbkrhQjrkKrh\">Synchronization</a></li></ol>",
- "_help_i6dbnitykE5D": "<h2>Inspiration for the name “Trilium”</h2><blockquote><p>Naming software is hard. I lived in Ontario when I first started the project and Trillium (the flower) is sort of a provincial logo, many institutions in Ontario are named \"Trillium [something]\". So I kept hearing/reading it almost everyday, I liked the sound of it and its nature motif, so I just reused it.</p><p><em>– Zadam (original Trilium maintainer)</em></p></blockquote><aside class=\"admonition note\"><p>Despite the fact that the Trillium flower has two “l\"s, the Trilium application only has one.</p></aside><h2>macOS support</h2><p>Originally, Trilium Notes considered the macOS build unsupported. TriliumNext commits to make the experience on macOS as good as possible.</p><p>if you find any platform-specific issues, feel free to <a href=\"#root/_help_wy8So3yZZlH9\">report them</a>.</p><h2>Translation / localisation support</h2><p>The original Trilium Notes application did not support multiple languages. Since we believe that internationalisation is a core part of an application, we have added support for it.</p><p>Contributions to translations are welcome.</p><h2>Multi-user support</h2><p>Common request is to allow multiple users collaborate, share notes etc. So far I'm resisting this because of these reasons:</p><ul><li>it's a huge feature, or rather a Pandora's box of collaboration features like user management, permissions, conflict resolution, real-time editing of a note by multiple people etc. This would be a huge amount of work. Trilium Notes is project made mostly by one person in free time and that's unlikely to change in the future.</li><li>given its size it would probably pivot the attention away from my main focus which is a personal note-taking</li><li>the assumption that only single person has access to the app simplifies many things, or just outright makes them possible. In multi-user app, our <a href=\"#root/_help_CdNpE2pqjmI6\">scripting</a>support would be a XSS security hole, while with the single user assumption it's an endless customizable tool.</li></ul><h2>How to open multiple documents in one Trilium instance</h2><p>This is normally not supported - one Trilium process can open only a single instance of a <a href=\"#root/_help_wX4HbRucYSDD\">database</a>. However, you can run two Trilium processes (from one installation), each connected to a separate document. To achieve this, you need to set a location for the <a href=\"#root/_help_tAassRL4RSQL\">data directory</a> in the <code spellcheck=\"false\">TRILIUM_DATA_DIR</code> environment variable and separate port on <code spellcheck=\"false\">TRILIUM_PORT</code> environment variable. How to do that depends on the platform, in Unix-based systems you can achieve that by running command such as this:</p><pre><code class=\"language-text-x-sh\">TRILIUM_DATA_DIR=/home/me/path/to/data/dir TRILIUM_PORT=12345 trilium </code></pre><p>You can save this command into a <code spellcheck=\"false\">.sh</code> script file or make an alias. Do this similarly for a second instance with different data directory and port.</p><h2>Can I use Dropbox / Google Drive / OneDrive to sync data across multiple computers.</h2><p>No.</p><p>These general purpose sync apps are not suitable to sync database files which are open and being worked on by another application. The result is that they will corrupt the database file, resulting in data loss and this message in the Trilium logs:</p><pre><code class=\"language-text-x-trilium-auto\">SqliteError: database disk image is malformed</code></pre><p>The only supported way to sync Trilium's data across the network is to use a <a href=\"#root/_help_cbkrhQjrkKrh\">sync/web server</a>.</p><h2>Why database instead of flat files?</h2><p>Trilium stores notes in a <a href=\"#root/_help_wX4HbRucYSDD\">database</a> which is an SQLite database. People often ask why doesn't Trilium rather use flat files for note storage - it's fair question since flat files are easily interoperable, work with SCM/git etc.</p><p>Short answer is that file systems are simply not powerful enough for what we want to achieve with Trilium. Using filesystem would mean fewer features with probably more problems.</p><p>More detailed answer:</p><ul><li><a href=\"#root/_help_IakOLONlIfGI\">clones</a> are what you might call \"hard directory link\" in filesystem lingo, but this concept is not implemented in any filesystem</li><li>filesystems make a distinction between directory and file while there's intentionally no such difference in Trilium</li><li>files are stored in no particular order and user can't change this</li><li>Trilium allows storing note <a href=\"#root/_help_zEY4DaJG4YT5\">attributes</a> which could be represented in extended user attributes but their support differs greatly among different filesystems / operating systems</li><li>Trilium makes links / relations between different notes which can be quickly retrieved / navigated (e.g. for <a href=\"#root/_help_BCkXAVs63Ttv\">note map</a>). There's no such support in file systems which means these would have to be stored in some kind of side-car files (mini-databases).</li><li>Filesystems are generally not transactional. While this is not completely required for a note-taking application, having transactions make it way easier to keep notes and their metadata in predictable and consistent state.</li></ul><h2>Search-related Questions</h2><h3>Why does search sometimes find results with typos?</h3><p>Trilium uses a progressive search strategy that includes fuzzy matching when exact matches return fewer than 5 results. This finds notes despite minor typos in your search query. You can use fuzzy search operators (<code spellcheck=\"false\">~=</code> for fuzzy exact match and <code spellcheck=\"false\">~*</code> for fuzzy contains). See the&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>&nbsp;documentation for details.</p><h3>How can I search for notes when I'm not sure of the exact spelling?</h3><p>Use the fuzzy search operators:</p><ul><li><code spellcheck=\"false\">#title ~= \"projct\"</code> - finds notes with titles like \"project\" despite the typo</li><li><code spellcheck=\"false\">note.content ~* \"algoritm\"</code> - finds content containing \"algorithm\" or similar words</li></ul><h3>Why do some search results appear before others with lower scores?</h3><p>Trilium places exact matches before fuzzy matches. When you search for \"project\", notes containing exactly \"project\" appear before notes with variations like \"projects\" or \"projection\", regardless of other scoring factors.</p><h3>How can I make my searches faster?</h3><ol><li>Use the \"Fast search\" option to search only titles and attributes (not content)</li><li>Limit search scope using the \"Ancestor\" field</li><li>Set a result limit to prevent loading too many results</li><li>For large databases, consider archiving old notes to reduce search scope</li></ol>",
- "_help_KSZ04uQ2D1St": "<p>One of the core features of Trilium is that it supports multiple types of notes, depending on the need.</p><h2>Creating a new note with a different type via the note tree</h2><p>The default note type in Trilium (e.g. when creating a new note) is&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>, since it's for general use.</p><p>To create a new note of a different type, head to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and right click an existing note where to place the new one and select:</p><ul><li><em>Insert note after</em>, to put the new note underneath the one selected.</li><li><em>Insert child note</em>, to insert the note as a child of the selected note.</li></ul><p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types_image.png\"></p><h2>Creating a new note of a different type via add link or new tab</h2><ul><li>When adding a <a href=\"#root/_help_QEAPj01N5f7w\">link</a> in a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;note, type the desired title of the new note and press Enter. Afterwards the type of the note will be asked.</li><li>Similarly, when creating a new tab, type the desired title and press Enter.</li></ul><h2>Changing the type of a note</h2><p>It is possible to change the type of a note after it has been created via the <em>Basic Properties</em> tab in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_BlN9DFI679QC\">Ribbon</a>. Note that it's generally a good idea to change the note type only if the note is empty. Can also be used to edit the <a href=\"#root/_help_4FahAwuGTAwC\">source of a note</a>.</p><h2>Supported note types</h2><p>The following note types are supported by Trilium:</p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Note Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a></td>\n<td>The default note type, which allows for rich text formatting, images, admonitions and right-to-left support.</td>\n</tr>\n<tr>\n<td><a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a></td>\n<td>Uses a mono-space font and can be used to store larger chunks of code or plain text than a text note, and has better syntax highlighting.</td>\n</tr>\n<tr>\n<td><a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a></td>\n<td>Stores the information about a search (the search text, criteria, etc.) for later use. Can be used for quick filtering of a large amount of notes, for example. The search can easily be triggered.</td>\n</tr>\n<tr>\n<td><a class=\"reference-link\" href=\"#root/_help_iRwzGnHPzonm\">Relation Map</a></td>\n<td>Allows easy creation of notes and relations between them. Can be used for mainly relational data such as a family tree.</td>\n</tr>\n<tr>\n<td><a class=\"reference-link\" href=\"#root/_help_bdUJEHsAPYQR\">Note Map</a></td>\n<td>Displays the relationships between the notes, whether via relations or their hierarchical structure.</td>\n</tr>\n<tr>\n<td><a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a></td>\n<td>Used in&nbsp;<a class=\"reference-link\" href=\"#root/_help_CdNpE2pqjmI6\">Scripting</a>, it displays the HTML content of another note. This allows displaying any kind of content, provided there is a script behind it to generate it.</td>\n</tr>\n<tr>\n<td><a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a></td>\n<td>Displays the children of the note either as a grid, a list, or for a more specialized case: a calendar.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <br> <br>Generally useful for easy reading of short notes.</td>\n</tr>\n<tr>\n<td><a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a></td>\n<td>Displays diagrams such as bar charts, flow charts, state diagrams, etc. Requires a bit of technical knowledge since the diagrams are written in a specialized format.</td>\n</tr>\n<tr>\n<td><a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a></td>\n<td>Allows easy drawing of sketches, diagrams, handwritten content. Uses the same technology behind <a href=\"https://excalidraw.com\">excalidraw.com</a>.</td>\n</tr>\n<tr>\n<td><a class=\"reference-link\" href=\"#root/_help_1vHRoWCEjj0L\">Web View</a></td>\n<td>Displays the content of an external web page, similar to a browser.</td>\n</tr>\n<tr>\n<td><a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a></td>\n<td>Easy for brainstorming ideas, by placing them in a hierarchical layout.</td>\n</tr>\n<tr>\n<td><a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map</a></td>\n<td>Displays the children of the note as a geographical map, one use-case would be to plan vacations. It even has basic support for tracks. Notes can also be created from it.</td>\n</tr>\n<tr>\n<td><a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a></td>\n<td>Represents an uploaded file such as PDFs, images, video or audio files.</td>\n</tr>\n</tbody></table></figure>",
- "_help_iPIMuisry3hd": "<p>The default note type in Trilium, text notes allow for rich formatting, tables, images, admonitions and a handful of other features.</p><h2>Formatting bars</h2><p>Most of the interaction with text notes is done via the built-in toolbars. Depending on preference, there are two different layouts:</p><ul><li>The <em>Floating toolbar</em> is hidden by default and only appears when needed. In this mode there are actually two different toolbars:<br><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/1_Text_image.png\" width=\"496\" height=\"91\"><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/2_Text_image.png\" width=\"812\" height=\"114\"></li><li>A toolbar that appears when text is selected. This provides text-level formatting such as bold, italic, text colors, inline code, etc.<br><em><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text_image.png\" width=\"1109\" height=\"124\"></em></li></ul><p>Fore more information see&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>.</p><h2>Features and formatting</h2><p>Here's a list of various features supported by text notes:</p><table>\n <thead>\n <tr>\n <th>Dedicated article</th>\n <th>Feature</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td><a class=\"reference-link\" href=\"#root/_help_Gr6xFaF6ioJ5\">General formatting</a></td>\n <td><ul><li>Headings (section titles, paragraph)</li><li>Font size</li><li>Bold, italic, underline, strike-through</li><li>Superscript, subscript</li><li>Font color &amp; background color</li><li>Remove formatting</li></ul></td>\n </tr>\n <tr>\n <td><a class=\"reference-link\" href=\"#root/_help_S6Xx8QIWTV66\">Lists</a></td>\n <td><ul><li>Bulleted lists</li><li>Numbered lists</li><li>To-do lists</li></ul></td>\n </tr>\n <tr>\n <td><a class=\"reference-link\" href=\"#root/_help_NwBbFdNZ9h7O\">Block quotes &amp; admonitions</a></td>\n <td><ul><li>Block quotes</li><li>Admonitions</li></ul></td>\n </tr>\n <tr>\n <td><a class=\"reference-link\" href=\"#root/_help_NdowYOC1GFKS\">Tables</a></td>\n <td><ul><li>Basic tables</li><li>Merging cells</li><li>Styling tables and cells.</li><li>Table captions</li></ul></td>\n </tr>\n <tr>\n <td><a class=\"reference-link\" href=\"#root/_help_UYuUB1ZekNQU\">Developer-specific formatting</a></td>\n <td><ul><li>Inline code</li><li>Code blocks</li><li>Keyboard shortcuts</li></ul></td>\n </tr>\n <tr>\n <td><a class=\"reference-link\" href=\"#root/_help_AgjCISero73a\">Footnotes</a></td>\n <td><ul><li>Footnotes</li></ul></td>\n </tr>\n <tr>\n <td><a class=\"reference-link\" href=\"#root/_help_mT0HEkOsz6i1\">Images</a></td>\n <td><ul><li>Images</li></ul></td>\n </tr>\n <tr>\n <td><a class=\"reference-link\" href=\"#root/_help_QEAPj01N5f7w\">Links</a></td>\n <td><ul><li>External links</li><li>Internal Trilium links</li></ul></td>\n </tr>\n <tr>\n <td><a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a></td>\n <td><ul><li>Include note</li></ul></td>\n </tr>\n <tr>\n <td><a class=\"reference-link\" href=\"#root/_help_CohkqWQC1iBv\">Insert buttons</a></td>\n <td><ul><li>Symbols</li><li><a class=\"reference-link\" href=\"#root/_help_YfYAtQBcfo5V\">Math Equations</a></li><li>Mermaid diagrams</li><li>Horizontal ruler</li><li>Page break</li></ul></td>\n </tr>\n <tr>\n <td><a class=\"reference-link\" href=\"#root/_help_dEHYtoWWi8ct\">Other features</a></td>\n <td><ul><li>Indentation<ul><li>Markdown import</li></ul></li><li><a class=\"reference-link\" href=\"#root/_help_2x0ZAX9ePtzV\">Cut to subnote</a></li></ul></td>\n </tr>\n <tr>\n <td><a class=\"reference-link\" href=\"#root/_help_gLt3vA97tMcp\">Premium features</a></td>\n <td><ul><li><a class=\"reference-link\" href=\"#root/_help_ZlN4nump6EbW\">Slash Commands</a></li><li><a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a></li><li><a class=\"reference-link\" href=\"#root/_help_5wZallV2Qo1t\">Format Painter</a></li></ul></td>\n </tr>\n </tbody>\n</table><h2>Read-Only vs. Editing Mode</h2><p>Text notes are usually opened in edit mode. However, they may open in read-only mode if the note is too big or the note is explicitly marked as read-only. For more information, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_CoFPLs3dRlXc\">[missing note]</a>.</p><h2>Keyboard shortcuts</h2><p>There are numerous keyboard shortcuts to format the text without having to use the mouse. For a reference of all the key combinations, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_A9Oc6YKKc65v\">[missing note]</a>. In addition, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_QrtTYPmdd1qq\">Markdown-like formatting</a>&nbsp;as an alternative to the keyboard shortcuts.</p><h2>Content width</h2><p>For readability purposes on wider screens, the width of text notes is limited via a configurable option. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_t596jLvPrqkS\">[missing note]</a>&nbsp;for more information.</p><h2>Converting to a Markdown note</h2><p>Text notes can be converted to&nbsp;<a class=\"reference-link\" href=\"#root/_help_6RM1Q7ppFVoj\">Markdown</a>&nbsp;notes. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_jludwdW7N4hg\">Converting between note types</a>.</p><h2>Technical details</h2><p>For the text editing functionality, Trilium uses a commercial product (with an open-source base) called&nbsp;<a class=\"reference-link\" href=\"#root/_help_MI26XDLSAlCD\">[missing note]</a>. This brings the benefit of having a powerful WYSIWYG (What You See Is What You Get) editor.</p>",
- "_help_oSuaNgyyKnhu": "<aside class=\"admonition note\"><p>This feature used to be called <em>Bookmarks</em> (as it is the official name in the editor we are using), but in order not to collide with the concept of&nbsp;<a class=\"reference-link\" href=\"#root/_help_u3YFHC9tQlpm\">Bookmarks</a>, we have renamed it to <em>Anchors.</em></p></aside><p>Anchors allows creating <a href=\"#root/_help_QEAPj01N5f7w\">links</a> to a certain part of a note, such as referencing a particular heading or section within a note.</p><p>This feature was introduced in TriliumNext v0.94.0 and augmented in v0.103.0 to support linking across notes.</p><h2>Interaction</h2><ul><li>To create a anchor:<ul><li>Place the cursor at the desired position where to place the anchor.</li><li>Look for the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Anchors_plus.png\" width=\"15\" height=\"16\"> button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>, and then press the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Anchors_plus.png\" width=\"12\" height=\"15\"> button.</li><li>Alternatively, use&nbsp;<a class=\"reference-link\" href=\"#root/_help_ZlN4nump6EbW\">Slash Commands</a>&nbsp;and look for <em>anchor</em>.</li></ul></li><li>To place a link to a anchor:<ul><li>Place the cursor at the desired position of the link.</li><li>From the <a href=\"#root/_help_QEAPj01N5f7w\">link</a> pane, select the <em>Anchors</em> section and select the desired anchor.</li></ul></li></ul><h2>Linking across notes</h2><p>Trilium v0.103.0 introduces cross-note Anchors, which makes it possible to create&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;which point to a specific anchor in that document.</p><h3>Compatibility with documents from previous versions</h3><p>For notes created prior to Trilium v0.103.0, you might notice that the Anchors might not be identified. This limitation is intentional in order not to have to re-process all the notes, looking for anchors.</p><p>To fix this, simply go that note and make any change (e.g. inserting a space), this will trigger the recalculation of the links.</p><h3>Linking to anchors through the <em>Add link</em> dialog</h3><ol><li>Create an anchor in the target note using the same process as described above.</li><li>In another note, press <kbd>Ctrl</kbd>+<kbd>L</kbd> to insert an internal link. Select the target note containing Anchors.</li><li>If the target note contains Anchors, a section will appear underneath the note selector with the list of Anchors.</li><li>Add the link normally.</li></ol><p>Clicking on a reference link pointing to a anchor will automatically scroll to the desired section.</p><h3>Linking to anchors through the bookmark toolbar</h3><ol><li>Create an anchor in the target note using the same process as described above.</li><li>Click on the anchor to reveal the anchor's floating toolbar.</li><li>Click on the <em>Copy anchor reference link</em> button.</li><li>Go to the note where to insert the link and press <kbd>Ctrl</kbd>+<kbd>V</kbd>.</li></ol><aside class=\"admonition note\"><p>Use this method only to insert&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;between two documents. To link to an anchor on the same note, use the <em>Insert link</em> dialog (<kbd>Ctrl</kbd>+<kbd>K</kbd>) and select the <em>Anchors</em> item instead.</p></aside>",
- "_help_oI7GoyilXXAr": "<h2>Automatic replacements</h2><p>As you type in a text note, certain character sequences are replaced with the typographic symbol they represent. Typing <code spellcheck=\"false\">(c)</code> gives you <code spellcheck=\"false\">©</code>, <code spellcheck=\"false\">...</code> gives you <code spellcheck=\"false\">…</code>, and <code spellcheck=\"false\">\"quote\"</code> gives you <code spellcheck=\"false\">“quote”</code>.</p><p>These replacements are not applied inside code blocks or inline code, and pasted text is never affected — only text you type. If you have pasted a code snippet, or written one inside a code block, its characters are left exactly as they are.</p><p>Once an automatic replacement takes place, it can be undone by:</p><ul><li>Pressing <kbd>Backspace</kbd> immediately after a replacement undoes it and restores what you typed.<ul><li>Note that this consumes the undo, so a further <kbd>Ctrl</kbd>+<kbd>Z</kbd> might delete your typed text.</li><li>Pressing <kbd>Space</kbd> or changing the cursor position disables this functionality.</li></ul></li><li>Pressing <kbd>Ctrl</kbd>+<kbd>Z</kbd>, which works even after pressing space.</li></ul><p>Each group can be turned off in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Text notes</em> → <em>Automatic replacements</em>.</p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Group</th>\n<th>What it replaces</th>\n</tr>\n</thead>\n<tbody><tr>\n<td>Punctuation</td>\n<td><code spellcheck=\"false\">...</code> with an ellipsis (<code spellcheck=\"false\">…</code>), and <code spellcheck=\"false\">--</code> and <code spellcheck=\"false\">---</code> <em>surrounded by spaces</em> with an en dash (<code spellcheck=\"false\">–</code>) and an em dash (<code spellcheck=\"false\">—</code>)</td>\n</tr>\n<tr>\n<td>Mathematical symbols</td>\n<td>fractions such as <code spellcheck=\"false\">1/2</code> with <code spellcheck=\"false\">½</code>, and the operators <code spellcheck=\"false\">&lt;=</code>, <code spellcheck=\"false\">&gt;=</code>, <code spellcheck=\"false\">!=</code>, <code spellcheck=\"false\">&lt;-</code> and <code spellcheck=\"false\">-&gt;</code> with <code spellcheck=\"false\">≤</code>, <code spellcheck=\"false\">≥</code>, <code spellcheck=\"false\">≠</code>, <code spellcheck=\"false\">←</code> and <code spellcheck=\"false\">→</code></td>\n</tr>\n<tr>\n<td>Copyright and trademark</td>\n<td><code spellcheck=\"false\">(c)</code>, <code spellcheck=\"false\">(r)</code> and <code spellcheck=\"false\">(tm)</code> with <code spellcheck=\"false\">©</code>, <code spellcheck=\"false\">®</code> and <code spellcheck=\"false\">™</code></td>\n</tr>\n<tr>\n<td>Quotation marks</td>\n<td>straight quotes with typographic ones — see below</td>\n</tr>\n</tbody></table></figure><h2>Quotation marks</h2><p>Quotation marks are configured separately from the rest, with one setting for the <strong>double</strong> quote key and one for the <strong>single</strong> quote key, because which pair belongs on which key differs between conventions — British typography traditionally sets a quotation in <code spellcheck=\"false\">‘…’</code> where American sets it in <code spellcheck=\"false\">“…”</code>.</p><p>Each offers:</p><ul><li><em>Based on the note's content language</em> (the default) — English gives <code spellcheck=\"false\">“quote”</code>, German <code spellcheck=\"false\">„quote“</code>, French <code spellcheck=\"false\">« quote »</code>, Japanese <code spellcheck=\"false\">「quote」</code>. See <em>Content language &amp; Right-to-left support</em> for how a note's language is decided.</li><li><em>Disabled,</em> straight quotes stay straight.</li><li><em>A specific pair</em> — <code spellcheck=\"false\">“…”</code>, <code spellcheck=\"false\">‘…’</code>, <code spellcheck=\"false\">„…“</code>, <code spellcheck=\"false\">„…”</code>, <code spellcheck=\"false\">«…»</code>, <code spellcheck=\"false\">« … »</code>, <code spellcheck=\"false\">‹…›</code>, <code spellcheck=\"false\">「…」</code>, <code spellcheck=\"false\">『…』</code>. Choosing one applies it to every note, whatever language it is written in.</li></ul><h2>Custom replacements</h2><p>You can add your own under&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Text notes</em> → <em>Automatic replacements</em> → <em>Custom replacements</em>. Type the text to replace and the replacement, then press Enter. Existing ones are shown as chips and removed with the × on each.</p><p>A custom replacement is applied when the text is typed as a whole word and followed by a space, so longer words that begin with it are left alone — a <code spellcheck=\"false\">TN</code> replacement does not rewrite the end of <code spellcheck=\"false\">BTN</code>, and <code spellcheck=\"false\">TNT</code> can still be typed.</p><p>Capitalisation follows what you type, unless the replacement has capitals of its own:</p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th><strong>Replacement you defined</strong></th>\n<th><strong>You type</strong></th>\n<th><strong>You get</strong></th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code spellcheck=\"false\">teh</code> → <code spellcheck=\"false\">the</code></td>\n<td><code spellcheck=\"false\">teh</code> / <code spellcheck=\"false\">Teh</code> / <code spellcheck=\"false\">TEH</code></td>\n<td><code spellcheck=\"false\">the</code> / <code spellcheck=\"false\">The</code> / <code spellcheck=\"false\">THE</code></td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">TN</code> → <code spellcheck=\"false\">Trilium Notes</code></td>\n<td><code spellcheck=\"false\">TN</code> or <code spellcheck=\"false\">tn</code></td>\n<td><code spellcheck=\"false\">Trilium Notes</code> (unchanged — it has capitals)</td>\n</tr>\n</tbody></table></figure><p>The text to replace is matched literally; it is not a pattern. Typing a replacement whose \"text to replace\" already exists updates that entry rather than adding a second one.</p><h2>Characters that only look replaced (ligatures)</h2><p>If you see <code spellcheck=\"false\">!=</code> displayed as <code spellcheck=\"false\">≠</code> or <code spellcheck=\"false\">-&gt;</code> as <code spellcheck=\"false\">→</code> inside a code block, that is not a replacement — replacements never run there. It is a <em>font ligature</em>: the default monospace font draws certain character pairs as a single symbol. The underlying text is unchanged, and copying it out gives you back <code spellcheck=\"false\">!=</code> and <code spellcheck=\"false\">-&gt;</code>.</p><p>This can be turned off with&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a><em>→ Appearance → Fonts → Programming ligatures.</em></p>",
- "_help_NwBbFdNZ9h7O": "<h2>Block quotes</h2><p>As the name suggests, block quotes can be useful to cite one or more paragraphs.</p><p>To create a block quote, press <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Block%20quotes%20%26%20admonitions_image.png\" width=\"15\" height=\"12\"> from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>. It's also possible to type <kbd>&gt;</kbd>, followed by a space to create one (but only if the cursor is at the beginning of a line).</p><p>Inside the quote block, other block items can be inserted such as tables, images, or even other block quotes or admonitions.</p><h2>Admonitions</h2><p>Admonitions are a way to highlight information to the reader. Other names for it include <em>call-outs</em> and <em>info/warning/alert boxes</em>.</p><figure class=\"image image-style-align-center\"><img style=\"aspect-ratio:959/547;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/2_Block%20quotes%20%26%20admonitions_image.png\" width=\"959\" height=\"547\"></figure><p>From a functional point of view, admonitions act very similarly to a block quote, just with different styling. This includes the ability to insert other elements in it such as headings, tables, images, etc.</p><h3>Inserting a new admonition</h3><p>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>:</p><p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Block%20quotes%20%26%20admonitions_image.png\"></p><p>It's possible to insert an admonition simply by typing:</p><ul><li><code spellcheck=\"false\">!!! note</code></li><li><code spellcheck=\"false\">!!! tip</code></li><li><code spellcheck=\"false\">!!! important</code></li><li><code spellcheck=\"false\">!!! caution</code></li><li><code spellcheck=\"false\">!!! warning</code></li></ul><p>In addition to that, it's also possible to type <code spellcheck=\"false\">!!!</code>&nbsp; followed by any text, case in which a default admonition type will appear (note) with the entered text inside it.</p><h3>Interaction</h3><p>By design, admonitions act very similar to block quotes.</p><ul><li>Selecting a text and pressing the admonition button will turn that text into an admonition.</li><li>If selecting multiple admonitions, pressing the admonition button will automatically merge them into one.</li></ul><p>Inside an admonition:</p><ul><li>Pressing <kbd>Backspace</kbd> while the admonition is empty will remove it.</li><li>Pressing <kbd>Enter</kbd> will start a new paragraph. Pressing it twice will exit out of the admonition.</li><li>Headings and other block content including tables can be inserted inside the admonition.</li></ul><h3>Types of admonitions</h3><p>There are currently five types of admonitions: <em>Note</em>, <em>Tip</em>, <em>Important</em>, <em>Caution</em>, <em>Warning</em>.</p><p>These types were inspired by GitHub's support for this feature and there are currently no plans for adjusting it or allowing the user to customize them.</p><h3>Markdown support</h3><p>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_rJ9grSgoExl9\">Supported syntax</a>.</p>",
- "_help_4n4oQUVbnOxa": "<p>Collapsible blocks are sections of content that can be expanded and collapsed, letting you hide detail until it's needed.</p><p>A collapsible block consists of:</p><ul><li><strong>An always-visible header</strong>, containing:<ul><li><strong>An arrow</strong> that expands or collapses the block when clicked.</li><li><strong>A summary line</strong> that acts as the block's title. With the cursor in the summary line, press <kbd>Ctrl</kbd>+<kbd>Enter</kbd> to expand or collapse the block.</li><li><strong>A drag handle</strong> for repositioning the block within the note.</li></ul></li><li><strong>The body</strong>, which is hidden while the block is collapsed. It can hold any kind of content, including nested collapsible blocks. To break out of a collapsible block and continue typing outside it, press <kbd>Enter</kbd> twice at the end of the block.</li></ul><p>You can use the arrow keys to move freely with the cursor between the summary line, the block's body, and the text around the block.</p><h2>Inserting a collapsible block</h2><p>In the formatting bar, go to “<strong>Insert” → “Collapsible Block”</strong>.</p><aside class=\"admonition tip\"><p>Place multiple collapsible blocks one after another to create an accordion, where each block can be expanded or collapsed independently.</p></aside>",
- "_help_veGu4faJErEM": "<p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Content%20language%20%26%20Right-to-left%20support_image.jpg\"></p><p>The content language determines:</p><ul><li>The spell-checking of the note, when in a browser. The desktop installation has a dedicated spellchecking section.</li><li>Whether the text is displayed from right-to-left, for languages such as Arabic, Hebrew, etc.</li><li>How typed quotes are <a href=\"#root/_help_oI7GoyilXXAr\">automatically replaced</a> (e.g. English uses <code spellcheck=\"false\">“text”</code>, whereas some languages use <code spellcheck=\"false\">«text»</code>).</li></ul><h2>Setting the language of a single note</h2><p>To set the language of the content of a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;note:</p><ul><li>On the new layout, there is a language selector in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlJ73vBCjWDw\">Status bar</a>.</li><li>On the old layout, go to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_BlN9DFI679QC\">Ribbon</a>&nbsp;→ <em>Basic Properties</em> and look for the <em>Language</em> field.</li></ul><h2>Adjusting the list of languages</h2><p>By default there will be no language configured, they can be configured by going to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ Language &amp; Region or by selecting the <em>Configure languages</em> item when setting the language.</p><h2>Default content language</h2><p>Notes that do not have a language of their own follow&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Language &amp; Region</em> → <em>Default content language</em>. It is set to English initially, and can be set to any content language, or to <em>Based on the application's language</em>.</p><p>If a note has a language set, it always takes precedence over the default.</p>",
++ "_help_i6dbnitykE5D": "<h2>Inspiration for the name “Trilium”</h2><blockquote><p>Naming software is hard. I lived in Ontario when I first started the project and Trillium (the flower) is sort of a provincial logo, many institutions in Ontario are named \"Trillium [something]\". So I kept hearing/reading it almost everyday, I liked the sound of it and its nature motif, so I just reused it.</p><p><em>– Zadam (original Trilium maintainer)</em></p></blockquote><aside class=\"admonition note\"><p>Despite the fact that the Trillium flower has two “l\"s, the Trilium application only has one.</p></aside><h2>How do I create a folder?</h2><p>Trilium has no separate folder type: any note can have child notes, so any note can act as a folder. A note can hold its own content and have children at the same time, unlike a file system, which separates files from directories.</p><p>To organize notes into a folder:</p><ol><li>Create a note that acts as the folder, for example \"Projects\".</li><li>Right-click it in the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a> and select <em>Insert child note</em>, or hover over it and press the <span class=\"tn-icon bx bx-plus\"></span> button.</li><li>To move existing notes into it, drag them onto it in the tree.</li></ol><p>The children of a note are listed at the end of its content (see <a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a>).</p><p>If you want the note to look like a folder, with no content of its own and only its children shown, make it a collection instead: right-click in the tree, select <em>Insert child note</em> → <em>Collection</em>, then choose <a class=\"reference-link\" href=\"#root/_help_8QqnMzx393bx\">Grid View</a> or <a class=\"reference-link\" href=\"#root/_help_mULW0Q3VojwY\">List View</a>. See <a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a> for the other views, such as tables, boards and calendars.</p><h2>macOS support</h2><p>Originally, Trilium Notes considered the macOS build unsupported. TriliumNext commits to make the experience on macOS as good as possible.</p><p>if you find any platform-specific issues, feel free to <a href=\"#root/_help_wy8So3yZZlH9\">report them</a>.</p><h2>Translation / localisation support</h2><p>The original Trilium Notes application did not support multiple languages. Since we believe that internationalisation is a core part of an application, we have added support for it.</p><p>Contributions to translations are welcome.</p><h2>Multi-user support</h2><p>Common request is to allow multiple users collaborate, share notes etc. So far I'm resisting this because of these reasons:</p><ul><li>it's a huge feature, or rather a Pandora's box of collaboration features like user management, permissions, conflict resolution, real-time editing of a note by multiple people etc. This would be a huge amount of work. Trilium Notes is project made mostly by one person in free time and that's unlikely to change in the future.</li><li>given its size it would probably pivot the attention away from my main focus which is a personal note-taking</li><li>the assumption that only single person has access to the app simplifies many things, or just outright makes them possible. In multi-user app, our <a href=\"#root/_help_CdNpE2pqjmI6\">scripting</a>support would be a XSS security hole, while with the single user assumption it's an endless customizable tool.</li></ul><h2>How to open multiple documents in one Trilium instance</h2><p>This is normally not supported - one Trilium process can open only a single instance of a <a href=\"#root/_help_wX4HbRucYSDD\">database</a>. However, you can run two Trilium processes (from one installation), each connected to a separate document. To achieve this, you need to set a location for the <a href=\"#root/_help_tAassRL4RSQL\">data directory</a> in the <code>TRILIUM_DATA_DIR</code> environment variable and separate port on <code>TRILIUM_PORT</code> environment variable. How to do that depends on the platform, in Unix-based systems you can achieve that by running command such as this:</p><pre><code class=\"language-text-x-sh\">TRILIUM_DATA_DIR=/home/me/path/to/data/dir TRILIUM_PORT=12345 trilium </code></pre><p>You can save this command into a <code>.sh</code> script file or make an alias. Do this similarly for a second instance with different data directory and port.</p><h2>Can I use Dropbox / Google Drive / OneDrive to sync data across multiple computers.</h2><p>No.</p><p>These general purpose sync apps are not suitable to sync database files which are open and being worked on by another application. The result is that they will corrupt the database file, resulting in data loss and this message in the Trilium logs:</p><pre><code class=\"language-text-x-trilium-auto\">SqliteError: database disk image is malformed</code></pre><p>The only supported way to sync Trilium's data across the network is to use a <a href=\"#root/_help_cbkrhQjrkKrh\">sync/web server</a>.</p><h2>Why database instead of flat files?</h2><p>Trilium stores notes in a <a href=\"#root/_help_wX4HbRucYSDD\">database</a> which is an SQLite database. People often ask why doesn't Trilium rather use flat files for note storage - it's fair question since flat files are easily interoperable, work with SCM/git etc.</p><p>Short answer is that file systems are simply not powerful enough for what we want to achieve with Trilium. Using filesystem would mean fewer features with probably more problems.</p><p>More detailed answer:</p><ul><li><a href=\"#root/_help_IakOLONlIfGI\">clones</a> are what you might call \"hard directory link\" in filesystem lingo, but this concept is not implemented in any filesystem</li><li>filesystems make a distinction between directory and file while there's intentionally no such difference in Trilium</li><li>files are stored in no particular order and user can't change this</li><li>Trilium allows storing note <a href=\"#root/_help_zEY4DaJG4YT5\">attributes</a> which could be represented in extended user attributes but their support differs greatly among different filesystems / operating systems</li><li>Trilium makes links / relations between different notes which can be quickly retrieved / navigated (e.g. for <a href=\"#root/_help_BCkXAVs63Ttv\">note map</a>). There's no such support in file systems which means these would have to be stored in some kind of side-car files (mini-databases).</li><li>Filesystems are generally not transactional. While this is not completely required for a note-taking application, having transactions make it way easier to keep notes and their metadata in predictable and consistent state.</li></ul><h2>Search-related Questions</h2><h3>Why does search sometimes find results with typos?</h3><p>Trilium uses a progressive search strategy that includes fuzzy matching when exact matches return fewer than 5 results. This finds notes despite minor typos in your search query. You can use fuzzy search operators (<code>~=</code> for fuzzy exact match and <code>~*</code> for fuzzy contains). See the&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>&nbsp;documentation for details.</p><h3>How can I search for notes when I'm not sure of the exact spelling?</h3><p>Use the fuzzy search operators:</p><ul><li><code>#title ~= \"projct\"</code> - finds notes with titles like \"project\" despite the typo</li><li><code>note.content ~* \"algoritm\"</code> - finds content containing \"algorithm\" or similar words</li></ul><h3>Why do some search results appear before others with lower scores?</h3><p>Trilium places exact matches before fuzzy matches. When you search for \"project\", notes containing exactly \"project\" appear before notes with variations like \"projects\" or \"projection\", regardless of other scoring factors.</p><h3>How can I make my searches faster?</h3><ol><li>Use the \"Fast search\" option to search only titles and attributes (not content)</li><li>Limit search scope using the \"Ancestor\" field</li><li>Set a result limit to prevent loading too many results</li><li>For large databases, consider archiving old notes to reduce search scope</li></ol>",
++ "_help_KSZ04uQ2D1St": "<p>One of the core features of Trilium is that it supports multiple types of notes, depending on the need.</p><h2>Creating a new note with a different type via the note tree</h2><p>The default note type in Trilium (e.g. when creating a new note) is&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>, since it's for general use.</p><p>To create a new note of a different type, head to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and right click an existing note where to place the new one and select:</p><ul><li><em>Insert note after</em>, to put the new note underneath the one selected.</li><li><em>Insert child note</em>, to insert the note as a child of the selected note.</li></ul><p>The note types created less often,&nbsp;<a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a>,&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>,&nbsp;<a class=\"reference-link\" href=\"#root/_help_1vHRoWCEjj0L\">Web View</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_bdUJEHsAPYQR\">Note Map</a>, are in the <em>More</em> submenu.</p><p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types_image.png\"></p><h2>Creating a new note of a different type via add link or new tab</h2><ul><li>When adding a <a href=\"#root/_help_QEAPj01N5f7w\">link</a> in a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;note, type the desired title of the new note and press Enter. Afterwards the type of the note will be asked.</li><li>Similarly, when creating a new tab, type the desired title and press Enter.</li></ul><p>The note type is chosen from the same menu as in the note tree, with its submenus (code languages, snippets, collections and the note types created less often) and its search box: type to narrow the list, then press <kbd>Enter</kbd> to create the first match. <kbd>Enter</kbd> right away creates a Text note.</p><h2>Changing the type of a note</h2><p>It is possible to change the type of a note after it has been created via&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>&nbsp;→ <em>Note type</em>. This feature can also be used to edit the <a href=\"#root/_help_4FahAwuGTAwC\">source of a note</a>.</p><aside class=\"admonition note\"><p>Note that it's generally a good idea to change the note type only if the note is empty</p></aside><h2>Supported note types</h2><p>The following note types are supported by Trilium:</p><figure class=\"table\"><table><thead><tr><th>Note Type</th><th>Description</th></tr></thead><tbody><tr><td><a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a></td><td>The default note type, which allows for rich text formatting, images, admonitions and right-to-left support.</td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a></td><td>Uses a mono-space font and can be used to store larger chunks of code or plain text than a text note, and has better syntax highlighting.</td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a></td><td>Stores the information about a search (the search text, criteria, etc.) for later use. Can be used for quick filtering of a large amount of notes, for example. The search can easily be triggered.</td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_iRwzGnHPzonm\">Relation Map</a></td><td>Allows easy creation of notes and relations between them. Can be used for mainly relational data such as a family tree.</td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_bdUJEHsAPYQR\">Note Map</a></td><td>Displays the relationships between the notes, whether via relations or their hierarchical structure.</td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a></td><td>Used in&nbsp;<a class=\"reference-link\" href=\"#root/_help_CdNpE2pqjmI6\">Scripting</a>, it displays the HTML content of another note. This allows displaying any kind of content, provided there is a script behind it to generate it.</td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a></td><td>Displays the children of the note either as a grid, a list, or for a more specialized case: a calendar.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <br> <br>Generally useful for easy reading of short notes.</td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a></td><td>Displays diagrams such as bar charts, flow charts, state diagrams, etc. Requires a bit of technical knowledge since the diagrams are written in a specialized format.</td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a></td><td>Allows easy drawing of sketches, diagrams, handwritten content. Uses the same technology behind <a href=\"https://excalidraw.com\">excalidraw.com</a>.</td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_1vHRoWCEjj0L\">Web View</a></td><td>Displays the content of an external web page, similar to a browser.</td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a></td><td>Easy for brainstorming ideas, by placing them in a hierarchical layout.</td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map</a></td><td>Displays the children of the note as a geographical map, one use-case would be to plan vacations. It even has basic support for tracks. Notes can also be created from it.</td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a></td><td>Represents an uploaded file such as PDFs, images, video or audio files.</td></tr></tbody></table></figure>",
++ "_help_iPIMuisry3hd": "<p>The default note type in Trilium, text notes allow for rich formatting, tables, images, admonitions and a handful of other features.</p><h2>Formatting bars</h2><p>Most of the interaction with text notes is done via the built-in toolbars. Depending on preference, there are two different layouts:</p><ul><li>The <em>Floating toolbar</em> is hidden by default and only appears when needed. In this mode there are actually two different toolbars:<br><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/1_Text_image.png\" width=\"496\" height=\"91\"><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/2_Text_image.png\" width=\"812\" height=\"114\"></li><li>A toolbar that appears when text is selected. This provides text-level formatting such as bold, italic, text colors, inline code, etc.<br><em><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text_image.png\" width=\"1109\" height=\"124\"></em></li></ul><p>Fore more information see&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>.</p><h2>Features and formatting</h2><p>Here's a list of various features supported by text notes:</p><figure class=\"table\"><table><thead><tr><th>Dedicated article</th><th>Feature</th></tr></thead><tbody><tr><td><a class=\"reference-link\" href=\"#root/_help_Gr6xFaF6ioJ5\">General formatting</a></td><td><ul><li>Headings (section titles, paragraph)</li><li>Font size</li><li>Bold, italic, underline, strike-through</li><li>Superscript, subscript</li><li>Font color &amp; background color</li><li>Remove formatting</li></ul></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_S6Xx8QIWTV66\">Lists</a></td><td><ul><li>Bulleted lists</li><li>Numbered lists</li><li>To-do lists</li></ul></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_NwBbFdNZ9h7O\">Block quotes &amp; admonitions</a></td><td><ul><li>Block quotes</li><li>Admonitions</li></ul></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_NdowYOC1GFKS\">Tables</a></td><td><ul><li>Basic tables</li><li>Merging cells</li><li>Styling tables and cells.</li><li>Table captions</li></ul></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_UYuUB1ZekNQU\">Developer-specific formatting</a></td><td><ul><li>Inline code</li><li>Code blocks</li><li>Keyboard shortcuts</li></ul></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_AgjCISero73a\">Footnotes</a></td><td><ul><li>Footnotes</li></ul></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_mT0HEkOsz6i1\">Images</a></td><td><ul><li>Images</li></ul></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_QEAPj01N5f7w\">Links</a></td><td><ul><li>External links</li><li>Internal Trilium links</li></ul></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a></td><td><ul><li>Include note</li></ul></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_klC3ilXa9kUE\">Block references</a></td><td><ul><li>Links to blocks of a note</li><li>Including blocks of a note</li></ul></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_CohkqWQC1iBv\">Insert buttons</a></td><td><ul><li>Symbols</li><li><a class=\"reference-link\" href=\"#root/_help_YfYAtQBcfo5V\">Math Equations</a></li><li>Mermaid diagrams</li><li>Horizontal ruler</li><li>Page break</li></ul></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_dEHYtoWWi8ct\">Other features</a></td><td><ul><li>Indentation<ul><li>Markdown import</li></ul></li><li><a class=\"reference-link\" href=\"#root/_help_2x0ZAX9ePtzV\">Cut to subnote</a></li></ul></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_gLt3vA97tMcp\">Premium features</a></td><td><ul><li><a class=\"reference-link\" href=\"#root/_help_ZlN4nump6EbW\">Slash Commands</a></li><li><a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a></li><li><a class=\"reference-link\" href=\"#root/_help_5wZallV2Qo1t\">Format Painter</a></li></ul></td></tr></tbody></table></figure><h2>Read-Only vs. Editing Mode</h2><p>Text notes are usually opened in edit mode. However, they may open in read-only mode if the note is too big or the note is explicitly marked as read-only. For more information, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_CoFPLs3dRlXc\">Read-Only Notes</a>.</p><h2>Keyboard shortcuts</h2><p>There are numerous keyboard shortcuts to format the text without having to use the mouse. For a reference of all the key combinations, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_A9Oc6YKKc65v\">Keyboard Shortcuts</a>. In addition, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_QrtTYPmdd1qq\">Markdown-like formatting</a>&nbsp;as an alternative to the keyboard shortcuts.</p><h2>Content width</h2><p>For readability purposes on wider screens, the width of text notes is limited via a configurable option. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_t596jLvPrqkS\">Content width</a>&nbsp;for more information.</p><h2>Converting to a Markdown note</h2><p>Text notes can be converted to&nbsp;<a class=\"reference-link\" href=\"#root/_help_6RM1Q7ppFVoj\">Markdown</a>&nbsp;notes. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_jludwdW7N4hg\">Converting between note types</a>.</p><h2>Technical details</h2><p>For the text editing functionality, Trilium uses a commercial product (with an open-source base) called&nbsp;<a class=\"reference-link\" href=\"#root/_help_MI26XDLSAlCD\">CKEditor</a>. This brings the benefit of having a powerful WYSIWYG (What You See Is What You Get) editor.</p>",
++ "_help_oSuaNgyyKnhu": "<aside class=\"admonition note\"><p>This feature used to be called <em>Bookmarks</em> (as it is the official name in the editor we are using), but in order not to collide with the concept of&nbsp;<a class=\"reference-link\" href=\"#root/_help_u3YFHC9tQlpm\">Bookmarks</a>, we have renamed it to <em>Anchors.</em></p></aside><p>Anchors allows creating <a href=\"#root/_help_QEAPj01N5f7w\">links</a> to a certain part of a note, such as referencing a particular heading or section within a note.</p><p>This feature was introduced in TriliumNext v0.94.0 and augmented in v0.103.0 to support linking across notes.</p><h2>Interaction</h2><ul><li>To create a anchor:<ul><li>Place the cursor at the desired position where to place the anchor.</li><li>Look for the&nbsp;<span class=\"tn-icon bx bx-plus\"></span> button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>, and then press the&nbsp;<span class=\"tn-icon cke cke-bookmark\"></span> button.</li><li>Alternatively, use&nbsp;<a class=\"reference-link\" href=\"#root/_help_ZlN4nump6EbW\">Slash Commands</a>&nbsp;and look for <em>anchor</em>.</li></ul></li><li>To place a link to a anchor:<ul><li>Place the cursor at the desired position of the link.</li><li>From the <a href=\"#root/_help_QEAPj01N5f7w\">link</a> pane, select the <em>Anchors</em> section and select the desired anchor.</li></ul></li></ul><h2>Linking across notes</h2><p>Trilium v0.103.0 introduces cross-note Anchors, which makes it possible to create&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;which point to a specific anchor in that document.</p><h3>Compatibility with documents from previous versions</h3><p>For notes created prior to Trilium v0.103.0, you might notice that the Anchors might not be identified. This limitation is intentional in order not to have to re-process all the notes, looking for anchors.</p><p>To fix this, simply go that note and make any change (e.g. inserting a space), this will trigger the recalculation of the links.</p><h3>Linking to anchors through the <em>Add link</em> dialog</h3><ol><li>Create an anchor in the target note using the same process as described above.</li><li>In another note, press <kbd>Ctrl</kbd>+<kbd>L</kbd> to insert an internal link. Select the target note containing Anchors.</li><li>If the target note contains Anchors, a section will appear underneath the note selector with the list of Anchors.</li><li>Add the link normally.</li></ol><p>Clicking on a reference link pointing to a anchor will automatically scroll to the desired section.</p><h3>Linking to anchors through the bookmark toolbar</h3><ol><li>Create an anchor in the target note using the same process as described above.</li><li>Click on the anchor to reveal the anchor's floating toolbar.</li><li>Click on the <span class=\"tn-icon cke cke-trilium-copy\"></span> <em>Copy anchor reference link</em> button.</li><li>Go to the note where to insert the link and press <kbd>Ctrl</kbd>+<kbd>V</kbd>.</li></ol><aside class=\"admonition note\"><p>Use this method only to insert&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;between two documents. To link to an anchor on the same note, use the <em>Insert link</em> dialog (<kbd>Ctrl</kbd>+<kbd>K</kbd>) and select the <em>Anchors</em> item instead.</p></aside>",
++ "_help_oI7GoyilXXAr": "<h2>Automatic replacements</h2><p>As you type in a text note, certain character sequences are replaced with the typographic symbol they represent. Typing <code>(c)</code> gives you <code>©</code>, <code>...</code> gives you <code>…</code>, and <code>\"quote\"</code> gives you <code>“quote”</code>.</p><p>These replacements are not applied inside code blocks or inline code, and pasted text is never affected, only text you type. If you have pasted a code snippet, or written one inside a code block, its characters are left exactly as they are.</p><h3>Undoing a replacement</h3><p>Once an automatic replacement takes place, it can be undone by:</p><ul><li>Pressing <kbd>Backspace</kbd> immediately after a replacement undoes it and restores what you typed.<ul><li>Note that this consumes the undo, so a further <kbd>Ctrl</kbd>+<kbd>Z</kbd> might delete your typed text.</li><li>Pressing <kbd>Space</kbd> or changing the cursor position disables this functionality.</li></ul></li><li>Pressing <kbd>Ctrl</kbd>+<kbd>Z</kbd>, which works even after pressing space.</li></ul><h3>Replacement groups &amp; configuration</h3><p>Each group can be turned off in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Text notes</em> → <em>Automatic replacements</em>.</p><figure class=\"table\"><table><thead><tr><th>Group</th><th>What it replaces</th></tr></thead><tbody><tr><td>Punctuation</td><td><code>...</code> with an ellipsis (<code>…</code>), and <code>--</code> and <code>---</code> <em>surrounded by spaces</em> with an en dash (<code>–</code>) and an em dash (<code>—</code>)</td></tr><tr><td>Mathematical symbols</td><td>fractions such as <code>1/2</code> with <code>½</code>, and the operators <code>&lt;=</code>, <code>&gt;=</code>, <code>!=</code>, <code>&lt;-</code> and <code>-&gt;</code> with <code>≤</code>, <code>≥</code>, <code>≠</code>, <code>←</code> and <code>→</code></td></tr><tr><td>Copyright and trademark</td><td><code>(c)</code>, <code>(r)</code> and <code>(tm)</code> with <code>©</code>, <code>®</code> and <code>™</code></td></tr><tr><td>Quotation marks</td><td>straight quotes with typographic ones — see below</td></tr></tbody></table></figure><h2>Quotation marks</h2><p>Quotation marks are configured separately from the rest, with one setting for the <strong>double</strong> quote key and one for the <strong>single</strong> quote key, because which pair belongs on which key differs between conventions: British typography traditionally sets a quotation in <code>‘…’</code> where American sets it in <code>“…”</code>.</p><p>Each offers:</p><ul><li><em>Based on the note's content language</em> (the default) — English gives <code>“quote”</code>, German <code>„quote“</code>, French <code>« quote »</code>, Japanese <code>「quote」</code>. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_veGu4faJErEM\">Content language &amp; Right-to-left support</a>&nbsp;for how a note's language is decided.</li><li><em>Disabled,</em> straight quotes stay straight.</li><li>A specific pair_:_ <code>“…”</code>, <code>‘…’</code>, <code>„…“</code>, <code>„…”</code>, <code>«…»</code>, <code>« … »</code>, <code>‹…›</code>, <code>「…」</code>, <code>『…』</code>. Choosing one applies it to every note, regardless of its content language.</li></ul><h2>Custom replacements</h2><p>You can add your own under&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Text notes</em> → <em>Automatic replacements</em> → <em>Custom replacements</em>. Type the text to replace and the replacement, then press Enter. Existing ones are shown as chips and removed with the × on each.</p><p>A custom replacement is applied when the text is typed as a whole word and followed by a space, so longer words that begin with it are left alone — a <code>TN</code> replacement does not rewrite the end of <code>BTN</code>, and <code>TNT</code> can still be typed.</p><p>Capitalization follows what you type, unless the replacement has capitals of its own:</p><figure class=\"table\"><table><thead><tr><th><strong>Replacement you defined</strong></th><th><strong>You type</strong></th><th><strong>You get</strong></th></tr></thead><tbody><tr><td><code>teh</code> → <code>the</code></td><td><code>teh</code> / <code>Teh</code> / <code>TEH</code></td><td><code>the</code> / <code>The</code> / <code>THE</code></td></tr><tr><td><code>TN</code> → <code>Trilium Notes</code></td><td><code>TN</code> or <code>tn</code></td><td><code>Trilium Notes</code> (unchanged, it has capitals)</td></tr></tbody></table></figure><p>Of note:</p><ul><li>The text to replace is matched literally; it is not a pattern.</li><li>Typing a \"text to replace\" that already exists in the list of replacements will update the existing one instead. It's not possible to have multiple replacements for the same text.</li><li>The same “text to replace” with different capitalization (e.g. <code>TN</code> and <code>tn</code> co-existing) doesn't work because it would interfere with the capitalization rules above.</li></ul><h2>Characters that only look replaced (ligatures)</h2><p>If you see <code>!=</code> displayed as <code>≠</code> or <code>-&gt;</code> as <code>→</code> inside a code block, that is not a replacement since replacements never run there (unless a code block is applied to an existing text). It is a <em>font ligature</em>: the default monospace font draws certain character pairs as a single symbol. The underlying text is unchanged, and copying it out gives you back <code>!=</code> and <code>-&gt;</code>.</p><p>This can be turned off with&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a><em>→ Appearance → Fonts → Programming ligatures.</em></p>",
++ "_help_NwBbFdNZ9h7O": "<h2>Block quotes</h2><p>As the name suggests, block quotes can be useful to cite one or more paragraphs.</p><p>To create a block quote, press&nbsp;<span class=\"tn-icon cke cke-quote\"></span> from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>. It's also possible to type <kbd>&gt;</kbd>, followed by a space to create one (but only if the cursor is at the beginning of a line).</p><p>Inside the quote block, other block items can be inserted such as tables, images, or even other block quotes or admonitions.</p><h2>Admonitions</h2><p>Admonitions are a way to highlight information to the reader. Other names for it include <em>call-outs</em> and <em>info/warning/alert boxes</em>.</p><figure class=\"image image-style-align-center\"><img style=\"aspect-ratio:959/547;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Block%20quotes%20%26%20admonitions_image.png\" width=\"959\" height=\"547\"></figure><p>From a functional point of view, admonitions act very similarly to a block quote, just with different styling. This includes the ability to insert other elements in it such as headings, tables, images, etc.</p><h3>Inserting a new admonition</h3><p>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>:</p><p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Block%20quotes%20%26%20admonitions_image.png\"></p><p>It's possible to insert an admonition simply by typing:</p><ul><li><code>!!! note</code></li><li><code>!!! tip</code></li><li><code>!!! important</code></li><li><code>!!! caution</code></li><li><code>!!! warning</code></li></ul><p>In addition to that, it's also possible to type <code>!!!</code>&nbsp; followed by any text, case in which a default admonition type will appear (note) with the entered text inside it.</p><h3>Interaction</h3><p>By design, admonitions act very similar to block quotes.</p><ul><li>Selecting a text and pressing the admonition button will turn that text into an admonition.</li><li>If selecting multiple admonitions, pressing the admonition button will automatically merge them into one.</li></ul><p>Inside an admonition:</p><ul><li>Pressing <kbd>Backspace</kbd> while the admonition is empty will remove it.</li><li>Pressing <kbd>Enter</kbd> will start a new paragraph. Pressing it twice will exit out of the admonition.</li><li>Headings and other block content including tables can be inserted inside the admonition.</li></ul><h3>Types of admonitions</h3><p>There are currently five types of admonitions: <em>Note</em>, <em>Tip</em>, <em>Important</em>, <em>Caution</em>, <em>Warning</em>.</p><p>These types were inspired by GitHub's support for this feature and there are currently no plans for adjusting it or allowing the user to customize them.</p><h3>Markdown support</h3><p>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_rJ9grSgoExl9\">Supported syntax</a>.</p>",
++ "_help_klC3ilXa9kUE": "<p>Block references are <a href=\"#root/_help_QEAPj01N5f7w\">links</a> to a block of a text note, such as a paragraph, a heading, a list item or a table, or to a range of consecutive blocks. A block reference can be pasted in another note as a link, or turned into an <a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a> that shows only the referenced blocks.</p><h2>Copying a reference</h2><ol><li>Place the cursor in the block to reference. To reference several consecutive blocks, select them.</li><li>Right-click the block handle, the sequence of dots to the left of the block (see <a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>). Alternatively, right-click the text and open the <em>Copy</em> submenu.</li><li>Select <em>Copy reference to this block</em>, or <em>Copy reference to these blocks</em> for a selection. The referenced blocks flash briefly.</li><li>Go to the note where to insert the link and press <kbd>Ctrl</kbd>+<kbd>V</kbd>.</li></ol><p>Inside a <a class=\"reference-link\" href=\"#root/_help_EK2ckIZ74tbT\">Content tabs</a> block, the reference points to the whole block. To link to a single tab, use <em>Copy link to tab</em> instead. Inside a <a class=\"reference-link\" href=\"#root/_help_wYDzQ1fBFgfT\">Multicolumn layout</a>, the reference points to the blocks in the column, and an include shows them without the layout around them.</p><p>The link shows the title of the note, followed by the beginning of the referenced text. A link to blocks of the same note shows only the beginning of the referenced text.</p><p>If the note is <a href=\"#root/_help_R9pX4DGra2Vt\">shared</a>, the menu of the block handle also offers <em>Copy public link to this block</em>. It copies the web address of the shared page with the reference added, to send to people who read the note outside Trilium. Opening the address scrolls the shared page to the referenced blocks and flashes them.</p><p>The <em>Paste</em> submenu of the context menu offers two more ways to insert a copied reference:</p><ul><li><em>Paste reference as a link</em> inserts only the link, even when the reference was copied as plain text or along with other content.</li><li><em>Paste reference as an excerpt</em> inserts an include of the referenced blocks, as described below.</li></ul><p>In a browser, the context menu of the text editor opens only when right-clicking selected text. Elsewhere the browser shows its own menu.</p><h2>Following a reference</h2><p>Clicking a block reference opens the note, scrolls to the referenced blocks and flashes them. If a referenced block was deleted, an error message is shown instead, along with the blocks of the range that still exist.</p><h2>Including the referenced blocks</h2><p>To show the referenced blocks inside another note, right-click the link in a note being edited and select <em>Convert link to note excerpt</em>, or paste the copied reference with <em>Paste</em> → <em>Paste reference as an excerpt</em>. The include shows only the referenced blocks, not the rest of the note, and marks them with an <em>Excerpt</em> badge in its title. It starts at the <em>Full</em> box size, so all the referenced blocks are visible. To see the whole note, press the <span class=\"tn-icon bx bx-link-external\"></span> button in the same title, which opens the note in a new tab. Converting the include back to a link keeps the reference.</p><p>To edit the referenced blocks without leaving the note, press the <span class=\"tn-icon bx bx-pencil\"></span> <em>Edit excerpt</em> button in the title of the include, or turn on <em>Editable</em> (<span class=\"tn-icon bx bx-edit-alt\"></span>) in its toolbar, as for any <a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>. Press the button again to stop editing. The changes are saved to the referenced blocks, and the rest of the note stays as it is. The button is grayed out where the blocks cannot be edited, such as in a read-only note. An excerpt has no <em>Fullscreen</em> button.</p><p>If a referenced block was deleted, the include shows <em>Broken reference</em>.</p><h2>Limitations</h2><ul><li>References can be copied only from a note being edited, and not in the mobile layout.</li><li>An include of a range that covers only part of a list or a quote, such as from its second item to a paragraph after it, cannot be edited in place.</li><li>Deleting a block breaks the references to it.</li><li>Block references are not kept when exporting to Markdown. On a <a href=\"#root/_help_R9pX4DGra2Vt\">shared page</a>, a block reference opens the whole note.</li></ul>",
++ "_help_4n4oQUVbnOxa": "<p>Collapsible blocks are sections of content that can be expanded and collapsed, letting you hide detail until it's needed.</p><p>A collapsible block consists of:</p><ul><li><strong>An always-visible header</strong>, containing:<ul><li><strong>An arrow</strong> that expands or collapses the block when clicked.</li><li><strong>A summary line</strong> that acts as the block's title. With the cursor in the summary line, press <kbd>Ctrl</kbd>+<kbd>Enter</kbd> to expand or collapse the block.</li><li><strong>A drag handle</strong> for repositioning the block within the note.</li></ul></li><li><strong>The body</strong>, which is hidden while the block is collapsed. It can hold any kind of content, including nested collapsible blocks. To break out of a collapsible block and continue typing outside it, press <kbd>Enter</kbd> twice at the end of the block.</li></ul><p>You can use the arrow keys to move freely with the cursor between the summary line, the block's body, and the text around the block.</p><h2>Inserting a collapsible block</h2><p>In the formatting bar, go to <em>Insert</em> → <em>Collapsible Block</em>.</p><aside class=\"admonition tip\"><p>Place multiple collapsible blocks one after another to create an accordion, where each block can be expanded or collapsed independently.</p></aside>",
++ "_help_veGu4faJErEM": "<p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Content%20language%20%26%20Right-to-left%20support_image.jpg\"></p><p>The content language determines:</p><ul><li>The spell-checking of the note, when in a browser. The desktop installation has a dedicated spellchecking section.</li><li>Whether the text is displayed from right-to-left, for languages such as Arabic, Hebrew, etc.</li><li>How typed quotes are <a href=\"#root/_help_oI7GoyilXXAr\">automatically replaced</a> (e.g. English uses <code>“text”</code>, whereas some languages use <code>«text»</code>). This applies only if&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Text</em> → <em>Single/Double quotation marks</em> is set to <em>Based on note's content language</em>.</li><li>Which languages are offered by the&nbsp;<a class=\"reference-link\" href=\"#root/_help_VRoP0g1uHHc2\">In-editor AI assistant</a>&nbsp;for translation.</li><li>The language and the text direction the content is marked with on a <a href=\"#root/_help_R9pX4DGra2Vt\">shared page</a>, which screen readers and browsers follow.</li></ul><h2>Setting the language of a single note</h2><p>To set the language of the content of a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;note, there is a language selector in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlJ73vBCjWDw\">Status bar</a>&nbsp;indicated by a&nbsp;<span class=\"tn-icon bx bx-globe\"></span> icon.</p><h2>Adjusting the list of languages</h2><p>By default there will be no language configured, they can be configured by going to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ Language &amp; Region or by selecting the <em>Configure languages</em> item when setting the language.</p><h2>Default content language</h2><p>Notes that do not have a language of their own follow&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Language &amp; Region</em> → <em>Default content language</em>. It is set to English initially, and can be set to any content language, or to <em>Based on the application's language</em>.</p><p>If a note has a language set, it always takes precedence over the default.</p>",
++ "_help_EK2ckIZ74tbT": "<p>Content tabs group several titled panels of content into one block that shows a single panel at a time. They suit content that comes in variants (such as installation steps for each operating system or the same snippet in several programming languages).</p><p>A tabs block consists of:</p><ul><li><strong>A row of tab titles</strong>, above the panel or, when the tabs are aligned at the bottom, below it. The title of the panel that is showing is highlighted.</li><li><strong>The panel of the active tab.</strong> A panel can hold any kind of content (including nested tabs blocks).</li></ul><h2>Inserting a tabs block</h2><ul><li>In the formatting bar, go to <em>Insert</em> → <em>Tabs</em>.</li><li>Alternatively, type <code>/tabs</code> and press <kbd>Enter</kbd>, as described in&nbsp;<a class=\"reference-link\" href=\"#root/_help_ZlN4nump6EbW\">Slash Commands</a>.</li></ul><p>A new block contains two tabs, named “Tab 1” and “Tab 2”. Any content that was selected prior to inserting the tabs will be moved into the first tab. The title of the first tab is selected, so typing replaces it.</p><h2>Editing tabs</h2><ul><li>To show a tab, click its title or move the cursor into it.</li><li>To move from a title into its panel, press <kbd>Enter</kbd>.</li><li>The label of a tab can be formatted just like normal text, including support for&nbsp;<a class=\"reference-link\" href=\"#root/_help_hD8GawVuazff\">Icons</a>.</li></ul><p>While the cursor is inside a tabs block, a toolbar appears above it with the following buttons:</p><ul><li><span class=\"tn-icon cke cke-plus\"></span>&nbsp;<em>(Add tab)</em> inserts a tab after the current one and selects its title.</li><li><span class=\"tn-icon cke cke-remove\"></span>&nbsp;<em>(Remove tab)</em> removes the current tab. Removing the last tab removes the whole block.</li><li><span class=\"tn-icon cke cke-chevron-right bx-flip-horizontal\"></span>&nbsp;<em>(Move tab left)</em> and&nbsp;<span class=\"tn-icon cke cke-chevron-right\"></span> (<em>Move tab right)</em> change the order of the tabs.</li><li><span class=\"tn-icon cke cke-link\"></span>&nbsp;<em>(Copy link to tab)</em> copies a link to the current tab, as described below.</li><li><span class=\"tn-icon cke cke-trilium-tabs\"></span>&nbsp;<em>(Tab alignment)</em> places the tab titles above the panel (<em>Align tabs at top</em>, the default) or below it (<em>Align tabs at bottom</em>).</li></ul><p>The tab that is showing is not saved with the note: every tabs block opens on its first tab.</p><h2>Reading tabs</h2><p>In&nbsp;<a class=\"reference-link\" href=\"#root/_help_CoFPLs3dRlXc\">Read-Only Notes</a>&nbsp;and on&nbsp;<a class=\"reference-link\" href=\"#root/_help_R9pX4DGra2Vt\">Sharing</a>, tabs blocks work as tabs as well:</p><ul><li>To show a tab, click its title, or focus it and press <kbd>Enter</kbd> or <kbd>Space</kbd>.</li><li>To move between the titles of a block, use the arrow keys, <kbd>Home</kbd> and <kbd>End</kbd>.</li></ul><p>A tab without a title shows “Tab title” in place of one.</p><p>In read-only notes, a title too long for its tab fades out where it is cut off. To read the rest of it, swipe it sideways or drag it with the mouse.</p><h2>Linking to a tab</h2><p>A link can point to a single tab, much like a link to a block (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_klC3ilXa9kUE\">Block references</a>):</p><ol><li>Place the cursor in the tab, either in its title or in its panel.</li><li>Press <em>Copy link to tab</em> (<span class=\"tn-icon cke cke-link\"></span>) in the toolbar of the tabs block. Alternatively, right-click the text and select <em>Copy</em> → <em>Copy link to this tab</em>. The tab flashes briefly.</li><li>Go to the note where to insert the link and press <kbd>Ctrl</kbd>+<kbd>V</kbd>.</li></ol><p>The link shows the title of the note, followed by the title of the tab. Clicking it opens the note, shows the tab and flashes it. As with any block reference, the link can be turned into an&nbsp;<a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>&nbsp;that shows only that tab.</p><p>Links to a tab can be copied only from a note being edited. On a <a href=\"#root/_help_R9pX4DGra2Vt\">shared page</a>, such a link opens the whole note.</p><h2>Content in hidden tabs</h2><p>Content inside a tab that is not showing is still reachable (both while editing and while reading). The tab that holds it is shown when:</p><ul><li>searching the note with <kbd>Ctrl</kbd>+<kbd>F</kbd> highlights a match inside it;</li><li>a link points to an anchor or a block inside it (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_oSuaNgyyKnhu\">Anchors</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_klC3ilXa9kUE\">Block references</a>);</li><li>an entry of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_BFvAtE74rbP6\">Table of contents</a>&nbsp;or the&nbsp;<a class=\"reference-link\" href=\"#root/_help_AxshuNRegLAv\">Highlights list</a>&nbsp;points inside it;</li><li>on a shared page, the address of the page points to a heading or an anchor inside it.</li></ul><p>Tab titles are not headings, so they do not appear in the table of contents; headings inside a panel do.</p><h2>Printing and exporting</h2><ul><li>When printing or <a href=\"#root/_help_NRnIZmSMc5sj\">exporting to PDF</a>, every tab is printed, one after another, each with its title above its panel, whatever the tab alignment.</li><li>Markdown export and import write tabs blocks in the content tabs syntax of Material for MkDocs, described in&nbsp;<a class=\"reference-link\" href=\"#root/_help_rJ9grSgoExl9\">Supported syntax</a>.&nbsp;<a class=\"reference-link\" href=\"#root/_help_6RM1Q7ppFVoj\">Markdown</a>&nbsp;notes use the same syntax, show the blocks as tabs in their preview and insert them with <code>/tabs</code>. That syntax has no tab alignment, so tabs aligned at the bottom are exported as regular tabs.</li><li>Anywhere the tabs cannot work as tabs (such as an HTML export opened elsewhere), a tabs block reads as a sequence of titled sections.</li></ul>",
+ "_help_2x0ZAX9ePtzV": "<figure class=\"image image_resized image-style-align-right\" style=\"width:64.63%;\"><img style=\"aspect-ratio:812/585;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Cut%20to%20subnote_cut-to-subnote.gif\" width=\"812\" height=\"585\"></figure><p>When editing a document that becomes too large, you can split it into sub-notes:</p><ol><li>Select the desired text and cut it to the clipboard.</li><li>Create a new sub-note and name it.</li><li>Paste the content from the clipboard into the sub-note.</li></ol><p>Trilium can automate this process. Select some text within the note, and in the selection toolbar, click the scissors icon for the \"cut &amp; pasted selection to sub-note\" action. The heading is automatically detected and the new sub-note is named accordingly. You can also assign a keyboard shortcut for this action. This functionality is available through the block toolbar icon.</p>",
- "_help_UYuUB1ZekNQU": "<h3>Inline code</h3><p>Inline code formats text using a monospace font to indicate technical content in a sentence such as code, paths, etc.</p><p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/3_Developer-specific%20formatting_image.png\"></p><p>Example of inline code being used to illustrate file system paths as well as shell commands (<code spellcheck=\"false\">git</code> in this case).</p><p>To insert an inline code:</p><ul><li>Via the&nbsp;<a href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>, look for the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/2_Developer-specific%20formatting_image.png\"> button.</li><li>Type `code` where <code spellcheck=\"false\">code</code> is the desired text to be automatically formatted as inline code.</li></ul><h3>Code blocks</h3><p>Code blocks display a snippet of code as a dedicated block:</p><p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Developer-specific%20formatting_image.jpg\"></p><p>A code block with JavaScript syntax highlight enabled.</p><p>Note that these are not meant for very large portions of code. Use the dedicated&nbsp;<a href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note type instead.</p><p>See the dedicated documentation for more information:&nbsp;<a href=\"#root/_help_QxEyIjRBizuC\">Code blocks</a></p><h3>Keyboard shortcuts</h3><p>This allows marking a portion of text as a shortcut key.</p><p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Developer-specific%20formatting_image.jpg\"></p><p>To apply this style, press the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/4_Developer-specific%20formatting_image.png\"> button in <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Developer-specific%20formatting_image.png\"> group from the&nbsp;<a href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>. On the floating toolbar, the buttons appear when selecting a text.</p><p>Alternatively, press the <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>K</kbd> combination to apply keyboard shortcut formatting to the current text selection.</p><p>The formatting can be removed by pressing again the button (from the UI or from the keyboard), or by using the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Developer-specific%20formatting_image.png\" width=\"17\" height=\"16\"> <em>Remove formatting</em> button.</p>",
- "_help_QxEyIjRBizuC": "<p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Developer-specific%20formatting/Code%20blocks_image.jpg\"></p><p>The code blocks feature allows entering pieces of code in text notes.</p><p>Note that this feature is meant for generally small snippets of code. For larger files such as an entire log, see the&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note type instead.</p><h2>Inserting a code block</h2><ul><li>Via the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>, look for the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Developer-specific%20formatting/Code%20blocks_image.png\"> button.<ul><li>Pressing directly on the icon will insert a code block with the language that was selected most recently. If this is the first time a code block is inserted, the language will be “Auto-detected” by default.</li><li>Pressing the arrow next to the icon, which will show a popup with the available languages.</li></ul></li><li>Type <code spellcheck=\"false\">```</code> (as in Markdown).<ul><li>Note that it's not possible to specify the language, as it will default to the last selected language.</li></ul></li></ul><h2>Exiting out of the code block</h2><ul><li>To exit out of a code block and enter a normal paragraph, move the cursor at the end of the code block and press <kbd>Enter</kbd> twice.</li><li>Similarly, to insert a paragraph above the note block, move the cursor at the beginning of the code block and press <kbd>Enter</kbd> twice.</li></ul><aside class=\"admonition note\"><p>If you've pasted a code block with a more complex HTML structure, exiting out of the code block by pressing <kbd>Enter</kbd> multiple times might not work. In that case the best approach is to delete the code block entirely and use <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>V</kbd> (paste as plain text).</p></aside><h2>Syntax highlighting &amp; color schemes</h2><p>Since TriliumNext v0.90.12, Trilium will try to offer syntax highlighting to the code block. Note that the syntax highlighting mechanism is slightly different than the one in&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;notes as different technologies are involved.</p><p>Interaction:</p><ul><li>When the language is set to <em>Auto-detected</em> (by default), Trilium will try to identify the programming language (or similar) that corresponds to the given snippet of text and highlight it. If this is problematic, consider changing the language of the code block manually.</li><li>When the language is set to <em>Plain text</em>, there will be no syntax highlighting.</li></ul><p>Note that when editing a text note, syntax highlighting is automatically disabled if the code block is too big (somewhere around 500 lines). This value is currently not configurable. For&nbsp;<a class=\"reference-link\" href=\"#root/_help_CoFPLs3dRlXc\">Read-Only Notes</a>, this limitation is not applied.</p><p>In order to configure this new feature, a section has been added in Options → Appearance to control the syntax highlighting. There the color scheme can be chosen, from a builtin selection of themes from Highlight.js.</p><ul><li>It is possible to disable the syntax highlighting for all the notes by selecting “No syntax highlighting” in the “Color scheme” option.</li><li>Word wrapping is disabled by default, but can be configured from the same section.</li><li>The tab width can also be adjusted from Options.</li></ul><aside class=\"admonition note\"><p><strong>Context regarding syntax highlighting</strong></p><p>In order to achieve the syntax highlight, the Highlight.js library is being used. Do note that support for syntax highlighting in code blocks is not a supported feature of the text editor we are using CKEditor), but rather a hack which makes use of the highlights API (used for highlighting search results for example). Nevertheless, we haven't noticed any major issues during the development of the feature, but feel free to report any issues you might have.</p><p>Most of the work to achieve the syntax highlight itself was already done by <a href=\"https://github.com/antoniotejada\">antoniotejada</a> in <a href=\"https://github.com/antoniotejada/Trilium-SyntaxHighlightWidget\">https://github.com/antoniotejada/Trilium-SyntaxHighlightWidget</a>. On our side we added customization but also additional functionality.</p></aside><h3>Migrating from existing syntax highlight plugins</h3><p>If you are already using a syntax highlighting plugin such as the <a href=\"https://github.com/antoniotejada/Trilium-SyntaxHighlightWidget\">Trilium-SyntaxHighlightWidget</a> we are basing off of, it is important to disable that plugin before upgrading in order for it not to conflict with our implementation.</p><p>Should you encounter any issues after the migration, try running Trilium in safe mode.</p><h2>Changing the language of a code block</h2><p>Simply click anywhere inside the code block and press again the code block button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>:<br><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Developer-specific%20formatting/1_Code%20blocks_image.png\"></p><h2>Adjusting the list of languages</h2><p>The code blocks feature shares the list of languages with the&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note type.</p><p>The supported languages can be adjusted by going to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>, then <em>Code Notes</em> and looking for the <em>Available MIME types in the dropdown</em> section. Simply check any of the items to add them to the list, or uncheck them to remove them from the list.</p><p>Note that the list of languages is not immediately refreshed, you'd have to manually <a href=\"#root/_help_s8alTXmpFR61\">refresh the application</a>.</p>",
- "_help_AgjCISero73a": "<figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:199/187;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Footnotes_image.png\" width=\"199\" height=\"187\"></figure><p>Footnotes are a good place to insert references to a paragraph or details that are displayed at the bottom of the note.</p><h2>Interaction</h2><ul><li>To insert a new footnote, press <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Footnotes_image.png\" width=\"17\" height=\"12\"> (or press the right arrow and select <em>New footnote</em>).</li><li>To insert a reference to an existing footnote, press the right arrow and select <em>Insert footnote</em>, followed by the number of the footnote to insert.</li><li>Hovering over a reference (e.g. <code spellcheck=\"false\">[1]</code>) will display the content of the footnote in a tooltip for easy reference.</li><li>Clicking on a reference in the text (e.g. <code spellcheck=\"false\">[1]</code>) will navigate to the corresponding footnote.</li><li>Similarly, clicking on the <code spellcheck=\"false\">^</code> button of a footnote will navigate to the corresponding reference in the text.</li></ul>",
- "_help_5wZallV2Qo1t": "<figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:220/76;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Format%20Painter_image.png\" width=\"220\" height=\"76\"></figure><p>The Format Painter is a feature in text notes that allows users to copy the formatting of text (such as <strong>bold</strong>, <em>italic</em>, <del>Strikethrough</del>, etc.) and apply it to other parts of the document. It helps maintain consistent formatting and accelerates the creation of rich content.</p><h2>Usage Instructions</h2><p>Click the text that you want to copy the formatting from and use the paint formatting toolbar button (<img class=\"image_resized\" style=\"aspect-ratio:150/150;width:2.7%;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Format%20Painter_746436a2e1.svg\" alt=\"Format painter\" width=\"150\" height=\"150\">) to copy the style. Then select the target text with your mouse to apply the formatting.</p><ul><li><strong>To copy the formatting</strong>: Place the cursor inside text with some formatting and click the paint formatting toolbar button. The mouse cursor changes to indicate the painter is armed.</li><li><strong>To paint with the copied formatting</strong>: Select the target text with your mouse. The formatting is applied when you release the button, and the painter disarms — the cursor returns to normal.</li><li><strong>To cancel without painting</strong>: Click the toolbar button again or press <kbd>Escape</kbd>.</li></ul><h2>Limitations</h2><ol><li>Painting with block-level formatting (like headings or image styles) is not supported yet. This is because, in&nbsp;<a class=\"reference-link\" href=\"#root/_help_MI26XDLSAlCD\">CKEditor</a>, they are considered a part of the content rather than text formatting.</li><li>The painter applies to a selection, not to a word: clicking a single word does not format it. A click only primes the caret, so text you type there takes the copied formatting.</li><li>The painter is one-shot; each paint requires copying the formatting again.</li></ol>",
- "_help_nRhnJkTT8cPs": "<p>Trilium allows two different editing experiences for text notes, based on your preference.</p><p>The type of formatting toolbar can be changed by going to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;and then looking for the&nbsp;<a class=\"reference-link\" href=\"#root/_options/_optionsTextNotes\">Text Notes</a>&nbsp;section. In it, look for the <em>Formatting toolbar</em> category.</p><h2>Floating</h2><p>The floating bar is a more minimalist option, in which the formatting is hidden behind two different popups.</p><h3>Block-level popup</h3><p>The first popup is the block-level popup. This will appear to the left of the current paragraph you are currently editing, as a sequence of dots:<br><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Formatting%20toolbar_image.jpg\"></p><p>Clicking this popup will reveal the formatting options that are specific to the entire paragraph, such as setting a heading, lists, tables, etc.</p><p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/3_Formatting%20toolbar_image.jpg\"></p><h3>Inline popup</h3><p>The inline popup appears automatically when selecting a text:</p><p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Formatting%20toolbar_image.jpg\"></p><p>All the options here apply only to the selected portion of text, such as changing the font size, or making the text bold.</p><h2>Fixed</h2><p>The fixed formatting offers a more traditional editing paradigm, usually useful if a lot of formatting is needed.</p><p>All the options are combined into a single toolbar that will appear as part of the&nbsp;<a href=\"#root/_help_BlN9DFI679QC\">Ribbon</a>.</p><p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/2_Formatting%20toolbar_image.jpg\"></p><p>By default, if the toolbar does not fit on the screen, the rest of the options will be grouped into a single option at the end. It is possible to display items on multiple lines by checking the corresponding option in the <em>Formatting toolbar</em> section.</p>",
- "_help_Gr6xFaF6ioJ5": "<h2>Headings</h2><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:255/284;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/3_General%20formatting_image.png\" width=\"255\" height=\"284\"></figure><p>Trilium provides headings to define sections within text. Headings are numbered from 2 to 6.</p><p>The reason why Heading 1 is missing from the list is that it is being reserved for the title of note.</p><p>To turn a heading back into a normal text, select <em>Paragraph</em> from the list.</p><p>Apart from using the UI, it is also possible to quickly insert headings using the Markdown-like shortcuts:</p><ul><li><code spellcheck=\"false\">##</code> for Heading 2</li><li><code spellcheck=\"false\">###</code> for Heading 3</li><li><code spellcheck=\"false\">####</code> for Heading 4</li><li><code spellcheck=\"false\">#####</code> for Heading 5</li><li><code spellcheck=\"false\">######</code> for Heading 6</li></ul><h2>Font size</h2><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:363/249;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/General%20formatting_image.png\" width=\"363\" height=\"249\"></figure><p>One way to highlight a portion of text is to increase the size of the font.</p><p>To do so, select some text and choose an option from the <em>Font size</em> selector (as pictured to the right).</p><p>Unlike other text editors such as Microsoft Word, the font size is relative (i.e. “Tiny”, “Small” instead of a number like 12).</p><p>Avoid using this feature just to simply make all text bigger. In that case it's generally better to adjust the font size for all notes in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;or by zooming.</p><h2>Bold, italic, underline, strike-through</h2><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:215/71;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/4_General%20formatting_image.png\" width=\"215\" height=\"71\"></figure><p>Text can be formatted as <strong>Bold,</strong> <em>Italic,</em> Underline or <del>Strike-through</del> via the dedicated buttons in the formatting toolbar.</p><p>This formatting can be easily removed using the <em>Remove formatting</em> item.</p><p>The following keyboard shortcuts can be used here:</p><ul><li><kbd>Ctrl</kbd>+<kbd>B</kbd> for bold</li><li><kbd>Ctrl</kbd>+<kbd>I</kbd> for italic</li><li><kbd>Ctrl</kbd>+<kbd>U</kbd> for underline</li></ul><p>Alternatively, Markdown-like formatting can be used:</p><ul><li><strong>Bold</strong>: Type <code spellcheck=\"false\">**text**</code> or <code spellcheck=\"false\">__text__</code></li><li><em>Italic</em>: Type <code spellcheck=\"false\">*text*</code> or <code spellcheck=\"false\">_text_</code></li><li><del>Strikethrough</del>: Type <code spellcheck=\"false\">~~text~~</code></li></ul><h2>Superscript, subscript</h2><p>This allows writing superscript or subscript text.</p><p>This is mostly useful for units of measure (e.g. cm3 for cubic centimeters) and chemical notations (e.g. NaHCO3)</p><p>For mathematical formulas, prefer the&nbsp;<a class=\"reference-link\" href=\"#root/_help_YfYAtQBcfo5V\">Math Equations</a>&nbsp;feature instead.</p><h2>Font color and background color</h2><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:167/204;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/2_General%20formatting_image.png\" width=\"167\" height=\"204\"></figure><p>Selected text can be colored with one of the predefined colors from a palette or any color can be selected using the color picker.</p><p>Once there is at least one color defined in the document, it will appear in the list for easy reuse.</p><p>When selecting a foreground or a background color, consider the contrast if switching between a dark theme or a light <a href=\"#root/_help_Wy267RK4M69c\">theme</a>.</p><p>To remove either the background or foreground color of a text, select the corresponding formatting button and press <em>Remove color</em> or use the <em>Remove formatting</em> toolbar item.</p><h2>Remove formatting</h2><p>The <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_General%20formatting_image.png\" width=\"17\" height=\"16\"> <em>Remove formatting</em> button is a quick way to eliminate the general formatting styling of a particular text.</p><p>Simply select the text and press the button to remove the formatting (bold, italic, colors, sizes, etc.). If the text does not have any removable formatting, the button will appear disabled.</p><p>Note that heading styles are not taken into consideration, these must be manually changed back to a paragraph according to the <em>Headings</em> section.</p><p>When pasting content that comes with undesired formatting, an alternative to pasting and then removing formatting is pasting as plain text via <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>V</kbd>.</p><h2>Format painter</h2><p>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_5wZallV2Qo1t\">Format Painter</a>&nbsp;allows users to copy the formatting of text (such as bold, italic, Strikethrough, etc.) and apply it to other parts of the document. It helps maintain consistent formatting and accelerates the creation of rich content.</p><h2>Support for Markdown</h2><p>When exported to&nbsp;<a class=\"reference-link\" href=\"#root/_help_Oau6X9rCuegd\">Markdown</a>, most of the general formatting is maintained such as headings, bold, italic, underline, etc.</p>",
++ "_help_UYuUB1ZekNQU": "<h3>Inline code</h3><p>Inline code formats text using a monospace font to indicate technical content in a sentence such as code, paths, etc.</p><p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Developer-specific%20formatting_image.png\"></p><p>Example of inline code being used to illustrate file system paths as well as shell commands (<code>git</code> in this case).</p><p>To insert an inline code:</p><ul><li>Via the&nbsp;<a href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>, look for the&nbsp;<span class=\"tn-icon cke cke-code\"></span> button.</li><li>Type `code` where <code>code</code> is the desired text to be automatically formatted as inline code.</li><li>Paste a single line copied from Visual Studio Code. See <a href=\"#root/_help_QxEyIjRBizuC\">Code blocks</a> for pasting several lines.</li></ul><h3>Code blocks</h3><p>Code blocks display a snippet of code as a dedicated block:</p><p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Developer-specific%20formatting_image.jpg\"></p><p>A code block with JavaScript syntax highlight enabled.</p><p>Note that these are not meant for very large portions of code. Use the dedicated&nbsp;<a href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note type instead.</p><p>See the dedicated documentation for more information:&nbsp;<a href=\"#root/_help_QxEyIjRBizuC\">Code blocks</a></p><h3>Keyboard shortcuts</h3><p>This allows marking a portion of text as a shortcut key.</p><p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Developer-specific%20formatting_image.jpg\"></p><p>To apply this style, press the&nbsp;<span class=\"tn-icon cke cke-trilium-kbd\"></span> button in&nbsp;<span class=\"tn-icon bx bx-text\"></span> group from the&nbsp;<a href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>. On the floating toolbar, the buttons appear when selecting a text.</p><p>Alternatively, press the <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>K</kbd> combination to apply keyboard shortcut formatting to the current text selection.</p><p>The formatting can be removed by pressing again the button (from the UI or from the keyboard), or by using the&nbsp;<span class=\"tn-icon cke cke-remove-format\"></span> <em>Remove formatting</em> button.</p>",
++ "_help_QxEyIjRBizuC": "<p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Developer-specific%20formatting/Code%20blocks_image.jpg\"></p><p>The code blocks feature allows entering pieces of code in text notes.</p><p>Note that this feature is meant for generally small snippets of code. For larger files such as an entire log, see the&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note type instead.</p><h2>Inserting a code block</h2><ul><li>Via the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>, look for the&nbsp;<span class=\"tn-icon cke cke-code-block\"></span> button.<ul><li>Pressing directly on the icon will insert a code block with the language that was selected most recently. If this is the first time a code block is inserted, the language will be “Auto-detected” by default.</li><li>Pressing the arrow next to the icon, which will show a popup with the available languages.</li></ul></li><li>Type <code>```</code> (as in Markdown).<ul><li>Note that it's not possible to specify the language, as it will default to the last selected language.</li></ul></li><li>Paste several lines of code copied from Visual Studio Code.<ul><li>The code block uses the language of the file in Visual Studio Code.</li><li>If that language is not in the list of languages, the code block uses <em>Auto-detected</em>.</li><li>The colors of the Visual Studio Code theme are removed.</li><li>A single line becomes inline code instead of a code block.</li><li>In Firefox, the code block always uses <em>Auto-detected</em>. Firefox can't read the language from Visual Studio Code.</li></ul></li></ul><h2>Exiting out of the code block</h2><ul><li>To exit out of a code block and enter a normal paragraph, move the cursor at the end of the code block and press Enter twice.</li><li>Similarly, to insert a paragraph above the note block, move the cursor at the beginning of the code block and press Enter twice.</li></ul><aside class=\"admonition note\"><p>If you've pasted a code block with a more complex HTML structure, exiting out of the code block by pressing Enter multiple times might not work. In that case the best approach is to delete the code block entirely and use Ctrl+Shift+V (paste as plain text).</p></aside><h2>Syntax highlighting &amp; color schemes</h2><p>Since TriliumNext v0.90.12, Trilium will try to offer syntax highlighting to the code block. Note that the syntax highlighting mechanism is slightly different than the one in&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;notes as different technologies are involved.</p><p>Interaction:</p><ul><li>When the language is set to <em>Auto-detected</em> (by default), Trilium will try to identify the programming language (or similar) that corresponds to the given snippet of text and highlight it. Only the languages enabled in <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Code Notes</em> → <em>Available MIME types in the dropdown</em> are considered. If this is problematic, consider changing the language of the code block manually.</li><li>When the language is set to <em>Plain text</em>, there will be no syntax highlighting.</li></ul><p>Note that when editing a text note, syntax highlighting is automatically disabled if the code block is too big (somewhere around 500 lines). In&nbsp;<a class=\"reference-link\" href=\"#root/_help_CoFPLs3dRlXc\">Read-Only Notes</a>, in print and on a <a href=\"#root/_help_R9pX4DGra2Vt\">shared page</a>, a code block of more than 500 lines or 50,000 characters is shown without syntax highlighting. These limits are not configurable.</p><p>In order to configure this new feature, a section has been added in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Appearance</em> to control the syntax highlighting. There the color scheme can be chosen, from a builtin selection of themes from Highlight.js. <em>VS Code (Light)</em> and <em>VS Code (Dark)</em> use the same colors as the default themes of <a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a> notes, so a code block and a code note color the same code alike.</p><ul><li>It is possible to disable the syntax highlighting for all the notes by selecting “No syntax highlighting” in the “Color scheme” option.</li><li>Word wrapping is disabled by default, but can be configured from the same section.</li><li>The tab width can also be adjusted from Options.</li></ul><aside class=\"admonition note\"><p><strong>Context regarding syntax highlighting</strong></p><p>In order to achieve the syntax highlight, the Highlight.js library is being used. Do note that support for syntax highlighting in code blocks is not a supported feature of the text editor we are using CKEditor), but rather a hack which makes use of the highlights API (used for highlighting search results for example). Nevertheless, we haven't noticed any major issues during the development of the feature, but feel free to report any issues you might have.</p><p>Most of the work to achieve the syntax highlight itself was already done by <a href=\"https://github.com/antoniotejada\">antoniotejada</a> in <a href=\"https://github.com/antoniotejada/Trilium-SyntaxHighlightWidget\">https://github.com/antoniotejada/Trilium-SyntaxHighlightWidget</a>. On our side we added customization but also additional functionality.</p></aside><h3>Migrating from existing syntax highlight plugins</h3><p>If you are already using a syntax highlighting plugin such as the <a href=\"https://github.com/antoniotejada/Trilium-SyntaxHighlightWidget\">Trilium-SyntaxHighlightWidget</a> we are basing off of, it is important to disable that plugin before upgrading in order for it not to conflict with our implementation.</p><p>Should you encounter any issues after the migration, try running Trilium in safe mode.</p><h2>Changing the language of a code block</h2><p>Simply click anywhere inside the code block and press again the code block button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>:<br><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Developer-specific%20formatting/Code%20blocks_image.png\"></p><h2>Adjusting the list of languages</h2><p>The code blocks feature shares the list of languages with the&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note type.</p><p>The supported languages can be adjusted by going to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>, then <em>Code Notes</em> and looking for the <em>Available MIME types in the dropdown</em> section. Simply check any of the items to add them to the list, or uncheck them to remove them from the list.</p><p>Note that the list of languages is not immediately refreshed, you'd have to manually <a href=\"#root/_help_s8alTXmpFR61\">refresh the application</a>.</p><h2>Text replacements and ligatures</h2><p><a class=\"reference-link\" href=\"#root/_help_oI7GoyilXXAr\">Automatic replacements</a>&nbsp;are a feature of text notes which converts some character sequences into another and some of them interfere with programming text, such as the conversion of quotes. While in a code block, the automatic replacements <strong>are not effect</strong>. The only way the automatic replacements can interfere is if the text is typed/pasted before being put in a code block.</p><p>A different feature is <em>programming ligatures</em>, which is simply a display affordance which turns <code>!=</code> into <code>≠</code> or <code>-&gt;</code> as <code>→</code> . These come from the <a href=\"#root/_help_w4rMEhJsALlA\">font</a>. The underlying text is not actually changed, and copying it out gives you back <code>!=</code> and <code>-&gt;</code>.</p><p>Ligatures can be disabled in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a><em>→ Appearance → Fonts → Programming ligatures.</em></p>",
++ "_help_AgjCISero73a": "<figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:199/187;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Footnotes_image.png\" width=\"199\" height=\"187\"></figure><p>Footnotes are a good place to insert references to a paragraph or details that are displayed at the bottom of the note.</p><h2>Interaction</h2><ul><li>To insert a new footnote, press&nbsp;<span class=\"tn-icon cke cke-trilium-insert-footnote\"></span> (or press the right arrow and select <em>New footnote</em>).</li><li>To insert a reference to an existing footnote, press the right arrow and select <em>Insert footnote</em>, followed by the number of the footnote to insert.</li><li>Hovering over a reference (e.g. <code>[1]</code>) will display the content of the footnote in a tooltip for easy reference.</li><li>Clicking on a reference in the text (e.g. <code>[1]</code>) will navigate to the corresponding footnote.</li><li>Similarly, clicking on the <code>^</code> button of a footnote will navigate to the corresponding reference in the text.</li></ul>",
++ "_help_5wZallV2Qo1t": "<figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:220/76;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Format%20Painter_image.png\" width=\"220\" height=\"76\"></figure><p>The Format Painter is a feature in text notes that allows users to copy the formatting of text (such as <strong>bold</strong>, <em>italic</em>, <del>Strikethrough</del>, etc.) and apply it to other parts of the document. It helps maintain consistent formatting and accelerates the creation of rich content.</p><h2>Usage Instructions</h2><p>Click the text that you want to copy the formatting from and use the <em>Copy formatting</em> toolbar button (<span class=\"tn-icon cke cke-paint-roller\"></span>) to copy the style. Then select the target text with your mouse to apply the formatting.</p><ul><li><strong>To copy the formatting</strong>: Place the cursor inside text with some formatting and click the <em>Copy formatting</em> toolbar button. The mouse cursor changes to indicate the painter is armed.</li><li><strong>To paint with the copied formatting</strong>: Select the target text with your mouse. The formatting is applied when you release the button, and the painter disarms — the cursor returns to normal.</li><li><strong>To cancel without painting</strong>: Click the toolbar button again or press <kbd>Escape</kbd>.</li></ul><h2>Limitations</h2><ol><li>Painting with block-level formatting (like headings or image styles) is not supported yet. This is because, in&nbsp;<a class=\"reference-link\" href=\"#root/_help_MI26XDLSAlCD\">CKEditor</a>, they are considered a part of the content rather than text formatting.</li><li>The painter applies to a selection, not to a word: clicking a single word does not format it. A click only primes the caret, so text you type there takes the copied formatting.</li><li>The painter is one-shot; each paint requires copying the formatting again.</li></ol>",
++ "_help_nRhnJkTT8cPs": "<p>Trilium allows two different editing experiences for text notes, based on your preference.</p><p>The type of formatting toolbar can be changed by going to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;and then looking for the&nbsp;<a class=\"reference-link\" href=\"#root/_hidden/_options/_optionsTextNotes\">Text Notes</a>&nbsp;section. In it, look for the <em>Formatting toolbar</em> category.</p><h2>Floating</h2><p>The floating bar is a more minimalist option, in which the formatting is hidden behind two different popups.</p><h3>Block-level popup</h3><p>The first popup is the block-level popup. This will appear to the left of the current paragraph you are currently editing, as a sequence of dots:<br><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Formatting%20toolbar_image.jpg\"></p><p>Clicking this popup will reveal the formatting options that are specific to the entire paragraph, such as setting a heading, lists, tables, etc.</p><p>The dots are also a drag handle: drag them to move the paragraph, all the selected paragraphs, or a selected element such as an image, a table or an included note to another place in the note. Right-clicking them copies a reference to the paragraph or to the selected paragraphs, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_klC3ilXa9kUE\">Block references</a>.</p><figure class=\"image\"><img style=\"aspect-ratio:1404/156;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/2_Formatting%20toolbar_image.png\" width=\"1404\" height=\"156\"></figure><h3>Inline popup</h3><p>The inline popup appears automatically when selecting a text:</p><figure class=\"image\"><img style=\"aspect-ratio:1008/154;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Formatting%20toolbar_image.png\" width=\"1008\" height=\"154\"></figure><p>All the options here apply only to the selected portion of text, such as changing the font size, or making the text bold.</p><h2>Fixed</h2><p>The fixed formatting offers a more traditional editing paradigm, usually useful if a lot of formatting is needed.</p><p>All the options are combined into a single toolbar that will appear at the above the note. When using&nbsp;<a class=\"reference-link\" href=\"#root/_help_luNhaphA37EO\">Split View</a>, a single toolbar will be available to save space and it acts on the active note.</p><p>The sequence of dots to the left of the current paragraph is still shown, but only as a drag handle: drag it to move the paragraph, all the selected paragraphs, or a selected element such as an image, a table or an included note to another place in the note. Clicking it does not open a popup, and right-clicking it copies a reference to the block, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_klC3ilXa9kUE\">Block references</a>. The drag handle is not shown in the mobile layout.</p><figure class=\"image\"><img style=\"aspect-ratio:1440/60;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Formatting%20toolbar_image.png\" width=\"1440\" height=\"60\"></figure><p>By default, if the toolbar does not fit on the screen, the rest of the options will be grouped into a single option at the end. It is possible to display items on multiple lines by checking the corresponding option in the <em>Formatting toolbar</em> section.</p>",
++ "_help_Gr6xFaF6ioJ5": "<h2>Headings</h2><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:255/284;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/2_General%20formatting_image.png\" width=\"255\" height=\"284\"></figure><p>Trilium provides headings to define sections within text. Headings are numbered from 2 to 6.</p><p>The reason why Heading 1 is missing from the list is that it is being reserved for the title of note.</p><p>To turn a heading back into a normal text, select <em>Paragraph</em> from the list.</p><p>Apart from using the UI, it is also possible to quickly insert headings using the Markdown-like shortcuts:</p><ul><li><code>##</code> for Heading 2</li><li><code>###</code> for Heading 3</li><li><code>####</code> for Heading 4</li><li><code>#####</code> for Heading 5</li><li><code>######</code> for Heading 6</li></ul><h2>Font size</h2><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:363/249;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/General%20formatting_image.png\" width=\"363\" height=\"249\"></figure><p>One way to highlight a portion of text is to increase the size of the font.</p><p>To do so, select some text and choose an option from the <em>Font size</em> (<span class=\"tn-icon cke cke-font-size\"></span>) selector (as pictured to the right).</p><p>Unlike other text editors such as Microsoft Word, the font size is relative (i.e. “Tiny”, “Small” instead of a number like 12).</p><p>Avoid using this feature just to simply make all text bigger. In that case it's generally better to adjust the font size for all notes in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;or by zooming.</p><h2>Bold, italic, underline, strike-through</h2><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:215/71;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/3_General%20formatting_image.png\" width=\"215\" height=\"71\"></figure><p>Text can be formatted as <strong>Bold,</strong> <em>Italic,</em> Underline or <del>Strike-through</del> via the dedicated buttons (<span class=\"tn-icon cke cke-bold\"></span>, <span class=\"tn-icon cke cke-italic\"></span>, <span class=\"tn-icon cke cke-underline\"></span>, <span class=\"tn-icon cke cke-strikethrough\"></span>) in the formatting toolbar.</p><p>This formatting can be easily removed using the <em>Remove formatting</em> (<span class=\"tn-icon cke cke-remove-format\"></span>) item.</p><p>The following keyboard shortcuts can be used here:</p><ul><li><kbd>Ctrl</kbd>+<kbd>B</kbd> for bold</li><li><kbd>Ctrl</kbd>+<kbd>I</kbd> for italic</li><li><kbd>Ctrl</kbd>+<kbd>U</kbd> for underline</li></ul><p>Alternatively, Markdown-like formatting can be used:</p><ul><li><strong>Bold</strong>: Type <code>**text**</code> or <code>__text__</code></li><li><em>Italic</em>: Type <code>*text*</code> or <code>_text_</code></li><li><del>Strikethrough</del>: Type <code>~~text~~</code></li></ul><h2>Superscript, subscript</h2><p>This allows writing superscript or subscript text.</p><p>This is mostly useful for units of measure (e.g. cm3 for cubic centimeters) and chemical notations (e.g. NaHCO3)</p><p>For mathematical formulas, prefer the&nbsp;<a class=\"reference-link\" href=\"#root/_help_YfYAtQBcfo5V\">Math Equations</a>&nbsp;feature instead.</p><h2>Font color and background color</h2><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:167/204;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_General%20formatting_image.png\" width=\"167\" height=\"204\"></figure><p>Selected text can be colored with one of the predefined colors from a palette or any color can be selected using the color picker (<span class=\"tn-icon cke cke-color-palette\"></span>).</p><p>Once there is at least one color defined in the document, it will appear in the list for easy reuse.</p><p>Colors adapt to the <a href=\"#root/_help_Wy267RK4M69c\">theme</a>. Trilium shows each color in a lighter or darker shade that suits the current theme, so the text stays readable after switching between light and dark themes. The hue stays the same: red text is red in both themes, only lighter or darker. This applies to the palette, the color picker and the document colors alike, and to shared notes too. Printed notes and PDF exports always use the shades of light themes, which suit white paper. The note itself keeps the color as it was picked, so an exported note shows it unchanged.</p><p>Colors applied with older versions of Trilium are shown exactly as they were picked, until the note is next edited.</p><p>Older browsers that can't adapt colors show them exactly as they were picked.</p><p>When you paste text copied from a web page in Chrome, Edge or a Chromium-based app (such as Visual Studio Code), Trilium removes the page's styling:</p><ul><li>Text and background colors.</li><li>Fonts and font sizes.</li><li>Table borders, backgrounds and spacing.</li></ul><p>The following formatting is preserved:</p><ul><li>Bold, italic, underline and strikethrough.</li><li>Subscript and superscript.</li><li>Links, code and tables.</li></ul><p>Colors are preserved when pasting from Word, Google Docs or another note.</p><p>To remove either the background or foreground color of a text, select the corresponding formatting button (<span class=\"tn-icon cke cke-font-color\"></span> or <span class=\"tn-icon cke cke-font-background\"></span>) and press <em>Remove color</em> (<span class=\"tn-icon cke cke-eraser\"></span>) or use the <em>Remove formatting</em> (<span class=\"tn-icon cke cke-remove-format\"></span>) toolbar item.</p><h2>Remove formatting</h2><p>The&nbsp;<span class=\"tn-icon cke cke-remove-format\"></span> <em>Remove formatting</em> button is a quick way to eliminate the general formatting styling of a particular text.</p><p>Simply select the text and press the button to remove the formatting (bold, italic, colors, sizes, etc.). If the text does not have any removable formatting, the button will appear disabled.</p><p>Note that heading styles are not taken into consideration, these must be manually changed back to a paragraph according to the <em>Headings</em> section.</p><p>When pasting content that comes with undesired formatting, an alternative to pasting and then removing formatting is pasting as plain text via <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>V</kbd>.</p><h2>Format painter</h2><p>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_5wZallV2Qo1t\">Format Painter</a>&nbsp;allows users to copy the formatting of text (such as bold, italic, Strikethrough, etc.) and apply it to other parts of the document. It helps maintain consistent formatting and accelerates the creation of rich content.</p><h2>Support for Markdown</h2><p>When exported to&nbsp;<a class=\"reference-link\" href=\"#root/_help_Oau6X9rCuegd\">Markdown</a>, most of the general formatting is maintained such as headings, bold, italic, underline, etc.</p>",
+ "_help_AxshuNRegLAv": "<aside class=\"admonition note\"><p>This page has been relocated to&nbsp;<a class=\"reference-link\" href=\"#root/_help_2dcGDhp9WFKb\">Outline tab</a>.</p></aside>",
- "_help_mT0HEkOsz6i1": "<p>Trilium supports storing and displaying images. Supported formats are PNG, JPEG, GIF, BMP, WebP, AVIF and SVG.</p><p>An image can be uploaded in the form of note's <a href=\"#root/_help_0vhv7lsOLy82\">attachment</a> or as a standalone <a href=\"#root/_help_kBrnXNG3Hplm\">note</a> placed into the <a href=\"#root/_help_kBrnXNG3Hplm\">note tree</a>. Its reference can be copied into a text note, in order to display it in the text itself.</p><h2>Uploading images</h2><p>To add an image to the note:</p><ul><li>Simply drag it from file explorer onto the note editor inside Trilium and the image will be uploaded.</li><li>Alternatively, from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>&nbsp;look for the <em>Insert image</em> icon.</li><li>You can also copy and paste an image from web (see section below).</li></ul><h2>Clipboard &amp; automatic download of images</h2><p>Trilium has a special handling for images copied to and pasted from the clipboard.</p><ul><li><p>For a mix of text and images, the images are downloaded automatically by the server (or desktop app, depending on what is being used).</p><ul><li>This means that the image must be publicly accessible and reachable from wherever Trilium is running. Inaccessible images will end up as broken images.</li></ul></li><li><p>If a single image is pasted into Trilium, it will prefer the image that comes in the clipboard. This makes it possible to copy images that Trilium would not otherwise be able to reach, such as Google Chat, Slack, etc.</p></li><li><p>When a text with images is copied from Trilium and pasted in another app (such as Microsoft Word or LibreOffice Writer), the images will be preserved.</p></li></ul><p>The automatic download of images is enabled by default and can be toggled from&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Media</em> → <em>Download images automatically.</em></p><h2>Configuring the images</h2><p>Clicking on an image will reveal a popup with multiple options:<br><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/3_Images_image.png\"></p><h3>Alignment</h3><p>The first set of options configure the alignment are, in order:</p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Icon</th>\n<th>Option</th>\n<th>Preview</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/2_Images_image.png\"></td>\n<td>Inline</td>\n<td><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Images_image.jpg\"></td>\n<td>As the name suggests, the name can be put inside a paragraph and moved around similarly as if it was a block of text. Use drag &amp; drop or cut-paste to move it around.</td>\n</tr>\n<tr>\n<td><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/4_Images_image.png\"></td>\n<td>Centered image</td>\n<td><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Images_image.jpg\"></td>\n<td>The image will be displayed as a block and centered, not allowing text in either the left or right of it.</td>\n</tr>\n<tr>\n<td><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Images_image.png\"></td>\n<td>Wrap text</td>\n<td><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/3_Images_image.jpg\"></td>\n<td>The image will be displayed to the left or the right of the text.</td>\n</tr>\n<tr>\n<td><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Images_image.png\"></td>\n<td>Block align</td>\n<td><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/2_Images_image.jpg\"></td>\n<td>Similarly to <em>Centered image</em>, the image will be displayed as a block and aligned either to the left or to the right, but not allowing text to flow on either of its sides.</td>\n</tr>\n</tbody></table></figure><h2>Compression</h2><p>Since Trilium isn't really meant to be primary storage for image data, it attempts to compress and resize (with pretty aggressive settings) uploaded images before storing them to the database. You may then notice some quality degradation. Basic quality settings is available in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Media</em>.</p><p>If you want to save images in their original resolution, it is recommended to save them as attachment to note (look for the contextual menu in&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note buttons</a>&nbsp;→ <em>Import files</em>).</p><h2>Aligning images side-by-side</h2><p>There are generally two ways to display images side by side:</p><ul><li>If they are roughly the same size, simply make the two images in-line, according to the alignment section above. The images can be dragged &amp; dropped onto the same line.</li><li>If they are on different size, create a <a href=\"#root/_help_NdowYOC1GFKS\">table</a> with invisible borders.</li></ul>",
- "_help_0Ofbk1aSuVRu": "<figure class=\"image image-style-align-right image_resized\" style=\"width:50.47%;\"><img style=\"aspect-ratio:880/553;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Images/Image%20references_image.png\" width=\"880\" height=\"553\"></figure><p>Image references are an easy way to embed the preview of another note type into a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;note.</p><h2>Supported note types</h2><ul><li><a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a></li><li><a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a></li><li><a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a></li></ul><h2>Steps</h2><ol><li>Go to one of the supported notes (listed above) and look for the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Images/1_Image%20references_image.png\"> button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_XpOYSgsLkTJy\">Floating buttons</a>&nbsp;area.</li><li>Go to a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;note and use the Paste function to insert the reference to that note.</li></ol><h2>Interaction</h2><ul><li>Double-clicking an image reference from a text note will automatically open the target note.</li><li>Clicking an image reference while <kbd>Ctrl</kbd> is pressed will open the target note in a new tab.</li><li>Modifying the target note should also update the image reference. If that doesn't happen, consider&nbsp;<a class=\"reference-link\" href=\"#root/_help_s8alTXmpFR61\">Refreshing the application</a>.</li></ul>",
- "_help_nBAXQFj20hS1": "<p>Text notes can \"include\" another note as a read-only widget or an interactive widget, depending on the type of note.</p><p>This can be useful for e.g. including a dynamically generated chart (from scripts &amp; \"render HTML\" note) or other more advanced use cases.</p><h2>Including a note</h2><p>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>, look for the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Include%20Note_image.png\"> button. There is also a keyboard shortcut defined for it but it is not allocated by default.</p><h2>Included notes in the share functionality</h2><p>If a <a href=\"#root/_help_R9pX4DGra2Vt\">shared note</a> contains one or more included notes, they will be displayed in the content of the note as if they were part of the note itself.</p><p>For this to work, the included notes must also be shared, otherwise they will not be shown. However, the included notes can still be hidden from the note tree via <code spellcheck=\"false\">#shareHiddenFromTree</code>.</p><h2>Interactive notes</h2><p>Since v0.104.0, included notes might become interactive depending on their note type:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>&nbsp;(e.g.&nbsp;<a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map</a>) will render fully interactive, including creating new notes.</li><li><a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a>&nbsp;will also display the results.</li><li><a class=\"reference-link\" href=\"#root/_help_1vHRoWCEjj0L\">Web View</a>&nbsp;provides an interactive preview of the website.</li></ul>",
- "_help_CohkqWQC1iBv": "<p>Press the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/4_Insert%20buttons_image.png\" width=\"34\" height=\"16\"> button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>&nbsp;to reveal special inserable items and blocks such as symbols, Math expressions and separators.</p><h2>Bookmarks</h2><p>See the dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_oSuaNgyyKnhu\">Anchors</a>&nbsp;section.</p><h2>Emoji</h2><figure class=\"image image-style-align-right image_resized\" style=\"width:42.4%;\"><img style=\"aspect-ratio:366/410;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Insert%20buttons_plus.png\" width=\"366\" height=\"410\"></figure><p>This feature allows inserting Unicode emoji characters. Simply select a category and a desired emoji to insert it.</p><p>Emojis can also be searched by their English name and the skin tone can be selected via a combo box to the right.</p><p>There is also the possibility of inserting emojis directly by typing <code spellcheck=\"false\">:</code> followed by a name of an emoji, triggering the display of a list of emojis. Simply use the arrow keys to select one and press <kbd>Enter</kbd> to insert it.</p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Insert%20buttons_plus.png\" width=\"272\" height=\"187\"><h2>Symbols</h2><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:346/322;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Insert%20buttons_image.png\" width=\"346\" height=\"322\"></figure><p>Pressing the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/7_Insert%20buttons_image.png\" width=\"18\" height=\"15\"> button will reveal a popup window displaying a list of characters that are generally more difficult to insert directly from the keyboard, such as a subset of emojis, quotation characters, etc.</p><p>Interaction:</p><ul><li>Click on a character to insert it at the current cursor position.</li><li>The window can be dragged around by the top bar where the title is, to avoid it getting in the way of the text.</li><li>Click on the <em>Category</em> selector to filter the characters.</li></ul><h2>Math equations</h2><p>See the dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_YfYAtQBcfo5V\">Math Equations</a>&nbsp;page.</p><h2>Mermaid diagram</h2><p>Press the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/2_Insert%20buttons_image.png\" width=\"16\" height=\"17\"> button to create an inline Mermaid diagram.</p><p>This feature is quite similar to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a>&nbsp;note types and is meant as an alternative to it for simple diagrams. For more complex diagrams, use the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>&nbsp;feature for a dedicated Mermaid note.</p><figure class=\"image\"><img style=\"aspect-ratio:1174/358;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/6_Insert%20buttons_image.png\" width=\"1174\" height=\"358\"></figure><h2>Horizontal ruler</h2><p>This feature will display a horizontal line, generally useful to separate different sections of the text. To do so, press the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/5_Insert%20buttons_image.png\" width=\"18\" height=\"16\"> button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>.</p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/3_Insert%20buttons_image.png\" width=\"502\" height=\"95\"><p>Alternatively, it's possible to insert a horizontal ruler by typing <code spellcheck=\"false\">---</code>.</p><h2>Page break</h2><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:371/79;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/8_Insert%20buttons_image.png\" width=\"371\" height=\"79\"></figure><p>Page breaks provide a way to force the next paragraph or block (table, image, etc.) to be displayed onto the next page when printing (either to a real printer to <a href=\"#root/_help_NRnIZmSMc5sj\">when exporting to PDF</a>).</p><p>Page breaks are marked in the editor with the words <em>Page break</em>, but they will not actually be shown when printed.</p><ul><li>To insert a page break, press the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Insert%20buttons_image.png\" width=\"20\" height=\"19\"> in the formatting toolbar.</li><li>To insert many page breaks at once, insert a page break first, click on it and press <kbd>Ctrl</kbd>+<kbd>C</kbd>. Then use <kbd>Ctrl</kbd>+<kbd>V</kbd>, to paste as many times as needed.</li></ul>",
- "_help_oiVPnW8QfnvS": "<h2>Trilium-specific shortcuts</h2><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Action</th>\n<th>PC</th>\n<th>Mac</th>\n</tr>\n</thead>\n<tbody><tr>\n<td>Bring up inline formatting toolbar (arrow keys <kbd><span>←</span></kbd>,<kbd><span>→</span></kbd> to navigate, <kbd>Enter</kbd> to apply)</td>\n<td><kbd>Alt</kbd>+<kbd>F10</kbd></td>\n<td><kbd>⌥</kbd>+<kbd>F10</kbd></td>\n</tr>\n<tr>\n<td>Bring up block formatting toolbar</td>\n<td><kbd>Alt</kbd>+<kbd>F10</kbd></td>\n<td><kbd>⌥</kbd>+<kbd>F10</kbd></td>\n</tr>\n<tr>\n<td>Create <a href=\"#root/_help_QEAPj01N5f7w\">external link</a></td>\n<td><kbd>Ctrl</kbd>+<kbd>K</kbd></td>\n<td><kbd>⌘</kbd>+<kbd>K</kbd></td>\n</tr>\n<tr>\n<td>Create <a href=\"#root/_help_QEAPj01N5f7w\">internal (note) link</a></td>\n<td><kbd>Ctrl</kbd>+<kbd>L</kbd></td>\n<td><kbd>⌘</kbd>+<kbd>L</kbd></td>\n</tr>\n<tr>\n<td>Inserts current date and time at caret position</td>\n<td><kbd>Alt</kbd>+<kbd>T</kbd></td>\n<td><kbd>⌥</kbd>+<kbd>T</kbd></td>\n</tr>\n<tr>\n<td>Increase paragraph indentation</td>\n<td><kbd>Tab</kbd></td>\n<td><kbd>⇥</kbd></td>\n</tr>\n<tr>\n<td>Decrease paragraph indentation</td>\n<td><kbd>Shift</kbd> + <kbd>Tab</kbd></td>\n<td><kbd>⇧</kbd> + <kbd>⇥</kbd></td>\n</tr>\n<tr>\n<td>Mark selected text as <a href=\"#root/_help_UYuUB1ZekNQU\">keyboard shortcut</a></td>\n<td><kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>K</kbd></td>\n<td><kbd>⌘</kbd>+ <kbd>⌥</kbd>+ <kbd>K</kbd></td>\n</tr>\n<tr>\n<td>Insert&nbsp;<a class=\"reference-link\" href=\"#root/_help_YfYAtQBcfo5V\">Math Equations</a></td>\n<td><kbd>Ctrl</kbd> + <kbd>M</kbd></td>\n<td><kbd>⌘</kbd>+ <kbd>M</kbd></td>\n</tr>\n<tr>\n<td>Move blocks (lists, paragraphs, etc.) up</td>\n<td><kbd>Ctrl</kbd>+<kbd>↑</kbd></td>\n<td><kbd>⌘</kbd>+<kbd>↑</kbd></td>\n</tr>\n<tr>\n<td><kbd>Alt</kbd>+<kbd>↑</kbd></td>\n<td><kbd>⌥</kbd>+<kbd>↑</kbd></td>\n<td></td>\n</tr>\n<tr>\n<td>Move blocks (lists, paragraphs, etc.) down</td>\n<td><kbd>Ctrl</kbd>+<kbd>↑</kbd></td>\n<td><kbd>⌘</kbd>+<kbd>↑</kbd></td>\n</tr>\n<tr>\n<td><kbd>Alt</kbd>+<kbd>↓</kbd></td>\n<td><kbd>⌥</kbd>+<kbd>↓</kbd></td>\n<td></td>\n</tr>\n</tbody></table></figure><h2>Common shortcuts</h2><aside class=\"admonition tip\"><p>This section of keyboard shortcuts presents a subset of the keyboard shortcuts as supported by the editor technology we are using,&nbsp;<a class=\"reference-link\" href=\"#root/_help_MI26XDLSAlCD\">CKEditor</a>. The shortcuts were taken from the <a href=\"https://ckeditor.com/docs/ckeditor5/latest/features/accessibility.html#keyboard-shortcuts\">official documentation</a>. Note that not all the shortcuts in the original documentation are applicable (due to using a different configuration).</p></aside><h3>Content editing</h3><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Action</th>\n<th>PC</th>\n<th>Mac</th>\n</tr>\n</thead>\n<tbody><tr>\n<td>Insert a hard break (a new paragraph)</td>\n<td><kbd>Enter</kbd></td>\n<td></td>\n</tr>\n<tr>\n<td>Insert a soft break (a <code spellcheck=\"false\">&lt;br&gt;</code> element)</td>\n<td><kbd>Shift</kbd>+<kbd>Enter</kbd></td>\n<td><kbd>⇧Enter</kbd></td>\n</tr>\n<tr>\n<td>Copy selected content</td>\n<td><kbd>Ctrl</kbd>+<kbd>C</kbd></td>\n<td><kbd>⌘C</kbd></td>\n</tr>\n<tr>\n<td>Paste content</td>\n<td><kbd>Ctrl</kbd>+<kbd>V</kbd></td>\n<td><kbd>⌘V</kbd></td>\n</tr>\n<tr>\n<td>Paste content as plain text</td>\n<td><kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>V</kbd></td>\n<td><kbd>⌘⇧V</kbd></td>\n</tr>\n<tr>\n<td>Undo</td>\n<td><kbd>Ctrl</kbd>+<kbd>Z</kbd></td>\n<td><kbd>⌘Z</kbd></td>\n</tr>\n<tr>\n<td>Redo</td>\n<td><kbd>Ctrl</kbd>+<kbd>Y</kbd>, <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Z</kbd></td>\n<td><kbd>⌘Y</kbd>, <kbd>⌘⇧Z</kbd></td>\n</tr>\n<tr>\n<td>Bold text</td>\n<td><kbd>Ctrl</kbd>+<kbd>B</kbd></td>\n<td><kbd>⌘B</kbd></td>\n</tr>\n<tr>\n<td>Change text case</td>\n<td><kbd>Shift</kbd>+<kbd>F3</kbd></td>\n<td><kbd>⇧F3</kbd> (may require <kbd>Fn</kbd>)</td>\n</tr>\n<tr>\n<td>Create link</td>\n<td><kbd>Ctrl</kbd>+<kbd>K</kbd></td>\n<td><kbd>⌘K</kbd></td>\n</tr>\n<tr>\n<td>Move out of a link</td>\n<td><kbd>←←</kbd>, <kbd>→→</kbd></td>\n<td></td>\n</tr>\n<tr>\n<td>Move out of an inline code style</td>\n<td><kbd>←←</kbd>, <kbd>→→</kbd></td>\n<td></td>\n</tr>\n<tr>\n<td>Select all</td>\n<td><kbd>Ctrl</kbd>+<kbd>A</kbd></td>\n<td><kbd>⌘A</kbd></td>\n</tr>\n<tr>\n<td>Find in the document</td>\n<td><kbd>Ctrl</kbd>+<kbd>F</kbd></td>\n<td><kbd>⌘F</kbd></td>\n</tr>\n<tr>\n<td>Copy text formatting</td>\n<td><kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>C</kbd></td>\n<td><kbd>⌘⇧C</kbd></td>\n</tr>\n<tr>\n<td>Paste text formatting</td>\n<td><kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>V</kbd></td>\n<td><kbd>⌘⇧V</kbd></td>\n</tr>\n<tr>\n<td>Italic text</td>\n<td><kbd>Ctrl</kbd>+<kbd>I</kbd></td>\n<td><kbd>⌘I</kbd></td>\n</tr>\n<tr>\n<td>Strikethrough text</td>\n<td><kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>X</kbd></td>\n<td><kbd>⌘⇧X</kbd></td>\n</tr>\n<tr>\n<td>Underline text</td>\n<td><kbd>Ctrl</kbd>+<kbd>U</kbd></td>\n<td><kbd>⌘U</kbd></td>\n</tr>\n<tr>\n<td>Revert autoformatting action</td>\n<td><kbd>Backspace</kbd></td>\n<td></td>\n</tr>\n</tbody></table></figure><h3>Interacting with blocks</h3><p>Blocks are images, tables, blockquotes, annotations.</p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Action</th>\n<th>PC</th>\n<th>Mac</th>\n</tr>\n</thead>\n<tbody><tr>\n<td>Insert a new paragraph directly after a widget</td>\n<td><kbd>Enter</kbd></td>\n<td></td>\n</tr>\n<tr>\n<td>Insert a new paragraph directly before a widget</td>\n<td><kbd>Shift</kbd>+<kbd>Enter</kbd></td>\n<td><kbd>⇧Enter</kbd></td>\n</tr>\n<tr>\n<td>Move the caret to allow typing directly before a widget</td>\n<td><kbd>↑</kbd>, <kbd>←</kbd></td>\n<td></td>\n</tr>\n<tr>\n<td>Move the caret to allow typing directly after a widget</td>\n<td><kbd>↓</kbd>, <kbd>→</kbd></td>\n<td></td>\n</tr>\n<tr>\n<td>After entering a nested editable, move the selection to the closest ancestor widget. For example: move from an image caption to the whole image widget.</td>\n<td><kbd>Tab</kbd> then <kbd>Esc</kbd></td>\n<td></td>\n</tr>\n</tbody></table></figure><p>Specifically for lists:</p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Action</th>\n<th>PC</th>\n<th>Mac</th>\n</tr>\n</thead>\n<tbody><tr>\n<td>Increase list item indent</td>\n<td><kbd>⇥</kbd></td>\n<td></td>\n</tr>\n<tr>\n<td>Decrease list item indent</td>\n<td><kbd>Shift</kbd>+<kbd>⇥</kbd></td>\n<td><kbd>⇧⇥</kbd></td>\n</tr>\n</tbody></table></figure><p>In tables:</p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Action</th>\n<th>PC</th>\n<th>Mac</th>\n</tr>\n</thead>\n<tbody><tr>\n<td>Move the selection to the next cell</td>\n<td><kbd>⇥</kbd></td>\n<td></td>\n</tr>\n<tr>\n<td>Move the selection to the previous cell</td>\n<td><kbd>Shift</kbd>+<kbd>⇥</kbd></td>\n<td><kbd>⇧⇥</kbd></td>\n</tr>\n<tr>\n<td>Insert a new table row (when in the last cell of a table)</td>\n<td><kbd>⇥</kbd></td>\n<td></td>\n</tr>\n<tr>\n<td>Navigate through the table</td>\n<td><kbd>↑</kbd>, <kbd>→</kbd>, <kbd>↓</kbd>, <kbd>←</kbd></td>\n<td></td>\n</tr>\n</tbody></table></figure><h3>General UI shortcuts</h3><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Action</th>\n<th>PC</th>\n<th>Mac</th>\n</tr>\n</thead>\n<tbody><tr>\n<td>Close contextual balloons, dropdowns, and dialogs</td>\n<td><kbd>Esc</kbd></td>\n<td></td>\n</tr>\n<tr>\n<td>Open the accessibility help dialog</td>\n<td><kbd>Alt</kbd>+<kbd>0</kbd></td>\n<td><kbd>⌥0</kbd></td>\n</tr>\n<tr>\n<td>Move focus between form fields (inputs, buttons, etc.)</td>\n<td><kbd>⇥</kbd>, <kbd>Shift</kbd>+<kbd>⇥</kbd></td>\n<td><kbd>⇥</kbd>, <kbd>⇧⇥</kbd></td>\n</tr>\n<tr>\n<td>Move focus to the toolbar, navigate between toolbars</td>\n<td><kbd>Alt</kbd>+<kbd>F10</kbd></td>\n<td><kbd>⌥F10</kbd> (may require <kbd>Fn</kbd>)</td>\n</tr>\n<tr>\n<td>Navigate through the toolbar or menu bar</td>\n<td><kbd>↑</kbd>, <kbd>→</kbd>, <kbd>↓</kbd>, <kbd>←</kbd></td>\n<td></td>\n</tr>\n<tr>\n<td>Navigate to the next focusable field or an element outside the editor</td>\n<td><kbd>Tab</kbd>, <kbd>Shift</kbd>+<kbd>Tab</kbd></td>\n<td></td>\n</tr>\n<tr>\n<td>Execute the currently focused button. Executing buttons that interact with the editor content moves the focus back to the content.</td>\n<td><kbd>Enter</kbd>, <kbd>Space</kbd></td>\n<td></td>\n</tr>\n<tr>\n<td>Move focus in and out of an active dialog window</td>\n<td><kbd>Ctrl</kbd>+<kbd>F6</kbd></td>\n<td><kbd>⌘F6</kbd> (may require <kbd>Fn</kbd>)</td>\n</tr>\n</tbody></table></figure>",
- "_help_UmgZAfcltxkS": "<p>Link previews turn a pasted URL into a rich, metadata-aware widget that can be displayed in three visual modes:</p><h2>Display modes</h2><p>A link preview can be displayed in one of three modes:</p><ul><li><strong>Inline</strong> — a link showing the site's favicon and page title (quite similar to&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>). Use this when you want the link to flow with the surrounding paragraph.</li><li><strong>Card</strong> — a block-level preview with thumbnail, title, description, and site name. Use this when the link is the focus of a paragraph.</li><li><strong>Embed</strong> — a block-level interactive embed.<ul><li>Currently supported for YouTube videos, which render interactively (via an <code spellcheck=\"false\">iframe</code>).</li><li>To prevent unwanted remote requests, the video is shown only after clicking on it first.</li></ul></li></ul><table class=\"ck-table-resized\">\n <colgroup>\n <col style=\"width:21.85%;\">\n <col style=\"width:38.84%;\">\n <col style=\"width:39.31%;\">\n </colgroup>\n <tbody>\n <tr>\n <td><figure class=\"image image_resized\" style=\"width:100%;\"><img style=\"aspect-ratio:251/42;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Link%20Previews_image.png\" width=\"251\" height=\"42\"><figcaption><em>Inline</em> link preview</figcaption></figure></td>\n <td><figure class=\"image image_resized\" style=\"width:100%;\"><img style=\"aspect-ratio:1217/196;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/2_Link%20Previews_image.png\" width=\"1217\" height=\"196\"><figcaption><em>Card</em> link preview</figcaption></figure></td>\n <td><figure class=\"image image_resized\" style=\"width:100%;\"><img style=\"aspect-ratio:994/563;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Link%20Previews_image.png\" width=\"994\" height=\"563\"><figcaption><em>Embed</em> link preview</figcaption></figure></td>\n </tr>\n </tbody>\n</table><h2>Inserting a link preview</h2><p>There are two ways to create one:</p><h3>1. By pasting a URL</h3><p>A link preview is automatically created:</p><ul><li>By pasting the URL and pressing <kbd>Space</kbd>. This will create an <em>inline</em> link preview.</li><li>When at the start of a new paragraph, pressing <kbd>Enter</kbd> will create a <em>card</em> or an <em>embed</em> for YouTube URLs.</li></ul><p>To undo an automatic link preview, press <kbd>Ctrl</kbd>+<kbd>Z</kbd> immediately afterwards which keeps it as a plain link instead. Alternatively, once a link preview was created, click on the link and select <em>Plain link</em> from the link preview toolbar.</p><p>This automatic conversion can be disabled by going to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Text Notes</em> and unchecking <em>Autogenerate link previews</em> from the <em>Features</em> section.</p><p>If the link is not accessible to the Trilium server (or the network request fails for any other reason), it will not be converted to a link preview.</p><aside class=\"admonition note\"><p>A URL is only auto-converted when the pasted text <em>is</em> the URL. Links with a display name (e.g. <a href=\"https://triliumnotes.org\">Trilium Notes website</a>) are left as plain links.</p></aside><h3>2. By using the \"Link preview\" toolbar button</h3><p>Click <strong>Link preview</strong> in the formatting toolbar to open the <em>Link preview</em> popup. Paste the URL and choose the type of preview.</p><h2>Altering an existing link preview</h2><p>Click on an inserted link preview to select it, and a small toolbar will appear with the following options:</p><ul><li>The normal link operations (opening in a new tab, copying the link, unlinking).</li><li>A button to edit the title of the link preview. This is especially useful if the title is hidden behind a login screen.</li><li>A way to switch between the link preview modes (Inline, Card or Embed) as well as to convert it to a normal link instead.<ul><li>The Embed option is only enabled when the URL points to a supported service (YouTube today).</li></ul></li></ul><h2>Where the preview data comes from</h2><p>When you insert a link preview, Trilium fetches metadata once and stores it inside the note's HTML:</p><ul><li><strong>YouTube URLs</strong> — title, channel name, and thumbnail are fetched via YouTube's public oEmbed endpoint.</li><li><strong>All other URLs</strong> — Trilium fetches the page and reads OpenGraph tags (<code spellcheck=\"false\">og:title</code>, <code spellcheck=\"false\">og:description</code>, <code spellcheck=\"false\">og:image</code>, <code spellcheck=\"false\">og:site_name</code>), falling back to the page's <code spellcheck=\"false\">&lt;title&gt;</code> and <code spellcheck=\"false\">&lt;meta name=\"description\"&gt;</code>. The site's favicon is downloaded and inlined.</li></ul><p>Because the data is stored in the note itself, link previews continue to render correctly when you reopen the note, share/publish it, or export to HTML — without any further network requests.</p><p>The metadata is captured <strong>at insertion time</strong> and is not automatically refreshed. If the linked page later changes its title or thumbnail, you'll need to re-insert the link to pick up the new values. To refresh a link, simply create it again.</p><p>When accessing a&nbsp;<a class=\"reference-link\" href=\"#root/_help_WOcw2SLH6tbX\">Server Installation</a>, the data is fetched from the remote URL by the server and not the client.</p><h2>Known limitations</h2><ul><li>The Embed display mode currently only supports YouTube. Other video and media platforms fall back to a Card preview.</li><li>Pages that block automated fetches may produce a minimal preview (hostname only).</li><li>Link previews require the Trilium server to reach the target URL, so they won't generate previews for pages on networks the server can't see.</li></ul>",
++ "_help_mT0HEkOsz6i1": "<p>Trilium supports storing and displaying images. Supported formats are PNG, JPEG, GIF, BMP, WebP, AVIF and SVG.</p><p>An image can be uploaded in the form of note's <a href=\"#root/_help_0vhv7lsOLy82\">attachment</a> or as a standalone <a href=\"#root/_help_kBrnXNG3Hplm\">note</a> placed into the <a href=\"#root/_help_kBrnXNG3Hplm\">note tree</a>. Its reference can be copied into a text note, in order to display it in the text itself.</p><h2>Uploading images</h2><p>To add an image to the note:</p><ul><li>Simply drag it from file explorer onto the note editor inside Trilium and the image will be uploaded.</li><li>Alternatively, from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>&nbsp;look for the <span class=\"tn-icon cke cke-image-upload\"></span> <em>Upload image from computer</em> button.</li><li>You can also copy and paste an image from web (see section below).</li></ul><aside class=\"admonition tip\"><p>To link a picture instead of displaying it, attach it with <em>Attach file as a link</em>, from the arrow beside the <span class=\"tn-icon cke cke-paper-clip\"></span><em>Attach file</em> button. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>.</p></aside><h2>Clipboard &amp; automatic download of images</h2><p>Trilium has a special handling for images copied to and pasted from the clipboard.</p><ul><li>For a mix of text and images, the images are downloaded automatically by the server (or desktop app, depending on what is being used).<ul><li>This means that the image must be publicly accessible and reachable from wherever Trilium is running. Inaccessible images will end up as broken images.</li></ul></li><li>If a single image is pasted into Trilium, it will prefer the image that comes in the clipboard. This makes it possible to copy images that Trilium would not otherwise be able to reach, such as Google Chat, Slack, etc.</li><li>When a text with images is copied from Trilium and pasted in another app (such as Microsoft Word or LibreOffice Writer), the images will be preserved.</li></ul><p>The automatic download of images is enabled by default and can be toggled from&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Media</em> → <em>Download images automatically.</em></p><h2>Configuring the images</h2><p>Clicking on an image will reveal a popup with multiple options:<br><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Images_image.png\"></p><h3>Alignment</h3><p>The first set of options configure the alignment are, in order:</p><figure class=\"table\"><table><thead><tr><th>Icon</th><th>Option</th><th>Preview</th><th>Description</th></tr></thead><tbody><tr><td><span class=\"tn-icon cke cke-object-inline\"></span></td><td>Inline</td><td><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Images_image.jpg\"></td><td>As the name suggests, the name can be put inside a paragraph and moved around similarly as if it was a block of text. Use drag &amp; drop or cut-paste to move it around.</td></tr><tr><td><span class=\"tn-icon cke cke-object-center\"></span></td><td>Centered image</td><td><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Images_image.jpg\"></td><td>The image will be displayed as a block and centered, not allowing text in either the left or right of it.</td></tr><tr><td><span class=\"tn-icon cke cke-object-inline-right\"></span></td><td>Wrap text</td><td><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/3_Images_image.jpg\"></td><td>The image will be displayed to the left or the right of the text.</td></tr><tr><td><span class=\"tn-icon cke cke-object-left\"></span></td><td>Block align</td><td><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/2_Images_image.jpg\"></td><td>Similarly to <em>Centered image</em>, the image will be displayed as a block and aligned either to the left or to the right, but not allowing text to flow on either of its sides.</td></tr></tbody></table></figure><h3>Drawing over an image</h3><p>To draw or write over an image, press the <span class=\"tn-icon bx bxs-pen\"></span> <em>Convert image to a drawing canvas</em> button of its toolbar. The image becomes a drawing canvas that shows all of it, locked in place. See the drawing canvases section of <a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>.</p><h2>Compression</h2><p>Since Trilium isn't really meant to be primary storage for image data, it attempts to compress and resize (with pretty aggressive settings) uploaded images before storing them to the database. You may then notice some quality degradation. Basic quality settings is available in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Media</em>.</p><p>If you want to save images in their original resolution, it is recommended to save them as attachment to note (look for the contextual menu in&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>&nbsp;→ <em>Import files</em>).</p><h2>Aligning images side-by-side</h2><p>There are generally two ways to display images side by side:</p><ul><li>If they are roughly the same size, simply make the two images in-line, according to the alignment section above. The images can be dragged &amp; dropped onto the same line.</li><li>If they are on different size, create a <a href=\"#root/_help_NdowYOC1GFKS\">table</a> with invisible borders.</li></ul>",
++ "_help_0Ofbk1aSuVRu": "<figure class=\"image image-style-align-right image_resized\" style=\"width:50.47%;\"><img style=\"aspect-ratio:880/553;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Images/Image%20references_image.png\" width=\"880\" height=\"553\"></figure><p>Image references are an easy way to embed the preview of another note type into a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;note.</p><h2>Supported note types</h2><ul><li><a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a></li><li><a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a></li><li><a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a></li></ul><h2>Steps</h2><ol><li>Go to one of the supported notes (listed above) and look for the&nbsp;<span class=\"tn-icon bx bx-copy\"></span> button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_1P8QXI5edXNd\">Note buttons</a>&nbsp;area.</li><li>Go to a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;note and use the Paste function to insert the reference to that note.</li></ol><h2>Interaction</h2><ul><li>Double-clicking an image reference from a text note will automatically open the target note.</li><li>Clicking an image reference while <kbd>Ctrl</kbd> is pressed will open the target note in a new tab.</li><li>Modifying the target note should also update the image reference. If that doesn't happen, consider&nbsp;<a class=\"reference-link\" href=\"#root/_help_s8alTXmpFR61\">Refreshing the application</a>.</li></ul>",
++ "_help_VRoP0g1uHHc2": "<figure class=\"image image-style-align-center image_resized\" style=\"width:76.29%;\"><img style=\"aspect-ratio:1479/865;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/In-editor%20AI%20assistant_image.png\" width=\"1479\" height=\"865\"></figure><p>The AI assistant works on the text you are already writing: select a passage and have it rewritten, translated or turned into a table, or ask for new content at the cursor. Unlike the <a href=\"#root/_help_LrKznOtw9cQD\">AI chat</a>, it does not open a conversation window, the result is previewed in place and only enters the note when you accept it.</p><h2>Requirements</h2><p>The assistant is only available once at least one provider is configured in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>AI / LLM</em>, with at least one model selected for it. Until then the toolbar entry is not shown at all.</p><h2>Accessing the AI assistant</h2><p>To access the AI assistant:</p><ul><li>Look for the&nbsp;<span class=\"tn-icon cke cke-trilium-ai\"></span> button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>. Press the button itself to enter the <em>Ask AI</em> mode or press the arrow key next to it to access the quick commands and the model selection.</li><li>Look for <em>AI assistant</em> or any of the <em>AI</em>-prefixed quick commands in&nbsp;<a class=\"reference-link\" href=\"#root/_help_ZlN4nump6EbW\">Slash Commands</a>.</li><li>Press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>K</kbd>.</li><li>Select a text and choose the <em>AI assistant</em> option in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_jcQVxzYybYgz\">Note contextual menu</a>.</li></ul><h2>What the assistant works on</h2><figure class=\"table\"><table><thead><tr><th>Situation</th><th>What is sent</th></tr></thead><tbody><tr><td>Text is selected</td><td>The selection.</td></tr><tr><td>Nothing is selected, and you pick a quick action</td><td>The paragraph the cursor is in.</td></tr><tr><td>Nothing is selected, and you type your own prompt</td><td>Nothing, the response is new content written at the cursor.</td></tr></tbody></table></figure><p>In all cases the assistant also sends the text before and after the target, so that the model can tell what it is writing into: asked to <em>Continue writing</em> or to summarize, a model that can only see the selected words is guessing at the document around them. This surrounding text is context only, it is never rewritten.</p><aside class=\"admonition important\"><p>That means a single run sends more than the passage you highlighted. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_cRRrdZjgyhNc\">Privacy</a>&nbsp;for exactly what leaves your machine.</p></aside><h2>Quick actions</h2><p>The arrow beside the toolbar button opens a menu of ready-made instructions, grouped by what they do.</p><ul><li>The <em>Reformat</em> actions produce real Trilium content rather than plain text: <em>Diagram</em> inserts a Mermaid diagram, <em>Callout</em> an admonition, and <em>Collapsible</em> a collapsible block.</li><li>The <em>Translate</em> group lists the <a href=\"#root/_help_veGu4faJErEM\">content languages</a> you have enabled, or a predefined list if no content languages are set. It can be filled from within the editor, the last entry of the submenu opens the language configuration directly.</li></ul><p>Actions that need something to work on are greyed out when there is nothing to work on (for example an empty paragraph with no selection).</p><h2>Asking for something specific</h2><p>Choosing <em>Ask AI…</em> (<span class=\"tn-icon bx bx-message-square-dots\"></span>) opens a prompt where you can describe the change in your own words, for example: \"make this less formal\", \"add a row for 2024\", \"write an intro paragraph for this section\". Press <kbd>Enter</kbd> or the <span class=\"tn-icon cke cke-arrow-up\"></span> send button to run it.</p><p>Once a response arrives you can keep going in the same prompt, and the assistant treats it as a conversation rather than as a fresh request: after <em>Translate this to German</em>, asking for <em>make it shorter</em> shortens the German, not the original.</p><h2>Reviewing the result</h2><p>The response streams in as it is generated, and can be interrupted at any point by pressing the <em>Stop</em> (<span class=\"tn-icon cke cke-stop\"></span>) button; whatever arrived before that stays usable.</p><p>Nothing is written into the note until you say so. The review offers:</p><ul><li><em>Result</em>, which displays the response as it will be inserted.</li><li><em>Changes</em>, which displays an inline diff against the original, with insertions and deletions marked. When the model rewrote the passage rather than editing it, the review opens on <em>Result</em> instead: a diff of two texts with little in common is harder to read than the answer itself.</li><li><em>Try again</em> (<span class=\"tn-icon cke cke-refresh\"></span>), to re-run the same instruction.</li><li><em>Replace</em>, which substitutes the original passage</li><li><em>Insert below</em>, which keeps the original and adds the response after it.</li></ul><p>Trilium also reports the model that produced it, the tokens consumed and, for providers that report it, the price.</p><p>If you ask for a correction and there is nothing to correct, the assistant will indicate it instead of showing a blank diff.</p><h2>Choosing the model</h2><p>The bottom of the quick actions menu shows which model the assistant runs on, and lets you pick another from the models you selected in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>AI / LLM</em>, grouped by provider.</p><p>The model can also be changed while asking for something specific, or after the assistant has generated its response (i.e. if the response needs a better model).</p><p>This choice is separate from the model used by the chat, and is remembered across notes and devices. Left unset, the assistant follows the first configured provider.</p>",
++ "_help_mVEYwt20exhO": "<p><em>Quick actions</em> are a feature of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_VRoP0g1uHHc2\">In-editor AI assistant</a>&nbsp;for&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes which automatically triggers an LLM suggestion based on a defined prompt. The built-in quick actions come with a predefined prompt, but it is also possible to define your own quick actions.</p><h2>Creating a custom quick action</h2><p>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>: </p><ol><li>Right-click the note where you want to place the quick action.</li><li>Select <em>Insert child note</em>.</li><li>Select <em>More</em> → <em>AI Quick Action</em>. The entry appears only when AI is enabled.</li></ol><p>Afterwards, simply type in the content of the note the desired prompt. The text can be formatted in the same manner as a normal text note and it will be passed to the LLM as Markdown.</p><p>The title of the note will become the title of the quick action.</p><p>Of note:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;notes work too.</li><li>An empty note is ignored.</li><li><a class=\"reference-link\" href=\"#root/_help_MKmLg5x6xkor\">Archived Notes</a>&nbsp;are also excluded.</li></ul><h2>Using a quick action</h2><p>Once a quick action is defined, the action will appear under the <em>Quick Actions</em> dropdown in a group called <em>Custom</em>.</p>",
++ "_help_nBAXQFj20hS1": "<p>Text notes can \"include\" another note as a read-only widget or an interactive widget, depending on the type of note.</p><p>This can be useful for e.g. including a dynamically generated chart (from scripts &amp; \"render HTML\" note) or other more advanced use cases.</p><h2>Including a note</h2><p>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>, look for the&nbsp;<span class=\"tn-icon cke cke-trilium-note\"></span> button. There is also a keyboard shortcut defined for it but it is not allocated by default.</p><p>To include a note that is already linked, right-click a reference link to it in a text note being edited and select <em>Convert link to an included note</em>, at the end of the menu. The include gets the box size that suits the note, as one added from the button does.</p><p>An <a href=\"#root/_help_0vhv7lsOLy82\">attachment</a> can be included the same way, from the context menu of a link to it (see <em>Embedding an attachment</em> there).</p><p>A link to blocks of a text note is converted the same way, with <em>Convert link to note excerpt</em>, and the include then shows only those blocks. See <a class=\"reference-link\" href=\"#root/_help_klC3ilXa9kUE\">Block references</a>.</p><h2>Box sizes</h2><p>The box size sets how much of the included note is shown.</p><ul><li><em>Tiny</em> shows a single row instead of the content: the note's icon, its title with the path to the note above it, and buttons to act on the note. The included note is never rendered, so wherever the note is shown outside the editor, such as in print, in a tooltip or on a shared page, a <em>Tiny</em> include appears as a link to the included note.</li><li><em>Small</em> and <em>Medium</em> show the content in a box of limited height. Text scrolls inside the box, while a picture, a diagram or a video is scaled down to fit it.</li><li><em>Full</em> shows the whole content.</li><li><em>Expandable</em> shows only the title until its <span class=\"tn-icon bx bx-chevron-right\"></span> arrow is pressed. In a read-only note, a click anywhere on the title row other than its buttons and link expands or collapses it as well.</li></ul><p>A new include gets the size that suits what it shows:</p><ul><li><em>Tiny</em> for a note or an attachment that has no preview, such as a relation map or an archive.</li><li><em>Small</em> for audio.</li><li><em>Full</em> for a code note or a code file, such as a <code>.js</code>, <code>.py</code> or <code>.txt</code> attachment, and for an excerpt of the blocks of a text note.</li><li><em>Medium</em> for anything else.</li></ul><p>The dialog that includes a note selects that size once the note is picked, and you can choose another one there. To change the size later, select the include and use the <em>Box size</em> menu in its toolbar, or the <em>Size</em> submenu of its <em>More actions</em> menu.</p><h2>Resizing</h2><p>A <em>Small</em>, <em>Medium</em> or <em>Expandable</em> include can be resized to any width and height. A <em>Tiny</em> or <em>Full</em> include always fits its content.</p><ul><li>To resize an include, select it and drag the handle in its bottom-right corner. To change only the width or only the height, drag the middle of its right or bottom edge instead, where a touch screen shows a handle too. In right-to-left text, the handle is in the bottom-left corner and the width changes from the left edge.</li><li>Resizing works with a mouse, a pen or a finger.</li><li>While the height changes, moving the handle near the top or the bottom of the note scrolls the note.</li><li>An include narrower than the note is centered, so changing its width moves both of its sides. Making it as wide as the note returns it to the full width.</li><li>To cancel a resize, press <kbd>Esc</kbd> before releasing the handle.</li><li>To reset the size, double-click the corner handle, or double-tap it on a touch screen. Double-clicking the right or bottom edge resets only the width or the height.</li><li>Choosing a box size resets the height. Choosing <em>Tiny</em> or <em>Full</em> resets the width too.</li><li>While an <em>Expandable</em> include is collapsed, only its width can be changed.</li></ul><h2>Caption</h2><p>An include can have a caption, shown centered at the bottom of its box. The caption is part of the text note, so it can be formatted like the rest of the text, for example in bold or with a link.</p><ul><li>To add a caption, select the include, press the <span class=\"tn-icon cke cke-caption\"></span> <em>Toggle caption on</em> button in its toolbar and type the caption.</li><li>To remove the caption, press the same button again. Pressing it once more brings back the text it had, as long as the note stays open.</li><li>A <em>Tiny</em> include has no caption. Switching an include to <em>Tiny</em> removes its caption, and switching it back to a larger size restores the caption, as long as the note stays open.</li><li>An <em>Expandable</em> include shows its caption under the title while the content is collapsed, and under the content once it is expanded.</li></ul><h2>Title</h2><p>The title row of an include links to the included note and holds its buttons. To show only the content, select the include and press the <span class=\"tn-icon bx bx-window-alt\"></span> <em>Show title</em> button in its toolbar. Pressing it again shows the title.</p><ul><li>While the title is hidden, the <span class=\"tn-icon cke cke-three-vertical-dots\"></span> <em>More actions</em> button in the toolbar of the include opens the menu of the included note.</li><li>A <em>Tiny</em> or <em>Expandable</em> include always shows its title, and its toolbar has no <em>Show title</em> button.</li></ul><h2>Opening an included note</h2><p>To open an included note in a new tab, press the <span class=\"tn-icon bx bx-link-external\"></span> <em>Open in new tab</em> button at the end of its title. An embedded attachment has the same button.</p><p>The <span class=\"tn-icon bx bx-dots-vertical-rounded\"></span> <em>More actions</em> button at the end of the title row opens the same menu as right-clicking anywhere on the title row: the other places to open the note in and, for an embedded attachment, the actions on the attachment.</p><p>In a note being edited, the menu also has the commands of the include's toolbar: the <em>Size</em> submenu, <em>Show title</em> and <em>Show caption</em>, each checked while it is in effect, and <em>Convert to link</em> at the end. A drawing canvas, an included text or code note and an embedded code file also have <em>Editable</em>, above <em>Size</em>. For an embedded attachment they follow its first group of actions; for an included note they end the menu.</p><p>To show an include of size <em>Medium</em> or <em>Full</em> on the whole screen, press the <span class=\"tn-icon bx bx-fullscreen\"></span> <em>Fullscreen</em> button at the end of its title. An excerpt of the blocks of a note has an <span class=\"tn-icon bx bx-pencil\"></span> <em>Edit excerpt</em> button there instead; see <a class=\"reference-link\" href=\"#root/_help_klC3ilXa9kUE\">Block references</a>. To return, press <span class=\"tn-icon bx bx-exit\"></span> <em>Exit fullscreen</em> in the top-right corner, or <kbd>Esc</kbd>.</p><p>A <em>Tiny</em> include has these buttons instead, followed by the same <em>More actions</em> button:</p><ul><li>For a note, <span class=\"tn-icon bx bx-edit\"></span> <em>Quick edit</em> opens the note in&nbsp;<a class=\"reference-link\" href=\"#root/_help_ZjLYv08Rp3qC\">Quick edit</a>, and <span class=\"tn-icon bx bx-link-external\"></span> <em>Open in new tab</em> opens it in a new tab.</li><li>For an embedded attachment, <span class=\"tn-icon bx bx-file-find\"></span> <em>Open externally</em> opens the file in another application, and <span class=\"tn-icon bx bx-download\"></span> <em>Download</em> downloads it. The size of the file is shown under its title.</li></ul><h2>Converting an include to a link</h2><p>To replace an include with a link to the included note, select it and press the <span class=\"tn-icon cke cke-link\"></span> <em>Convert to link</em> button in its toolbar, or choose <em>Convert to link</em> at the end of its <em>More actions</em> menu. An embedded attachment turns into a link to the attachment the same way.</p><h2>Included notes in the share functionality</h2><p>If a <a href=\"#root/_help_R9pX4DGra2Vt\">shared note</a> contains one or more included notes, they will be displayed in the content of the note as if they were part of the note itself. The caption of an include is shown under the included content. A <em>Tiny</em> include is shown as a link to the included note instead, and so is an include that would show a note already shown around it, such as a note that includes itself. The same goes for a printed or exported note.</p><p>For this to work, the included notes must also be shared, otherwise they will not be shown. However, the included notes can still be hidden from the note tree via <code>#shareHiddenFromTree</code>.</p><h2>Interactive notes</h2><p>Since v0.104.0, included notes might become interactive depending on their note type:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>&nbsp;(e.g.&nbsp;<a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map</a>) will render fully interactive, including creating new notes.</li><li><a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a>&nbsp;will also display the results.</li><li><a class=\"reference-link\" href=\"#root/_help_1vHRoWCEjj0L\">Web View</a>&nbsp;provides an interactive preview of the website.</li></ul><h2>Included images</h2><p>An included image, whether an image note or an image attachment, is shown in the image viewer, which zooms and pans it:</p><ul><li>To zoom, press the <span class=\"tn-icon bx bx-plus-circle\"></span> <em>Zoom in</em> and <span class=\"tn-icon bx bx-minus-circle\"></span> <em>Zoom out</em> buttons in the bottom-right corner of the image, or pinch on a touch screen. The percentage between them resets the zoom.</li><li>To zoom with the mouse wheel, click the image first. Until then, the mouse wheel scrolls the note.</li><li>To pan an image that is zoomed in, drag it. At its fitted size, dragging the image on a touch screen scrolls the note.</li><li>To return to the fitted size, double-click the image.</li></ul><p>In a <em>Small</em> or <em>Medium</em> box, the image is scaled down to fit the height of the box. In fullscreen, it fits the screen.</p><h2>Editing an include in place</h2><p>An included text note, an included code note and an embedded code file such as a <code>.js</code>, <code>.py</code> or <code>.txt</code> attachment can be edited without leaving the note that includes them. A code note or file is shown with syntax highlighting until then.</p><ul><li>To edit, select the include and turn on the <span class=\"tn-icon bx bx-edit-alt\"></span> <em>Editable</em> button at the start of its toolbar, or check <em>Editable</em> in its <span class=\"tn-icon cke cke-three-vertical-dots\"></span> <em>More actions</em> menu. Turn <em>Editable</em> off to return to the preview.</li><li>While an included text note has the focus, the formatting toolbar applies to it. The notes it includes in turn stay read-only.</li><li>Code is edited in the same code editor as a <a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a> note, with its theme, indentation and line wrapping settings.</li><li>The changes are saved as you type, to the included note or to the attachment, as they would be in its own tab.</li><li>An include of <a class=\"reference-link\" href=\"#root/_help_klC3ilXa9kUE\">Block references</a> edits only the referenced blocks.</li><li>Editing is not available in a <a href=\"#root/_help_CoFPLs3dRlXc\">read-only note</a>, for an included note marked <code>#readOnly</code>, or for an attachment of another note.</li></ul><h2>Drawing canvases</h2><p>A drawing canvas is an Excalidraw canvas, like the one of a <a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a> note, drawn directly in the text note. It is not a note of its own: the drawing is kept in a <code>Canvas.excalidraw</code> <a href=\"#root/_help_0vhv7lsOLy82\">attachment</a> of the text note and is saved together with the text.</p><ul><li>To insert a drawing canvas, open the <span class=\"tn-icon cke cke-plus\"></span> <em>Insert</em> menu of the <a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a> and choose <span class=\"tn-icon bx bx-pen\"></span> <em>Drawing canvas</em>, above <em>Mermaid diagram</em>. It is also available as <em>Drawing canvas</em> in the <a class=\"reference-link\" href=\"#root/_help_ZlN4nump6EbW\">Slash Commands</a>. The canvas is added empty and editable, in a <em>Medium</em> box with its title hidden, and takes the focus, ready for drawing.</li><li>To draw or write over an image, select the image and press the <span class=\"tn-icon bx bxs-pen\"></span> <em>Convert image to a drawing canvas</em> button of its toolbar. The image is replaced by an editable drawing canvas in a <em>Medium</em> box, with its title hidden and the focus in it. The image sits at its original size in the middle of the canvas, zoomed so that all of it shows, and is locked so that it cannot be selected or moved by accident. While it is locked, the canvas can be zoomed in on the image but not zoomed out past it or scrolled beyond its edges. To move or resize the image anyway, right-click it and choose <em>Unlock</em>. The caption of the image is kept, but not its alignment or link. Only an image on its own line can be converted, not one inside a paragraph. Undo brings the image back.</li><li>An Excalidraw file (<code>.excalidraw</code>) attached with the <span class=\"tn-icon cke cke-paper-clip\"></span><em>Attach file</em> button becomes a drawing canvas too, in a <em>Medium</em> box titled with the file name. It starts with <em>Editable</em> off, so the drawing shows but cannot be changed until <em>Editable</em> is turned on (see below).</li><li>To draw on a canvas that does not have the focus, click it first. Until then, touch gestures scroll the note. The canvas then has the tools, menus and keyboard shortcuts of a Canvas note. The toolbars, the menus and the properties of the selected shapes show only while the canvas has the focus, so elsewhere the drawing reads like a picture in the text.</li><li>The mouse wheel and the touchpad scroll the note over a canvas too, as over the text. To zoom, use the zoom buttons of the canvas toolbar; to move around the drawing, use the <span class=\"tn-icon bx bxs-hand\"></span> <em>Hand</em> tool. In fullscreen, the mouse wheel moves and zooms the drawing instead.</li><li>The canvas toolbar replaces the Excalidraw menu: <em>Export image</em>, <em>Find on canvas</em>, <em>Library</em> and <em>Help</em> are at the end of its <span class=\"tn-icon bx bx-category\"></span> <em>More tools</em> menu. In fullscreen, the Excalidraw menu shows again.</li><li>A new drawing has the background color of the note. A background chosen from the Excalidraw menu replaces it.</li><li>To protect a finished drawing from accidental changes, select it and turn off the <span class=\"tn-icon bx bx-edit-alt\"></span> <em>Editable</em> button at the start of its toolbar, or uncheck <em>Editable</em> in its <span class=\"tn-icon cke cke-three-vertical-dots\"></span> <em>More actions</em> menu. The drawing then shows as a still picture, at the zoom and position it had, and can no longer be changed, zoomed or moved. To draw again, turn <em>Editable</em> back on.</li><li>The box sizes, resizing, the caption and the title work as for an included note, but the toolbar of a drawing leaves the box size, <em>Show title</em> and <em>Convert to link</em> to its <em>More actions</em> menu.</li><li>In the desktop layout, Excalidraw keeps its desktop interface however small the box is. In the mobile layout, a narrow or short box switches it to a compact interface. For more room, choose <em>Full</em>, or show the title and press <span class=\"tn-icon bx bx-fullscreen\"></span> <em>Fullscreen</em>.</li><li>Pictures added to the drawing are stored in the same attachment. A converted image is kept as an image attachment of the note instead, named with a generated code.</li><li>In a <a href=\"#root/_help_CoFPLs3dRlXc\">read-only note</a>, the drawing shows as a still picture too.</li><li>On a <a href=\"#root/_help_R9pX4DGra2Vt\">shared page</a>, the drawing is shown as a picture at its own size, whatever the size of its box, in light or dark colors to match the page. Each change to the drawing saves this picture as an SVG image attachment of the note, also named with a generated code.</li></ul><h3>Limitations</h3><ul><li>The Excalidraw shape library is not saved for a drawing canvas.</li><li>Outside the editor, for example in a tooltip, when printing or in the list of attachments, the drawing is shown as a picture.</li><li>A drawing has no picture for shared pages until its first change, except one converted from an image. Until then, for example for an attached <code>.excalidraw</code> file, a shared page shows a link to download the drawing instead.</li><li>In Safari, the picture of a drawing on a shared page follows the light or dark appearance of the system rather than the theme chosen on the page.</li><li>A copy of a drawing canvas pasted in the same note shares the drawing with the original, so a change to one shows in the other only after the note is opened again. A copy pasted in another note gets a drawing of its own.</li></ul>",
++ "_help_CohkqWQC1iBv": "<p>Press the&nbsp;<span class=\"tn-icon cke cke-plus\"></span> button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>&nbsp;to reveal special inserable items and blocks such as symbols, Math expressions and separators.</p><h2>Bookmarks</h2><p>See the dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_oSuaNgyyKnhu\">Anchors</a>&nbsp;section.</p><h2>Emoji</h2><figure class=\"image image-style-align-right image_resized\" style=\"width:42.4%;\"><img style=\"aspect-ratio:366/410;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Insert%20buttons_plus.png\" width=\"366\" height=\"410\"></figure><p>This feature allows inserting Unicode emoji characters. Simply select a category and a desired emoji to insert it.</p><p>Emojis can also be searched by their English name and the skin tone can be selected via a combo box to the right.</p><p>There is also the possibility of inserting emojis directly by typing <code>:</code> followed by a name of an emoji, triggering the display of a list of emojis. Simply use the arrow keys to select one and press <kbd>Enter</kbd> or <kbd>Tab</kbd> to insert it.</p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Insert%20buttons_plus.png\" width=\"272\" height=\"187\"><h2>Symbols</h2><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:346/322;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Insert%20buttons_image.png\" width=\"346\" height=\"322\"></figure><p>Pressing the&nbsp;<span class=\"tn-icon cke cke-special-characters\"></span> button will reveal a popup window displaying a list of characters that are generally more difficult to insert directly from the keyboard, such as a subset of emojis, quotation characters, etc.</p><p>Interaction:</p><ul><li>Click on a character to insert it at the current cursor position.</li><li>The window can be dragged around by the top bar where the title is, to avoid it getting in the way of the text.</li><li>Click on the <em>Category</em> selector to filter the characters.</li></ul><h2>Multicolumn layout</h2><p>See the dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_wYDzQ1fBFgfT\">Multicolumn layout</a>&nbsp;page.</p><h2>Math equations</h2><p>See the dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_YfYAtQBcfo5V\">Math Equations</a>&nbsp;page.</p><h2>Drawing canvas</h2><p>Choose <span class=\"tn-icon bx bx-pen\"></span> <em>Drawing canvas</em> to draw on an Excalidraw canvas inside the text. See <em>Drawing canvases</em> in <a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>.</p><h2>Mermaid diagram</h2><p>Press the&nbsp;<span class=\"tn-icon cke cke-trilium-mermaid-insert\"></span> button to create an inline Mermaid diagram.</p><p>This feature is quite similar to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a>&nbsp;note types and is meant as an alternative to it for simple diagrams. For more complex diagrams, use the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>&nbsp;feature for a dedicated Mermaid note.</p><figure class=\"image\"><img style=\"aspect-ratio:1174/358;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/2_Insert%20buttons_image.png\" width=\"1174\" height=\"358\"></figure><h2>Horizontal ruler</h2><p>This feature will display a horizontal line, generally useful to separate different sections of the text. To do so, press the&nbsp;<span class=\"tn-icon cke cke-horizontal-line\"></span> button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>.</p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Insert%20buttons_image.png\" width=\"502\" height=\"95\"><p>Alternatively, it's possible to insert a horizontal ruler by typing <code>---</code>.</p><h2>Page break</h2><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:371/79;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/3_Insert%20buttons_image.png\" width=\"371\" height=\"79\"></figure><p>Page breaks provide a way to force the next paragraph or block (table, image, etc.) to be displayed onto the next page when printing (either to a real printer to <a href=\"#root/_help_NRnIZmSMc5sj\">when exporting to PDF</a>).</p><p>Page breaks are marked in the editor with the words <em>Page break</em>, but they will not actually be shown when printed.</p><ul><li>To insert a page break, press the&nbsp;<span class=\"tn-icon cke cke-page-break\"></span> in the formatting toolbar.</li><li>To insert many page breaks at once, insert a page break first, click on it and press <kbd>Ctrl</kbd>+<kbd>C</kbd>. Then use <kbd>Ctrl</kbd>+<kbd>V</kbd>, to paste as many times as needed.</li></ul><h2>Date and time</h2><p>The <span class=\"tn-icon cke cke-trilium-date-time\"></span> button inserts the current date and time at the cursor, replacing the selected text if there is any. The inserted text takes the formatting of the text around it, so a date inserted inside bold text is bold too.</p><ul><li>To insert the date in the default format, press the button itself or press <kbd>Alt</kbd>+<kbd>T</kbd>.</li><li>To insert it in another format, press the arrow next to the button and pick a format from the list. Each entry shows the current date and time in that format: the default one, the date or the time alone, the date written out, and ISO 8601.</li><li>The same formats are offered by the <a class=\"reference-link\" href=\"#root/_help_ZlN4nump6EbW\">Slash Commands</a>: type <code>/date</code>, <code>/time</code>, <code>/now</code> or <code>/today</code>. The <em>Insert date/time</em> entry uses the default format, and shows what it inserts underneath; the other entries show their output in the title.</li></ul><p>The default format can be changed in <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Text Notes</em> → <em>Editor</em> → <em>Date/time format</em>, using <a href=\"https://day.js.org/docs/en/display/format\">Day.js format tokens</a> (for example <code>DD.MM.YYYY HH:mm</code>).</p><h2>Icons</h2><p>Icons just like the ones for the <a href=\"#root/_help_p9kXRFAkwN4o\">note icon</a> can be inserted in text. For more information see&nbsp;<a class=\"reference-link\" href=\"#root/_help_hD8GawVuazff\">Icons</a>.</p>",
++ "_help_hD8GawVuazff": "<p>Icons just like the <a href=\"#root/_help_hD8GawVuazff\">note icons</a> can be inserted in the content of a note, including from any other <a href=\"#root/_help_gOKqSJgXLcIj\">custom icon packs</a>.</p><h2>Features</h2><ul><li>The icon can be formatted through the<a class=\"reference-link\" href=\"#root/_help_Gr6xFaF6ioJ5\">General formatting</a>&nbsp;tools of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>:<ul><li>Foreground/icon color</li><li>Background color/highlight</li><li>Font size</li></ul></li><li>Custom&nbsp;<a class=\"reference-link\" href=\"#root/_help_gOKqSJgXLcIj\">Icon Packs</a>&nbsp;are also supported.<ul><li>For emojis, prefer the Emoji functionality from&nbsp;<a class=\"reference-link\" href=\"#root/_help_CohkqWQC1iBv\">Insert buttons</a>.</li></ul></li><li>When an icon is clicked a floating toolbar appears with the following functions:<ul><li><span class=\"tn-icon bx bx-sticker\"></span>&nbsp;which changes the icon.</li><li><span class=\"tn-icon bx bx-reflect-horizontal\"></span>&nbsp;which applies transforms: rotate (90 / 180 / 270) and flip horizontal/vertical. Only one transform can be used per icon.</li></ul></li></ul><h2>Usage</h2><ul><li>The in-app help/user guide makes use of these icons in order to illustrate buttons in the UI.</li><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_GnhlmrATVqcH\">Microsoft OneNote</a>&nbsp;importer also makes use of them for the&nbsp;<a class=\"reference-link\" href=\"#root/_help_LpvyEIBIAAj7\">Tags</a>.</li></ul><h2>Inserting an icon</h2><p>There are two ways to insert an icon:</p><ul><li>Via the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>&nbsp;look for the&nbsp;<span class=\"tn-icon bx bx-plus\"></span> icon and then the&nbsp;<span class=\"tn-icon bx bx-sticker\"></span> icon.</li><li>Via&nbsp;<a class=\"reference-link\" href=\"#root/_help_ZlN4nump6EbW\">Slash Commands</a>, type <code>/icon</code>.</li></ul><p>An icon picker will appear, search for an icon and click it to insert it in the document.</p><h2>Finding notes by their icons</h2><p>An icon can be <a href=\"#root/_help_eIg8jdvaoNNd\">searched</a>. A note containing a&nbsp;<span class=\"tn-icon bx bx-star\"></span> icon can be found by searching for <code>star</code>, or its <code>iconClass</code> (<code>bx-star</code>).</p><p>To find the name of the icon, hover the mouse over an icon while in the icon picker.</p><h2>Markdown rendering</h2><p>When exporting to&nbsp;<a class=\"reference-link\" href=\"#root/_help_Oau6X9rCuegd\">Markdown</a>, the item will render as raw HTML representation of the icon as is used by Trilium:</p><pre><code class=\"language-text-html\">&lt;span class=\"tn-icon bx bx-star\"&gt;&lt;/span&gt;</code></pre>",
++ "_help_oiVPnW8QfnvS": "<h2>Trilium-specific shortcuts</h2><figure class=\"table\"><table><thead><tr><th>Action</th><th>PC</th><th>Mac</th></tr></thead><tbody><tr><td>Bring up inline formatting toolbar (arrow keys ←,→ to navigate, Enter to apply)</td><td>Alt+F10</td><td>⌥+F10</td></tr><tr><td>Bring up block formatting toolbar</td><td>Alt+F10</td><td>⌥+F10</td></tr><tr><td>Create <a href=\"#root/_help_QEAPj01N5f7w\">external link</a></td><td>Ctrl+K</td><td>⌘+K</td></tr><tr><td>Create <a href=\"#root/_help_QEAPj01N5f7w\">internal (note) link</a></td><td>Ctrl+L</td><td>⌘+L</td></tr><tr><td>Inserts current date and time at caret position</td><td>Alt+T</td><td>⌥+T</td></tr><tr><td>Increase paragraph indentation</td><td>Tab</td><td>⇥</td></tr><tr><td>Decrease paragraph indentation</td><td>Shift + Tab</td><td>⇧ + ⇥</td></tr><tr><td>Mark selected text as <a href=\"#root/_help_UYuUB1ZekNQU\">keyboard shortcut</a></td><td>Ctrl + Alt + K</td><td>⌘+ ⌥+ K</td></tr><tr><td>Insert&nbsp;<a class=\"reference-link\" href=\"#root/_help_YfYAtQBcfo5V\">Math Equations</a></td><td>Ctrl + M</td><td>⌘+ M</td></tr><tr><td>Move blocks (lists, paragraphs, etc.) up</td><td>Ctrl+↑</td><td>⌘+↑</td></tr><tr><td>Alt+↑</td><td>⌥+↑</td><td></td></tr><tr><td>Move blocks (lists, paragraphs, etc.) down</td><td>Ctrl+↑</td><td>⌘+↑</td></tr><tr><td>Alt+↓</td><td>⌥+↓</td><td></td></tr></tbody></table></figure><h2>Common shortcuts</h2><aside class=\"admonition tip\"><p>This section of keyboard shortcuts presents a subset of the keyboard shortcuts as supported by the editor technology we are using,&nbsp;<a class=\"reference-link\" href=\"#root/_help_MI26XDLSAlCD\">CKEditor</a>. The shortcuts were taken from the <a href=\"https://ckeditor.com/docs/ckeditor5/latest/features/accessibility.html#keyboard-shortcuts\">official documentation</a>. Note that not all the shortcuts in the original documentation are applicable (due to using a different configuration).</p></aside><h3>Content editing</h3><figure class=\"table\"><table><thead><tr><th>Action</th><th>PC</th><th>Mac</th></tr></thead><tbody><tr><td>Insert a hard break (a new paragraph)</td><td>Enter</td><td></td></tr><tr><td>Insert a soft break (a <code>&lt;br&gt;</code> element)</td><td>Shift+Enter</td><td>⇧Enter</td></tr><tr><td>Copy selected content</td><td>Ctrl+C</td><td>⌘C</td></tr><tr><td>Paste content</td><td>Ctrl+V</td><td>⌘V</td></tr><tr><td>Paste content as plain text</td><td>Ctrl+Shift+V</td><td>⌘⇧V</td></tr><tr><td>Undo</td><td>Ctrl+Z</td><td>⌘Z</td></tr><tr><td>Redo</td><td>Ctrl+Y, Ctrl+Shift+Z</td><td>⌘Y, ⌘⇧Z</td></tr><tr><td>Bold text</td><td>Ctrl+B</td><td>⌘B</td></tr><tr><td>Change text case</td><td>Shift+F3</td><td>⇧F3 (may require Fn)</td></tr><tr><td>Create link</td><td>Ctrl+K</td><td>⌘K</td></tr><tr><td>Move out of a link</td><td>←←, →→</td><td></td></tr><tr><td>Move out of an inline code style</td><td>←←, →→</td><td></td></tr><tr><td>Select all</td><td>Ctrl+A</td><td>⌘A</td></tr><tr><td>Find in the document</td><td>Ctrl+F</td><td>⌘F</td></tr><tr><td>Copy text formatting</td><td>Ctrl+Shift+C</td><td>⌘⇧C</td></tr><tr><td>Paste text formatting</td><td>Ctrl+Shift+V</td><td>⌘⇧V</td></tr><tr><td>Italic text</td><td>Ctrl+I</td><td>⌘I</td></tr><tr><td>Strikethrough text</td><td>Ctrl+Shift+X</td><td>⌘⇧X</td></tr><tr><td>Underline text</td><td>Ctrl+U</td><td>⌘U</td></tr><tr><td>Revert autoformatting action</td><td>Backspace</td><td></td></tr></tbody></table></figure><h3>Interacting with blocks</h3><p>Blocks are images, tables, blockquotes, annotations.</p><figure class=\"table\"><table><thead><tr><th>Action</th><th>PC</th><th>Mac</th></tr></thead><tbody><tr><td>Insert a new paragraph directly after a widget</td><td>Enter</td><td></td></tr><tr><td>Insert a new paragraph directly before a widget</td><td>Shift+Enter</td><td>⇧Enter</td></tr><tr><td>Move the caret to allow typing directly before a widget</td><td>↑, ←</td><td></td></tr><tr><td>Move the caret to allow typing directly after a widget</td><td>↓, →</td><td></td></tr><tr><td>After entering a nested editable, move the selection to the closest ancestor widget. For example: move from an image caption to the whole image widget.</td><td>Tab then Esc</td><td></td></tr></tbody></table></figure><p>Specifically for lists:</p><figure class=\"table\"><table><thead><tr><th>Action</th><th>PC</th><th>Mac</th></tr></thead><tbody><tr><td>Increase list item indent</td><td>⇥</td><td></td></tr><tr><td>Decrease list item indent</td><td>Shift+⇥</td><td>⇧⇥</td></tr></tbody></table></figure><p>In tables:</p><figure class=\"table\"><table><thead><tr><th>Action</th><th>PC</th><th>Mac</th></tr></thead><tbody><tr><td>Move the selection to the next cell</td><td>⇥</td><td></td></tr><tr><td>Move the selection to the previous cell</td><td>Shift+⇥</td><td>⇧⇥</td></tr><tr><td>Insert a new table row (when in the last cell of a table)</td><td>⇥</td><td></td></tr><tr><td>Navigate through the table</td><td>↑, →, ↓, ←</td><td></td></tr></tbody></table></figure><h3>General UI shortcuts</h3><figure class=\"table\"><table><thead><tr><th>Action</th><th>PC</th><th>Mac</th></tr></thead><tbody><tr><td>Close contextual balloons, dropdowns, and dialogs</td><td>Esc</td><td></td></tr><tr><td>Open the accessibility help dialog</td><td>Alt+0</td><td>⌥0</td></tr><tr><td>Move focus between form fields (inputs, buttons, etc.)</td><td>⇥, Shift+⇥</td><td>⇥, ⇧⇥</td></tr><tr><td>Move focus to the toolbar, navigate between toolbars</td><td>Alt+F10</td><td>⌥F10 (may require Fn)</td></tr><tr><td>Navigate through the toolbar or menu bar</td><td>↑, →, ↓, ←</td><td></td></tr><tr><td>Navigate to the next focusable field or an element outside the editor</td><td>Tab, Shift+Tab</td><td></td></tr><tr><td>Execute the currently focused button. Executing buttons that interact with the editor content moves the focus back to the content.</td><td>Enter, Space</td><td></td></tr><tr><td>Move focus in and out of an active dialog window</td><td>Ctrl+F6</td><td>⌘F6 (may require Fn)</td></tr></tbody></table></figure>",
++ "_help_UmgZAfcltxkS": "<p>Link previews turn a pasted URL into a rich, metadata-aware widget that can be displayed in three visual modes:</p><h2>Display modes</h2><p>A link preview can be displayed in one of three modes:</p><ul><li><strong>Inline</strong> — a link showing the site's favicon and page title (quite similar to&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>). Use this when you want the link to flow with the surrounding paragraph.</li><li><strong>Card</strong> — a block-level preview with thumbnail, title, description, and site name. Use this when the link is the focus of a paragraph.</li><li><strong>Embed</strong> — a block-level interactive embed.<ul><li>Currently supported for YouTube videos, which render interactively (via an <code>iframe</code>).</li><li>To prevent unwanted remote requests, the video is shown only after clicking on it first.</li></ul></li></ul><div class=\"trilium-multicolumn-layout\" data-trilium-column-ratios=\"1-1-1\"><div class=\"trilium-multicolumn-column\"><figure class=\"image image_resized\" style=\"width:100%;\"><img style=\"aspect-ratio:251/42;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Link%20Previews_image.png\" width=\"251\" height=\"42\"><figcaption><em>Inline</em> link preview</figcaption></figure></div><div class=\"trilium-multicolumn-column\"><figure class=\"image image_resized\" style=\"width:100%;\"><img style=\"aspect-ratio:1217/196;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/2_Link%20Previews_image.png\" width=\"1217\" height=\"196\"><figcaption><em>Card</em> link preview</figcaption></figure></div><div class=\"trilium-multicolumn-column\"><figure class=\"image image_resized\" style=\"width:100%;\"><img style=\"aspect-ratio:994/563;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Link%20Previews_image.png\" width=\"994\" height=\"563\"><figcaption><em>Embed</em> link preview</figcaption></figure></div></div><h2>Inserting a link preview</h2><p>There are three ways to create one:</p><h3>1. By pasting a URL</h3><p>A link preview is automatically created:</p><ul><li>By pasting the URL and pressing <kbd>Space</kbd>. This will create an <em>inline</em> link preview.</li><li>When at the start of a new paragraph, pressing <kbd>Enter</kbd> will create a <em>card</em> or an <em>embed</em> for YouTube URLs.</li></ul><p>To undo an automatic link preview, press <kbd>Ctrl</kbd>+<kbd>Z</kbd> immediately afterwards which keeps it as a plain link instead. Alternatively, once a link preview was created, click on the link and select <em>Plain link</em> from the link preview toolbar.</p><p>This automatic conversion can be disabled by going to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Text Notes</em> and unchecking <em>Autogenerate link previews</em> from the <em>Features</em> section.</p><p>If the link is not accessible to the Trilium server (or the network request fails for any other reason), it will not be converted to a link preview.</p><aside class=\"admonition note\"><p>A URL is only auto-converted when the pasted text <em>is</em> the URL. Links with a display name (e.g. <a href=\"https://triliumnotes.org\">Trilium Notes website</a>) are left as plain links.</p></aside><h3>2. By using the \"Link preview\" toolbar button</h3><p>Click <em>Link preview</em> (<span class=\"tn-icon cke cke-trilium-link-preview\"></span>) in the formatting toolbar to open the <em>Link preview</em> popup. Paste the URL and choose the type of preview.</p><h3>3. By saving browser tabs from the Web Clipper</h3><p>When the&nbsp;<a class=\"reference-link\" href=\"#root/_help_MtPxeAWVAzMg\">Web Clipper</a>&nbsp;saves the tabs of a window, each tab becomes an <em>inline</em> link preview showing the title and favicon the browser displays for it. Because this data comes from the browser, pages behind a login keep their real title, and the Trilium server does not contact the saved pages.</p><p>When <em>Autogenerate link previews</em> is turned off, the tabs are saved as a list of plain links instead.</p><h2>Altering an existing link preview</h2><p>Click on an inserted link preview to select it, and a small toolbar will appear with the following options:</p><ul><li>The normal link operations (opening in a new tab, copying the link, unlinking).</li><li>A button to edit the title of the link preview. This is especially useful if the title is hidden behind a login screen.</li><li>A way to switch between the link preview modes (Inline, Card or Embed) as well as to convert it to a normal link instead.<ul><li>The Embed option is only enabled when the URL points to a supported service (YouTube today).</li></ul></li></ul><h2>Where the preview data comes from</h2><p>When you insert a link preview, Trilium fetches metadata once and stores it inside the note's HTML:</p><ul><li><strong>YouTube URLs</strong> — title, channel name, and thumbnail are fetched via YouTube's public oEmbed endpoint.</li><li><strong>All other URLs</strong> — Trilium fetches the page and reads OpenGraph tags (<code>og:title</code>, <code>og:description</code>, <code>og:image</code>, <code>og:site_name</code>), falling back to the page's <code>&lt;title&gt;</code> and <code>&lt;meta name=\"description\"&gt;</code>. The site's favicon is downloaded and inlined.</li></ul><p>Because the data is stored in the note itself, link previews continue to render correctly when you reopen the note, share/publish it, or export to HTML — without any further network requests.</p><p>The metadata is captured <strong>at insertion time</strong> and is not automatically refreshed. If the linked page later changes its title or thumbnail, you'll need to re-insert the link to pick up the new values. To refresh a link, simply create it again.</p><p>When accessing a&nbsp;<a class=\"reference-link\" href=\"#root/_help_WOcw2SLH6tbX\">Server Installation</a>, the data is fetched from the remote URL by the server and not the client.</p><h2>Known limitations</h2><ul><li>The Embed display mode currently only supports YouTube. Other video and media platforms fall back to a Card preview.</li><li>Pages that block automated fetches may produce a minimal preview (hostname only).</li><li>Link previews require the Trilium server to reach the target URL, so they won't generate previews for pages on networks the server can't see.</li></ul>",
+ "_help_QEAPj01N5f7w": "<p>There are two types of links:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_3IDVtesTQ8ds\">External links</a>, for standard hyperlinks to websites or other resources.</li><li><a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;for links to other notes within Trilium.<ul><li>The list of notes that refer to a particular note is called&nbsp;<a class=\"reference-link\" href=\"#root/_help_wfGXLmm7x27z\">Backlinks</a>.</li></ul></li></ul><h2>Note map</h2><p>Trilium provides a visualization of incoming and outgoing links for a particular note. See <a href=\"#root/_help_BCkXAVs63Ttv\">note map</a> for details.</p>",
- "_help_3IDVtesTQ8ds": "<p>An external link is a standard web link targeting for example a website. For example, <a href=\"https://en.wikipedia.org/wiki/South_China_Sea\">https://en.wikipedia.org/wiki/South_China_Sea</a> is an external link to a Wikipedia page.</p><p>To create a link without a custom text:</p><ul><li>Press <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Links/1_External%20links_image.png\" width=\"15\" height=\"16\"> in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>:<ul><li>A popup will appear, type or paste the URL in the box.</li><li>Press <kbd>Enter</kbd> or the check mark icon to confirm.</li></ul></li><li>Alternatively, press <kbd>Ctrl</kbd>+<kbd>K</kbd> to trigger the aforementioned popup.</li><li>A simpler way is to paste the raw link and press space to turn it automatically into a link.</li></ul><p>To create a link with a custom text:</p><ul><li>First, type and select the text which will be turned into a link.</li><li>Follow the previous steps to open the link interface (via the formatting toolbar, or <kbd>Ctrl</kbd>+<kbd>K</kbd>).</li><li>Alternatively, simply paste (<kbd>Ctrl</kbd>+<kbd>V</kbd>) over the selected text to turn it into a link.</li></ul><p>Once a link is inserted:</p><ul><li>The text inside the link can be changed if needed but the link itself will remain.</li><li>To modify the link, click on the link to display the popup and press the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Links/External%20links_image.png\" width=\"18\" height=\"18\"> <em>Edit link</em> button.</li><li>To remove a link, click on it and press the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Links/2_External%20links_image.png\" width=\"18\" height=\"18\"> <em>Unlink</em> button.</li></ul><p>You can follow external link by either double clicking (will open new tab/window) it or right clicking on them and choosing \"Open in new tab\".</p>",
- "_help_hrZ1D00cLbal": "<p>Internal links are links to other notes within Trilium.</p><p>You can open an internal link by clicking it. You can also see a read-only preview of an internal link's contents by hovering over it.</p><h2>Inserting internal links</h2><p>Internal links can be created at the current position in a text note by:</p><ol><li>Pressing <kbd>Ctrl</kbd> + <kbd>L</kbd> or the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Links/Internal%20(reference)%20links_image.png\" width=\"20\" height=\"17\"> button underneath the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Links/1_Internal%20(reference)%20links_image.png\" width=\"34\" height=\"16\"> menu in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>.</li><li>Searching for the title of the desired note to link. It's also possible to create new notes from this dialog by typing a non-existing note title and selecting <em>Create and link child note</em>.</li></ol><p>There are two link types which you can select when creating the link to the note:</p><ol><li><em>Link title mirrors the note's current title</em><ol><li>This is sometimes also called \"reference link\".</li><li>The title of this link cannot be changed. Instead, it will always show the current title of the linked note.</li><li>The icon of the linked note will also be displayed.</li></ol></li><li><em>Link title can be changed arbitrarily</em><ol><li>This will create a traditional hyperlink, where the text of the link can be different from the note title.</li></ol></li></ol><h2>In-place linking</h2><p>You can also insert internal links “inline” by using the <code spellcheck=\"false\">@</code> symbol:</p><ol><li>Type <code spellcheck=\"false\">@</code> in a text note, which will open the note search menu.</li><li>Search for the desired note's title by typing a few characters. Use <kbd>Up</kbd> and <kbd>Down</kbd> to select the correct note, and press <kbd>Enter</kbd> or <kbd>Tab</kbd> to create the link. It's also possible to create new notes with this method by typing a non-existing note title and selecting <em>Create and link child note</em>.</li></ol><h2>Pasting internal links</h2><p>You can also insert internal links by copying a note from the note tree.</p><ol><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, select a note and press <kbd>Ctrl</kbd> + <kbd>C</kbd>.</li><li>In a text note, paste the link by pressing <kbd>Ctrl</kbd> + <kbd>V</kbd>.</li></ol>",
- "_help_wfGXLmm7x27z": "<p>A link points from one note to another; a <em>backlink</em> is that same connection seen from the other end: the list of notes that refer to the current one.</p><p>Backlinks are maintained automatically and are read-only from this side. A backlink disappears when the note that created it removes the link; it cannot be deleted from the note being pointed at.</p><h2>What counts as a backlink</h2><p>Any&nbsp;r<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;pointing at the current note, which covers two rather different cases:</p><ul><li>Relations that Trilium maintains on your behalf.<ul><li>The most common is <code spellcheck=\"false\">internalLink</code>, created whenever a note refers to another one through&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;in its text.</li><li>Embedded images (<code spellcheck=\"false\">imageLink</code>), relation map connections (<code spellcheck=\"false\">relationMapLink</code>) and note inclusions (<code spellcheck=\"false\">includeNoteLink</code>) work the same way.</li></ul></li><li>Relations you define yourself.<ul><li>If another note carries <code spellcheck=\"false\">~author</code> pointing at the current note, that note is listed here as well.</li></ul></li></ul><p>Relations coming from a&nbsp;<a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a>&nbsp;are excluded, since a search stores an <code spellcheck=\"false\">ancestor</code> relation that would otherwise list every one of its results as a backlink.</p><aside class=\"admonition note\"><p>Only some note types have their content scanned for links:&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>,&nbsp;<a class=\"reference-link\" href=\"#root/_help_6RM1Q7ppFVoj\">Markdown</a>,&nbsp;<a class=\"reference-link\" href=\"#root/_help_iRwzGnHPzonm\">Relation Map</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_GBBMSlVSOIGP\">AI</a>&nbsp;chats. A link written inside a&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note is not registered and will not appear as a backlink on the target note. A relation set manually on a code note does still count.</p></aside><h2>How entries are displayed</h2><p>Each entry names the note the reference comes from, followed by one of:</p><ul><li><strong>An excerpt</strong> of the surrounding content, with the link itself highlighted. This is available for&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes and for&nbsp;<a class=\"reference-link\" href=\"#root/_help_GBBMSlVSOIGP\">AI</a>&nbsp;chat notes. Roughly 200 characters of context are quoted around the link, trimmed with an ellipsis where the surrounding text is longer, and images are left out.</li><li><strong>The name of the relation</strong>, for every other note type where the source cannot be quoted. This is the case for&nbsp;<a class=\"reference-link\" href=\"#root/_help_iRwzGnHPzonm\">Relation Map</a>&nbsp;notes and for any note carrying a relation you defined yourself.</li></ul><p>A note is listed once per reference it makes, so a note that links to the current one three times occupies three rows.</p><p>Of note:</p><ul><li>For AI chat notes, only the assistant's own prose is quoted. A chat that reached the note purely through tool calls has nothing to quote and is listed by relation name instead.</li><li>Excerpts are only generated for roughly the first 50 sources. On a heavily referenced note, the remaining entries fall back to showing the relation name.</li></ul><h2>Where backlinks are shown</h2><ul><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_KRlZFoIH0j6p\">Connections tab</a>&nbsp;of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>, as a dedicated section.</li><li>As a badge in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlJ73vBCjWDw\">Status bar</a>&nbsp;showing the number of backlinks. The badge only appears when the note is being read normally (not in a revision or attachment view) and when there is at least one backlink; pressing it opens the section above.</li><li>Incoming links are also drawn on the link map, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_BCkXAVs63Ttv\">Note Map (Link map, Tree map)</a>.</li><li>On the old layout, backlinks are showed as a dedicated button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_XpOYSgsLkTJy\">Floating buttons</a>&nbsp;area.</li></ul>",
- "_help_S6Xx8QIWTV66": "<p>There are three types of lists supported by text notes:</p><ul><li><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/3_Lists_image.png\" width=\"17\" height=\"13\"> Bulleted lists (also known as unordered lists).</li><li><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Lists_image.png\" width=\"18\" height=\"16\"> Numbered lists (or ordered lists).</li><li><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Lists_image.png\" width=\"19\" height=\"13\"> To-do lists</li></ul><p>For bulleted and numbered lists, it's possible to configure an alternative marker such as squares or Roman numbering by pressing the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/2_Lists_image.png\" width=\"10\" height=\"6\"> icon. For numbered lists, it's also possible to specify the number to start at or whether to count in reverse order.</p><h2>Keyboard interaction</h2><ul><li>To create a new list:<ul><li>Bulleted list: Start a line with <code spellcheck=\"false\">*</code> or <code spellcheck=\"false\">-</code> followed by a space;</li><li>Numbered list: Start a line with <code spellcheck=\"false\">1.</code> or <code spellcheck=\"false\">1)</code> followed by a space;</li><li>To-do list: Start a line with <code spellcheck=\"false\">- [ ]</code> for an unchecked item or <code spellcheck=\"false\">[x]</code> for a checked item.</li></ul></li><li>To create a new item in the list, press <kbd>Enter</kbd>.</li><li>To create a blank line within a list item, press <kbd>Shift</kbd>+<kbd>Enter</kbd>.</li><li>To exit out of the list, press <kbd>Enter</kbd> twice.</li><li>To merge two lists, simply delete the gap between them.</li><li>To create nested lists, simply use the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/4_Lists_image.png\" width=\"17\" height=\"14\"> button (see <em>Indentation</em> in&nbsp;<a class=\"reference-link\" href=\"#root/_help_dEHYtoWWi8ct\">Other features</a>) or the <kbd>Tab</kbd> key. To decrease the nesting level for the current element, press <kbd>Shift</kbd>+<kbd>Tab</kbd>.</li></ul><h2>Headings, code blocks within lists</h2><p>It possible to add content-level blocks such as headings, code blocks, tables within lists, as follows:</p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th></th>\n<th></th>\n<th></th>\n</tr>\n</thead>\n<tbody><tr>\n<td>1</td>\n<td><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/2_Lists_image.jpg\"></td>\n<td>First, create a list.</td>\n</tr>\n<tr>\n<td>2</td>\n<td><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/4_Lists_image.jpg\"></td>\n<td>Press Enter to create a new list item.</td>\n</tr>\n<tr>\n<td>3</td>\n<td><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Lists_image.jpg\"></td>\n<td>Press Backspace to get rid of the bullet point. Notice the cursor position.</td>\n</tr>\n<tr>\n<td>4</td>\n<td><img class=\"image_resized\" style=\"aspect-ratio:676/112;width:98.29%;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/5_Lists_image.jpg\" width=\"676\" height=\"112\"></td>\n<td>At this point, insert any desired block-level item such as a code block.</td>\n</tr>\n<tr>\n<td>5</td>\n<td><img class=\"image_resized\" style=\"aspect-ratio:675/129;width:94.22%;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/3_Lists_image.jpg\" width=\"675\" height=\"129\"></td>\n<td>To continue with a new bullet point, press Enter until the cursor moves to a new blank position.</td>\n</tr>\n<tr>\n<td>6</td>\n<td><img class=\"image_resized\" style=\"aspect-ratio:675/129;width:100%;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Lists_image.jpg\" width=\"675\" height=\"129\"></td>\n<td>Press Enter once more to create the new bullet.</td>\n</tr>\n</tbody></table></figure><p>The same principle applies to all three list types (bullet, numbered and to-do).</p><h2>To-do lists</h2><p>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_fASfBrYnquKU\">To-do Lists</a>.</p><h2>Collapsible lists</h2><p>Starting with Trilium v0.104.0, it is possible to collapse nested list items. This applies to bullet lists, numbered lists as well as to-do lists.</p><p>To collapse or expand a list item that has nested sub-items:</p><ul><li>Using the mouse, move the cursor over the list item and an arrow will appear to its left. Clicking it will toggle between collapsed and expanded.</li><li>For bullet lists and numbered lists, it's also possible to click directly on the marker (e.g. the bullet or the number) instead of on the arrow to collapse or expand it. This won't work for to-do lists since this would toggle the to-do instead.</li><li>Press <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Enter</kbd> which will toggle the collapse/expand state for the item at the cursor position.</li></ul><p>Of note:</p><ul><li>Collapsed items always show the arrow to indicate its state.</li><li>The collapsed state is saved at note level and synced across instances, which means that it will restore after a refresh or reopening of the application.</li><li>The collapsed state is also persisted in&nbsp;<a class=\"reference-link\" href=\"#root/_help_mHbBMPDPkVV5\">Import &amp; Export</a>, but only for the HTML format. Markdown exports will not preserve the collapse state.</li><li>Collapsible bullets only exist in the context of editable text notes. Read-only lists will always be fully expanded.</li><li>The list items will auto-expand on edit to avoid typing in a hidden area.</li></ul>",
- "_help_QrtTYPmdd1qq": "<p>Markdown-like formatting allows inserting some basic formatting by typing the Markdown equivalent. Note that this does not mean that&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes supports Markdown, these are just some convenience shortcuts.</p><p>To import more complex formatting into text notes, consider using the <a href=\"#root/_help_dEHYtoWWi8ct\"><em>Import from Markdown</em></a> function. For fully-fleged Markdown notes imports, consider using the dedicated <a href=\"#root/_help_Oau6X9rCuegd\">import</a> function.</p><ul><li>For <a href=\"#root/_help_Gr6xFaF6ioJ5\">headings:</a><ul><li><code spellcheck=\"false\">##</code> for Heading 2 (the first-level heading is reserved for the note title).</li><li><code spellcheck=\"false\">###</code> for Heading 3</li><li><code spellcheck=\"false\">####</code> for Heading 4</li><li><code spellcheck=\"false\">#####</code> for Heading 5</li><li><code spellcheck=\"false\">######</code> for Heading 6</li></ul></li><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_Gr6xFaF6ioJ5\">General formatting</a>:<ul><li><strong>Bold</strong>: Type <code spellcheck=\"false\">**text**</code> or <code spellcheck=\"false\">__text__</code></li><li><em>Italic</em>: Type <code spellcheck=\"false\">*text*</code> or <code spellcheck=\"false\">_text_</code></li><li><del>Strikethrough</del>: Type <code spellcheck=\"false\">~~text~~</code></li></ul></li><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_S6Xx8QIWTV66\">Lists</a>:<ul><li>Bulleted list: Start a line with <code spellcheck=\"false\">*</code> or <code spellcheck=\"false\">-</code> followed by a space;</li><li>Numbered list: Start a line with <code spellcheck=\"false\">1.</code> or <code spellcheck=\"false\">1)</code> followed by a space;</li><li>To-do list: Start a line with <code spellcheck=\"false\">[ ]</code> for an unchecked item or <code spellcheck=\"false\">[x]</code> for a checked item.</li></ul></li><li>For <a href=\"#root/_help_NwBbFdNZ9h7O\">block quotes</a>, press <code spellcheck=\"false\">&gt;</code>, followed by a space.</li><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_QxEyIjRBizuC\">Code blocks</a>, type <code spellcheck=\"false\">```</code>.</li><li>For a <a href=\"#root/_help_dEHYtoWWi8ct\">horizontal line</a>, type <code spellcheck=\"false\">---</code>.</li><li>For <a href=\"#root/_help_NwBbFdNZ9h7O\">admonitions</a>:<ul><li><code spellcheck=\"false\">!!! note</code></li><li><code spellcheck=\"false\">!!! tip</code></li><li><code spellcheck=\"false\">!!! important</code></li><li><code spellcheck=\"false\">!!! caution</code></li><li><code spellcheck=\"false\">!!! warning</code></li><li>Starting any other text with <code spellcheck=\"false\">!!!</code> will insert a note admonition with the text inside of it.</li></ul></li><li>For <a href=\"#root/_help_CohkqWQC1iBv\">emojis</a>, type <code spellcheck=\"false\">:</code> followed by an emoji name to trigger an auto-completion.</li></ul><p>If auto-formatting is not desirable, press <kbd>Ctrl</kbd> + <kbd>Z</kbd> to revert the text to its original form.</p>",
- "_help_YfYAtQBcfo5V": "<figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:350/193;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Math%20Equations_image.png\" width=\"350\" height=\"193\"></figure><p>Within text notes, it's possible to enter mathematical equations using the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Math%20Equations_image.png\" width=\"20\" height=\"15\"> button from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>&nbsp;(generally found under the&nbsp;<a class=\"reference-link\" href=\"#root/_help_CohkqWQC1iBv\">Insert buttons</a>).</p><p>The mathematical expression must be written in the TeX format. There is no visual editor for the math equations, only a preview.&nbsp;</p><p>Enabling <em>Display mode</em> will render the equation slightly bigger (especially if using big operators such as summation, or fractions) and center it. Display mode equations will act as blocks (i.e. like paragraphs, or tables) and can be inserted for example in lists. Non-display equations can be part of the text.</p><h2>Keyboard shortcuts</h2><p>If inserting equations frequently, using the <kbd>Ctrl</kbd>+<kbd>M</kbd> keyboard shortcut can be more comfortable. Alternatively, type <code spellcheck=\"false\">$$</code> or <code spellcheck=\"false\">\\[</code> to trigger the popup directly.</p><p>There is currently no quick way to turn an already typed-out equation, such as surrounding it with <code spellcheck=\"false\">$</code> or pressing <kbd>Ctrl</kbd>+<kbd>M</kbd>.</p><h2>Supported math features</h2><p>Technically we are using the KaTeX library which allows for a subset of the TeX format. To see the full list of supported features, consult the <a href=\"https://katex.org/docs/supported\">Supported Functions</a> and the <a href=\"https://katex.org/docs/support_table\">Support Table</a> from the official documentation.</p><h2>Markdown support</h2><p>Math equations will be preserved when exporting to or importing from Markdown, surrounded by <code spellcheck=\"false\">$</code> characters for inline math expressions, and <code spellcheck=\"false\">$$</code> for display mode.</p><p>If you notice any issue with the Markdown import/export for equations, feel free to <a href=\"#root/_help_wy8So3yZZlH9\">report</a> it while providing the equation that causes issues.</p><h2>Formatting the equation</h2><p>It is possible to customize the font size and foreground color for both inline and display-mode equations, just like any other text. For inline equations, the background color/highlight can also be adjusted.</p>",
- "_help_dEHYtoWWi8ct": "<h2>Indentation</h2><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:201/124;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/6_Other%20features_image.png\" width=\"201\" height=\"124\"></figure><p>Paragraphs can be indented to the right using the &nbsp;button from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>.</p><ul><li>Press <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/5_Other%20features_image.png\" width=\"17\" height=\"14\"> to increase the indentation of the current paragraph by one. Can be pressed multiple times if needed.</li><li>Press <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Other%20features_image.png\" width=\"17\" height=\"14\"> to decrease the indentation of a current paragraph. The button will be disabled if it is already at the minimum indentation level.</li><li>For convenience, keyboard shortcuts are also available. Press <kbd>Tab</kbd> to indent or <kbd>Shift</kbd>+<kbd>Tab</kbd> to decrease the indentation. These shortcuts work even if the cursor is not at the beginning of a paragraph or a list.</li><li>Apart from paragraphs, the indent button is also enabled in&nbsp;<a class=\"reference-link\" href=\"#root/_help_S6Xx8QIWTV66\">Lists</a>, where it can be used to create nested lists.</li></ul><h2>Markdown import</h2><p>If the clipboard contains Markdown text, it can be easily imported into text notes. Simply copy a Markdown-formatted text and press the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/2_Other%20features_image.png\" width=\"20\" height=\"14\"> to insert its visual representation.</p><p>Note that this only works with raw Markdown (e.g. <code spellcheck=\"false\"># Heading 1</code> to generate a heading) and not the visual representation of the Markdown (e.g. as in the preview pane of an application). In that case, simply use the paste function which already accepts HTML-formatted content.</p><p>This is mostly useful for snippets of text, for entire Markdown documents use the dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_Oau6X9rCuegd\">Markdown</a>&nbsp;import/export function.</p><p>If accessing Trilium with a web browser, the Markdown import action will ask for the content to be inserted into a dedicated screen since it does not have access to the clipboard.</p><h2>Cut to subnote</h2><p>The <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Other%20features_image.png\" width=\"16\" height=\"20\"> button will create a child note with the selected text. For more information, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_2x0ZAX9ePtzV\">Cut to subnote</a>.</p><h2>Find and replace</h2><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:394/203;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/4_Other%20features_image.png\" width=\"394\" height=\"203\"></figure><p>The <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/3_Other%20features_image.png\" width=\"18\" height=\"17\"> button will open the editor's dedicated search and replace functionality.</p><p>Alternatively, the <kbd>Ctrl</kbd>+<kbd>F</kbd> combination can be pressed to show the dialog.</p>",
- "_help_gLt3vA97tMcp": "<p>The text editor we are using for&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes is called CKEditor and it's a commercial product. The core components are open-source, however they <a href=\"https://ckeditor.com/docs/trial/latest/index.html\">offer quite a few features</a> that require a commercial license in order to be used.</p><p>We have reached out to the CKEditor team in order to obtain a license in order to have some of these extra features and they have agreed, based on a signed agreement.</p><aside class=\"admonition note\"><p>Since v0.105.0, all premium features were replaced with plugins written specifically for for Trilium, from scratch and under an AGPL license.</p><p>The premium features used to be:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_ZlN4nump6EbW\">Slash Commands</a></li><li><a class=\"reference-link\" href=\"#root/_help_pwc194wlRzcH\">Text Snippets</a></li><li><a class=\"reference-link\" href=\"#root/_help_5wZallV2Qo1t\">Format Painter</a></li></ul></aside>",
- "_help_ZlN4nump6EbW": "<figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:419/571;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Slash%20Commands_image.png\" width=\"419\" height=\"571\"></figure><p>Slash commands is a feature of&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes which allows easily accessing commonly used commands simply by using the keyboard, without having to remember dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_A9Oc6YKKc65v\">Keyboard Shortcuts</a>.</p><h2>Interaction</h2><ul><li>As the name suggests, to trigger the slash commands simply press the <kbd>/</kbd> key to trigger it. Note that this can be anywhere in a paragraph as long as it's not part of the word, if it doesn't show up simply press a space and press the <kbd>/</kbd> key again.</li><li>Use <kbd>↑</kbd> and <kbd>↓</kbd> keys to navigate between options.</li><li>By default, the full list of commands is displayed.</li><li>To search by title or description, simply start typing for an action.</li><li>To trigger an action, press the <kbd>Enter</kbd> key.</li></ul><h2>Integration with other features</h2><p>Apart from the common set of commands, some features are specially integrated with the slash commands:</p><ul><li>For <a href=\"#root/_help_NwBbFdNZ9h7O\">admonitions</a>, each admonition type (e.g. note, tip) will be individually displayed.</li><li>Every&nbsp;<a class=\"reference-link\" href=\"#root/_help_pwc194wlRzcH\">Text Snippets</a>&nbsp;will also appear individually, making it easy to insert them.</li></ul>",
- "_help_oBo3iHIZnbG2": "<p>Trilium supports spell checking for your notes. How it works depends on whether you're using the <strong>desktop application</strong> (Electron) or accessing Trilium through a <strong>web browser</strong>.</p><h2>Desktop</h2><p>The desktop app uses Chromium's built-in spellchecker. You can configure it from <em>Options</em> → <em>Spell Check</em>.</p><h3>Enabling spell check</h3><p>Toggle <em>Check spelling</em> to enable or disable the spellchecker. A restart is required for changes to take effect — use the restart button at the bottom of the section.</p><h3>Choosing languages</h3><p>When spell check is enabled, a <em>Spell Check Languages</em> section appears listing all languages available on your system. Select one or more languages by checking the boxes. The spellchecker will accept words that are valid in <em>any</em> of the selected languages.</p><p>The available languages depend on your operating system's installed language packs. For example, on Windows you can add languages through <em>Options</em> → <em>Time &amp; Language</em> → <em>Language &amp; Region</em> → <em>Add a language</em>.</p><aside class=\"admonition note\"><p>The changes take effect only after restarting the application.</p></aside><h3>Custom dictionary</h3><aside class=\"admonition tip\"><p>This function is available starting with Trilium v0.103.0.</p></aside><p>Words you add to the dictionary (e.g. via the right-click context menu → \"Add to dictionary\") are stored in a <strong>synced note</strong> inside Trilium. This means your custom dictionary automatically syncs across all your devices.</p><p>You can view and edit the dictionary directly from <em>Settings</em> → <em>Spell Check</em> → <em>Custom Dictionary</em> → <em>Edit dictionary</em>. This opens the underlying note, which contains one word per line. You can add, remove, or modify entries as you like.</p><aside class=\"admonition note\"><p>Changes to the custom dictionary (whether from the editor or the context menu) take effect after restarting the application.</p></aside><h4>How the custom dictionary works</h4><ul><li>When you right-click a misspelled word and choose \"Add to dictionary\", the word is saved both to Electron's local spellchecker and to the synced dictionary note.</li><li>On startup, Trilium loads all words from the dictionary note into the spellchecker session.</li><li>If Trilium detects words in Electron's local dictionary but the dictionary note is empty (e.g. on first use), it performs a <strong>one-time import</strong> of those words into the note.</li><li>Words that are in Electron's local dictionary but <em>not</em> in the note (e.g. you removed them manually) are cleaned up from the local dictionary on startup.</li></ul><h4>Known limitations</h4><p>On Windows and macOS, Electron delegates \"Add to dictionary\" to the operating system's user dictionary. This means:</p><ul><li>Words added via the context menu are also written to the OS-level dictionary (e.g. <code spellcheck=\"false\">%APPDATA%\\Microsoft\\Spelling\\&lt;language&gt;\\default.dic</code> on Windows).</li><li><strong>Removing a word</strong> from the Trilium dictionary note prevents it from being loaded into the spellchecker on next startup, but does <em>not</em> remove it from the OS dictionary. The word may still be accepted by the OS spellchecker until you remove it from the OS dictionary manually.</li></ul><h2>Web browser</h2><p>When accessing Trilium through a web browser, spell checking is handled entirely by the browser itself. Trilium does not control the browser's spellchecker — language selection, dictionaries, and all other settings are managed through your browser's preferences.</p><p>The Spell Check settings page in Trilium will indicate that these options apply only to desktop builds.</p><h2>Frequently asked questions</h2><h3>Do I need to restart after every change?</h3><p>Yes. Spell check language selection and the custom dictionary are loaded once at startup. Any changes require a restart to take effect.</p><h3>Can I use multiple spell check languages at the same time?</h3><p>Yes. Select as many languages as you need from the checklist. The spellchecker will accept words from any of the selected languages.</p><h3>My custom words disappeared after syncing to a new device — what happened?</h3><p>On the first launch of a new device, Trilium may import existing local dictionary words into the note. If the note already has words from another device (via sync), those are preserved. Make sure sync completes before restarting the application on a new device.</p><h3>I removed a word from the dictionary note but it's still accepted</h3><p>This is likely due to the OS-level dictionary retaining the word (see <a href=\"#known-limitations\">Known limitations</a> above). You can manually remove it from your operating system's user dictionary.</p>",
++ "_help_3IDVtesTQ8ds": "<p>An external link is a standard web link targeting for example a website. For example, <a href=\"https://en.wikipedia.org/wiki/South_China_Sea\">https://en.wikipedia.org/wiki/South_China_Sea</a> is an external link to a Wikipedia page.</p><p>To create a link without a custom text:</p><ul><li>Press&nbsp;<span class=\"tn-icon cke cke-link\"></span> in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>:<ul><li>A popup will appear, type or paste the URL in the box.</li><li>Press <kbd>Enter</kbd> or the check mark icon to confirm.</li></ul></li><li>Alternatively, press <kbd>Ctrl</kbd>+<kbd>K</kbd> to trigger the aforementioned popup.</li><li>A simpler way is to paste the raw link and press space to turn it automatically into a link.</li></ul><p>To create a link with a custom text:</p><ul><li>First, type and select the text which will be turned into a link.</li><li>Follow the previous steps to open the link interface (via the formatting toolbar, or <kbd>Ctrl</kbd>+<kbd>K</kbd>).</li><li>Alternatively, simply paste (<kbd>Ctrl</kbd>+<kbd>V</kbd>) over the selected text to turn it into a link.</li></ul><p>Once a link is inserted:</p><ul><li>The text inside the link can be changed if needed but the link itself will remain.</li><li>To modify the link, click on the link to display the popup and press the&nbsp;<span class=\"tn-icon cke cke-pencil\"></span> <em>Edit link</em> button.</li><li>To remove a link, click on it and press the&nbsp;<span class=\"tn-icon cke cke-unlink\"></span> <em>Unlink</em> button.</li></ul><p>You can follow external link by either double clicking (will open new tab/window) it or right clicking on them and choosing \"Open in new tab\".</p>",
++ "_help_hrZ1D00cLbal": "<p>Internal links are links to other notes within Trilium.</p><p>You can open an internal link by clicking it. You can also see a read-only preview of an internal link's contents by hovering over it.</p><h2>Inserting internal links</h2><p>Internal links can be created at the current position in a text note by:</p><ol><li>Pressing <kbd>Ctrl</kbd> + <kbd>L</kbd> or the&nbsp;<span class=\"tn-icon cke cke-trilium\"></span> button underneath the&nbsp;<span class=\"tn-icon cke cke-plus\"></span> menu in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>.</li><li>Searching for the title of the desired note to link. It's also possible to create new notes from this dialog by typing a non-existing note title and selecting either <em>Create note</em>, which places it in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_S0Fos78ZfcY7\">Note Inbox</a>&nbsp;(today's day note, or the top level, when no inbox is set), or <em>Create child note</em>, which places it under the note being edited.</li></ol><p>There are two link types which you can select when creating the link to the note:</p><ol><li><em>Link title mirrors the note's current title</em><ol><li>This is sometimes also called \"reference link\".</li><li>The title of this link cannot be changed. Instead, it will always show the current title of the linked note.</li><li>The icon of the linked note will also be displayed.</li><li>If the linked note is deleted, the link keeps the last title it showed, in red and with a <span class=\"tn-icon bx bx-x\"></span> icon instead of the note icon. Clicking it while editing opens the <em>Fix link</em> dialog, which searches for that title; picking a note, or creating a new one, replaces the link with one to that note.</li></ol></li><li><em>Link title can be changed arbitrarily</em><ol><li>This will create a traditional hyperlink, where the text of the link can be different from the note title.</li></ol></li></ol><h2>In-place linking</h2><p>You can also insert internal links “inline” by using the <code>@</code> symbol:</p><ol><li>Type <code>@</code> in a text note, which will open the note search menu.</li><li>Search for the desired note's title by typing a few characters. Use <kbd>Up</kbd> and <kbd>Down</kbd> to select the correct note, and press <kbd>Enter</kbd> or <kbd>Tab</kbd> to create the link. It's also possible to create new notes with this method by typing a non-existing note title and selecting <em>Create note</em> or <em>Create child note</em>, as described above.</li></ol><h2>Pasting internal links</h2><p>You can also insert internal links by copying a note from the note tree.</p><ol><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, select a note and press <kbd>Ctrl</kbd> + <kbd>C</kbd>.</li><li>In a text note, paste the link by pressing <kbd>Ctrl</kbd> + <kbd>V</kbd>.</li></ol>",
++ "_help_wfGXLmm7x27z": "<p>A link points from one note to another; a <em>backlink</em> is that same connection seen from the other end: the list of notes that refer to the current one.</p><p>Backlinks are maintained automatically and are read-only from this side. A backlink disappears when the note that created it removes the link; it cannot be deleted from the note being pointed at.</p><h2>What counts as a backlink</h2><p>Any&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;pointing at the current note, which covers two rather different cases:</p><ul><li>Relations that Trilium maintains on your behalf.<ul><li>The most common is <code>internalLink</code>, created whenever a note refers to another one through&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;in its text.</li><li>Embedded images (<code>imageLink</code>), relation map connections (<code>relationMapLink</code>) and note inclusions (<code>includeNoteLink</code>) work the same way.</li></ul></li><li>Relations you define yourself.<ul><li>If another note has <code>~author</code> pointing at the current note, that note is listed here as well.</li></ul></li></ul><p>Relations coming from a&nbsp;<a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a>&nbsp;are excluded, since a search stores an <code>ancestor</code> relation that would otherwise list every one of its results as a backlink.</p><aside class=\"admonition note\"><p>Only some note types have their content scanned for links:&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>,&nbsp;<a class=\"reference-link\" href=\"#root/_help_6RM1Q7ppFVoj\">Markdown</a>,&nbsp;<a class=\"reference-link\" href=\"#root/_help_iRwzGnHPzonm\">Relation Map</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_GBBMSlVSOIGP\">AI</a>&nbsp;chats. A link written inside a&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note is not registered and will not appear as a backlink on the target note. A relation set manually on a code note does still count.</p></aside><h2>How entries are displayed</h2><p>Each entry names the note the reference comes from, followed by one of:</p><ul><li><strong>An excerpt</strong> of the surrounding content, with the link itself highlighted. This is available for&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes and for&nbsp;<a class=\"reference-link\" href=\"#root/_help_GBBMSlVSOIGP\">AI</a>&nbsp;chat notes. Roughly 200 characters of context are quoted around the link, trimmed with an ellipsis where the surrounding text is longer, and images are left out.</li><li><strong>The name of the relation</strong>, for every other note type where the source cannot be quoted. This is the case for&nbsp;<a class=\"reference-link\" href=\"#root/_help_iRwzGnHPzonm\">Relation Map</a>&nbsp;notes and for any note carrying a relation you defined yourself.</li></ul><p>A note is listed once per reference it makes, so a note that links to the current one three times occupies three rows.</p><p>Of note:</p><ul><li>For AI chat notes, only the assistant's own prose is quoted. A chat that reached the note purely through tool calls has nothing to quote and is listed by relation name instead.</li><li>Excerpts are only generated for roughly the first 50 sources. On a heavily referenced note, the remaining entries fall back to showing the relation name.</li></ul><h2>Where backlinks are shown</h2><ul><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_KRlZFoIH0j6p\">Connections tab</a>&nbsp;of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>, as a dedicated section.</li><li>As a badge in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlJ73vBCjWDw\">Status bar</a>&nbsp;showing the number of backlinks. The badge only appears when the note is being read normally (not in a revision or attachment view) and when there is at least one backlink; pressing it opens the section above.</li><li>In&nbsp;<a class=\"reference-link\" href=\"#root/_help_ZjLYv08Rp3qC\">Quick edit</a>, as a button with a link icon in the header of the popup, under the same conditions; its tooltip gives the number of backlinks. Pressing a backlink opens that note in the popup.</li><li>Incoming links are also drawn on the link map, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_BCkXAVs63Ttv\">Note Map (Link map, Tree map)</a>.</li></ul>",
++ "_help_S6Xx8QIWTV66": "<p>There are three types of lists supported by text notes:</p><ul><li><span class=\"tn-icon cke cke-bulleted-list\"></span>&nbsp;Bulleted lists (also known as unordered lists).</li><li><span class=\"tn-icon cke cke-numbered-list\"></span>&nbsp;Numbered lists (or ordered lists).</li><li><span class=\"tn-icon cke cke-todo-list\"></span>&nbsp;To-do lists</li></ul><p>For bulleted and numbered lists, it's possible to configure an alternative marker such as squares or Roman numbering by pressing the&nbsp;<span class=\"tn-icon cke cke-dropdown-arrow\"></span> icon. For numbered lists, it's also possible to specify the number to start at or whether to count in reverse order.</p><h2>Keyboard interaction</h2><ul><li>To create a new list:<ul><li>Bulleted list: Start a line with <code>*</code> or <code>-</code> followed by a space;</li><li>Numbered list: Start a line with <code>1.</code> or <code>1)</code> followed by a space;</li><li>To-do list: Start a line with <code>- [ ]</code> for an unchecked item or <code>[x]</code> for a checked item.</li></ul></li><li>To create a new item in the list, press <kbd>Enter</kbd>.</li><li>To create a blank line within a list item, press <kbd>Shift</kbd>+<kbd>Enter</kbd>.</li><li>To exit out of the list, press <kbd>Enter</kbd> twice.</li><li>To merge two lists, simply delete the gap between them.</li><li>To create nested lists, simply use the&nbsp;<span class=\"tn-icon cke cke-indent\"></span> button (see <em>Indentation</em> in&nbsp;<a class=\"reference-link\" href=\"#root/_help_dEHYtoWWi8ct\">Other features</a>) or the <kbd>Tab</kbd> key. To decrease the nesting level for the current element, press <kbd>Shift</kbd>+<kbd>Tab</kbd>.</li></ul><h2>Headings, code blocks within lists</h2><p>It possible to add content-level blocks such as headings, code blocks, tables within lists, as follows:</p><figure class=\"table\"><table><tbody><tr><td>1</td><td><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/2_Lists_image.jpg\"></td><td>First, create a list.</td></tr><tr><td>2</td><td><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/4_Lists_image.jpg\"></td><td>Press Enter to create a new list item.</td></tr><tr><td>3</td><td><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Lists_image.jpg\"></td><td>Press Backspace to get rid of the bullet point. Notice the cursor position.</td></tr><tr><td>4</td><td><img class=\"image_resized\" style=\"aspect-ratio:676/112;width:98.29%;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/5_Lists_image.jpg\" width=\"676\" height=\"112\"></td><td>At this point, insert any desired block-level item such as a code block.</td></tr><tr><td>5</td><td><img class=\"image_resized\" style=\"aspect-ratio:675/129;width:94.22%;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/3_Lists_image.jpg\" width=\"675\" height=\"129\"></td><td>To continue with a new bullet point, press Enter until the cursor moves to a new blank position.</td></tr><tr><td>6</td><td><img class=\"image_resized\" style=\"aspect-ratio:675/129;width:100%;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Lists_image.jpg\" width=\"675\" height=\"129\"></td><td>Press Enter once more to create the new bullet.</td></tr></tbody></table></figure><p>The same principle applies to all three list types (bullet, numbered and to-do).</p><h2>To-do lists</h2><p>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_fASfBrYnquKU\">To-do Lists</a>.</p><h2>Collapsible lists</h2><p>Starting with Trilium v0.104.0, it is possible to collapse nested list items. This applies to bullet lists, numbered lists as well as to-do lists.</p><p>To collapse or expand a list item that has nested sub-items:</p><ul><li>Using the mouse, move the cursor over the list item and an arrow will appear to its left. Clicking it will toggle between collapsed and expanded.</li><li>For bullet lists and numbered lists, it's also possible to click directly on the marker (e.g. the bullet or the number) instead of on the arrow to collapse or expand it. This won't work for to-do lists since this would toggle the to-do instead.</li><li>Press <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Enter</kbd> which will toggle the collapse/expand state for the item at the cursor position.</li></ul><p>Of note:</p><ul><li>Collapsed items always show the arrow to indicate its state.</li><li>The collapsed state is saved at note level and synced across instances, which means that it will restore after a refresh or reopening of the application.</li><li>The collapsed state is also persisted in&nbsp;<a class=\"reference-link\" href=\"#root/_help_mHbBMPDPkVV5\">Import &amp; Export</a>, but only for the HTML format. Markdown exports will not preserve the collapse state.</li><li>Collapsible bullets only exist in the context of editable text notes. Read-only lists will always be fully expanded.</li><li>The list items will auto-expand on edit to avoid typing in a hidden area.</li></ul>",
++ "_help_QrtTYPmdd1qq": "<p>Markdown-like formatting allows inserting some basic formatting by typing the Markdown equivalent. Note that this does not mean that&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes supports Markdown, these are just some convenience shortcuts.</p><p>To import more complex formatting into text notes, consider using the <a href=\"#root/_help_dEHYtoWWi8ct\"><em>Import from Markdown</em></a> function. For fully-fleged Markdown notes imports, consider using the dedicated <a href=\"#root/_help_Oau6X9rCuegd\">import</a> function.</p><ul><li>For <a href=\"#root/_help_Gr6xFaF6ioJ5\">headings:</a><ul><li><code>##</code> for Heading 2 (the first-level heading is reserved for the note title).</li><li><code>###</code> for Heading 3</li><li><code>####</code> for Heading 4</li><li><code>#####</code> for Heading 5</li><li><code>######</code> for Heading 6</li></ul></li><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_Gr6xFaF6ioJ5\">General formatting</a>:<ul><li><strong>Bold</strong>: Type <code>**text**</code> or <code>__text__</code></li><li><em>Italic</em>: Type <code>*text*</code> or <code>_text_</code></li><li><del>Strikethrough</del>: Type <code>~~text~~</code></li></ul></li><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_S6Xx8QIWTV66\">Lists</a>:<ul><li>Bulleted list: Start a line with <code>*</code> or <code>-</code> followed by a space;</li><li>Numbered list: Start a line with <code>1.</code> or <code>1)</code> followed by a space;</li><li>To-do list: Start a line with <code>[ ]</code> for an unchecked item or <code>[x]</code> for a checked item.</li></ul></li><li>For <a href=\"#root/_help_NwBbFdNZ9h7O\">block quotes</a>, press <code>&gt;</code>, followed by a space.</li><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_QxEyIjRBizuC\">Code blocks</a>, type <code>```</code>.</li><li>For a <a href=\"#root/_help_dEHYtoWWi8ct\">horizontal line</a>, type <code>---</code>.</li><li>For <a href=\"#root/_help_NwBbFdNZ9h7O\">admonitions</a>:<ul><li><code>!!! note</code></li><li><code>!!! tip</code></li><li><code>!!! important</code></li><li><code>!!! caution</code></li><li><code>!!! warning</code></li><li>Starting any other text with <code>!!!</code> will insert a note admonition with the text inside of it.</li></ul></li><li>For <a href=\"#root/_help_CohkqWQC1iBv\">emojis</a>, type <code>:</code> followed by an emoji name to trigger an auto-completion.</li></ul><p>If auto-formatting is not desirable, press <kbd>Ctrl</kbd> + <kbd>Z</kbd> to revert the text to its original form.</p>",
++ "_help_YfYAtQBcfo5V": "<figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:350/193;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Math%20Equations_image.png\" width=\"350\" height=\"193\"></figure><p>Within text notes, it's possible to enter mathematical equations using the&nbsp;<span class=\"tn-icon cke cke-trilium-math\"></span> button from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>&nbsp;(generally found under the&nbsp;<a class=\"reference-link\" href=\"#root/_help_CohkqWQC1iBv\">Insert buttons</a>).</p><p>By default, the math dialog includes a MathLive visual editor and a TeX field. Disable <em>MathLive visual editor</em> under Options → Text Notes → Features to use only the TeX field and preview.</p><p>Enabling <em>Display mode</em> will render the equation slightly bigger (especially if using big operators such as summation, or fractions) and center it. Display mode equations will act as blocks (i.e. like paragraphs, or tables) and can be inserted for example in lists. Non-display equations can be part of the text.</p><h2>Keyboard shortcuts</h2><p>If inserting equations frequently, using the <kbd>Ctrl</kbd>+<kbd>M</kbd> keyboard shortcut can be more comfortable. Alternatively, type <code>$$</code> or <code>\\[</code> to trigger the popup directly.</p><p>There is currently no quick way to turn an already typed-out equation, such as surrounding it with <code>$</code> or pressing <kbd>Ctrl</kbd>+<kbd>M</kbd>.</p><h2>Supported math features</h2><p>Technically we are using the KaTeX library which allows for a subset of the TeX format. To see the full list of supported features, consult the <a href=\"https://katex.org/docs/supported\">Supported Functions</a> and the <a href=\"https://katex.org/docs/support_table\">Support Table</a> from the official documentation.</p><h2>Markdown support</h2><p>Math equations will be preserved when exporting to or importing from Markdown, surrounded by <code>$</code> characters for inline math expressions, and <code>$$</code> for display mode.</p><p>If you notice any issue with the Markdown import/export for equations, feel free to <a href=\"#root/_help_wy8So3yZZlH9\">report</a> it while providing the equation that causes issues.</p><h2>Formatting the equation</h2><p>It is possible to customize the font size and foreground color for both inline and display-mode equations, just like any other text. For inline equations, the background color/highlight can also be adjusted.</p>",
++ "_help_wYDzQ1fBFgfT": "<p>A multicolumn layout arranges content in two to four columns, side by side. A column can hold any kind of content, including tables, images and another multicolumn layout.</p><h2>Inserting a layout</h2><ul><li>In the formatting bar, go to <em>Insert</em> → <span class=\"tn-icon cke cke-trilium-multicolumn\"></span> <em>Multiple column layout</em> to insert a layout with two columns. Its submenu offers <em>2 columns</em>, <em>3 columns</em> and <em>4 columns</em>.</li><li>Alternatively, type <code>/columns</code> and choose <em>2 columns layout</em>, <em>3 columns layout</em> or <em>4 columns layout</em>, as described in&nbsp;<a class=\"reference-link\" href=\"#root/_help_ZlN4nump6EbW\">Slash Commands</a>.</li></ul><p>The columns of a new layout have equal widths. If text is selected when the layout is inserted, the selection moves into the first column.</p><h2>Changing the columns</h2><p>While the cursor is inside a layout, a toolbar appears above it with a button that shows the current layout. Clicking it opens a row of figures, one for each available layout; hovering over a figure shows its number of columns and their widths:</p><figure class=\"table\"><table><thead><tr><th>Columns</th><th>Widths</th></tr></thead><tbody><tr><td>2</td><td>50%-50%, 25%-75%, 75%-25%</td></tr><tr><td>3</td><td>33%-33%-33%, 25%-50%-25%</td></tr><tr><td>4</td><td>25%-25%-25%-25%</td></tr></tbody></table></figure><ul><li>Choosing a layout with more columns adds empty columns at the end.</li><li>Choosing a layout with fewer columns removes the last columns and moves their content to the end of the last remaining column.</li></ul><h2>Removing a layout</h2><ul><li>To remove the layout but keep its content, click the <span class=\"tn-icon cke cke-remove\"></span> <em>Remove layout</em> button in the layout's toolbar. The content of the columns is placed one after another where the layout was, and empty columns are left out.</li><li>To delete the layout together with its content, click the handle at its top-left corner to select it, then press <kbd>Delete</kbd>.</li></ul><h2>Narrow screens</h2><p>When a layout has too little room for its columns (narrower than about 500 pixels, such as on a phone), the columns are stacked one below the other. While editing, alternating background colors tell the columns apart. This applies to each layout on its own, so a layout inside a narrow column is stacked while the outer one stays side by side.</p><h2>Printing and exporting</h2><ul><li>When printing or <a href=\"#root/_help_NRnIZmSMc5sj\">exporting to PDF</a>, the columns are printed side by side.</li><li>Markdown has no columns, so Markdown export keeps the layout and each column as HTML <code>&lt;div&gt;</code> tags, with the content of each column written as Markdown between them. Importing the file back restores the layout. Markdown viewers that don't support HTML show the content of the columns one after another.</li></ul>",
++ "_help_dEHYtoWWi8ct": "<h2>Indentation</h2><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:201/124;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Other%20features_image.png\" width=\"201\" height=\"124\"></figure><p>Paragraphs can be indented using the following buttons from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>:</p><ul><li>Press&nbsp;<span class=\"tn-icon cke cke-indent\"></span> to increase the indentation of the current paragraph by one. Can be pressed multiple times if needed.</li><li>Press&nbsp;<span class=\"tn-icon cke cke-outdent\"></span> to decrease the indentation of a current paragraph. The button will be disabled if it is already at the minimum indentation level.</li><li>For convenience, keyboard shortcuts are also available. Press <kbd>Tab</kbd> to indent or <kbd>Shift</kbd>+<kbd>Tab</kbd> to decrease the indentation. These shortcuts work even if the cursor is not at the beginning of a paragraph or a list.</li><li>Apart from paragraphs, the indent button is also enabled in&nbsp;<a class=\"reference-link\" href=\"#root/_help_S6Xx8QIWTV66\">Lists</a>&nbsp;(for nesting) and&nbsp;<a class=\"reference-link\" href=\"#root/_help_NdowYOC1GFKS\">Tables</a>.</li></ul><p>When indented paragraphs or headings are copied and pasted as plain text, for example into a <a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a> note or another application, each indentation level becomes a tab at the start of the line. A copy that stays within a single paragraph contains only its text, without the indentation.</p><p>The reverse also works: when plain text is pasted into a text note, each paragraph whose lines all start with tabs is indented by one level per tab. Pasting into a code block keeps the tabs as they are.</p><h2>Markdown import</h2><p>If the clipboard contains Markdown text, it can be easily imported into text notes. Simply copy a Markdown-formatted text and press the&nbsp;<span class=\"tn-icon cke cke-trilium-markdown-mark\"></span> to insert its visual representation.</p><p>Note that this only works with raw Markdown (e.g. <code># Heading 1</code> to generate a heading) and not the visual representation of the Markdown (e.g. as in the preview pane of an application). In that case, simply use the paste function which already accepts HTML-formatted content.</p><p>This is mostly useful for snippets of text, for entire Markdown documents use the dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_Oau6X9rCuegd\">Markdown</a>&nbsp;import/export function.</p><p>If accessing Trilium with a web browser, the Markdown import action will ask for the content to be inserted into a dedicated screen since it does not have access to the clipboard.</p><h2>Cut to subnote</h2><p>The&nbsp;<span class=\"tn-icon cke cke-trilium-scissors\"></span> button will create a child note with the selected text. For more information, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_2x0ZAX9ePtzV\">Cut to subnote</a>.</p><h2>Find and replace</h2><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:394/203;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Other%20features_image.png\" width=\"394\" height=\"203\"></figure><p>The&nbsp;<span class=\"tn-icon cke cke-find-replace\"></span> button will open the editor's dedicated search and replace functionality.</p><p>Alternatively, the <kbd>Ctrl</kbd>+<kbd>F</kbd> combination can be pressed to show the dialog.</p>",
++ "_help_gLt3vA97tMcp": "<p>The text editor we are using is called&nbsp;<a class=\"reference-link\" href=\"#root/_help_MI26XDLSAlCD\">CKEditor</a>&nbsp;which has an open-source core, but it's also a commercial product which offers <a href=\"https://ckeditor.com/docs/trial/latest/index.html\">premium features</a>.</p><p>Prior to v0.105.0, Trilium used the following premium features as part of a signed agreement between the CKEditor and the Trilium team:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_ZlN4nump6EbW\">Slash Commands</a></li><li><a class=\"reference-link\" href=\"#root/_help_pwc194wlRzcH\">Text Snippets</a></li><li><a class=\"reference-link\" href=\"#root/_help_5wZallV2Qo1t\">Format Painter</a></li></ul><p>Starting with v0.105.0, those features have been completely rewritten as custom CKEditor plugins, licensed under AGPL-3.0.</p><h2>Lookalikes</h2><p>There are some premium CK features that look like Trilium's built-in functionality but they are completely different:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_VRoP0g1uHHc2\">In-editor AI assistant</a></li><li><a class=\"reference-link\" href=\"#root/_help_YfYAtQBcfo5V\">Math Equations</a>&nbsp;which uses a third-party plugin that has been adapted for Trilium.</li></ul>",
++ "_help_ZlN4nump6EbW": "<figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:419/571;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Slash%20Commands_image.png\" width=\"419\" height=\"571\"></figure><p>Slash commands is a feature of&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes which allows easily accessing commonly used commands simply by using the keyboard, without having to remember dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_A9Oc6YKKc65v\">Keyboard Shortcuts</a>.</p><h2>Interaction</h2><ul><li>As the name suggests, to trigger the slash commands simply press the / key to trigger it. Note that this can be anywhere in a paragraph as long as it's not part of the word, if it doesn't show up simply press a space and press the / key again.</li><li>Use ↑ and ↓ keys to navigate between options.</li><li>By default, the full list of commands is displayed.</li><li>To search, simply start typing: commands are found by their title or by other names they go by (for example <code>h2</code> for <em>Heading 2</em>).</li><li>To trigger the highlighted action, press Enter or Tab.</li></ul><h2>Integration with other features</h2><p>Apart from the common set of commands, some features are specially integrated with the slash commands:</p><ul><li>For <a href=\"#root/_help_NwBbFdNZ9h7O\">admonitions</a>, each admonition type (e.g. note, tip) will be individually displayed.</li><li>Every&nbsp;<a class=\"reference-link\" href=\"#root/_help_pwc194wlRzcH\">Text Snippets</a>&nbsp;will also appear individually, making it easy to insert them.</li><li><a class=\"reference-link\" href=\"#root/_help_VRoP0g1uHHc2\">In-editor AI assistant</a>: dedicated <em>Ask AI</em> item as well as all the predefined and <a href=\"#root/_help_mVEYwt20exhO\">custom quick actions</a>.</li></ul>",
++ "_help_oBo3iHIZnbG2": "<p>Trilium supports spell checking for your notes. How it works depends on whether you're using the <strong>desktop application</strong> (Electron) or accessing Trilium through a <strong>web browser</strong>.</p><h2>Desktop</h2><p>The desktop app uses Chromium's built-in spellchecker. You can configure it from <em>Options</em> → <em>Spell Check</em>.</p><h3>Enabling spell check</h3><p>Toggle <em>Check spelling</em> to enable or disable the spellchecker. A restart is required for changes to take effect — use the restart button at the bottom of the section.</p><h3>Choosing languages</h3><p>When spell check is enabled, a <em>Spell Check Languages</em> section appears listing all languages available on your system. Select one or more languages by checking the boxes. The spellchecker will accept words that are valid in <em>any</em> of the selected languages.</p><p>The available languages depend on your operating system's installed language packs. For example, on Windows you can add languages through <em>Options</em> → <em>Time &amp; Language</em> → <em>Language &amp; Region</em> → <em>Add a language</em>.</p><aside class=\"admonition note\"><p>The changes take effect only after restarting the application.</p></aside><h3>Custom dictionary</h3><aside class=\"admonition tip\"><p>This function is available starting with Trilium v0.103.0.</p></aside><p>Words you add to the dictionary (e.g. via the right-click context menu → \"Add to dictionary\") are stored in a <strong>synced note</strong> inside Trilium. This means your custom dictionary automatically syncs across all your devices.</p><p>You can view and edit the dictionary directly from <em>Settings</em> → <em>Spell Check</em> → <em>Custom Dictionary</em> → <em>Edit dictionary</em>. This opens the underlying note, which contains one word per line. You can add, remove, or modify entries as you like.</p><aside class=\"admonition note\"><p>Changes to the custom dictionary (whether from the editor or the context menu) take effect after restarting the application.</p></aside><h4>How the custom dictionary works</h4><ul><li>When you right-click a misspelled word and choose \"Add to dictionary\", the word is saved both to Electron's local spellchecker and to the synced dictionary note.</li><li>On startup, Trilium loads all words from the dictionary note into the spellchecker session.</li><li>If Trilium detects words in Electron's local dictionary but the dictionary note is empty (e.g. on first use), it performs a <strong>one-time import</strong> of those words into the note.</li><li>Words that are in Electron's local dictionary but <em>not</em> in the note (e.g. you removed them manually) are cleaned up from the local dictionary on startup.</li></ul><h4>Known limitations</h4><p>On Windows and macOS, Electron delegates \"Add to dictionary\" to the operating system's user dictionary. This means:</p><ul><li>Words added via the context menu are also written to the OS-level dictionary (e.g. <code>%APPDATA%\\Microsoft\\Spelling\\&lt;language&gt;\\default.dic</code> on Windows).</li><li><strong>Removing a word</strong> from the Trilium dictionary note prevents it from being loaded into the spellchecker on next startup, but does <em>not</em> remove it from the OS dictionary. The word may still be accepted by the OS spellchecker until you remove it from the OS dictionary manually.</li></ul><h2>Web browser</h2><p>When accessing Trilium through a web browser, spell checking is handled entirely by the browser itself. Trilium does not control the browser's spellchecker — language selection, dictionaries, and all other settings are managed through your browser's preferences.</p><p>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_jcQVxzYybYgz\">Note contextual menu</a>&nbsp;has a special behavior in which a right-clicked word (without selection) shows the browser's default contextual menu which allows the spellcheck to function.</p><p>The Spell Check settings page in Trilium will indicate that these options apply only to desktop builds.</p><h2>Frequently asked questions</h2><h3>Do I need to restart after every change?</h3><p>Yes. Spell check language selection and the custom dictionary are loaded once at startup. Any changes require a restart to take effect.</p><h3>Can I use multiple spell check languages at the same time?</h3><p>Yes. Select as many languages as you need from the checklist. The spellchecker will accept words from any of the selected languages.</p><h3>My custom words disappeared after syncing to a new device — what happened?</h3><p>On the first launch of a new device, Trilium may import existing local dictionary words into the note. If the note already has words from another device (via sync), those are preserved. Make sure sync completes before restarting the application on a new device.</p><h3>I removed a word from the dictionary note but it's still accepted</h3><p>This is likely due to the OS-level dictionary retaining the word (see <a href=\"#known-limitations\">Known limitations</a> above). You can manually remove it from your operating system's user dictionary.</p>",
+ "_help_BFvAtE74rbP6": "<aside class=\"admonition note\"><p>This page has been relocated to&nbsp;<a class=\"reference-link\" href=\"#root/_help_2dcGDhp9WFKb\">Outline tab</a>.</p></aside>",
- "_help_NdowYOC1GFKS": "<p>Tables are a powerful feature for&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes, since editing them is generally easy.</p><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:176/204;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/6_Tables_image.png\" width=\"176\" height=\"204\"></figure><p>To create a table, simply press the table button and select with the mouse the desired amount of columns and rows, as indicated in the adjacent figure.</p><h2>Formatting toolbar</h2><p>When a table is selected, a special formatting toolbar will appear:</p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/10_Tables_image.png\" width=\"384\" height=\"100\"><h2>Navigating a table</h2><ul><li>Using the mouse:<ul><li>Click on a cell to focus it.</li><li>Click the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/11_Tables_image.png\" width=\"28\" height=\"27\"> button at the top or the bottom of a table to insert an empty paragraph near it.</li><li>Click the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/5_Tables_image.png\" width=\"24\" height=\"26\"> button at the top-left of the table to select it entirely (for easy copy-pasting or cutting) or drag and drop it to relocate the table.</li></ul></li><li>Using the keyboard:<ul><li>Use the arrow keys on the keyboard to easily navigate between cells.</li><li>It's also possible to use <kbd>Tab</kbd> to go to the next cell and Shift+Tab to go to the previous cell.</li><li>Unlike arrow keys, pressing <kbd>Tab</kbd> at the end of the table (last row, last column) will create a new row automatically.</li><li>To select multiple cells, hold <kbd>Shift</kbd> while using the arrow keys.</li></ul></li></ul><h2>Resizing cells</h2><ul><li>Columns can be resized by hovering the mouse over the border of two adjacent cells and dragging it.</li><li>By default, the row height is not adjustable using the mouse, but it can be configured from the cell settings (see below).</li><li>To adjust exactly the width (in pixels or percentages) of a cell, select the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/8_Tables_image.png\" width=\"19\" height=\"19\"> button.</li></ul><h2>Inserting new rows and new columns</h2><ul><li>To insert a new column, click on a desired location, then press the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Tables_image.png\" width=\"18\" height=\"20\"> button from the formatting toolbar and select <em>Insert column left or right.</em></li><li>To insert a new row, click on a desired location, then press the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/7_Tables_image.png\" width=\"20\" height=\"18\"> button and select <em>Insert row above</em> or <em>below</em>.<ul><li>A quicker alternative to creating a new row while at the end of the table is to press the <kbd>Tab</kbd> key.</li></ul></li></ul><h2>Merging cells</h2><p>To merge two or more cells together, simply select them via drag &amp; drop and press the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Tables_image.png\" width=\"19\" height=\"19\"> button from the formatting toolbar.</p><p>More options are available by pressing the arrow next to it:</p><ul><li>Click on a single cell and select Merge cell up/down/right/left to merge with an adjacent cell.</li><li>Select <em>Split cell vertically</em> or <em>horizontally</em>, to split a cell into multiple cells (can also be used to undo a merge).</li></ul><h2>Table properties</h2><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:312/311;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/2_Tables_image.png\" width=\"312\" height=\"311\"></figure><p>The table properties can be accessed via the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/13_Tables_image.png\" width=\"19\" height=\"19\"> button and allows for the following adjustments:</p><ul><li>Border (not the border of the cells, but the outer rim of the table), which includes the style (single, double), color and width.</li><li>The background color, with none set by default.</li><li>The width and height of the table in percentage (must end with <code spellcheck=\"false\">%</code>) or pixels (must end with <code spellcheck=\"false\">px</code>).</li><li>The alignment of the table.<ul><li>Left or right-aligned, case in which the text will flow next to it.</li><li>Centered, case in which text will avoid the table, regardless of the table width.</li></ul></li></ul><p>The table will immediately update to reflect the changes, but the <em>Save</em> button must be pressed for the changes to persist.</p><h2>Cell properties</h2><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:320/386;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/3_Tables_image.png\" width=\"320\" height=\"386\"></figure><p>Similarly to table properties, the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/12_Tables_image.png\" width=\"19\" height=\"19\"> button opens a popup which adjusts the styling of one or more cells (based on the user's selection).</p><p>The following options can be adjusted:</p><ul><li>The border style, color and width (same as table properties), but applying to the current cell only.</li><li>The background color, with none set by default.</li><li>The width and height of the cell in percentage (must end with <code spellcheck=\"false\">%</code>) or pixels (must end with <code spellcheck=\"false\">px</code>).</li><li>The padding (the distance of the text compared to the cell's borders).</li><li>The alignment of the text, both horizontally (left, centered, right, justified) and vertically (top, middle or bottom).</li></ul><p>The cell will immediately update to reflect the changes, but the <em>Save</em> button must be pressed for the changes to persist.</p><h2>Caption</h2><p>Press the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/4_Tables_image.png\" width=\"18\" height=\"17\"> button to insert a caption or a text description of the table, which is going to be displayed above the table.</p><h2>Table borders</h2><p>By default, tables will come with a predefined gray border.</p><p>To adjust the borders, follow these steps:</p><ol><li>Select the table.</li><li>In the floating panel, select the <em>Table properties</em> option (<img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/14_Tables_image.png\" width=\"21\" height=\"21\">).<ol><li>Look for the <em>Border</em> section at the top of the newly opened panel.</li><li>This will control the outer borders of the table.</li><li>Select a style for the border. Generally <em>Single</em> is the desirable option.</li><li>Select a color for the border.</li><li>Select a width for the border, expressed in pixels.</li></ol></li><li>Select all the cells of the table and then press the <em>Cell properties</em> option (<img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/9_Tables_image.png\" width=\"21\" height=\"21\">).<ol><li>This will control the inner borders of the table, at cell level.</li><li>Note that it's possible to change the borders individually by selecting one or more cells, case in which it will only change the borders that intersect these cells.</li><li>Repeat the same steps as from step (2).</li></ol></li></ol><h3>Tables with invisible borders</h3><p>Tables can be set to have invisible borders in order to allow for basic layouts (columns, grids) of text or <a href=\"#root/_help_mT0HEkOsz6i1\">images</a> without the distraction of their border:</p><ol><li>First insert a table with the desired number of columns and rows.</li><li>Select the entire table.</li><li>In <em>Table properties</em>, set:<ol><li><em>Style</em> to <em>Single</em></li><li><em>Color</em> to <code spellcheck=\"false\">transparent</code></li><li>Width to <code spellcheck=\"false\">1px</code>.</li></ol></li><li>In Cell Properties, set the same as on the previous step.</li></ol><h2>Table indentation</h2><p>Since v0.104.1, tables can be indented as a block (the whole table moves, rather than just the content of a cell).</p><ol><li>Click the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/5_Tables_image.png\" width=\"24\" height=\"26\"> button to select the entire table. Otherwise, the indentation applies only to the current cell's content.</li><li>Press <kbd>Tab</kbd> to increase the indent, or <kbd>Shift</kbd>+<kbd>Tab</kbd> to decrease it. Alternatively, use the indentation buttons in the formatting toolbar.</li></ol><p>Markdown does not support indented tables, so the indentation is lost when converting to Markdown.</p><h2>Markdown import/export</h2><p>Simple tables are exported in GitHub-flavored Markdown format (e.g. a series of <code spellcheck=\"false\">|</code> items). If the table is found to be more complex (it contains HTML elements, has custom sizes or images), the table is converted to a HTML one instead.</p><p>Generally formatting loss should be minimal when exported to Markdown due to the fallback to HTML formatting.</p>",
- "_help_pwc194wlRzcH": "<figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:265/108;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Text%20Snippets_image.png\" width=\"265\" height=\"108\"></figure><p>Text Snippets are closely related to&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>, but instead of defining the content of an entire note, text snippets are pieces of formatted text that can easily be inserted in a text note.</p><h2>Creating a text snippet</h2><p>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>: </p><ol><li>Right click a note where to place the text snippet.</li><li>Select <em>Insert child note</em>.</li><li>Select <em>Text snippet</em>.</li></ol><p>Afterwards, simply type in the content of the note the desired text. The text can be formatted in the same manner as a normal text note.</p><p>The title of the note will become the title of the template. Optionally, a description can be added in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;section.</p><h2>Inserting a snippet</h2><p>Once a snippet is created, there are two options to insert it:</p><ol><li>From the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>, by looking for the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Text%20Snippets_image.png\" width=\"19\" height=\"19\">button.</li><li>Using&nbsp;<a class=\"reference-link\" href=\"#root/_help_ZlN4nump6EbW\">Slash Commands</a>: <ol><li>To look for a specific template, start typing the name of the template (its title).</li><li>To look for all the templates, type <code spellcheck=\"false\">template</code>.</li></ol></li></ol><aside class=\"admonition tip\"><p>A newly created snippet doesn't appear? Generally it takes up to a few seconds to refresh the list of templates once you make a change.</p><p>If this doesn't happen, <a href=\"#root/_help_s8alTXmpFR61\">reload the application</a> and <a href=\"#root/_help_wy8So3yZZlH9\">report the issue</a>to us.&nbsp;</p></aside><h2>Limitations</h2><ul><li>Whenever a snippet is created, deleted or its title/description are modified, all the open text notes will need to be refreshed. This causes a slight flash for usually under a second, but it can cause some discomfort.</li><li>Unlike&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>, the snippets cannot be limited to a particular <a href=\"#root/_help_9sRHySam5fXb\">workspace</a>.</li></ul>",
- "_help_fASfBrYnquKU": "<h2>Extended task states</h2><figure class=\"image image-style-align-left\"><img style=\"aspect-ratio:303/264;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/To-do%20Lists_image.png\" width=\"303\" height=\"264\"></figure><p>In Trilium, to-do items aren't limited to a simple \"done\" or \"not done.\" Tasks can also be marked as <em>in progress</em> (\"doing\"), <em>under consideration</em> (\"maybe\"), or <em>cancelled</em> (\"won't do\"), thus giving a more accurate picture of where things actually stand.</p><p>Right-click the checkbox and select the desired state. Alternatively, press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Enter </kbd> to cycle through the task states. Tapping or left-clicking the checkbox will always toggle between \"None\" and \"Done\".</p><p>Task states are fully preserved when converting between&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_6RM1Q7ppFVoj\">Markdown</a>&nbsp;notes, in both directions.</p><h3>Customizing the extended task states</h3><p>Task states are customizable: you can reorder them, create new ones with different colors and symbols, or delete the ones you don't need. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_i16PM6A7GXdU\">Customizing to-do task states</a>&nbsp;for more details.</p><h2>Keyboard shortcuts</h2><p>When at the beginning on an empty paragraph, type the following to insert a to-do list:</p><ul><li><code spellcheck=\"false\">[ ]</code> for an unchecked item</li><li><code spellcheck=\"false\">[x]</code> for a checked item</li></ul><p>Extended task states are supported as well, using its corresponding <em>Markdown symbol</em>. These are the defaults but they can be changed if needed (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_i16PM6A7GXdU\">Customizing to-do task states</a>):</p><ul><li><code spellcheck=\"false\">[/]</code> for “Doing”.</li><li><code spellcheck=\"false\">[?]</code> for “Maybe”.</li><li><code spellcheck=\"false\">[-]</code> for “Cancelled”.</li></ul><p>To reorder the item under the cursor, press <kbd>Alt</kbd>+<kbd>Up</kbd> or <kbd>Alt</kbd>+<kbd>Down</kbd>. To reorder multiple items, select them first.</p><h2>See also</h2><ul><li>To-do lists are meant for small task lists. For more complicated, day-to-day task tracking consider using a&nbsp;<a class=\"reference-link\" href=\"#root/_help_CtBQqbwXDx1w\">Kanban Board</a>&nbsp;collection instead.</li></ul>",
- "_help_6f9hih2hXXZk": "<p>Trilium supports creating \"code\" notes, i.e. notes which contain some sort of formal code - be it programming language (C++, JavaScript), structured data (JSON, XML) or other types of codes (CSS etc.).</p><p>This can be useful for a few things:</p><ul><li>computer programmers can store code snippets as notes with syntax highlighting</li><li>JavaScript code notes can be executed inside Trilium for some extra functionality<ul><li>we call such JavaScript code notes \"scripts\" - see&nbsp;<a class=\"reference-link\" href=\"#root/_help_CdNpE2pqjmI6\">Scripting</a></li></ul></li><li>JSON, XML etc. can be used as storage for structured data (typically used in conjunction with scripting)</li></ul><p>For shorter snippets of code that can be embedded in&nbsp;<a href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes, see&nbsp;<a href=\"#root/_help_QxEyIjRBizuC\">Code blocks</a>.</p><p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Code_image.jpg\"></p><h2>Adjusting the language of a code note</h2><p>In the&nbsp;<a href=\"#root/_help_BlN9DFI679QC\">Ribbon</a>, look for the <em>Note type</em> selector and click it to reveal the possible note types. Inside of it there will be a section called <em>Code</em>, select any one of the languages.</p><p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/1_Code_image.jpg\"></p><h2>Adjusting the list of languages</h2><p>Trilium supports syntax highlighting for many languages, but by default displays only some of them. The supported languages can be adjusted by going to&nbsp;<a href=\"#root/_help_4TIF1oA4VQRO\">Options</a>, then <em>Code Notes</em> and looking for the <em>Available MIME types in the dropdown</em> section. Simply check any of the items to add them to the list, or un-check them to remove them from the list.</p><p>Note that the list of languages is not immediately refreshed, you'd have to manually <a href=\"#root/_help_s8alTXmpFR61\">refresh the application</a>.</p><p>The list of languages is also shared with the&nbsp;<a href=\"#root/_help_QxEyIjRBizuC\">Code blocks</a>&nbsp;feature of&nbsp;<a href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes.</p><h2>Word wrap</h2><p>Long lines can be displayed on multiple lines:</p><ul><li>Globally for all code notes, from&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Code Notes.</em></li><li>For a particular note, by going to the menu in&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note buttons</a>&nbsp;and selecting <em>Word wrap</em> and selecting the appropriate option:<ul><li><em>Auto</em>, to respect the global word wrap for code notes.</li><li><em>On</em> or <em>Off</em>, to change the state of the word wrap for this note regardless of the global option.</li></ul></li></ul><aside class=\"admonition note\"><p>Word wrapping can also be adjusted at note level through the <code spellcheck=\"false\">#wrapLines</code> <a href=\"#root/_help_HI6GBBIduIgv\">label</a>, which can also be inherited.</p></aside><h2>Adjusting options using the status bar</h2><aside class=\"admonition note\"><p>This feature is only available for the&nbsp;<a class=\"reference-link\" href=\"#root/_help_IjZS7iK5EXtb\">New Layout</a>. For the old layout, the tab width can be adjusted at note level using the <code spellcheck=\"false\">#tabWidth</code> attribute, but re-indentation is not available.</p></aside><p>The status bar at the bottom of the editor shows the current indentation settings and language. Clicking on the indentation indicator opens a menu with three sections:</p><ol><li><strong>Indent Using</strong> — switch between Spaces and Tabs (<code spellcheck=\"false\">#indentWithTabs</code>). If a per-note override is active, a \"Reset to default\" option appears.</li><li><strong>Display Width</strong> — choose from preset widths (1, 2, 3, 4, 6, 8). Changes are saved as a per-note <code spellcheck=\"false\">#tabWidth</code> label.</li><li><strong>Re-indent Content To</strong> — convert existing indentation to a different style. For example, re-indent a file from 4 spaces to 2 spaces, or from spaces to tabs. This rewrites the leading whitespace on every line while preserving alignment remainders.</li></ol><p>Clicking the language indicator lets you change the note's MIME type.</p><h3>Re-indentation</h3><p>When you re-indent content, the editor:</p><ul><li>Measures the visual column width of each line's leading whitespace using the current style</li><li>Calculates indent levels and any alignment remainder</li><li>Rebuilds the leading whitespace in the target style</li><li>Preserves non-leading whitespace, blank lines, and content without indentation</li></ul><h2>Color schemes</h2><p>Since Trilium 0.94.0 the colors of code notes can be customized by going&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ Code Notes and looking for the <em>Appearance</em> section.</p><aside class=\"admonition note\"><p><strong>Why are there only a few themes whereas the code block themes for text notes have a lot?</strong><br>The reason is that Code notes use a different technology than the one used in Text notes, and as such there is a more limited selection of themes. If you find a CodeMirror 6 (not 5) theme that you would like to use, let us know and we might consider adding it to the set of default themes. There is no possibility of adding new themes (at least for now), since the themes are defined in JavaScript and not at CSS level.</p></aside>",
- "_help_m523cpzocqaD": "<p>Trilium allows you to save common searches as notes within the note tree. The search results will appear as sub-notes under these \"saved search\" notes. Here is an example of how it works:</p><figure class=\"image image_resized image-style-align-center\" style=\"width:50%;\"><img style=\"aspect-ratio:812/585;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Saved%20Search_saved-search.gif\" width=\"812\" height=\"585\"></figure><h2>Location</h2><p>By default, saved searches are stored in the day note. However, you can designate a different note to store saved searches by marking it with the <code spellcheck=\"false\">#searchHome</code> label. Additionally, for <a href=\"#root/_help_9sRHySam5fXb\">workspaces</a>, you can use the <code spellcheck=\"false\">#workspaceSearchHome</code> label to specify a storage location for saved searches within that workspace.</p>",
- "_help_iRwzGnHPzonm": "<p>Relation map is a type of&nbsp;note&nbsp;which visualizes notes and their <a href=\"#root/_help_zEY4DaJG4YT5\">relations</a>.</p><h2>Interaction</h2><ul><li>To create a new note and add it to the board, press the plus button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_XpOYSgsLkTJy\">Floating buttons</a>.<ul><li>Afterwards, click anywhere on the map to place it there.</li><li>The note will be placed as a sub-child of the map.</li></ul></li><li>An existing note can also be dragged from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>. It will be placed at the position it's dragged on.<ul><li>Multiple notes can also be dragged via&nbsp;<a class=\"reference-link\" href=\"#root/_help_yTjUdsOi4CIE\">Multiple selection</a>. The notes will be positioned near the dragged position without overlapping.</li><li>The dragged note can be a sub-child of the map, or it can be at any arbitrary position.</li></ul></li><li>To create a relationship, hold the mouse on the box on the right of a note and then:<ul><li>Drag it over another note to create a relationship pointing from the first note to the second one.</li><li>Drag over the same note to create a self-referencing relationship (represented as a loop).</li><li>Once dragged, enter the name of the relationship to create. To cancel, simply dismiss the dialog or press <kbd>Esc</kbd>.</li></ul></li><li>To open a note, either click on the note (opening it in the current view) or use the right click menu to open in a new tab.</li><li>To edit the title of a note or to delete it (either from the map, or delete it completely), right click the note.</li><li>To delete a relationship, right click it and select the corresponding option.</li></ul><h2>Development process demo</h2><p>This is a basic example how you can create simple diagram using relation maps:</p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Relation%20Map_relation-map-dev-process.png\" width=\"934\" height=\"667\"><p>And this is how you can create it:</p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Relation%20Map_relation-map-dev-process-demo.gif\" width=\"812\" height=\"585\"><p>We start completely from scratch by first creating new note called \"Development process\" and changing its type to \"Relation map\". After that we create new notes one by one and place them by clicking into the map. We also drag <a href=\"#root/_help_zEY4DaJG4YT5\">relations</a>between notes and name them. That's all!</p><p>Items on the map - \"Specification\", \"Development\", \"Testing\" and \"Demo\" are actually notes which have been created under \"Development process\" note - you can click on them and write some content. Connections between notes are called \"<a href=\"#root/_help_zEY4DaJG4YT5\">relations</a>\".</p><h2>Family demo</h2><p>This is more complicated demo using some advanced concepts. Resulting diagram is here:</p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Relation%20Map_relation-map-family.png\" width=\"941\" height=\"758\"><p>This is how you get to it:</p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Relation%20Map_relation-map-family-demo.gif\" width=\"812\" height=\"585\"><p>There are several steps here:</p><ul><li>we start with empty relation map and two existing notes representing Prince Philip and Queen Elizabeth II. These two notes already have <code spellcheck=\"false\">isPartnerOf</code> <a href=\"#root/_help_zEY4DaJG4YT5\">relations</a>defined.<ul><li>There are actually two \"inverse\" relations (one from Philip to Elizabeth and one from Elizabeth to Philip)</li></ul></li><li>we drag both notes to relation map and place to suitable position. Notice how the existing <code spellcheck=\"false\">isPartnerOf</code> relations are displayed.</li><li>now we create new note - we name it \"Prince Charles\" and place it on the relation map by clicking on the desired position. The note is by default created under the relation map note (visible in the note tree on the left).</li><li>we create two new relations <code spellcheck=\"false\">isChildOf</code> targeting both Philip and Elizabeth<ul><li>now there's something unexpected - we can also see the relation to display another <code spellcheck=\"false\">hasChild</code> relation. This is because there's a <a href=\"#root/_help_OFXdgB2nNk1F\">relation definition</a> which puts <code spellcheck=\"false\">isChildOf</code> as an \"<a href=\"#root/_help_OFXdgB2nNk1F\">inverse</a>\" relation of <code spellcheck=\"false\">hasChildOf</code> (and vice versa) and thus it is created automatically.</li></ul></li><li>we create another note for Princess Diana and create <code spellcheck=\"false\">isPartnerOf</code> relation from Charles. Again notice how the relation has arrows both ways - this is because <code spellcheck=\"false\">isPartnerOf</code> definition specifies its inverse relation as again \"isPartnerOf\" so the opposite relation is created automatically.</li><li>as the last step we pan &amp; zoom the map to fit better to window dimensions.</li></ul><p>Relation definitions mentioned above come from \"Person template\" note which is assigned to any child of \"My Family Tree\" relation note. You can play with the whole thing in the <a href=\"#root/_help_wX4HbRucYSDD\">demo notes</a>.</p><h2>Details</h2><p>You can specify which relations should be displayed with comma delimited names of relations in <code spellcheck=\"false\">displayRelations</code> label.</p><p>Alternatively, you can specify comma delimited list of relation names in <code spellcheck=\"false\">hideRelations</code> which will display all relations, except for the ones defined in the label.</p><h2>See also</h2><ul><li><a class=\"reference-link\" href=\"#root/_help_bdUJEHsAPYQR\">Note Map</a>&nbsp;is a similar concept.</li></ul>",
- "_help_bdUJEHsAPYQR": "<figure class=\"image image_resized\" style=\"width:72.68%;\"><img style=\"aspect-ratio:1311/1271;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Note%20Map_image.png\" width=\"1311\" height=\"1271\"></figure><p>A Note map is a note type which displays a standalone version of the feature of the same name:&nbsp;<a class=\"reference-link\" href=\"#root/_help_BCkXAVs63Ttv\">Note Map (Link map, Tree map)</a>. Consult that page for more information on how the note map works and what it displays.</p><p>Once created, the note map will display the relations between notes. Only the notes that are part of the parent of the note map will be displayed (including their children).</p><h2>Root note</h2><p>The root note defines the starting point of the graph, from which the relations and the hierarchy are derived from.</p><p>There are three possible root notes:</p><ul><li>The default root note is the parent note of the note map.</li><li>To use the currently <a href=\"#root/_help_OR8WJ7Iz9K4U\">hoisted note</a> instead, set the <code spellcheck=\"false\">mapRootNoteId</code> label to <code spellcheck=\"false\">hoisted</code>.</li><li>To use a specific note instead, set <code spellcheck=\"false\">mapRootNoteId</code> to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_m1lbrzyKDaRB\">Note ID</a>&nbsp;of the desired note.</li></ul><h2>Customization</h2><p>The note map can be customized using the following&nbsp;<a class=\"reference-link\" href=\"#root/_help_HI6GBBIduIgv\">Labels</a>:</p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Label</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code spellcheck=\"false\">#mapIncludeRelation</code></td>\n<td>Comma-delimited relation names to include from the note map.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">#mapExcludeRelation</code></td>\n<td>Comma-delimited relation names to exclude from the note map.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">#mapRootNoteId</code></td>\n<td>The ID of the note the map roots from, or <code spellcheck=\"false\">hoisted</code>. See the root note section above for more information.</td>\n</tr>\n</tbody></table></figure>",
- "_help_HcABDtFCkbFN": "<figure class=\"image\"><img style=\"aspect-ratio:601/216;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Render%20Note_image.png\" width=\"601\" height=\"216\"></figure><p>Render Note is a special case of <a href=\"#root/_help_yIhgI5H7A2Sm\">front-end scripting</a> which allows rendering custom content inside a note. This makes it possible to create custom dashboards, or to use a custom note editor.</p><p>The content can either be a vanilla HTML, or Preact JSX.</p><h2>Creating a render note</h2><ol><li>Create a&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note with the:<ol><li>HTML language for the legacy/vanilla method, with what needs to be displayed (for example <code spellcheck=\"false\">&lt;p&gt;Hello world.&lt;/p&gt;</code>).</li><li>JSX for the Preact-based approach (see below).</li></ol></li><li>Create a&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>.</li><li>Assign the <code spellcheck=\"false\">renderNote</code> <a href=\"#root/_help_zEY4DaJG4YT5\">relation</a> to point at the previously created code note.</li></ol><h2>Legacy scripting using jQuery</h2><p>A static HTML is generally not enough for&nbsp;<a class=\"reference-link\" href=\"#root/_help_CdNpE2pqjmI6\">Scripting</a>. The next step is to automatically change parts of the note using JavaScript.</p><p>For a simple example, we are going to create a render note that displays the current date in a field.</p><p>To do so, first create an HTML code note with the following content:</p><pre><code class=\"language-text-html\">&lt;h1&gt;Current date &amp; time&lt;/h1&gt;\nThe current date &amp; time is &lt;span class=\"date\"&gt;&lt;/span&gt;</code></pre><p>Now we need to add the script. Create another&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>, but this time of JavaScript (frontend) language. Make sure the newly created note is a direct child of the HTML note created previously; with the following content:</p><pre><code class=\"language-text-javascript\">const $dateEl = api.$container.find(\".date\");\n$dateEl.text(new Date());</code></pre><p>Now create a render note at any place and set its <code spellcheck=\"false\">~renderNote</code> relation to point to the HTML note. When the render note is accessed it will display:</p><blockquote><p><strong>Current date &amp; time</strong><br>The current date &amp; time is Sun Apr 06 2025 15:26:29 GMT+0300 (Eastern European Summer Time)</p></blockquote><h2>Dynamic content using Preact &amp; JSX</h2><p>As a more modern alternative to jQuery, it's possible to use Preact &amp; JSX to render pages. Since JSX is a superset of JavaScript, there's no need to provide a HTML anymore.</p><p>Here are the steps to creating a simple render note:</p><ol><li><p>Create a note of type&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>.</p></li><li><p>Create a child&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note with JSX as the language.<br>As an example, use the following content:</p><pre><code class=\"language-text-x-trilium-auto\">export default function() {\n return (\n &lt;&gt;\n &lt;p&gt;Hello world.&lt;/p&gt;\n &lt;/&gt;\n );\n}</code></pre></li><li><p>In the parent render note, define a <code spellcheck=\"false\">~renderNote</code> relation pointing to the newly created child.</p></li><li><p>Refresh the render note and it should display a “Hello world” message.</p></li></ol><h2>Refreshing the note</h2><p>It's possible to refresh the note via:</p><ul><li>The corresponding button in&nbsp;<a class=\"reference-link\" href=\"#root/_help_XpOYSgsLkTJy\">Floating buttons</a>.</li><li>The “Render active note” <a href=\"#root/_help_A9Oc6YKKc65v\">keyboard shortcut</a> (not assigned by default).</li></ul><h2>Examples</h2><ul><li><a class=\"reference-link\" href=\"#root/_help_R7abl2fc6Mxi\">Weight Tracker</a>&nbsp;which is present in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_6tZeKvSHEUiB\">Demo Notes</a>.</li></ul>",
- "_help_s1aBHPd79XYj": "<aside class=\"admonition tip\"><p>For a quick understanding of the Mermaid syntax, see&nbsp;<a class=\"reference-link\" href=\"{{helpAssets}}/User%20Guide/Note%20Types/Mermaid%20Diagrams/Syntax%20reference.dat\">Syntax reference</a>&nbsp;(official documentation).</p></aside><figure class=\"image image-style-align-center\"><img style=\"aspect-ratio:886/663;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/2_Mermaid%20Diagrams_image.png\" width=\"886\" height=\"663\"></figure><p>Trilium supports Mermaid, which adds support for various diagrams such as flowchart, sequence diagram, class diagram, state diagram, pie charts, etc., all using a text description of the chart instead of manually drawing the diagram.</p><p>This note type is a split view, meaning that both the source code and a preview of the document are displayed side-by-side. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_SL5f1Auq7sVN\">Note types with split view</a>&nbsp;for more information.</p><h2>Sample diagrams</h2><p>Starting with v0.103.0, Mermaid diagrams no longer start with a sample flowchart, but instead a pane at the bottom will show all the supported diagrams with sample code for each:</p><ul><li>Simply click on any of the samples to apply it.</li><li>The pane will disappear as soon as something is typed in the code editor or a sample is selected. To make it appear again, simply remove the content of the note.</li></ul><h2>Layouts</h2><p>Depending on the chart being edited and user preference, there are two layouts supported by the Mermaid note type:</p><ul><li>Horizontal, where the source code (editable part) is on the left side of the screen and the preview is to the right.</li><li>Vertical, where the source code is at the bottom of the screen and the preview is at the top.</li></ul><p>It's possible to switch between the two layouts at any time by pressing the <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Mermaid%20Diagrams_image.png\"> icon in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_XpOYSgsLkTJy\">Floating buttons</a>&nbsp;area.</p><h2>Interaction</h2><ul><li>The source code of the diagram (in Mermaid format) is displayed on the left or bottom side of the note (depending on the layout).<ul><li>Changing the diagram code will refresh automatically the diagram.</li></ul></li><li>The preview of the diagram is displayed at the right or top side of the note (depending on the layout):<ul><li>There are dedicated buttons at the bottom-right of the preview to control the zoom in, zoom out or re-center the diagram: <img src=\"{{helpAssets}}/User%20Guide/Note%20Types/1_Mermaid%20Diagrams_image.png\"></li><li>The preview can be moved around by holding the left mouse button and dragging.</li><li>Zooming can also be done by using the scroll wheel.</li><li>The zoom and position on the preview will remain fixed as the diagram changes, to be able to work more easily with large diagrams.</li></ul></li><li>The size of the source/preview panes can be adjusted by hovering over the border between them and dragging it with the mouse.</li><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_XpOYSgsLkTJy\">Floating buttons</a>&nbsp;area:<ul><li>The source/preview can be laid out left-right or bottom-top via the <em>Move editing pane to the left / bottom</em> option.</li><li>Press <em>Lock editing</em> to automatically mark the note as read-only. In this mode, the code pane is hidden and the diagram is displayed full-size. Similarly, press <em>Unlock editing</em> to mark a read-only note as editable.</li><li>Press the <em>Copy image reference to the clipboard</em> to be able to insert the image representation of the diagram into a text note. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_0Ofbk1aSuVRu\">Image references</a>&nbsp;for more information.</li><li>Press the <em>Export diagram as SVG</em> to download a scalable/vector rendering of the diagram. Can be used to present the diagram without degrading when zooming.</li><li>Press the <em>Export diagram as PNG</em> to download a normal image (at 1x scale, raster) of the diagram. Can be used to send the diagram in more traditional channels such as e-mail.</li></ul></li></ul><h2>Errors in the diagram</h2><p>If there is an error in the source code, the error will be displayed in an information pane.</p><p>During the state of an error, the diagram will no longer be rendered and the previously working diagram will remain in the preview section.</p>",
- "_help_RH6yLjjWJHof": "<p>Mermaid supports a different layout engine which supports slightly more complex diagrams, called the <a href=\"https://eclipse.dev/elk/\">Eclipse Layout Kernel (ELK)</a>. Trilium has support for these as well, but it's not enabled by default.</p><p>In order to activate ELK for any diagram, insert the following YAML frontmatter right at the beginning of the diagram:</p><pre><code class=\"language-text-x-yaml\">---\nconfig:\n layout: elk\n---</code></pre><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>With ELK off</th>\n<th>With ELK on</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Mermaid%20Diagrams/ELK%20layout_ELK%20off.svg\"></td>\n<td><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Mermaid%20Diagrams/ELK%20layout_ELK%20on.svg\"></td>\n</tr>\n</tbody></table></figure>",
- "_help_grjYqerjn243": "<figure class=\"image\"><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Canvas_image.png\" alt=\"grafik\"></figure><p>Available since Trilium v0.52.</p><p>Canvas notes use the Excalidraw library to allow handwritten notes with mouse, pen or touch on an infinite canvas. It also supports basic diagramming, text and graphics input.</p><h2>Interaction</h2><ul><li>The note can be togged <a href=\"#root/_help_CoFPLs3dRlXc\">read-only</a> from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_XpOYSgsLkTJy\">Floating buttons</a>&nbsp;section.</li></ul><h2>Embedding notes</h2><p>Since v0.104.0, Canvas supports embedding notes in a similar fashion to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>&nbsp;functionality for&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes.</p><p>To embed a note:</p><ul><li>From the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, drag the item onto the canvas.</li><li>Manually, by choosing <em>More tools</em> → <em>Web Embed</em> and pasting the link to the note (e.g. <code spellcheck=\"false\">root/MujWAc9fQ1nj</code>).</li></ul><p>Embedding notes in the canvas follows the same rules as&nbsp;<a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>: some notes are rendered as images (e.g.&nbsp;<a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a>), whereas some render fully interactive such as&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>.</p>",
- "_help_1vHRoWCEjj0L": "<h2>Configuration</h2><p>A webview needs to know which URL to render, and it can be provided by setting the <code spellcheck=\"false\">webViewSrc</code> <a href=\"#root/_help_zEY4DaJG4YT5\">label</a>, such as:</p><pre><code class=\"language-text-x-trilium-auto\">#webViewSrc=\"https://www.wikipedia.org\"</code></pre><p>The URL needs to contain the full scheme.</p><h2>Web view on the server vs. Electron</h2><p>When accessing Trilium via a browser instead of the desktop application, the web view will still try to render the content of the desired webpage. However, since it's running in a browser there are quite a few limitations as opposed to the desktop one.</p><p>More specifically, quite a few websites oppose being embedded in another website (technically they have a non-permisive <code spellcheck=\"false\">X-Frame-Options</code> header). This is not bypassable by Trilium so the page will simply fail to render.</p><p>You can diagnose this by right clicking the Trilium web page → Inspect (element) and looking in the “Console” tab for errors such as:</p><ul><li><code spellcheck=\"false\">Refused to display 'https://www.google.com/' in a frame because it set 'X-Frame-Options' to 'sameorigin'.</code></li><li><code spellcheck=\"false\">Refused to frame 'https://duckduckgo.com/' because an ancestor violates the following Content Security Policy directive: \"frame-ancestors 'self' https://html.duckduckgo.com\".</code></li></ul><p>There are a few websites that do render such as <code spellcheck=\"false\">wikipedia.org</code>.</p><p>Do note that we are also applying some sandboxing constraints on the server side, so if you have any issues other than the unresolvable <code spellcheck=\"false\">X-Frame-Options</code> described above, feel free to report them.</p><p>On the desktop side, a different technology is used which bypasses the constraints of an <code spellcheck=\"false\">iframe</code> (<code spellcheck=\"false\">webview</code>).</p><h2>Embedding in other note types</h2><p>Starting with v0.104.0, web views can be embedded into other note types:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_IF7Q6I9x7zuw\">Dashboard</a></li><li><a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a></li><li><a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes via&nbsp;<a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>.</li></ul>",
- "_help_gBbsAeiuUxI5": "<figure class=\"image image-style-align-center\"><img style=\"aspect-ratio:892/675;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Mind%20Map_image.png\" width=\"892\" height=\"675\"></figure><p>The mindmap allows for easy jotting down of ideas and storing them in a hierarchical fashion.</p><h2>Terminology</h2><ul><li>A <strong>node</strong> is a single idea, represented differently based on depth (filled rounded rectangle for the root note, unfilled rectangles for sub-ideas, lines only for sub-sub-ideas).</li><li>The <strong>root node</strong> is the top-most node from which all other nodes derive, displayed as a filled rectangle. There can only be a single root node.</li></ul><h2>Interaction</h2><ul><li>To create a new node at the same level as the current one, press <kbd>Enter</kbd>, enter the desired text and then press <kbd>Enter</kbd> once again to confirm.</li><li>Similarly, to create a sub-node, press <kbd>Tab</kbd>, enter the desired text and then press <kbd>Enter</kbd>.</li><li>To create a parent, use <kbd>Ctrl</kbd>+<kbd>Enter</kbd> instead.</li><li>To remove a node, press <kbd>Delete</kbd>.</li><li>To move a node up or down, press <kbd>Page Up</kbd> or <kbd>Page Down</kbd>.</li><li>To adjust the font size, color of the text or background or to add a link, click on a node and use the floating panel that appears to the right.</li><li>To select one or more notes, drag and drop across the map.</li><li>Right click the node to bring a contextual menu with options such as creating new nodes, focusing on a particular notes or creating links between them.</li><li>Use the buttons at the top-left to change the positioning of the nodes relative to the root node (to the left, to the right, or to both sides).</li><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_XpOYSgsLkTJy\">Floating buttons</a>&nbsp;area:<ul><li>An <a href=\"#root/_help_0Ofbk1aSuVRu\">image reference</a> can be copied, to paste the mind map in a text note.</li><li>The diagram can be exported either as SVG (vectorial) or PNG (raster).</li><li>The note can be togged <a href=\"#root/_help_CoFPLs3dRlXc\">read-only</a>.</li></ul></li></ul>",
- "_help_W8vYD3Q1zjCR": "<p>The <em>File</em> note type can be used to attach various external files such as images, videos or PDF documents.</p><h2>Uploading a file</h2><p>Since these files come from an external source, it is not possible to create a <em>File</em> note type directly:</p><ul><li>Drag a file into the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</li><li>Right click a note and select <em>Import into note</em> and point it to one of the supported files.</li></ul><h2>Supported file types</h2><h3>PDFs</h3><p>PDFs can be uploaded to Trilium and they will display a live preview with full support for various features such as table of contents, annotations, as well as remembering the last page read. For more information, see the dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_XJGJrpu7F9sh\">PDFs</a>&nbsp;page.</p><h2>Office documents</h2><p>Trilium offers previews for Office documents such as Word (<code spellcheck=\"false\">.docx</code>), Excel (<code spellcheck=\"false\">.xlsx</code>) and PowerPoint (<code spellcheck=\"false\">.pptx</code>). For more information, see the dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_KG48zgNY31NW\">Office documents</a>.</p><h3>Images</h3><figure class=\"image image-style-align-center image_resized\" style=\"width:50%;\"><img style=\"aspect-ratio:879/766;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/2_File_image.png\" width=\"879\" height=\"766\"></figure><p>Interaction:</p><ul><li><em>Copy reference to clipboard</em>, for embedding the image within&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes.<ul><li>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_0Ofbk1aSuVRu\">Image references</a>&nbsp;for more information.</li><li>Alternatively, press the corresponding button from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_XpOYSgsLkTJy\">Floating buttons</a>.</li></ul></li></ul><h3>Videos</h3><p>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_AjqEeiDUOzj4\">Audio &amp; Video</a>.</p><h3>Audio</h3><figure class=\"image image-style-align-center image_resized\" style=\"width:50%;\"><img style=\"aspect-ratio:850/243;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/1_File_image.png\" width=\"850\" height=\"243\"></figure><p>Adding a supported audio file will reveal a basic audio player that can be used to play it.</p><p>Interactions:</p><ul><li>The audio can be played/paused using the dedicated button.</li><li>Dragging the mouse across, or clicking the progress bar will seek through the song.</li><li>The volume can be set.</li><li>The playback speed can be adjusted via the contextual menu next to the volume.</li></ul><h3>Text files</h3><figure class=\"image image-style-align-center image_resized\" style=\"width:50%;\"><img style=\"aspect-ratio:926/347;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/File_image.png\" width=\"926\" height=\"347\"></figure><p>Files that are identified as containing text will show a preview of their content. One common use case for this type of file is to embed text files whose content is not necessarily of interest to the user, such as third-party libraries or generated content, that can then be downloaded if needed.</p><p>Note that generally text files will be <a href=\"#root/_help_mHbBMPDPkVV5\">imported</a> as either&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;or&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;notes. To bypass this behavior and create a <em>File</em> note type, use the <em>Import into note</em> feature and uncheck <em>Import HTML, Markdown and TXT as text notes</em>, as well as <em>Import recognized code files as code notes</em>.&nbsp;</p><p>Since one of the use cases for having files instead of notes is to display large files, the content preview is limited to a relatively small amount of characters. To view the full file, consider opening it in an external application.</p><h3>GPS tracks</h3><p>Trilium displays information about GPS tracks in <code spellcheck=\"false\">.gpx</code> format, such as the distance, duration, elevation profile, tracks, markers.</p><p>When a <code spellcheck=\"false\">.gpx</code> note is dropped in a&nbsp;<a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map</a>, the track itself will also be displayed on the map.</p><figure class=\"image\"><img style=\"aspect-ratio:1500/807;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/4_File_image.png\" width=\"1500\" height=\"807\"></figure><h3>Unknown file types</h3><figure class=\"image image-style-align-center image_resized\" style=\"width:50%;\"><img style=\"aspect-ratio:532/240;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/3_File_image.png\" width=\"532\" height=\"240\"></figure><p>If the file could not be identified as any of the supported file types from above, it will be treated as an unknown file. In this case, all the default interactions will be available such as downloading or opening the file externally, but there will be no preview of the content.</p><h2>Interaction</h2><ul><li>Regardless of the file type, a series of buttons will be displayed in the <em>Image</em> or <em>File</em> tab in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_BlN9DFI679QC\">Ribbon</a>.<ul><li><em>Download</em>, which will download the file for local use.</li><li><em>Open</em>, will will open the file with the system-default application.</li><li>Upload new revision to replace the file with a new one.</li></ul></li><li>It is <strong>not</strong> possible to change the note type of a <em>File</em> note.</li><li>Convert into an <a href=\"#root/_help_0vhv7lsOLy82\">attachment</a> from the <a href=\"#root/_help_8YBEPzcpUgxw\">note menu</a>.</li></ul><h2>Relation with other notes</h2><ul><li><p>Files are also displayed in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a>&nbsp;based on their type:</p><img class=\"image_resized\" style=\"aspect-ratio:853/315;width:50%;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/5_File_image.png\" width=\"853\" height=\"315\"></li><li><p>Non-image files can be embedded into text notes as read-only widgets via the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>&nbsp;functionality.</p></li><li><p>Image files can be embedded into text notes like normal images via&nbsp;<a class=\"reference-link\" href=\"#root/_help_0Ofbk1aSuVRu\">Image references</a>.</p></li></ul><h2>File size limit</h2><p>An individual file cannot be bigger than 374 MiB. For more information see <em>Maximum import size</em> in&nbsp;<a class=\"reference-link\" href=\"#root/_help_mHbBMPDPkVV5\">Import &amp; Export</a>.</p>",
- "_help_XJGJrpu7F9sh": "<figure class=\"image image_resized\" style=\"width:74.34%;\"><img style=\"aspect-ratio:1360/698;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/File/PDFs_image.png\" width=\"1360\" height=\"698\"></figure><p>PDFs file can be uploaded in Trilium, where they will be displayed without the need to download them first.</p><p>Since v0.102.0, PDFs will be rendered using Trilium's built-in PDF viewer, which is a customization of <a href=\"https://mozilla.github.io/pdf.js/\">Mozilla's PDF.js viewer</a> (also built-in in the Mozilla Firefox browser). Versions prior to that render PDFs using the browser's default PDF viewer.</p><h2>Features</h2><ul><li>The last page viewed and scroll position is maintained in between restarts or note navigations.</li><li>Annotations (text, highlights) as well as comments. These are saved automatically.</li><li>Forms can be filled.</li><li>Can be printed or downloaded.</li><li>Can be saved as a <a href=\"#root/_help_KC1HB96bqqHX\">template</a> and the content of the PDF will be copied over to the new note. This is especially useful in combination with annotations or filled forms.</li><li>Integrates with the sidebar in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_IjZS7iK5EXtb\">New Layout</a>, by displaying the list of pages with thumbnails, table of contents and a listing of the annotations.</li><li>Basic support for signatures (the hand-drawn ones, not proper digital signatures), similar to annotations. Signatures are stored and can be reused across multiple documents (up to 5).</li></ul><h2>Storing last position and settings</h2><p>For every PDF, Trilium will remember the following information:</p><ul><li>The current page.</li><li>The scroll position, within the current page.</li><li>The rotation of the page.</li></ul><p>This makes it useful when reading large documents since the position is remembered automatically. This happens in the background, however it's recorded only a few seconds after stopping any scroll actions.</p><aside class=\"admonition tip\"><p>Technically, the information about the scroll position and rotation is stored in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>&nbsp;section, in a dedicated attachment called <code spellcheck=\"false\">pdfHistory.json</code>.</p></aside><h2>Annotations</h2><p>Since v0.102.0 it's possible to annotate PDFs. To do so, look for the annotation buttons on the right side of the PDF toolbar (<img src=\"{{helpAssets}}/User%20Guide/Note%20Types/File/1_PDFs_image.png\" width=\"120\" height=\"32\">).</p><p>Since v0.103.0:</p><ul><li>Annotations are disabled if the note is marked as&nbsp;<a class=\"reference-link\" href=\"#root/_help_CoFPLs3dRlXc\">Read-Only Notes</a>.</li><li>Comments can also be added, which is similar to highlights but also attach a text.</li><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>&nbsp;also displays a list of annotations (highlights, comments), but only in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_IjZS7iK5EXtb\">New Layout</a>.</li></ul><h3>Supported annotations</h3><p>The following annotation methods are supported:</p><ul><li><strong>Highlight</strong><br>Allows highlighting text with one of the predefined colors.<ul><li>The thickness is also adjustable.</li><li>It's also possible to highlight the blank space, turning the feature more into a thicker pen.</li></ul></li><li><strong>Text</strong><br>Allows adding arbitrary text, with a custom color and size.</li><li><strong>Pen</strong><br>Allows free drawing on the document, with variable color, thickness and opacity.</li><li><strong>Image</strong><br>Allows inserting images from outside Trilium directly into the document.</li></ul><h3>Editing existing annotations</h3><p>Although annotations are stored in the PDF itself, they can be edited. To edit an annotation, press one of the annotation buttons from the previous section to enter edit mode and click on an existing annotation. This will reveal a toolbar with options to customize the annotation (e.g. to change a color), as well as the possibility to remove it.</p><h3>How are annotations stored</h3><p>Annotations are stored directly in the PDF. When modifications are made, Trilium will replace the PDF with the new one.</p><p>Since modifications are automatically saved, there's no need to manually save the document after making modifications to the annotations.</p><p>The benefit of “baked-in annotations” is that they are also accessible if downloading (for external use outside Trilium) or sharing the note.</p><p>The downside is that the entire PDF needs to be sent back to the server, which can slow down performance for larger documents. If you encounter any issues from this system, feel free to <a href=\"#root/_help_wy8So3yZZlH9\">report it</a>.</p><h2>Filling out forms</h2><p>Similar to annotations, forms are also supported by Trilium since v0.102.0. If the document has fields that can be filled-in, they will be indicated with a colored background.</p><p>Simply type text in the forms and they will be automatically saved.</p><h2>Sidebar navigation</h2><aside class=\"admonition note\"><p>This feature is only available if&nbsp;<a class=\"reference-link\" href=\"#root/_help_IjZS7iK5EXtb\">New Layout</a>&nbsp;is enabled. If you are using the old layout, these features are still available by looking for a sidebar button in the PDF viewer toolbar.</p></aside><p>See the dedicated section on PDFs in&nbsp;<a class=\"reference-link\" href=\"#root/_help_2dcGDhp9WFKb\">Outline tab</a>.</p><h2>Share functionality</h2><p>PDFs can also be shared using the&nbsp;<a class=\"reference-link\" href=\"#root/_help_R9pX4DGra2Vt\">Sharing</a>&nbsp;feature. This will also use Trilium's customized PDF viewer.</p><p>If you are using a reverse proxy on your server with strict access limitations for the share functionality, make sure that <code spellcheck=\"false\">[host].com/pdfjs</code> directory is accessible. Note that this directory is outside the <code spellcheck=\"false\">/share</code> route as it's common with the rest of the application.</p>",
- "_help_AjqEeiDUOzj4": "<figure class=\"image image-style-align-right image_resized\" style=\"width:61.8%;\"><img style=\"aspect-ratio:953/587;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/File/Audio%20%26%20Video_image.png\" width=\"953\" height=\"587\"></figure><p>Starting with v0.103.0, Trilium has a custom media player for both video and audio files, which offers more features than the built-in player.</p><p>Versions prior to v0.103.0 also support media, but using the built-in player.</p><p>The file is streamed directly, so when accessing the note from a server it doesn't have to download the entire file to start playing it.</p><h2>Note on large media files</h2><p>Although Trilium offers support for media files, it is generally not meant to be used with very large files. Uploading large media will cause the&nbsp;<a class=\"reference-link\" href=\"#root/_help_wX4HbRucYSDD\">Database</a>&nbsp;to balloon, as well as any&nbsp;<a class=\"reference-link\" href=\"#root/_help_ODY7qQn5m2FT\">Backup</a>&nbsp;of it. In addition, there might be slowdowns when first uploading the files. Otherwise, a large database should not impact the general performance of Trilium significantly.</p><h2>Supported formats</h2><p>Trilium uses the built-in media decoding mechanism of the browser (or Electron/Chromium when running on the desktop). Starting with v0.103.0, a message will be displayed instead when a media format is not supported.</p><h2>Interactions</h2><p>To play/pause, simply click anywhere on the media. For video files, the controls at the bottom will hide automatically after playing, simply move the mouse to show them again.</p><p>The bottom bar has the following features:</p><ul><li>A track bar to seek across the media. Audio files up to 60 MB will display a waveform seekbar, to give a visual overview of the track's structure: silences, pauses, and louder segments.</li><li>On the left of the track bar, the current time is indicated.</li><li>On the right of the track bar, the remaining time is indicated.</li><li>On the left side there are buttons to:<ul><li>Adjust the playback speed (e.g. 0.5x, 1x).</li><li>Play mode (applies to all media from the parent note):<ul><li>Play once — play the media until it ends, then stop.</li><li>Loop — replay the media automatically once it ends.</li><li>Play next — when the current item ends, continue with the next one in the same parent note until the last item finishes.</li></ul></li><li>Rotate the video by 90 degrees (video only).</li></ul></li><li>In the center:<ul><li>Previous media — jumps to the previous media: the nearest media note above the current one in the tree (within the same parent note) in the case of media notes, or the previous media attachment.</li><li>Go back by 10s</li><li>Play/pause</li><li>Go forward by 10s</li><li>Next media — jumps to the next media: the nearest media note below the current one in the tree (within the same parent note) in the case of media notes, or the next media attachment.</li></ul></li><li>On the right side:<ul><li>Mute button</li><li>Volume adjustment</li><li>Full screen (video only)</li><li>Zoom to fill, which will crop the video so that it fills the entire window (video only).</li><li>Picture-in-picture, if the browser supports it (video only).</li></ul></li></ul><h2>Including media in notes</h2><figure class=\"image\"><img style=\"aspect-ratio:1395/145;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/File/1_Audio%20%26%20Video_image.png\" width=\"1395\" height=\"145\"><figcaption>An audio note include (configured to the \"Small\" size).</figcaption></figure><p><a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_6RM1Q7ppFVoj\">Markdown</a>&nbsp;notes can embed an interactive media player directly in the note content. To do so, include the audio or video file:</p><ul><li><strong>Text notes:</strong> in the formatting toolbar, click “<strong>Insert”</strong> → <strong>“Include”.</strong></li><li><strong>Markdown notes:</strong> type <code spellcheck=\"false\">/include</code> press <kbd>Enter</kbd>.</li></ul><p>Then select the audio/video file note to be included.</p><h2>Keyboard shortcuts</h2><p>The following keyboard shortcuts are supported by the media player:</p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th></th>\n<th></th>\n</tr>\n</thead>\n<tbody><tr>\n<td><kbd>Space</kbd></td>\n<td>Play/pause</td>\n</tr>\n<tr>\n<td><kbd>Left arrow key</kbd></td>\n<td>Go back by 10s</td>\n</tr>\n<tr>\n<td><kbd>Right arrow key</kbd></td>\n<td>Go forward by 10s</td>\n</tr>\n<tr>\n<td><kbd>Ctrl</kbd> + <kbd>Left arrow key</kbd></td>\n<td>Go back by 1 min</td>\n</tr>\n<tr>\n<td><kbd>Ctrl</kbd> + <kbd>Right arrow key</kbd></td>\n<td>Go right by 1 min</td>\n</tr>\n<tr>\n<td><kbd>Page Up</kbd></td>\n<td>Navigate to the previous media</td>\n</tr>\n<tr>\n<td><kbd>Page Down</kbd></td>\n<td>Navigate to the next media</td>\n</tr>\n<tr>\n<td><kbd>F</kbd></td>\n<td>Toggle full-screen</td>\n</tr>\n<tr>\n<td><kbd>M</kbd></td>\n<td>Mute/unmute</td>\n</tr>\n<tr>\n<td><kbd>Home</kbd></td>\n<td>Go to the beginning of the media</td>\n</tr>\n<tr>\n<td><kbd>End</kbd></td>\n<td>Go to the end of the media</td>\n</tr>\n<tr>\n<td><kbd>Up</kbd></td>\n<td>Increase volume by 5%</td>\n</tr>\n<tr>\n<td><kbd>Down</kbd></td>\n<td>Decrease volume by 5%</td>\n</tr>\n<tr>\n<td><kbd>Alt+F1</kbd> (customizable)</td>\n<td>Show this list of keyboard shortcuts on screen.</td>\n</tr>\n</tbody></table></figure>",
- "_help_KG48zgNY31NW": "<p>Since v0.105.0, office documents stored in Trilium display an inline preview of their content, without the need to download them or open them in an external application.</p><h2>Supported formats</h2><ul><li>Microsoft Office formats: Word (<code spellcheck=\"false\">.docx</code>), Excel (<code spellcheck=\"false\">.xlsx</code>) and PowerPoint (<code spellcheck=\"false\">.pptx</code>).</li><li>The OpenDocument alternatives to the previous formats (Text, Spreadsheet, Presentation), created by editors such as LibreOffice and OpenOffice.</li><li><a href=\"https://en.wikipedia.org/wiki/Rich_Text_Format\">Rich Text Format (RTF)</a>.</li><li><a href=\"https://en.wikipedia.org/wiki/EPUB\">EPUB</a> e-books.</li></ul><aside class=\"admonition note\"><p>Older Microsoft Office formats (<code spellcheck=\"false\">.doc</code>, <code spellcheck=\"false\">.xls</code>, <code spellcheck=\"false\">.ppt</code>) are not supported.</p></aside><h2>How it works</h2><p>The document is converted to a simplified representation on the server and rendered as read-only content, similar to a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;note.</p><p>The preview generally preserves:</p><ul><li>Headings, paragraphs and text alignment.</li><li>Text formatting: bold, italic, underline, strikethrough, subscript/superscript, text and highlight colors, fonts and font sizes.</li><li>Bulleted and numbered lists.</li><li>Tables, including merged cells and cell background colors.</li><li>Embedded images.</li><li>Links and footnotes.</li></ul><p>To keep links readable regardless of the theme, the default hyperlink color applied automatically by word processors is ignored; links that were deliberately given a custom color by the author keep it.</p><h2>Limitations</h2><ul><li>The preview is read-only. To edit the document, download it or open it in an external application; the content of the note is not affected by the preview. Alternatively copy and paste it into a text note.</li><li>The preview is a simplified rendering: complex layouts (columns, text boxes, headers and footers), charts and the precise styling of table borders are not reproduced.</li><li>Documents larger than 20 MB are not previewed, to keep the server responsive. The usual download and open actions remain available.</li><li>If the document cannot be converted, a notice is displayed instead and the file can still be downloaded or opened externally.</li></ul><h2>Relation with other features</h2><ul><li>The same preview is used when an office document is displayed in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a>&nbsp;or embedded in a text note via&nbsp;<a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>, as well as for office documents stored as&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>.</li><li>Independently of the preview, the text content of office documents is also extracted in the background so that it can be found with&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>&nbsp;via&nbsp;<a class=\"reference-link\" href=\"#root/_help_TiQbQDgP8L5t\">Text Extraction (OCR)</a>.</li><li><code spellcheck=\"false\">.csv</code> and <code spellcheck=\"false\">.xlsx</code> files can be converted to&nbsp;<a class=\"reference-link\" href=\"#root/_help_GWHEkY4I4OE3\">Spreadsheets</a>&nbsp;via the <a href=\"#root/_help_mHbBMPDPkVV5\">import</a> function.</li></ul>",
- "_help_GWHEkY4I4OE3": "<figure class=\"image\"><img style=\"aspect-ratio:1102/573;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Spreadsheets_image.png\" width=\"1102\" height=\"573\"></figure><aside class=\"admonition important\"><p>Spreadsheets are a new type of note introduced in v0.103.0 and are currently considered experimental/beta. As such, expect major changes to occur to this note type.</p></aside><p>Spreadsheets provide a familiar experience to Microsoft Excel or LibreOffice Calc, with support for formulas, data validation and text formatting.</p><h2>Spreadsheets vs. collections</h2><p>There is a slight overlap between spreadsheets and the&nbsp;<a class=\"reference-link\" href=\"#root/_help_2FvYrpmOXm29\">Table</a>&nbsp;collection. In general the table collection is useful to track meta-information about notes (for example a collection of people and their birthdays), whereas spreadsheets are quite useful for calculations since they support formulas.</p><p>Spreadsheets also benefit from a wider range of features such as data validation, formatting and can work on a relatively large dataset.</p><h2>Data intercompatibility (import/export)</h2><p>Starting with v0.104.0, Trilium provides a level of data intercompatibility between the internal format (Univer) and the following formats:</p><ul><li>Microsoft Excel (.xlsx)<ul><li>Preserves basic formatting (fonts, sizes, borders, backgrounds).</li><li>Formulas are preserved, but note that not all Excel functions are supported and vice-versa with Univer.</li><li>Images (cell-bound or floating), without preserving rotation.</li><li>Supports multi-sheets natively.</li></ul></li><li>Comma-Separated Values (.csv)<ul><li>Since it's a text-based format, any formatting is lost.</li><li>Formulas are evaluated and turned into their final value instead.</li><li>Multi-sheets spreadsheets are exported as a single ZIP containing a CSV file per sheet.</li></ul></li></ul><p>Both <a href=\"#root/_help_mHbBMPDPkVV5\">import and export</a> are supported, as follows:</p><ul><li>To import a file, simply drag it into the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and it will be converted into a spreadsheet note.<ul><li>To avoid this behavior (e.g. to import a .xlsx file as an actual&nbsp;<a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a>), uncheck the corresponding option in the <a href=\"#root/_help_mHbBMPDPkVV5\">Import dialog</a>.</li><li>Multiple files can be imported at the same time, including a mixture of .csv and .xlsx files. Folder structure can be preserved by using a .zip file.</li></ul></li><li>Unlike importing, exporting is on a per-note basis:<ul><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note buttons</a>, choose the <em>Export to Excel</em> or <em>Export to CSV</em> options for the&nbsp;<a class=\"reference-link\" href=\"#root/_help_IjZS7iK5EXtb\">New Layout</a>.</li><li>For the old layout, choose the corresponding buttons in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_XpOYSgsLkTJy\">Floating buttons</a>&nbsp;area.</li><li>If exported as a single file via&nbsp;<a class=\"reference-link\" href=\"#root/_help_mHbBMPDPkVV5\">Import &amp; Export</a>, the resulting file will be a custom <code spellcheck=\"false\">.triliumsheet</code> file that preserves the spreadsheet as-is.<ul><li>The export is intentionally a different process than the normal&nbsp;<a class=\"reference-link\" href=\"#root/_help_mHbBMPDPkVV5\">Import &amp; Export</a>&nbsp;functionality because it does conversion to multiple formats with varying degrees of compatibility.</li></ul></li></ul></li></ul><aside class=\"admonition important\"><p>Import &amp; export for both .xlsx and .csv files are supported on a best-effort basis. It does not support advanced features (data validation, scripting, etc.). If you notice a particular issue, it can be <a href=\"#root/_help_wy8So3yZZlH9\">reported</a>, however all bug reports must contain a sample file in order to be taken into consideration.</p></aside><h2>Supported features</h2><p>The spreadsheet has support for the following features:</p><ul><li>Since v0.104.0, images that can be either inside a cell or floating above.<ul><li>The images are saved as&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>&nbsp;for performance reasons.</li><li>The image upload respects the same compression settings as text&nbsp;<a class=\"reference-link\" href=\"#root/_help_mT0HEkOsz6i1\">Images</a>.</li></ul></li><li>Filtering</li><li>Sorting</li><li>Data validation</li><li>Conditional formatting</li><li>Notes / annotations</li><li>Find / replace</li></ul><p>We might consider adding <a href=\"https://docs.univer.ai/guides/sheets/features/filter\">other features</a> from Univer at some point. If there is a particular feature that can be added easily, it can be discussed over <a href=\"#root/_help_wy8So3yZZlH9\">GitHub Issues</a>.</p><h3>Share functionality</h3><p>Spreadsheets can be <a href=\"#root/_help_R9pX4DGra2Vt\">shared</a>, case in which a best-effort HTML rendering of the spreadsheet is done:</p><ul><li>Preserves basic formatting.</li><li>Cells with formulas display the precalculated value instead of the formula.</li></ul><p>Since v0.104.0:</p><ul><li>Numbers and dates are properly formatted.</li><li>Images are shown inside a cell or floating above, including rotation.</li></ul><p>For more advanced use cases, this will most likely not work as intended. Feel free to <a href=\"#root/_help_wy8So3yZZlH9\">report issues</a>, but keep in mind that we might not be able to have a complete feature parity with all the features of Univer.</p><h2>Features not supported yet</h2><h3>Regarding Pro features</h3><p>Univer spreadsheets also feature a <a href=\"https://univer.ai/pro\">Pro plan</a> which adds quite a lot of functionality such as charts, printing, pivot tables, export, etc.</p><p>As the Pro plan needs a license, Trilium does not support any of the premium features. Theoretically, pro features can be used in trial mode with some limitations, we might explore this direction at some point.</p><h3>Planned features</h3><p>There are a few features that are already planned but are not supported yet:</p><ul><li>Trilium-specific formulas (e.g. to obtain the title of a note).</li><li>User-defined formulas</li><li>Cross-workbook calculation</li></ul><p>If you would like us to work on these features, consider <a href=\"https://triliumnotes.org/en/support-us\">supporting us</a>.</p><h3>Mobile support</h3><p>Versions prior to v0.104.0 have no dedicated mobile support, which means that the interaction is difficult without a mouse and keyboard. Starting with v0.104.0 we integrate Univer's mobile plugin, which introduces feature such as drag to pan which makes the interface more usable on mobile.</p>",
- "_help_6RM1Q7ppFVoj": "<p>Trilium has always supported Markdown through its <a href=\"#root/_help_Oau6X9rCuegd\">import feature</a>, however the file was either transformed to a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;note (converted to Trilium's internal HTML format) or saved as a&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note with only syntax highlight.</p><p>This note type is a split view, meaning that both the source code and a preview of the document are displayed side-by-side. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_SL5f1Auq7sVN\">Note types with split view</a>&nbsp;for more information.</p><h2>Rationale</h2><p>The goal of this note type is to fill a gap: rendering Markdown but not altering its structure or its whitespace which would inevitably change otherwise through import/export.</p><p>Even if Markdown is now specially treated by having a preview mechanism, Trilium remains at its core a WYSWYG editor so Markdown will not replace text notes.</p><aside class=\"admonition note\"><p>Feature requests regarding the Markdown implementation will be considered, but if they are outside the realm of Trilium, they will not be implemented. One of the core aspects of the Markdown integration is that it reuses components that are already available through other features of the application.</p></aside><h2>Features</h2><h3>Source view pane</h3><ul><li>Syntax highlighting for the Markdown syntax.</li><li>Nested syntax highlighting for code inside code blocks.</li><li>When editing larger documents, the preview scrolls along with the source editor.</li></ul><h3>Preview pane</h3><p>The following features are supported by Trilium's Markdown format and will show up in the preview pane:</p><ul><li><p>All standard and GitHub-flavored syntax (basic formatting, tables, blockquotes).</p></li><li><p>Basic HTML is also supported (e.g. collapsible blocks using <code spellcheck=\"false\">&lt;details&gt;</code> and <code spellcheck=\"false\">&lt;summary&gt;</code>).</p></li><li><p>Code blocks with syntax highlight.</p><ul><li>The language must be specified for syntax highlight to be applied (e.g. <code spellcheck=\"false\">```js</code>).</li><li>Code blocks will respect the text wrapping from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;section in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>.</li></ul></li><li><p><a class=\"reference-link\" href=\"#root/_help_NwBbFdNZ9h7O\">Block quotes &amp; admonitions</a></p></li><li><p><a class=\"reference-link\" href=\"#root/_help_YfYAtQBcfo5V\">Math Equations</a>&nbsp;(both inline and block)</p></li><li><p><a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a>&nbsp;using <code spellcheck=\"false\">```mermaid</code></p></li><li><p><a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>&nbsp;(no built-in Markdown syntax, but HTML syntax works just fine):</p><pre><code class=\"language-text-html\">&lt;section class=\"include-note\" data-note-id=\"vJDjQm0VK8Na\" data-box-size=\"expandable\"&gt;\n &amp;nbsp;\n&lt;/section&gt;</code></pre><ul><li>These can also be quickly created via the <code spellcheck=\"false\">/include</code> command or via a dedicated keyboard shortcut (not assigned by default).</li></ul></li><li><p><a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;via its HTML syntax, or through a <em>Wikilinks</em>-like format (only&nbsp;<a class=\"reference-link\" href=\"#root/_help_m1lbrzyKDaRB\">Note ID</a>):</p><pre><code class=\"language-text-x-trilium-auto\">[[Hg8TS5ZOxti6]]</code></pre></li><li><p>To-do lists with extended task states:</p><table class=\"ck-table-resized\" style=\"border-style:none\">\n <colgroup>\n <col style=\"width:80.6%;\">\n <col style=\"width:19.4%;\">\n </colgroup>\n <tbody>\n <tr>\n <td><pre><code class=\"language-text-x-markdown\">- [ ] None\n- [/] Doing\n- [X] Done\n- [?] Maybe\n- [-] Cancelled</code></pre></td>\n <td><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:218/221;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Markdown_image.png\" width=\"218\" height=\"221\"></figure></td>\n </tr>\n </tbody>\n</table><p>Task states are customizable: you can reorder them, create new ones with different colors and symbols, or delete the ones you don't need. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_i16PM6A7GXdU\">Customizing to-do task states</a>&nbsp;for more details.</p><p>Note that to-do items with task states other than \"None\" and \"Done\" are Trilium-specific and may not work well with other Markdown software.</p></li><li><p><a class=\"reference-link\" href=\"#root/_help_AgjCISero73a\">Footnotes</a>&nbsp;are also supported via the corresponding Markdown syntax:</p><pre><code class=\"language-text-x-trilium-auto\">This is [^1], while this is [^2].\n\n[^1]: the first footnote\n[^2]: the second footnote</code></pre><ul><li>These can also be quickly created using the <code spellcheck=\"false\">/footnote</code> command.</li></ul></li><li><p>Page breaks for&nbsp;<a class=\"reference-link\" href=\"#root/_help_NRnIZmSMc5sj\">Printing &amp; Exporting as PDF</a>:</p><pre><code class=\"language-text-x-trilium-auto\">&lt;div class=\"page-break\"&gt;&lt;/div&gt;</code></pre></li><li><p>Highlights (background color) are supported both via the <code spellcheck=\"false\">==</code> Markdown syntax, as well as the canonical HTML representation in Trilium:</p><pre><code class=\"language-text-x-trilium-auto\">==highlighted==\n&lt;span style=\"background-color:hsl(0,0%,100%);\"&gt;Highlighted&lt;/span&gt;</code></pre></li></ul><h3>Links</h3><p>Multiple types of links are supported:</p><ul><li><p>Web URLs can be written with the standard Markdown syntax:</p><pre><code class=\"language-text-x-trilium-auto\">[Wikipedia](https://www.wikipedia.org)</code></pre></li><li><p><a href=\"#root/_help_hrZ1D00cLbal\">Reference link</a> to other notes with dynamic title, either by manually entering the note ID or via the <em>Add link</em> dialog:</p><pre><code class=\"language-text-x-trilium-auto\">[[B9oMG6rFvvfq]]</code></pre></li><li><p><a href=\"#root/_help_hrZ1D00cLbal\">Reference link</a> to other notes with a custom text:</p><pre><code class=\"language-text-x-trilium-auto\">[This is a link](#root/LhtnZxtVsUMp)</code></pre></li></ul><p>To create a link, either:</p><ul><li>Type it manually using the syntax described above.</li><li>Use the <em>Add link</em> dialog by pressing <kbd>Ctrl</kbd>+<kbd>L</kbd> or typing the <code spellcheck=\"false\">/link</code> command.</li></ul><p><a class=\"reference-link\" href=\"#root/_help_UmgZAfcltxkS\">Link Previews</a>&nbsp;are also rendered, but there is no mechanism to insert them automatically as of now, they have to be copied from a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;note instead.</p><h3>Keyboard shortcuts</h3><p>The Markdown notes share some of the keyboard shortcuts from&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes:</p><ul><li><em>Cut to note</em> (<kbd>Ctrl</kbd>+<kbd>X</kbd>) which cuts the selection into a new child note.</li><li><em>Add link</em> (<kbd>Ctrl</kbd>+<kbd>L</kbd>) which shows the dialog to create external or reference links.</li><li><em>Insert date/time</em> (<kbd>Alt</kbd>+<kbd>T</kbd>) which respects the same formatting as text notes.</li><li><em>Include note</em> (not assigned by default), which triggers the same dialog to insert notes as the one for text notes.</li></ul><p>In addition, the following formatting keyboard shortcuts are available:</p><ul><li><kbd>Ctrl</kbd>+<kbd>B</kbd> to toggle <strong>bold</strong>.</li><li><kbd>Ctrl</kbd>+<kbd>I</kbd> to toggle <em>italic</em>.</li><li><kbd>Ctrl</kbd>+<kbd>M</kbd> to wrap the current selection in an inline math (<code spellcheck=\"false\">$</code>).</li><li><kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>X</kbd> to toggle <del>strikethrough</del>.</li></ul><h3>Images &amp; attachments</h3><p>Images can be inserted into the document in four different methods:</p><ul><li>Drag &amp; drop directly into the editor area.</li><li>Pasting an image from clipboard.</li><li>Pasting a reference to another <a href=\"#root/_help_0vhv7lsOLy82\">attachment</a> (e.g. <em>Copy reference to clipboard</em> button).</li><li>Use the <code spellcheck=\"false\">/image</code> slash command.</li></ul><p>An image reference to an attachment looks like this:</p><pre><code class=\"language-text-x-trilium-auto\">![Name.jpeg](api/attachments/z50RceuHXe9J/image/image)</code></pre><h3>Auto-completion</h3><h4>Slash commands</h4><p>Just like&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes, Markdown notes support a selection of slash commands:</p><ul><li>Inserting the current date &amp; time (<code spellcheck=\"false\">/date</code>).</li><li><a href=\"#root/_help_nBAXQFj20hS1\">Including</a> another note (<code spellcheck=\"false\">/include</code>).</li><li>Uploading and inserting an image (<code spellcheck=\"false\">/image</code>).</li><li>Inserting a note link (<code spellcheck=\"false\">/link</code>).</li><li>Inserting a math equation block (<code spellcheck=\"false\">/math</code>).</li><li>Inserting a <a href=\"#root/_help_AgjCISero73a\">footnote</a> (<code spellcheck=\"false\">/footnote</code>).</li><li>Inserting a <a href=\"#root/_help_s1aBHPd79XYj\">Mermaid</a> diagram (<code spellcheck=\"false\">/mermaid</code>), with one variant per sample template (e.g. <code spellcheck=\"false\">/mermaid:flowchart</code>).</li><li>Inserting a collapsible block (<code spellcheck=\"false\">/collapsible</code>).</li><li>Inserting a page break for printing (<code spellcheck=\"false\">/page-break</code>).</li><li>Inserting a table (<code spellcheck=\"false\">/table</code>).</li><li>Creating admonitions (e.g. <code spellcheck=\"false\">/tip</code>, <code spellcheck=\"false\">/note</code>, <code spellcheck=\"false\">/important</code>, <code spellcheck=\"false\">/caution</code>, <code spellcheck=\"false\">/warning</code>).</li><li>Inserting task items (<code spellcheck=\"false\">/todo:&lt;state&gt;</code>, e.g. <code spellcheck=\"false\">/todo:done</code>), one per configured task state.</li><li>Inserting code snippets (<code spellcheck=\"false\">/snippet:&lt;name&gt;</code>) from your Markdown/plain-text snippet notes.</li></ul><p>Note that slash commands only work outside of code blocks and inline code.</p><h4>Code block language auto-completion</h4><p>Starting with v0.104.0, typing ``` to insert a code block will automatically open a list of suggested language types which have syntax highlighting.</p><p>The list of languages matches the one for&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;notes set in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>, it's not the full list of languages supported by Trilium.</p><h3>Other features</h3><ul><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_BFvAtE74rbP6\">Table of contents</a>&nbsp;will be displayed in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>&nbsp;based on the Markdown-level headings.<ul><li>This feature is available only on the&nbsp;<a class=\"reference-link\" href=\"#root/_help_IjZS7iK5EXtb\">New Layout</a>.</li></ul></li></ul><h3>Shared notes</h3><p>When a Markdown note is <a href=\"#root/_help_R9pX4DGra2Vt\">shared publicly</a>, it will be rendered with extended formatting just like&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes.</p><p>Most of the features described previously should be supported. If you face any issues, feel free to <a href=\"#root/_help_wy8So3yZZlH9\">report it</a> alongside a sample Markdown file.</p><h2>Creating Markdown notes</h2><p>There are two ways to create a Markdown note:</p><ol><li>Create a new note (e.g. in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>) and select the type <em>Markdown</em>, just like all the other note types.</li><li>Create a note of type&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;and select as the language either <em>Markdown</em> or <em>GitHub-Flavored Markdown</em>. This maintains compatibility with your existing notes prior to the introduction of this feature.</li></ol><aside class=\"admonition note\"><p>There is no distinction between the new Markdown note type and code notes of type Markdown; internally both are represented as&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;notes with one of the following MIME types:</p><ul><li><code spellcheck=\"false\">text/markdown</code></li><li><code spellcheck=\"false\">text/x-markdown</code></li><li><code spellcheck=\"false\">text/x-gfm</code> (GitHub Flavored Markdown)</li></ul></aside><h2>Import/export</h2><h3>Import</h3><p>By default, when importing a single Markdown file it automatically gets converted to a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;note. To avoid that and have it imported as a Markdown note instead:</p><ul><li>Right click the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and select <em>Import into note</em>.</li><li>Select the file normally.</li><li>Uncheck <em>Import HTML, Markdown and TXT as text notes if it's unclear from the metadata</em>.</li></ul><p>When importing a Trilium ZIP, it will preserve the Markdown type without converting to text notes thanks to the meta-information in it.</p><h3>Exporting</h3><p>When exporting Markdown files, the extension is preserved and the content remains the same as in the source view (with some small exceptions such as handling of attachments).</p><p>When exporting Markdown files as ZIP, choosing HTML or Markdown as the export format makes no difference as that only affects&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes.</p><p>If the Markdown note contains attachments, a ZIP export will rewrite the links to attachments so that they are replaced with a relative path to the attachment. On import, the links are re-written back.</p><h2>Conversion between text notes and Markdown notes</h2><p><a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes can be converted into Markdown notes and vice versa. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_jludwdW7N4hg\">Converting between note types</a>.</p><h2>Sync-scrolling &amp; block highlight</h2><p>When scrolling through the editing pane, the preview pane will attempt to synchronize its position to make it easier to see the preview.</p><p>In addition, the block in the preview matching the position of the cursor in the source view will appear slightly highlighted.</p><p>The sync is currently one-way only, scrolling the preview will not synchronize the position of the editor.</p><p>This feature cannot be disabled as of now; if the scrolling feels distracting, consider temporarily switching to the editor mode and then switching to preview mode when ready.</p><aside class=\"admonition note\"><p>This feature of synchronizing the scroll is based on blocks but it's provided on a best-effort basis since our underlying Markdown library doesn't support this feature natively, so we had to implement our own algorithm. Feel free to <a href=\"#root/_help_wy8So3yZZlH9\">report issues</a>, but always provide a sample Markdown file to be able to reproduce it.</p></aside>",
- "_help_jludwdW7N4hg": "<p>A note's type may be converted to another:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes to&nbsp;<a class=\"reference-link\" href=\"#root/_help_6RM1Q7ppFVoj\">Markdown</a>&nbsp;notes</li><li>Markdown notes to Text notes</li></ul><p>Before conversion, a revision is saved automatically, so you can restore the original or recover any missing elements from it if the conversion produces undesired results. Read more about&nbsp;<a class=\"reference-link\" href=\"#root/_help_vZWERwf8U3nx\">Note Revisions</a>.</p><h2>Converting individual notes</h2><h3>Markdown to Text Note</h3><p>Markdown notes can be converted to Text Notes with negligible loss of formatting fidelity.</p><p>To do so, go to the note menu → “<strong>Advanced”</strong> and select \"<strong>Convert to Text Note</strong>\".</p><h3>Text Note to Markdown</h3><aside class=\"admonition warning\"><p>Since Markdown does not support all the capabilities of Text notes, this conversion is lossy in terms of formatting: some formatting may be lost, and some unsupported elements may even be dropped. It's strongly recommended that you inspect the content for any information that might have gone missing after the conversion.</p></aside><p>To convert a text note to Markdown, go to the note menu → <strong>“Advanced”</strong> and select <strong>\"Convert to Markdown Note\"</strong>.</p><h2>Converting multiple notes</h2><p>A note type conversion can also be performed on an entire subtree or a set of multiple notes using&nbsp;<a class=\"reference-link\" href=\"#root/_help_ivYnonVFBxbQ\">Bulk Actions</a>.</p>",
- "_help_GTwFsgaA0lCt": "<p>Collections are a unique type of note that don't have content, but instead display their child notes in various presentation methods.</p><h2>Main collections</h2><figure class=\"table\"><table>\n<thead>\n<tr>\n<th></th>\n<th></th>\n</tr>\n</thead>\n<tbody><tr>\n<td><figure class=\"image\"><img style=\"aspect-ratio:1651/810;\" src=\"{{helpAssets}}/User%20Guide/Collections_collection_calendar.webp\" width=\"1651\" height=\"810\"></figure></td>\n<td><a class=\"reference-link\" href=\"#root/_help_xWbu3jpNWapp\">Calendar</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <br>which displays a week, month or year calendar with the notes being shown as events. New events can be added easily by dragging across the calendar.</td>\n</tr>\n<tr>\n<td><figure class=\"image\"><img style=\"aspect-ratio:1643/647;\" src=\"{{helpAssets}}/User%20Guide/Collections_collection_table.webp\" width=\"1643\" height=\"647\"></figure></td>\n<td><a class=\"reference-link\" href=\"#root/_help_2FvYrpmOXm29\">Table</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <br>displays each note as a row in a table, with&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;being shown as well. This makes it easy to visualize attributes of notes, as well as making them easily editable.</td>\n</tr>\n<tr>\n<td><figure class=\"image\"><img style=\"aspect-ratio:1174/850;\" src=\"{{helpAssets}}/User%20Guide/Collections_collection_board.webp\" width=\"1174\" height=\"850\"></figure></td>\n<td><a class=\"reference-link\" href=\"#root/_help_CtBQqbwXDx1w\">Kanban Board</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <br>displays notes in columns, grouped by the value of a label. Items and columns can easily be created or dragged around to change their status.</td>\n</tr>\n<tr>\n<td><figure class=\"image\"><img style=\"aspect-ratio:844/639;\" src=\"{{helpAssets}}/User%20Guide/Collections_collection_geomap.webp\" width=\"844\" height=\"639\"></figure></td>\n<td><a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <br>which displays a geographical map in which the notes are represented as markers/pins on the map. New events can be easily added by pointing on the map.</td>\n</tr>\n<tr>\n<td><figure class=\"image\"><img style=\"aspect-ratio:1120/763;\" src=\"{{helpAssets}}/User%20Guide/Collections_collection_presentation.webp\" width=\"1120\" height=\"763\"></figure></td>\n<td><a class=\"reference-link\" href=\"#root/_help_zP3PMqaG71Ct\">Presentation</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <br>which shows each note as a slide and can be presented full-screen with smooth transitions or exported to PDF for sharing.</td>\n</tr>\n</tbody></table></figure><h2>Classic collections</h2><p>Classic collections are read-only mode and compiles the contents of all child notes into one continuous view. This makes it ideal for reading extensive information broken into smaller, manageable segments.</p><ul><li><a class=\"reference-link\" href=\"#root/_help_8QqnMzx393bx\">Grid View</a>&nbsp;which is the default presentation method for child notes (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a>), where the notes are displayed as tiles with their title and content being visible.</li><li><a class=\"reference-link\" href=\"#root/_help_mULW0Q3VojwY\">List View</a>&nbsp;is similar to&nbsp;<a class=\"reference-link\" href=\"#root/_help_8QqnMzx393bx\">Grid View</a>, but it displays the notes one under the other with the content being expandable/collapsible, but also works recursively.</li></ul><p>Classic collections make use of pagination to support a large number of notes. The size of a page can be customized via <code spellcheck=\"false\">pageSize</code>.</p><h2>Creating a new collection</h2><p>To create a new collections, right click in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and look for the <em>Collections</em> entry and select the desired type.</p><p>By default, collections come with a default configuration and sometimes even sample notes. To create a collection completely from scratch:</p><ol><li>Create a new note of type <em>Text</em> (or any type).</li><li>Change the <a href=\"#root/_help_KSZ04uQ2D1St\">note type</a> to <em>Collection</em>.</li><li>In&nbsp;<a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>, select the desired view type.</li><li>Consult the help page of the corresponding view type in order to understand how to configure them.</li></ol><h2>Configuration</h2><p>To change the configuration of a collection or even switch to a different collection (e.g. from Kanban Board to a Calendar), see the&nbsp;<a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>&nbsp;bar at the top of the note.</p><h2>Archived notes</h2><p>By default, <a href=\"#root/_help_MKmLg5x6xkor\">archived notes</a> will not be shown in collections. This behavior can be changed by going to&nbsp;<a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>&nbsp;and checking <em>Show archived notes</em>.</p><p>Archived notes will be generally indicated by being greyed out as opposed to the normal ones.</p><h2>Hiding the child notes from the note tree</h2><p>For collections with a large number of items, it can be helpful to hide the items from the note tree for performance reasons and to reduce clutter. This is especially useful for standalone collections, such as a geomap or a task board.</p><p>To do so, go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>&nbsp;and select <em>Hide child notes in tree</em>.</p><h2>Advanced use cases</h2><h3>Adding a description to a collection</h3><p>To add a text before the collection, for example to describe it:</p><ol><li>Create a new collection.</li><li>Change the <a href=\"#root/_help_KSZ04uQ2D1St\">note type</a> from <em>Collection</em> to <em>Text</em>.</li></ol><p>Now the text will be displayed above while still maintaining the collection view.</p><p>The only downside to this method is that&nbsp;<a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>&nbsp;will not be shown anymore. In this case, modify the attributes manually or switch back temporarily to the <em>Collection</em> type for configuration purposes.</p><h3>Using saved search</h3><p>Collections, by default, only display the child notes. However, it is possible to use the&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>&nbsp;functionality to display notes all across the tree, with advanced querying functionality.</p><p>To do so, simply start a&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>&nbsp;and go to the <em>Collection Properties</em> tab in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_BlN9DFI679QC\">Ribbon</a>&nbsp;and select a desired type of collection. To keep the search-based collection, use a&nbsp;<a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a>.</p><aside class=\"admonition important\"><p>While in search, none of the collections will not display the child notes of the search results. The reason is that the search might hit a note multiple times, causing an exponential rise in the number of results.</p></aside><h2>Under the hood</h2><p>Collections by themselves are simply notes with no content that rely on the&nbsp;<a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a>&nbsp;mechanism (the one that lists the children notes at the bottom of a note) to display information.</p><p>By default, new collections use predefined&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>&nbsp;that are stored safely in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_2mUhVmZK8RF3\">Hidden Notes</a>&nbsp;to define some basic configuration such as the type of view, but also some&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;to make editing easier.</p><p>Collections don't store their configuration (e.g. the position on the map, the hidden columns in a table) in the content of the note itself, but as attachments.</p>",
- "_help_xWbu3jpNWapp": "<figure class=\"image\"><img style=\"aspect-ratio:2016/1413;\" src=\"{{helpAssets}}/User%20Guide/Collections/1_Calendar_image.png\" width=\"2016\" height=\"1413\"></figure><p>The Calendar view will display each child note in a calendar that has a start date and optionally an end date, as an event.</p><p>The Calendar view has multiple display modes:</p><ul><li>Month view, where the entire month is displayed and all-day events can be inserted. Both time-specific events and all-day events are listed.</li><li>Week view, where all the 7 days of the week (or 5 if the weekends are hidden) are displayed in columns. This mode allows entering and displaying time-specific events, not just all-day events.</li><li>Day view, which views only a single day. Especially useful for heavy agendas or mobile views.</li><li>List view, which displays all the events of a given month in sequence.</li><li>Year view, which displays the entire year for quick reference.</li></ul><p>Unlike other Collection view types, the Calendar view also allows some kind of interaction, such as moving events around as well as creating new ones.</p><h2>Creating a calendar</h2><p>Right click on an existing note in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and select <em>Insert child note</em> and look for <em>Calendar</em>.</p><h2>Creating a new event/note</h2><p>To create a new event:</p><ul><li>First, click the desired day (month &amp; year views) or the desired timeslot (day view).</li><li>Alternatively, drag across multiple days (or time slots) to set both the start and end date.</li></ul><p>In either cases, a small popup will show with a prompt for a title and the date &amp; time of the event that will be created.</p><p>At this point, the event hasn't been created yet to protect against accidental clicks. Add a title optionally and press the <em>Create</em> button. If no title is provided, the event will follow the&nbsp;<a class=\"reference-link\" href=\"#root/_help_47ZrP6FNuoG8\">Default Note Title</a>&nbsp;rules.</p><p>After creating the event, it will show up on the calendar. To edit the content of the event (including recurrence), click on it to bring it into the popup view.</p><aside class=\"admonition note\"><p>Creating new notes from the calendar will respect the <code spellcheck=\"false\">~child:template</code> relation if set on the Collection note.</p></aside><h2>Interacting with events</h2><ul><li>Hovering the mouse over an event will display information about the note.<br><img src=\"{{helpAssets}}/User%20Guide/Collections/4_Calendar_image.png\"></li><li>Left clicking the event will open a&nbsp;dedicated popup to quickly configure the event or edit its note content.</li><li>Right click will offer more options including opening the note in a new split or window.</li><li>Drag and drop an event on the calendar to move it to another day.</li><li>The length of an event can be changed by placing the mouse to the right edge of the event and dragging the mouse around.</li></ul><h3>Popup view</h3><p>When an event is clicked, a popup will show near the event which contains the following inforamtion:</p><ul><li>The title and icon of the event, both editable.</li><li>Buttons to interact with the event:<ul><li>Open the event in the same pane, new tab, etc.</li><li>Color picker to change the color of the event.</li><li>Button to remove the event from the calendar, which can optionally delete its corresponding note.</li></ul></li><li>Calendar-specific features:<ul><li>A toggle for all-day events.</li><li>A start/end date &amp; time selector.</li><li>A full recurrence editor, to have the same event show up weekly, monthly, etc.</li></ul></li><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;of the marker, if any.</li><li>The note's content which can be edited directly from the panel.</li></ul><p>To dismiss the popup:</p><ul><li>Press the X button at the top-right of the popup.</li><li>In the calendar, press anywhere outside the popup.</li><li>Or simply press the <kbd>Escape</kbd> key.</li></ul><p>It is possible to switch between events by clicking on them even when the popup view is already open.</p><p>Events can have&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;between them and clicking on such a link will automatically navigate the calendar to the right date and the popup view to the new note.</p><h2>Interaction on mobile</h2><p>When Trilium is on mobile, the interaction with the calendar is slightly different:</p><ul><li>Clicking on an event displays the popup view, which allows editing the event.</li><li>Long-presing an event triggers the contextual menu, including the option to open in&nbsp;<a class=\"reference-link\" href=\"#root/_help_ZjLYv08Rp3qC\">Quick edit</a>.</li><li>To insert a new event, touch and hold the empty space. When successful, the empty space will become colored to indicate the selection.<ul><li>Before releasing, drag across multiple spaces to create multi-day events.</li><li>When released, a prompt will appear to enter the note title.</li></ul></li><li>To move an existing event, touch and hold the event until the empty space near it will become colored.<ul><li>At this point the event can be dragged across other days on the calendar.</li><li>Or the event can be resized by tapping on the small circle to the right end of the event.</li><li>To exit out of editing mode, simply tap the empty space anywhere on the calendar.</li></ul></li></ul><h2>Configuring the calendar view</h2><p>In the <em>Collections</em> tab in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_BlN9DFI679QC\">Ribbon</a>, it's possible to adjust the following:</p><ul><li>Hide weekends from the week view.</li><li>Display week numbers on the calendar.</li><li>Set the slot duration (the length of each time row in day/week view).</li><li>Set the slot label interval (how often time labels appear on the axis in day/week view).</li></ul><h2>Configuring the calendar using attributes</h2><p>The following attributes can be added to the Collection type:</p><table>\n <thead>\n <tr>\n <th>Name</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td><code spellcheck=\"false\">#calendar:hideWeekends</code></td>\n <td>When present (regardless of value), it will hide Saturday and Sundays from the calendar.</td>\n </tr>\n <tr>\n <td><code spellcheck=\"false\">#calendar:weekNumbers</code></td>\n <td>When present (regardless of value), it will show the number of the week on the calendar.</td>\n </tr>\n <tr>\n <td><code spellcheck=\"false\">#calendar:initialDate</code></td>\n <td>Change the date the calendar opens on. When not present, the calendar opens on the current date.</td>\n </tr>\n <tr>\n <td><code spellcheck=\"false\">#calendar:view</code></td>\n <td><p>Which view to display in the calendar:</p><ul><li><code spellcheck=\"false\">timeGridDay</code> for the <em>day</em> view;</li><li><code spellcheck=\"false\">timeGridWeek</code> for the <em>week</em> view;</li><li><code spellcheck=\"false\">dayGridMonth</code> for the <em>month</em> view;</li><li><code spellcheck=\"false\">multiMonthYear</code> for the <em>year</em> view;</li><li><code spellcheck=\"false\">listMonth</code> for the <em>list</em> view.</li></ul><p>Any other value will be dismissed and the default view (month) will be used instead.</p><p>The value of this label is automatically updated when changing the view using the UI buttons.</p></td>\n </tr>\n <tr>\n <td><code spellcheck=\"false\">#calendar:slotDuration</code></td>\n <td>Sets how long each timeslot is on the calendar. Defaults to <code spellcheck=\"false\">00:15:00</code> (15 minutes). Must have the format \"HH:MM:SS\". For example, to create timeslots for every 10 minutes, you would set <code spellcheck=\"false\">#calendar:slotDuration=\"00:10:00\"</code>.</td>\n </tr>\n <tr>\n <td><code spellcheck=\"false\">#calendar:slotLabelInterval</code></td>\n <td>Sets how often the timeslots on the calendar should be labeled. Defaults to <code spellcheck=\"false\">01:00:00</code> (1 hour). Must have the format \"HH:MM:SS\". For example, to label timeslots every 30 minutes, you would set <code spellcheck=\"false\">#calendar:slotLabelInterval=\"00:30:00\"</code>.</td>\n </tr>\n <tr>\n <td><code spellcheck=\"false\">~child:template</code></td>\n <td>Defines the template for newly created notes in the calendar (via dragging or clicking).</td>\n </tr>\n </tbody>\n</table><p>In addition, the first day of the week can be either Sunday or Monday and can be adjusted from the application settings.</p><h2>Configuring the calendar events using attributes</h2><p>For each note of the calendar, the following attributes can be used:</p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code spellcheck=\"false\">#startDate</code></td>\n<td>The date the event starts, which will display it in the calendar. The format is <code spellcheck=\"false\">YYYY-MM-DD</code> (year, month and day separated by a minus sign).</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">#endDate</code></td>\n<td>Similar to <code spellcheck=\"false\">startDate</code>, mentions the end date if the event spans across multiple days. The date is inclusive, so the end day is also considered. The attribute can be missing for single-day events.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">#startTime</code></td>\n<td>The time the event starts at. If this value is missing, then the event is considered a full-day event. The format is <code spellcheck=\"false\">HH:MM</code> (hours in 24-hour format and minutes).</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">#endTime</code></td>\n<td>Similar to <code spellcheck=\"false\">startTime</code>, it mentions the time at which the event ends (in relation with <code spellcheck=\"false\">endDate</code> if present, or <code spellcheck=\"false\">startDate</code>).</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">#recurrence</code></td>\n<td>This is an optional CalDAV <code spellcheck=\"false\">RRULE</code> string that if present, determines whether a task should repeat or not. Note that it does not include the <code spellcheck=\"false\">DTSTART</code> attribute, which is derived from the <code spellcheck=\"false\">#startDate</code> and <code spellcheck=\"false\">#startTime</code> directly. For examples of valid <code spellcheck=\"false\">RRULE</code> strings see <a href=\"https://icalendar.org/rrule-tool.html\">https://icalendar.org/rrule-tool.html</a></td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">#color</code></td>\n<td>Displays the event with a specified color (named such as <code spellcheck=\"false\">red</code>, <code spellcheck=\"false\">gray</code> or hex such as <code spellcheck=\"false\">#FF0000</code>). This will also change the color of the note in other places such as the note tree.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">#calendar:color</code></td>\n<td><strong>❌️ Removed since v0.100.0. Use</strong> <code spellcheck=\"false\">#color</code> <strong>instead.</strong>&nbsp;&nbsp;&nbsp;&nbsp; <br> <br>Similar to <code spellcheck=\"false\">#color</code>, but applies the color only for the event in the calendar and not for other places such as the note tree.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">#iconClass</code></td>\n<td>If present, the icon of the note will be displayed to the left of the event title.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">#calendar:title</code></td>\n<td>Changes the title of an event to point to an attribute of the note other than the title, can either a label or a relation (without the <code spellcheck=\"false\">#</code> or <code spellcheck=\"false\">~</code> symbol). See <em>Use-cases</em> for more information.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">#calendar:displayedAttributes</code></td>\n<td>Allows displaying the value of one or more attributes in the calendar like this:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <br> <br><img src=\"{{helpAssets}}/User%20Guide/Collections/6_Calendar_image.png\"> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <br> <br><code spellcheck=\"false\">#weight=\"70\" #Mood=\"Good\" #calendar:displayedAttributes=\"weight,Mood\"</code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <br> <br>It can also be used with relations, case in which it will display the title of the target note:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <br> <br><code spellcheck=\"false\">~assignee=@My assignee #calendar:displayedAttributes=\"assignee\"</code></td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">#calendar:startDate</code></td>\n<td>Allows using a different label to represent the start date, other than <code spellcheck=\"false\">startDate</code> (e.g. <code spellcheck=\"false\">expiryDate</code>). The label name <strong>must not be</strong> prefixed with <code spellcheck=\"false\">#</code>. If the label is not defined for a note, the default will be used instead.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">#calendar:endDate</code></td>\n<td>Similar to <code spellcheck=\"false\">#calendar:startDate</code>, allows changing the attribute which is being used to read the end date.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">#calendar:startTime</code></td>\n<td>Similar to <code spellcheck=\"false\">#calendar:startDate</code>, allows changing the attribute which is being used to read the start time.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">#calendar:endTime</code></td>\n<td>Similar to <code spellcheck=\"false\">#calendar:startDate</code>, allows changing the attribute which is being used to read the end time.</td>\n</tr>\n</tbody></table></figure><h2>How the calendar works</h2><p><img src=\"{{helpAssets}}/User%20Guide/Collections/8_Calendar_image.png\"></p><p>The calendar displays all the child notes of the Collection that have a <code spellcheck=\"false\">#startDate</code>. An <code spellcheck=\"false\">#endDate</code> can optionally be added.</p><p>The start date &amp; end date can easily be edited from the calendar collection itself by clicking on the event. To edit the date while in the event note itself, the following attributes can be added to the Collection note:</p><pre><code class=\"language-text-x-trilium-auto\">#viewType=calendar #label:startDate(inheritable)=\"promoted,alias=Start Date,single,date\"\n#label:endDate(inheritable)=\"promoted,alias=End Date,single,date\"\n#hidePromotedAttributes </code></pre><p>This will result in:</p><p><img src=\"{{helpAssets}}/User%20Guide/Collections/7_Calendar_image.png\"></p><p>When not used in a Journal, the calendar is recursive. That is, it will look for events not just in its child notes but also in the children of these child notes.</p><h2>Recurrence</h2><p>The built in calendar view also supports repeating tasks (e.g. every week, every month as well as more complex recurrency rules).</p><p>Starting with v0.105.0, recurrence can be directly edited from the calendar by clicking on an event and then selecting the <em>Repeats</em> option.</p><h3>Custom recurrence using a subset of RRULE</h3><p>If the existing recurrence editor from the event popup is not sufficient, more complex rules can be manually set via the <code spellcheck=\"false\">#recurrence</code> label.</p><p>For example, to make a note repeat on the calendar:</p><ul><li>Every Day - <code spellcheck=\"false\">#recurrence=\"FREQ=DAILY;INTERVAL=1\"</code></li><li>Every 3 days - <code spellcheck=\"false\">#recurrence=\"FREQ=DAILY;INTERVAL=3\"</code></li><li>Every week - <code spellcheck=\"false\">#recurrence=\"FREQ=WEEKLY;INTERVAL=1\"</code></li><li>Every 2 weeks on Monday, Wednesday and Friday - <code spellcheck=\"false\">#recurrence=\"FREQ=WEEKLY;INTERVAL=2;BYDAY=MO,WE,FR\"</code></li><li>Every 3 months - <code spellcheck=\"false\">#recurrence=\"FREQ=MONTHLY;INTERVAL=3\"</code></li><li>Every 2 months on the First Sunday - <code spellcheck=\"false\">#recurrence=\"FREQ=MONTHLY;INTERVAL=2;BYDAY=1SU\"</code></li><li>Every month on the Last Friday - <code spellcheck=\"false\">#recurrence=\"FREQ=MONTHLY;INTERVAL=1;BYDAY=-1FR\"</code></li></ul><p>For other examples of valid <code spellcheck=\"false\">RRULE</code> strings see <a href=\"https://icalendar.org/rrule-tool.html\">https://icalendar.org/rrule-tool.html</a></p><p>Note that the recurrence string does not include the <code spellcheck=\"false\">DTSTART</code> attribute as defined in the iCAL specifications. This is derived directly from the <code spellcheck=\"false\">startDate</code> and <code spellcheck=\"false\">startTime</code> attributes</p><p>If you want to override the label the calendar uses to fetch the recurrence string, you can use the <code spellcheck=\"false\">#calendar:recurrence</code> attribute. For example, you can set <code spellcheck=\"false\">#calendar:recurrence=taskRepeats</code>. Then you can set your recurrence string like <code spellcheck=\"false\">#taskRepeats=\"FREQ=DAILY;INTERVAL=1\"</code></p><p>Also note that the recurrence label can be made promoted as with the start and end dates.&nbsp;</p><aside class=\"admonition warning\"><p>If the recurrence string is not valid, a toast will be shown with the note ID and title of the note with the erroneous recurrence message. This note will not be added to the calendar</p></aside><h2>Slot Duration &amp; Slot Label Interval</h2><p>Trilium's calendar view is powered by FullCalendar, which gives you fine-grained control over how the time grid looks and behaves for day and week views. Two labels you can use to configure these views are <code spellcheck=\"false\">#calendar:slotDuration</code> and <code spellcheck=\"false\">#calendar:slotLabelInterval</code>. Understanding what each one does — and how they interact — lets you tailor the calendar to match your workflow, whether you're scheduling in 15-minute increments or planning out your day in broad hourly blocks.</p><p>These settings can also be adjusted from the <em>Collections</em> tab in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_BlN9DFI679QC\">Ribbon</a>.</p><h3>Slot duration</h3><p>Controls how tall each time slot is on the calendar — essentially the smallest unit of time the grid is divided into. A shorter duration means more rows and finer granularity; a longer one means fewer, chunkier rows. The default is one row every 15 minutes.</p><p><strong>Examples:</strong></p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Value</th>\n<th>Result</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code spellcheck=\"false\">#calendar:slotDuration=\"00:15:00\"</code></td>\n<td>One row every 15 minutes</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">#calendar:slotDuration=\"00:30:00\"</code></td>\n<td>One row every 30 minutes</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">#calendar:slotDuration=\"01:00:00\"</code></td>\n<td>One row every hour</td>\n</tr>\n</tbody></table></figure><h3>Label interval</h3><p>Controls how often a time label appears on the left-hand axis. This is independent of the slot size — you can have very small slots but only label every hour to keep the axis readable. The default is a time label shown every hour.</p><p><strong>Examples:</strong></p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Value</th>\n<th>Result</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code spellcheck=\"false\">#calendar:slotLabelInterval=\"00:30:00\"</code></td>\n<td>Show a time label every 30 minutes</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">#calendar:slotLabelInterval=\"01:00:00\"</code></td>\n<td>Show a time label every hour</td>\n</tr>\n</tbody></table></figure><h3>Useful combinations</h3><figure class=\"table\"><table>\n<thead>\n<tr>\n<th><code spellcheck=\"false\">#calendar:slotDuration</code></th>\n<th><code spellcheck=\"false\">#calendar:slotLabelInterval</code></th>\n<th>Result</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code spellcheck=\"false\">00:15:00</code></td>\n<td><code spellcheck=\"false\">01:00:00</code></td>\n<td>Fine grid, clean axis — good for busy schedules</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">00:30:00</code></td>\n<td><code spellcheck=\"false\">01:00:00</code></td>\n<td>Standard calendar feel</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">01:00:00</code></td>\n<td><code spellcheck=\"false\">01:00:00</code></td>\n<td>Simple hourly grid — good for day planning</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">00:15:00</code></td>\n<td><code spellcheck=\"false\">00:30:00</code></td>\n<td>Fine grid, labels every 30 min — balanced detail</td>\n</tr>\n</tbody></table></figure><h3>Format</h3><p>Both values use <code spellcheck=\"false\">HH:mm:ss</code> format. Hours can go up to <code spellcheck=\"false\">24</code> (<code spellcheck=\"false\">24:00:00</code>), while minutes and seconds must be between <code spellcheck=\"false\">00</code> and <code spellcheck=\"false\">59</code>. The minimum meaningful duration is 1 minute (<code spellcheck=\"false\">00:01:00</code>).</p><h2>Use-cases</h2><h3>Using with the Journal / calendar</h3><p>It is possible to integrate the calendar view into the Journal with day notes. In order to do so change the note type of the Journal note (calendar root) to Collection and then select the Calendar View.</p><p>While in journal mode, the popup editor will not show dates, recurrence, colors or removal, since day notes aren't editable events.</p><p>Based on the <code spellcheck=\"false\">#calendarRoot</code> (or <code spellcheck=\"false\">#workspaceCalendarRoot</code>) attribute, the calendar will know that it's in a calendar and apply the following:</p><ul><li>The calendar events are now rendered based on their <code spellcheck=\"false\">dateNote</code> attribute rather than <code spellcheck=\"false\">startDate</code>.</li><li>Interactive editing such as dragging over an empty era or resizing an event is no longer possible.</li><li>Clicking on the empty space on a date will automatically open that day's note or create it if it does not exist.</li><li>Direct children of a day note will be displayed on the calendar despite not having a <code spellcheck=\"false\">dateNote</code> attribute. Children of the child notes will not be displayed.</li></ul><img src=\"{{helpAssets}}/User%20Guide/Collections/5_Calendar_image.png\" width=\"1217\" height=\"724\"><h3>Using a different attribute as event title</h3><p><img class=\"image-style-align-right\" src=\"{{helpAssets}}/User%20Guide/Collections/2_Calendar_image.png\" width=\"445\" height=\"124\">By default, events are displayed on the calendar by their note title. However, it is possible to configure a different attribute to be displayed instead.</p><p>To do so, assign <code spellcheck=\"false\">#calendar:title</code> to the child note (not the calendar/Collection note), with the value being <code spellcheck=\"false\">name</code> where <code spellcheck=\"false\">name</code> can be any label (make not to add the <code spellcheck=\"false\">#</code> prefix). The attribute can also come through inheritance such as a template attribute. If the note does not have the requested label, the title of the note will be used instead.</p><pre><code class=\"language-text-x-trilium-auto\">#startDate=2025-02-11 #endDate=2025-02-13 #name=\"My vacation\" #calendar:title=\"name\"</code></pre><h3>Using a relation attribute as event title</h3><p><img class=\"image-style-align-right image_resized\" style=\"aspect-ratio:294/151;width:21.22%;\" src=\"{{helpAssets}}/User%20Guide/Collections/3_Calendar_image.png\" width=\"294\" height=\"151\">Similarly to using an attribute, use <code spellcheck=\"false\">#calendar:title</code> and set it to <code spellcheck=\"false\">name</code> where <code spellcheck=\"false\">name</code> is the name of the relation to use.</p><p>Moreover, if there are more relations of the same name, they will be displayed as multiple events coming from the same note.</p><pre><code class=\"language-text-x-trilium-auto\">#startDate=2025-02-14 #endDate=2025-02-15 ~for=@John Smith ~for=@Jane Doe #calendar:title=\"for\"</code></pre><p><img class=\"image-style-align-left\" src=\"{{helpAssets}}/User%20Guide/Collections/Calendar_image.png\" width=\"296\" height=\"150\">Note that it's even possible to have a <code spellcheck=\"false\">#calendar:title</code> on the target note (e.g. “John Smith”) which will try to render an attribute of it. Note that it's not possible to use a relation here as well for safety reasons (an accidental recursion &nbsp;of attributes could cause the application to loop infinitely).</p><pre><code class=\"language-text-x-trilium-auto\">#calendar:title=\"shortName\" #shortName=\"John S.\"</code></pre>",
- "_help_2FvYrpmOXm29": "<figure class=\"image\"><img style=\"aspect-ratio:1050/259;\" src=\"{{helpAssets}}/User%20Guide/Collections/Table_image.png\" width=\"1050\" height=\"259\"></figure><p>The table view displays information in a grid, where the rows are individual notes and the columns are&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>. In addition, values are editable.</p><h2>How it works</h2><p>The tabular structure is represented as such:</p><ul><li>Each child note is a row in the table.</li><li>If child rows also have children, they will be displayed under an expander (nested notes).</li><li>Each column is a <a href=\"#root/_help_OFXdgB2nNk1F\">promoted attribute</a> that is defined on the Collection note.<ul><li>Actually, both promoted and unpromoted attributes are supported, but it's a requirement to use a label/relation definition.</li><li>The promoted attributes are usually defined as inheritable in order to show up in the child notes, but it's not a requirement.</li></ul></li><li>If there are multiple attribute definitions with the same <code spellcheck=\"false\">name</code>, only one will be displayed.</li><li>If an attribute definition has multiple values, they will all be grouped under a single column, with chips indicating individual values.</li></ul><p>There are also a few predefined columns:</p><ul><li>The current item number, identified by the <code spellcheck=\"false\">#</code> symbol.<ul><li>This simply counts the note and is affected by sorting.</li></ul></li><li><a class=\"reference-link\" href=\"#root/_help_m1lbrzyKDaRB\">Note ID</a>, representing the unique ID used internally by Trilium</li><li>The title of the note.</li></ul><h2>Interaction</h2><h3>Creating a new table</h3><p>Right click on an existing note in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and select <em>Insert child note</em> and look for <em>Table</em>.</p><h3>Adding columns</h3><p>Each column is a <a href=\"#root/_help_OFXdgB2nNk1F\">promoted or unpromoted attribute</a> that is defined on the Collection note.</p><p>To create a new column, either:</p><ul><li>Press <em>Add new column</em> at the bottom of the table.</li><li>Right click on an existing column and select Add column to the left/right.</li><li>Right click on the empty space of the column header and select <em>Label</em> or <em>Relation</em> in the <em>New column</em> section.</li></ul><h3>Adding new rows</h3><p>Each row is actually a note that is a child of the Collection note.</p><p>To create a new note, either:</p><ul><li>Press <em>Add new row</em> at the bottom of the table.</li><li>Right click on an existing row and select <em>Insert row above, Insert child note</em> or <em>Insert row below</em>.</li></ul><p>By default it will try to edit the title of the newly created note.</p><p>Alternatively, the note can be created from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;or <a href=\"#root/_help_CdNpE2pqjmI6\">scripting</a>.</p><h3>Context menu</h3><p>There are multiple menus:</p><ul><li>Right clicking on a column, allows:<ul><li>Sorting by the selected column and resetting the sort.</li><li>Hiding the selected column or adjusting the visibility of every column.</li><li>Adding new columns to the left or the right of the column.</li><li>Editing the current column.</li><li>Deleting the current column.</li></ul></li><li>Right clicking on the space to the right of the columns, allows:<ul><li>Adjusting the visibility of every column.</li><li>Adding new columns.</li></ul></li><li>Right clicking on a row, allows:<ul><li>Opening the corresponding note of the row in a new tab, split, window or quick editing it.</li><li>Inserting a new note above or below the selected row. These options are only enabled if the table is not sorted.</li><li>Inserting a new child note for the selected row.</li><li>Deleting the row.</li></ul></li></ul><h3>Editing data</h3><p>Simply click on a cell within a row to change its value. The change will not only reflect in the table, but also as an attribute of the corresponding note.</p><ul><li>The editing will respect the type of the promoted attribute, by presenting a normal text box, a number selector or a date selector for example.</li><li>It also possible to change the title of a note.</li><li>Editing relations is also possible<ul><li>Simply click on a relation and it will become editable. Enter the text to look for a note and click on it.</li><li>To remove a relation, remove the title of the note from the text box and click outside the cell.</li></ul></li></ul><h3>Editing columns</h3><p>It is possible to edit a column by right clicking it and selecting <em>Edit column.</em> This will basically change the label/relation definition at the collection level.</p><p>If the <em>Name</em> field of a column is changed, this will trigger a batch operation in which the corresponding label/relation will be renamed in all the children.</p><h2>Working with the data</h2><h3>Sorting by column</h3><p>By default, the order of the notes matches the order in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>. However, it is possible to sort the data by the values of a column:</p><ul><li>To do so, simply click on a column.</li><li>To switch between ascending or descending sort, simply click again on the same column. The arrow next to the column will indicate the direction of the sort.</li><li>To disable sorting and fall back to the original order, right click any column on the header and select <em>Clear sorting.</em></li></ul><h3>Reordering and hiding columns</h3><ul><li>Columns can be reordered by dragging the header of the columns.</li><li>Columns can be hidden or shown by right clicking on a column and clicking the item corresponding to the column.</li></ul><h3>Reordering rows</h3><p>Notes can be dragged around to change their order. To do so, move the mouse over the three vertical dots near the number row and drag the mouse to the desired position.</p><p>This will also change the order of the note in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</p><p>Reordering does have some limitations:</p><ul><li>If the parent note has <code spellcheck=\"false\">#sorted</code>, reordering will be disabled.</li><li>If using nested tables, then reordering will also be disabled.</li><li>Currently, it's possible to reorder notes even if column sorting is used, but the result might be inconsistent.</li></ul><h3>Nested trees</h3><p>If the child notes of the collection also have their own child notes, then they will be displayed in a hierarchy.</p><p>Next to the title of each element there will be a button to expand or collapse. By default, all items are expanded.</p><p>Since nesting is not always desirable, it is possible to limit the nesting to a certain number of levels or even disable it completely. To do so, either:</p><ul><li>Go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>&nbsp;and look for the <em>Max nesting depth</em> section.<ul><li>To disable nesting, type 0 and press Enter.</li><li>To limit to a certain depth, type in the desired number (e.g. 2 to only display children and sub-children).</li><li>To re-enable unlimited nesting, remove the number and press Enter.</li></ul></li><li>Manually set <code spellcheck=\"false\">maxNestingDepth</code> to the desired value.</li></ul><p>Limitations:</p><ul><li>While in this mode, it's not possible to reorder notes.</li></ul><h2>Limitations</h2><ul><li>There is no support to filter the rows by a certain criteria. Consider using the table view in search for that use case.</li></ul><h2>Use in search</h2><p>The table view can be used in a&nbsp;<a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a>&nbsp;by adding the <code spellcheck=\"false\">#viewType=table</code> attribute.</p><p>Unlike when used in a Collection, saved searches are not limited to the sub-hierarchy of a note and allows for advanced queries thanks to the power of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>.</p><p>However, there are also some limitations:</p><ul><li>It's not possible to reorder notes.</li><li>It's not possible to add a new row.</li></ul><p>Columns are supported, by being defined as&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a>&nbsp;note.</p><p>Editing is also supported.</p>",
- "_help_CtBQqbwXDx1w": "<figure class=\"image\"><img style=\"aspect-ratio:918/248;\" src=\"{{helpAssets}}/User%20Guide/Collections/2_Kanban%20Board_image.png\" width=\"918\" height=\"248\"></figure><p>The Board view presents sub-notes in columns for a Kanban-like experience. Each column represents a possible value for a status label, which can be adjusted.</p><h2>Creating a Kanban board</h2><p>Right click on an existing note in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and select <em>Insert child note</em> and look for <em>Kanban Board</em>.</p><h2>How it works</h2><p>When first creating a collection of <em>Board</em> type, a few subnotes will be created, each having a <code spellcheck=\"false\">#status</code> label set. The board then groups each note by the value of the status attribute.</p><p>Notes are displayed recursively, so even the child notes of the child notes will be displayed. However, unlike the&nbsp;<a class=\"reference-link\" href=\"#root/_help_2FvYrpmOXm29\">Table</a>, the notes are not displayed in a hierarchy.</p><h2>Interaction</h2><h3>Working with columns</h3><ul><li>Create a new column by pressing <em>Add Column</em> near the last column.<ul><li>Once pressed, a text box will be displayed to set the name of the column. Press <kbd>Enter</kbd> to confirm, or <kbd>Escape</kbd> to dismiss.</li></ul></li><li>To reorder a column, simply hold the mouse over the title and drag it to the desired position.</li><li>To delete a column, right click on its title and select <em>Delete column</em>.</li><li>To rename a column, click on the note title.<ul><li>Press Enter to confirm.</li><li>Upon renaming a column, the corresponding status attribute of all its notes will be changed in bulk.</li></ul></li><li>If there are many columns, use the mouse wheel to scroll.</li></ul><h3>Working with notes</h3><ul><li>Create a new note in any column by pressing <em>New item</em><ul><li>Enter the name of the note and press <kbd>Enter</kbd> or click away. To dismiss the creation of a new note, simply press <kbd>Escape</kbd> or leave the name empty.</li><li>Once created, the new note will have an attribute (<code spellcheck=\"false\">status</code> label by default) set to the name of the column.</li></ul></li><li>To open the note, simply click on it.</li><li>To change the title of the note directly from the board, hover the mouse over its card and press the edit button on the right.</li><li>To change the state of a note, simply drag a note from one column to the other to change its state.</li><li>The order of the notes in each column corresponds to their position in the tree.<ul><li>It's possible to reorder notes simply by dragging them to the desired position within the same columns.</li><li>It's also possible to drag notes across columns, at the desired position.</li></ul></li><li>For more options, right click on a note to display a context menu with the following options:<ul><li>Open the note in a new tab/split/window or quick edit.</li><li>Move the note to any column.</li><li>Insert a new note above/below the current one.</li><li>Archive/unarchive the current note.</li><li>Delete the current note.</li></ul></li><li>If there are many notes within the column, move the mouse over the column and use the mouse wheel to scroll.</li></ul><h3>Working with the note tree</h3><p>It's also possible to add items on the board using the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</p><ol><li>Select the desired note in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</li><li>Hold the mouse on the note and drag it to the to the desired column.</li></ol><p>This works for:</p><ul><li>Notes that are not children of the board, case in which a <a href=\"#root/_help_IakOLONlIfGI\">clone</a> will be created.</li><li>Notes that are children of the board, but not yet assigned on the board.</li><li>Notes that are children of the board, case in which they will be moved to the new column.</li></ul><h3>Keyboard interaction</h3><p>The board view has mild support for keyboard-based navigation:</p><ul><li>Use <kbd>Tab</kbd> and <kbd>Shift</kbd>+<kbd>Tab</kbd> to navigate between column titles, notes and the “New item” button for each of the columns, in sequential order.</li><li>To rename a column or a note, press <kbd>F2</kbd> while it is focused.</li><li>To open a specific note or create a new item, press <kbd>Enter</kbd> while it is focused.</li><li>To dismiss a rename of a note or a column, press <kbd>Escape</kbd>.</li></ul><h2>Configuration</h2><h3>Displaying custom attributes</h3><figure class=\"image image-style-align-center\"><img style=\"aspect-ratio:531/485;\" src=\"{{helpAssets}}/User%20Guide/Collections/Kanban%20Board_image.png\" width=\"531\" height=\"485\"></figure><p>Since v0.100.0, note attributes can be displayed on the board to enhance it with custom information such as adding a <em>Due date</em> for your tasks.</p><p>This feature works exclusively via attribute definitions (<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>). The easiest way to add these is:</p><ol><li>Go to board note.</li><li>In the ribbon select <em>Owned Attributes</em> → plus button → <em>Add new label/relation definition</em>.</li><li>Configure the attribute as desired.</li><li>Check <em>Inheritable</em> to make it applicable to child notes automatically.</li></ol><p>After creating the attribute, click on a note and fill in the promoted attributes which should then reflect inside the board.</p><p>Of note:</p><ul><li>Both promoted and non-promoted attribute definitions are supported. The only difference is that non-promoted attributes don't have an “Alias” for assigning a custom name.</li><li>Both “Single value” and “Multi value” attributes are supported. In case of multi-value, a badge is displayed for every instance of the attribute.</li><li>All label types are supported, including dates, booleans and URLs.</li><li>Relation attributes are also supported as well, showing a link with the target note title and icon.</li><li>Currently, it's not possible to adjust which promoted attributes are displayed, since all promoted attributes will be displayed (except the <code spellcheck=\"false\">board:groupBy</code> one). There are plans to improve upon this being able to hide promoted attributes individually.</li></ul><h3>Grouping by another label</h3><p>By default, the label used to group the notes is <code spellcheck=\"false\">#status</code>. It is possible to use a different label if needed by defining a label named <code spellcheck=\"false\">#board:groupBy</code> with the value being the attribute to use (with or without <code spellcheck=\"false\">#</code> attribute prefix).</p><h3>Grouping by relations</h3><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:535/245;\" src=\"{{helpAssets}}/User%20Guide/Collections/1_Kanban%20Board_image.png\" width=\"535\" height=\"245\"></figure><p>A more advanced use-case is grouping by <a href=\"#root/_help_Cq5X6iKQop6R\">Relations</a>.</p><p>During this mode:</p><ul><li>The columns represent the <em>target notes</em> of a relation.</li><li>When creating a new column, a note is selected instead of a column name.</li><li>The column icon will match the target note.</li><li>Moving notes between columns will change its relation.</li><li>Renaming an existing column will change the target note of all the notes in that column.</li></ul><p>Using relations instead of labels has some benefits:</p><ul><li>The status/grouping of the notes is visible outside the Kanban board, for example on the&nbsp;<a class=\"reference-link\" href=\"#root/_help_bdUJEHsAPYQR\">Note Map</a>.</li><li>Columns can have icons.</li><li>Renaming columns is less intensive since it simply involves changing the note title of the target note instead of having to do a bulk rename.</li></ul><p>To do so:</p><ol><li><p>First, create a Kanban board from scratch and not a template:</p></li><li><p>Assign <code spellcheck=\"false\">#viewType=board #hidePromotedAttributes</code> to emulate the default template.</p></li><li><p>Set <code spellcheck=\"false\">#board:groupBy</code> to the name of a relation to group by, <strong>including the</strong> <code spellcheck=\"false\">~</code> <strong>prefix</strong> (e.g. <code spellcheck=\"false\">~status</code>).</p></li><li><p>Optionally, use&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;for easy status change within the note:</p><pre><code class=\"language-text-x-trilium-auto\">#relation:status(inheritable)=\"promoted,alias=Status,single\"</code></pre></li></ol>",
- "_help_81SGnPGMk7Xc": "<figure class=\"image\"><img style=\"aspect-ratio:1561/1149;\" src=\"{{helpAssets}}/User%20Guide/Collections/Geo%20Map_image.png\" width=\"1561\" height=\"1149\"></figure><p>This note type displays the children notes on a geographical map, based on an attribute. It is also possible to add new notes at a specific location using the built-in interface.</p><h2>Features</h2><ul><li>Add markers on the map, which can be customized with icons, colors and text.</li><li>Display tracks on the map using <code spellcheck=\"false\">.gpx</code> files.</li><li>3D view of the map, which displays buildings when using a vector map.</li></ul><h2>System requirements</h2><p>Starting with v0.105.0, the geomap uses MapLibre GL which requires WebGL v1 support. In general, most devices will support it because browsers/Electron can render it in software if needed.</p><p>If the map could not be drawn because WebGL could not be initialized, an error message will appear instead of the map (<em>This map can't be drawn because WebGL isn't available…</em>).</p><h2>Interaction</h2><ul><li>At the bottom-center there is a central toolbar which provides editing features: adding new markers on the map and importing GPX tracks.</li><li>At the bottom-right there are the viewport items:<ul><li>Zoom in/out<ul><li>On mobile these are hidden, use pinch to zoom instead.</li><li>On desktop, alternatively use the scroll wheel to adjust the zoom.</li></ul></li><li>Full screen button which focuses the entire map onto the screen, while still allowing for edits.</li></ul></li></ul><h2>Creating a new geo map</h2><p>Right click on an existing note in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and select <em>Insert child note</em> → <em>Geo Map</em>.</p><p>By default the map will be empty and will show the entire world.</p><h2>Repositioning the map</h2><ul><li>Click and drag the map in order to move across the map.</li><li>Use the mouse wheel, two-finger gesture on a touchpad or the +/- buttons on the bottom-right to adjust the zoom.</li></ul><p>The position on the map and the zoom are saved inside the map note and restored when visiting again the note.</p><h2>Adding a marker using the map</h2><h3>Adding a new note using the plus button</h3><ol><li><p>To create a marker, first navigate to the desired point on the map. Then press the <em>Add marker</em> button at the center-bottom of the map.</p></li><li><p>Once pressed, the map will enter in the insert mode, as illustrated by the notification. Additionally, a preview of the marker will be shown at the cursor position.</p><p>Simply click the point on the map where to place the marker. To cancel, press either the &nbsp;<kbd>Escape</kbd> key or press again the <em>Add marker</em> button.</p></li><li><p>Once clicked, the marker will show up on the map and a popup will show to the right with the title already selected to be changed.</p></li></ol><h3>Adding a new note using the contextual menu</h3><ol><li>Right click anywhere on the map, where to place the newly created marker (and corresponding note).</li><li>Select <em>Add a marker at this location</em>.</li><li>Once clicked on a position on the map, the marker will show up on the map and a popup will show to the right with the title already selected to be changed.</li></ol><h3>Adding an existing note from the note tree</h3><ol><li>Select the desired note in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</li><li>Hold the mouse on the note and drag it to the map to the desired location.</li><li>The map should be updated with the new marker.</li></ol><p>This works for:</p><ul><li>Notes that are not part of the geo map, case in which a <a href=\"#root/_help_IakOLONlIfGI\">clone</a> will be created.</li><li>Notes that are a child of the geo map but not yet positioned on the map.</li><li>Notes that are a child of the geo map and also positioned, case in which the marker will be relocated to the new position.</li></ul><aside class=\"admonition note\"><p>Dragging existing notes only works if the map is in editing mode. See the <em>Read-only</em> section for more information.</p></aside><h2>How the location of the markers is stored</h2><p>The location of a marker is stored in the <code spellcheck=\"false\">#geolocation</code> attribute of the child notes:</p><p>This value can be added manually if needed. The value of the attribute is made up of the latitude and longitude separated by a comma.</p><h2>Repositioning markers</h2><p>Once a marker is set, it can be repositioned using one of the two ways:</p><ul><li>By right clicking the marker and selecting <em>Move to another location</em>.</li><li>By clicking the marker to open the popup and selecting the <em>Move to another location</em> button underneath the title bar.</li></ul><p>After clicking the button to move the marker, click at the desired position on the map to replace it. To cancel the operation, press <kbd>Escape</kbd>.</p><aside class=\"admonition note\"><p>If the map is locked for editing (see below), the map needs to be unlocked before moving the marker.</p></aside><h2>Interaction with the markers</h2><ul><li>Hovering over a marker will display a&nbsp;<a class=\"reference-link\" href=\"#root/_help_lgKX7r3aL30x\">Note Tooltip</a>&nbsp;with the content of the note it belongs to.<ul><li>Clicking on the note title in the tooltip will navigate to the note in the current view.</li></ul></li><li>Right-clicking the marker will open a contextual menu (as described below).</li><li>Clicking a marker will focus on the marker and display a dedicated popup with the details. This works regardless of whether the map is editable or not.</li></ul><h3>Popup view</h3><p>When a marker or a track is clicked, a popup will open to the right which contains the following information:</p><ul><li>The title and icon of the marker, both editable.</li><li>An indicator for the coordinates; clicking it will copy the coordinates to clipboard.</li><li>A button to maximize the popup.</li><li>Buttons to interact with the markers:<ul><li>Open the marker in the same pane, new tab, etc.</li><li>A button to open the location in a dedicated application (e.g. Google Maps on mobile).</li><li>Color picker to change the color of the marker.</li><li>Button to remove the marker from the map, which can optionally delete its corresponding note. Removing a marker without deleting the note will only remove its <code spellcheck=\"false\">#geolocation</code> attribute (case in which the coordinates have to be manually added back in in order to get the note to show on the map again).</li></ul></li><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;of the marker, if any.</li><li>The note's content which can be edited directly from the panel.</li></ul><p>To dismiss the popup:</p><ul><li>Press the X button at the top-right of the popup.</li><li>In the map, press anywhere outside the popup.</li><li>Or simply press the <kbd>Escape</kbd> key.</li></ul><p>When a marker is clicked, the map will automatically adjust the viewport so that the marker is still visible with the popup open. The currently selected marker is shown slightly bigger.</p><p>It is possible to switch between markers by clicking on them even when the popup view is already open.</p><p>Markers can have&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;between them and clicking on such a link will automatically adjust the viewport and the popup view to the new note.</p><h3>Contextual menu</h3><p>It's possible to press the right mouse button to display a contextual menu.</p><ol><li>If right-clicking an empty section of the map (not on a marker), it allows to:<ol><li>Displays the latitude and longitude. Clicking this option will copy them to the clipboard.</li><li>Open the location using an external application (if the operating system supports it).</li><li>Adding a new marker at that location.</li></ol></li><li>If right-clicking on a marker, it allows to:<ol><li>Displays the latitude and longitude. Clicking this option will copy them to the clipboard.</li><li>Open the location using an external application (if the operating system supports it).</li><li>Open the note in a new tab, split or window.</li><li>Button to remove the marker from the map, which can optionally delete its corresponding note. Removing a marker without deleting the note will only remove its <code spellcheck=\"false\">#geolocation</code> attribute (case in which the coordinates have to be manually added back in in order to get the note to show on the map again).</li></ol></li></ol><h3>Icon and color of the markers</h3><figure class=\"image image-style-align-right image_resized\" style=\"width:47.42%;\"><img style=\"aspect-ratio:885/321;\" src=\"{{helpAssets}}/User%20Guide/Collections/3_Geo%20Map_image.png\" width=\"885\" height=\"321\"></figure><p>The markers will have the same icon as the note.</p><p>It's possible to add a custom color to a marker by assigning them a <code spellcheck=\"false\">#color</code> attribute such as <code spellcheck=\"false\">#color=green</code>.</p><h3>Adding the coordinates manually</h3><p>In a nutshell, create a child note and set the <code spellcheck=\"false\">#geolocation</code> attribute to the coordinates.</p><p>The value of the attribute is made up of the latitude and longitude separated by a comma.</p><h4>Adding from Google Maps</h4><ol><li>In Google Maps, on the web:<ol><li>Look for a desired location, right click on it and a context menu will show up.</li><li>Simply click on the first item displaying the coordinates and they will be copied to clipboard.</li></ol></li><li>In Trilium, create a child note under the map.</li><li>Then paste the value inside the text box into the <code spellcheck=\"false\">#geolocation</code> attribute of a child note of the map (don't forget to surround the value with a <code spellcheck=\"false\">\"</code> character).</li></ol><h4>Adding from OpenStreetMap</h4><p>Similarly to the Google Maps approach:</p><ol><li>Go to any location on openstreetmap.org and right click to bring up the context menu. Select the <em>Show address</em> item.</li><li>The address will be visible in the top-left of the screen, in the place of the search bar.&nbsp;Select the coordinates and copy them into the clipboard.</li><li>Simply paste the value inside the text box into the <code spellcheck=\"false\">#geolocation</code> attribute of a child note of the map and then it should be displayed on the map.</li></ol><h2>Adding GPS tracks (.gpx)</h2><figure class=\"image\"><img style=\"aspect-ratio:1566/1155;\" src=\"{{helpAssets}}/User%20Guide/Collections/1_Geo%20Map_image.png\" width=\"1566\" height=\"1155\"></figure><p>Trilium can display GPS tracks on the geo map, in the form of <code spellcheck=\"false\">.gpx</code> files.</p><p>To add a track, either:</p><ol><li>Drag &amp; drop a <code spellcheck=\"false\">.gpx</code> file inside the geo map in the note tree.<ol><li>In order for the file to be recognized as a GPS track, it needs to show up as <code spellcheck=\"false\">application/gpx+xml</code> in the <em>File type</em> field.</li></ol></li><li>Press the <em>Add a GPS track from a GPX file</em> which will directly prompt for a GPX file and import it as a subnote of the collection.</li></ol><p>When going back to the map, the track should now be visible.</p><p>The starting point of the track will be displayed as a marker, with the name of the note underneath. The start marker will also respect the icon and the <code spellcheck=\"false\">color</code> of the note. The end marker is displayed with a distinct icon.</p><p>If the track file contains multiple tracks, they will all be displayed as well as markers. Trilium will also split a single track that happens to have non-continuous points.</p><p>If the GPX contains waypoints, they will also be displayed, including their names.</p><p>When the track is clicked, the entire route is brought into view, as well as the right popup will indicate details about the track such as distance, duration and the elevation map. This information is also displayed when clicking the <code spellcheck=\"false\">.gpx</code> note itself.</p><p>When clicking on the markers of a track (whether it's the start or stop builtin markers, or custom markers that are part of the track), only that marker is brought into view, as opposed to the entire route.</p><h2>Read-only mode</h2><p>When a map is in read-only all editing features will be disabled such as:</p><ul><li>The add button at the bottom of the map.</li><li>Repositioning markers.</li><li>Editing from the contextual menu (removing locations or adding new items).</li></ul><p>To enable read-only mode simply press the <em>Lock</em> icon from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note buttons</a>&nbsp;(or&nbsp;<a class=\"reference-link\" href=\"#root/_help_XpOYSgsLkTJy\">Floating buttons</a>&nbsp;for the old layout). To disable it, press the button again.</p><h2>Configuration</h2><h3>Map Style</h3><p>The styling of the map can be adjusted in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>&nbsp;or manually via the <code spellcheck=\"false\">#map:style</code> attribute.</p><p>The geo map comes with two different types of styles:</p><ul><li>Raster styles<ul><li>For these styles the map is represented as a grid of images at different zoom levels. This is the traditional way OpenStreetMap used to work.</li><li>Zoom is slightly restricted.</li><li>Currently, the only raster theme is the original OpenStreetMap style.</li></ul></li><li>Vector styles<ul><li>Vector styles are not represented as images, but as geometrical shapes. This makes the rendering much smoother, especially when zooming and looking at the building edges, for example.</li><li>The map can be zoomed in much further.</li><li>These come in various styles that are both light (Colorful, Graybeard, Neutrino) and dark (Eclipse, Shadow).</li><li>The vector styles come from <a href=\"https://versatiles.org/\">VersaTiles</a>, a free and open-source project providing map tiles based on OpenStreetMap.</li><li>The VersaTiles layers also provide 3D building information (see below).</li></ul></li></ul><p>The default theme is Versatiles Colorful (vector).</p><h4>3D view with buildings</h4><figure class=\"image\"><img style=\"aspect-ratio:2727/1642;\" src=\"{{helpAssets}}/User%20Guide/Collections/2_Geo%20Map_image.png\" width=\"2727\" height=\"1642\"></figure><p>Trilium v0.105.0 introduces a 3D view, courtesy of MapLibre GL. To enter 3D mode, simply press the corresponding button at the bottom-right of the map or press <kbd>Ctrl</kbd> and drag across the map.</p><p>The buildings will only appear from zoom 14 onwards to avoid lag.</p><aside class=\"admonition note\"><p>To get 3D buildings, make sure you are using the <em>VersaTiles</em> styles which provide the building informatia via the <code spellcheck=\"false\">versatiles-shortbread</code> source.</p></aside><h3>Custom map style / tiles</h3><p>Starting with v0.102.0 it is possible to use custom tile sets, but only in raster format.</p><p>To do so, manually set the <code spellcheck=\"false\">#map:style</code> <a href=\"#root/_help_HI6GBBIduIgv\">label</a> to the URL of the tile set. For example, to use Esri.NatGeoWorldMap, set the value to <a href=\"https://server.arcgisonline.com/ArcGIS/rest/services/NatGeo_World_Map/MapServer/tile/%7Bz%7D/%7By%7D/%7Bx%7D.\"><code spellcheck=\"false\">https://server.arcgisonline.com/ArcGIS/rest/services/NatGeo_World_Map/MapServer/tile/{z}/{y}/{x}</code>.</a></p><p>Additionally:</p><ul><li>Hi-DPI tiles are supported via the <code spellcheck=\"false\">{r}</code> placeholder.</li><li>To mark the custom style as dark (which affects the styling of the UI), apply the <code spellcheck=\"false\">map:darkStyle</code> label. This attribute also overrides builtin themes.</li></ul><aside class=\"admonition note\"><p>For a list of tile sets, see the <a href=\"https://leaflet-extras.github.io/leaflet-providers/preview/\">Leaflet Providers preview</a> page. Select a desired tile set and just copy the URL from the <em>Plain JavaScript</em> example.</p></aside><p>Custom vector map support is planned, but not yet implemented.</p><h3>Other options</h3><p>The following options can be configured either via the&nbsp;<a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>, by clicking on the settings (Gear icon). Alternatively, each of these options also have a corresponding <a href=\"#root/_help_HI6GBBIduIgv\">label</a> that can be set manually.</p><ul><li>Scale, which illustrates the scale of the map in either kilometers or miles in the bottom-left of the map.<ul><li>The unit is determined by the <em>Formatting locale</em> option in <em>Language &amp; Region</em>.</li></ul></li><li>The name of the markers is displayed by default underneath the pin on the map. Since v0.102.0, it is possible to hide these labels which increases the performance and decreases clutter when there are many markers on the map.</li><li>v0.105.0 also introduces a feature called <em>Group nearby markers</em> which will cluster multiple markers together at low zoom.<ul><li>The clusters display the number of items they contain. The color also changes based on the count.</li><li>Clicking on a cluster will automatically zoom in so that the individual markers that make up the cluster are now visible.</li></ul></li></ul>",
- "_help_zP3PMqaG71Ct": "<figure class=\"image\"><img style=\"aspect-ratio:1120/763;\" src=\"{{helpAssets}}/User%20Guide/Collections/Presentation_image.png\" width=\"1120\" height=\"763\"></figure><p>The Presentation view allows the creation of slideshows directly from within Trilium.</p><h3>Creating a new presentation</h3><p>Right click on an existing note in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and select <em>Insert child note</em> and look for <em>Presentation</em>.</p><h2>How it works</h2><ul><li>Each slide is a child note of the collection.</li><li>The order of the child notes determines the order of the slides.</li><li>Unlike traditional presentation software, slides can be laid out both horizontally and vertically (see belwo for more information).</li><li>Direct children will be laid out horizontally and the children of those will be laid out vertically. Children deeper than two levels of nesting are ignored.</li></ul><h2>Interaction and navigation</h2><p>In the floating buttons section (top-right):</p><ul><li>Edit button to go to the corresponding note of the current slide.</li><li>Press Overview button (or the <kbd>O</kbd> key) to show a birds-eye view of the slides. Press the button again to disable it.</li><li>Press the “Start presentation” button to show the presentation in full-screen.</li></ul><p>The following keyboard shortcuts are supported:</p><ul><li>Press <kbd>←</kbd> and <kbd>→</kbd> (or <kbd>H</kbd> and <kbd>L</kbd>) to go to the slide on the left or on the right (horizontal).</li><li>Press <kbd>↑</kbd> and <kbd>↓</kbd> &nbsp;(or <kbd>K</kbd> and <kbd>J</kbd>) to go to the upward or downward slide (vertical).</li><li>Press <kbd>Space</kbd> and <kbd>Shift</kbd> + <kbd>Space</kbd> or &nbsp;to go to the next/previous slide in order.</li><li>And a few more, press <kbd>?</kbd> to display a popup with all the supported keyboard combinations.</li></ul><h2>Vertical slides and nesting</h2><p>Unlike traditional presentation software such as Microsoft PowerPoint, the slides in Trilium can be laid out horizontally or vertically in order to create depth or better organize the slides by topic.</p><p>This horizontal/vertical organization affects transitions (especially on the “slide” transition), however it is most noticeable in navigation.</p><ul><li>Pressing <kbd>←</kbd> and <kbd>→</kbd> will navigate through slides horizontally, thus skipping vertical notes under the current slide. This is useful to skip entire chapters/related slides.</li><li>Pressing <kbd>↑</kbd> and <kbd>↓</kbd> will navigate through the vertical slides at the current level.</li><li>Pressing <kbd>Space</kbd> and <kbd>Shift</kbd> + <kbd>Space</kbd> will go to the next/previous slide in order, regardless of the direction. This is generally the key combination to use when presenting.</li><li>The arrows on the bottom-right of the slide will also reflect this navigation scheme.</li></ul><figure class=\"image image-style-align-right image_resized\" style=\"width:55.57%;\"><img style=\"aspect-ratio:890/569;\" src=\"{{helpAssets}}/User%20Guide/Collections/1_Presentation_image.png\" width=\"890\" height=\"569\"></figure><p>All direct children of the collection will be laid out horizontally. If a direct child also has children, those children will be placed as vertical slides.</p><p>In the following example, the note structure is as follows:</p><ul><li>Presentation collection<ul><li>Trilium Notes (demo page)</li><li>“Introduction” slide<ul><li>“The challenge of personal knowledge management”</li><li>“Note-taking structures”</li></ul></li><li>“Demo &amp; Feature highlights” slide<ul><li>“Really fast installation process”</li><li>Video slide</li></ul></li></ul></li></ul><h2>Customization</h2><p>At collection level, it's possible to adjust:</p><ul><li>The theme of the entire presentation to one of the predefined themes by going to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>&nbsp;and looking for the <em>Theme</em> option.</li><li>It's currently not possible to create custom themes, although it is planned.</li><li>Note that it is note possible to alter the CSS via&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlhDUqhENtH7\">Custom app-wide CSS</a>&nbsp;because the slides are rendered isolated (in a shadow DOM).</li></ul><p>At slide level:</p><ul><li>It's possible to adjust the background color of a slide by using the <a href=\"#root/_help_OFXdgB2nNk1F\">predefined promoted attribute</a> for the color or manually setting <code spellcheck=\"false\">#slide:background</code> to a hex color.</li><li>More complex backgrounds can be achieved via gradients. There's no UI for it; it has to be set via <code spellcheck=\"false\">#slide:background</code> to a CSS gradient definition such as: <code spellcheck=\"false\">linear-gradient(to bottom, #283b95, #17b2c3)</code>.</li></ul><h2>Tips and tricks</h2><ul><li>Text notes generally respect the formatting (bold, italic, foreground and background colors) and font size. Code blocks and tables also work.</li><li>Try using more than just text notes, the presentation uses the same mechanism as <a href=\"#root/_help_R9pX4DGra2Vt\">shared notes</a> and&nbsp;<a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a>&nbsp;so it should be able to display&nbsp;<a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a>,&nbsp;<a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a>&nbsp;in full-screen (without the interactivity).<ul><li><p>Consider using a transparent background for&nbsp;<a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a>, if the slides have a custom background (go to the hamburger menu in the Canvas, press the button select a custom color and write <code spellcheck=\"false\">transparent</code>).</p></li><li><p>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a>, some of them have a predefined background which can be changed via the frontmatter. For example, for XY-charts:</p><pre><code class=\"language-text-x-trilium-auto\">---\nconfig:\n themeVariables:\n xyChart:\n backgroundColor: transparent\n---</code></pre></li></ul></li></ul><h2>Under the hood</h2><p>The Presentation view uses <a href=\"https://revealjs.com/\">Reveal.js</a> to handle the navigation and layout of the slides.</p>",
- "_help_8QqnMzx393bx": "<figure class=\"image\"><img style=\"aspect-ratio:990/590;\" src=\"{{helpAssets}}/User%20Guide/Collections/Grid%20View_image.png\" width=\"990\" height=\"590\"></figure><p>This view presents the child notes in a grid format, allowing for a more visual navigation experience.</p><p>Each tile contains:</p><ul><li>The title of a note.</li><li>A snippet of the content.</li><li>For empty notes, the sub-children are also displayed, allowing for quick navigation.</li></ul><p>Depending on the type of note:</p><ul><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes, the text can be slightly scrollable via the mouse wheel to reveal more context.</li><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;notes, syntax highlighting is applied.</li><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a>&nbsp;notes, a preview is made available for audio, video and PDF notes.</li><li>If the note does not have a content, a list of its child notes will be displayed instead.</li></ul><p>The grid view is also used by default in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a>&nbsp;of every note, making it easy to navigate to children notes.</p><h3>Creating a new table</h3><p>Right click on an existing note in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and select <em>Insert child note</em> and look for <em>Grid View</em>.</p><h2>Configuration</h2><p>Unlike most other view types, the grid view is not actually configurable.</p>",
- "_help_mULW0Q3VojwY": "<figure class=\"image\"><img style=\"aspect-ratio:1387/758;\" src=\"{{helpAssets}}/User%20Guide/Collections/List%20View_image.png\" width=\"1387\" height=\"758\"></figure><p>List view is similar to&nbsp;<a class=\"reference-link\" href=\"#root/_help_8QqnMzx393bx\">Grid View</a>, but in the list view mode, each note is displayed in a single row with only the title and the icon of the note being visible by the default. By pressing the expand button it's possible to view the content of the note, as well as the children of the note (recursively).</p><p>In the example above, the \"Node.js\" note on the left panel contains several child notes. The right panel displays the content of these child notes as a single continuous document.</p><h3>Creating a new table</h3><p>Right click on an existing note in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and select <em>Insert child note</em> and look for <em>List View</em>.</p><h2>Interaction</h2><ul><li>Each note can be expanded or collapsed by clicking on the arrow to the left of the title.</li><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_BlN9DFI679QC\">Ribbon</a>, in the <em>Collection</em> tab there are options to expand and to collapse all notes easily.</li></ul><h2>Printing and exporting to PDF</h2><p>Since v0.100.0, list collections can be <a href=\"#root/_help_NRnIZmSMc5sj\">printed or exported to PDF</a>.</p><p>A printed list collection will print all the notes in the collection, in the right order and preserving the full hierarchy.</p><p>If exported to PDF within the desktop application, there is additional functionality:</p><ul><li>The table of contents of the PDF will reflect the structure of the notes.</li><li>Reference and inline links to other notes within the same hierarchy will be functional (will jump to the corresponding page). If a link refers to a note that is not in the printed hierarchy, it will be unlinked.</li></ul><h2>Expanding and collapsing multiple notes at once</h2><p>Apart from individually expanding or collapsing notes, it's also possible to expand or collapse them all at once. To do so, go to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>&nbsp;and look for the corresponding button.</p><p>By default, the <em>Expand</em> button will only expand the direct children (first level) of the collection. Starting with v0.100.0, it's possible to expand multiple levels of notes using the arrow button next to the button.</p><p>Manually expanded notes will reset if the application/tab is closed and then the collection is visited again. Automatically expanded notes, using the ribbon configuration will persist.</p><aside class=\"admonition tip\"><p>By design, the UI provides only a handful of levels of depth for expanding notes (direct children, 2-5, all levels). It's also possible to specify any desired depth by manually setting the <a href=\"#root/_help_HI6GBBIduIgv\">corresponding label</a>. For example: <code spellcheck=\"false\">#expanded=100</code> to expand up to 100 levels of depth.</p></aside><aside class=\"admonition note\"><p>From a performance standpoint, the List collection is efficient since it does not load child notes unless the notes are actually expanded. Expanding the list for a significantly large hierarchy can cause slow-downs.</p></aside>",
- "_help_CssoWBu8I7jF": "<figure class=\"image\"><img style=\"aspect-ratio:1177/98;\" src=\"{{helpAssets}}/User%20Guide/Collections/Collection%20Properties_image.png\" width=\"1177\" height=\"98\"></figure><p>The <em>Collection Properties</em> is a toolbar that is displayed at the top of every <a href=\"#root/_help_GTwFsgaA0lCt\">collection note</a>.</p><p>For versions prior to v0.102.0, this feature was only available for the&nbsp;<a class=\"reference-link\" href=\"#root/_help_IjZS7iK5EXtb\">New Layout</a>. Starting with this version, the collection properties are enabled for the Old layout as well, and&nbsp;<a class=\"reference-link\" href=\"#root/_help_BlN9DFI679QC\">Ribbon</a>&nbsp;no longer contains a dedicated tab for collection properties.</p><p>The collection properties has:</p><ul><li>A quick selector for the view type (e.g. grid, calendar, board).</li><li>A settings button with:<ul><li>Settings for the current view, for example hiding the weekends in a calendar.</li><li>Generic settings for the collection, such as <a href=\"#root/_help_wyaGBBQrl4i3\">hiding the child notes</a> or showing <a href=\"#root/_help_MKmLg5x6xkor\">archived notes</a>.</li></ul></li><li>Specific interactions for the current view, for example month selector and view switcher for the calendar.</li></ul>",
- "_help_IF7Q6I9x7zuw": "<figure class=\"image\"><img style=\"aspect-ratio:1406/1030;\" src=\"{{helpAssets}}/User%20Guide/Collections/Dashboard_image.png\" width=\"1406\" height=\"1030\"></figure><aside class=\"admonition note\"><p>The dashboard is currently considered beta. This means that it might face some changes in behavior until it is stabilized.</p></aside><p>The dashboard is a collection introduced in Trilium v0.104.0. It is similar to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8QqnMzx393bx\">Grid View</a>&nbsp;collection, but with some key differences:</p><ul><li>The grid layout is not fixed, allowing for tiles of varying widths and heights. The grid has 12 columns and an unlimited number of rows.</li><li>Each widget represents a child note of the collection and can be reordered or resized.</li><li>The grid will distribute the columns evenly to fill the entire screen.<ul><li>If the available space is too low (e.g. in a split or in mobile), the columns are collapsed so that all widgets are displayed one under the other.</li><li>While the columns are collapsed, the widgets cannot be reordered or resized.</li></ul></li><li>Unlike the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8QqnMzx393bx\">Grid View</a>, the widgets are not clickable which allows them to be interactive.</li></ul><h2>Types of widgets</h2><p>The dashboard uses the same rendering mechanism as the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8QqnMzx393bx\">Grid View</a>&nbsp;or the&nbsp;<a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a>, which means every note can be rendered, such as:</p><ul><li>Static content, via&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;or&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>.</li><li>Images via&nbsp;<a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a>,&nbsp;<a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a>,&nbsp;<a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a>.</li><li>Interactive widgets via&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>.</li><li>Web pages can be displayed via&nbsp;<a class=\"reference-link\" href=\"#root/_help_1vHRoWCEjj0L\">Web View</a>&nbsp;and refreshed via the context menu.</li><li><a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>&nbsp;render interactively inside the dashboard</li></ul><aside class=\"admonition tip\"><p>Interactive widgets through the use of&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>&nbsp;is the highlighted use case of the dashboard. Using the&nbsp;<a class=\"reference-link\" href=\"#root/_help_GBBMSlVSOIGP\">AI</a>&nbsp;chat, these widgets can be easily created as the AI is instructed in how to write them.</p></aside><h2>Adding new widgets</h2><p>There are two ways to add widgets to a dashboard:</p><ul><li>Create a child note of any type, the dashboard will automatically pick it up and add it onto the grid.</li><li>From the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, drag an existing note onto the dashboard and it will be placed there. This will <a href=\"#root/_help_IakOLONlIfGI\">clone</a> the note into the collection.</li></ul>",
- "_help_BgmBlOIl72jZ": "<p>While Trilium is actively maintained and stable, encountering bugs is possible.</p><h2>General Quick Fix</h2><p>The first step in troubleshooting is often a restart.</p><p>If you experience an UI issue, the frontend may have entered an inconsistent state. Reload the application by pressing <kbd>Ctrl</kbd> + <kbd>R</kbd>. This will reload the frontend.</p><p>If the issue persists or appears to be a backend problem, restart the entire application. For the desktop (Electron) build, simply close and reopen the window. If you're using a Docker build, restart the container.</p><h2>Broken Note Crashes Trilium</h2><p>Certain problems, such as rendering a note with a faulty script, can cause Trilium to crash. If Trilium attempts to reload the problematic note upon restart, it will continue to crash.</p><p>To resolve this, use the <code spellcheck=\"false\">TRILIUM_START_NOTE_ID</code> environment variable to reset the open tabs to a single specified note ID (e.g., <code spellcheck=\"false\">root</code>). In Linux, you can set it as follows:</p><pre><code class=\"language-text-x-trilium-auto\">TRILIUM_START_NOTE_ID=root ./trilium</code></pre><h2>Broken Script Prevents Application Startup</h2><p>If a custom script causes Trilium to crash, and it is set as a startup script or in an active <a href=\"#root/_help_MgibgPcfeuGz\">custom widget</a>, start Triliumin \"safe mode\" to prevent any custom scripts from executing:</p><pre><code class=\"language-text-x-trilium-auto\">TRILIUM_SAFE_MODE=true ./trilium</code></pre><p>Depending on your Trilium distribution, you may have pre-made scripts available: <code spellcheck=\"false\">trilium-safe-mode.bat</code> and <code spellcheck=\"false\">trilium-safe-mode.sh</code>.</p><p>Once Trilium starts, locate and fix or delete the problematic note.</p><h2>Sync and Consistency Checks</h2><p>Trilium periodically verifies the logical consistency of the database (e.g., ensuring every note has a parent). If inconsistencies are detected, you will be notified via the UI.</p><p>In such cases, file a bug report and attach an <a href=\"#root/_help_x59R8J8KV5Bp\">anonymized database</a> if necessary.</p><h2>Restoring Backup</h2><p>Trilium makes regular automatic backups. If issues become severe, you can <a href=\"#root/_help_ODY7qQn5m2FT\">restore from a backup</a>.</p><h2>Forgotten Password</h2><p>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_lwAX5SvbrK2g\">Resetting your password</a>.</p><h2>Reporting Bugs</h2><p>Reporting bugs is highly valuable. Here are some tips:</p><ul><li>Use GitHub issues for reporting: <a href=\"https://github.com/TriliumNext/Trilium/issues\">https://github.com/TriliumNext/Trilium/issues</a></li><li>Refer to the <a href=\"#root/_help_qzNzp9LYQyPT\">error logs</a> page for information on providing necessary details.</li></ul>",
++ "_help_NdowYOC1GFKS": "<p>Tables are a powerful feature for&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes, since editing them is generally easy.</p><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:176/204;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/2_Tables_image.png\" width=\"176\" height=\"204\"></figure><p>To create a table, simply press the table button and select with the mouse the desired amount of columns and rows, as indicated in the adjacent figure.</p><p>Since v0.107.0, the same menu starts with an <em>Insert table…</em> item, for a table larger than the grid or to type its size instead:</p><ol><li>Click the <span class=\"tn-icon cke cke-table\"></span>button and select <em>Insert table…</em>. A small form opens at the cursor.</li><li>Enter the number of <em>Columns</em> (up to 100) and <em>Rows</em> (up to 1000). The table can have at most 5000 cells in total, for example 1000 rows of 5 columns.</li><li>Press <em>Insert</em> or <kbd>Enter</kbd>.</li></ol><p>To close the form without inserting a table, press <kbd>Esc</kbd> or click outside it. From the keyboard, <kbd>Tab</kbd> moves between <em>Insert table…</em> and the grid while the menu is open.</p><p>On the <a class=\"reference-link\" href=\"#root/_help_RDslemsQ6gCp\">Mobile Frontend</a>, the <span class=\"tn-icon cke cke-table\"></span>button opens the form directly, without the grid.</p><h2>Formatting toolbar</h2><p>When a table is selected, a special formatting toolbar will appear:</p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/3_Tables_image.png\" width=\"384\" height=\"100\"><h2>Context menu</h2><p>Since v0.106.0, right-clicking anywhere inside a table opens a context menu with the most common table operations:</p><ul><li><em>Insert row above</em> and <em>Insert row below</em> insert a blank row next to the row of the current cell. When the selection spans multiple rows, the same number of rows is inserted.</li><li><em>Insert column to the left</em> and <em>Insert column to the right</em> work the same way for columns.</li><li>Since v0.107.0, <em>Set as header</em> or <em>Set header up to this row</em>, depending on the selection, turns rows into header rows, which always start at the top of the table:<ul><li><em>Set as header</em> shows when the selection starts at the first row, and makes every selected row a header row.</li><li><em>Set header up to this row</em> shows when the selection is in a single row below the first, and makes that row and every row above it header rows.</li><li>Neither shows when the selection spans several rows below the first.</li><li>A check mark shows that the rows are already header rows. Choosing the item again turns them, and every header row below them, back into regular rows. For example, in a table with five header rows, choosing <em>Set header up to this row</em> on the third row leaves only the first two as header rows.</li></ul></li><li><em>Merge cells</em> merges the selected cells into one. The selected cells must form a rectangle.</li><li><em>Split cell</em> splits each selected cell in two, either <em>Vertically</em> or <em>Horizontally</em>. <em>Unmerge cells</em>, in the same submenu, turns each merged cell in the selection back into the single cells it covers, keeping its content in the top-left one; cells that are not merged stay as they are.</li><li><em>Distribute columns evenly</em> splits the combined width of the columns the selection touches equally between them. The other columns and the width of the table stay as they are. It needs a selection spanning at least two columns; a merged cell counts for every column it covers.</li><li><em>Cut</em>, <em>Copy</em> and <em>Copy as Markdown</em> act on the selected cells. Since v0.107.0, <em>Copy</em> and <em>Paste</em> open submenus with their variants, such as <em>Copy as Markdown</em> and <em>Paste as plain text</em>; clicking <em>Copy</em> or <em>Paste</em> itself still copies or pastes:<ul><li>Cutting or copying produces a smaller table holding just the selected cells. Pasting it over a cell selection replaces those cells; pasting elsewhere inserts it as a table of its own. Cutting clears the cells without removing rows or columns.</li><li><em>Copy as Markdown</em> converts the selected cells to a Markdown table. A selected header row becomes the Markdown header; without one, an empty header row is emitted, since Markdown tables require one.</li></ul></li><li>Since v0.107.0, <em>Paste rows above</em> and <em>Paste rows below</em>, in the <em>Paste</em> submenu, paste the clipboard as new rows next to the row of the current cell, instead of over the cells from the cursor on. They show only when the selection is in a single row, and, like <em>Paste</em>, only where the clipboard can be read:<ul><li>A copied table becomes one new row for each of its rows, filled from the first column. When it has more columns than the table, the table gains columns, as with a regular paste. Other content goes in the first cell of a single new row.</li><li>The new rows are selected afterwards.</li><li>When merged cells join the row to others, the new rows go above or below that whole block of rows.</li></ul></li><li><em>Sort</em>, below the clipboard section, sorts the rows by the column of the current cell, in <em>Ascending</em> or <em>Descending</em> order. See <a href=\"#sorting-rows\">Sorting rows</a>.</li><li><em>Delete row</em> and <em>Delete column</em>, below <em>Sort</em>, remove every row or column the selection touches, even when only some of their cells are selected.</li><li><em>Delete table</em> removes the whole table and leaves an empty paragraph in its place. In a table nested inside another, only the inner table is removed.</li><li>Since v0.107.0, <em>Select</em>, below <em>Delete table</em>, selects the cells of every row (<em>Row</em>) or column (<em>Column</em>) the selection touches, or every cell of the table (<em>Table</em>). Unlike the <span class=\"tn-icon cke cke-drag-handle\"></span>button, which selects the table as a whole, <em>Table</em> selects its cells, so cell operations such as <em>Merge cells</em> apply to all of them. In a table nested inside another, <em>Table</em> selects only the cells of the inner table.</li></ul><p>Right-clicking a cell that is not part of the current selection moves the cursor there first, so the menu always applies to the cell under the pointer.</p><aside class=\"admonition note\"><p>In the browser, Trilium's menu replaces the browser's own context menu inside tables. To reach the browser's menu (for example for its spell checking suggestions), hold <kbd>Shift</kbd> while right-clicking. The desktop application is unaffected, since its menu already includes the spelling suggestions. In the browser, the menu also offers <em>Paste</em> only when the page can read the clipboard, which requires a secure (HTTPS) context and your permission; otherwise, paste with <kbd>Ctrl</kbd>+<kbd>V</kbd>.</p></aside><h2>Navigating a table</h2><ul><li>Using the mouse:<ul><li>Click on a cell to focus it.</li><li>Click the&nbsp;<span class=\"tn-icon cke cke-return-arrow\"></span> button at the top or the bottom of a table to insert an empty paragraph near it.</li><li>Click the&nbsp;<span style=\"--tn-color:hsl(0,0%,60%);color:hsl(0,0%,60%);\"><span class=\"tn-icon cke cke-drag-handle\"></span></span> button at the top-left of the table to select it entirely (for easy copy-pasting or cutting) or drag and drop it to relocate the table.</li></ul></li><li>Using the keyboard:<ul><li>Use the arrow keys on the keyboard to easily navigate between cells.</li><li>It's also possible to use <kbd>Tab</kbd> to go to the next cell and Shift+Tab to go to the previous cell.</li><li>Unlike arrow keys, pressing <kbd>Tab</kbd> at the end of the table (last row, last column) will create a new row automatically.</li><li>To select multiple cells, hold <kbd>Shift</kbd> while using the arrow keys.</li></ul></li><li>Using touch:<ul><li>Since v0.107.0, touching a table outlines the cell with the cursor, or the selected cells, and shows a handle at each corner of the outline.</li><li>To select multiple cells, drag one of the handles across the table. The cell at the opposite corner stays selected, so the selection grows or shrinks as the finger moves. The note and wide tables scroll when the handle reaches the edge of the screen.</li></ul></li></ul><h2>Resizing cells</h2><ul><li>Columns can be resized by hovering the mouse over the border of two adjacent cells and dragging it.</li><li>To give several columns the same width, select cells across them and choose <em>Distribute columns evenly</em> from the <span class=\"tn-icon cke cke-table-column\"></span>button of the formatting toolbar or from the <a href=\"#context-menu\">context menu</a>.</li><li>By default, the row height is not adjustable using the mouse, but it can be configured from the cell settings (see below).</li><li>To adjust exactly the width (in pixels or percentages) of a cell, select the&nbsp;<span class=\"tn-icon cke cke-table-cell-properties\"></span> button.</li></ul><h3>Resizing with touch</h3><p>Since v0.107.0, touching a table shows a bar at the bottom of the note, above the formatting toolbar on mobile. The bar has a segment for each column of the table, with a divider at the end of each column. Only the divider of the column with the cursor is a handle that resizes; the other dividers only mark where the columns meet, so a swipe across them scrolls instead. When several cells are selected, each column they cover has a handle.</p><ul><li>To resize a column, place the cursor in one of its cells or tap its segment, then drag its handle. The table grows or shrinks with the column, and scrolls when the handle reaches the edge of the screen. The column snaps to its starting width and to the widths of the columns beside it.</li><li>To cancel a resize, drag the handle back to where it started, or touch the screen with a second finger.</li><li>To give a column and the next one the same width, double-tap the handle between them.</li><li>To select a column, tap its segment. To open the column menu, touch and hold the segment.</li><li>To scroll a wide table sideways, swipe along the bar.</li></ul><p>A wide table scrolls a little past its end, so the handle of its last column stays away from the edge of the screen, where a swipe navigates back.</p><h2>Wide tables</h2><p>Since v0.107.0, a table can be wider than the&nbsp;<a class=\"reference-link\" href=\"#root/_help_t596jLvPrqkS\">Content width</a>. Such a table scrolls sideways, while the rest of the note keeps its width.</p><ul><li>A new table is as wide as the content. To make it wider, drag the right border of its last column past the edge of the content. The border snaps to the edge and holds there briefly, so the table is easy to bring back to the width of the content.</li><li>To set an exact width, enter a percentage above <code>100%</code> or a width in pixels in the&nbsp;<span class=\"tn-icon cke cke-table-properties\"></span> <a href=\"#table-properties\">table properties</a>.</li><li>A table whose content needs more room than the note, such as a pasted table with many columns, also scrolls instead of stretching the note.</li><li>Wide tables scroll the same way in read-only notes and on shared pages.</li><li>When printing or exporting to PDF, a wide table is shrunk to fit the page.</li></ul><p>Tables inside other blocks, such as block quotes, admonitions, collapsible blocks, columns or tabs, are limited to the width of their block and do not scroll.</p><h3>Mobile support</h3><p>On the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RDslemsQ6gCp\">Mobile Frontend</a>, a table keeps the width it has on a desktop and scrolls sideways, instead of squeezing its columns into the width of the screen. The full width of a table is the <em>Max content width</em> set in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Appearance</em> → <em>Content Width</em> on the mobile device, 1200 pixels by default. For example, a table set to <code>50%</code> is 600 pixels wide.</p><p>To resize columns on mobile, use the bar described in <a href=\"#resizing-with-touch\">Resizing with touch</a>.</p><h2>Long tables</h2><p>Since v0.107.0, the header rows of a table stay visible at the top of the note while you scroll through the rest of the table, and leave with the end of the table. This also works in read-only notes, on shared pages and in wide tables.</p><p>To turn rows into header rows, use <em>Set as header</em> in the <a href=\"#context-menu\">context menu</a>, or <em>Header row</em> in the <span class=\"tn-icon cke cke-table-row\"></span> button of the formatting toolbar.</p><p>To let header rows scroll away with the rest of the table, turn off <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Text Notes</em> → <em>Features</em> → <em>Use sticky header rows for tables</em>. The setting applies to the current device only, and shared pages keep their sticky header rows.</p><h2>Inserting new rows and new columns</h2><ul><li>To insert a new column, click on a desired location, then press the&nbsp;<span class=\"tn-icon cke cke-table-column\"></span> button from the formatting toolbar and select <em>Insert column left or right.</em></li><li>To insert a new row, click on a desired location, then press the&nbsp;<span class=\"tn-icon cke cke-table-row\"></span> button and select <em>Insert row above</em> or <em>below</em>.<ul><li>A quicker alternative to creating a new row while at the end of the table is to press the <kbd>Tab</kbd> key.</li></ul></li><li>Both operations are also available in the <a href=\"#context-menu\">context menu</a>, which inserts as many rows or columns as the selection spans.</li></ul><h2>Moving rows and columns</h2><p>Since v0.106.0, rows and columns can be reordered with the keyboard:</p><ul><li><kbd>Alt</kbd>+<kbd>Up</kbd> and <kbd>Alt</kbd>+<kbd>Down</kbd> move the rows touched by the selection up or down.</li><li><kbd>Alt</kbd>+<kbd>Left</kbd> and <kbd>Alt</kbd>+<kbd>Right</kbd> move the columns touched by the selection left or right.</li></ul><p>Merged cells are never split by a move. The rows or columns held together by a merged cell travel as one block, and moving toward such a block jumps over it entirely.</p><p>When the table has a header row, a header row moved below the header area becomes a regular row, and a regular row moved into the header area becomes a header row. Header columns behave the same way.</p><p>Outside of tables, <kbd>Alt</kbd>+<kbd>Left</kbd> and <kbd>Alt</kbd>+<kbd>Right</kbd> keep navigating the note history, and <kbd>Alt</kbd>+<kbd>Up</kbd> and <kbd>Alt</kbd>+<kbd>Down</kbd> keep moving the current paragraph.</p><h2>Sorting rows</h2><p>Since v0.107.0, the rows of a table can be sorted by the values of one column:</p><ul><li>To sort all the rows, place the cursor in any cell of the column to sort by, then select <em>Sort</em> → <em>Ascending</em> or <em>Descending</em> from the <a href=\"#context-menu\">context menu</a>. The same items are in the <span class=\"tn-icon bx bx-sort-alt-2\"></span>button of the formatting toolbar.</li><li>To sort only some of the rows, select their cells in the column to sort by, then sort the same way. Sorting is not available while the selection spans more than one column.</li></ul><p>Header rows always stay at the top of the table and are never sorted. A sort can be undone with <kbd>Ctrl</kbd>+<kbd>Z</kbd>.</p><h3>How values are compared</h3><p>Each cell is read as plain text, so formatting does not affect the order. Trilium then detects what kind of value the cell holds:</p><figure class=\"table\"><table><thead><tr><th>Kind</th><th>Examples</th><th>Compared by</th></tr></thead><tbody><tr><td>Time</td><td><code>15:02</code>, <code>15:02:38</code>, <code>3:02 PM</code></td><td>The time of day.</td></tr><tr><td>Date</td><td><code>2026-09-30</code>, <code>2026-09-30 15:02</code>, <code>30 September 2026</code>, <code>Wednesday, 30 September 2026</code>, <code>2026-09-30T15:02:38+03:00</code></td><td>The date and time.</td></tr><tr><td>Number</td><td><code>12</code>, <code>-3.5</code>, <code>1,234.56</code>, <code>$ 12.04</code>, <code>21 RON</code>, <code>24.5m</code></td><td>The numeric value.</td></tr><tr><td>Text</td><td>Anything else.</td><td>Alphabetically, ignoring case, with numbers inside the text in numeric order (<code>Item 9</code> before <code>Item 10</code>). Accents count, so <code>a</code> and <code>á</code> differ.</td></tr><tr><td>Empty</td><td>An empty cell, or one holding only spaces.</td><td>Not compared. Empty cells always go last.</td></tr></tbody></table></figure><p>Ascending order puts times first, then dates, numbers and text. Descending order reverses it. Empty cells go last in both directions.</p><p>Numbers, dates and times with the same value are ordered by their text, so <code>5 apples</code> comes before <code>5 pears</code>. Rows whose cells hold the same text, ignoring case, keep their relative order.</p><ul><li>Dates are also recognized in the formats of the note's language, such as <code>30.09.2026</code> or <code>30. September 2026</code> for German, and in the format chosen in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Text Notes</em> → <em>Editor</em> → <em>Date/time format</em> for <a href=\"#root/_help_CohkqWQC1iBv\">inserting the date and time</a>.</li><li>A number can start with a currency symbol, such as <code>$</code>, <code>€</code> or <code>£</code>. Whatever follows the number, such as a unit, is ignored, so units are not converted: <code>1 km</code> sorts before <code>500 m</code>. A cell that starts with letters, such as <code>RON 21</code>, is text.</li><li>The decimal separator follows the language of the note: <code>1.500</code> is one and a half in English, but one thousand five hundred in German. A comma or period that is not followed by exactly three digits is always read as a decimal separator, so <code>1,5</code> is one and a half in either language.</li><li>The language of the note set in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlJ73vBCjWDw\">Status bar</a>&nbsp;via the&nbsp;<span class=\"tn-icon bx bx-globe\"></span> icon, or else the default content language. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_veGu4faJErEM\">Content language &amp; Right-to-left support</a>.</li></ul><h3>Merged cells</h3><p>Rows joined by a merged cell are kept together and move as one block. The block is sorted by the value in its first row. When the block has more than one cell in the sorted column, the other cells do not affect the order, and a message says so: <em>Some rows were sorted together because merged cells tie them to each other</em>.</p><p>When the selection covers only part of such a block, the whole block is sorted.</p><h2>Merging cells</h2><p>To merge two or more cells together, simply select them via drag &amp; drop and press the&nbsp;<span class=\"tn-icon cke cke-table-merge-cell\"></span> button from the formatting toolbar.</p><p>More options are available by pressing the arrow next to it:</p><ul><li>Click on a single cell and select Merge cell up/down/right/left to merge with an adjacent cell.</li><li>Select <em>Merge selected cells</em> to merge the selected cells, the same as pressing the button itself.</li><li>Select <em>Split cell vertically</em> or <em>horizontally</em>, to split a cell into multiple cells (can also be used to undo a merge).</li><li>Select <em>Unmerge cells</em> to turn each merged cell in the selection back into the single cells it covers, keeping its content in the top-left one.</li></ul><p><em>Merge selected cells</em> and <em>Unmerge cells</em> are available since v0.107.0. Merging and splitting are also available by right-clicking the selected cells, via the <a href=\"#context-menu\">context menu</a>, where <em>Unmerge cells</em> is in the <em>Split cell</em> submenu.</p><h2>Table properties</h2><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:312/311;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Tables_image.png\" width=\"312\" height=\"311\"></figure><p>The table properties can be accessed via the&nbsp;<span class=\"tn-icon cke cke-table-properties\"></span> button and allows for the following adjustments:</p><ul><li>Border (not the border of the cells, but the outer rim of the table), which includes the style (single, double), color and width.</li><li>The background color, with none set by default.</li><li>The width and height of the table in percentage (must end with <code>%</code>) or pixels (must end with <code>px</code>).</li><li>The alignment of the table.<ul><li>Left or right-aligned, case in which the text will flow next to it.</li><li>Centered, case in which text will avoid the table, regardless of the table width.</li></ul></li></ul><p>The table will immediately update to reflect the changes, but the <em>Save</em> button must be pressed for the changes to persist.</p><h2>Cell properties</h2><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:320/386;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/1_Tables_image.png\" width=\"320\" height=\"386\"></figure><p>Similarly to table properties, the&nbsp;<span class=\"tn-icon cke cke-table-cell-properties\"></span> button opens a popup which adjusts the styling of one or more cells (based on the user's selection).</p><p>The following options can be adjusted:</p><ul><li>The border style, color and width (same as table properties), but applying to the current cell only.</li><li>The background color, with none set by default.</li><li>The width and height of the cell in percentage (must end with <code>%</code>) or pixels (must end with <code>px</code>).</li><li>The padding (the distance of the text compared to the cell's borders).</li><li>The alignment of the text, both horizontally (left, centered, right, justified) and vertically (top, middle or bottom).</li></ul><p>The cell will immediately update to reflect the changes, but the <em>Save</em> button must be pressed for the changes to persist.</p><h2>Border and background colors</h2><p>The border and background colors of tables and cells adapt to the <a href=\"#root/_help_Wy267RK4M69c\">theme</a>, the same way as <a href=\"#root/_help_Gr6xFaF6ioJ5\">text colors</a> do. A color picked from the palette, chosen with the color picker or typed in is shown in a lighter or darker shade that suits the current theme, so borders stay visible and text stays readable on the background. The hue stays the same, and the table keeps the color as it was picked.</p><p>Colors applied with older versions of Trilium are shown exactly as they were picked, until the note is next edited.</p><p>Older browsers that can't adapt colors show them exactly as they were picked.</p><h2>Caption</h2><p>Press the&nbsp;<span class=\"tn-icon cke cke-caption\"></span> button to insert a caption or a text description of the table, which is going to be displayed above the table.</p><h2>Table borders</h2><p>By default, tables will come with a predefined gray border.</p><p>To adjust the borders, follow these steps:</p><ol><li>Select the table.</li><li>In the floating panel, select the <em>Table properties</em> option (<span class=\"tn-icon cke cke-table-properties\"></span>).<ol><li>Look for the <em>Border</em> section at the top of the newly opened panel.</li><li>This will control the outer borders of the table.</li><li>Select a style for the border. Generally <em>Single</em> is the desirable option.</li><li>Select a color for the border.</li><li>Select a width for the border, expressed in pixels.</li></ol></li><li>Select all the cells of the table and then press the <em>Cell properties</em> option (<span class=\"tn-icon cke cke-table-cell-properties\"></span>).<ol><li>This will control the inner borders of the table, at cell level.</li><li>Note that it's possible to change the borders individually by selecting one or more cells, case in which it will only change the borders that intersect these cells.</li><li>Repeat the same steps as from step (2).</li></ol></li></ol><h3>Tables with invisible borders</h3><p>Tables can be set to have invisible borders in order to allow for basic layouts (columns, grids) of text or <a href=\"#root/_help_mT0HEkOsz6i1\">images</a> without the distraction of their border:</p><ol><li>First insert a table with the desired number of columns and rows.</li><li>Select the entire table.</li><li>In <em>Table properties</em>, set:<ol><li><em>Style</em> to <em>Single</em></li><li><em>Color</em> to <code>transparent</code></li><li>Width to <code>1px</code>.</li></ol></li><li>In Cell Properties, set the same as on the previous step.</li></ol><h2>Table indentation</h2><p>Since v0.104.1, tables can be indented as a block (the whole table moves, rather than just the content of a cell).</p><ol><li>Click the&nbsp;<span style=\"--tn-color:hsl(0,0%,60%);color:hsl(0,0%,60%);\"><span class=\"tn-icon cke cke-drag-handle\"></span></span> button to select the entire table. Otherwise, the indentation applies only to the current cell's content.</li><li>Press <kbd>Tab</kbd> to increase the indent, or <kbd>Shift</kbd>+<kbd>Tab</kbd> to decrease it. Alternatively, use the indentation buttons in the formatting toolbar.</li></ol><p>Markdown does not support indented tables, so the indentation is lost when converting to Markdown.</p><h2>Markdown import/export</h2><p>Simple tables are exported in GitHub-flavored Markdown format (e.g. a series of <code>|</code> items). If the table is found to be more complex (it contains HTML elements, has custom sizes or images), the table is converted to a HTML one instead.</p><p>Generally formatting loss should be minimal when exported to Markdown due to the fallback to HTML formatting.</p>",
++ "_help_pwc194wlRzcH": "<figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:265/108;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/Text%20Snippets_image.png\" width=\"265\" height=\"108\"></figure><p>Text Snippets are closely related to&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>, but instead of defining the content of an entire note, text snippets are pieces of formatted text that can easily be inserted in a text note.</p><h2>Creating a text snippet</h2><p>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>: </p><ol><li>Right click a note where to place the text snippet.</li><li>Select <em>Insert child note</em>.</li><li>Select <em>More</em> → <em>Text snippet</em>.</li></ol><p>Afterwards, simply type in the content of the note the desired text. The text can be formatted in the same manner as a normal text note.</p><p>The title of the note will become the title of the template. Optionally, a description can be added in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;section.</p><h2>Inserting a snippet</h2><p>Once a snippet is created, there are two options to insert it:</p><ol><li>From the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nRhnJkTT8cPs\">Formatting toolbar</a>, by looking for the&nbsp;<span class=\"tn-icon cke cke-trilium-template\"></span> button.</li><li>Using&nbsp;<a class=\"reference-link\" href=\"#root/_help_ZlN4nump6EbW\">Slash Commands</a>: <ol><li>To look for a specific template, start typing the name of the template (its title).</li><li>To look for all the templates, type <code>template</code>.</li></ol></li></ol><aside class=\"admonition tip\"><p>A newly created snippet doesn't appear? Generally it takes up to a few seconds to refresh the list of templates once you make a change.</p><p>If this doesn't happen, <a href=\"#root/_help_s8alTXmpFR61\">reload the application</a> and <a href=\"#root/_help_wy8So3yZZlH9\">report the issue</a>to us.&nbsp;</p></aside><h2>Limitations</h2><ul><li>Whenever a snippet is created, deleted or its title/description are modified, all the open text notes will need to be refreshed. This causes a slight flash for usually under a second, but it can cause some discomfort.</li><li>Unlike&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>, the snippets cannot be limited to a particular <a href=\"#root/_help_9sRHySam5fXb\">workspace</a>.</li></ul>",
++ "_help_fASfBrYnquKU": "<h2>Extended task states</h2><figure class=\"image image-style-align-left\"><img style=\"aspect-ratio:303/264;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Text/To-do%20Lists_image.png\" width=\"303\" height=\"264\"></figure><p>In Trilium, to-do items aren't limited to a simple \"done\" or \"not done.\" Tasks can also be marked as <em>in progress</em> (\"doing\"), <em>under consideration</em> (\"maybe\"), or <em>cancelled</em> (\"won't do\"), thus giving a more accurate picture of where things actually stand.</p><p>Right-click the checkbox and select the desired state. Alternatively, press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Enter </kbd> to cycle through the task states. Tapping or left-clicking the checkbox will always toggle between \"None\" and \"Done\".</p><p>Task states are fully preserved when converting between&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_6RM1Q7ppFVoj\">Markdown</a>&nbsp;notes, in both directions.</p><h3>Customizing the extended task states</h3><p>Task states are customizable: you can reorder them, create new ones with different colors and symbols, or delete the ones you don't need. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_i16PM6A7GXdU\">Customizing to-do task states</a>&nbsp;for more details.</p><h2>Keyboard shortcuts</h2><p>When at the beginning on an empty paragraph, type the following to insert a to-do list:</p><ul><li><code>[ ]</code> for an unchecked item</li><li><code>[x]</code> for a checked item</li></ul><p>Extended task states are supported as well, using its corresponding <em>Markdown symbol</em>. These are the defaults but they can be changed if needed (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_i16PM6A7GXdU\">Customizing to-do task states</a>):</p><ul><li><code>[/]</code> for “Doing”.</li><li><code>[?]</code> for “Maybe”.</li><li><code>[-]</code> for “Cancelled”.</li></ul><p>To reorder the item under the cursor, press <kbd>Alt</kbd>+<kbd>Up</kbd> or <kbd>Alt</kbd>+<kbd>Down</kbd>. To reorder multiple items, select them first.</p><h2>See also</h2><ul><li>To-do lists are meant for small task lists. For more complicated, day-to-day task tracking consider using a&nbsp;<a class=\"reference-link\" href=\"#root/_help_CtBQqbwXDx1w\">Kanban Board</a>&nbsp;collection instead.</li></ul>",
++ "_help_6f9hih2hXXZk": "<p>Trilium supports creating \"code\" notes, i.e. notes which contain some sort of formal code - be it programming language (C++, JavaScript), structured data (JSON, XML) or other types of codes (CSS etc.).</p><p>This can be useful for a few things:</p><ul><li>computer programmers can store code snippets as notes with syntax highlighting</li><li>JavaScript code notes can be executed inside Trilium for some extra functionality<ul><li>we call such JavaScript code notes \"scripts\" – see&nbsp;<a class=\"reference-link\" href=\"#root/_help_CdNpE2pqjmI6\">Scripting</a></li></ul></li><li>JSON, XML etc. can be used as storage for structured data (typically used in conjunction with scripting)</li></ul><p>For shorter snippets of code that can be embedded in&nbsp;<a href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes, see&nbsp;<a href=\"#root/_help_QxEyIjRBizuC\">Code blocks</a>.</p><p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Code_image.jpg\"></p><h2>Creating a code note</h2><p>In the <a href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, right-click a note and select <em>Insert child note</em> or <em>Insert note after</em>, then:</p><ul><li>To create a plain text code note, select <em>Code</em>.</li><li>To create a code note in a given language, hover <em>Code</em> and select the language. The list shows the languages enabled in the options (see below), and ends with <em>Configure code notes...</em>, which opens them.</li></ul><h2>Adjusting the language of a code note</h2><p>To change the language of a code note, look for the&nbsp;<span class=\"tn-icon bx bx-code\"></span> icon in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlJ73vBCjWDw\">Status bar</a>. When clicked it will reveal the list of available languages (which can be customized according to the section below). The menu also features a search bar to quickly filter, and icons to visually distinguish some of the programming languages.</p><p>On the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RDslemsQ6gCp\">Mobile Frontend</a>, the same list is available in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>&nbsp;→ <em>Change language mode</em>.</p><h2>Adjusting the list of languages</h2><p>Trilium supports syntax highlighting for many languages, but by default displays only some of them. The supported languages can be adjusted by going to&nbsp;<a href=\"#root/_help_4TIF1oA4VQRO\">Options</a>, then <em>Code Notes</em> and looking for the <em>Available MIME types in the dropdown</em> section. Simply check any of the items to add them to the list, or un-check them to remove them from the list.</p><p>Note that the list of languages is not immediately refreshed, you'd have to manually <a href=\"#root/_help_s8alTXmpFR61\">refresh the application</a>.</p><p>The list of languages is also shared with the&nbsp;<a href=\"#root/_help_QxEyIjRBizuC\">Code blocks</a>&nbsp;feature of&nbsp;<a href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes.</p><h2>Word wrap</h2><p>Long lines can be displayed on multiple lines:</p><ul><li>Globally for all code notes, from&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Code Notes.</em></li><li>For a particular note, by going to the menu in&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>&nbsp;and selecting <em>Word wrap</em> and selecting the appropriate option:<ul><li><em>Auto</em>, to respect the global word wrap for code notes.</li><li><em>On</em> or <em>Off</em>, to change the state of the word wrap for this note regardless of the global option.</li></ul></li></ul><aside class=\"admonition note\"><p>Word wrapping can also be adjusted at note level through the <code>#wrapLines</code> <a href=\"#root/_help_HI6GBBIduIgv\">label</a>, which can also be inherited.</p></aside><h2>Adjusting options using the status bar</h2><p>The status bar at the bottom of the editor shows the current indentation settings and language. Clicking on the indentation indicator opens a menu with three sections:</p><ol><li><em>Indent Using</em> — switch between Spaces and Tabs (<code>#indentWithTabs</code>). If a per-note override is active, a \"Reset to default\" option appears.</li><li><em>Display Width</em> — choose from preset widths (1, 2, 3, 4, 6, 8). Changes are saved as a per-note <code>#tabWidth</code> label.</li><li><em>Re-indent Content To</em> — convert existing indentation to a different style. For example, re-indent a file from 4 spaces to 2 spaces, or from spaces to tabs. This rewrites the leading whitespace on every line while preserving alignment remainders.</li></ol><p>Clicking the language indicator lets you change the note's MIME type. As in the <em>Note type</em> selector, typing narrows the list of languages.</p><h3>Re-indentation</h3><p>When you re-indent content, the editor:</p><ul><li>Measures the visual column width of each line's leading whitespace using the current style</li><li>Calculates indent levels and any alignment remainder</li><li>Rebuilds the leading whitespace in the target style</li><li>Preserves non-leading whitespace, blank lines, and content without indentation</li></ul><h2>Color schemes</h2><p>Since Trilium 0.94.0 the colors of code notes can be customized by going&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ Code Notes and looking for the <em>Appearance</em> section.</p><aside class=\"admonition note\"><p><strong>Why are there only a few themes whereas the code block themes for text notes have a lot?</strong><br>The reason is that Code notes use a different technology than the one used in Text notes, and as such there is a more limited selection of themes. If you find a CodeMirror 6 (not 5) theme that you would like to use, let us know and we might consider adding it to the set of default themes. There is no possibility of adding new themes (at least for now), since the themes are defined in JavaScript and not at CSS level.</p></aside><h2>Programming ligatures</h2><p>If you see <code>!=</code> displayed as <code>≠</code> or <code>-&gt;</code> as <code>→</code> inside a code note, those are <em>font ligature</em>: the default monospace font draws certain character pairs as a single symbol. The underlying text is not changed by Trilium (unlike text notes which have&nbsp;<a class=\"reference-link\" href=\"#root/_help_oI7GoyilXXAr\">Automatic replacements</a>), and copying it out gives you back <code>!=</code> and <code>-&gt;</code>.</p><p>This can be turned off with&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a><em>→ Appearance → Fonts → Programming ligatures</em>.</p><h2>Virtual keyboard behavior</h2><p>When using a virtual keyboard, keyboard suggestions and corrections are controlled as follows:</p><ul><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_6RM1Q7ppFVoj\">Markdown</a>&nbsp;and plain text code notes, the autocorrect is <strong>on</strong>, as well as automatic capitalization.</li><li>For all the other code notes, the autocorrect is off in order to avoid issues when typing code.</li></ul><aside class=\"admonition note\"><p>Not all browsers and platforms respect this value, so the keyboard suggestions might appear without autocorrecting or the browser might disregard this and autocorrect anyway.</p></aside>",
++ "_help_m523cpzocqaD": "<p>Trilium allows you to save common searches as notes within the note tree. The search results will appear as sub-notes under these \"saved search\" notes. Here is an example of how it works:</p><figure class=\"image image-style-align-center image_resized\" style=\"width:50%;\"><img style=\"aspect-ratio:812/585;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Saved%20Search_saved-search.gif\" width=\"812\" height=\"585\"></figure><p>A saved search runs when you open it, and when you expand it in the note tree. A saved search in a tab that is not shown, such as a background tab restored at startup, runs when you switch to that tab. Its results stay until you run the search again with the <em>Search</em> button of the search parameters. If the query has an error, it appears as a notification.</p><p>In&nbsp;<a class=\"reference-link\" href=\"#root/_help_64ZTlUPgEPtW\">Safe mode</a>, and when the request fails, the search does not run on its own. Press <em>Search now</em> to run it.</p><p>Once a search is saved, the <em>Search parameters</em> is still available underneath the&nbsp;<a class=\"reference-link\" href=\"#root/_help_l7pigIGu01K2\">Title</a>&nbsp;in order to be able to change the settings later on but it will appear collapsed by default.</p><h2>Location</h2><p>By default, saved searches are stored in the day note. However, you can designate a different note to store saved searches by marking it with the <code>#searchHome</code> label. Additionally, for <a href=\"#root/_help_9sRHySam5fXb\">workspaces</a>, you can use the <code>#workspaceSearchHome</code> label to specify a storage location for saved searches within that workspace.</p>",
++ "_help_iRwzGnHPzonm": "<p>Relation map is a type of&nbsp;note&nbsp;which visualizes notes and their <a href=\"#root/_help_zEY4DaJG4YT5\">relations</a>.</p><h2>Interaction</h2><ul><li>To create a new note and add it to the map, press the <span class=\"tn-icon bx bx-note\"></span> <em>Add note</em> button at the bottom of the map, then click anywhere on the map to place it there.<ul><li>While the map waits for the click, a translucent box follows the mouse to show where the note will go. To cancel, press the button again (now labeled <em>Cancel</em>) or press <kbd>Esc</kbd>.</li><li>The note is created as a child of the map, with the default title of a new note. It opens in the note panel (see below) with its title selected, so you can type its name straight away.</li></ul></li><li>An existing note can also be dragged from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>. It will be placed at the position it's dragged on.<ul><li>Multiple notes can also be dragged via&nbsp;<a class=\"reference-link\" href=\"#root/_help_yTjUdsOi4CIE\">Multiple selection</a>. The notes will be positioned near the dragged position without overlapping.</li><li>The dragged note can be a sub-child of the map, or it can be at any arbitrary position.</li></ul></li><li>Notes can also be pasted onto the map. Copy or cut them in the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, then click the map and press <kbd>Ctrl</kbd>+<kbd>V</kbd>, or right click an empty part of the map and select <em>Paste note(s)</em>.<ul><li>With <kbd>Ctrl</kbd>+<kbd>V</kbd>, the notes are placed under the mouse, or in the middle of the map if the mouse is not over it. From the right click menu, they are placed where the menu was opened.</li><li>Copied notes stay where they are in the tree. Cut notes are moved under the map, as if they had been pasted into it in the tree.</li><li>Links to notes, such as an <a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a> copied from a text note, can be pasted the same way. If the clipboard holds no link to a note, the notes last copied or cut in the tree are pasted.</li><li>The right click menu of an empty part of the map also has <em>Add note</em>, which creates a new note where the menu was opened.</li></ul></li><li>To create a relationship, hold the mouse on the dot on the right of a note and then:<ul><li>Drag it over another note to create a relationship pointing from the first note to the second one.</li><li>Drag over the same note to create a self-referencing relationship (represented as a loop).</li><li>Once dragged, a popover next to the relationship asks for its name. Type a new name and press <kbd>Enter</kbd>, or pick a relation name already in use from the suggestions. To cancel, press <kbd>Esc</kbd>, close the popover or click elsewhere on the map.</li></ul></li><li>Each note is shown as a card with its icon and title, colored in the note's color the same way as the cards of a <a class=\"reference-link\" href=\"#root/_help_CtBQqbwXDx1w\">Kanban Board</a>.</li><li>Hovering a note highlights its relationships, in the note's color if it has one, and fades the other relationships.</li><li>To view or edit a note, click it on the map. This opens the note panel (see below).<ul><li>To open the note in a new tab instead, <kbd>Ctrl</kbd>+click it or click it with the middle mouse button. <kbd>Shift</kbd>+click opens it in a new window. The right click menu offers the same options.</li></ul></li><li>To edit the title of a note, change its color or delete it (either from the map, or delete it completely), right click the note.</li><li>To rename or delete a relationship, right click it and select the corresponding option.</li><li>On a <a href=\"#root/_help_CoFPLs3dRlXc\">read-only</a> map, notes cannot be moved and relationships cannot be drawn, renamed or deleted. The right click menu of a note only offers to open it, and a relationship has no right click menu.</li><li>To move around the map, drag an empty part of it, and zoom with the mouse wheel or the <span class=\"tn-icon bx bx-minus-circle\"></span> and <span class=\"tn-icon bx bx-plus-circle\"></span> buttons at the bottom-right corner. Clicking the zoom percentage goes back to 100%, and <span class=\"tn-icon bx bx-scan\"></span> <em>Fit to view</em> zooms and pans so that all the notes are visible.<ul><li>Once the map has been clicked, the arrow keys or <kbd>W</kbd> <kbd>A</kbd> <kbd>S</kbd> <kbd>D</kbd> pan it, and <kbd>+</kbd> and <kbd>-</kbd> zoom it. The <kbd>?</kbd> button at the top-right corner of the map lists all its keyboard shortcuts.</li></ul></li></ul><h2>Note panel</h2><p>When a note on the map is clicked, a panel opens to the right of the map and the note is highlighted. If the panel would cover the note, or the note is partly off-screen, the map pans to bring it into view. The panel contains:</p><ul><li>The title and icon of the note, both editable.</li><li>A <span class=\"tn-icon bx bx-expand-alt\"></span> button to expand the panel over the whole map, and to restore it afterwards.</li><li>Buttons to interact with the note:<ul><li><span class=\"tn-icon bx bx-log-in\"></span> Open the note in the current tab, or, through the <span class=\"tn-icon bx bx-dots-horizontal-rounded\"></span> menu, in a new tab, split, window or the quick edit popup.</li><li>A <span class=\"tn-icon bx bx-palette\"></span> color picker to change the color of the note.</li><li>A <span class=\"tn-icon bx bx-trash\"></span> button to remove the note from the map, which can optionally delete the note as well.</li></ul></li><li>The <a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a> of the note, if any.</li><li>The note's content, which can be edited directly from the panel.</li></ul><p>The color picker and the remove button are not shown if the map is read-only.</p><p>Clicking another note on the map switches the panel to it. Similarly, clicking an <a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a> inside the panel switches the panel to that note, as long as it is on the map.</p><p>To close the panel, press the <span class=\"tn-icon bx bx-x\"></span> button at its top-right, click an empty part of the map, or press <kbd>Esc</kbd>.</p><p>On mobile, the note opens as a dialog over the whole screen instead of a panel.</p><h2>Development process demo</h2><p>This is a basic example how you can create simple diagram using relation maps:</p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Relation%20Map_relation-map-dev-process.png\" width=\"934\" height=\"667\"><p>And this is how you can create it:</p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Relation%20Map_relation-map-dev-process-demo.gif\" width=\"812\" height=\"585\"><p>We start completely from scratch by first creating new note called \"Development process\" and changing its type to \"Relation map\". After that we create new notes one by one and place them by clicking into the map. We also drag <a href=\"#root/_help_zEY4DaJG4YT5\">relations</a>between notes and name them. That's all!</p><p>Items on the map - \"Specification\", \"Development\", \"Testing\" and \"Demo\" are actually notes which have been created under \"Development process\" note - you can click on them and write some content. Connections between notes are called \"<a href=\"#root/_help_zEY4DaJG4YT5\">relations</a>\".</p><h2>Family demo</h2><p>This is more complicated demo using some advanced concepts. Resulting diagram is here:</p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Relation%20Map_relation-map-family.png\" width=\"941\" height=\"758\"><p>This is how you get to it:</p><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Relation%20Map_relation-map-family-demo.gif\" width=\"812\" height=\"585\"><p>There are several steps here:</p><ul><li>we start with empty relation map and two existing notes representing Prince Philip and Queen Elizabeth II. These two notes already have <code>isPartnerOf</code> <a href=\"#root/_help_zEY4DaJG4YT5\">relations</a>defined.<ul><li>There are actually two \"inverse\" relations (one from Philip to Elizabeth and one from Elizabeth to Philip)</li></ul></li><li>we drag both notes to relation map and place to suitable position. Notice how the existing <code>isPartnerOf</code> relations are displayed.</li><li>now we create new note - we name it \"Prince Charles\" and place it on the relation map by clicking on the desired position. The note is by default created under the relation map note (visible in the note tree on the left).</li><li>we create two new relations <code>isChildOf</code> targeting both Philip and Elizabeth<ul><li>now there's something unexpected - we can also see the relation to display another <code>hasChild</code> relation. This is because there's a <a href=\"#root/_help_OFXdgB2nNk1F\">relation definition</a> which puts <code>isChildOf</code> as an \"<a href=\"#root/_help_OFXdgB2nNk1F\">inverse</a>\" relation of <code>hasChildOf</code> (and vice versa) and thus it is created automatically.</li></ul></li><li>we create another note for Princess Diana and create <code>isPartnerOf</code> relation from Charles. Again notice how the relation has arrows both ways - this is because <code>isPartnerOf</code> definition specifies its inverse relation as again \"isPartnerOf\" so the opposite relation is created automatically.</li><li>as the last step we pan &amp; zoom the map to fit better to window dimensions.</li></ul><p>Relation definitions mentioned above come from \"Person template\" note which is assigned to any child of \"My Family Tree\" relation note. You can play with the whole thing in the <a href=\"#root/_help_wX4HbRucYSDD\">demo notes</a>.</p><h2>Details</h2><p>You can specify which relations should be displayed with comma delimited names of relations in <code>displayRelations</code> label.</p><p>Alternatively, you can specify comma delimited list of relation names in <code>hideRelations</code> which will display all relations, except for the ones defined in the label.</p><h2>See also</h2><ul><li><a class=\"reference-link\" href=\"#root/_help_bdUJEHsAPYQR\">Note Map</a>&nbsp;is a similar concept.</li></ul>",
++ "_help_bdUJEHsAPYQR": "<figure class=\"image image_resized\" style=\"width:72.68%;\"><img style=\"aspect-ratio:1311/1271;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Note%20Map_image.png\" width=\"1311\" height=\"1271\"></figure><p>A Note map is a note type which displays a standalone version of the feature of the same name:&nbsp;<a class=\"reference-link\" href=\"#root/_help_BCkXAVs63Ttv\">Note Map (Link map, Tree map)</a>. Consult that page for more information on how the note map works and what it displays.</p><p>Once created, the note map will display the relations between notes. Only the notes that are part of the parent of the note map will be displayed (including their children).</p><h2>Root note</h2><p>The root note defines the starting point of the graph, from which the relations and the hierarchy are derived from.</p><p>There are three possible root notes:</p><ul><li>The default root note is the parent note of the note map.</li><li>To use the currently <a href=\"#root/_help_OR8WJ7Iz9K4U\">hoisted note</a> instead, set the <code>mapRootNoteId</code> label to <code>hoisted</code>.</li><li>To use a specific note instead, set <code>mapRootNoteId</code> to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_m1lbrzyKDaRB\">Note ID</a>&nbsp;of the desired note.</li></ul><h2>Customization</h2><p>The note map can be customized using the following&nbsp;<a class=\"reference-link\" href=\"#root/_help_HI6GBBIduIgv\">Labels</a>:</p><figure class=\"table\"><table><thead><tr><th>Label</th><th>Description</th></tr></thead><tbody><tr><td><code>#mapIncludeRelation</code></td><td>Comma-delimited relation names to include from the note map.</td></tr><tr><td><code>#mapExcludeRelation</code></td><td>Comma-delimited relation names to exclude from the note map.</td></tr><tr><td><code>#mapRootNoteId</code></td><td>The ID of the note the map roots from, or <code>hoisted</code>. See the root note section above for more information.</td></tr></tbody></table></figure>",
++ "_help_HcABDtFCkbFN": "<figure class=\"image\"><img style=\"aspect-ratio:601/216;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Render%20Note_image.png\" width=\"601\" height=\"216\"></figure><p>Render Note is a special case of <a href=\"#root/_help_yIhgI5H7A2Sm\">front-end scripting</a> which allows rendering custom content inside a note. This makes it possible to create custom dashboards, or to use a custom note editor.</p><p>The content can either be a vanilla HTML, or Preact JSX.</p><h2>Creating a render note</h2><ol><li>Create a&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note with the:<ol><li>HTML language for the legacy/vanilla method, with what needs to be displayed (for example <code>&lt;p&gt;Hello world.&lt;/p&gt;</code>).</li><li>JSX for the Preact-based approach (see below).</li></ol></li><li>Create a&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>.</li><li>Assign the <code>renderNote</code> <a href=\"#root/_help_zEY4DaJG4YT5\">relation</a> to point at the previously created code note.</li></ol><h2>Legacy scripting using jQuery</h2><p>A static HTML is generally not enough for&nbsp;<a class=\"reference-link\" href=\"#root/_help_CdNpE2pqjmI6\">Scripting</a>. The next step is to automatically change parts of the note using JavaScript.</p><p>For a simple example, we are going to create a render note that displays the current date in a field.</p><p>To do so, first create an HTML code note with the following content:</p><pre><code class=\"language-text-html\">&lt;h1&gt;Current date &amp; time&lt;/h1&gt;\nThe current date &amp; time is &lt;span class=\"date\"&gt;&lt;/span&gt;</code></pre><p>Now we need to add the script. Create another&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>, but this time of JavaScript (frontend) language. Make sure the newly created note is a direct child of the HTML note created previously; with the following content:</p><pre><code class=\"language-text-javascript\">const $dateEl = api.$container.find(\".date\");\n$dateEl.text(new Date());</code></pre><p>Now create a render note at any place and set its <code>~renderNote</code> relation to point to the HTML note. When the render note is accessed it will display:</p><blockquote><p><strong>Current date &amp; time</strong><br>The current date &amp; time is Sun Apr 06 2025 15:26:29 GMT+0300 (Eastern European Summer Time)</p></blockquote><h2>Dynamic content using Preact &amp; JSX</h2><p>As a more modern alternative to jQuery, it's possible to use Preact &amp; JSX to render pages. Since JSX is a superset of JavaScript, there's no need to provide a HTML anymore.</p><p>Here are the steps to creating a simple render note:</p><ol><li><p>Create a note of type&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>.</p></li><li><p>Create a child&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note with JSX as the language.<br>As an example, use the following content:</p><pre><code class=\"language-text-x-trilium-auto\">export default function() {\n return (\n &lt;&gt;\n &lt;p&gt;Hello world.&lt;/p&gt;\n &lt;/&gt;\n );\n}</code></pre></li><li><p>In the parent render note, define a <code>~renderNote</code> relation pointing to the newly created child.</p></li><li><p>Refresh the render note and it should display a “Hello world” message.</p></li></ol><h2>Refreshing the note</h2><p>It's possible to refresh the note via:</p><ul><li>The&nbsp;<span class=\"tn-icon bx bx-refresh\"></span> button in&nbsp;the&nbsp;<a class=\"reference-link\" href=\"#root/_help_1P8QXI5edXNd\">Note buttons</a>&nbsp;area.</li><li>The “Render active note” <a href=\"#root/_help_A9Oc6YKKc65v\">keyboard shortcut</a> (not assigned by default).</li></ul><h2>Printing</h2><p>A render note can be printed or exported as PDF from the <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> once its <code>~renderNote</code> relation is set (see <a class=\"reference-link\" href=\"#root/_help_NRnIZmSMc5sj\">Printing &amp; Exporting as PDF</a>). Unlike other notes, it is printed exactly as it is displayed: the script does not run again, so what was typed, selected or loaded in the note is kept.</p><ul><li>The content is laid out again at the width of the page, so elements sized by the script for the screen (such as charts) might not fit.</li><li>Scrolling areas, such as a table in a scrolling container, are printed at their full height, without a scrollbar.</li><li>To adjust the layout for printing, use a <code>~printCss</code> relation.</li><li>The light colors are used for printing, whatever the current theme.</li></ul><p>When a render note is printed as part of a <a class=\"reference-link\" href=\"#root/_help_mULW0Q3VojwY\">List View</a> collection, or from another view such as its attachments, it is not on screen, so its script runs again for the print. In a collection, the output is printed without the note's own styles.</p><h2>Examples</h2><ul><li><a class=\"reference-link\" href=\"#root/_help_R7abl2fc6Mxi\">Weight Tracker</a>&nbsp;which is present in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_6tZeKvSHEUiB\">Demo Notes</a>.</li></ul>",
++ "_help_s1aBHPd79XYj": "<aside class=\"admonition tip\"><p>For a quick understanding of the Mermaid syntax, see&nbsp;<a class=\"reference-link\" href=\"{{helpAssets}}/User%20Guide/Note%20Types/Mermaid%20Diagrams/Syntax%20reference.dat\">Syntax reference</a>&nbsp;(official documentation).</p></aside><figure class=\"image\"><img style=\"aspect-ratio:1464/915;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Mermaid%20Diagrams_image.png\" width=\"1464\" height=\"915\"></figure><p>Trilium supports Mermaid, which adds support for various diagrams such as flowchart, sequence diagram, class diagram, state diagram, pie charts, etc., all using a text description of the chart instead of manually drawing the diagram.</p><p>This note type is a split view, meaning that both the source code and a preview of the document are displayed side-by-side. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_SL5f1Auq7sVN\">Note types with split view</a>&nbsp;for more information.</p><h2>Sample diagrams</h2><p>Starting with v0.103.0, Mermaid diagrams no longer start with a sample flowchart, but instead a pane at the bottom will show all the supported diagrams with sample code for each:</p><ul><li>Simply click on any of the samples to apply it.</li><li>The pane will disappear as soon as something is typed in the code editor or a sample is selected. To make it appear again, simply remove the content of the note.</li></ul><h2>Layouts</h2><p>Depending on the chart being edited and user preference, there are two layouts supported by the Mermaid note type:</p><ul><li>Horizontal, where the source code (editable part) is on the left side of the screen and the preview is to the right.</li><li>Vertical, where the source code is at the bottom of the screen and the preview is at the top.</li></ul><p>It's possible to switch between the two layouts at any time by pressing the&nbsp;<span class=\"tn-icon bx bxs-dock-left\"></span> icon in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_1P8QXI5edXNd\">Note buttons</a>.</p><h2>Interaction</h2><ul><li>The source code of the diagram (in Mermaid format) is displayed on the left or bottom side of the note (depending on the layout).<ul><li>Changing the diagram code will refresh automatically the diagram.</li></ul></li><li>The preview of the diagram is displayed at the right or top side of the note (depending on the layout):<ul><li>There are dedicated buttons at the bottom-right of the preview to control the zoom in, zoom out or fit the diagram.</li><li>The preview can be moved around by holding the left mouse button and dragging.</li><li>Zooming can also be done by using the scroll wheel.</li><li>The zoom and position on the preview will remain fixed as the diagram changes, to be able to work more easily with large diagrams.</li><li>Double-clicking the preview resets the zoom/position.</li><li>The preview can also be focused by clicking on it, case in which keyboard shortcuts can be used:<ul><li><kbd>+</kbd> or <kbd>E</kbd> to zoom in, <kbd>-</kbd> or <kbd>Q</kbd> to zoom out.</li><li><kbd>/</kbd> to reset the zoom/position.</li><li>Arrow keys or <kbd>W</kbd> <kbd>A</kbd> <kbd>S</kbd> <kbd>D</kbd> to pan. Holding <kbd>Shift</kbd> pans faster.</li></ul></li></ul></li><li>The size of the source/preview panes can be adjusted by hovering over the border between them and dragging it with the mouse.</li><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_1P8QXI5edXNd\">Note buttons</a>:<ul><li>The source/preview can be laid out left-right (via <span class=\"tn-icon bx bxs-dock-left\"></span>) or bottom-top (via <span class=\"tn-icon bx bxs-dock-bottom\"></span>).</li><li>Press the&nbsp;<span class=\"tn-icon bx bx-copy\"></span> (<em>Copy image reference to the clipboard</em>) to be able to insert the image representation of the diagram into a text note. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_0Ofbk1aSuVRu\">Image references</a>&nbsp;for more information.</li></ul></li><li>To export the diagram as either SVG or PNG, go to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_1P8QXI5edXNd\">Note buttons</a>&nbsp;and select <em>Export as image</em>:<ul><li>Select <em>SVG (vector)</em> to download a scalable/vector rendering of the diagram. Can be used to present the diagram without degrading when zooming.</li><li>Select <em>PNG (raster)</em> to download a normal image (at 1x scale, raster) of the diagram. Can be used to send the diagram in more traditional channels such as e-mail.</li></ul></li><li>The note can be marked as <a href=\"#root/_help_CoFPLs3dRlXc\">read-only</a>, case in which it switches by default to the preview (although it can be switched back using the source/preview buttons) and the source is no longer editable.</li></ul><h2>Errors in the diagram</h2><p>If there is an error in the source code, the error will be displayed in an information pane.</p><p>During the state of an error, the diagram will no longer be rendered and the previously working diagram will remain in the preview section.</p>",
++ "_help_RH6yLjjWJHof": "<p>Mermaid supports a different layout engine which supports slightly more complex diagrams, called the <a href=\"https://eclipse.dev/elk/\">Eclipse Layout Kernel (ELK)</a>. Trilium has support for these as well, but it's not enabled by default.</p><p>In order to activate ELK for any diagram, insert the following YAML frontmatter right at the beginning of the diagram:</p><pre><code class=\"language-text-x-yaml\">---\nconfig:\n layout: elk\n---</code></pre><figure class=\"table\"><table><thead><tr><th>With ELK off</th><th>With ELK on</th></tr></thead><tbody><tr><td><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Mermaid%20Diagrams/ELK%20layout_ELK%20off.svg\"></td><td><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Mermaid%20Diagrams/ELK%20layout_ELK%20on.svg\"></td></tr></tbody></table></figure>",
++ "_help_grjYqerjn243": "<figure class=\"image\"><img src=\"{{helpAssets}}/User%20Guide/Note%20Types/Canvas_image.png\" alt=\"grafik\"></figure><p>Canvas notes use the Excalidraw library to allow handwritten notes with mouse, pen or touch on an infinite canvas. It also supports basic diagramming, text and graphics input.</p><h2>Interaction</h2><ul><li>The note can be togged <a href=\"#root/_help_CoFPLs3dRlXc\">read-only</a> from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>.</li></ul><h2>Embedding notes</h2><p>Since v0.104.0, Canvas supports embedding notes in a similar fashion to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>&nbsp;functionality for&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes.</p><p>To embed a note:</p><ul><li>From the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, drag the item onto the canvas.</li><li>Manually, by choosing <em>More tools</em> → <em>Web Embed</em> and pasting the link to the note (e.g. <code>root/MujWAc9fQ1nj</code>).</li></ul><p>Embedding notes in the canvas follows the same rules as&nbsp;<a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>: some notes are rendered as images (e.g.&nbsp;<a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a>), whereas some render fully interactive such as&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>.</p><h2>Linking to a note</h2><ol><li>From the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;right click the note to be linked and selected <em>Advanced → Copy note path to the clipboard</em>.</li><li>In the canvas note, right click an element and select <em>Add link</em> (or press <kbd>Ctrl</kbd>+<kbd>K</kbd>). Paste the link and press <kbd>Enter</kbd>.</li><li>A&nbsp;<span class=\"tn-icon bx bx-link-external\"></span> icon will appear at the top-right of the element which will navigate to the linked note when clicked.</li></ol><h2>Drawing in a text note</h2><p>To draw inside a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;note instead of in a note of its own, insert a drawing canvas with <span class=\"tn-icon bx bx-pen\"></span><em>Drawing canvas</em> in the <span class=\"tn-icon cke cke-plus\"></span><em>Insert</em> menu. See <em>Drawing canvases</em> in&nbsp;<a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>.</p>",
++ "_help_1vHRoWCEjj0L": "<h2>Configuration</h2><p>A webview needs to know which URL to render, and it can be provided by setting the <code>webViewSrc</code> <a href=\"#root/_help_zEY4DaJG4YT5\">label</a>, such as:</p><pre><code class=\"language-text-x-trilium-auto\">#webViewSrc=\"https://www.wikipedia.org\"</code></pre><p>The URL needs to contain the full scheme.</p><h2>Web view on the server vs. Electron</h2><p>When accessing Trilium via a browser instead of the desktop application, the web view will still try to render the content of the desired webpage. However, since it's running in a browser there are quite a few limitations as opposed to the desktop one.</p><p>More specifically, quite a few websites oppose being embedded in another website (technically they have a non-permisive <code>X-Frame-Options</code> header). This is not bypassable by Trilium so the page will simply fail to render.</p><p>You can diagnose this by right clicking the Trilium web page → Inspect (element) and looking in the “Console” tab for errors such as:</p><ul><li><code>Refused to display 'https://www.google.com/' in a frame because it set 'X-Frame-Options' to 'sameorigin'.</code></li><li><code>Refused to frame 'https://duckduckgo.com/' because an ancestor violates the following Content Security Policy directive: \"frame-ancestors 'self' https://html.duckduckgo.com\".</code></li></ul><p>There are a few websites that do render such as <code>wikipedia.org</code>.</p><p>Do note that we are also applying some sandboxing constraints on the server side, so if you have any issues other than the unresolvable <code>X-Frame-Options</code> described above, feel free to report them.</p><p>On the desktop side, a different technology is used which bypasses the constraints of an <code>iframe</code> (<code>webview</code>).</p><h2>Embedding in other note types</h2><p>Starting with v0.104.0, web views can be embedded into other note types:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_IF7Q6I9x7zuw\">Dashboard</a></li><li><a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a></li><li><a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes via&nbsp;<a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>.</li></ul>",
++ "_help_gBbsAeiuUxI5": "<figure class=\"image image-style-align-center\"><img style=\"aspect-ratio:892/675;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Mind%20Map_image.png\" width=\"892\" height=\"675\"></figure><p>The mindmap allows for easy jotting down of ideas and storing them in a hierarchical fashion.</p><h2>Terminology</h2><ul><li>A <strong>node</strong> is a single idea, represented differently based on depth (filled rounded rectangle for the root note, unfilled rectangles for sub-ideas, lines only for sub-sub-ideas).</li><li>The <strong>root node</strong> is the top-most node from which all other nodes derive, displayed as a filled rectangle. There can only be a single root node.</li></ul><h2>Interaction</h2><ul><li>To create a new node at the same level as the current one, press <kbd>Enter</kbd>, enter the desired text and then press <kbd>Enter</kbd> once again to confirm.</li><li>Similarly, to create a sub-node, press <kbd>Tab</kbd>, enter the desired text and then press <kbd>Enter</kbd>.</li><li>To create a parent, use <kbd>Ctrl</kbd>+<kbd>Enter</kbd> instead.</li><li>To remove a node, press <kbd>Delete</kbd>.</li><li>To move a node up or down, press <kbd>Page Up</kbd> or <kbd>Page Down</kbd>.</li><li>To adjust the font size, color of the text or background or to add a link, click on a node and use the floating panel that appears to the right.</li><li>To select one or more notes, drag and drop across the map.</li><li>Right click the node to bring a contextual menu with options such as creating new nodes, focusing on a particular notes or creating links between them.</li><li>Use the buttons at the top-left to change the positioning of the nodes relative to the root node (to the left, to the right, or to both sides).</li><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_1P8QXI5edXNd\">Note buttons</a>&nbsp;area, an <a href=\"#root/_help_0Ofbk1aSuVRu\">image reference</a> can be copied by pressing the&nbsp;<span class=\"tn-icon bx bx-copy\"></span> button, to paste the mind map in a text note.</li><li>From the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>, the diagram can be exported either as SVG (vectorial) or PNG (raster) by selecting <em>Export as image</em>.</li><li>The note can be set as <a href=\"#root/_help_CoFPLs3dRlXc\">read-only</a> which will disable all editing features.</li></ul>",
++ "_help_W8vYD3Q1zjCR": "<p>The <em>File</em> note type can be used to attach various external files such as images, videos or PDF documents.</p><h2>Uploading a file</h2><p>Since these files come from an external source, it is not possible to create a <em>File</em> note type directly:</p><ul><li>Drag a file into the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</li><li>Right click a note and select <em>Import into note</em> and point it to one of the supported files.</li></ul><h2>Supported file types</h2><h3>PDFs</h3><p>PDFs can be uploaded to Trilium and they will display a live preview with full support for various features such as table of contents, annotations, as well as remembering the last page read. For more information, see the dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_XJGJrpu7F9sh\">PDFs</a>&nbsp;page.</p><h2>Office documents</h2><p>Trilium offers previews for Office documents such as Word (<code>.docx</code>), Excel (<code>.xlsx</code>) and PowerPoint (<code>.pptx</code>). For more information, see the dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_KG48zgNY31NW\">Office documents</a>.</p><h3>Images</h3><figure class=\"image image-style-align-center image_resized\" style=\"width:50%;\"><img style=\"aspect-ratio:879/766;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/2_File_image.png\" width=\"879\" height=\"766\"></figure><p>Interaction:</p><ul><li>An <a href=\"#root/_help_0Ofbk1aSuVRu\">image reference</a> can be copied by pressing the&nbsp;<span class=\"tn-icon bx bx-copy\"></span> icon from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_1P8QXI5edXNd\">Note buttons</a>&nbsp;area, which allows pasting it in a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;note.</li></ul><h3>Videos</h3><p>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_AjqEeiDUOzj4\">Audio &amp; Video</a>.</p><h3>Audio</h3><figure class=\"image image-style-align-center image_resized\" style=\"width:50%;\"><img style=\"aspect-ratio:850/243;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/1_File_image.png\" width=\"850\" height=\"243\"></figure><p>Adding a supported audio file will reveal a basic audio player that can be used to play it.</p><p>Interactions:</p><ul><li>The audio can be played/paused using the dedicated button.</li><li>Dragging the mouse across, or clicking the progress bar will seek through the song.</li><li>The volume can be set.</li><li>The playback speed can be adjusted via the contextual menu next to the volume.</li></ul><h3>Text files</h3><figure class=\"image image-style-align-center image_resized\" style=\"width:50%;\"><img style=\"aspect-ratio:926/347;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/File_image.png\" width=\"926\" height=\"347\"></figure><p>Files that are identified as containing text will show a preview of their content. One common use case for this type of file is to embed text files whose content is not necessarily of interest to the user, such as third-party libraries or generated content, that can then be downloaded if needed.</p><p>Note that generally text files will be <a href=\"#root/_help_mHbBMPDPkVV5\">imported</a> as either&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;or&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;notes. To bypass this behavior and create a <em>File</em> note type, use the <em>Import into note</em> feature and uncheck <em>Import HTML, Markdown and TXT as text notes</em>, as well as <em>Import recognized code files as code notes</em>.&nbsp;</p><p>Since one of the use cases for having files instead of notes is to display large files, the content preview is limited to a relatively small amount of characters. To view the full file, consider opening it in an external application.</p><h3>GPS tracks</h3><p>Trilium displays information about GPS tracks in <code>.gpx</code> format, such as the distance, duration, elevation profile, tracks, markers.</p><p>When a <code>.gpx</code> note is dropped in a&nbsp;<a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map</a>, the track itself will also be displayed on the map.</p><figure class=\"image\"><img style=\"aspect-ratio:1500/807;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/4_File_image.png\" width=\"1500\" height=\"807\"></figure><h3>Fonts</h3><p>Supported font formats will show an interactive preview of the font:</p><ul><li>A field to type in a custom text.</li><li>A slider to change the font size of the preview.</li><li>A preview of the text at the given size.</li><li>A sampling of various font sizes for this font.</li><li>The Latin alphabet.</li></ul><p>Additionally, enabling <em>In font picker</em> will make the font available in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Appearance</em> font selection. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_w4rMEhJsALlA\">Personalizing the font</a>&nbsp;for more information.</p><h3>Unknown file types</h3><figure class=\"image image-style-align-center image_resized\" style=\"width:50%;\"><img style=\"aspect-ratio:532/240;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/3_File_image.png\" width=\"532\" height=\"240\"></figure><p>If the file could not be identified as any of the supported file types from above, it will be treated as an unknown file. In this case, all the default interactions will be available such as downloading or opening the file externally, but there will be no preview of the content.</p><h2>Interaction</h2><ul><li>Regardless of the file type, a series of buttons will be displayed in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>&nbsp;area.<ul><li><span class=\"tn-icon bx bx-download\"></span>&nbsp;(Download), which will download the file for local use.</li><li><span class=\"tn-icon bx bx-link-external\"></span>&nbsp;(Open), will will open the file with the system-default application.</li><li><span class=\"tn-icon bx bx-folder-open\"></span>&nbsp;(Upload new revision) to replace the file with a new one.</li></ul></li><li>It is <strong>not</strong> possible to change the note type of a <em>File</em> note.</li><li>Convert into an <a href=\"#root/_help_0vhv7lsOLy82\">attachment</a> from the <a href=\"#root/_help_8YBEPzcpUgxw\">note menu</a>.</li></ul><h2>Relation with other notes</h2><ul><li><p>Files are also displayed in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a>&nbsp;based on their type:</p><img class=\"image_resized\" style=\"aspect-ratio:853/315;width:50%;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/5_File_image.png\" width=\"853\" height=\"315\"></li><li><p>Non-image files can be embedded into text notes as read-only widgets via the&nbsp;<a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>&nbsp;functionality.</p></li><li><p>Image files can be embedded into text notes like normal images via&nbsp;<a class=\"reference-link\" href=\"#root/_help_0Ofbk1aSuVRu\">Image references</a>.</p></li></ul><h2>File size limit</h2><p>An individual file cannot be bigger than 374 MiB. For more information see <em>Maximum import size</em> in&nbsp;<a class=\"reference-link\" href=\"#root/_help_mHbBMPDPkVV5\">Import &amp; Export</a>.</p>",
++ "_help_XJGJrpu7F9sh": "<figure class=\"image image_resized\" style=\"width:74.34%;\"><img style=\"aspect-ratio:1360/698;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/File/PDFs_image.png\" width=\"1360\" height=\"698\"></figure><p>PDFs file can be uploaded in Trilium, where they will be displayed without the need to download them first.</p><p>Since v0.102.0, PDFs will be rendered using Trilium's built-in PDF viewer, which is a customization of <a href=\"https://mozilla.github.io/pdf.js/\">Mozilla's PDF.js viewer</a> (also built-in in the Mozilla Firefox browser). Versions prior to that render PDFs using the browser's default PDF viewer.</p><h2>Features</h2><ul><li>The last page viewed and scroll position is maintained in between restarts or note navigations.</li><li>Annotations (text, highlights) as well as comments. These are saved automatically.</li><li>Forms can be filled.</li><li>Can be printed or downloaded.</li><li>Can be saved as a <a href=\"#root/_help_KC1HB96bqqHX\">template</a> and the content of the PDF will be copied over to the new note. This is especially useful in combination with annotations or filled forms.</li><li>Integrates with the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>&nbsp;by displaying the list of pages with thumbnails, table of contents and a listing of the annotations.</li><li>Basic support for signatures (the hand-drawn ones, not proper digital signatures), similar to annotations. Signatures are stored and can be reused across multiple documents (up to 5).</li></ul><h2>Storing last position and settings</h2><p>For every PDF, Trilium will remember the following information:</p><ul><li>The current page.</li><li>The scroll position, within the current page.</li><li>The rotation of the page.</li></ul><p>This makes it useful when reading large documents since the position is remembered automatically. This happens in the background, however it's recorded only a few seconds after stopping any scroll actions.</p><aside class=\"admonition tip\"><p>Technically, the information about the scroll position and rotation is stored in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>&nbsp;section, in a dedicated attachment called <code>pdfHistory.json</code>.</p></aside><h2>Annotations</h2><p>Since v0.102.0 it's possible to annotate PDFs. To do so, look for the annotation buttons on the right side of the PDF toolbar (<img src=\"{{helpAssets}}/User%20Guide/Note%20Types/File/1_PDFs_image.png\" width=\"120\" height=\"32\">).</p><p>Since v0.103.0:</p><ul><li>Annotations are disabled if the note is marked as&nbsp;<a class=\"reference-link\" href=\"#root/_help_CoFPLs3dRlXc\">Read-Only Notes</a>.</li><li>Comments can also be added, which is similar to highlights but also attach a text.</li><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>&nbsp;also displays a list of annotations (highlights, comments).</li></ul><h3>Supported annotations</h3><p>The following annotation methods are supported:</p><ul><li><strong>Highlight</strong><br>Allows highlighting text with one of the predefined colors.<ul><li>The thickness is also adjustable.</li><li>It's also possible to highlight the blank space, turning the feature more into a thicker pen.</li></ul></li><li><strong>Text</strong><br>Allows adding arbitrary text, with a custom color and size.</li><li><strong>Pen</strong><br>Allows free drawing on the document, with variable color, thickness and opacity.</li><li><strong>Image</strong><br>Allows inserting images from outside Trilium directly into the document.</li></ul><h3>Editing existing annotations</h3><p>Although annotations are stored in the PDF itself, they can be edited. To edit an annotation, press one of the annotation buttons from the previous section to enter edit mode and click on an existing annotation. This will reveal a toolbar with options to customize the annotation (e.g. to change a color), as well as the possibility to remove it.</p><h3>How are annotations stored</h3><p>Annotations are stored directly in the PDF. When modifications are made, Trilium will replace the PDF with the new one.</p><p>Since modifications are automatically saved, there's no need to manually save the document after making modifications to the annotations.</p><p>The benefit of “baked-in annotations” is that they are also accessible if downloading (for external use outside Trilium) or sharing the note.</p><p>The downside is that the entire PDF needs to be sent back to the server, which can slow down performance for larger documents. If you encounter any issues from this system, feel free to <a href=\"#root/_help_wy8So3yZZlH9\">report it</a>.</p><h2>Linking to a page or an annotation</h2><p>A link can open a PDF at a given page, or at one of its annotations. To create one:</p><ul><li>To link to a page, right-click the page in the <em>Pages</em> section of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>&nbsp;and select <em>Copy reference</em>.</li><li>To link to an annotation, right-click it in the <em>Annotations</em> section of the sidebar and select <em>Copy reference</em>.</li></ul><p>Pasted into a text note, the reference becomes one of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>, showing the title of the PDF followed by the page (<em>Page 5</em>), or by <em>Annotation on page 5</em> for a reference to an annotation. Clicking it opens the PDF and scrolls to the page or to the annotation.</p><p>A reference to an annotation also carries its page, so a link to an annotation that was deleted still opens the right page.</p><aside class=\"admonition note\"><p>An annotation drawn since the PDF was opened does not have a permanent identifier until the PDF is opened again, so a reference copied for it points at its page only.</p></aside><h2>Filling out forms</h2><p>Similar to annotations, forms are also supported by Trilium since v0.102.0. If the document has fields that can be filled-in, they will be indicated with a colored background.</p><p>Simply type text in the forms and they will be automatically saved.</p><h2>Sidebar navigation</h2><p>See the dedicated section on PDFs in&nbsp;<a class=\"reference-link\" href=\"#root/_help_2dcGDhp9WFKb\">Outline tab</a>.</p><h2>Share functionality</h2><p>PDFs can also be shared using the&nbsp;<a class=\"reference-link\" href=\"#root/_help_R9pX4DGra2Vt\">Sharing</a>&nbsp;feature. This will also use Trilium's customized PDF viewer.</p><p>If you are using a reverse proxy on your server with strict access limitations for the share functionality, make sure that <code>[host].com/pdfjs</code> directory is accessible. Note that this directory is outside the <code>/share</code> route as it's common with the rest of the application.</p><h2>OCR</h2><p>PDFs are eligible for&nbsp;<a class=\"reference-link\" href=\"#root/_help_TiQbQDgP8L5t\">Text Extraction (OCR)</a>, which means that their text can be used in&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>.</p>",
++ "_help_AjqEeiDUOzj4": "<figure class=\"image image-style-align-right image_resized\" style=\"width:61.8%;\"><img style=\"aspect-ratio:953/587;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/File/Audio%20%26%20Video_image.png\" width=\"953\" height=\"587\"></figure><p>Starting with v0.103.0, Trilium has a custom media player for both video and audio files, which offers more features than the built-in player.</p><p>Versions prior to v0.103.0 also support media, but using the built-in player.</p><p>The file is streamed directly, so when accessing the note from a server it doesn't have to download the entire file to start playing it.</p><h2>Note on large media files</h2><p>Although Trilium offers support for media files, it is generally not meant to be used with very large files. Uploading large media will cause the&nbsp;<a class=\"reference-link\" href=\"#root/_help_wX4HbRucYSDD\">Database</a>&nbsp;to balloon, as well as any&nbsp;<a class=\"reference-link\" href=\"#root/_help_ODY7qQn5m2FT\">Backup</a>&nbsp;of it. In addition, there might be slowdowns when first uploading the files. Otherwise, a large database should not impact the general performance of Trilium significantly.</p><h2>Supported formats</h2><p>Trilium uses the built-in media decoding mechanism of the browser (or Electron/Chromium when running on the desktop). Starting with v0.103.0, a message will be displayed instead when a media format is not supported.</p><h2>Interactions</h2><p>To play/pause, simply click anywhere on the media. For video files, the controls at the bottom will hide automatically after playing, simply move the mouse to show them again.</p><p>The bottom bar has the following features:</p><ul><li>A track bar to seek across the media. Audio files up to 60 MB will display a waveform seekbar, to give a visual overview of the track's structure: silences, pauses, and louder segments.</li><li>On the left of the track bar, the current time is indicated.</li><li>On the right of the track bar, the remaining time is indicated.</li><li>On the left side there are buttons to:<ul><li>Adjust the playback speed (e.g. 0.5x, 1x).</li><li>Play mode (applies to all media from the parent note):<ul><li>Play once — play the media until it ends, then stop.</li><li>Loop — replay the media automatically once it ends.</li><li>Play next — when the current item ends, continue with the next one in the same parent note until the last item finishes.</li></ul></li><li>Rotate the video by 90 degrees (video only).</li></ul></li><li>In the center:<ul><li>Previous media — jumps to the previous media: the nearest media note above the current one in the tree (within the same parent note) in the case of media notes, or the previous media attachment.</li><li>Go back by 10s</li><li>Play/pause</li><li>Go forward by 10s</li><li>Next media — jumps to the next media: the nearest media note below the current one in the tree (within the same parent note) in the case of media notes, or the next media attachment.</li></ul></li><li>On the right side:<ul><li>Mute button</li><li>Volume adjustment</li><li>Full screen (video only)</li><li>Zoom to fill, which will crop the video so that it fills the entire window (video only).</li><li>Picture-in-picture, if the browser supports it (video only).</li></ul></li></ul><h2>Including media in notes</h2><figure class=\"image\"><img style=\"aspect-ratio:1395/145;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/File/1_Audio%20%26%20Video_image.png\" width=\"1395\" height=\"145\"><figcaption>An audio note include (configured to the \"Small\" size).</figcaption></figure><p><a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_6RM1Q7ppFVoj\">Markdown</a>&nbsp;notes can embed an interactive media player directly in the note content. To do so, include the audio or video file:</p><ul><li><strong>Text notes:</strong> in the formatting toolbar, click <em>Insert</em> → <em>Include</em>.</li><li><strong>Markdown notes:</strong> type <code>/include</code> press <kbd>Enter</kbd>.</li></ul><p>Then select the audio/video file note to be included.</p><h2>Keyboard shortcuts</h2><p>The following keyboard shortcuts are supported by the media player:</p><figure class=\"table\"><table><tbody><tr><td><kbd>Space</kbd></td><td>Play/pause</td></tr><tr><td><kbd>Left arrow key</kbd></td><td>Go back by 10s</td></tr><tr><td><kbd>Right arrow key</kbd></td><td>Go forward by 10s</td></tr><tr><td><kbd>Ctrl</kbd> + <kbd>Left arrow key</kbd></td><td>Go back by 1 min</td></tr><tr><td><kbd>Ctrl</kbd> + <kbd>Right arrow key</kbd></td><td>Go right by 1 min</td></tr><tr><td><kbd>Page Up</kbd></td><td>Navigate to the previous media</td></tr><tr><td><kbd>Page Down</kbd></td><td>Navigate to the next media</td></tr><tr><td><kbd>F</kbd></td><td>Toggle full-screen</td></tr><tr><td><kbd>M</kbd></td><td>Mute/unmute</td></tr><tr><td><kbd>Home</kbd></td><td>Go to the beginning of the media</td></tr><tr><td><kbd>End</kbd></td><td>Go to the end of the media</td></tr><tr><td><kbd>Up</kbd></td><td>Increase volume by 5%</td></tr><tr><td><kbd>Down</kbd></td><td>Decrease volume by 5%</td></tr><tr><td><kbd>Alt+F1</kbd> (customizable)</td><td>Show this list of keyboard shortcuts on screen.</td></tr></tbody></table></figure>",
++ "_help_KG48zgNY31NW": "<p>Since v0.105.0, office documents stored in Trilium display an inline preview of their content, without the need to download them or open them in an external application.</p><h2>Supported formats</h2><ul><li>Microsoft Office formats: Word (<code>.docx</code>), Excel (<code>.xlsx</code>) and PowerPoint (<code>.pptx</code>).</li><li>The OpenDocument alternatives to the previous formats (Text, Spreadsheet, Presentation), created by editors such as LibreOffice and OpenOffice.</li><li><a href=\"https://en.wikipedia.org/wiki/Rich_Text_Format\">Rich Text Format (RTF)</a>.</li><li><a href=\"https://en.wikipedia.org/wiki/EPUB\">EPUB</a> e-books.</li></ul><aside class=\"admonition note\"><p>Older Microsoft Office formats (<code>.doc</code>, <code>.xls</code>, <code>.ppt</code>) are not supported.</p></aside><h2>How it works</h2><p>The document is converted to a simplified representation on the server and rendered as read-only content, similar to a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;note.</p><p>The preview generally preserves:</p><ul><li>Headings, paragraphs and text alignment.</li><li>Text formatting: bold, italic, underline, strikethrough, subscript/superscript, text and highlight colors, fonts and font sizes.</li><li>Bulleted and numbered lists.</li><li>Tables, including merged cells and cell background colors.</li><li>Embedded images.</li><li>Links and footnotes.</li></ul><p>To keep links readable regardless of the theme, the default hyperlink color applied automatically by word processors is ignored; links that were deliberately given a custom color by the author keep it.</p><h2>Limitations</h2><ul><li>The preview is read-only. To edit the document, download it or open it in an external application; the content of the note is not affected by the preview. Alternatively copy and paste it into a text note.</li><li>The preview is a simplified rendering: complex layouts (columns, text boxes, headers and footers), charts and the precise styling of table borders are not reproduced.</li><li>Documents larger than 20 MB are not previewed, to keep the server responsive. The usual download and open actions remain available.</li><li>If the document cannot be converted, a notice is displayed instead and the file can still be downloaded or opened externally.</li></ul><h2>Relation with other features</h2><ul><li>The same preview is used when an office document is displayed in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a>&nbsp;or embedded in a text note via&nbsp;<a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>, as well as for office documents stored as&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>.</li><li>Independently of the preview, the text content of office documents is also extracted in the background so that it can be found with&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>&nbsp;via&nbsp;<a class=\"reference-link\" href=\"#root/_help_TiQbQDgP8L5t\">Text Extraction (OCR)</a>.</li><li><code>.csv</code> and <code>.xlsx</code> files can be converted to&nbsp;<a class=\"reference-link\" href=\"#root/_help_GWHEkY4I4OE3\">Spreadsheets</a>&nbsp;via the <a href=\"#root/_help_mHbBMPDPkVV5\">import</a> function.</li></ul>",
++ "_help_GWHEkY4I4OE3": "<figure class=\"image\"><img style=\"aspect-ratio:1102/573;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Spreadsheets_image.png\" width=\"1102\" height=\"573\"></figure><aside class=\"admonition important\"><p>Spreadsheets are a new type of note introduced in v0.103.0 and are currently considered experimental/beta. As such, expect major changes to occur to this note type.</p></aside><p>Spreadsheets provide a familiar experience to Microsoft Excel or LibreOffice Calc, with support for formulas, data validation and text formatting.</p><h2>Spreadsheets vs. collections</h2><p>There is a slight overlap between spreadsheets and the&nbsp;<a class=\"reference-link\" href=\"#root/_help_2FvYrpmOXm29\">Table</a>&nbsp;collection. In general the table collection is useful to track meta-information about notes (for example a collection of people and their birthdays), whereas spreadsheets are quite useful for calculations since they support formulas.</p><p>Spreadsheets also benefit from a wider range of features such as data validation, formatting and can work on a relatively large dataset.</p><h2>Data intercompatibility (import/export)</h2><p>Starting with v0.104.0, Trilium provides a level of data intercompatibility between the internal format (Univer) and the following formats:</p><ul><li>Microsoft Excel (.xlsx)<ul><li>Preserves basic formatting (fonts, sizes, borders, backgrounds).</li><li>Formulas are preserved, but note that not all Excel functions are supported and vice-versa with Univer.</li><li>Images (cell-bound or floating), without preserving rotation.</li><li>Supports multi-sheets natively.</li></ul></li><li>Comma-Separated Values (.csv)<ul><li>Since it's a text-based format, any formatting is lost.</li><li>Formulas are evaluated and turned into their final value instead.</li><li>Multi-sheets spreadsheets are exported as a single ZIP containing a CSV file per sheet.</li></ul></li></ul><p>Both <a href=\"#root/_help_mHbBMPDPkVV5\">import and export</a> are supported, as follows:</p><ul><li>To import a file, simply drag it into the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and it will be converted into a spreadsheet note.<ul><li>To avoid this behavior (e.g. to import a .xlsx file as an actual&nbsp;<a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a>), uncheck the corresponding option in the <a href=\"#root/_help_mHbBMPDPkVV5\">Import dialog</a>.</li><li>Multiple files can be imported at the same time, including a mixture of .csv and .xlsx files. Folder structure can be preserved by using a .zip file.</li></ul></li><li>Unlike importing, exporting is on a per-note basis:<ul><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>, choose the <em>Export to Excel</em> or <em>Export to CSV</em> options.</li><li>If exported as a single file via&nbsp;<a class=\"reference-link\" href=\"#root/_help_mHbBMPDPkVV5\">Import &amp; Export</a>, the resulting file will be a custom <code>.triliumsheet</code> file that preserves the spreadsheet as-is.<ul><li>The export is intentionally a different process than the normal&nbsp;<a class=\"reference-link\" href=\"#root/_help_mHbBMPDPkVV5\">Import &amp; Export</a>&nbsp;functionality because it does conversion to multiple formats with varying degrees of compatibility.</li></ul></li></ul></li></ul><p>Cells pasted from Excel or another application keep their formatting except for the font, so they use the spreadsheet's font like the rest of the cells.</p><aside class=\"admonition important\"><p>Import &amp; export for both .xlsx and .csv files are supported on a best-effort basis. It does not support advanced features (data validation, scripting, etc.). If you notice a particular issue, it can be <a href=\"#root/_help_wy8So3yZZlH9\">reported</a>, however all bug reports must contain a sample file in order to be taken into consideration.</p></aside><h2>Supported features</h2><p>The spreadsheet has support for the following features:</p><ul><li>Since v0.104.0, images that can be either inside a cell or floating above.<ul><li>The images are saved as&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>&nbsp;for performance reasons.</li><li>The image upload respects the same compression settings as text&nbsp;<a class=\"reference-link\" href=\"#root/_help_mT0HEkOsz6i1\">Images</a>.</li></ul></li><li>Filtering</li><li>Sorting</li><li>Data validation</li><li>Conditional formatting</li><li>Notes / annotations</li><li>Find / replace</li></ul><p>We might consider adding <a href=\"https://docs.univer.ai/guides/sheets/features/filter\">other features</a> from Univer at some point. If there is a particular feature that can be added easily, it can be discussed over <a href=\"#root/_help_wy8So3yZZlH9\">GitHub Issues</a>.</p><h3>Share functionality</h3><p>Spreadsheets can be <a href=\"#root/_help_R9pX4DGra2Vt\">shared</a>, case in which a best-effort HTML rendering of the spreadsheet is done:</p><ul><li>Preserves basic formatting.</li><li>Cells with formulas display the precalculated value instead of the formula.</li></ul><p>Since v0.104.0:</p><ul><li>Numbers and dates are properly formatted.</li><li>Images are shown inside a cell or floating above, including rotation.</li></ul><p>For more advanced use cases, this will most likely not work as intended. Feel free to <a href=\"#root/_help_wy8So3yZZlH9\">report issues</a>, but keep in mind that we might not be able to have a complete feature parity with all the features of Univer.</p><h2>Features not supported yet</h2><h3>Regarding Pro features</h3><p>Univer spreadsheets also feature a <a href=\"https://univer.ai/pro\">Pro plan</a> which adds quite a lot of functionality such as charts, printing, pivot tables, export, etc.</p><p>As the Pro plan needs a license, Trilium does not support any of the premium features. Theoretically, pro features can be used in trial mode with some limitations, we might explore this direction at some point.</p><h3>Planned features</h3><p>There are a few features that are already planned but are not supported yet:</p><ul><li>Trilium-specific formulas (e.g. to obtain the title of a note).</li><li>User-defined formulas</li><li>Cross-workbook calculation</li></ul><p>If you would like us to work on these features, consider <a href=\"https://triliumnotes.org/en/support-us\">supporting us</a>.</p><h3>Mobile support</h3><p>Versions prior to v0.104.0 have no dedicated mobile support, which means that the interaction is difficult without a mouse and keyboard. Starting with v0.104.0 we integrate Univer's mobile plugin, which introduces feature such as drag to pan which makes the interface more usable on mobile.</p>",
++ "_help_6RM1Q7ppFVoj": "<p>Trilium has always supported Markdown through its <a href=\"#root/_help_Oau6X9rCuegd\">import feature</a>, however the file was either transformed to a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;note (converted to Trilium's internal HTML format) or saved as a&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note with only syntax highlight.</p><p>This note type is a split view, meaning that both the source code and a preview of the document are displayed side-by-side. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_SL5f1Auq7sVN\">Note types with split view</a>&nbsp;for more information.</p><h2>Rationale</h2><p>The goal of this note type is to fill a gap: rendering Markdown but not altering its structure or its whitespace which would inevitably change otherwise through import/export.</p><p>Even if Markdown is now specially treated by having a preview mechanism, Trilium remains at its core a WYSWYG editor so Markdown will not replace text notes.</p><aside class=\"admonition note\"><p>Feature requests regarding the Markdown implementation will be considered, but if they are outside the realm of Trilium, they will not be implemented. One of the core aspects of the Markdown integration is that it reuses components that are already available through other features of the application.</p></aside><h2>Features</h2><h3>Source view pane</h3><ul><li>Syntax highlighting for the Markdown syntax.</li><li>Nested syntax highlighting for code inside code blocks.</li><li>When editing larger documents, the preview scrolls along with the source editor.</li></ul><h3>Preview pane</h3><p>The following features are supported by Trilium's Markdown format and will show up in the preview pane:</p><ul><li><p>All standard and GitHub-flavored syntax (basic formatting, tables, blockquotes).</p></li><li><p>Basic HTML is also supported (e.g. collapsible blocks using <code>&lt;details&gt;</code> and <code>&lt;summary&gt;</code>).</p></li><li><p>Code blocks with syntax highlight.</p><ul><li>The language must be specified for syntax highlight to be applied (e.g. <code>```js</code>).</li><li>Code blocks will respect the text wrapping from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;section in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>.</li></ul></li><li><p><a class=\"reference-link\" href=\"#root/_help_NwBbFdNZ9h7O\">Block quotes &amp; admonitions</a></p></li><li><p><a class=\"reference-link\" href=\"#root/_help_YfYAtQBcfo5V\">Math Equations</a>&nbsp;(both inline and block)</p></li><li><p><a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a>&nbsp;using <code>```mermaid</code></p></li><li><p><a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a>&nbsp;(no built-in Markdown syntax, but HTML syntax works just fine):</p><pre><code class=\"language-text-html\">&lt;figure class=\"include-note\" data-note-id=\"vJDjQm0VK8Na\" data-box-size=\"expandable\"&gt;\n &lt;figcaption&gt;An optional caption, with &lt;strong&gt;HTML&lt;/strong&gt; formatting&lt;/figcaption&gt;\n&lt;/figure&gt;</code></pre><ul><li>The caption is optional. Markdown is not processed inside the HTML block, so format the caption with HTML tags.</li><li>Includes written as <code>&lt;section class=\"include-note\"&gt;</code>, the syntax of earlier versions, still work.</li><li>These can also be quickly created via the <code>/include</code> command or via a dedicated keyboard shortcut (not assigned by default).</li></ul></li><li><p><a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;via its HTML syntax, or through a <em>Wikilinks</em>-like format (only&nbsp;<a class=\"reference-link\" href=\"#root/_help_m1lbrzyKDaRB\">Note ID</a>):</p><pre><code class=\"language-text-x-trilium-auto\">[[Hg8TS5ZOxti6]]</code></pre></li><li><p>To-do lists with extended task states:</p><figure class=\"table\"><table class=\"ck-table-resized\" style=\"border-style:none;\"><colgroup><col style=\"width:80.6%;\"><col style=\"width:19.4%;\"></colgroup><tbody><tr><td><pre><code class=\"language-text-x-markdown\">- [ ] None\n- [/] Doing\n- [X] Done\n- [?] Maybe\n- [-] Cancelled</code></pre></td><td><figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:218/221;\" src=\"{{helpAssets}}/User%20Guide/Note%20Types/Markdown_image.png\" width=\"218\" height=\"221\"></figure></td></tr></tbody></table></figure><p>Task states are customizable: you can reorder them, create new ones with different colors and symbols, or delete the ones you don't need. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_i16PM6A7GXdU\">Customizing to-do task states</a>&nbsp;for more details.</p><p>Note that to-do items with task states other than \"None\" and \"Done\" are Trilium-specific and may not work well with other Markdown software.</p></li><li><p><a class=\"reference-link\" href=\"#root/_help_AgjCISero73a\">Footnotes</a>&nbsp;are also supported via the corresponding Markdown syntax:</p><pre><code class=\"language-text-x-trilium-auto\">This is [^1], while this is [^2].\n\n[^1]: the first footnote\n[^2]: the second footnote</code></pre><ul><li>These can also be quickly created using the <code>/footnote</code> command.</li></ul></li><li><p>Page breaks for&nbsp;<a class=\"reference-link\" href=\"#root/_help_NRnIZmSMc5sj\">Printing &amp; Exporting as PDF</a>:</p><pre><code class=\"language-text-x-trilium-auto\">&lt;div class=\"page-break\"&gt;&lt;/div&gt;</code></pre></li><li><p>Highlights (background color) are supported both via the <code>==</code> Markdown syntax, as well as the canonical HTML representation in Trilium:</p><pre><code class=\"language-text-x-trilium-auto\">==highlighted==\n&lt;span style=\"background-color:#e5e64d;--tn-background:#e5e64d;\"&gt;Highlighted&lt;/span&gt;</code></pre></li></ul><h3>Links</h3><p>Multiple types of links are supported:</p><ul><li><p>Web URLs can be written with the standard Markdown syntax:</p><pre><code class=\"language-text-x-trilium-auto\">[Wikipedia](https://www.wikipedia.org)</code></pre></li><li><p><a href=\"#root/_help_hrZ1D00cLbal\">Reference link</a> to other notes with dynamic title, either by manually entering the note ID or via the <em>Add link</em> dialog:</p><pre><code class=\"language-text-x-trilium-auto\">[[B9oMG6rFvvfq]]</code></pre></li><li><p><a href=\"#root/_help_hrZ1D00cLbal\">Reference link</a> to other notes with a custom text:</p><pre><code class=\"language-text-x-trilium-auto\">[This is a link](#root/LhtnZxtVsUMp)</code></pre></li></ul><p>To create a link, either:</p><ul><li>Type it manually using the syntax described above.</li><li>Use the <em>Add link</em> dialog by pressing <kbd>Ctrl</kbd>+<kbd>L</kbd> or typing the <code>/link</code> command.</li></ul><p><a class=\"reference-link\" href=\"#root/_help_UmgZAfcltxkS\">Link Previews</a>&nbsp;are also rendered, but there is no mechanism to insert them automatically as of now, they have to be copied from a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;note instead.</p><h3>Keyboard shortcuts</h3><p>The Markdown notes share some of the keyboard shortcuts from&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes:</p><ul><li><em>Cut to note</em> (<kbd>Ctrl</kbd>+<kbd>X</kbd>) which cuts the selection into a new child note.</li><li><em>Add link</em> (<kbd>Ctrl</kbd>+<kbd>L</kbd>) which shows the dialog to create external or reference links.</li><li><em>Date/time</em> (<kbd>Alt</kbd>+<kbd>T</kbd>) which respects the same formatting as text notes.</li><li><em>Include note</em> (not assigned by default), which triggers the same dialog to insert notes as the one for text notes.</li></ul><p>In addition, the following formatting keyboard shortcuts are available:</p><ul><li><kbd>Ctrl</kbd>+<kbd>B</kbd> to toggle <strong>bold</strong>.</li><li><kbd>Ctrl</kbd>+<kbd>I</kbd> to toggle <em>italic</em>.</li><li><kbd>Ctrl</kbd>+<kbd>M</kbd> to wrap the current selection in an inline math (<code>$</code>).</li><li><kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>X</kbd> to toggle <del>strikethrough</del>.</li></ul><h3>Images &amp; attachments</h3><p>Images can be inserted into the document in four different methods:</p><ul><li>Drag &amp; drop directly into the editor area.</li><li>Pasting an image from clipboard.</li><li>Pasting a reference to another <a href=\"#root/_help_0vhv7lsOLy82\">attachment</a> (e.g. <em>Copy reference to clipboard</em> button).</li><li>Use the <code>/image</code> slash command.</li></ul><p>An image reference to an attachment looks like this:</p><pre><code class=\"language-text-x-trilium-auto\">![Name.jpeg](api/attachments/z50RceuHXe9J/image/image)</code></pre><h3>Auto-completion</h3><h4>Slash commands</h4><p>Just like&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes, Markdown notes support a selection of slash commands:</p><ul><li>Inserting the current date &amp; time (<code>/date</code>).</li><li><a href=\"#root/_help_nBAXQFj20hS1\">Including</a> another note (<code>/include</code>).</li><li>Uploading and inserting an image (<code>/image</code>).</li><li>Inserting a note link (<code>/link</code>).</li><li>Inserting a math equation block (<code>/math</code>).</li><li>Inserting a <a href=\"#root/_help_AgjCISero73a\">footnote</a> (<code>/footnote</code>).</li><li>Inserting a <a href=\"#root/_help_s1aBHPd79XYj\">Mermaid</a> diagram (<code>/mermaid</code>), with one variant per sample template (e.g. <code>/mermaid:flowchart</code>).</li><li>Inserting a collapsible block (<code>/collapsible</code>).</li><li>Inserting <a href=\"#root/_help_rJ9grSgoExl9\">tabs</a> (<code>/tabs</code>).</li><li>Inserting a page break for printing (<code>/page-break</code>).</li><li>Inserting a table (<code>/table</code>).</li><li>Creating admonitions (e.g. <code>/tip</code>, <code>/note</code>, <code>/important</code>, <code>/caution</code>, <code>/warning</code>).</li><li>Inserting task items (<code>/todo:&lt;state&gt;</code>, e.g. <code>/todo:done</code>), one per configured task state.</li><li>Inserting code snippets (<code>/snippet:&lt;name&gt;</code>) from your Markdown/plain-text snippet notes.</li></ul><p>The list shows each command by its title, as in Text notes. Typing a command's title, its keyword (as listed above) or a related word such as <code>latex</code> or <code>grid</code> finds it.</p><p>Note that slash commands only work outside of code blocks and inline code.</p><h4>Linking notes with <code>@</code> or <code>[[</code></h4><p>As in&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes, typing <code>@</code> at the start of a line or after a space opens the note search. Picking a note replaces what was typed with a link to it in the Wikilinks-like format (<code>[[noteId]]</code>), which the preview shows as an&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;with the note's title.</p><p>The search runs on everything typed after the <code>@</code>, spaces included, so a title such as <code>@My meeting notes</code> can be typed out; press <kbd>Esc</kbd> to close the list and go on writing. If no note fits, the list offers to create one, as a child of the Markdown note or in the inbox; the link is inserted once the note is created.</p><p>You can also start typing the link directly: <code>[[</code> opens the same list, and closing the brackets yourself dismisses it. To change where an existing link points, place the cursor inside it and pick another note.</p><p>Like slash commands, <code>@</code> and <code>[[</code> do nothing inside code blocks and inline code.</p><p>In the editor, a <code>[[noteId]]</code> link shows as the note's icon and title, so you can tell which note it points to without looking up its ID. Clicking it, or moving the cursor next to it, shows the link as written so it can be edited. Links inside code blocks and inline code are left as they are.</p><h4>Code block language auto-completion</h4><p>Starting with v0.104.0, typing ``` to insert a code block will automatically open a list of suggested language types which have syntax highlighting.</p><p>The list of languages matches the one for&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;notes set in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>, it's not the full list of languages supported by Trilium.</p><h3>Other features</h3><ul><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_BFvAtE74rbP6\">Table of contents</a>&nbsp;will be displayed in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>&nbsp;based on the Markdown-level headings.</li></ul><h3>Shared notes</h3><p>When a Markdown note is <a href=\"#root/_help_R9pX4DGra2Vt\">shared publicly</a>, it will be rendered with extended formatting just like&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes.</p><p>Most of the features described previously should be supported. If you face any issues, feel free to <a href=\"#root/_help_wy8So3yZZlH9\">report it</a> alongside a sample Markdown file.</p><h2>Creating Markdown notes</h2><p>There are two ways to create a Markdown note:</p><ol><li>Create a new note (e.g. in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>) and select the type <em>Markdown</em>, just like all the other note types.</li><li>Create a note of type&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;and select as the language either <em>Markdown</em> or <em>GitHub-Flavored Markdown</em>. This maintains compatibility with your existing notes prior to the introduction of this feature.</li></ol><aside class=\"admonition note\"><p>There is no distinction between the new Markdown note type and code notes of type Markdown; internally both are represented as&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;notes with one of the following MIME types:</p><ul><li><code>text/markdown</code></li><li><code>text/x-markdown</code></li><li><code>text/x-gfm</code> (GitHub Flavored Markdown)</li></ul></aside><h2>Import/export</h2><h3>Import</h3><p>By default, when importing a single Markdown file it automatically gets converted to a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;note. To avoid that and have it imported as a Markdown note instead:</p><ul><li>Right click the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and select <em>Import into note</em>.</li><li>Select the file normally.</li><li>Uncheck <em>Import HTML, Markdown and TXT as text notes if it's unclear from the metadata</em>.</li></ul><p>When importing a Trilium ZIP, it will preserve the Markdown type without converting to text notes thanks to the meta-information in it.</p><h3>Exporting</h3><p>When exporting Markdown files, the extension is preserved and the content remains the same as in the source view (with some small exceptions such as handling of attachments).</p><p>When exporting Markdown files as ZIP, choosing HTML or Markdown as the export format makes no difference as that only affects&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes.</p><p>If the Markdown note contains attachments, a ZIP export will rewrite the links to attachments so that they are replaced with a relative path to the attachment. On import, the links are re-written back.</p><h2>Conversion between text notes and Markdown notes</h2><p><a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes can be converted into Markdown notes and vice versa. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_jludwdW7N4hg\">Converting between note types</a>.</p><h2>Sync-scrolling &amp; block highlight</h2><p>When scrolling through the editing pane, the preview pane will attempt to synchronize its position to make it easier to see the preview.</p><p>In addition, the block in the preview matching the position of the cursor in the source view will appear slightly highlighted.</p><p>The sync is currently one-way only, scrolling the preview will not synchronize the position of the editor.</p><p>This feature cannot be disabled as of now; if the scrolling feels distracting, consider temporarily switching to the editor mode and then switching to preview mode when ready.</p><aside class=\"admonition note\"><p>This feature of synchronizing the scroll is based on blocks but it's provided on a best-effort basis since our underlying Markdown library doesn't support this feature natively, so we had to implement our own algorithm. Feel free to <a href=\"#root/_help_wy8So3yZZlH9\">report issues</a>, but always provide a sample Markdown file to be able to reproduce it.</p></aside>",
++ "_help_jludwdW7N4hg": "<p>A note's type may be converted to another:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes to&nbsp;<a class=\"reference-link\" href=\"#root/_help_6RM1Q7ppFVoj\">Markdown</a>&nbsp;notes</li><li>Markdown notes to Text notes</li></ul><p>Before conversion, a revision is saved automatically, so you can restore the original or recover any missing elements from it if the conversion produces undesired results. Read more about&nbsp;<a class=\"reference-link\" href=\"#root/_help_vZWERwf8U3nx\">Note Revisions</a>.</p><h2>Converting individual notes</h2><h3>Markdown to Text Note</h3><p>Markdown notes can be converted to Text Notes with negligible loss of formatting fidelity.</p><p>To do so, go to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> → <em>Advanced</em> and select <em>Convert to Text Note</em>.</p><h3>Text Note to Markdown</h3><aside class=\"admonition warning\"><p>Since Markdown does not support all the capabilities of Text notes, this conversion is lossy in terms of formatting: some formatting may be lost, and some unsupported elements may even be dropped. It's strongly recommended that you inspect the content for any information that might have gone missing after the conversion.</p></aside><p>To convert a text note to Markdown, go to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> → <em>Advanced</em> and select <em>Convert to Markdown Note</em>.</p><h2>Converting multiple notes</h2><p>A note type conversion can also be performed on an entire subtree or a set of multiple notes using&nbsp;<a class=\"reference-link\" href=\"#root/_help_ivYnonVFBxbQ\">Bulk Actions</a>.</p>",
++ "_help_GTwFsgaA0lCt": "<p>Collections are a unique type of note that don't have content, but instead display their child notes in various presentation methods.</p><h2>Main collections</h2><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bx-calendar\"></span>&nbsp;Calendar</p><div class=\"trilium-tab-panel\"><p><a class=\"reference-link\" href=\"#root/_help_xWbu3jpNWapp\">Calendar</a>&nbsp;displays a week, month or year calendar with the notes being shown as events. New events can be added easily by dragging across the calendar.</p><figure class=\"image\"><img style=\"aspect-ratio:1651/810;\" src=\"{{helpAssets}}/User%20Guide/Collections_collection_calendar.webp\" width=\"1651\" height=\"810\"></figure></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bx-table\"></span>&nbsp;Table</p><div class=\"trilium-tab-panel\"><p><a class=\"reference-link\" href=\"#root/_help_2FvYrpmOXm29\">Table</a>&nbsp;displays each note as a row in a table, with&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;being shown as well. This makes it easy to visualize attributes of notes, as well as making them easily editable.</p><figure class=\"image\"><img style=\"aspect-ratio:1643/647;\" src=\"{{helpAssets}}/User%20Guide/Collections_collection_table.webp\" width=\"1643\" height=\"647\"></figure></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bx-columns\"></span>&nbsp;Kanban Board</p><div class=\"trilium-tab-panel\"><p><a class=\"reference-link\" href=\"#root/_help_CtBQqbwXDx1w\">Kanban Board</a>&nbsp;displays notes in columns, grouped by the value of a label. Items and columns can easily be created or dragged around to change their status.</p><figure class=\"image\"><img style=\"aspect-ratio:1174/850;\" src=\"{{helpAssets}}/User%20Guide/Collections_collection_board.webp\" width=\"1174\" height=\"850\"></figure></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bx-map-alt\"></span>&nbsp;Geo Map</p><div class=\"trilium-tab-panel\"><p><a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map</a>&nbsp;which displays a geographical map in which the notes are represented as pins on the map. New markers can be easily added by pointing on the map. In addition <a href=\"#root/_help_C2H9HK4BzwG7\">shapes</a> such as paths, rectangles and circles can be added, as well as GPX tracks.</p><figure class=\"image\"><img style=\"aspect-ratio:844/639;\" src=\"{{helpAssets}}/User%20Guide/Collections_collection_geomap.webp\" width=\"844\" height=\"639\"></figure></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bx-slideshow\"></span>&nbsp;Presentation</p><div class=\"trilium-tab-panel\"><p><a class=\"reference-link\" href=\"#root/_help_zP3PMqaG71Ct\">Presentation</a>&nbsp;which shows each note as a slide and can be presented full-screen with smooth transitions or exported to PDF for sharing.</p><figure class=\"image\"><img style=\"aspect-ratio:1120/763;\" src=\"{{helpAssets}}/User%20Guide/Collections_collection_presentation.webp\" width=\"1120\" height=\"763\"></figure></div></section></div><h2>Classic collections</h2><p>Classic collections are read-only mode and compiles the contents of all child notes into one continuous view. This makes it ideal for reading extensive information broken into smaller, manageable segments.</p><ul><li><a class=\"reference-link\" href=\"#root/_help_8QqnMzx393bx\">Grid View</a>&nbsp;which is the default presentation method for child notes (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a>), where the notes are displayed as tiles with their title and content being visible.</li><li><a class=\"reference-link\" href=\"#root/_help_mULW0Q3VojwY\">List View</a>&nbsp;is similar to&nbsp;<a class=\"reference-link\" href=\"#root/_help_8QqnMzx393bx\">Grid View</a>, but it displays the notes one under the other with the content being expandable/collapsible, but also works recursively.</li></ul><p>Classic collections make use of pagination to support a large number of notes. The size of a page can be customized via <code>pageSize</code>.</p><h2>Creating a new collection</h2><p>To create a new collection, right-click a note in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and select <em>Insert child note</em> → <em>Collection</em> → the desired type.</p><p>By default, collections come with a default configuration and sometimes even sample notes. To create a collection completely from scratch:</p><ol><li>Create a new note of type <em>Text</em> (or any type).</li><li>Change the <a href=\"#root/_help_KSZ04uQ2D1St\">note type</a> to <em>Collection</em>.</li><li>In&nbsp;<a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>, select the desired view type.</li><li>Consult the help page of the corresponding view type in order to understand how to configure them.</li></ol><h2>Configuration</h2><p>To change the configuration of a collection or even switch to a different collection (e.g. from Kanban Board to a Calendar), see the&nbsp;<a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>&nbsp;bar at the top of the note.</p><h2>Archived notes</h2><p>By default, <a href=\"#root/_help_MKmLg5x6xkor\">archived notes</a> will not be shown in collections. This behavior can be changed by going to&nbsp;<a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>&nbsp;and checking <em>Show archived notes</em>.</p><p>Archived notes will be generally indicated by being greyed out as opposed to the normal ones.</p><h2>Hiding the child notes from the note tree</h2><p>For collections with a large number of items, it can be helpful to hide the items from the note tree for performance reasons and to reduce clutter. This is especially useful for standalone collections, such as a geomap or a task board.</p><p>To do so, go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>&nbsp;and select <em>Hide child notes in tree</em>.</p><h2>Advanced use cases</h2><h3>Adding a description to a collection</h3><p>To add a text before the collection, for example to describe it:</p><ol><li>Create a new collection.</li><li>Change the <a href=\"#root/_help_KSZ04uQ2D1St\">note type</a> from <em>Collection</em> to <em>Text</em>.</li></ol><p>Now the text will be displayed above while still maintaining the collection view.</p><p>The only downside to this method is that&nbsp;<a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>&nbsp;will not be shown anymore. In this case, modify the attributes manually or switch back temporarily to the <em>Collection</em> type for configuration purposes.</p><h3>Using saved search</h3><p>Collections, by default, only display the child notes. However, it is possible to use the&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>&nbsp;functionality to display notes all across the tree, with advanced querying functionality.</p><p>To do so, simply start a&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>&nbsp;and go to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>&nbsp;and select a desired type of collection. To keep the search-based collection, use a&nbsp;<a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a>.</p><aside class=\"admonition important\"><p>While in search, none of the collections will not display the child notes of the search results. The reason is that the search might hit a note multiple times, causing an exponential rise in the number of results.</p></aside><h2>Under the hood</h2><p>Collections by themselves are simply notes with no content that rely on the&nbsp;<a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a>&nbsp;mechanism (the one that lists the children notes at the bottom of a note) to display information.</p><p>By default, new collections use predefined&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>&nbsp;that are stored safely in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_2mUhVmZK8RF3\">Hidden Notes</a>&nbsp;to define some basic configuration such as the type of view, but also some&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;to make editing easier.</p><p>Collections don't store their configuration (e.g. the position on the map, the hidden columns in a table) in the content of the note itself, but as attachments.</p>",
++ "_help_xWbu3jpNWapp": "<figure class=\"image\"><img style=\"aspect-ratio:2016/1413;\" src=\"{{helpAssets}}/User%20Guide/Collections/1_Calendar_image.png\" width=\"2016\" height=\"1413\"></figure><p>The Calendar view will display each child note in a calendar that has a start date and optionally an end date, as an event.</p><p>The Calendar view has multiple display modes:</p><ul><li>Month view, where the entire month is displayed and all-day events can be inserted. Both time-specific events and all-day events are listed.</li><li>Week view, where all the 7 days of the week (or 5 if the weekends are hidden) are displayed in columns. This mode allows entering and displaying time-specific events, not just all-day events.</li><li>Day view, which views only a single day. Especially useful for heavy agendas or mobile views.</li><li>List view, which displays all the events of a given month in sequence.</li><li>Year view, which displays the entire year for quick reference.</li></ul><p>Unlike other Collection view types, the Calendar view also allows some kind of interaction, such as moving events around as well as creating new ones.</p><h2>Creating a calendar</h2><p>Right click on an existing note in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and select <em>Insert child note</em> → <em>Collection</em> → <em>Calendar</em>.</p><h2>Creating a new event/note</h2><p>To create a new event:</p><ul><li>First, click the desired day (month &amp; year views) or the desired timeslot (day view).</li><li>Alternatively, drag across multiple days (or time slots) to set both the start and end date.</li></ul><p>In either cases, a small popup will show with a prompt for a title and the date &amp; time of the event that will be created. The date and time can be changed there the same way as in the popup view of an existing event (see below).</p><p>At this point, the event hasn't been created yet to protect against accidental clicks. Add a title optionally and press the <em>Create</em> button. If no title is provided, the event will follow the&nbsp;<a class=\"reference-link\" href=\"#root/_help_47ZrP6FNuoG8\">Default Note Title</a>&nbsp;rules.</p><p>The <span class=\"tn-icon bx bx-detail\"></span> template field below the date and time shows the note type or template the event's note is made from. To make the event from another one, press the field and select it from the list; the calendar remembers the choice for the next event. Select <em>More templates…</em> to change which templates are listed (see <a href=\"#event-templates\">Event templates</a>). The date and time entered for the event replace any dates and times the template carries.</p><p>To give the event a time before creating it (for example, after clicking a day in the month view), press <em>Add time</em> and set the start and end time; the duration is shown to the right of them. To make the event all-day again, press the <span class=\"tn-icon bx bx-x\"></span> button at the end of the row. Adding or removing a time keeps the dates, so an event can start at a time on one day and end at a time on another (for example, a night shift). Changing the start date or time moves the end by the same amount, keeping the duration. An empty end date means the event ends on the day it starts; setting the end time before the start time moves the end date to the next day.</p><p>After creating the event, it will show up on the calendar. To edit the content of the event (including recurrence), click on it to bring it into the popup view.</p><aside class=\"admonition note\"><p>Creating new notes from the calendar will respect the <code>~child:template</code> relation if set on the Collection note.</p></aside><h2>Interacting with events</h2><ul><li>Hovering the mouse over an event will display information about the note.<br><img src=\"{{helpAssets}}/User%20Guide/Collections/4_Calendar_image.png\"></li><li>Left clicking the event will open a&nbsp;dedicated popup to quickly configure the event or edit its note content.</li><li>Right click will offer more options including opening the note in a new split or window.</li><li>Drag and drop an event on the calendar to move it to another day.</li><li>The length of an event can be changed by placing the mouse to the right edge of the event and dragging the mouse around.</li></ul><p>On a <a href=\"#root/_help_CoFPLs3dRlXc\">read-only</a> calendar, events can't be dragged, resized or created, their context menu only offers the places to open them in, and the button to pin the current date is hidden. Switching between the month, week and day views still works, but the choice isn't saved.</p><h3>Popup view</h3><p>When an event is clicked, a popup will show near the event which contains the following inforamtion:</p><ul><li>The title and icon of the event, both editable.</li><li>Buttons to interact with the event:<ul><li>Open the event in the same pane, new tab, etc.</li><li>Color picker to change the color of the event.</li><li>Button to remove the event from the calendar, which can optionally delete its corresponding note.</li></ul></li><li>Calendar-specific features:<ul><li>The start date and, for an event spanning several days, the end date.</li><li>The start and end time with the duration to the right of them, and a <span class=\"tn-icon bx bx-x\"></span> button that removes the time, making the event all-day. An all-day event shows an <em>Add time</em> button instead.</li><li>A full recurrence editor, opened from the dropdown below the time, to have the same event show up weekly, monthly, etc.</li></ul></li><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;of the marker, if any.</li><li>The note's content which can be edited directly from the panel.</li></ul><p>To dismiss the popup:</p><ul><li>Press the X button at the top-right of the popup.</li><li>In the calendar, press anywhere outside the popup.</li><li>Or simply press the <kbd>Escape</kbd> key.</li></ul><p>It is possible to switch between events by clicking on them even when the popup view is already open.</p><p>Events can have&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;between them and clicking on such a link will automatically navigate the calendar to the right date and the popup view to the new note.</p><h2>Interaction on mobile</h2><p>When Trilium is on mobile, the interaction with the calendar is slightly different:</p><ul><li>Clicking on an event displays the popup view, which allows editing the event.</li><li>Long-presing an event triggers the contextual menu, including the option to open in&nbsp;<a class=\"reference-link\" href=\"#root/_help_ZjLYv08Rp3qC\">Quick edit</a>.</li><li>To insert a new event, touch and hold the empty space. When successful, the empty space will become colored to indicate the selection.<ul><li>Before releasing, drag across multiple spaces to create multi-day events.</li><li>When released, a prompt will appear to enter the note title.</li></ul></li><li>To move an existing event, touch and hold the event until the empty space near it will become colored.<ul><li>At this point the event can be dragged across other days on the calendar.</li><li>Or the event can be resized by tapping on the small circle to the right end of the event.</li><li>To exit out of editing mode, simply tap the empty space anywhere on the calendar.</li></ul></li></ul><h2>Configuring the calendar view</h2><p>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>, it's possible to:</p><ul><li>Hide weekends from the week view.</li><li>Display week numbers on the calendar.</li><li>Set the slot duration (the length of each time row in day/week view).</li><li>Set the slot label interval (how often time labels appear on the axis in day/week view).</li></ul><p>The same settings are also listed under <em>General</em> in the <span class=\"tn-icon bx bx-cog\"></span> <em>Calendar properties</em> dialog (see <a href=\"#event-templates\">Event templates</a> for how to open it). The time slots are listed there whichever view the calendar is in. Its <em>Included notes</em> section sets whether archived notes are shown and how deep the calendar looks for events (see <a href=\"#limiting-the-depth\">Limiting the depth</a>).</p><h3>Event templates</h3><p>By default, a new event is a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a> note. To make events from other note types, or from&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a> with predefined content and attributes (such as a color), open the <span class=\"tn-icon bx bx-cog\"></span> <em>Calendar properties</em> dialog from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> or from the settings menu of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>, and find <em>Event templates</em>. Here you can:</p><ul><li>Include a note type or note template already created in your knowledge base by pressing the <span class=\"tn-icon bx bx-list-plus\"></span> <em>Add existing template</em> button and then selecting the desired note type or template.</li><li>Create a new template by pressing the <span class=\"tn-icon bx bx-plus\"></span> <em>Create a new template</em> button. The template is created as a child of the calendar, and is not shown as an event.</li><li>Press the <span class=\"tn-icon bx bx-x\"></span> button to remove a template from the list. The template is removed only from the list, not deleted.</li><li>Press the <span class=\"tn-icon bx bx-dots-vertical-rounded\"></span> button of a custom template to edit, open in a new window, duplicate, or delete it.</li><li>Drag a template by its handle to reorder the list shown when creating an event.</li></ul><p>The dialog is not available on a read-only calendar, or on a calendar marked with <code>#calendarRoot</code> or <code>#workspaceCalendarRoot</code> (see <a href=\"#using-with-the-journal--calendar\">Using with the Journal / calendar</a>).</p><h3>Event attributes</h3><p>Events can show the values of their attributes below their title, in the month view, and in the week and day views for all-day events and for timed ones tall enough to hold them. To choose which attributes are shown, open the <span class=\"tn-icon bx bx-cog\"></span> <em>Calendar properties</em> dialog (see <a href=\"#event-templates\">Event templates</a> for how to open it) and find <em>Event attributes</em>. It lists the <a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a> the calendar defines, and those its events define themselves. Here you can:</p><ul><li>Turn an attribute on to show it on the events. New attributes are hidden until you turn them on, which keeps the calendar from getting cluttered.</li><li>Drag an attribute by its handle to change the order in which the events show them.</li><li>Create a new attribute, which is shown on the events right away, or edit or delete one the calendar defines.</li></ul><p>The dates, times and recurrence of the events are not listed, as the calendar always shows them itself.</p><p>If an event has a <code>#calendar:displayedAttributes</code> label, including one inherited from the calendar, the attributes listed in that label are shown instead.</p><h2>Configuring the calendar using attributes</h2><p>The following attributes can be added to the Collection type:</p><figure class=\"table\"><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><code>#calendar:hideWeekends</code></td><td>When present (regardless of value), it will hide Saturday and Sundays from the calendar.</td></tr><tr><td><code>#calendar:weekNumbers</code></td><td>When present (regardless of value), it will show the number of the week on the calendar.</td></tr><tr><td><code>#calendar:initialDate</code></td><td>Change the date the calendar opens on. When not present, the calendar opens on the current date.</td></tr><tr><td><code>#calendar:view</code></td><td><p>Which view to display in the calendar:</p><ul><li><code>timeGridDay</code> for the <em>day</em> view;</li><li><code>timeGridWeek</code> for the <em>week</em> view;</li><li><code>dayGridMonth</code> for the <em>month</em> view;</li><li><code>multiMonthYear</code> for the <em>year</em> view;</li><li><code>listMonth</code> for the <em>list</em> view.</li></ul><p>Any other value will be dismissed and the default view (month) will be used instead.</p><p>The value of this label is automatically updated when changing the view using the UI buttons.</p></td></tr><tr><td><code>#calendar:slotDuration</code></td><td>Sets how long each timeslot is on the calendar. Defaults to <code>00:15:00</code> (15 minutes). Must have the format \"HH:MM:SS\". For example, to create timeslots for every 10 minutes, you would set <code>#calendar:slotDuration=\"00:10:00\"</code>.</td></tr><tr><td><code>#calendar:slotLabelInterval</code></td><td>Sets how often the timeslots on the calendar should be labeled. Defaults to <code>01:00:00</code> (1 hour). Must have the format \"HH:MM:SS\". For example, to label timeslots every 30 minutes, you would set <code>#calendar:slotLabelInterval=\"00:30:00\"</code>.</td></tr><tr><td><code>~child:template</code></td><td>Defines the template for newly created notes in the calendar (via dragging or clicking).</td></tr></tbody></table></figure><p>In addition, the first day of the week can be either Sunday or Monday and can be adjusted from the application settings.</p><h2>Configuring the calendar events using attributes</h2><p>For each note of the calendar, the following attributes can be used:</p><figure class=\"table\"><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><code>#startDate</code></td><td>The date the event starts, which will display it in the calendar. The format is <code>YYYY-MM-DD</code> (year, month and day separated by a minus sign).</td></tr><tr><td><code>#endDate</code></td><td>Similar to <code>startDate</code>, mentions the end date if the event spans across multiple days. The date is inclusive, so the end day is also considered. The attribute can be missing for single-day events.</td></tr><tr><td><code>#startTime</code></td><td>The time the event starts at. If this value is missing, then the event is considered a full-day event. The format is <code>HH:MM</code> (hours in 24-hour format and minutes).</td></tr><tr><td><code>#endTime</code></td><td>Similar to <code>startTime</code>, it mentions the time at which the event ends (in relation with <code>endDate</code> if present, or <code>startDate</code>).</td></tr><tr><td><code>#recurrence</code></td><td>This is an optional CalDAV <code>RRULE</code> string that if present, determines whether a task should repeat or not. Note that it does not include the <code>DTSTART</code> attribute, which is derived from the <code>#startDate</code> and <code>#startTime</code> directly. For examples of valid <code>RRULE</code> strings see <a href=\"https://icalendar.org/rrule-tool.html\">https://icalendar.org/rrule-tool.html</a></td></tr><tr><td><code>#color</code></td><td>Displays the event with a specified color (named such as <code>red</code>, <code>gray</code> or hex such as <code>#FF0000</code>). This will also change the color of the note in other places such as the note tree.</td></tr><tr><td><code>#calendar:color</code></td><td><strong>❌️ Removed since v0.100.0. Use</strong> <code>#color</code> <strong>instead.</strong>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <br> <br>Similar to <code>#color</code>, but applies the color only for the event in the calendar and not for other places such as the note tree.</td></tr><tr><td><code>#iconClass</code></td><td>If present, the icon of the note will be displayed to the left of the event title.</td></tr><tr><td><code>#calendar:title</code></td><td>Changes the title of an event to point to an attribute of the note other than the title, can either a label or a relation (without the <code>#</code> or <code>~</code> symbol). See <em>Use-cases</em> for more information.</td></tr><tr><td><code>#calendar:titleTemplate</code></td><td>Changes the title an event is displayed with on the calendar, filled in again for every occurrence of a repeating event. See <em>Use-cases</em> for displaying an age on a birthday.</td></tr><tr><td><code>#calendar:displayedAttributes</code></td><td>Takes precedence over the <a href=\"#event-attributes\">Event attributes</a> chosen in the calendar's properties. Allows displaying the value of one or more attributes in the calendar, in the order given, like this:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <br> <br><img src=\"{{helpAssets}}/User%20Guide/Collections/6_Calendar_image.png\"> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <br> <br><code>#weight=\"70\" #Mood=\"Good\" #calendar:displayedAttributes=\"weight,Mood\"</code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <br> <br>It can also be used with relations, case in which it will display the title of the target note:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <br> <br><code>~assignee=@My assignee #calendar:displayedAttributes=\"assignee\"</code></td></tr><tr><td><code>#calendar:startDate</code></td><td>Allows using a different label to represent the start date, other than <code>startDate</code> (e.g. <code>expiryDate</code>). The label name <strong>must not be</strong> prefixed with <code>#</code>. If the label is not defined for a note, the default will be used instead.</td></tr><tr><td><code>#calendar:endDate</code></td><td>Similar to <code>#calendar:startDate</code>, allows changing the attribute which is being used to read the end date.</td></tr><tr><td><code>#calendar:startTime</code></td><td>Similar to <code>#calendar:startDate</code>, allows changing the attribute which is being used to read the start time.</td></tr><tr><td><code>#calendar:endTime</code></td><td>Similar to <code>#calendar:startDate</code>, allows changing the attribute which is being used to read the end time.</td></tr></tbody></table></figure><h2>How the calendar works</h2><p><img src=\"{{helpAssets}}/User%20Guide/Collections/8_Calendar_image.png\"></p><p>The calendar displays all the child notes of the Collection that have a <code>#startDate</code>. An <code>#endDate</code> can optionally be added.</p><p>A text note with a start date is shown with the <span class=\"tn-icon bx bx-calendar-event\"></span> icon in the note tree and elsewhere, unless it has an icon of its own (set with <code>#iconClass</code>). The start date is read from the label <code>#calendar:startDate</code> names, if any.</p><p>The start date &amp; end date can easily be edited from the calendar collection itself by clicking on the event. To edit the date while in the event note itself, the following attributes can be added to the Collection note:</p><pre><code class=\"language-text-x-trilium-auto\">#viewType=calendar #label:startDate(inheritable)=\"promoted,alias=Start Date,single,date\"\n#label:endDate(inheritable)=\"promoted,alias=End Date,single,date\"\n#hidePromotedAttributes </code></pre><p>This will result in:</p><p><img src=\"{{helpAssets}}/User%20Guide/Collections/7_Calendar_image.png\"></p><p>When not used in a Journal, the calendar is recursive. That is, it will look for events not just in its child notes but also in the children of these child notes.</p><h3>Limiting the depth</h3><p>To limit how deep the calendar looks for events, set <em>Maximum nesting depth</em> under <em>Included notes</em> in the <span class=\"tn-icon bx bx-cog\"></span><em>Calendar properties</em> dialog (see <a href=\"#event-templates\">Event templates</a> for how to open it), or the <code>#maxNestingDepth</code> label: <code>0</code> shows only the child notes, <code>1</code> adds their children, and so on. Without a value, events are looked for at every level. The setting doesn't apply in a Journal.</p><h2>Recurrence</h2><p>The built in calendar view also supports repeating tasks (e.g. every week, every month as well as more complex recurrency rules).</p><p>Starting with v0.105.0, recurrence can be directly edited from the calendar by clicking on an event and then selecting the <em>Repeats</em> option.</p><h3>Custom recurrence using a subset of RRULE</h3><p>If the existing recurrence editor from the event popup is not sufficient, more complex rules can be manually set via the <code>#recurrence</code> label.</p><p>For example, to make a note repeat on the calendar:</p><ul><li>Every Day - <code>#recurrence=\"FREQ=DAILY;INTERVAL=1\"</code></li><li>Every 3 days - <code>#recurrence=\"FREQ=DAILY;INTERVAL=3\"</code></li><li>Every week - <code>#recurrence=\"FREQ=WEEKLY;INTERVAL=1\"</code></li><li>Every 2 weeks on Monday, Wednesday and Friday - <code>#recurrence=\"FREQ=WEEKLY;INTERVAL=2;BYDAY=MO,WE,FR\"</code></li><li>Every 3 months - <code>#recurrence=\"FREQ=MONTHLY;INTERVAL=3\"</code></li><li>Every 2 months on the First Sunday - <code>#recurrence=\"FREQ=MONTHLY;INTERVAL=2;BYDAY=1SU\"</code></li><li>Every month on the Last Friday - <code>#recurrence=\"FREQ=MONTHLY;INTERVAL=1;BYDAY=-1FR\"</code></li></ul><p>For other examples of valid <code>RRULE</code> strings see <a href=\"https://icalendar.org/rrule-tool.html\">https://icalendar.org/rrule-tool.html</a></p><p>Note that the recurrence string does not include the <code>DTSTART</code> attribute as defined in the iCAL specifications. This is derived directly from the <code>startDate</code> and <code>startTime</code> attributes</p><p>If you want to override the label the calendar uses to fetch the recurrence string, you can use the <code>#calendar:recurrence</code> attribute. For example, you can set <code>#calendar:recurrence=taskRepeats</code>. Then you can set your recurrence string like <code>#taskRepeats=\"FREQ=DAILY;INTERVAL=1\"</code></p><p>Also note that the recurrence label can be made promoted as with the start and end dates.&nbsp;</p><aside class=\"admonition warning\"><p>If the recurrence string is not valid, a toast will be shown with the note ID and title of the note with the erroneous recurrence message. This note will not be added to the calendar</p></aside><h2>Customizing the slot duration and label interval</h2><p>Time slots in day and week views can be customized from&nbsp;<a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a></p><ul><li><em>Slot duration</em> controls how tall each time slot is on the calendar (essentially the smallest unit of time the grid is divided into).<ul><li>A shorter duration means more rows and finer granularity; a longer one means fewer, chunkier rows.</li><li>The default is one row every 15 minutes.</li></ul></li><li><em>Label interval</em> controls how often a time label appears on the left-hand axis.<ul><li>This is independent of the slot size: you can have very small slots but only label every hour to keep the axis readable.</li><li>The default is a time label shown every hour.</li></ul></li></ul><aside class=\"admonition note\"><p>These values can also be customized directly via the <code>#calendar:slotDuration</code> and <code>#calendar:slotLabelInterval</code> <a href=\"#root/_help_HI6GBBIduIgv\">labels</a>. Both values use <code>HH:mm:ss</code> format. Hours can go up to <code>24</code> (<code>24:00:00</code>), while minutes and seconds must be between <code>00</code> and <code>59</code>. The minimum meaningful duration is 1 minute (<code>00:01:00</code>).</p></aside><h2>Use-cases</h2><h3>Using with the Journal / calendar</h3><p>It is possible to integrate the calendar view into the Journal with day notes. In order to do so change the note type of the Journal note (calendar root) to Collection and then select the Calendar View.</p><p>While in journal mode, the popup editor will not show dates, recurrence, colors or removal, since day notes aren't editable events.</p><p>Based on the <code>#calendarRoot</code> (or <code>#workspaceCalendarRoot</code>) attribute, the calendar will know that it's in a calendar and apply the following:</p><ul><li>The calendar events are now rendered based on their <code>dateNote</code> attribute rather than <code>startDate</code>.</li><li>Interactive editing such as dragging over an empty era or resizing an event is no longer possible.</li><li>Clicking on the empty space on a date will automatically open that day's note or create it if it does not exist.</li><li>Direct children of a day note will be displayed on the calendar despite not having a <code>dateNote</code> attribute. Children of the child notes will not be displayed.</li></ul><img src=\"{{helpAssets}}/User%20Guide/Collections/5_Calendar_image.png\" width=\"1217\" height=\"724\"><h3>Using a different attribute as event title</h3><p><img class=\"image-style-align-right\" src=\"{{helpAssets}}/User%20Guide/Collections/2_Calendar_image.png\" width=\"445\" height=\"124\">By default, events are displayed on the calendar by their note title. However, it is possible to configure a different attribute to be displayed instead.</p><p>To do so, assign <code>#calendar:title</code> to the child note (not the calendar/Collection note), with the value being <code>name</code> where <code>name</code> can be any label (make not to add the <code>#</code> prefix). The attribute can also come through inheritance such as a template attribute. If the note does not have the requested label, the title of the note will be used instead.</p><pre><code class=\"language-text-x-trilium-auto\">#startDate=2025-02-11 #endDate=2025-02-13 #name=\"My vacation\" #calendar:title=\"name\"</code></pre><h3>Using a relation attribute as event title</h3><p><img class=\"image-style-align-right image_resized\" style=\"aspect-ratio:294/151;width:21.22%;\" src=\"{{helpAssets}}/User%20Guide/Collections/3_Calendar_image.png\" width=\"294\" height=\"151\">Similarly to using an attribute, use <code>#calendar:title</code> and set it to <code>name</code> where <code>name</code> is the name of the relation to use.</p><p>Moreover, if there are more relations of the same name, they will be displayed as multiple events coming from the same note.</p><pre><code class=\"language-text-x-trilium-auto\">#startDate=2025-02-14 #endDate=2025-02-15 ~for=@John Smith ~for=@Jane Doe #calendar:title=\"for\"</code></pre><p><img class=\"image-style-align-left\" src=\"{{helpAssets}}/User%20Guide/Collections/Calendar_image.png\" width=\"296\" height=\"150\">Note that it's even possible to have a <code>#calendar:title</code> on the target note (e.g. “John Smith”) which will try to render an attribute of it. Note that it's not possible to use a relation here as well for safety reasons (an accidental recursion &nbsp;of attributes could cause the application to loop infinitely).</p><pre><code class=\"language-text-x-trilium-auto\">#calendar:title=\"shortName\" #shortName=\"John S.\"</code></pre><h3>Displaying an age on a recurring event</h3><p>A birthday or an anniversary repeats every year, and what is interesting about each occurrence is the number of years it marks. To display it:</p><ol><li>Set the event's start date to the original date (for example, the date of birth).</li><li>Click the event, then select the <em>Repeats</em> dropdown.</li><li>Select <em>Yearly</em> and check <em>Show the number of years in the title</em>.</li></ol><p>The event is then displayed as “John Smith (35)” in 2025, “John Smith (36)” in 2026, and so on. Only the calendar is affected; the note keeps its own title.</p><p>The checkbox sets the <code>#calendar:titleTemplate</code> label, which sets the title an event is displayed with and is filled in again for every occurrence the recurrence rule produces:</p><pre><code class=\"language-text-x-trilium-auto\">#startDate=1990-05-12 #recurrence=\"FREQ=YEARLY\" #calendar:titleTemplate=\"${title} (${years})\"</code></pre><p>To word the title differently, edit the label directly. The checkbox is then disabled, as it is when the template is inherited, so that it never overwrites a template of your own.</p><p>The following values can be used in the template:</p><figure class=\"table\"><table><thead><tr><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>${title}</code></td><td>The title the event would otherwise be displayed with: the note title, or the attribute <code>#calendar:title</code> points to.</td></tr><tr><td><code>${years}</code></td><td>The whole years between <code>#startDate</code> and the occurrence being displayed. It is <code>0</code> on the first occurrence.</td></tr><tr><td><code>${date}</code></td><td>The date of the occurrence being displayed, as a <a href=\"https://day.js.org/docs/en/display/format\">day.js</a> object. For example, <code>${date.format('YYYY')}</code>.</td></tr><tr><td><code>${startDate}</code></td><td>The date the event starts on, in the same form. For example, <code>${startDate.format('YYYY')}</code>.</td></tr></tbody></table></figure><p>To use the same template for every event of a calendar, make the label inheritable on the Collection note:</p><pre><code class=\"language-text-x-trilium-auto\">#calendar:titleTemplate(inheritable)=\"${title} (${years})\"</code></pre><aside class=\"admonition note\"><p>A template that cannot be read — an unknown value, or an expression other than a value and the <code>format</code> call shown above — leaves the event with its plain title and reports the reason in the browser console.</p></aside>",
++ "_help_2FvYrpmOXm29": "<figure class=\"image\"><img style=\"aspect-ratio:1050/259;\" src=\"{{helpAssets}}/User%20Guide/Collections/Table_image.png\" width=\"1050\" height=\"259\"></figure><p>The table view displays information in a grid, where the rows are individual notes and the columns are&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>. In addition, values are editable.</p><h2>How it works</h2><p>The tabular structure is represented as such:</p><ul><li>Each child note is a row in the table.</li><li>If child rows also have children, they will be displayed under an expander (nested notes).</li><li>Each column is a <a href=\"#root/_help_OFXdgB2nNk1F\">promoted attribute</a> that is defined on the Collection note.<ul><li>Actually, both promoted and unpromoted attributes are supported, but it's a requirement to use a label/relation definition.</li><li>The promoted attributes are usually defined as inheritable in order to show up in the child notes, but it's not a requirement.</li></ul></li><li>If there are multiple attribute definitions with the same <code>name</code>, only one will be displayed.</li><li>If an attribute definition has multiple values, they will all be grouped under a single column, with chips indicating individual values.</li></ul><p>There are also a few predefined columns:</p><ul><li>The current item number, identified by the <code>#</code> symbol.<ul><li>This simply counts the note and is affected by sorting.</li></ul></li><li><a class=\"reference-link\" href=\"#root/_help_m1lbrzyKDaRB\">Note ID</a>, representing the unique ID used internally by Trilium</li><li>The title of the note.</li></ul><h2>Interaction</h2><h3>Creating a new table</h3><p>Right click on an existing note in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and select <em>Insert child note</em> → <em>Collection</em> → <em>Table</em>.</p><h3>Adding columns</h3><p>Each column is a <a href=\"#root/_help_OFXdgB2nNk1F\">promoted or unpromoted attribute</a> that is defined on the Collection note.</p><p>To create a new column, either:</p><ul><li>Press <em>Add new column</em> at the bottom of the table.</li><li>Right click on an existing column and select Add column to the left/right.</li><li>Right click on the empty space of the column header and select <em>Label</em> or <em>Relation</em> in the <em>New column</em> section.</li></ul><h3>Adding new rows</h3><p>Each row is actually a note that is a child of the Collection note.</p><p>To create a new note, either:</p><ul><li>Press <em>Add new row</em> at the bottom of the table.</li><li>Right click on an existing row and select <em>Insert row above, Insert child note</em> or <em>Insert row below</em>.</li></ul><p>By default it will try to edit the title of the newly created note.</p><p>Alternatively, the note can be created from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;or <a href=\"#root/_help_CdNpE2pqjmI6\">scripting</a>.</p><h3>Context menu</h3><p>There are multiple menus:</p><ul><li>Right clicking on a column, allows:<ul><li>Sorting by the selected column and resetting the sort.</li><li>Hiding the selected column or adjusting the visibility of every column.</li><li>Adding new columns to the left or the right of the column.</li><li>Editing the current column.</li><li>Deleting the current column.</li></ul></li><li>Right clicking on the space to the right of the columns, allows:<ul><li>Adjusting the visibility of every column.</li><li>Adding new columns.</li></ul></li><li>Right clicking on a row, allows:<ul><li>Opening the corresponding note of the row in a new tab, split, window or quick editing it.</li><li>Inserting a new note above or below the selected row. These options are only enabled if the table is not sorted.</li><li>Inserting a new child note for the selected row.</li><li>Deleting the row.</li></ul></li></ul><h3>Editing data</h3><p>Simply click on a cell within a row to change its value. The change will not only reflect in the table, but also as an attribute of the corresponding note.</p><ul><li>The editing will respect the type of the promoted attribute, by presenting a normal text box, a number selector or a date selector for example.</li><li>It also possible to change the title of a note.</li><li>Editing relations is also possible<ul><li>Simply click on a relation and it will become editable. Enter the text to look for a note and click on it.</li><li>To remove a relation, remove the title of the note from the text box and click outside the cell.</li></ul></li></ul><h3>Editing columns</h3><p>It is possible to edit a column by right clicking it and selecting <em>Edit column…</em> This will basically change the label/relation definition at the collection level.</p><p>If the <em>Name</em> field of a column is changed, this will trigger a batch operation in which the corresponding label/relation will be renamed in all the children.</p><h3>Read-only tables</h3><p>On a <a href=\"#root/_help_CoFPLs3dRlXc\">read-only</a> table, the cells can't be edited and the rows can't be dragged. The <em>New row</em> and <em>New column</em> buttons are hidden, and the context menus offer only what leaves the notes as they are: sorting and hiding columns, and opening the notes. Columns can still be resized and reordered, but the layout isn't saved. The <em>Table properties</em> dialog isn't available.</p><h2>Working with the data</h2><h3>Sorting by column</h3><p>By default, the order of the notes matches the order in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>. However, it is possible to sort the data by the values of a column:</p><ul><li>To do so, simply click on a column.</li><li>To switch between ascending or descending sort, simply click again on the same column. The arrow next to the column will indicate the direction of the sort.</li><li>To disable sorting and fall back to the original order, right click any column on the header and select <em>Clear sorting.</em></li></ul><h3>Reordering and hiding columns</h3><ul><li>Columns can be reordered by dragging the header of the columns.</li><li>Columns can be hidden or shown by right clicking on a column and clicking the item corresponding to the column.</li></ul><h3>Reordering rows</h3><p>Notes can be dragged around to change their order. To do so, move the mouse over the three vertical dots near the number row and drag the mouse to the desired position.</p><p>This will also change the order of the note in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</p><p>Reordering does have some limitations:</p><ul><li>If the parent note has <code>#sorted</code>, reordering will be disabled.</li><li>If using nested tables, then reordering will also be disabled.</li><li>Currently, it's possible to reorder notes even if column sorting is used, but the result might be inconsistent.</li></ul><h3>Nested trees</h3><p>If the child notes of the collection also have their own child notes, then they will be displayed in a hierarchy.</p><p>Next to the title of each element there will be a button to expand or collapse. By default, all items are expanded.</p><p>Since nesting is not always desirable, it is possible to limit the nesting to a certain number of levels or even disable it completely. To do so, go to <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> → <em>Table properties</em> and set <em>Maximum nesting depth</em> (under the <em>Included notes</em> section), or set the <code>#maxNestingDepth</code> <a href=\"#root/_help_HI6GBBIduIgv\">label</a> of the collection:</p><ul><li><code>0</code> disables nesting, showing only the children of the collection.</li><li><code>1</code> also shows their children, <code>2</code> the level below that, and so on.</li><li>Removing the label shows every level again.</li></ul><p>Limitations:</p><ul><li>While in this mode, it's not possible to reorder notes.</li></ul><h2>Limitations</h2><ul><li>There is no support to filter the rows by a certain criteria. Consider using the table view in search for that use case.</li></ul><h2>Use in search</h2><p>The table view can be used in a&nbsp;<a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a>&nbsp;by adding the <code>#viewType=table</code> attribute.</p><p>Unlike when used in a Collection, saved searches are not limited to the sub-hierarchy of a note and allows for advanced queries thanks to the power of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>.</p><p>However, there are also some limitations:</p><ul><li>It's not possible to reorder notes.</li><li>It's not possible to add a new row.</li></ul><p>Columns are supported, by being defined as&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a>&nbsp;note.</p><p>Editing is also supported.</p>",
++ "_help_CtBQqbwXDx1w": "<p>The Board view lets you arrange subnotes as cards on a <a href=\"https://en.wikipedia.org/wiki/Kanban_board\">Kanban board</a>.</p><h2>Creating a Kanban board</h2><p>Right-click an existing note in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, select <em>Insert child note</em> → <em>Collection</em> → <em>Kanban Board</em>.</p><h2>How it works</h2><p>When you first create a collection of the <em>Board</em> type, a few subnotes are created, each with a <code>#status</code> label set. The board then groups each note by the value of its status attribute.</p><p>Notes are displayed recursively, so even grandchildren and more deeply nested notes will be displayed. However, unlike the&nbsp;<a class=\"reference-link\" href=\"#root/_help_2FvYrpmOXm29\">Table</a>, the notes are not displayed hierarchically.</p><p>To limit how deep the board looks, go to <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> → <em>Board properties</em> and set <em>Maximum nesting depth</em> (under the <em>Included notes</em> section), or apply the <code>#maxNestingDepth</code> label to the board note: <code>0</code> shows only the children, <code>1</code> adds their children, and so on. Without a value, every level is shown.</p><h2>Working with columns</h2><h3>Creating columns</h3><p>You can create a new column by pressing the <span class=\"tn-icon bx bx-plus\"></span> <em>Add column</em> button located after the last column.</p><p>Enter the new name (which must not match another column), optionally select an icon by pressing the circle at the start of the text box, and then press the (+) button or <kbd>Enter</kbd>. Click or tap outside the text box, or press <kbd>Esc</kbd>, to dismiss it.</p><p>Columns can also be added from a context menu:</p><ul><li>To add a column at the end of the board, right-click an empty area of the board and select <span class=\"tn-icon bx bx-columns\"></span> <em>Add new column</em>.</li><li>To add a column next to an existing one, open its column menu and select <span class=\"tn-icon bx bx-columns\"></span> <em>Add new column</em> → <em>Before</em> (<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Enter</kbd>) or <em>After</em> (<kbd>Ctrl</kbd>+<kbd>Enter</kbd>).</li></ul><p>Once a board is set up, the <em>Add column</em> button can be hidden. To do so, go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> → <em>Board properties</em> and turn off <em>Show the \"Add column\" button</em> (under the <em>General</em> section), or apply the <code>#board:hideAddColumn</code> label to the board note. Columns can still be added from the context menus above.</p><h3>Reordering columns</h3><p>The order of the columns can be changed at any time. There are several ways to do this:</p><ul><li><strong>Using touch or a mouse:</strong> Touch and hold the column header, or click and hold it with the mouse. Drag the column left or right until it reaches the desired location, and then release it.</li><li><strong>Using the keyboard:</strong> While the keyboard focus is anywhere inside the column, you can use these key combinations. If the column header itself is focused, you can omit <kbd>Alt</kbd>:<ul><li><kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>Right</kbd>: Move the column to the right.</li><li><kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>Left</kbd>: Move the column to the left.</li><li><kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>Home</kbd>: Make it the first column.</li><li><kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>End</kbd>: Make it the last column.</li></ul></li><li><em>Using the column menu:</em> Open the column menu and use the&nbsp;<span class=\"tn-icon bx bx-horizontal-left\"></span> <em>Move column</em> submenu.</li></ul><h3>Renaming and recoloring columns</h3><p>To change the name of a column, open the column menu and select&nbsp;<span class=\"tn-icon bx bx-edit-alt\"></span> <em>Rename column</em>, or press <kbd>F2</kbd> while the column header is selected.</p><p>From the same menu, you can tint the column with a different color by using the color palette at the bottom of the menu.</p><h3>Collapsing and expanding columns</h3><h4>Collapsing</h4><p>A column can be collapsed (minimized) to occupy less space on the screen and make the board look less cluttered. This is particularly useful for columns that are not frequently used, or when you want to focus on only a few columns and keep the rest out of sight.</p><p>To collapse a column:</p><ul><li><strong>Using a mouse:</strong> Double-click the column header.</li><li><strong>Using touch:</strong> Tap the column header, and then press the&nbsp;<span class=\"tn-icon bx bx-collapse-horizontal\"></span> button on the side toolbar.</li><li><strong>Using the keyboard:</strong> Focus the column header, and then press <kbd>Space</kbd>.</li></ul><p>Alternatively, you can use the&nbsp;<span class=\"tn-icon bx bx-collapse-horizontal\"></span> <em>Collapse column</em> command from the column menu.</p><p>Once a column is collapsed, its cards are no longer visible, but the column can still receive cards from other columns:</p><ul><li><strong>Drop cards onto a collapsed column:</strong> The cards will be moved to the column (at the bottom if manual sorting is enabled).</li><li><strong>Hold cards over a collapsed column for a few seconds:</strong> The column will expand, allowing you to drop the cards at the desired position (if manual sorting is enabled) or peek at the other cards before deciding whether to drop them.</li><li><strong>Move a card to a collapsed column using the keyboard:</strong> The column will temporarily expand to reveal the moved card. You can then continue moving the selected cards up or down, or to another column.</li></ul><p>Collapsed columns can still be reordered, and their menus remain available.</p><p>A collapsed column shows its title vertically, read from the bottom up. If any column title on the board contains Chinese, Japanese or Korean characters, the titles of all collapsed columns read from the top down instead, so that those characters stay upright.</p><h4>Expanding</h4><p>You can restore a collapsed column so that its content is visible again in the following ways:</p><ul><li><strong>Using a mouse:</strong> Click the collapsed column.</li><li><strong>Using touch:</strong> Tap the collapsed column, and then press the&nbsp;<span class=\"tn-icon bx bx-expand-horizontal\"></span> button on the side toolbar.</li><li><strong>Using the keyboard:</strong> Move the focus to the collapsed column, and then press <kbd>Space</kbd>.</li></ul><h4>Keeping a column collapsed</h4><p>By default, once a column is expanded, it remains expanded. However, you can configure a column to collapse again after you finish working with it. To activate this behavior, open the column menu and check&nbsp;<span class=\"tn-icon bx bx-lock-alt\"></span> <em>Keep the column collapsed</em>.</p><p>A column configured to remain collapsed will expand like any other collapsed column, but only temporarily, until another column is focused.</p><h4>Collapsing and expanding all columns</h4><p>You can expand or collapse all columns at once by using the&nbsp;<span class=\"tn-icon bx bx-collapse-alt\"></span> (collapse) and&nbsp;<span class=\"tn-icon bx bx-expand-alt\"></span> (expand) buttons. On the desktop, these buttons are located at the bottom of the screen; on the mobile interface, they are in the header.</p><h3>Sorting cards within a column</h3><p>By default, the cards in a column are sorted manually by moving them up and down. You can also keep them sorted automatically, using customizable criteria for each column. To customize the sorting options, open the column menu → <em>Sort</em>. The following options are available:</p><ul><li><span class=\"tn-icon bx bx-collection\"></span>&nbsp;<em>Board's default</em>: Use the default sorting order (initially manual for new boards).</li><li><span class=\"tn-icon bx bx-move-vertical\"></span>&nbsp;<em>Manually</em>: Sort cards by manually moving them up and down.</li><li><span class=\"tn-icon bx bx-text\"></span>&nbsp;<em>Title</em>: Sort cards by title.</li><li><span class=\"tn-icon bx bx-calendar-plus\"></span>&nbsp;<em>Creation date &amp; time</em>: Sort cards by the creation date and time of the note represented by each card. If a card was created from an existing note, the date and time will match the original creation date and time of that note, not when the card was added to the board.</li><li>Any custom attribute: Any card attribute (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_zEY4DaJG4YT5\">Attributes</a>) can be used as a sorting criterion.</li><li><span class=\"tn-icon bx bx-sort-up\"></span>&nbsp;<em>Ascending</em>: Sort from smallest to largest (A to Z, 0 to 9, or oldest to newest).</li><li><span class=\"tn-icon bx bx-sort-down\"></span>&nbsp;<em>Descending</em>: Sort in reverse order, from largest to smallest.</li></ul><aside class=\"admonition important\"><p>The card order you set is preserved after you switch away from manual sorting. When you switch back to manual sorting, the cards will be in the same order in which you arranged them.</p></aside><h4>How card attributes are sorted</h4><p>When cards are sorted by an attribute, they are ordered according to the following rules:</p><figure class=\"table\"><table><thead><tr><th>Attribute type</th><th>Sort order (ascending)</th></tr></thead><tbody><tr><td>Text, Multi-line text, URL, Email, Phone</td><td>A to Z, 0 to 9</td></tr><tr><td>Number</td><td>lowest → greatest</td></tr><tr><td>Date, Date &amp; time</td><td>oldest → newest</td></tr><tr><td>Time</td><td>earliest hour (closest to 0) → latest hour (closest to 24)</td></tr><tr><td>Checkbox</td><td>unchecked → checked</td></tr><tr><td>Select</td><td>The order in which the options are declared.&nbsp;&nbsp;&nbsp;&nbsp; <br>For example, a select attribute declared with “Low”, “Medium”, and “High” options will be sorted as follows: Low → Medium → High.</td></tr><tr><td>Color</td><td>Grays → colors. Colors are ordered by their color-wheel <a href=\"https://en.wikipedia.org/wiki/Hue\">hue</a> angle (from 0° to 360°).</td></tr></tbody></table></figure><p>Relation attributes are ordered according to the title of the target note.</p><p>Cards with attributes that have no value set are always sorted at the end of the column, regardless of whether the sort order is ascending or descending. If an attribute holds more than one value, only the first value is used for sorting.</p><h4>Configuring the default sorting options</h4><p>Every new column uses the <em>Board's default</em> sorting option, which is initially set to manual sorting on new boards. However, the default can be changed to any other sorting criterion and direction. To configure it, go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> → <em>Board properties</em> → <em>Default card order</em> (under the <em>General</em> section).</p><p>Once the default is changed, all columns set to the <em>Board's default</em> sorting option will follow the new sorting options.</p><p>Columns using a sorting option other than <em>Board's default</em> will not be affected by the new default. To override all columns so that they use the default sorting options, use the <em>Reset sorting options to default for all columns</em> command in <em>Board properties</em>.</p><aside class=\"admonition warning\"><p>Using the <code>#sorted</code> attribute on Kanban boards <strong>is no longer recommended</strong>, because it applies to every column and prevents manual sorting. Instead, use <code>#board:sortColumns</code>, which is designed exclusively for board collections and can take one of the following values: <code>title</code>, <code>creationDate</code>, or <code>attr:_&lt;attribute name&gt;_</code>, for example, <code>#board:sortColumns=attr:dueDate</code>. Using the <code>#board:sortColumnsDescending</code> label will switch to descending order.</p></aside><h3>Setting a limit</h3><p>For each column, you can limit the number of cards it contains (also known as a WIP limit). Once the limit is exceeded, the column displays a visual warning to indicate that it is over its limit.</p><p>To enable the limit, go to the column menu →&nbsp;<span class=\"tn-icon bx bx-tachometer\"></span> <em>Set limit</em>, and then:</p><ul><li>Turn on the <em>Warn for exceeding the column capacity</em> toggle.</li><li>Enter the desired limit in the <em>Maximum number of cards in the column</em> text box.</li><li>Press the <em>Set limit</em> button.</li></ul><p>A column that has reached its limit can still accept new cards. Blocking new cards is not supported and most likely never will be, due to the way Trilium works: cards are regular notes, and the attributes used to group them into columns can be set from anywhere in the app, outside the board control. As a result, enforcing the limit would not be consistent.</p><h3>Archiving a column</h3><p>If you want to hide a column from the board without deleting it, you can archive it by opening the column menu →&nbsp;<span class=\"tn-icon bx bx-archive-in\"></span> <em>Archive column</em>. Archiving a column does not set the archived flag (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_MKmLg5x6xkor\">Archived Notes</a>) on the notes corresponding to its cards.</p><p>To show archived columns again, go to&nbsp;<span class=\"tn-icon bx bx-cog\"></span> <em>Collection options</em> and toggle&nbsp;<span class=\"tn-icon bx bx-archive-in\"></span> <em>Show archived notes</em>, or turn on <em>Show archived cards and columns</em> in <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> → <em>Board properties</em> (under the <em>Included notes</em> section). Archived columns will appear faded. To restore one, open its column menu and select&nbsp;<span class=\"tn-icon bx bx-archive-out\"></span> <em>Unarchive column</em>.</p><h3>Deleting a column</h3><p>You can delete a column by opening the column menu →&nbsp;<span class=\"tn-icon bx bx-trash\"></span> <em>Delete column</em>, or by pressing <kbd>Delete</kbd> when a column header is focused, and then confirming. This removes the column from the board and unsets the grouping attribute for each note represented by a card in that column. If the column contains cards, the confirmation also offers to delete their notes instead of keeping them.</p><p>The inbox column is not deleted this way. Its menu entry is&nbsp;<span class=\"tn-icon bx bx-trash\"></span> <em>Remove inbox column</em>, and <kbd>Delete</kbd> on its header hides the inbox without changing any card.</p><h3>The inbox column</h3><p>The inbox column is a special column containing cards that are not assigned to another column. It is particularly useful when you switch an existing collection containing child notes to a board collection. The inbox column turns all child notes into cards that you can quickly distribute among the other columns. It can also act as a backlog where you can keep new cards that might eventually become part of the board.</p><p>The inbox column is hidden by default. To show it, go to&nbsp;<span class=\"tn-icon bx bx-cog\"></span> <em>Collection options</em> and toggle <em>Show inbox column</em>. The inbox column is distinguishable by its transparent background. It is always the first column and cannot be moved. It does not support a card limit. Otherwise, it operates like a regular column: its title, icon, and color can be changed; it can be sorted manually or automatically; and it can be collapsed.</p><p>You can also show the inbox column by applying the <code>#board:showInbox</code> label (read more about&nbsp;<a class=\"reference-link\" href=\"#root/_help_zEY4DaJG4YT5\">Attributes</a>) to the board note.</p><p>Optionally, the inbox column can also list nested notes from the board collection's subtree. To enable this, open the column menu and check&nbsp;<span class=\"tn-icon bx bx-subdirectory-right\"></span> <em>Include nested notes</em>.</p><h3>Changing the width of columns</h3><p>There are three predefined widths for board columns: narrow (default), medium, and wide. To change the width, open the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> → <em>Board properties</em> → <em>Column width</em> (under the <em>General</em> section). This option applies to every column on the board, except in the mobile version.</p><p>The same option is also available through the <code>#board:columnWidth</code> label (read more about&nbsp;<a class=\"reference-link\" href=\"#root/_help_zEY4DaJG4YT5\">Attributes</a>) on the board note, which accepts “<code>narrow</code>”, “<code>medium</code>”, or “<code>wide</code>” as its value.</p><p>You can also redefine these three widths by using custom app CSS (read more about&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlhDUqhENtH7\">Custom app-wide CSS</a>) and assigning the desired pixel values as follows:</p><pre><code class=\"language-text-x-trilium-auto\">#trilium-app {\n --board-column-width-narrow: 275px;\n --board-column-width-medium: 325px;\n --board-column-width-wide: 400px;\n}</code></pre><h2>Working with cards</h2><h3>Creating a new card</h3><p>To create a new card, press the <span class=\"tn-icon bx bx-plus\"></span> <em>New card</em> button located at the bottom of each column. To create a new card above or below a specific card, right-click or hold that card, and then select&nbsp;<span class=\"tn-icon bx bx-list-plus bx-flip-vertical\"></span> <em>Insert new above</em> or&nbsp;<span class=\"tn-icon bx bx-list-plus\"></span> <em>Insert new below</em> from the context menu. Alternatively, press <kbd>Shift</kbd> + <kbd>Enter</kbd> to create a new card above the focused card, or <kbd>Enter</kbd> to create one below it.</p><p>Next, type the title of the new card, and then press the&nbsp;<span class=\"tn-icon bx bx-plus-circle\"></span> button or <kbd>Enter</kbd> to complete it. Tap or click anywhere outside the text box to dismiss it. You can also select a different icon and card template. To learn more about card templates, see Card templates (learn more about&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>).</p><p>After the card is created, you can tap or click it, or press <kbd>Space</kbd>, to edit the note content.</p><p>When using the&nbsp;<span class=\"tn-icon bx bx-plus\"></span> <em>New card</em> button, cards are always created at the end of the column. To create the card at the top of the column, right-click or hold the&nbsp;<span class=\"tn-icon bx bx-plus-circle\"></span> button and select&nbsp;<span class=\"tn-icon bx bx-vertical-top\"></span> <em>Create at top</em>. When using keyboard shortcuts, focus the column header and press <kbd>Enter</kbd> to create a new card at the start of the column, or <kbd>Shift</kbd> + <kbd>Enter</kbd> to create one at the end.</p><h3>Adding an existing note as a card</h3><p>Any note in your knowledge base can be represented as a card on a board. To add an existing note to your board, create a new card but do not enter a title. Instead, press the&nbsp;<span class=\"tn-icon bx bx-folder-open\"></span> button. Alternatively, use the&nbsp;<span class=\"tn-icon bx bx-folder-open\"></span> <em>Add an existing note as a card</em> command from the column menu.</p><p>In the dialog that opens, search for the note by name, and then press the <em>Add to column</em> button to insert it. Alternatively, you can drag any note from the tree and drop it at the desired position on the board.</p><p>If the target note is already in the board collection's subtree, it will already be listed in the <strong>inbox column</strong>.</p><aside class=\"admonition important\"><p>Notes added to the board are cloned, not duplicated. This means that changes to their titles, content, and attributes on the board are reflected in their original locations as well. Learn more about cloned notes.</p></aside><h3>Selecting multiple cards</h3><p>When working with a board, you may need to perform operations on multiple cards at once, such as moving them to another column, setting attributes or colors, deleting them, or archiving them.</p><p>You can select multiple cards in the following ways:</p><ul><li><strong>Using a mouse and keyboard:</strong><ul><li>To add a card to the selection, hold <kbd>Ctrl</kbd> and click the card. Repeat this for other cards until all the desired cards are selected. Clicking a selected card again while holding <kbd>Ctrl</kbd> will deselect it.</li><li>If the cards you want to select form a continuous sequence within a column, hold <kbd>Shift</kbd>, click the first card in the sequence, and then click the last card.</li><li>Press <kbd>Esc</kbd> to clear the selection.</li></ul></li><li><strong>On mobile:</strong><ol><li>To enter selection mode, tap the&nbsp;<span class=\"tn-icon bx bx-select-multiple\"></span> button at the top of the screen. A selection toolbar will appear in the header, displaying “0 cards selected”.</li><li>Tap the cards you want to select. If you tap a selected card again, it will be deselected. To select all cards in a column, press the&nbsp;<span class=\"tn-icon bx bx-list-check\"></span> button on the selection toolbar. To clear the selection, press the&nbsp;<span class=\"tn-icon bx bx-x\"></span> button.</li><li>Use the side toolbar to apply actions to the selected cards.</li></ol></li><li><strong>Using only the keyboard:</strong><ul><li>To add the currently focused card to the selection, press <kbd>Ctrl</kbd> + <kbd>Space</kbd>. Repeat this for the other cards you want to select. Pressing <kbd>Ctrl</kbd> + <kbd>Space</kbd> again on a selected card will deselect it.</li><li>To select a continuous sequence of cards within a column, hold <kbd>Shift</kbd> and use the <kbd>Up</kbd> and <kbd>Down</kbd> arrow keys to expand or shrink the selection.</li><li>To select every card in the column the focus is in, press <kbd>Ctrl</kbd> + <kbd>A</kbd>. The same action is available from the column menu, as <span class=\"tn-icon bx bx-selection\"></span> <em>Select all cards</em>.</li><li>Press <kbd>Esc</kbd> to clear the selection.</li></ul></li></ul><h3>Moving cards between columns</h3><p>To move one or more cards to another column, use one of the following methods:</p><h4>Using touch or a mouse</h4><p>Touch and hold the card, or click and hold it with the mouse, and then drag it to the desired column. If the column uses manual sorting, you can also position the card relative to the other cards.</p><aside class=\"admonition tip\"><p>To drag a card outside the board, for example to the note tree, another split, or another window, hold <kbd>Ctrl</kbd> and then start dragging.</p></aside><p>If the target column is collapsed, you can drop the card onto its header to move it into that column (at the end if manually sorted), without expanding it. However, if you want to reveal its cards before dropping, hold the card over the column for a few seconds; the column will then expand.</p><aside class=\"admonition tip\"><p><strong>You can quickly drop a card at the start or end of a column.</strong></p><p>Drop the card above the column while the “Drop as the first card” hint is displayed to make it the first card in that column. Alternatively, drop it below the column while the “Drop as the last card” hint is displayed to make it the last card.</p></aside><h4>Using the keyboard</h4><p>You can also use keyboard shortcuts to move the selected card or cards between columns:</p><ul><li><kbd>Ctrl</kbd> + <kbd>Right</kbd>: Move to the next column.</li><li><kbd>Ctrl</kbd> + <kbd>Left</kbd>: Move to the previous column.</li><li><kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>Right</kbd>: Move to the last column.</li><li><kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>Left</kbd>: Move to the first column.</li></ul><h4>Using the context menu</h4><p>To quickly move a card to another column, open the card's context menu and select the destination column. The menu lists the first seven columns; on a wider board, the remaining ones are grouped under <em>More…</em>.</p><h3>Reordering cards within a column</h3><p>Cards within a column can be freely reordered unless the column uses a sorting option other than manual. To reposition a card, drag it as described in the <strong>Moving cards between columns</strong> section and drop it at the desired position.</p><p>Alternatively, you can use keyboard shortcuts to move the selected card or cards:</p><ul><li><kbd>Ctrl</kbd> + <kbd>Up</kbd>: Move up.</li><li><kbd>Ctrl</kbd> + <kbd>Down</kbd>: Move down.</li><li><kbd>Ctrl</kbd> + <kbd>Home</kbd>: Move to the top of the column.</li><li><kbd>Ctrl</kbd> + <kbd>End</kbd>: Move to the end of the column.</li></ul><p>If multiple cards are selected, the keyboard shortcuts work only if the selection consists of a continuous sequence of cards.</p><h3>Editing a card</h3><p>Every card on a board is a regular note. To edit the note associated with a card, click or tap the card, or press <kbd>Space</kbd> when the card is selected. The note will open in a Quick Edit dialog, where you can modify it. You can also open the note in a new tab, split, or window by using the&nbsp;<span class=\"tn-icon bx bx-link-external\"></span> <em>Open note</em> submenu in the card's context menu. To open the note in a new tab on the desktop version, you can also click or tap the&nbsp;<span class=\"tn-icon bx bx-link-external\"></span> <em>Open note</em> menu item directly, without opening its submenu.</p><p>To change the title or icon of a card, use one of the following methods:</p><ul><li><strong>Using a mouse:</strong> Place the mouse pointer over the card, and then click the&nbsp;<span class=\"tn-icon bx bx-rename\"></span> button.</li><li><strong>On mobile:</strong> Hold the card until the side toolbar appears, and then tap the&nbsp;<span class=\"tn-icon bx bx-rename\"></span> button.</li><li><strong>Using the keyboard:</strong> Select a card, and then press <kbd>F2</kbd>.</li><li><em>Using the context menu:</em> Open the card's context menu and select&nbsp;<span class=\"tn-icon bx bx-rename\"></span> <em>Edit title &amp; icon</em>.</li></ul><p>You can then enter a new name and select another icon. To move the keyboard focus from the title field to the icon selector, press <kbd>Shift</kbd> + <kbd>Tab</kbd>. Click or tap anywhere outside the card, or press <kbd>Enter</kbd>, to apply the change. Press <kbd>Esc</kbd> to discard the changes.</p><p>Each card can be tinted with a different color. Open the card's context menu and select the desired color. If no color is assigned, the card inherits the column color.</p><aside class=\"admonition important\"><p>The title, icon, and color of a card are the same as those of the corresponding note. If that note exists in multiple locations in the tree, any change to its title, icon, or color on the board will apply in those locations as well, not only on the board.</p></aside><h3>Archiving a card</h3><p>A card can be hidden from the board without deleting it by using the&nbsp;<span class=\"tn-icon bx bx-archive-in\"></span> <em>Archive note</em> command from the card's context menu.</p><p>To show archived cards again, go to&nbsp;<span class=\"tn-icon bx bx-cog\"></span> <em>Collection options</em> and toggle&nbsp;<span class=\"tn-icon bx bx-archive-in\"></span> <em>Show archived notes</em>, or turn on <em>Show archived cards and columns</em> in <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> → <em>Board properties</em> (under the <em>Included notes</em> section). Archived cards will appear faded. To restore one, open its context menu and select&nbsp;<span class=\"tn-icon bx bx-archive-out\"></span> <em>Unarchive note</em>.</p><aside class=\"admonition warning\"><p>Archiving a card sets the <code>#archived</code> flag on its note. If the note exists in multiple locations in the tree, it will appear archived in those locations as well. Read more about&nbsp;<a class=\"reference-link\" href=\"#root/_help_MKmLg5x6xkor\">Archived Notes</a>.</p></aside><h3>Deleting a card</h3><p>You can remove one or more cards from the board and delete their associated notes by using the&nbsp;<span class=\"tn-icon bx bx-trash\"></span> <em>Delete note…</em> command from the card's context menu, or by pressing <kbd>Shift</kbd> + <kbd>Delete</kbd>. On mobile, hold the card until the side toolbar appears, and then tap the&nbsp;<span class=\"tn-icon bx bx-trash\"></span> button.</p><h4>Removing a card from the board without deleting the note</h4><p>To remove a card from the board's columns while keeping its note, open the card's context menu and select&nbsp;<span class=\"tn-icon bx bx-task-x\"></span> <em>Remove from column</em>, or press <kbd>Delete</kbd>. On mobile, hold the card until the side toolbar appears, and then tap the&nbsp;<span class=\"tn-icon bx bx-task-x\"></span> button.</p><p>This command is not available when the inbox column is enabled. Instead, drag the card to the inbox column to achieve the same result.</p><p>The note remains in the board collection but is not assigned to any column. To see it on the board again, enable the inbox column.</p><aside class=\"admonition note\"><p>Under the hood, removing a card simply unsets the note's grouping attribute.</p></aside><h3>Working with custom card attributes</h3><p>By default, the face of a card displays a minimal set of information: the title, icon, and color. In some cases, this may not provide enough useful information at a glance. You can extend the card to display extra information, called card attributes, such as a due date, priority, completion status, or any other information you need. Card attributes use the same principles as&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>.</p><h4>Creating a new attribute</h4><p>To create a new attribute, follow these steps:</p><ol><li>Go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> → <em>Board properties</em>, find the <em>Card attributes</em> section, and then press the&nbsp;<span class=\"tn-icon bx bx-plus\"></span> <em>Create a new attribute</em> button.</li><li>Enter a name for the attribute. This is the internal name used by Trilium, so do not use spaces or special characters.</li><li>Select a type (text, number, checkbox, and so on).</li><li>Set the display name. This is the name shown on the card.</li><li>Press <em>Save &amp; close</em>.</li></ol><aside class=\"admonition note\"><p>For each newly created attribute, Trilium creates an attribute definition on the board collection note. A card displays the attributes declared as inheritable on the board note, as well as any attribute the card gets a definition for from elsewhere, for example through&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>&nbsp;or another parent note it is cloned under. Attributes that only the cards define are listed after the board's own.</p></aside><p>Here is an example of the attributes you can define for a typical Kanban board used to track tasks:</p><figure class=\"table\"><table><thead><tr><th>Attribute name</th><th>Attribute type</th><th>Attribute display name</th></tr></thead><tbody><tr><td>dueDate</td><td>Date &amp; Time</td><td>Due date</td></tr><tr><td>priority</td><td>Select (options: Low, Medium, High, Urgent)</td><td>Priority</td></tr><tr><td>done</td><td>Checkbox</td><td>Done</td></tr></tbody></table></figure><h4>Modifying the values of custom attributes</h4><p>To set the value of a custom attribute, click or tap the card, and then enter or select the desired value in the dialog header.</p><p>For attributes of the “select” or “checkbox” type, you can quickly change the value by using the card's context menu under the <em>Attributes</em> section.</p><h4>Reordering, hiding, redefining, and deleting custom attributes</h4><p>Go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> → <em>Board properties</em>. Under the <em>Card attributes</em> section, you can:</p><ul><li>Hold the <strong>=</strong> handle shown beside an attribute, and then drag the item up or down to reorder the attributes. This determines the order in which the attributes are displayed on the card.</li><li>Turn off the toggle to hide an attribute from the card's face. The attribute remains available when you edit the card. For the current grouping attribute, the toggle is disabled.</li><li>Press the&nbsp;<span class=\"tn-icon bx bxs-edit\"></span> button to modify the definition of an attribute.</li><li>Press the&nbsp;<span class=\"tn-icon bx bx-trash\"></span> button to delete the attribute and all its values from every note in the board collection.</li></ul><p>Attributes that the cards get from a template or another parent note can be reordered and hidden here, but not modified or deleted. Edit them on the note that defines them.</p><p>If cards define an attribute with the same name but a different type or different select options, for example through two different templates, or if a card overrides the board's definition with its own, the attribute is marked <em>Multiple definitions</em>. Such an attribute is sorted as text and does not appear in the card's context menu.</p><h3>Managing card templates</h3><p>When you create a new card, Trilium offers four templates by default: <em>Text</em>, <em>Markdown</em>, <em>Canvas</em>, and <em>Spreadsheet</em>. You can customize this list to include other note types or custom templates with predefined placeholder content and prefilled card attributes.</p><p>To customize the card templates, go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> → <em>Board properties</em> and find <em>Card templates</em>. Here you can:</p><ul><li>Include a note type or note template already created in your knowledge base by pressing the&nbsp;<span class=\"tn-icon bx bx-list-plus\"></span> <em>Add existing template</em> button and then selecting the desired note type or template.</li><li>Create a new template by pressing the&nbsp;<span class=\"tn-icon bx bx-plus\"></span> <em>Create a new template</em> button. The template editor will open, where you can define the icon, title, default attribute values, and default content. The note template will be created as a child of the board collection.</li><li>Press the&nbsp;<span class=\"tn-icon bx bx-x\"></span> button to remove a template from the list. The template is removed only from the list, not deleted from your knowledge base. You can add it again using&nbsp;<span class=\"tn-icon bx bx-list-plus\"></span> <em>Add existing template</em>.</li><li>Press the&nbsp;<span class=\"tn-icon bx bx-dots-vertical-rounded\"></span> button to open a dropdown that lets you edit, open in a new window, duplicate, or delete a template. This button is visible only for custom note templates.</li><li>Hold the <strong>=</strong> handle shown beside a template, and then drag the item up or down to reorder the templates. This determines the order in which templates are listed in the template dropdown when you create a new card. You can move the most frequently used templates to the top for faster access.</li></ul><h3>Grouping cards</h3><p>On a board, cards are grouped into columns. The column to which a card belongs is determined by the value of the <strong>grouping attribute</strong>, which is a regular attribute of the card's note.</p><p>By default, boards use the <strong>Status</strong> attribute as the grouping attribute. When you move a card to a column called “Waiting on Customer”, the card's Status attribute is set to “Waiting on Customer”.</p><aside class=\"admonition note\"><p>Under the hood, the Status attribute is declared on the board collection note with the name <code>status</code>. It is a select-type attribute that is inheritable and promoted. Each select option becomes a column, and each new column created on the board extends the list of options.</p></aside><h4>Creating a new grouping attribute</h4><p>To quickly create a new grouping attribute:</p><ol><li>Open the&nbsp;<span class=\"tn-icon bx bx-category-alt\"></span> <em>Group by</em> dropdown in the board header and select&nbsp;<span class=\"tn-icon bx bx-plus\"></span> <em>Create a new attribute</em>.</li><li>Fill in the <em>Name</em> field. This is used internally by Trilium, so do not use spaces or special characters.</li><li>Enter the <em>Display name</em>. This is the attribute name shown in the dropdown list.</li><li>Press <em>Save &amp; close</em>.</li></ol><aside class=\"admonition tip\"><p>Because the grouping attribute is a regular card attribute, you can also create it in <em>Board properties</em>. Make sure you set the attribute type to “select”.</p></aside><h4>Switching the grouping attribute</h4><p>Switching the grouping attribute lets you view your cards by priority, category, or any other custom grouping attribute. You can switch the grouping attribute at any time by using the&nbsp;<span class=\"tn-icon bx bx-category-alt\"></span> <em>Group by</em> dropdown in the board header. You can also change it using the <code>#board:groupBy=&lt;_attribute name_&gt;</code> label.</p><aside class=\"admonition warning\"><p>The order of cards in manually sorted columns corresponds to their positions within the board collection subtree. This means that the card order is shared across all views, regardless of the grouping attribute. Reordering notes in one view will also reorder them in other views that use a different grouping attribute.</p></aside><h4>Deleting a grouping attribute</h4><p>To delete a grouping attribute, go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> → <em>Board properties</em>, find the attribute under the <em>Card attributes</em> section, and press the corresponding&nbsp;<span class=\"tn-icon bx bx-trash\"></span> button.</p><h4>Grouping by relations</h4><p>A more advanced use case is grouping by <a href=\"#root/_help_Cq5X6iKQop6R\">Relations</a>.</p><p>In this mode:</p><ul><li>The columns represent the <em>target notes</em> of a relation.</li><li>When creating a new column, you select a note instead of entering a column name.</li><li>The column icon matches the target note.</li><li>Moving notes between columns changes their relations.</li><li>Renaming an existing column changes the target note for all notes in that column.</li></ul><p>Using relations instead of labels has several benefits:</p><ul><li>The status or grouping of notes is visible outside the Kanban board, for example, on the&nbsp;<a class=\"reference-link\" href=\"#root/_help_bdUJEHsAPYQR\">Note Map</a>.</li><li>A column takes its title and icon from the target note, so renaming that note anywhere in the tree renames the column.</li></ul><p>To use relations for grouping:</p><ol><li><p>Create a Kanban board from scratch rather than from a template.</p></li><li><p>Assign <code>#viewType=board #hidePromotedAttributes</code> to emulate the default template.</p></li><li><p>Set <code>#board:groupBy</code> to the name of a relation, <strong>including the</strong> <code>~</code> <strong>prefix</strong> (for example, <code>~status</code>).</p></li><li><p>Optionally, use&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;to make changing the status within the note easier:</p><pre><code class=\"language-text-x-trilium-auto\">#relation:status(inheritable)=\"promoted,alias=Status,single\"</code></pre></li></ol><h2>Searching and filtering the board</h2><p>You can search for cards using the search box at the top of the board. Enter your keywords, and then press the&nbsp;<span class=\"tn-icon bx bx-search\"></span> button in the search field or press <kbd>Enter</kbd>. Only cards whose titles, content, or attribute values match the query will be displayed. Columns without results will be temporarily collapsed to make room for the matching cards. Press the&nbsp;<span class=\"tn-icon bx bx-x\"></span> button in the search field to clear the search and display all cards again.</p><h3>Advanced filtering</h3><p>If you need to refine the view to display only cards matching specific criteria beyond a regular text search, you can use Trilium's search query syntax. Here are some example queries:</p><p>Display only cards whose <strong>Priority</strong> attribute is set to “Low”:</p><pre><code class=\"language-text-x-trilium-auto\">#priority=Low</code></pre><p>Display only cards whose <strong>Issue Category</strong> is set to “Software” and whose <strong>Site</strong> is set to either “Office” or “Factory”:</p><pre><code class=\"language-text-x-trilium-auto\">#issueCategory=\"Software\" AND (#site=\"Office\" OR #site=\"Factory\")</code></pre><p>Display only cards with a <strong>Due Date</strong> in the next seven days that are not yet marked as <strong>Done</strong>:</p><pre><code class=\"language-text-x-trilium-auto\">#dueDate &gt;= TODAY AND #dueDate &lt;= TODAY+7 AND #!done</code></pre><p>The filter persists even after you close the tab. When you reopen the collection, the filter remains active until you clear the search query by using the&nbsp;<span class=\"tn-icon bx bx-x\"></span> button.</p><h2>Linking to a column or a card</h2><p>You can create a link that opens the board and points out a specific column or card. Open the column menu or the card’s context menu, select&nbsp;<span class=\"tn-icon bx bx-copy\"></span> <em>Copy reference</em>, and then paste the link where you need it.</p><p>In a text note, the pasted link displays the title, icon, and color of the column or card it points to. In a Markdown or code note, the plain link address is pasted instead. Opening the link scrolls the board to the column or card and focuses it. If the column belongs to a different grouping attribute, the board switches to that attribute first.</p><h2>Read-only boards</h2><p>A board marked as <a href=\"#root/_help_CoFPLs3dRlXc\">read-only</a> only shows its cards. It has no buttons to add a card or a column, column and card titles can't be renamed, and column icons can't be changed. Cards and columns can't be dragged, moved or deleted with the keyboard, and notes dragged in from the note tree aren't added. The context menus of a card or a column keep only the entries that change nothing, such as opening the note or <span class=\"tn-icon bx bx-copy\"></span> <em>Copy reference</em>, and the board's own menu doesn't open. The cards can still be grouped by another attribute, but the choice isn't saved, and no new grouping attribute can be created.</p>",
++ "_help_81SGnPGMk7Xc": "<figure class=\"image\"><img style=\"aspect-ratio:1561/1149;\" src=\"{{helpAssets}}/User%20Guide/Collections/Geo%20Map_image.png\" width=\"1561\" height=\"1149\"></figure><p>This note type displays the children notes on a geographical map, based on an attribute. It is also possible to add new notes at a specific location using the built-in interface.</p><h2>Features</h2><ul><li>Add markers on the map, which can be customized with icons, colors and text.</li><li>Search the notes already on the map, and look up places anywhere in the world.</li><li>Turn a place the map already shows into a marker by clicking it.</li><li>Draw paths, areas, rectangles and circles onto the map.</li><li>Display tracks on the map using <code>.gpx</code> files.</li><li>Show your own location on the map and follow it as you move.</li><li>3D view of the map, which displays buildings when using a vector map.</li></ul><h2>System requirements</h2><p>Starting with v0.105.0, the geomap uses MapLibre GL which requires WebGL v1 support. In general, most devices will support it because browsers/Electron can render it in software if needed.</p><p>If the map could not be drawn because WebGL could not be initialized, an error message will appear instead of the map (<em>This map can't be drawn because WebGL isn't available…</em>).</p><p>The button that shows your location is offered only when Trilium is reached over HTTPS, in the desktop application or in the mobile application. Browsers refuse to share the location of a device with a page served over plain HTTP, so on such a server the button does not appear.</p><h2>Interaction</h2><ul><li>At the top-left there is the search bar. It searches the notes already on the map, and it can also search for places online when you ask it to. While you move through the results of a search, a counter with previous (<span class=\"tn-icon bx bx-chevron-left\"></span>) and next (<span class=\"tn-icon bx bx-chevron-right\"></span>) buttons appears under it.</li><li>At the bottom-center there is a central toolbar which provides editing features: adding new markers on the map (<span class=\"tn-icon bx bx-pin\"></span>) and importing GPX tracks (<span class=\"tn-icon bx bx-trip\"></span>).</li><li>At the bottom-right there are the viewport items:<ul><li>Zoom in/out (<span class=\"tn-icon bx bx-plus-circle\"></span> / <span class=\"tn-icon bx bx-minus-circle\"></span>)<ul><li>On mobile these are hidden, use pinch to zoom instead.</li><li>On desktop, alternatively use the scroll wheel to adjust the zoom.</li></ul></li><li>A <span class=\"tn-icon bx bx-current-location\"></span> button that shows your location on the map and follows it (see <em>Going to your location</em> below).</li><li><span class=\"tn-icon bx bx-fullscreen\"></span> Full screen button which focuses the entire map onto the screen, while still allowing for edits.</li></ul></li><li>At the top-center (on desktop, or left-center on mobile and in split views) there are the drawing tools such as paths, areas, rectangles and circles.<ul><li>When the map is read-only, the toolbar is not shown.</li></ul></li></ul><h2>Creating a new geo map</h2><p>Right click on an existing note in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and select <em>Insert child note</em> → <em>Collection</em> → <em>Geo Map</em>.</p><p>By default the map will be empty and will show the entire world.</p><h2>Repositioning the map</h2><ul><li>Click and drag the map in order to move across the map.</li><li>Use the mouse wheel, two-finger gesture on a touchpad or the +/- buttons on the bottom-right to adjust the zoom.</li></ul><p>The position on the map and the zoom are saved inside the map note and restored when visiting again the note.</p><p>A map that has no position saved yet is framed around the markers it contains when you open it, so they are all in view without having to go looking for them. A map that contains no markers shows the whole world instead.</p><p>In practice this applies to maps whose markers were added externally, by a script or through&nbsp;<a class=\"reference-link\" href=\"#root/_help_pgxEVkzLl1OP\">ETAPI (REST API)</a>. When you add markers yourself you have already moved the map to reach the place you are marking, and that movement saves a position.</p><h2>Going to your location</h2><p>Press the <em>Show your location</em> (<span class=\"tn-icon bx bx-current-location\"></span>) button at the bottom-right of the map, beside the zoom buttons. The first time, the browser or the operating system asks whether Trilium may know where the device is. In the desktop application the operating system's location settings decide.</p><p>The map then moves to where the device is and marks it with a blue dot. A lighter circle around the dot shows how accurate the position is: a phone with GPS gives a dot on the street, while a computer located through its network connection can give a circle that covers a neighbourhood. The map follows the dot as it moves, and the button stays pressed while it does.</p><p>Dragging the map stops it from following. The dot stays and keeps moving, and pressing the button again brings the map back to it. Pressing the button while the map is following turns the dot off.</p><p>Click the dot to see its coordinates in the panel a searched place is shown in. From there the position can be kept as a marker (see <em>Keeping a place as a marker</em>). Clicking the lighter circle around the dot is a click on the map.</p><p>If the position cannot be found, a message says so and the button keeps waiting for one; press it again to stop. If you refuse the permission, the button is disabled until the map is opened again. To allow it after all, change the permission for Trilium in the browser or in the system's location settings.</p><p>Your position is not stored in the note, and Trilium does not send it anywhere on its own. Moving the map there does what any other pan or zoom does: the tile provider behind the map's style sees the coordinates of the area now on screen. The map does remember where you left it, as it does after any other movement, so a map you have taken to your location opens there the next time.</p><h2>Searching the map</h2><p>The search bar at the top-left of the map searches in two places. It always searches the notes that are already on the map. It can also search for places online, but only when you ask it to.</p><h3>Searching the notes already on the map</h3><p>Type in the search bar, and the notes on the map are matched by their title as you type. Accents are ignored, both in what you type and in the titles, so <code>zurich</code> finds <em>Zürich Hauptbahnhof</em>. Each word is searched for on its own, so <code>hotel paris</code> finds <em>Paris Hotel</em>. Notes without a <code>#geolocation</code> attribute are not offered, since there would be nowhere to go. Drawn shapes and GPS tracks are offered, even though they carry no such attribute: selecting one brings the whole shape or route into view.</p><p>If more notes match than the list can show, you are offered the ones closest to the area you are viewing.</p><h3>Searching for places online</h3><p>Looking up a place sends what you typed to a third-party service. For this reason, it never happens while you type. Instead, the last row of the result list offers the search. That row reads <em>Search online for \"…\"</em>, with the name of the service below it. The search runs only when you press that row or select it with Enter.</p><p>Trilium uses Nominatim, the place search run by the OpenStreetMap Foundation. It needs no account and no API key. Its name is shown on every row that belongs to it: the row that offers the search, the row that says a search is running, and the row that reports that nothing was found or that the service could not be reached.</p><p>The search prefers the area you are viewing. Places inside the current view are searched for first and listed above the others. If you search for a shop while looking at your own town, you therefore find the branch in that town, and not one with the same name on another continent. The view is always treated as at least 25 km across, so a search made while zoomed into a single street still covers the town around it.</p><h3>Going to a point</h3><p>If you type or paste coordinates into the search bar, a <em>Go to</em> row is offered above all the other results. Selecting it moves the map to that exact spot and marks it. You can then keep it as a marker, in the same way you keep a place found by searching.</p><p>Points are untitled by default; the corresponding note opens with the default name selected so it can be easily replaced. If the map has a&nbsp;<a class=\"reference-link\" href=\"#root/_help_47ZrP6FNuoG8\">Default Note Title</a>&nbsp;label, the marker is named by that template instead.</p><p>The supported forms are:</p><ul><li>A plain pair, such as <code>45.9432, 24.9668</code>. This is what Google Maps and OpenStreetMap both give you when you ask for the coordinates of a place, and it is also what the <code>#geolocation</code> attribute holds.</li><li>The <code>geo:</code> link that the map itself offers for a place, through the <em>Open location</em> action.</li><li>The address of a place on Google Maps or OpenStreetMap, pasted whole.</li></ul><p>A pair that is not a place on Earth, such as <code>1234, 5678</code>, is not offered.</p><h3>Reading the results</h3><p>Results are gathered under headings, and each group is ordered by distance from the middle of the map:</p><ul><li><em>On this map</em>: notes that are already on the map, whatever their distance.</li><li><em>Nearby</em>: places found within about 25 km of the view.</li><li><em>Far away</em>: all the other places.</li></ul><p>The headings only appear when at least two of the three groups contain something. Every row that has a position shows how far away it is, in kilometres or miles according to your locale. A place found online shows its name on the first line and its address on the second.</p><h3>Selecting a result</h3><p>Selecting a note already on the map moves to its marker and opens the note beside the map, as clicking the marker would.</p><p>Selecting a place found online moves the map to it and marks it with a temporary pin. The pin has a different color from the map's own markers. The map is fitted to the area that the place covers, so a country fills the view, while a house is shown at street level. Some places have a boundary, such as a country, a county or a park. When the service reports one, that boundary is outlined under the pin.</p><p>A panel then opens with the place's full address and its coordinates: in the top-right corner on desktop, and at the bottom of the map on mobile, where the top is kept for the search bar and the result counter. Pressing the coordinates copies them to the clipboard.</p><h3>Keeping a place as a marker</h3><p>Press <em>Add as marker</em> in that panel to keep the place. A child note is created under the map. It takes the name of the place, as well as the icon, which matches the kind of place it is. Its <code>#geolocation</code> attribute is already set. The note opens beside the map, so you can edit it straight away. The temporary pin disappears, because the place is now a marker like any other.</p><p>The button is not offered on a map that cannot be edited, where the panel can still be read.</p><p>Press the panel's close button, or the Escape key, to send the place away without keeping it. The pin goes with it.</p><h3>Stepping through the results</h3><p>Once you select a result, a counter appears under the search bar, with a previous (<span class=\"tn-icon bx bx-chevron-left\"></span>) and a next (<span class=\"tn-icon bx bx-chevron-right\"></span>) button. These buttons move through everything the search offered, in the order it was listed. You can therefore compare several results without opening the list again. Pressing the counter itself moves the map back to the current result, which is useful after you have moved the map away from it.</p><h3>The keyboard</h3><ul><li><kbd>Enter</kbd> runs the online search when its row is the one selected, and otherwise moves to the highlighted result. Pressed after a result has been taken, it brings the list back.</li><li><kbd>Escape</kbd> closes the result list, and closes the place panel.</li><li>Returning to the search bar reopens the list it was showing.</li><li>The <span class=\"tn-icon bx bx-x\"></span> button at the end of the bar empties it, which also takes a searched place, its pin and its panel off the map.</li></ul><h2>Adding a marker using the map</h2><h3>Adding a new note using the <em>Add marker</em> button</h3><ol><li><p>To create a marker, first navigate to the desired point on the map. Then press the <em>Add marker</em> (<span class=\"tn-icon bx bx-pin\"></span>) button at the center-bottom of the map.</p></li><li><p>Once pressed, the map will enter in the insert mode, as illustrated by the notification. Additionally, a preview of the marker will be shown at the cursor position.</p><p>Simply click the point on the map where to place the marker. To cancel, press either the &nbsp;Escape key or press again the <em>Add marker</em> button.</p></li><li><p>Once clicked, the marker will show up on the map and a popup will show to the right with the title already selected to be changed.</p></li></ol><h3>Adding a new note using the contextual menu</h3><ol><li>Right click anywhere on the map, where to place the newly created marker (and corresponding note).</li><li>Select <em>Add a marker at this location</em> (<span class=\"tn-icon bx bx-pin\"></span>).</li><li>Once clicked on a position on the map, the marker will show up on the map and a popup will show to the right with the title already selected to be changed.</li></ol><h3>Adding an existing note from the note tree</h3><ol><li>Select the desired note in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</li><li>Hold the mouse on the note and drag it to the map to the desired location.</li><li>The map should be updated with the new marker.</li></ol><p>This works for:</p><ul><li>Notes that are not part of the geo map, case in which a <a href=\"#root/_help_IakOLONlIfGI\">clone</a> will be created.</li><li>Notes that are a child of the geo map but not yet positioned on the map.</li><li>Notes that are a child of the geo map and also positioned, case in which the marker will be relocated to the new position.</li></ul><aside class=\"admonition note\"><p>Dragging existing notes only works if the map is in editing mode. See the <em>Read-only</em> section for more information.</p></aside><h3>Adding a note from a place the map already shows</h3><p>When a vector map style is used, the map itself draws the shops, cafés, museums and other places around the area being viewed. Once the map is zoomed in far enough for these to be drawn, they can be clicked:</p><ol><li>Look for the places drawn in orange. This is the same color used for a place found by searching. These are the places you can click. They are drawn almost solid, while the other places on the map stay a faint grey.</li><li>Rest the mouse on one of them. Its name appears above it, and the mouse cursor changes to a pointer. The map draws these places as icons without names, so you read a name by hovering over it. If all the names were shown at once, they would crowd out the titles of your own markers.</li><li>Click it. The same panel used for a place found by searching appears. It shows the name of the place and its coordinates, and a pin is placed on the map.</li><li>Press <em>Add as marker</em> to keep it. The note is created with the name of the place as its title, and with the icon that matches the kind of place it is.</li></ol><p>Places are read from the map data that has already been downloaded, so clicking one does not send anything to the internet.</p><p>Some things to keep in mind:</p><ul><li>Places with no name in the map data, such as benches or parking spaces, show no name and cannot be clicked. Clicking them does nothing, just like clicking an empty part of the map.</li><li>The map's own markers come first. If a marker covers a place, clicking it opens the note and not the place.</li><li>This does not work with the raster (OpenStreetMap) style, because its places are part of the map image. It also does not work with the <em>Neutrino</em> style, which draws no places.</li><li>In read-only mode you can still click a place and read it, but you cannot keep it as a marker.</li></ul><h2>How the location of the markers is stored</h2><p>The location of a marker is stored in the <code>#geolocation</code> attribute of the child notes:</p><p>This value can be added manually if needed. The value of the attribute is made up of the latitude and longitude separated by a comma.</p><p>On an image map, the position is stored in <code>#mapPosition</code> instead (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_ZRDXGc0nAIh4\">Image maps</a>).</p><h2>Repositioning markers</h2><p>Once a marker is set, it can be repositioned using one of the two ways:</p><ul><li>By right clicking the marker and selecting <em>Move to another location</em> (<span class=\"tn-icon bx bx-move\"></span>).</li><li>By clicking the marker to open the popup and selecting the <em>Move to another location</em> (<span class=\"tn-icon bx bx-move\"></span>) button underneath the title bar.</li></ul><p>After clicking the button to move the marker, click at the desired position on the map to replace it. To cancel the operation, press Escape.</p><aside class=\"admonition note\"><p>If the map is locked for editing (see below), the map needs to be unlocked before moving the marker.</p></aside><h2>Interaction with the markers, tracks or shapes</h2><ul><li>Hovering over a marker will display a&nbsp;<a class=\"reference-link\" href=\"#root/_help_lgKX7r3aL30x\">Note Tooltip</a>&nbsp;with the content of the note it belongs to.<ul><li>Clicking on the note title in the tooltip will navigate to the note in the current view.</li></ul></li><li>Right-clicking the marker will open a contextual menu (as described below).</li><li>Clicking a marker will focus on the marker and display a dedicated popup with the details. This works regardless of whether the map is editable or not.</li></ul><h3>Popup view</h3><p>When a marker, a <a href=\"#root/_help_C2H9HK4BzwG7\">shape</a>, or track is clicked, a popup will open to the right which contains the following information:</p><ul><li>The title and icon of the marker, both editable.</li><li>An indicator for the coordinates (<span class=\"tn-icon bx bx-crosshair\"></span>); clicking it will copy the coordinates to clipboard.</li><li>A <span class=\"tn-icon bx bx-expand-alt\"></span> button to maximize the popup.</li><li>Buttons to interact with the current item:<ul><li><span class=\"tn-icon bx bx-log-in\"></span> Open the marker in the same pane, or use <span class=\"tn-icon bx bx-dots-horizontal-rounded\"></span> to open it in a new tab, split, etc.</li><li>A <span class=\"tn-icon bx bx-map-alt\"></span> button to open the location in a dedicated application (e.g. Google Maps on mobile).</li><li><span class=\"tn-icon bx bx-palette\"></span> Color picker to change the color of the marker.</li><li><span class=\"tn-icon bx bx-move\"></span> Markers can also be moved, unlike tracks or shapes (which need to be redrawn).</li><li><span class=\"tn-icon bx bx-trash\"></span> Button to remove the marker from the map, which can optionally delete its corresponding note.<ul><li>Removing a marker without deleting the note will only remove its <code>#geolocation</code> attribute (case in which the coordinates have to be manually added back in in order to get the note to show on the map again).</li><li>Similarly, removing a shape will remove its <code>#geoShape</code> attribute.</li></ul></li></ul></li><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;of the marker, if any.</li><li>The note's content which can be edited directly from the panel.</li></ul><p>To dismiss the popup:</p><ul><li>Press the X button at the top-right of the popup.</li><li>In the map, press anywhere outside the popup.</li><li>Or simply press the Escape key.</li></ul><p>When a marker is clicked, the map will automatically adjust the viewport so that the marker is still visible with the popup open. The currently selected marker is shown slightly bigger.</p><p>It is possible to switch between markers by clicking on them even when the popup view is already open.</p><p>Markers can have&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;between them and clicking on such a link will automatically adjust the viewport and the popup view to the new note.</p><h3>Contextual menu</h3><p>It's possible to press the right mouse button to display a contextual menu.</p><ol><li>If right-clicking an empty section of the map (not on a marker), it allows to:<ol><li><span class=\"tn-icon bx bx-crosshair\"></span> Displays the latitude and longitude. Clicking this option will copy them to the clipboard.</li><li><span class=\"tn-icon bx bx-map-alt\"></span> Open the location using an external application (if the operating system supports it).</li><li><span class=\"tn-icon bx bx-pin\"></span> Adding a new marker at that location.</li></ol></li><li>If right-clicking on a marker, it allows to:<ol><li><span class=\"tn-icon bx bx-crosshair\"></span> Displays the latitude and longitude. Clicking this option will copy them to the clipboard.</li><li><span class=\"tn-icon bx bx-map-alt\"></span> Open the location using an external application (if the operating system supports it).</li><li>Open the note in a new tab, split or window.</li><li><span class=\"tn-icon bx bx-move\"></span> Move the marker to another location.</li><li><span class=\"tn-icon bx bx-trash\"></span> Button to remove the marker from the map, which can optionally delete its corresponding note. Removing a marker without deleting the note will only remove its <code>#geolocation</code> attribute (case in which the coordinates have to be manually added back in in order to get the note to show on the map again).</li></ol></li><li>Shapes can also be right-clicked and the menu is similar to markers except they cannot be moved.</li></ol><h3>Icon and color</h3><figure class=\"image image-style-align-right image_resized\" style=\"width:47.42%;\"><img style=\"aspect-ratio:885/321;\" src=\"{{helpAssets}}/User%20Guide/Collections/3_Geo%20Map_image.png\" width=\"885\" height=\"321\"></figure><p>The markers will have the same icon as the note.</p><p>It's possible to add a custom color to a marker by assigning them a <code>#color</code> attribute such as <code>#color=green</code>.</p><p>This also applies to tracks and <a href=\"#root/_help_C2H9HK4BzwG7\">shapes</a>.</p><aside class=\"admonition note\"><p>The color as it will be displayed on the map might be slightly tinted in order to make the text or icon more legible.</p></aside><h3>Adding the coordinates manually</h3><p>Searching for the place is usually quicker (see <em>Searching the map</em> above). The steps below remain useful for a coordinate that is already to hand, or for a place the search cannot find.</p><p>In a nutshell, create a child note and set the <code>#geolocation</code> attribute to the coordinates.</p><p>The value of the attribute is made up of the latitude and longitude separated by a comma.</p><h4>Adding from Google Maps</h4><ol><li>In Google Maps, on the web:<ol><li>Look for a desired location, right click on it and a context menu will show up.</li><li>Simply click on the first item displaying the coordinates and they will be copied to clipboard.</li></ol></li><li>In Trilium, create a child note under the map.</li><li>Then paste the value inside the text box into the <code>#geolocation</code> attribute of a child note of the map (don't forget to surround the value with a <code>\"</code> character).</li></ol><h4>Adding from OpenStreetMap</h4><p>Similarly to the Google Maps approach:</p><ol><li>Go to any location on openstreetmap.org and right click to bring up the context menu. Select the <em>Show address</em> item.</li><li>The address will be visible in the top-left of the screen, in the place of the search bar.&nbsp;Select the coordinates and copy them into the clipboard.</li><li>Simply paste the value inside the text box into the <code>#geolocation</code> attribute of a child note of the map and then it should be displayed on the map.</li></ol><h2>Drawing shapes on the map</h2><p>See the dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_C2H9HK4BzwG7\">Drawing shapes</a>&nbsp;page.</p><h2>Using an image instead of the world map</h2><p>A geo map can be drawn over an image of your own, such as a floor plan or a fantasy map, with markers placed in the image's pixels. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_ZRDXGc0nAIh4\">Image maps</a>.</p><h2>Adding GPS tracks (.gpx)</h2><figure class=\"image\"><img style=\"aspect-ratio:1566/1155;\" src=\"{{helpAssets}}/User%20Guide/Collections/1_Geo%20Map_image.png\" width=\"1566\" height=\"1155\"></figure><p>Trilium can display GPS tracks on the geo map, in the form of <code>.gpx</code> files.</p><p>To add a track, either:</p><ol><li>Drag &amp; drop a <code>.gpx</code> file inside the geo map in the note tree.<ol><li>In order for the file to be recognized as a GPS track, it needs to show up as <code>application/gpx+xml</code> in the <em>File type</em> field.</li></ol></li><li>Press the <em>Add a GPS track from a GPX file</em> (<span class=\"tn-icon bx bx-trip\"></span>) button which will directly prompt for a GPX file and import it as a subnote of the collection.</li></ol><p>When going back to the map, the track should now be visible.</p><p>The starting point of the track will be displayed as a marker, with the name of the note underneath. The start marker will also respect the icon and the <code>color</code> of the note. The end marker is displayed with a distinct icon.</p><p>If the track file contains multiple tracks, they will all be displayed as well as markers. Trilium will also split a single track that happens to have non-continuous points.</p><p>If the GPX contains waypoints, they will also be displayed, including their names.</p><p>When the track is clicked, the entire route is brought into view, as well as the right popup will indicate details about the track such as distance, duration and the elevation map. This information is also displayed when clicking the <code>.gpx</code> note itself.</p><p>When clicking on the markers of a track (whether it's the start or stop builtin markers, or custom markers that are part of the track), only that marker is brought into view, as opposed to the entire route.</p><h2>Read-only mode</h2><p>When a map is <a href=\"#root/_help_CoFPLs3dRlXc\">read-only</a> all editing features will be disabled such as:</p><ul><li>The <em>Add marker</em> (<span class=\"tn-icon bx bx-pin\"></span>) button at the bottom of the map.</li><li>Repositioning markers.</li><li>Editing from the contextual menu (removing locations or adding new items).</li><li>Keeping a place as a marker, whether you found it by searching or clicked it on the map. You can still search and click, and you can still look at a place and copy its coordinates.</li><li>Drawing <a href=\"#root/_help_C2H9HK4BzwG7\">shapes</a>.</li><li>The <em>Geo map properties</em> dialog; its entry is hidden from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>.</li></ul><p>To set a map as read-only, go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>&nbsp;→ <em>Editable</em> → <em>Read-only</em>.</p><h2>Configuration</h2><h3>Map Style</h3><p>The styling of the map can be adjusted in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>, under <em>Background</em> in the <em>Geo map properties</em> dialog, or manually via the <code>#map:style</code> attribute.</p><p>The geo map comes with two different types of styles:</p><ul><li>Raster styles<ul><li>For these styles the map is represented as a grid of images at different zoom levels. This is the traditional way OpenStreetMap used to work.</li><li>Zoom is slightly restricted.</li><li>Currently, the only raster theme is the original OpenStreetMap style.</li></ul></li><li>Vector styles<ul><li>Vector styles are not represented as images, but as geometrical shapes. This makes the rendering much smoother, especially when zooming and looking at the building edges, for example.</li><li>The map can be zoomed in much further.</li><li>These come in various styles that are both light (Colorful, Graybeard, Neutrino) and dark (Eclipse, Shadow).</li><li>The vector styles come from <a href=\"https://versatiles.org/\">VersaTiles</a>, a free and open-source project providing map tiles based on OpenStreetMap.</li><li>The VersaTiles layers also provide 3D building information (see below).</li></ul></li></ul><p>The default theme is Versatiles Colorful (vector).</p><h4>3D view with buildings</h4><figure class=\"image\"><img style=\"aspect-ratio:2727/1642;\" src=\"{{helpAssets}}/User%20Guide/Collections/2_Geo%20Map_image.png\" width=\"2727\" height=\"1642\"></figure><p>Trilium v0.105.0 introduces a 3D view, courtesy of MapLibre GL. To enter 3D mode, simply press the <em>3D</em> button at the bottom-right of the map or press Ctrl and drag across the map.</p><p>The buildings will only appear from zoom 14 onwards to avoid lag.</p><aside class=\"admonition note\"><p>To get 3D buildings, make sure you are using the <em>VersaTiles</em> styles which provide the building informatia via the <code>versatiles-shortbread</code> source.</p></aside><h3>Custom map style / tiles</h3><p>Starting with v0.102.0 it is possible to use custom tile sets, but only in raster format.</p><p>To use one:</p><ol><li>Open the <em>Geo map properties</em> dialog from the <a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>.</li><li>Under <em>Background</em>, set <em>Type</em> to <em>Custom tileset</em>.</li><li>In <em>Tile URL</em>, enter the address of the tile set, with <code>{z}</code>, <code>{x}</code> and <code>{y}</code> where the zoom level and the position of the tile go. For example, to use Esri.NatGeoWorldMap, enter <a href=\"https://server.arcgisonline.com/ArcGIS/rest/services/NatGeo_World_Map/MapServer/tile/%7Bz%7D/%7By%7D/%7Bx%7D\"><code>https://server.arcgisonline.com/ArcGIS/rest/services/NatGeo_World_Map/MapServer/tile/{z}/{y}/{x}</code></a>. The URL is saved once you leave the field; a URL that doesn't start with <code>http://</code> or <code>https://</code>, or that lacks one of the three placeholders, is not saved. A map drawn over an image keeps its image until a URL is saved.</li><li>If the tiles are dark, turn on <em>Dark tileset</em>, which draws the marker titles in a light color so that they remain readable.</li></ol><p>Additionally:</p><ul><li>Hi-DPI tiles are supported via the <code>{r}</code> placeholder.</li><li>Servers that number their tiles by quadkey are supported via the <code>{quadkey}</code> placeholder, in place of <code>{z}</code>, <code>{x}</code> and <code>{y}</code>.</li></ul><p>To go back to a built-in style, set <em>Type</em> back to <em>Vector &amp; Raster</em>. The tile set is switched off rather than removed: its label is renamed to <code>#disabled:map:style</code>, so setting <em>Type</em> to <em>Custom tileset</em> again brings back the same URL. A tile set inherited from a parent note or a template is overridden by the default style instead.</p><p>The tile set can also be set manually: the URL goes in the <code>#map:style</code> <a href=\"#root/_help_HI6GBBIduIgv\">label</a>, and the <code>#map:darkStyle</code> label marks it as dark. <code>#map:darkStyle</code> also overrides the built-in styles.</p><aside class=\"admonition note\"><p>For a list of tile sets, see the <a href=\"https://leaflet-extras.github.io/leaflet-providers/preview/\">Leaflet Providers preview</a> page. Select a desired tile set and just copy the URL from the <em>Plain JavaScript</em> example.</p></aside><p>Custom vector map support is planned, but not yet implemented.</p><h3>Other options</h3><p>The following options can be configured either via the&nbsp;<a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>, by clicking on the settings (<span class=\"tn-icon bx bx-cog\"></span>) button. Alternatively, each of these options also have a corresponding <a href=\"#root/_help_HI6GBBIduIgv\">label</a> that can be set manually.</p><ul><li>Scale, which illustrates the scale of the map in either kilometers or miles in the bottom-left of the map.<ul><li>The unit is determined by the <em>Formatting locale</em> option in <em>Language &amp; Region</em>.</li></ul></li><li>The name of the markers is displayed by default underneath the pin on the map. Since v0.102.0, it is possible to hide these labels which increases the performance and decreases clutter when there are many markers on the map.</li><li>v0.105.0 also introduces a feature called <em>Group nearby markers</em> which will cluster multiple markers together at low zoom.<ul><li>The clusters display the number of items they contain. The color also changes based on the count.</li><li>Clicking on a cluster will automatically zoom in so that the individual markers that make up the cluster are now visible.</li></ul></li></ul><p>The same options are also listed under <em>General</em> in the <span class=\"tn-icon bx bx-cog\"></span><em>Geo map properties</em> dialog, opened from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> or from the settings menu of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>. Its <em>Included notes</em> section sets whether archived notes are shown and the <em>Maximum nesting depth</em> (see below), and its <em>Background</em> section holds the map style, the URL of a custom tile set when <em>Type</em> is set to <em>Custom tileset</em> (see above), or, with <em>Type</em> set to <em>Custom image</em>, draws the map over an image of your own instead, as described in&nbsp;<a class=\"reference-link\" href=\"#root/_help_ZRDXGc0nAIh4\">Image maps</a>.</p><p>The map shows the notes of its whole subtree, not only its children. <em>Maximum nesting depth</em> (<code>#maxNestingDepth</code>) limits how deep below the map it looks: <code>0</code> shows only the children, <code>1</code> adds their children, and so on. Without a value, every level is shown.</p>",
++ "_help_C2H9HK4BzwG7": "<p>The following shapes can be drawn on the map: a path, an area, a rectangle or a circle.</p><p>Unlike markers, the title of the shape is not displayed directly on the map but it will be displayed when hovered.</p><p>The shape will also be drawn in the <a href=\"#root/_help_p9kXRFAkwN4o\">color of the note</a>, if set.&nbsp;</p><h2>Drawing a shape on the map</h2><p>To draw a shape, use the toolbar that appears in the top-center area on desktop and on the left-center on mobile and in split view.</p><p>Once a shape is drawn, it cannot be moved or modified. To do so, simply remove the shape and draw another one instead.</p><h3>Drawing a path or an area</h3><ol><li>Press the <em>Draw a path on the map</em> (<span class=\"tn-icon bx bx-vector\"></span>) or <em>Draw an area on the map</em> (<span class=\"tn-icon bx bx-shape-polygon\"></span>) button. The button stays held down while the tool is armed, and a notification describes what to do.</li><li>Click on the map once for each point. The shape is previewed as it grows.</li><li>Finish it by pressing <kbd>Enter</kbd>. A path can also be finished by clicking its last point again, and an area by clicking the corner it started from. A path needs at least two points and an area at least three.</li></ol><h3>Drawing a rectangle or a circle</h3><ol><li>Press the <em>Draw a rectangle on the map</em> (<span class=\"tn-icon bx bx-shape-square\"></span>) or <em>Draw a circle on the map</em> (<span class=\"tn-icon bx bx-shape-circle\"></span>) button.</li><li>Click once to set the first corner, or the center of the circle. Click a second time at the opposite corner, or at the distance the circle should reach.</li><li>Instead of two clicks you can drag from one to the other. This also works on mobile and other touch-based apps.</li></ol><h3>Finishing and cancelling</h3><p>To give up on a shape while drawing it, press <kbd>Escape</kbd> or press the tool's button again. Whatever has been drawn so far is discarded.</p><p>The tool is deactivated once a shape is finished, so drawing a second shape requires another button press.</p><h2>Interaction</h2><p>Once a shape is created:</p><ul><li>Clicking a shape opens the standard panel which allows changing the title, the content and with buttons to open the note or remove it.<ul><li>When clicking, a marker takes priority over the shape.</li></ul></li><li>Right-clicking a shape opens a contextual menu similar to the one for markers, which allows opening the corresponding note or removing the shape.</li><li>Typing in the map's search bar finds shapes by their title, as it does markers. Selecting one brings the whole shape into view.</li></ul><h2>How shapes are represented</h2><p>Shapes are represented quite similarly to markers, which means each shape is a note. The information about the same is stored using a <a href=\"#root/_help_HI6GBBIduIgv\">label</a> called <code>geoShape</code>.</p>",
++ "_help_ZRDXGc0nAIh4": "<p>An image map is a geo map drawn over an image of your own instead of a world map, such as a floor plan, a fantasy map for a tabletop game, or a diagram to annotate. Markers and shapes work as they do on a geo map, but their positions are measured on the image instead of in latitude and longitude: in the image's own pixels, or in a coordinate system of your choosing, such as the one a video game uses.</p><h2>Creating an image map</h2><ol><li>Upload the image as a note of its own, for example by dragging the file into the note tree. PNG, JPEG, WebP and GIF images are supported; SVG images are not.</li><li>Create a geo map, or open an existing one.</li><li>Open the <span class=\"tn-icon bx bx-cog\"></span><em>Geo map properties</em> dialog from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a> or from the settings menu of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>.</li><li>Under <em>Background</em>, set <em>Type</em> to <em>Custom image</em>, then choose the image note in <em>Image note</em>. The list only offers image notes in a format the map can draw (PNG, JPEG, WebP or GIF), and shows all of them before anything is typed.</li></ol><p>The map then shows the image instead of the world map and opens with the whole image in view. To go back to a world map, set <em>Type</em> back to <em>Vector &amp; Raster</em>. The image is switched off rather than removed: its relation is renamed to <code>~disabled:map:image</code>, so setting <em>Type</em> to <em>Custom image</em> again brings back the same image, with its coordinates. An image that the geo map inherits from a parent note or a template can only be switched off on the note that holds it.</p><p>The image note is stored in a <code>~map:image</code> <a href=\"#root/_help_Cq5X6iKQop6R\">relation</a> of the geo map, which can also be added by hand.</p><h2>Image size</h2><p>Images are resized when they are uploaded, so by default the image of a map is at most 2000 pixels on its longer side, which can be too coarse for a detailed map. To keep an image at a higher resolution, do one of the following before uploading it:</p><ul><li>In <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Media</em>, raise <em>Max image dimensions</em> or turn off <em>Automatically compress images</em>.</li><li>Upload it through the <em>Import</em> dialog with <em>Compress images</em> unchecked.</li></ul><p>An image that was already uploaded keeps its size; upload it again after changing the settings.</p><p>The image is drawn as a single picture by the graphics card, which limits how large it can be. Images up to 4096 pixels on their longer side are safe on practically every device, and most computers handle up to 16384 pixels. On a device whose graphics card cannot hold the image, the markers and shapes still appear but the image itself does not. The <em>Geo map properties</em> dialog warns about an image larger than 4096 pixels, and about one that can't be used at all, such as an SVG image.</p><h2>Interaction</h2><p>Adding, moving and removing markers, drawing shapes, the popup view and the contextual menu work as described for the&nbsp;<a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map</a>. The camera stays over the image and can zoom in up to four times past the image's own resolution.</p><p>The features that only make sense on a real map are not available on an image map:</p><ul><li>Searching the map and searching for places online.</li><li>Going to your location.</li><li>Adding GPS tracks.</li><li>Clicking the places the base map shows.</li><li>The 3D buildings.</li><li>Opening a location in an external map application.</li></ul><p>The look of the marker titles follows the image: if the image is dark, turn on <em>Dark image</em> under <em>Background</em> in the <em>Geo map properties</em> dialog, so that the titles are drawn in a light color. This sets the <code>#map:darkStyle</code> label.</p><p>The <em>Map style</em> setting doesn't apply to an image map, so it's hidden from the settings menu of the collection while the map has an image.</p><h2>Choosing the coordinate system</h2><p>By default, positions are measured in pixels of the image at its original size, from its top-left corner, with <code>x</code> growing to the right and <code>y</code> growing downwards.</p><p>To use coordinates of your own instead, open the <em>Geo map properties</em> dialog, set <em>Coordinates</em> under <em>Background</em> to <em>Custom</em>, and enter the coordinates of the image's <em>Top-left corner</em> and <em>Bottom-right corner</em>. Switching to <em>Custom</em> starts from the image's size in pixels, so the markers stay where they are until the corners are changed; for that reason, <em>Custom</em> can only be chosen once the image has loaded. All positions are then read and written in those coordinates, including the ones shown in the contextual menu and in the popup view. To go back to pixels, set <em>Coordinates</em> to <em>Image pixels</em>. Corners that the geo map inherits from a parent note or a template can only be removed on the note that holds them; entering other corners on this map overrides them.</p><p>The corners are stored in the <code>#map:imageBounds</code> label of the geo map as <code>x,y x,y</code>, with a space between the two corners, which can also be set by hand. For example:</p><ul><li>A screenshot of a game map that covers <code>x</code> from -512 to 512 and <code>y</code> from -512 to 512, with <code>y</code> growing downwards: <code>#map:imageBounds=-512,-512 512,512</code>. Coordinates copied from the game can then be pasted directly into <code>#mapPosition</code>.</li><li>A world whose <code>y</code> grows upwards, with the origin in the middle of the image: <code>#map:imageBounds=-2000,1000 2000,-1000</code>. A top-left <code>y</code> larger than the bottom-right one is what flips the axis.</li><li>A floor plan measured in meters: <code>#map:imageBounds=0,0 24,12</code>.</li></ul><p>The two axes don't have to use the same scale. A circle is always measured in the map's own units, so it appears as an ellipse when the units are stretched differently along the two axes.</p><p>Corners that share an <code>x</code> or a <code>y</code> don't span an area: the dialog doesn't save them, and a label holding them, or a value that cannot be read, is ignored and the pixels of the image are used instead.</p><h2>Coordinate rulers</h2><p>Enabling <em>Show scale</em> in the collection properties draws rulers along the edges of the image instead of a distance scale. Round values of the map's coordinates are marked with ticks along all four edges, labeled along the top and left ones, with faint grid lines across the image. The spacing follows the zoom level, and the values follow <code>#map:imageBounds</code> when it is set.</p><p>The rulers are drawn on the image itself, so they move out of view along with its edges when zooming in. The grid lines remain visible across the image.</p><h2>How the positions are stored</h2><p>Because positions are stored in different labels from the ones of a geo map, the same note can be placed both on a geo map and on an image map.</p><figure class=\"table\"><table><thead><tr><th>Label</th><th>Content</th></tr></thead><tbody><tr><td><code>#mapPosition</code></td><td>The position of a marker, as <code>x,y</code>, for example <code>#mapPosition=320,145</code>.</td></tr><tr><td><code>#mapShape</code></td><td>A shape, in the same format as <code>#geoShape</code> (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_C2H9HK4BzwG7\">Drawing shapes</a>) but with <code>x,y</code> pairs, and a circle's radius in the map's units, for example <code>#mapShape=circle:400,300 50</code>.</td></tr></tbody></table></figure><p>The positions belong to the coordinate system, not to the image. When replacing the image with a different one, for example a higher-resolution copy, keep <code>#map:imageBounds</code> describing the area the new image covers and every marker stays in place. With <em>Image pixels</em>, the positions are pixels, so an image of a different size moves the markers relative to what the image shows; to avoid that, switch <em>Coordinates</em> to <em>Custom</em> before replacing the image, which keeps the size of the old one (<code>0,0 &lt;width&gt;,&lt;height&gt;</code>) as the corners.</p><aside class=\"admonition tip\"><p>To draw freely over an image instead of placing notes on it, consider a&nbsp;<a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a>.</p></aside>",
++ "_help_zP3PMqaG71Ct": "<figure class=\"image\"><img style=\"aspect-ratio:1120/763;\" src=\"{{helpAssets}}/User%20Guide/Collections/Presentation_image.png\" width=\"1120\" height=\"763\"></figure><p>The Presentation view allows the creation of slideshows directly from within Trilium.</p><h3>Creating a new presentation</h3><p>Right click on an existing note in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and select <em>Insert child note</em> → <em>Collection</em> → <em>Presentation</em>.</p><h2>How it works</h2><ul><li>Each slide is a child note of the collection.</li><li>The order of the child notes determines the order of the slides.</li><li>Unlike traditional presentation software, slides can be laid out both horizontally and vertically (see below for more information).</li><li>Direct children will be laid out horizontally and the children of those will be laid out vertically. Children deeper than two levels of nesting are ignored.</li></ul><h2>Interaction and navigation</h2><p>In the floating toolbar (top-right):</p><ul><li><span class=\"tn-icon bx bx-edit\"></span> <em>Edit this slide</em> button to go to the corresponding note of the current slide. A <a href=\"#root/_help_CoFPLs3dRlXc\">read-only</a> presentation doesn't show it.</li><li>Press the <span class=\"tn-icon bx bx-grid-horizontal\"></span> Overview button (or the <kbd>O</kbd> key) to show a birds-eye view of the slides. Press the button again to disable it.</li><li>Press the <span class=\"tn-icon bx bx-fullscreen\"></span> “Start presentation” button to show the presentation in full-screen.</li></ul><p>The following keyboard shortcuts are supported:</p><ul><li>Press <kbd>←</kbd> and <kbd>→</kbd> (or <kbd>H</kbd> and <kbd>L</kbd>) to go to the slide on the left or on the right (horizontal).</li><li>Press <kbd>↑</kbd> and <kbd>↓</kbd> &nbsp;(or <kbd>K</kbd> and <kbd>J</kbd>) to go to the upward or downward slide (vertical).</li><li>Press <kbd>Space</kbd> and <kbd>Shift</kbd> + <kbd>Space</kbd> or &nbsp;to go to the next/previous slide in order.</li><li>And a few more, press <kbd>?</kbd> to display a popup with all the supported keyboard combinations.</li></ul><h2>Vertical slides and nesting</h2><p>Unlike traditional presentation software such as Microsoft PowerPoint, the slides in Trilium can be laid out horizontally or vertically in order to create depth or better organize the slides by topic.</p><p>This horizontal/vertical organization affects transitions (especially on the “slide” transition), however it is most noticeable in navigation.</p><ul><li>Pressing <kbd>←</kbd> and <kbd>→</kbd> will navigate through slides horizontally, thus skipping vertical notes under the current slide. This is useful to skip entire chapters/related slides.</li><li>Pressing <kbd>↑</kbd> and <kbd>↓</kbd> will navigate through the vertical slides at the current level.</li><li>Pressing <kbd>Space</kbd> and <kbd>Shift</kbd> + <kbd>Space</kbd> will go to the next/previous slide in order, regardless of the direction. This is generally the key combination to use when presenting.</li><li>The arrows on the bottom-right of the slide will also reflect this navigation scheme.</li></ul><figure class=\"image image-style-align-right image_resized\" style=\"width:55.57%;\"><img style=\"aspect-ratio:890/569;\" src=\"{{helpAssets}}/User%20Guide/Collections/1_Presentation_image.png\" width=\"890\" height=\"569\"></figure><p>All direct children of the collection will be laid out horizontally. If a direct child also has children, those children will be placed as vertical slides.</p><p>In the following example, the note structure is as follows:</p><ul><li>Presentation collection<ul><li>Trilium Notes (demo page)</li><li>“Introduction” slide<ul><li>“The challenge of personal knowledge management”</li><li>“Note-taking structures”</li></ul></li><li>“Demo &amp; Feature highlights” slide<ul><li>“Really fast installation process”</li><li>Video slide</li></ul></li></ul></li></ul><h2>Customization</h2><p>At collection level, it's possible to adjust:</p><ul><li>The theme of the entire presentation to one of the predefined themes by going to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>&nbsp;and looking for the <em>Theme</em> option.</li><li>It's currently not possible to create custom themes, although it is planned.</li><li>Note that it is note possible to alter the CSS via&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlhDUqhENtH7\">Custom app-wide CSS</a>&nbsp;because the slides are rendered isolated (in a shadow DOM).</li></ul><p>At slide level:</p><ul><li>It's possible to adjust the background color of a slide by using the <a href=\"#root/_help_OFXdgB2nNk1F\">predefined promoted attribute</a> for the color or manually setting <code>#slide:background</code> to a hex color.</li><li>More complex backgrounds can be achieved via gradients. There's no UI for it; it has to be set via <code>#slide:background</code> to a CSS gradient definition such as: <code>linear-gradient(to bottom, #283b95, #17b2c3)</code>.</li></ul><h2>Tips and tricks</h2><ul><li>Text notes generally respect the formatting (bold, italic, foreground and background colors) and font size. Code blocks and tables also work.</li><li>Try using more than just text notes, the presentation uses the same mechanism as <a href=\"#root/_help_R9pX4DGra2Vt\">shared notes</a> and&nbsp;<a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a>&nbsp;so it should be able to display&nbsp;<a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a>,&nbsp;<a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a>&nbsp;in full-screen (without the interactivity).<ul><li><p>Consider using a transparent background for&nbsp;<a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a>, if the slides have a custom background (go to the hamburger menu in the Canvas, press the button select a custom color and write <code>transparent</code>).</p></li><li><p>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a>, some of them have a predefined background which can be changed via the frontmatter. For example, for XY-charts:</p><pre><code class=\"language-text-x-trilium-auto\">---\nconfig:\n themeVariables:\n xyChart:\n backgroundColor: transparent\n---</code></pre></li></ul></li></ul><h2>Under the hood</h2><p>The Presentation view uses <a href=\"https://revealjs.com/\">Reveal.js</a> to handle the navigation and layout of the slides.</p>",
++ "_help_8QqnMzx393bx": "<figure class=\"image\"><img style=\"aspect-ratio:990/590;\" src=\"{{helpAssets}}/User%20Guide/Collections/Grid%20View_image.png\" width=\"990\" height=\"590\"></figure><p>This view presents the child notes in a grid format, allowing for a more visual navigation experience.</p><p>Each tile contains:</p><ul><li>The title of a note.</li><li>A snippet of the content.</li><li>For empty notes, the sub-children are also displayed, allowing for quick navigation.</li></ul><p>Depending on the type of note:</p><ul><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes, the text can be slightly scrollable via the mouse wheel to reveal more context.</li><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;notes, syntax highlighting is applied.</li><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a>&nbsp;notes, a preview is made available for audio, video and PDF notes.</li><li>If the note does not have a content, a list of its child notes will be displayed instead.</li></ul><p>The grid view is also used by default in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a>&nbsp;of every note, making it easy to navigate to children notes.</p><h3>Creating a new table</h3><p>Right click on an existing note in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and select <em>Insert child note</em> → <em>Collection</em> → <em>Grid View</em>.</p><h2>Configuration</h2><p>Unlike most other view types, the grid view is not actually configurable.</p>",
++ "_help_mULW0Q3VojwY": "<figure class=\"image\"><img style=\"aspect-ratio:1387/758;\" src=\"{{helpAssets}}/User%20Guide/Collections/List%20View_image.png\" width=\"1387\" height=\"758\"></figure><p>List view is similar to&nbsp;<a class=\"reference-link\" href=\"#root/_help_8QqnMzx393bx\">Grid View</a>, but in the list view mode, each note is displayed in a single row with only the title and the icon of the note being visible by the default. By pressing the <span class=\"tn-icon bx bx-chevron-right\"></span> expand button it's possible to view the content of the note, as well as the children of the note (recursively).</p><p>In the example above, the \"Node.js\" note on the left panel contains several child notes. The right panel displays the content of these child notes as a single continuous document.</p><h3>Creating a new table</h3><p>Right click on an existing note in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and select <em>Insert child note</em> → <em>Collection</em> → <em>List View</em>.</p><h2>Interaction</h2><ul><li>Each note can be expanded or collapsed by clicking on the <span class=\"tn-icon bx bx-chevron-right\"></span> arrow to the left of the title.</li><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>, there are buttons to expand (<span class=\"tn-icon bx bx-move-vertical\"></span>) and to collapse (<span class=\"tn-icon bx bx-layer-minus\"></span>) all notes easily.</li></ul><h2>Printing and exporting to PDF</h2><p>Since v0.100.0, list collections can be <a href=\"#root/_help_NRnIZmSMc5sj\">printed or exported to PDF</a>.</p><p>A printed list collection will print all the notes in the collection, in the right order and preserving the full hierarchy.</p><p>If exported to PDF within the desktop application, there is additional functionality:</p><ul><li>The table of contents of the PDF will reflect the structure of the notes.</li><li>Reference and inline links to other notes within the same hierarchy will be functional (will jump to the corresponding page). If a link refers to a note that is not in the printed hierarchy, it will be unlinked.</li></ul><h2>Expanding and collapsing multiple notes at once</h2><p>Apart from individually expanding or collapsing notes, it's also possible to expand or collapse them all at once. To do so, go to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>&nbsp;and look for the corresponding button.</p><p>By default, the <em>Expand</em> (<span class=\"tn-icon bx bx-move-vertical\"></span>) button will only expand the direct children (first level) of the collection. Starting with v0.100.0, it's possible to expand multiple levels of notes using the arrow button next to the button.</p><p>Manually expanded notes will reset if the application/tab is closed and then the collection is visited again. However notes automatically expanded/collapsed via the buttons in&nbsp;<a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>&nbsp;will persist.</p><aside class=\"admonition tip\"><p>By design, the UI provides only a handful of levels of depth for expanding notes (direct children, 2-5, all levels). It's also possible to specify any desired depth by manually setting the <a href=\"#root/_help_HI6GBBIduIgv\">corresponding label</a>. For example: <code>#expanded=100</code> to expand up to 100 levels of depth.</p></aside><aside class=\"admonition note\"><p>From a performance standpoint, the List collection is efficient since it does not load child notes unless the notes are actually expanded. Expanding the list for a significantly large hierarchy can cause slow-downs.</p></aside>",
++ "_help_CssoWBu8I7jF": "<figure class=\"image\"><img style=\"aspect-ratio:1177/98;\" src=\"{{helpAssets}}/User%20Guide/Collections/Collection%20Properties_image.png\" width=\"1177\" height=\"98\"></figure><p>The <em>Collection Properties</em> is a toolbar that is displayed at the top of every <a href=\"#root/_help_GTwFsgaA0lCt\">collection note</a>.</p><p>The collection properties has:</p><ul><li>A quick selector for the view type (e.g. grid, calendar, board).</li><li>A settings button with:<ul><li>Settings for the current view, for example hiding the weekends in a calendar.</li><li>Generic settings for the collection, such as <a href=\"#root/_help_wyaGBBQrl4i3\">hiding the child notes</a> or showing <a href=\"#root/_help_MKmLg5x6xkor\">archived notes</a>.</li></ul></li><li>Specific interactions for the current view, for example month selector and view switcher for the calendar.</li></ul>",
++ "_help_IF7Q6I9x7zuw": "<figure class=\"image\"><img style=\"aspect-ratio:1406/1030;\" src=\"{{helpAssets}}/User%20Guide/Collections/Dashboard_image.png\" width=\"1406\" height=\"1030\"></figure><aside class=\"admonition note\"><p>The dashboard is currently considered beta. This means that it might face some changes in behavior until it is stabilized.</p></aside><p>The dashboard is a collection introduced in Trilium v0.104.0. It is similar to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8QqnMzx393bx\">Grid View</a>&nbsp;collection, but with some key differences:</p><ul><li>The grid layout is not fixed, allowing for tiles of varying widths and heights. The grid has 12 columns and an unlimited number of rows.</li><li>Each widget represents a child note of the collection and can be reordered or resized.</li><li>The grid will distribute the columns evenly to fill the entire screen.<ul><li>If the available space is too low (e.g. in a split or in mobile), the columns are collapsed so that all widgets are displayed one under the other.</li><li>While the columns are collapsed, the widgets cannot be reordered or resized.</li></ul></li><li>Unlike the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8QqnMzx393bx\">Grid View</a>, the widgets are not clickable which allows them to be interactive.</li></ul><h2>Types of widgets</h2><p>The dashboard uses the same rendering mechanism as the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8QqnMzx393bx\">Grid View</a>&nbsp;or the&nbsp;<a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a>, which means every note can be rendered, such as:</p><ul><li>Static content, via&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;or&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>.</li><li>Images via&nbsp;<a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a>,&nbsp;<a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a>,&nbsp;<a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a>.</li><li>Interactive widgets via&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>.</li><li>Web pages can be displayed via&nbsp;<a class=\"reference-link\" href=\"#root/_help_1vHRoWCEjj0L\">Web View</a>&nbsp;and refreshed via the context menu.</li><li><a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>&nbsp;render interactively inside the dashboard</li></ul><aside class=\"admonition tip\"><p>Interactive widgets through the use of&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>&nbsp;is the highlighted use case of the dashboard. Using the&nbsp;<a class=\"reference-link\" href=\"#root/_help_GBBMSlVSOIGP\">AI</a>&nbsp;chat, these widgets can be easily created as the AI is instructed in how to write them.</p></aside><h2>Adding new widgets</h2><p>There are two ways to add widgets to a dashboard:</p><ul><li>Create a child note of any type, the dashboard will automatically pick it up and add it onto the grid.</li><li>From the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, drag an existing note onto the dashboard and it will be placed there. This will <a href=\"#root/_help_IakOLONlIfGI\">clone</a> the note into the collection.</li></ul><h2>Read-only dashboards</h2><p>On a <a href=\"#root/_help_CoFPLs3dRlXc\">read-only</a> dashboard, the widgets can't be moved or resized, notes dragged from the <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a> aren't added, and the menu of a widget no longer offers to remove it.</p>",
++ "_help_BgmBlOIl72jZ": "<p>While Trilium is actively maintained and stable, encountering bugs is possible.</p><h2>General Quick Fix</h2><p>The first step in troubleshooting is often a restart.</p><p>If you experience an UI issue, the frontend may have entered an inconsistent state. Reload the application by pressing <kbd>Ctrl</kbd> + <kbd>R</kbd>. This will reload the frontend.</p><p>If the issue persists or appears to be a backend problem, restart the entire application. For the desktop (Electron) build, simply close and reopen the window. If you're using a Docker build, restart the container.</p><h2>Reporting Bugs</h2><p>Reporting bugs is highly valuable. Here are some tips:</p><ul><li>Use GitHub issues for reporting: <a href=\"https://github.com/TriliumNext/Trilium/issues\">https://github.com/TriliumNext/Trilium/issues</a></li><li>Refer to the <a href=\"#root/_help_qzNzp9LYQyPT\">error logs</a> page for information on providing necessary details.</li></ul><details class=\"trilium-collapsible\" open=\"\"><summary>Broken Note Crashes Trilium</summary><p>Certain problems, such as rendering a note with a faulty script, can cause Trilium to crash. If Trilium attempts to reload the problematic note upon restart, it will continue to crash.</p><p>To resolve this, use the <code>TRILIUM_START_NOTE_ID</code> environment variable to reset the open tabs to a single specified note ID (e.g., <code>root</code>). In Linux, you can set it as follows:</p><pre><code class=\"language-text-x-trilium-auto\">TRILIUM_START_NOTE_ID=root ./trilium</code></pre></details><details class=\"trilium-collapsible\" open=\"\"><summary>Broken Script Prevents Application Startup</summary><p>If a custom script causes Trilium to crash, and it is set as a startup script or in an active <a href=\"#root/_help_MgibgPcfeuGz\">custom widget</a>, start Triliumin \"safe mode\" to prevent any custom scripts from executing:</p><pre><code class=\"language-text-x-trilium-auto\">TRILIUM_SAFE_MODE=true ./trilium</code></pre><p>Depending on your Trilium distribution, you may have pre-made scripts available: <code>trilium-safe-mode.bat</code> and <code>trilium-safe-mode.sh</code>.</p><p>Once Trilium starts, locate and fix or delete the problematic note.</p></details><details class=\"trilium-collapsible\" open=\"\"><summary>Sync and Consistency Checks</summary><p>Trilium periodically verifies the logical consistency of the database (e.g., ensuring every note has a parent). If inconsistencies are detected, you will be notified via the UI.</p><p>In such cases, file a bug report and attach an <a href=\"#root/_help_x59R8J8KV5Bp\">anonymized database</a> if necessary.</p></details><details class=\"trilium-collapsible\" open=\"\"><summary>Restoring Backup</summary><p>Trilium makes regular automatic backups. If issues become severe, you can <a href=\"#root/_help_ODY7qQn5m2FT\">restore from a backup</a>.</p></details><details class=\"trilium-collapsible\" open=\"\"><summary>Forgotten Password</summary><p>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_lwAX5SvbrK2g\">Resetting your password</a>.</p></details>",
+ "_help_wy8So3yZZlH9": "<p>Go to <a href=\"https://github.com/TriliumNext/Trilium/issues\">Issues · TriliumNext/Trilium</a> and press “New issue”.</p><p>If you are reporting a bug, select “Bug Report” and fill in the details.</p>",
- "_help_x59R8J8KV5Bp": "<p><img src=\"{{helpAssets}}/User%20Guide/Troubleshooting/Anonymized%20Database_image.jpg\"></p><p>In certain scenarios, understanding the structure of a database is crucial for troubleshooting issues. However, sharing your actual <a href=\"#root/_help_wX4HbRucYSDD\">database</a> file with personal notes is not advisable. To address this, Trilium offers a feature to anonymize the database. This feature can be accessed via Menu -&gt; Options -&gt; Advanced tab.</p><p>This feature creates a copy of your database with all sensitive data removed. Specifically, it strips out note titles, contents, revisions, history, and some non-system attributes while retaining the overall structure and metadata, such as modification dates. After anonymization, the database undergoes a <a href=\"https://sqlite.org/lang_vacuum.html\">vacuuming process</a> to ensure no sensitive data remnants remain in the file. The anonymized database is saved in the <code spellcheck=\"false\">anonymized</code> directory within the <a href=\"#root/_help_tAassRL4RSQL\">data directory</a>, making it safe to share with bug reports.</p><p>This will create a copy of your document and remove all sensitive data (currently note titles, contents, revisions, history and some of the options, and non-system attributes) while leaving all structure and metadata (e.g. date of last change). After this is done, the database is <a href=\"https://sqlite.org/lang_vacuum.html\">VACUUMed</a> to make sure there's no stale sensitive data in the document file. The resulting file is stored in <code spellcheck=\"false\">anonymized</code> directory (placed in the <a href=\"#root/_help_tAassRL4RSQL\">data directory</a>). You can safely attach it to a bug report.</p><h2>Command Line Anonymization</h2><p>If your <a href=\"#root/_help_wX4HbRucYSDD\">database</a> is corrupted to the point where Trilium cannot start, the anonymization process can still be executed via the command line:</p><pre><code class=\"language-text-x-trilium-auto\">node src/anonymize.js</code></pre><p>Run this command from the directory containing Trilium's source files, typically found in the <code spellcheck=\"false\">resources/app</code> directory for desktop builds.</p>",
++ "_help_x59R8J8KV5Bp": "<p><img src=\"{{helpAssets}}/User%20Guide/Troubleshooting/Anonymized%20Database_image.jpg\"></p><p>In certain scenarios, understanding the structure of a database is crucial for troubleshooting issues. However, sharing your actual <a href=\"#root/_help_wX4HbRucYSDD\">database</a> file with personal notes is not advisable. To address this, Trilium offers a feature to anonymize the database. This feature can be accessed via Menu -&gt; Options -&gt; Advanced tab.</p><p>This feature creates a copy of your database with all sensitive data removed. Specifically, it strips out note titles, contents, revisions, history, and some non-system attributes while retaining the overall structure and metadata, such as modification dates. After anonymization, the database undergoes a <a href=\"https://sqlite.org/lang_vacuum.html\">vacuuming process</a> to ensure no sensitive data remnants remain in the file. The anonymized database is saved in the <code>anonymized</code> directory within the <a href=\"#root/_help_tAassRL4RSQL\">data directory</a>, making it safe to share with bug reports.</p><p>This will create a copy of your document and remove all sensitive data (currently note titles, contents, revisions, history and some of the options, and non-system attributes) while leaving all structure and metadata (e.g. date of last change). After this is done, the database is <a href=\"https://sqlite.org/lang_vacuum.html\">VACUUMed</a> to make sure there's no stale sensitive data in the document file. The resulting file is stored in <code>anonymized</code> directory (placed in the <a href=\"#root/_help_tAassRL4RSQL\">data directory</a>). You can safely attach it to a bug report.</p><h2>Command Line Anonymization</h2><p>If your <a href=\"#root/_help_wX4HbRucYSDD\">database</a> is corrupted to the point where Trilium cannot start, the anonymization process can still be executed via the command line:</p><pre><code class=\"language-text-x-trilium-auto\">node src/anonymize.js</code></pre><p>Run this command from the directory containing Trilium's source files, typically found in the <code>resources/app</code> directory for desktop builds.</p>",
+ "_help_qzNzp9LYQyPT": "<p>It's important to provide all available error logs together with bug reports.</p><p>There are two types of error logs, both of which are useful when reporting bugs.</p><ul><li><a class=\"reference-link\" href=\"#root/_help_bnyigUA2UK7s\">Backend (server) logs</a></li><li><a class=\"reference-link\" href=\"#root/_help_9yEHzMyFirZR\">Frontend logs</a></li></ul><h2>Providing sensitive data</h2><p>If you don't feel comfortable attaching the logs or anything sensitive to the public GitHub issues, feel free to contact the devs in our Matrix <a href=\"https://github.com/TriliumNext/Trilium#-discuss-with-us\">support channel</a>.</p><p>Use this email to also provide anything which could assist in analysing the bug - e.g. files/images/ZIPs being imported or <a href=\"#root/_help_x59R8J8KV5Bp\">anonymized database</a>.</p><h3>Exporting note subtree for reproduction</h3><p>Often times, bugs manifest themselves in specific notes and having them would greatly ease reproduction and fixing.</p><p>In such case, please export the relevant note subtree by right-clicking it on the left tree, choosing Export - HTML as ZIP:</p><p><img src=\"{{helpAssets}}/User%20Guide/Troubleshooting/Error%20logs_error-logs-export-subtree.png\"></p>",
- "_help_bnyigUA2UK7s": "<h2>Accessing via the backend log</h2><p>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>, go to <em>Advanced</em> → <em>Show backend log</em>. This will display the current backend log (i.e. today's), with the historical information available only on disk (see below).</p><p>Interaction since v0.104.0:</p><ul><li>The file can be downloaded as a text file using the dedicated button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note buttons</a>&nbsp;area (<a class=\"reference-link\" href=\"#root/_help_IjZS7iK5EXtb\">New Layout</a>&nbsp;only).</li><li>The file can also be searched just like a normal&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note.</li></ul><h2>Location on the disk</h2><p>Backend logs are stored on the file system. To find them, open the&nbsp;<a class=\"reference-link\" href=\"#root/_help_tAassRL4RSQL\">Data directory</a>, go to the <code spellcheck=\"false\">log</code> subdirectory and find the latest log file, e.g. <code spellcheck=\"false\">trilium-2022-12-14.log</code>.&nbsp;</p><h2>Reporting backend bugs</h2><p>You can attach the whole file to the bug report (preferable) or open it and copy-paste only the last lines / lines you believe are relevant.</p><h2>Customizing the retention of logs</h2><p>The backend logs are fully managed by the Trilium server. By default the last 90 days worth of logs are kept; the logs older than that are deleted in order to reduce the space consumption.</p><p>It's possible to change the retention period by modifying the&nbsp;<a class=\"reference-link\" href=\"#root/_help_Gzjqa934BdH4\">Configuration (config.ini or environment variables)</a>&nbsp;via the <code spellcheck=\"false\">.ini</code> file:</p><pre><code class=\"language-text-x-trilium-auto\">[Logging]\nretentionDays=7</code></pre><p>Or via the environment variable <code spellcheck=\"false\">TRILIUM_LOGGING_RETENTION_DAYS</code>.</p><p>Special cases:</p><ul><li>Positive values indicate the number of days worth of logs to keep</li><li>A value of 0 results with the default value (90 days) to be used</li><li>Negative values (e.g. <code spellcheck=\"false\">-1</code>) result with all logs to be kept, irrespective how ancient and numerous (and</li></ul><aside class=\"admonition note\"><p>If you set the retention days to a low number, you might notice that not all the log files are being deleted. This is because a minimum number of logs (7 at the time of writing) is maintained at all times.</p></aside>",
++ "_help_bnyigUA2UK7s": "<h2>Accessing via the backend log</h2><p>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>, go to <em>Advanced</em> → <em>Show backend log</em>. This will display the current backend log (i.e. today's), with the historical information available only on disk (see below).</p><p>Interaction since v0.104.0:</p><ul><li>The file can be downloaded as a text file using the&nbsp;<span class=\"tn-icon bx bx-download\"></span> button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>&nbsp;area.</li><li>The file can also be searched just like a normal&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note.</li></ul><h2>Location on the disk</h2><p>Backend logs are stored on the file system. To find them, open the&nbsp;<a class=\"reference-link\" href=\"#root/_help_tAassRL4RSQL\">Data directory</a>, go to the <code>log</code> subdirectory and find the latest log file, e.g. <code>trilium-2022-12-14.log</code>.&nbsp;</p><h2>Reporting backend bugs</h2><p>You can attach the whole file to the bug report (preferable) or open it and copy-paste only the last lines / lines you believe are relevant.</p><h2>Customizing the retention of logs</h2><p>The backend logs are fully managed by the Trilium server. By default the last 90 days worth of logs are kept; the logs older than that are deleted in order to reduce the space consumption.</p><p>It's possible to change the retention period by modifying the&nbsp;<a class=\"reference-link\" href=\"#root/_help_Gzjqa934BdH4\">Configuration (config.ini or environment variables)</a>&nbsp;via the <code>.ini</code> file:</p><pre><code class=\"language-text-x-trilium-auto\">[Logging]\nretentionDays=7</code></pre><p>Or via the environment variable <code>TRILIUM_LOGGING_RETENTION_DAYS</code>.</p><p>Special cases:</p><ul><li>Positive values indicate the number of days worth of logs to keep</li><li>A value of 0 results with the default value (90 days) to be used</li><li>Negative values (e.g. <code>-1</code>) result with all logs to be kept, irrespective how ancient and numerous (and</li></ul><aside class=\"admonition note\"><p>If you set the retention days to a low number, you might notice that not all the log files are being deleted. This is because a minimum number of logs (7 at the time of writing) is maintained at all times.</p></aside>",
+ "_help_9yEHzMyFirZR": "<p>To provide frontend logs, we need to open the Developer Console. Often the easiest way is to press <kbd>Ctrl</kbd>-<kbd>Shift</kbd>-<kbd>I</kbd> which should work in most browsers (and desktop app). Make sure that the error producing action happened right before you copy&amp;paste the errors, the console is cleared on app restart.</p><p>If that doesn't work, then:</p><ul><li>in Trilium desktop app, go to top-left menu button -&gt; Advanced -&gt; Open Dev Tools</li><li>In Firefox/Chrome right-click anywhere in the page and click Inspect:</li></ul><p><img src=\"{{helpAssets}}/User%20Guide/Troubleshooting/Error%20logs/Frontend%20logs_error-logs-firefox-context-men.png\"></p><p>Once you have Dev Tools open, click on \"Console\" tab:</p><p><img src=\"{{helpAssets}}/User%20Guide/Troubleshooting/Error%20logs/Frontend%20logs_image.jpg\"></p><p>Copy-paste (or screenshot) the logs. It's better to provide not just errors, but the whole log, which might provide context while analyzing the bug.</p>",
+ "_help_vdlYGAcpXAgc": "<p>Synchronization can sometimes take a long amount of time in order to compute the items that require update. When running behind a reverse proxy, the request can time out.</p><p>The solution is to increase the timeout at proxy level.</p><h2>Nginx</h2><p>Add the following to the configuration file:</p><pre><code class=\"language-text-x-nginx-conf\">proxy_connect_timeout 300;\nproxy_send_timeout 300;\nproxy_read_timeout 300;\nsend_timeout 300;</code></pre><p>And restart the server.</p><p>See&nbsp;<a href=\"#root/_help_ud6MShXL4WpO\">Nginx Proxy Setup</a>&nbsp;for more information about the Nginx setup.</p><p>If it still doesn't work, try increasing the timeout.</p>",
+ "_help_s8alTXmpFR61": "<p>Some changes to the application will not take effect immediately and as such it might require to manually reload or refresh the application.</p><p>To do so, simply press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>R</kbd>.</p>",
- "_help_7NfNr5pZpVKV": "<h2>Step 1. Find a place to place the themes</h2><p>Organization is an important aspect of managing a knowledge base. When developing a new theme or importing an existing one it's a good idea to keep them into one place.</p><p>As such, the first step is to create a new note to gather all the themes.</p><p><img src=\"{{helpAssets}}/User%20Guide/Theme%20development/Creating%20a%20custom%20theme_5_Creating%20a%20custom%20theme_im.jpg\"></p><h2>Step 2. Create the theme</h2><figure class=\"table\"><table>\n<thead>\n<tr>\n<th></th>\n<th></th>\n</tr>\n</thead>\n<tbody><tr>\n<td><img src=\"{{helpAssets}}/User%20Guide/Theme%20development/Creating%20a%20custom%20theme_3_Creating%20a%20custom%20theme_im.jpg\"></td>\n<td>Themes are code notes with a special attribute. Start by creating a new code note.</td>\n</tr>\n<tr>\n<td><img src=\"{{helpAssets}}/User%20Guide/Theme%20development/Creating%20a%20custom%20theme_1_Creating%20a%20custom%20theme_im.jpg\"></td>\n<td>Then change the note type to a CSS code.</td>\n</tr>\n<tr>\n<td><img src=\"{{helpAssets}}/User%20Guide/Theme%20development/Creating%20a%20custom%20theme_Creating%20a%20custom%20theme_im.jpg\"></td>\n<td>In the <em>Owned Attributes</em> section define the <code spellcheck=\"false\">#appTheme</code> attribute to point to any desired name. This is the name that will show up in the appearance section in settings.</td>\n</tr>\n</tbody></table></figure><h2>Step 3. Define the theme's CSS</h2><p>As a very simple example we will change the background color of the launcher pane to a shade of blue.</p><p>To alter the different variables of the theme:</p><pre><code class=\"language-text-css\">:root {\n\t--launcher-pane-background-color: #0d6efd;\n}</code></pre><h2>Step 4. Activating the theme</h2><p>Refresh the application (Ctrl+Shift+R is a good way to do so) and go to settings. You should see the newly created theme:</p><p><img src=\"{{helpAssets}}/User%20Guide/Theme%20development/Creating%20a%20custom%20theme_2_Creating%20a%20custom%20theme_im.jpg\"></p><p>Afterwards the application will refresh itself with the new theme:</p><p><img src=\"{{helpAssets}}/User%20Guide/Theme%20development/Creating%20a%20custom%20theme_4_Creating%20a%20custom%20theme_im.jpg\"></p><p>Do note that the theme will be based off of the legacy theme. To override that and base the theme on the new TriliumNext theme, see:&nbsp;<a href=\"#root/_help_WFGzWeUK6arS\">Theme base (legacy vs. next)</a></p><h2>Step 5. Making changes</h2><p>Simply go back to the note and change according to needs. To apply the changes to the current window, press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>R</kbd> to refresh.</p><p>It's a good idea to keep two windows, one for editing and the other one for previewing the changes.</p>",
- "_help_WFGzWeUK6arS": "<p>By default, any custom theme will be based on the legacy light theme. To use the TriliumNext theme instead, add the <code spellcheck=\"false\">#appThemeBase=next</code> attribute onto the existing theme. The <code spellcheck=\"false\">appTheme</code> attribute must also be present.</p><p><img src=\"{{helpAssets}}/User%20Guide/Theme%20development/Customize%20the%20Next%20theme_image.png\"></p><p>The <code spellcheck=\"false\">appThemeBase</code> label can be set to one of the following values:</p><ul><li><code spellcheck=\"false\">next</code>, for the TriliumNext (auto light or dark mode).</li><li><code spellcheck=\"false\">next-light</code>, for the always light mode of the TriliumNext.</li><li><code spellcheck=\"false\">next-dark</code>, for the always dark mode of the TriliumNext.</li><li>Any other value is ignored and will use the legacy white theme instead.</li></ul><h2>Overrides</h2><p>Do note that the TriliumNext theme has a few more overrides than the legacy theme. Due to that, it is recommended to use <code spellcheck=\"false\">#trilium-app</code> with a next theme instead of the <code spellcheck=\"false\">:root</code> of a legacy theme.</p><pre><code class=\"language-text-css\">#trilium-app {\n\t--launcher-pane-background-color: #0d6efd;\n}</code></pre>",
- "_help_WN5z4M8ASACJ": "<h2>Detecting mobile vs. desktop</h2><p>The mobile layout is different than the one on the desktop. Use <code spellcheck=\"false\">body.mobile</code> and <code spellcheck=\"false\">body.desktop</code> to differentiate between them.</p><pre><code class=\"language-text-css\">body.mobile #root-widget {\n\t/* Do something on mobile */\n}\n\nbody.desktop #root-widget {\n\t/* Do something on desktop */\n}</code></pre><p>Do note that there is also a “tablet mode” in the mobile layout. For that particular case media queries are required:</p><pre><code class=\"language-text-css\">@media (max-width: 991px) {\n\n #launcher-pane {\n\n /* Do something on mobile layout */\n\n }\n\n}\n\n\n\n@media (min-width: 992px) {\n\n #launcher-pane {\n\n /* Do something on mobile tablet + desktop layout */\n\n }\n\n}</code></pre><h2>Detecting horizontal vs. vertical layout</h2><p>The user can select between vertical layout (the classical one, where the launcher bar is on the left) and a horizontal layout (where the launcher bar is on the top and tabs are full-width).</p><p>Different styles can be applied by using classes at <code spellcheck=\"false\">body</code> level:</p><pre><code class=\"language-text-x-trilium-auto\">body.layout-vertical #left-pane {\n\t/* Do something */\n}\n\nbody.layout-horizontal #center-pane {\n\t/* Do something else */\t\n}</code></pre><p>The two different layouts use different containers (but they are present in the DOM regardless of the user's choice), for example <code spellcheck=\"false\">#horizontal-main-container</code> and <code spellcheck=\"false\">#vertical-main-container</code> can be used to customize the background of the content section.</p><h2>Detecting platform (Windows, macOS) or Electron</h2><p>It is possible to add particular styles that only apply to a given platform by using the classes in <code spellcheck=\"false\">body</code>:</p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Windows</th>\n<th>macOS</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code spellcheck=\"false\">&lt;br&gt;body.platform-win32 {&lt;br&gt; background: red;&lt;br&gt;}&lt;br&gt;</code></td>\n<td><code spellcheck=\"false\">&lt;br&gt;body.platform-darwin {&lt;br&gt; background: red;&lt;br&gt;}&lt;br&gt;</code></td>\n</tr>\n</tbody></table></figure><p>It is also possible to only apply a style if running under Electron (desktop application):</p><pre><code class=\"language-text-x-trilium-auto\">body.electron {\n\tbackground: blue;\n}</code></pre><h3>Native title bar</h3><p>It's possible to detect if the user has selected the native title bar or the custom title bar by querying against <code spellcheck=\"false\">body</code>:</p><pre><code class=\"language-text-x-trilium-auto\">body.electron.native-titlebar {\n\t/* Do something */\n}\n\nbody.electron:not(.native-titlebar) {\n\t/* Do something else */\n}</code></pre><h3>Native window buttons</h3><p>When running under Electron with native title bar off, a feature was introduced to use the platform-specific window buttons such as the semaphore on macOS.</p><p>See <a href=\"https://github.com/TriliumNext/Notes/pull/702\">Native title bar buttons by eliandoran · Pull Request #702 · TriliumNext/Notes</a> for the original implementation of this feature, including screenshots.</p><h4>On Windows</h4><p>The colors of the native window button area can be adjusted using a RGB hex color:</p><pre><code class=\"language-text-x-trilium-auto\">body {\n\t--native-titlebar-foreground: #ffffff;\n\t--native-titlebar-background: #ff0000;\n}</code></pre><p>It is also possible to use transparency at the cost of reduced hover colors using a RGBA hex color:</p><pre><code class=\"language-text-x-trilium-auto\">body {\n\t--native-titlebar-background: #ff0000aa;\n}</code></pre><p>Note that the value is read when the window is initialized and then it is refreshed only when the user changes their light/dark mode preference.</p><h4>On macOS</h4><p>On macOS the semaphore window buttons are enabled by default when the native title bar is disabled. The offset of the buttons can be adjusted using:</p><pre><code class=\"language-text-css\">body {\n --native-titlebar-darwin-x-offset: 12;\n --native-titlebar-darwin-y-offset: 14 !important;\n}</code></pre><h3>Background/transparency effects on Windows (Mica)</h3><p>Windows 11 offers a special background/transparency effect called Mica, which can be enabled by themes by setting the <code spellcheck=\"false\">--background-material</code> variable at <code spellcheck=\"false\">body</code> level:</p><pre><code class=\"language-text-css\">body.electron.platform-win32 {\n\t--background-material: tabbed; \n}</code></pre><p>The value can be either <code spellcheck=\"false\">tabbed</code> (especially useful for the horizontal layout) or <code spellcheck=\"false\">mica</code> (ideal for the vertical layout).</p><p>Do note that the Mica effect is applied at <code spellcheck=\"false\">body</code> level and the theme needs to make the entire hierarchy (semi-)transparent in order for it to be visible. Use the TrilumNext theme as an inspiration.</p><h2>Note icons, tab workspace accent color</h2><p>Theme capabilities are small adjustments done through CSS variables that can affect the layout or the visual aspect of the application.</p><p>In the tab bar, to display the icons of notes instead of the icon of the workspace:</p><pre><code class=\"language-text-css\">:root {\n\t--tab-note-icons: true;\n}</code></pre><p>When a workspace is hoisted for a given tab, it is possible to get the background color of that workspace, for example to apply a small strip on the tab instead of the whole background color:</p><pre><code class=\"language-text-css\">.note-tab .note-tab-wrapper {\n --tab-background-color: initial !important;\n}\n\n.note-tab .note-tab-wrapper::after {\n content: \"\";\n position: absolute;\n top: 0;\n left: 0;\n right: 0;\n height: 3px;\n background-color: var(--workspace-tab-background-color);\n}</code></pre><h2>Custom fonts</h2><p>Currently the only way to include a custom font is to use&nbsp;<a href=\"#root/_help_d3fAXQ2diepH\">Custom resource providers</a>. Basically import a font into Trilium and assign it <code spellcheck=\"false\">#customResourceProvider=fonts/myfont.ttf</code> and then import the font in CSS via <code spellcheck=\"false\">/custom/fonts/myfont.ttf</code>. Use <code spellcheck=\"false\">../../../custom/fonts/myfont.ttf</code> if you run your Trilium server on a different path than <code spellcheck=\"false\">/</code>.</p><h2>Dark and light themes</h2><p>A light theme needs to have the following CSS:</p><pre><code class=\"language-text-css\">:root {\n\t--theme-style: light;\n}</code></pre><p>if the theme is dark, then <code spellcheck=\"false\">--theme-style</code> needs to be <code spellcheck=\"false\">dark</code>.</p><p>If the theme is auto (e.g. supports both light or dark based on <code spellcheck=\"false\">prefers-color-scheme</code>) it must also declare (in addition to setting <code spellcheck=\"false\">--theme-style</code> to either <code spellcheck=\"false\">light</code> or <code spellcheck=\"false\">dark</code>):</p><pre><code class=\"language-text-css\">:root {\n\n --theme-style-auto: true;\n\n}</code></pre><p>This will affect the behavior of the Electron application by informing the operating system of the color preference (e.g. background effects will appear correct on Windows).</p>",
- "_help_AlhDUqhENtH7": "<p>It is possible to provide a CSS file to be used regardless of the theme set by the user.</p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th></th>\n<th></th>\n</tr>\n</thead>\n<tbody><tr>\n<td><img src=\"{{helpAssets}}/User%20Guide/Theme%20development/Custom%20app-wide%20CSS_image.png\"></td>\n<td>Start by creating a new note and changing the note type to CSS</td>\n</tr>\n<tr>\n<td><img src=\"{{helpAssets}}/User%20Guide/Theme%20development/2_Custom%20app-wide%20CSS_image.png\"></td>\n<td>In the ribbon, press the “Owned Attributes” section and type <code spellcheck=\"false\">#appCss</code>.</td>\n</tr>\n<tr>\n<td><img src=\"{{helpAssets}}/User%20Guide/Theme%20development/3_Custom%20app-wide%20CSS_image.png\"></td>\n<td>Type the desired CSS.&nbsp;&nbsp;&nbsp; <br> <br>Generally it's a good idea to append <code spellcheck=\"false\">!important</code> for the styles that are being changed, in order to prevent other</td>\n</tr>\n</tbody></table></figure><h2>Seeing the changes</h2><p>Adding a new <em>app CSS note</em> or modifying an existing one does not immediately apply changes. To see the changes, press Ctrl+Shift+R to refresh the page first.</p><h2>Sample use cases</h2><h3>Customizing the printing stylesheet</h3><aside class=\"admonition tip\"><p>Since v0.99.2, it's no longer possible to use <code spellcheck=\"false\">#appCss</code> to customize the printing CSS, since the printing is now done in an isolated environment.</p><p>However, it's still possible to customize the CSS via <code spellcheck=\"false\">~printCss</code>; see&nbsp;<a class=\"reference-link\" href=\"#root/_help_NRnIZmSMc5sj\">Printing &amp; Exporting as PDF</a>&nbsp;for more information.</p></aside><h3>Per-workspace styles</h3><p>When using&nbsp;<a class=\"reference-link\" href=\"#root/_help_9sRHySam5fXb\">Workspaces</a>, it can be helpful to create a visual distinction between notes in different workspaces.</p><p>To do so:</p><ol><li>In the note with <code spellcheck=\"false\">#workspace</code>, add an inheritable attribute <code spellcheck=\"false\">#cssClass(inheritable)</code> with a value that uniquely identifies the workspace (say <code spellcheck=\"false\">my-workspace</code>).</li><li>Anywhere in the note structure, create a CSS note with <code spellcheck=\"false\">#appCss</code>.</li></ol><h4>Change the color of the icons in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a></h4><pre><code class=\"language-text-x-trilium-auto\">.fancytree-node.my-workspace.fancytree-custom-icon {\n color: #ff0000;\n}</code></pre><h4>Change the color of the note title and the icon</h4><p>To change the color of the note title and the icon (above the content):</p><pre><code class=\"language-text-x-trilium-auto\">.note-split.my-workspace .note-icon-widget button.note-icon,\n.note-split.my-workspace .note-title-widget input.note-title {\n color: #ff0000;\n}</code></pre><h4>Add a watermark to the note content</h4><figure class=\"image image-style-align-right image_resized\" style=\"width:39.97%;\"><img style=\"aspect-ratio:641/630;\" src=\"{{helpAssets}}/User%20Guide/Theme%20development/1_Custom%20app-wide%20CSS_image.png\" width=\"641\" height=\"630\"></figure><ol><li>Insert an image in any note and take the URL of the image.</li><li>Use the following CSS, adjusting the <code spellcheck=\"false\">background-image</code> and <code spellcheck=\"false\">width</code> and <code spellcheck=\"false\">height</code> to the desired values.</li></ol><pre><code class=\"language-text-x-trilium-auto\">.note-split.my-workspace .scrolling-container:after {\n position: fixed;\n content: \"\";\n background-image: url(\"/api/attachments/Rvm3zJNITQI1/image/logo.png\");\n background-size: contain;\n background-position: center;\n background-repeat: no-repeat;\n width: 237px;\n height: 44px;\n bottom: 1em;\n right: 1em;\n opacity: 0.5;\n z-index: 0;\n}</code></pre><h2>Limitations</h2><p>Some parts of the application can't be styled directly via custom CSS because they are rendered in an isolated mode (shadow DOM), more specifically:</p><ul><li>The slides in a&nbsp;<a class=\"reference-link\" href=\"#root/_help_zP3PMqaG71Ct\">Presentation</a>.</li></ul>",
- "_help_g1mlRoU8CsqC": "<aside class=\"admonition note\"><p>This page explains, step‑by‑step, how to create a custom icon pack. For a general description of how to use already existing icon packs, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_gOKqSJgXLcIj\">Icon Packs</a>.</p></aside><p>First read the quick flow to get the overall steps. After that there is a concrete example (Phosphor) with a small Node.js script you can run to generate the manifest.</p><h2>Quick flow (what you need to do)</h2><ol><li>Verify the icon set is a font (one of: .woff2, .woff, .ttf).</li><li>Obtain a list that maps icon names to Unicode code points (often provided as a JSON like <code spellcheck=\"false\">selection.json</code> or a CSS file).</li><li>Create a manifest JSON that maps icon ids to glyphs and search terms.</li><li>Create a Trilium note of type Code, set language to JSON, paste the manifest as the note content.</li><li>Upload the font file as an attachment to the same note (MIME type must be <code spellcheck=\"false\">font/woff2</code>, <code spellcheck=\"false\">font/woff</code>, or <code spellcheck=\"false\">font/ttf</code> and role <code spellcheck=\"false\">file</code>).</li><li>Add the label <code spellcheck=\"false\">#iconPack=&lt;prefix&gt;</code> to the note (prefix: alphanumeric, hyphen, underscore only).</li><li>Refresh the client and verify the icon pack appears in the icon selector.</li></ol><h2>Verify the icon set</h2><p>The first step is to analyze if the icon set being packed can be integrated into Trilium.</p><p>Trilium only supports <strong>font-based icon sets</strong>, with the following formats:</p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Extension</th>\n<th>MIME type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code spellcheck=\"false\">.woff2</code></td>\n<td><code spellcheck=\"false\">font/woff2</code></td>\n<td>Recommended due to great compression (low size).</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">.woff</code></td>\n<td><code spellcheck=\"false\">font/woff</code></td>\n<td>Higher compatibility, but the font file is bigger.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">.ttf</code></td>\n<td><code spellcheck=\"false\">font/ttf</code></td>\n<td>Most common, but highest font size.</td>\n</tr>\n</tbody></table></figure><p>Trilium <strong>does not</strong> support the following formats:</p><ul><li>SVG-based fonts.</li><li>Individual SVGs.</li><li><code spellcheck=\"false\">.eot</code> fonts (legacy and proprietary).</li><li>Duotone icons, since it requires a special CSS format that Trilium doesn't support.</li><li>Any other font format not specified in the <em>Supported formats</em> section.</li></ul><p>In this case, the font must be manually converted to one of the supported formats (ideally <code spellcheck=\"false\">.woff2</code>).</p><h2>Manifest format</h2><p>The manifest is a JSON object with an <code spellcheck=\"false\">icons</code> map. Each entry key is the CSS/class id you will use (Trilium uses the CSS class when rendering). Value object:</p><ul><li>glyph: the single character (the glyph) — can be the escaped Unicode (e.g. \"\\ue9c2\") or the literal character.</li><li>terms: array of search aliases; the first term is used as display name in the selector.</li></ul><p>Example minimal manifest:</p><pre><code class=\"language-text-x-trilium-auto\">{\n \"icons\": {\n \"ph-acorn\": {\n \"glyph\": \"\\uea3f\",\n \"terms\": [\"acorn\", \"nut\"]\n },\n \"ph-book\": {\n \"glyph\": \"\\uea40\",\n \"terms\": [\"book\", \"read\"]\n }\n }\n}</code></pre><aside class=\"admonition note\"><ul><li>You can supply glyph as the escaped <code spellcheck=\"false\">\\uXXXX</code> sequence or as the actual UTF‑8 character.</li><li>It is also possible to use the unescaped glyph inside the JSON. It will appear strange (e.g. ), but it will be rendered properly regardless.</li><li>The manifest keys (e.g. <code spellcheck=\"false\">ph-acorn</code>) should match the class names used by the font (prefix + name is a common pattern).</li></ul></aside><h2>Concrete example: Phosphor Icons</h2><p><a href=\"https://phosphoricons.com/\">Phosphor Icons</a> provide a <code spellcheck=\"false\">selection.json</code> that includes <code spellcheck=\"false\">properties.code</code> (the codepoint) and <code spellcheck=\"false\">properties.name</code> (the icon name). The goal: convert that into Trilium's manifest.</p><p>Sample <code spellcheck=\"false\">selection.json</code> excerpt:</p><pre><code class=\"language-text-x-trilium-auto\">{\n \"icons\": [\n {\n \"icon\": {\n \"paths\": [ /* [...] */ ],\n \"grid\": 0,\n \"attrs\": [{}],\n \"isMulticolor\": false,\n \"isMulticolor2\": false,\n \"tags\": [\"acorn\"]\n },\n \"attrs\": [{}],\n \"properties\": {\n \"id\": 0,\n \"order\": 1513,\n \"name\": \"acorn\",\n \"code\": 60314,\n \"ligatures\": \"acorn\",\n \"prevSize\": 16\n },\n \"setIdx\": 0,\n \"setId\": 0,\n \"iconIdx\": 0\n },\n /* [...] */\n ]\n}</code></pre><p>A tiny Node.js script to produce the manifest (place <code spellcheck=\"false\">selection.json</code> in the same directory and run with Node 20+):</p><pre><code class=\"language-text-javascript\">import { join } from \"node:path\";\nimport { readFileSync, writeFileSync } from \"node:fs\";\n\nfunction processIconPack(packName) {\n const path = join(packName);\n const selectionMeta = JSON.parse(readFileSync(join(path, \"selection.json\"), \"utf-8\"));\n const icons = {};\n\n for (const icon of selectionMeta.icons) {\n let name = icon.properties.name;\n if (name.endsWith(`-${packName}`)) {\n name = name.split(\"-\").slice(0, -1).join(\"-\");\n }\n\n const id = `ph-${name}`;\n icons[id] = {\n glyph: `${String.fromCharCode(icon.properties.code)}`,\n terms: [ name ]\n };\n }\n\n writeFileSync(\"manifest.json\", JSON.stringify(icons, null, 2), \"utf8\");\n console.log(\"manifest.json created\");\n}\n\nprocessIconPack(\"light\");</code></pre><p>What to do with the script:</p><ul><li>Put <code spellcheck=\"false\">selection.json</code> and <code spellcheck=\"false\">build-manifest.js</code> in a folder.</li><li>Run: node build-manifest.js</li><li>The script writes <code spellcheck=\"false\">manifest.json</code> — open it, verify contents, then copy into a Trilium Code note (language: JSON).</li></ul><aside class=\"admonition tip\"><p><strong>Mind the escape format when processing CSS</strong></p><p>The Unicode escape syntax is different in CSS (<code spellcheck=\"false\">\"\\ea3f\"</code>) when compared to JSON (<code spellcheck=\"false\">\"\\uea3f\"</code>). Notice how the JSON escape is <code spellcheck=\"false\">\\u</code> and not <code spellcheck=\"false\">\\</code>.</p><p>As a more compact alternative, provide the un-escaped character directly, as UTF-8 is supported.</p></aside><h3>Assigning the prefix</h3><p>Before an icon pack can be used, it needs to have a prefix defined. This prefix uniquely identifies the icon pack so that it can be used throughout the application.</p><p>To do so, Trilium makes use of the same format that was used for the internal icon pack (Boxicons). For example, when an icon from Boxicons is set, it looks like this: <code spellcheck=\"false\">#iconClass=\"bx bxs-sushi\"</code>. In this case, the icon pack prefix is <code spellcheck=\"false\">bx</code> and the icon class name is <code spellcheck=\"false\">bxs-sushi</code>.</p><p>In order for an icon pack to be recognized, the prefix must be specified in the <code spellcheck=\"false\">#iconPack</code> label.&nbsp;</p><p>For our example with Phosphor Icons, we can use the <code spellcheck=\"false\">ph</code> prefix since it also matches the prefix set in the original CSS. So in this case it would be <code spellcheck=\"false\">#iconPack=ph</code>.</p><aside class=\"admonition important\"><p>The prefix must consist of only alphanumeric characters, hyphens and underscore. If the prefix doesn't match these constraints, the icon pack will be ignored and an error will be logged in&nbsp;<a class=\"reference-link\" href=\"#root/_help_bnyigUA2UK7s\">Backend (server) logs</a>.</p></aside><h2>Creating the Trilium icon pack note</h2><ol><li>Create a note of type <em>Code</em>.</li><li>Set the language to <em>JSON</em>.</li><li>Rename the note. The name of the note will also be the name of the icon pack as displayed in the list of icons.</li><li>Copy and paste the manifest generated in the previous step as the content of this note.</li><li>Go to the <a href=\"#root/_help_0vhv7lsOLy82\">note attachment</a> and upload the font file (in <code spellcheck=\"false\">.woff2</code>, <code spellcheck=\"false\">.woff</code>, <code spellcheck=\"false\">.ttf</code>) format.<ol><li>Trilium identifies the font to use from attachments via the MIME type, make sure the MIME type is displayed correctly after uploading the attachment (for example <code spellcheck=\"false\">font/woff2</code>).</li><li>Make sure the <code spellcheck=\"false\">role</code> appears as <code spellcheck=\"false\">file</code>, otherwise the font will not be identified.</li><li>Multiple attachments are supported, but only one font will actually be used in Trilium's order of preference: <code spellcheck=\"false\">.woff2</code>, <code spellcheck=\"false\">.woff</code>, <code spellcheck=\"false\">.ttf</code>. As such, there's not much reason to upload more than one font per icon pack.</li></ol></li><li>Add label: <code spellcheck=\"false\">#iconPack=&lt;prefix&gt;</code> (for Phosphor example: <code spellcheck=\"false\">#iconPack=ph</code>).</li></ol><h3>Final steps</h3><ul><li><a href=\"#root/_help_s8alTXmpFR61\">Refresh the client</a><ul><li>Change the icon of the note and look for the <em>Filter</em> icon in the top-right side.</li><li>Check if the new icon pack is displayed there and click on it to see the full list of icons.</li><li>Go through most of the items to look for issues such as missing icon, wrong names (some icons have aliases/terms that can cause issues).</li></ul></li><li>Optionally, assign an icon from the new icon pack to this note. This icon will be used in the icon pack filter for a visual distinction.</li><li>The icon pack can then be <a href=\"#root/_help_mHbBMPDPkVV5\">exported as ZIP</a> in order to be distributed to other users.<ul><li>It's important to note that icon packs are considered “unsafe” by default, so “Safe mode” must be disabled when importing the ZIP.</li><li>Consider linking new users to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_gOKqSJgXLcIj\">Icon Packs</a>&nbsp;documentation in order to understand how to import and use an icon pack.</li></ul></li></ul><h3>Troubleshooting</h3><p>If the icon pack doesn't show up, look through the&nbsp;<a class=\"reference-link\" href=\"#root/_help_bnyigUA2UK7s\">Backend (server) logs</a>&nbsp;for clues.</p><ul><li>One example is if the font could not be retrieved: <code spellcheck=\"false\">ERROR: Icon pack is missing WOFF/WOFF2/TTF attachment: Boxicons v3 400 (dup) (XRzqDQ67fHEK)</code>.</li><li>Make sure the prefix is unique and not already taken by some other icon pack. When there are two icon packs with the same prefix, only one is used. The server logs will indicate if this situation occurs.</li><li>Make sure the prefix consists only of alphanumeric characters, hyphens and underscore.</li></ul>",
- "_help_zEY4DaJG4YT5": "<figure class=\"image\"><img style=\"aspect-ratio:1071/146;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Attributes_image.png\" width=\"1071\" height=\"146\"></figure><p>In Trilium, attributes are key-value pairs assigned to notes, providing additional metadata or functionality. There are two primary types of attributes:</p><ol><li><p><a class=\"reference-link\" href=\"#root/_help_HI6GBBIduIgv\">Labels</a>&nbsp;can be used for a variety of purposes, such as storing metadata or configuring the behavior of notes. Labels are also searchable, enhancing note retrieval.</p><p>For more information, including predefined labels, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_HI6GBBIduIgv\">Labels</a>.</p></li><li><p><a class=\"reference-link\" href=\"#root/_help_Cq5X6iKQop6R\">Relations</a>&nbsp;define connections between notes, similar to links. These can be used for metadata and scripting purposes.</p><p>For more information, including a list of predefined relations, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_Cq5X6iKQop6R\">Relations</a>.</p></li></ol><p>These attributes play a crucial role in organizing, categorizing, and enhancing the functionality of notes.</p><h2>Types of attributes</h2><p>Conceptually there are two types of attributes (applying to both labels and relations):</p><ol><li><strong>System attributes</strong><br>As the name suggest, these attributes have a special meaning since they are interpreted by Trilium. For example the <code spellcheck=\"false\">color</code> attribute will change the color of the note as displayed in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and links, and <code spellcheck=\"false\">iconClass</code> will change the icon of a note.</li><li><strong>User-defined attributes</strong><br>These are free-form labels or relations that can be used by the user. They can be used purely for categorization purposes (especially if combined with&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>), or they can be given meaning through the use of&nbsp;<a class=\"reference-link\" href=\"#root/_help_CdNpE2pqjmI6\">Scripting</a>.</li></ol><p>In practice, Trilium makes no direct distinction of whether an attribute is a system one or a user-defined one. A label or relation is considered a system attribute if it matches one of the built-in names (e.g. like the aforementioned <code spellcheck=\"false\">iconClass</code>). Keep this in mind when creating &nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;in order not to accidentally alter a system attribute (unless intended).</p><h2>Viewing the list of attributes</h2><p>Both the labels and relations for the current note are displayed in the <em>Owned Attributes</em> section of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_BlN9DFI679QC\">Ribbon</a>, where they can be viewed and edited. Inherited attributes are displayed in the <em>Inherited Attributes</em> section of the ribbon, where they can only be viewed.</p><p>In the list of attributes, labels are prefixed with the <code spellcheck=\"false\">#</code> character whereas relations are prefixed with the <code spellcheck=\"false\">~</code> character.</p><h2>Attribute Definitions and Promoted Attributes</h2><p><a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;create a form-like editing experience for attributes, which makes it easy to enhancing the organization and management of attributes</p><h2>Multiplicity</h2><p>Attributes in Trilium can be \"multi-valued\", meaning multiple attributes with the same name can co-exist. This can be combined with&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;to easily add them.</p><h2>Attribute Inheritance</h2><p>Trilium supports attribute inheritance, allowing child notes to inherit attributes from their parents. For more information, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_bwZpz2ajCEwO\">Attribute Inheritance</a>.</p>",
- "_help_HI6GBBIduIgv": "<p>A label is an <a href=\"#root/_help_zEY4DaJG4YT5\">attribute</a> of a note which has a name and optionally a value.</p><h2>Common use cases</h2><ul><li><strong>Metadata for personal use</strong>: Assign labels with optional values for categorization, such as <code spellcheck=\"false\">#year=1999</code>, <code spellcheck=\"false\">#genre=\"sci-fi\"</code>, or <code spellcheck=\"false\">#author=\"Neal Stephenson\"</code>. This can be combined with&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;to make their display more user-friendly.</li><li><strong>Configuration</strong>: Labels can configure advanced features or settings (see reference below).</li><li><strong>Scripts and Plugins</strong>: Used to tag notes with special metadata, such as the \"weight\" attribute in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_R7abl2fc6Mxi\">Weight Tracker</a>.</li></ul><h2>Creating a label using the visual editor</h2><ol><li>Go to the <em>Owned Attributes</em> section in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_BlN9DFI679QC\">Ribbon</a>.</li><li>Press the + button (<em>Add new attribute</em>) to the right.</li><li>Select <em>Add new label</em> for the relation.</li></ol><aside class=\"admonition tip\"><p>If you prefer keyboard shortcuts, press <kbd>Alt</kbd>+<kbd>L</kbd> while focused on a note or in the <em>Owned Attributes</em> section to display the visual editor.</p></aside><p>While in the visual editor:</p><ul><li>Set the desired name</li><li>Optionally, set the value of the label. Labels can exist without a value.</li><li>Check <em>Inheritable</em> if the label should be inherited by the child notes as well. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_bwZpz2ajCEwO\">Attribute Inheritance</a>&nbsp;for more information.</li></ul><h2>Creating a label manually</h2><p>In the <em>Owned Attributes</em> section in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_BlN9DFI679QC\">Ribbon</a>:</p><ul><li>To create a label called <code spellcheck=\"false\">myLabel</code> with no value, simply type <code spellcheck=\"false\">#myLabel</code>.</li><li>To create a label called <code spellcheck=\"false\">myLabel</code> with a value <code spellcheck=\"false\">value</code>, simply type <code spellcheck=\"false\">#myLabel=value</code>.</li><li>If the value contains spaces, then the text must be quoted: <code spellcheck=\"false\">#myLabel=\"Hello world\"</code>.</li><li>If the string contains quotes (regardless of whether it has spaces), then the text must be quoted with apostrophes instead: <code spellcheck=\"false\">#myLabel='Hello \"world\"'</code>.</li><li>To create an inheritable label called <code spellcheck=\"false\">myLabel</code>, simply write <code spellcheck=\"false\">#myLabel(inheritable)</code> for no value or <code spellcheck=\"false\">#myLabel(inheritable)=value</code> if there is a value.</li></ul><h2>Predefined labels</h2><p>This is a list of labels that Trilium natively supports.</p><aside class=\"admonition tip\"><p>Some labels presented here end with a <code spellcheck=\"false\">*</code>. That means that there are multiple labels with the same prefix, consult the specific page linked in the description of that label for more information.</p></aside><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Label</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code spellcheck=\"false\">disableVersioning</code></td>\n<td>Disables automatic creation of&nbsp;<a class=\"reference-link\" href=\"#root/_help_vZWERwf8U3nx\">Note Revisions</a>&nbsp;for a particular note. Useful for e.g. large, but unimportant notes - e.g. large JS libraries used for scripting.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">versioningLimit</code></td>\n<td>Limits the maximum number of&nbsp;<a class=\"reference-link\" href=\"#root/_help_vZWERwf8U3nx\">Note Revisions</a>&nbsp;for a particular note, overriding the global settings.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">calendarRoot</code></td>\n<td>Marks the note which should be used as root for&nbsp;<a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a>. Only one should be marked as such.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">archived</code></td>\n<td>Hides notes from default search results and dialogs. Archived notes can optionally be hidden in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">excludeFromExport</code></td>\n<td>Excludes this note and its children when exporting.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">run</code>, <code spellcheck=\"false\">runOnInstance</code>, <code spellcheck=\"false\">runAtHour</code></td>\n<td>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_GPERMystNGTB\">Events</a>.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">disableInclusion</code></td>\n<td>Scripts with this label won't be included into parent script execution.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">sorted</code>, <code spellcheck=\"false\">sortDirection</code>, <code spellcheck=\"false\">sortFoldersFirst</code>, <code spellcheck=\"false\">sortNatural</code>, <code spellcheck=\"false\">sortLocale</code>, <code spellcheck=\"false\">top</code>, <code spellcheck=\"false\">bottom</code></td>\n<td>Manages automatic/permanent sorting. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_aGlEvb9hyDhS\">Sorting Notes</a>.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">hidePromotedAttributes</code></td>\n<td>Hide&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;on this note. Generally useful when defining inherited attributes, but the parent note doesn't need them.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">readOnly</code></td>\n<td>Marks a note to always be <a href=\"#root/_help_CoFPLs3dRlXc\">read-only</a>, if it's a supported note (text, code, mermaid).</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">autoReadOnlyDisabled</code></td>\n<td>Disables automatic <a href=\"#root/_help_CoFPLs3dRlXc\">read-only mode</a> for the given note.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">appCss</code></td>\n<td>Marks CSS notes which are loaded into the Trilium application and can thus be used to modify Trilium's looks. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlhDUqhENtH7\">Custom app-wide CSS</a>&nbsp;for more info.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">appTheme</code></td>\n<td>Marks CSS notes which are full Trilium themes and are thus available in Trilium options. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_pKK96zzmvBGf\">Theme development</a>&nbsp;for more information.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">appThemeBase</code></td>\n<td>Set to <code spellcheck=\"false\">next</code>, <code spellcheck=\"false\">next-light</code>, or <code spellcheck=\"false\">next-dark</code> to use the corresponding TriliumNext theme (auto, light or dark) as the base for a custom theme, instead of the legacy one. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_WFGzWeUK6arS\">Customize the Next theme</a>&nbsp;for more information.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">cssClass</code></td>\n<td>Value of this label is then added as CSS class to the node representing given note in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>. This can be useful for advanced theming. Can be used in template notes.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">iconClass</code></td>\n<td>value of this label is added as a CSS class to the icon on the tree which can help visually distinguish the notes in the tree. Example might be bx bx-home - icons are taken from boxicons. Can be used in template notes.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">pageSize</code></td>\n<td>Specifies the number of items per page in&nbsp;<a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a>.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">customRequestHandler</code></td>\n<td>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_J5Ex1ZrMbyJ6\">Custom Request Handler</a>.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">customResourceProvider</code></td>\n<td>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_d3fAXQ2diepH\">Custom Resource Providers</a>.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">widget</code></td>\n<td>Marks this note as a custom widget which will be added to the Trilium component tree. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>&nbsp;for more information.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">searchHome</code></td>\n<td>New search notes will be created as children of this note (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a>).</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">workspace</code> and related attributes</td>\n<td>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_9sRHySam5fXb\">Workspaces</a>.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">inbox</code></td>\n<td>Default inbox location for new notes. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_S0Fos78ZfcY7\">Note Inbox</a>&nbsp;for more information.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">sqlConsoleHome</code></td>\n<td>Default location of&nbsp;<a class=\"reference-link\" href=\"#root/_help_YKWqdJhzi2VY\">SQL Console</a>&nbsp;saved queries.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">bookmarked</code></td>\n<td>Indicates this note is a <a href=\"#root/_help_u3YFHC9tQlpm\">bookmark</a>.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">bookmarkFolder</code></td>\n<td>Note with this label will appear in bookmarks as folder (allowing access to its children). See&nbsp;<a class=\"reference-link\" href=\"#root/_help_u3YFHC9tQlpm\">Bookmarks</a>&nbsp;for more information.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">share*</code></td>\n<td>See the attribute reference in&nbsp;<a class=\"reference-link\" href=\"#root/_help_R9pX4DGra2Vt\">Sharing</a>.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">displayRelations</code>, <code spellcheck=\"false\">hideRelations</code></td>\n<td>Comma delimited names of relations which should be displayed/hidden in a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iRwzGnHPzonm\">Relation Map</a>&nbsp;(both the note type and the&nbsp;<a class=\"reference-link\" href=\"#root/_help_BCkXAVs63Ttv\">Note Map (Link map, Tree map)</a>&nbsp;general functionality).</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">titleTemplate</code></td>\n<td>Default title of notes created as children of this note. This value is evaluated as a JavaScript string and thus can be enriched with dynamic content via the injected <code spellcheck=\"false\">now</code> and <code spellcheck=\"false\">parentNote</code> variables.&nbsp; <br> <br>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_47ZrP6FNuoG8\">Default Note Title</a>&nbsp;for more info.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">template</code></td>\n<td>This note will appear in the selection of available template when creating new note. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>&nbsp;for more information.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">toc</code></td>\n<td>Controls the display of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_BFvAtE74rbP6\">Table of contents</a>&nbsp;for a given note. <code spellcheck=\"false\">#toc</code> or <code spellcheck=\"false\">#toc=show</code> to always display the table of contents, <code spellcheck=\"false\">#toc=false</code> to always hide it.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">color</code></td>\n<td>defines color of the note in note tree, links etc. Use any valid CSS color value like 'red' or #a13d5f&nbsp;&nbsp; <br>Note: this color may be automatically adjusted when displayed to ensure sufficient contrast with the background.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">keyboardShortcut</code></td>\n<td>Defines a keyboard shortcut which will immediately jump to this note. Example: 'ctrl+alt+e'. Requires frontend reload for the change to take effect.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">keepCurrentHoisting</code></td>\n<td>Opening this link won't change hoisting even if the note is not displayable in the current hoisted subtree.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">executeButton</code></td>\n<td>Title of the button which will execute the current code note</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">executeDescription</code></td>\n<td>Longer description of the current code note displayed together with the execute button</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">excludeFromNoteMap</code></td>\n<td>Notes with this label will be hidden from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_bdUJEHsAPYQR\">Note Map</a>.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">newNotesOnTop</code></td>\n<td>New notes will be created at the top of the parent note, not on the bottom.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">hideHighlightWidget</code></td>\n<td>Hides the&nbsp;<a class=\"reference-link\" href=\"#root/_help_AxshuNRegLAv\">Highlights list</a>&nbsp;widget</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">hideChildrenOverview</code></td>\n<td>Hides the&nbsp;<a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a>&nbsp;for that particular note.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">subtreeHidden</code></td>\n<td>Hides all child notes of this note from the tree, displaying a badge with the count of hidden children. Children remain accessible via search or direct links.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">printLandscape</code></td>\n<td>When exporting to PDF, changes the orientation of the page to landscape instead of portrait.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">printPageSize</code></td>\n<td>When exporting to PDF, changes the size of the page. Supported values: <code spellcheck=\"false\">A0</code>, <code spellcheck=\"false\">A1</code>, <code spellcheck=\"false\">A2</code>, <code spellcheck=\"false\">A3</code>, <code spellcheck=\"false\">A4</code>, <code spellcheck=\"false\">A5</code>, <code spellcheck=\"false\">A6</code>, <code spellcheck=\"false\">Legal</code>, <code spellcheck=\"false\">Letter</code>, <code spellcheck=\"false\">Tabloid</code>, <code spellcheck=\"false\">Ledger</code>.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">printScale</code>, <code spellcheck=\"false\">printMargins</code></td>\n<td>Additional printing options, generally configured through the&nbsp;<a class=\"reference-link\" href=\"#root/_help_NRnIZmSMc5sj\">Printing &amp; Exporting as PDF</a>&nbsp;dialog.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">geolocation</code></td>\n<td>Indicates the latitude and longitude of a note, to be displayed in a&nbsp;<a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map</a>.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">map:*</code></td>\n<td>Defines specific options for the&nbsp;<a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map</a>.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">calendar:*</code></td>\n<td>Defines specific options for the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xWbu3jpNWapp\">Calendar</a>.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">viewType</code></td>\n<td>Sets the view of child notes (e.g. grid or list). See&nbsp;<a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a>&nbsp;for more information.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">webViewSrc</code></td>\n<td>Defines the URL of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_1vHRoWCEjj0L\">Web View</a>.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">tabWidth</code>, <code spellcheck=\"false\">indentWithTabs</code>, <code spellcheck=\"false\">wrapLines</code></td>\n<td>Per-note Code editor settings: indentation width, indent with tabs vs. spaces, and word wrapping. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">datePattern</code>, <code spellcheck=\"false\">weekPattern</code>, <code spellcheck=\"false\">monthPattern</code>, <code spellcheck=\"false\">quarterPattern</code>, <code spellcheck=\"false\">yearPattern</code></td>\n<td>Customizes the title naming pattern of day / week / month / quarter / year notes. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a>.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">enableWeekNote</code>, <code spellcheck=\"false\">enableQuarterNote</code></td>\n<td>Enables optional week and quarter notes in the calendar hierarchy; set on the calendar root. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a>.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">fullContentWidth</code></td>\n<td>Expands the note to the full editor width, ignoring the configured content width (useful for wide tables). See&nbsp;<a class=\"reference-link\" href=\"#root/_help_t596jLvPrqkS\">Content width</a>.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">iconPack</code></td>\n<td>Identifies a custom icon pack by its prefix. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_g1mlRoU8CsqC\">Creating an icon pack</a>.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">clipperInbox</code></td>\n<td>Overrides the default location where the Web Clipper saves clippings (defaults to the day note). See&nbsp;<a class=\"reference-link\" href=\"#root/_help_MtPxeAWVAzMg\">Web Clipper</a>.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">similarNotesWidgetDisabled</code></td>\n<td>Disables the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xWtq5NUHOwql\">Similar Notes</a>&nbsp;ribbon tab (old layout only)</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">docName</code> , <code spellcheck=\"false\">docUrl</code></td>\n<td>Used internally for the in-app help.</td>\n</tr>\n</tbody></table></figure>",
- "_help_Cq5X6iKQop6R": "<p>A relation is similar to a <a href=\"#root/_help_HI6GBBIduIgv\">label</a>, but instead of having a text value it refers to another note.</p><h2>Common use cases</h2><ul><li><strong>Metadata Relationships for personal use</strong>: For example, linking a book note to an author note.<br>This can be combined with&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;to make their display more user-friendly.</li><li><strong>Configuration</strong>: For configuring some notes such as&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>, or configuring&nbsp;<a class=\"reference-link\" href=\"#root/_help_R9pX4DGra2Vt\">Sharing</a>&nbsp;or&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>&nbsp;(see the list below).</li><li><strong>Scripting</strong>: Attaching scripts to events or conditions related to the note.</li></ul><h2>Creating a relation using the visual editor</h2><ol><li>Go to the <em>Owned Attributes</em> section in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_BlN9DFI679QC\">Ribbon</a>.</li><li>Press the + button (<em>Add new attribute</em>) to the right.</li><li>Select <em>Add new relation</em> for the relation.</li></ol><aside class=\"admonition tip\"><p>If you prefer keyboard shortcuts, press <kbd>Alt</kbd>+<kbd>L</kbd> while focused on a note or in the <em>Owned Attributes</em> section to display the visual editor.</p></aside><p>While in the visual editor:</p><ul><li>Set the desired name</li><li>Set the Target note (the note to point to). Unlike labels, relations cannot exist with a target note.</li><li>Check <em>Inheritable</em> if the label should be inherited by the child notes as well. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_bwZpz2ajCEwO\">Attribute Inheritance</a>&nbsp;for more information.</li></ul><h2>Creating a relation manually</h2><p>In the <em>Owned Attributes</em> section in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_BlN9DFI679QC\">Ribbon</a>:</p><ul><li>To create a relation called <code spellcheck=\"false\">myRelation</code>:<ul><li>First type <code spellcheck=\"false\">~myRelation=@</code> .</li><li>After this, an autocompletion box should appear.</li><li>Type the title of the note to point to and press <kbd>Enter</kbd> to confirm (or click the desired note).</li><li>Alternatively copy a note from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and paste it after the <code spellcheck=\"false\">=</code> sign (without the <code spellcheck=\"false\">@</code> , in this case).</li></ul></li><li>To create an inheritable relation, follow the same steps as previously described but instead of <code spellcheck=\"false\">~myRelation</code> write <code spellcheck=\"false\">~myRelation(inheritable)</code>.</li></ul><h2>Predefined relations</h2><p>These relations are supported and used internally by Trilium.</p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Label</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code spellcheck=\"false\">runOn*</code></td>\n<td>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_GPERMystNGTB\">Events</a></td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">template</code></td>\n<td>note's attributes will be inherited even without a parent-child relationship, note's content and subtree will be added to instance notes if empty. See documentation for details.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">inherit</code></td>\n<td>note's attributes will be inherited even without a parent-child relationship. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>&nbsp;for a similar concept. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_bwZpz2ajCEwO\">Attribute Inheritance</a>&nbsp;in the documentation.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">renderNote</code></td>\n<td>notes of type&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>&nbsp;will be rendered using a code note (HTML or script) and it is necessary to point using this relation to which note should be rendered</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">widget</code></td>\n<td>Used in the context of custom&nbsp;<a class=\"reference-link\" href=\"#root/_help_4Gn3psZKsfSm\">Launch Bar Widgets</a>, to refer to the widget that will be rendered.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">shareCss</code></td>\n<td>CSS note which will be injected into the share page. CSS note must be in the shared sub-tree as well. Consider using <code spellcheck=\"false\">shareHiddenFromTree</code> and <code spellcheck=\"false\">shareOmitDefaultCss</code> as well.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">shareJs</code></td>\n<td>JavaScript note which will be injected into the share page. JS note must be in the shared sub-tree as well. Consider using <code spellcheck=\"false\">shareHiddenFromTree</code>.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">shareHtml</code></td>\n<td>HTML note which will be injected into the share page at locations specified by the <code spellcheck=\"false\">shareHtmlLocation</code> label. HTML note must be in the shared sub-tree as well. Consider using <code spellcheck=\"false\">shareHiddenFromTree</code>.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">shareTemplate</code></td>\n<td>Embedded JavaScript note that will be used as the template for displaying the shared note. Falls back to the default template. Consider using <code spellcheck=\"false\">shareHiddenFromTree</code>.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">shareFavicon</code></td>\n<td>Favicon note to be set in the shared page. Typically you want to set it to share root and make it inheritable. Favicon note must be in the shared sub-tree as well. Consider using <code spellcheck=\"false\">shareHiddenFromTree</code>.</td>\n</tr>\n</tbody></table></figure>",
- "_help_bwZpz2ajCEwO": "<p>Inheritance refers to the process of having a <a href=\"#root/_help_HI6GBBIduIgv\">label</a> or a <a href=\"#root/_help_Cq5X6iKQop6R\">relation</a> shared across multiple notes, generally in parent-child relations (or anywhere if using templates).</p><h2>Standard Inheritance</h2><p>In Trilium, attributes can be automatically inherited by child notes if they have the <code spellcheck=\"false\">isInheritable</code> flag set to <code spellcheck=\"false\">true</code>. This means the attribute (a key-value pair) is applied to the note and all its descendants.</p><p>To make an attribute inheritable, simply use the visual editor for&nbsp;<a class=\"reference-link\" href=\"#root/_help_HI6GBBIduIgv\">Labels</a>&nbsp;or&nbsp;<a class=\"reference-link\" href=\"#root/_help_Cq5X6iKQop6R\">Relations</a>. Alternatively, the attribute can be manually defined where <code spellcheck=\"false\">#myLabel=value</code> becomes <code spellcheck=\"false\">#myLabel(inheritable)=value</code> when inheritable.</p><p>As an example, the <code spellcheck=\"false\">archived</code> label can be set to be inheritable, allowing you to hide a whole subtree of notes from searches and other dialogs by applying this label at the top level.</p><p>Standard inheritance forces all the notes that are children (and sub-children) of a note to have that particular label or relation. If there is a need to have some notes not inherit one of the labels, then <em>copying inheritance</em> or <em>template inheritance</em> needs to be used instead.</p><h2>Copying Inheritance</h2><p>Copying inheritance differs from standard inheritance by using a <code spellcheck=\"false\">child:</code> prefix in the attribute name. This prefix causes new child notes to automatically receive specific attributes from the parent note. These attributes are independent of the parent and will persist even if the note is moved elsewhere.</p><p>If a parent note has the label <code spellcheck=\"false\">#child:exampleAttribute</code>, all newly created child notes (one level deep) will inherit the <code spellcheck=\"false\">#exampleAttribute</code> label. This can be useful for setting default properties for notes in a specific section.</p><p>Similarly, for relations use <code spellcheck=\"false\">~child:myRelation</code>.</p><p>Due to the way it's designed, copying inheritance cannot be used to cascade infinitely within a hierarchy. For that use case, consider using either standard inheritance or templates.</p><h3>Chained inheritance</h3><p>It is possible to define labels across multiple levels of depth. For example, <code spellcheck=\"false\">#child:child:child:foo</code> applied to a root note would create:</p><ul><li><code spellcheck=\"false\">#child:child:foo</code> on the first-level children.</li><li><code spellcheck=\"false\">#child:foo</code> on the second-level children.</li><li><code spellcheck=\"false\">#foo</code> on the third-level children.</li></ul><p>Similarly, use <code spellcheck=\"false\">~child:child:child:foo</code> if dealing with relations.</p><p>Do note that same as simple copying inheritance, the changes will not apply retroactively to existing notes in the hierarchy, it will only apply to the newly created notes.</p><h2>Template Inheritance</h2><p>Attributes can also be inherited from&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>. When a new note is created using a template, it inherits the attributes defined in that template. This is particularly useful for maintaining consistency across notes that follow a similar structure or function.</p>",
- "_help_OFXdgB2nNk1F": "<figure class=\"image image_resized\" style=\"width:61.4%;\"><img style=\"aspect-ratio:938/368;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Attributes/Promoted%20Attributes_image.png\" width=\"938\" height=\"368\"></figure><p>Promoted attributes are <a href=\"#root/_help_zEY4DaJG4YT5\">attributes</a> which are displayed prominently in the UI which allow them to be easily viewed and edited.</p><p>One way of seeing promoted attributes is as a kind of form with several fields. Each field is just regular attribute, the only difference is that they appear on the note itself.</p><p>Attributes can be pretty useful since they allow for querying and script automation etc. but they are also inconveniently hidden. This allows you to select few of the important ones and push them to the front of the user.</p><h2>Attribute definition</h2><figure class=\"image image-style-align-right image_resized\" style=\"width:50%;\"><img style=\"aspect-ratio:885/742;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Attributes/2_Promoted%20Attributes_image.png\" width=\"885\" height=\"742\"></figure><p>In order to have promoted attributes, there needs to be a way to define them.</p><p>Technically, attributes are only name-value pairs where both name and value are strings.</p><p>The <em>Attribute definition</em> specifies how should this value be interpreted:</p><ul><li>Is it just string, or is it a date?</li><li>Should we allow multiple values or note?</li><li>Should we <em>promote</em> the attribute or not?</li></ul><h2>Types of attributes</h2><p>Attribute definitions have a dedicated type field which will change how the value will be edited in the promoted attributes section.</p><p>The following types are supported:</p><ul><li><em>Text</em>, the default option which allows any type of text to be edited, similar to normal labels that don't have a type associated.</li><li><em>Multi-line text</em>, similar to a normal text field, but rendered in a bigger text box that also supports writing on multiple lines.</li><li><em>Number</em>, will display as a number input field with up/down arrows.<ul><li>Optionally a <em>precision</em> which sets how many decimals the value steps by and is displayed with.</li></ul></li><li><em>Boolean</em>, which renders as a checkbox for a true/false value.</li><li><em>Select,</em> which provides a list of user-defined options when editing.<ul><li>The list is not fixed, meaning that new options can be easily added from the promoted attribute.</li><li>Renaming an option does not change the existing values since the value is stored as text. Consider a <a href=\"#root/_help_ivYnonVFBxbQ\">bulk rename</a>.</li><li>The items do not have a custom color or icon. This is intentional as selects are meant to be light-weight. For a more customizable option, consider using&nbsp;<a class=\"reference-link\" href=\"#root/_help_Cq5X6iKQop6R\">Relations</a>&nbsp;instead which use notes as items and those notes can be colorized and also carry an icon.</li></ul></li><li><em>Date,</em> which provides a date picker.</li><li><em>Date &amp; Time,</em> which provides a date &amp; time picker.</li><li><em>Time,</em> which provides a time picker.</li><li><em>URL,</em> which provides a button to open the web address in a new window.</li><li><em>Email</em>, which provides a button to quickly send an email to that address using your operating system's default app.</li><li><em>Phone</em>, which provides a button to quickly call that number using your operating system's default app.</li><li><em>Color</em>, which provides a color picker and a way to remove the value.</li><li><em>Relation</em>, which points to another note and uses&nbsp;<a class=\"reference-link\" href=\"#root/_help_Cq5X6iKQop6R\">Relations</a>&nbsp;instead of&nbsp;<a class=\"reference-link\" href=\"#root/_help_HI6GBBIduIgv\">Labels</a>.</li></ul><aside class=\"admonition note\"><p>For label-based attributes, these types are not enforced by the attribute system, meaning that changing the type afterwards does not guarantee that the values in it correspond to the type (e.g. turning a text into a number).</p></aside><h2>Creating a new promoted attribute definition</h2><p>To create a new promoted attribute:</p><ol><li>Go to a note.</li><li>Go to <em>Owned Attributes</em> in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_BlN9DFI679QC\">Ribbon</a>.</li><li>Press the + button.</li><li>Select either <em>Add new label definition</em> or <em>Add new relation definition</em>.</li><li>Select the name which will be name of the label or relation that will be created when the promoted attribute is edited.</li><li>Ensure <em>Promoted</em> is checked in order to display it at the top of notes.</li><li>Optionally, choose an <em>Alias</em> which will be displayed next to the promoted attribute instead of the attribute name. Generally it's best to choose a “user-friendly” name since it can contain spaces and other characters which are not supported as attribute names.</li><li>Check <em>Inheritable</em> to apply it to this note and all its descendants. To keep it only for the current note, un-check it.</li><li>Press “Save &amp; Close” to apply the changes.</li></ol><h2>How attribute definitions actually work</h2><p>When a new promoted attribute definition is created, it creates a corresponding label prefixed with either <code spellcheck=\"false\">label</code> or <code spellcheck=\"false\">relation</code>, depending on the definition type:</p><pre><code class=\"language-text-x-trilium-auto\">#label:myColor(inheritable)=\"promoted,alias=Color,multi,color\"</code></pre><p>The only purpose of the attribute definition is to set up a template. If the attribute was marked as promoted, then it's also displayed to the user for easy editing.</p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th></th>\n<th></th>\n</tr>\n</thead>\n<tbody><tr>\n<td><figure class=\"image\"><img style=\"aspect-ratio:495/157;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Attributes/1_Promoted%20Attributes_image.png\" width=\"495\" height=\"157\"></figure></td>\n<td>Notice how the promoted attribute definition only creates a “Due date” box above the text content.</td>\n</tr>\n<tr>\n<td><figure class=\"image\"><img style=\"aspect-ratio:663/160;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Attributes/3_Promoted%20Attributes_image.png\" width=\"663\" height=\"160\"></figure></td>\n<td>Once a value is set by the user, a new label (or relation, depending on the type) is created. The name of the attribute matches one set when creating the promoted attribute.</td>\n</tr>\n</tbody></table></figure><p>So there's one attribute for value and one for definition. But notice how an definition attribute can be made <a href=\"#root/_help_bwZpz2ajCEwO\">Inheritable</a>, meaning that it's also applied to all descendant notes. In this case, the definition used for the whole sub-tree while \"value\" attributes are for each not individually.</p><h2>Using system attributes</h2><p>It's possible to create promoted attributes out of system attributes, to be able to easily alter them.</p><p>Here are a few practical examples:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>&nbsp;already make use of this practice, for example:<ul><li>Calendars add “Start Date”, “End Date”, “Start Time” and “End Time” as promoted attributes. These map to system attributes such as <code spellcheck=\"false\">startDate</code> which are then interpreted by the calendar view.</li><li><a class=\"reference-link\" href=\"#root/_help_zP3PMqaG71Ct\">Presentation</a>&nbsp;adds a “Background” promoted attribute for each of the slide to easily be able to customize.</li></ul></li><li>The Trilium documentation (which is edited in Trilium) uses a promoted attribute to be able to easily edit the <code spellcheck=\"false\">#shareAlias</code> (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_R9pX4DGra2Vt\">Sharing</a>) in order to form clean URLs.</li><li>If you always edit a particular system attribute such as <code spellcheck=\"false\">#color</code>, simply create a promoted attribute for it to make it easier.</li></ul><h3>Inverse relation</h3><p>Some relations always occur in pairs - my favorite example is on the family. If you have a note representing husband and note representing wife, then there might be a relation between those two of <code spellcheck=\"false\">isPartnerOf</code>. This is bidirectional relationship - meaning that if a relation is pointing from husband to wife then there should be always another relation pointing from wife to husband.</p><p>Another example is with parent-child relationship. Again these always occur in pairs, but in this case it's not exact same relation - the one going from parent to child might be called <code spellcheck=\"false\">isParentOf</code> and the other one going from child to parent might be called <code spellcheck=\"false\">isChildOf</code>.</p><p>Relation definition allows you to specify such \"inverse relation\" - for the relation you just define you specify which is the inverse relation. Note that in the second example we should have two relation definitions - one for <code spellcheck=\"false\">isParentOf</code> which defines <code spellcheck=\"false\">isChildOf</code> as inverse relation and then second relation definition for <code spellcheck=\"false\">isChildOf</code> which defines <code spellcheck=\"false\">isParentOf</code> as inverse relation.</p><p>What this does internally is that whenever we save a relation which has defined inverse relation, we check that this inverse relation exists on the relation target note. Similarly, when we delete relation, we also delete inverse relation on the target note.</p><h2>See also</h2><ul><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_2FvYrpmOXm29\">Table</a>&nbsp;collection makes heavy use of promoted attributes to define the columns of the table, since they already carry the type information. When made inheritable, it's also easy to change those fields when the child notes are opened.</li></ul>",
- "_help_KC1HB96bqqHX": "<p>A template in Trilium serves as a predefined structure for other notes, referred to as instance notes. Assigning a template to a note brings three main effects:</p><ol><li><strong>Attribute Inheritance</strong>: All attributes from the template note are <a href=\"#root/_help_bwZpz2ajCEwO\">inherited</a> by the instance notes. Even attributes with <code spellcheck=\"false\">#isInheritable=false</code> are inherited by the instance notes, although only inheritable attributes are further inherited by the children of the instance notes.</li><li><strong>Content Duplication</strong>: The content of the template note is copied to the instance note, provided the instance note is empty at the time of template assignment.</li><li><strong>Child Note Duplication</strong>: All child notes of the template are deep-duplicated to the instance note.</li></ol><h2>Example</h2><p>A typical example would be a \"Book\" template note, which might include:</p><ul><li><strong>Promoted Attributes</strong>: Such as publication year, author, etc. (see <a href=\"#root/_help_OFXdgB2nNk1F\">promoted attributes</a>).</li><li><strong>Outline</strong>: An outline for a book review, including sections like themes, conclusion, etc.</li><li><strong>Child Notes</strong>: Additional notes for highlights, summary, etc.</li></ul><p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Templates_template.png\" alt=\"Template Example\"></p><h2>Instance Note</h2><p>An instance note is a note related to a template note. This relationship means the instance note's content is initialized from the template, and all attributes from the template are inherited.</p><p>To create an instance note through the UI:</p><p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Templates_template-create-instance-note.png\" alt=\"show child note templates\"></p><p>For the template to appear in the menu, the template note must have the <code spellcheck=\"false\">#template</code> label. Do not confuse this with the <code spellcheck=\"false\">~template</code> relation, which links the instance note to the template note. If you use <a href=\"#root/_help_9sRHySam5fXb\">workspaces</a>, you can also mark templates with <code spellcheck=\"false\">#workspaceTemplate</code> to display them only in the workspace.</p><p>Templates can also be added or changed after note creation by creating a <code spellcheck=\"false\">~template</code> relation pointing to the desired template note.&nbsp;</p><p>To specify a template for child notes, you can use a <code spellcheck=\"false\">~child:template</code> relation pointing to the appropriate template note. There is no limit to the depth of the hierarchy — you can use <code spellcheck=\"false\">~child:child:template</code>, <code spellcheck=\"false\">~child:child:child:template</code>, and so on.</p><aside class=\"admonition important\"><p>Changing the template hierarchy after the parent note is created will not retroactively apply to newly created child notes.<br>For example, if you initially use <code spellcheck=\"false\">~child:template</code> and later switch to <code spellcheck=\"false\">~child:child:template</code>, it will not automatically apply the new template to the grandchild notes. Only the structure present at the time of note creation is considered.</p></aside><h2>Regarding note types</h2><p>By default, newly created notes are&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes. If a parent note defines a <code spellcheck=\"false\">child:template</code> pointing to a template of a different type (e.g. a Code note), the behavior depends on how the new note is created:</p><ul><li>If no note type is explicitly chosen (e.g. the + button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>), the template is applied and the new note takes the type and content of the template.</li><li>If a note type is explicitly selected (e.g.&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;→ <em>Insert note after</em> / <em>Insert child note</em>):<ul><li>If the selected type matches the template's type, the template is applied.</li><li>If the selected type differs, the template is disregarded entirely — the new note is an empty note of the selected type.</li></ul></li></ul><p>Selecting a specific template from the creation menu always takes precedence over <code spellcheck=\"false\">child:template</code>.</p><h2>Additional Notes</h2><p>From a visual perspective, templates can define <code spellcheck=\"false\">#iconClass</code> and <code spellcheck=\"false\">#cssClass</code> attributes, allowing all instance notes (e.g., books) to display a specific icon and CSS style.</p><p>Explore the concept further in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_6tZeKvSHEUiB\">Demo Notes</a>, including examples like the&nbsp;<a class=\"reference-link\" href=\"#root/_help_iRwzGnHPzonm\">Relation Map</a>,&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYjQUYhpbUEW\">Task Manager</a>, and&nbsp;<a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a>.</p><p>Additionally, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_47ZrP6FNuoG8\">Default Note Title</a>&nbsp;for creating title templates. Note templates and title templates can be combined by creating a <code spellcheck=\"false\">#titleTemplate</code> for a template note.</p>",
++ "_help_7NfNr5pZpVKV": "<h2>Step 1. Find a place to place the themes</h2><p>Organization is an important aspect of managing a knowledge base. When developing a new theme or importing an existing one it's a good idea to keep them into one place.</p><p>As such, the first step is to create a new note to gather all the themes.</p><p><img src=\"{{helpAssets}}/User%20Guide/Theme%20development/Creating%20a%20custom%20theme_5_Creating%20a%20custom%20theme_im.jpg\"></p><h2>Step 2. Create the theme</h2><figure class=\"table\"><table><tbody><tr><td><img src=\"{{helpAssets}}/User%20Guide/Theme%20development/Creating%20a%20custom%20theme_3_Creating%20a%20custom%20theme_im.jpg\"></td><td>Themes are code notes with a special attribute. Start by creating a new code note.</td></tr><tr><td><img src=\"{{helpAssets}}/User%20Guide/Theme%20development/Creating%20a%20custom%20theme_1_Creating%20a%20custom%20theme_im.jpg\"></td><td>Then change the note type to a CSS code.</td></tr><tr><td><img src=\"{{helpAssets}}/User%20Guide/Theme%20development/Creating%20a%20custom%20theme_Creating%20a%20custom%20theme_im.jpg\"></td><td>In the attributes of the note (the&nbsp;<span class=\"tn-icon bx bx-list-check\"></span> button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlJ73vBCjWDw\">Status bar</a>), define the <code>#appTheme</code> attribute to point to any desired name. This is the name that will show up in the appearance section in settings.</td></tr></tbody></table></figure><h2>Step 3. Define the theme's CSS</h2><p>As a very simple example we will change the background color of the launcher pane to a shade of blue.</p><p>To alter the different variables of the theme:</p><pre><code class=\"language-text-css\">:root {\n\t--launcher-pane-background-color: #0d6efd;\n}</code></pre><h2>Step 4. Activating the theme</h2><p>Refresh the application (Ctrl+Shift+R is a good way to do so) and go to settings. You should see the newly created theme:</p><p><img src=\"{{helpAssets}}/User%20Guide/Theme%20development/Creating%20a%20custom%20theme_2_Creating%20a%20custom%20theme_im.jpg\"></p><p>Afterwards the application will refresh itself with the new theme:</p><p><img src=\"{{helpAssets}}/User%20Guide/Theme%20development/Creating%20a%20custom%20theme_4_Creating%20a%20custom%20theme_im.jpg\"></p><p>Do note that the theme will be based off of the legacy theme. To override that and base the theme on the Modern theme, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_WFGzWeUK6arS\">Customize the Next theme</a>.</p><h2>Step 5. Making changes</h2><p>Simply go back to the note and change according to needs. To apply the changes to the current window, press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>R</kbd> to refresh.</p><p>It's a good idea to keep two windows, one for editing and the other one for previewing the changes.</p>",
++ "_help_WFGzWeUK6arS": "<p>By default, any custom theme will be based on the legacy light theme. To use the TriliumNext theme instead, add the <code>#appThemeBase=next</code> attribute onto the existing theme. The <code>appTheme</code> attribute must also be present.</p><p><img src=\"{{helpAssets}}/User%20Guide/Theme%20development/Customize%20the%20Next%20theme_image.png\"></p><p>The <code>appThemeBase</code> label can be set to one of the following values:</p><ul><li><code>next</code>, for the TriliumNext (auto light or dark mode).</li><li><code>next-light</code>, for the always light mode of the TriliumNext.</li><li><code>next-dark</code>, for the always dark mode of the TriliumNext.</li><li>Any other value is ignored and will use the legacy white theme instead.</li></ul><h2>Overrides</h2><p>Do note that the TriliumNext theme has a few more overrides than the legacy theme. Due to that, it is recommended to use <code>#trilium-app</code> with a next theme instead of the <code>:root</code> of a legacy theme.</p><pre><code class=\"language-text-css\">#trilium-app {\n\t--launcher-pane-background-color: #0d6efd;\n}</code></pre>",
++ "_help_WN5z4M8ASACJ": "<h2>Detecting mobile vs. desktop</h2><p>The mobile layout is different than the one on the desktop. Use <code>body.mobile</code> and <code>body.desktop</code> to differentiate between them.</p><pre><code class=\"language-text-css\">body.mobile #root-widget {\n\t/* Do something on mobile */\n}\n\nbody.desktop #root-widget {\n\t/* Do something on desktop */\n}</code></pre><p>Do note that there is also a “tablet mode” in the mobile layout. For that particular case media queries are required:</p><pre><code class=\"language-text-css\">@media (max-width: 991px) {\n #launcher-pane {\n /* Do something on mobile layout */\n }\n}\n\n\n\n@media (min-width: 992px) {\n #launcher-pane {\n /* Do something on mobile tablet + desktop layout */\n }\n}</code></pre><h2>Detecting horizontal vs. vertical layout</h2><p>The user can select between vertical layout (the classical one, where the launcher bar is on the left) and a horizontal layout (where the launcher bar is on the top and tabs are full-width).</p><p>Different styles can be applied by using classes at <code>body</code> level:</p><pre><code class=\"language-text-css\">body.layout-vertical #left-pane {\n\t/* Do something */\n}\n\nbody.layout-horizontal #center-pane {\n\t/* Do something else */\t\n}</code></pre><p>The two different layouts use different containers (but they are present in the DOM regardless of the user's choice), for example <code>#horizontal-main-container</code> and <code>#vertical-main-container</code> can be used to customize the background of the content section.</p><h2>Detecting platform (Windows, macOS) or Electron</h2><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-windows\"></span>&nbsp;Windows</p><div class=\"trilium-tab-panel\"><pre><code class=\"language-text-css\">body.platform-win32 {\n\tbackground: red;\n}</code></pre></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-apple\"></span>&nbsp;macOS</p><div class=\"trilium-tab-panel\"><pre><code class=\"language-text-css\">body.platform-darwin {\n\tbackground: red;\n}</code></pre></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bx-windows\"></span>&nbsp;Electron (desktop app)</p><div class=\"trilium-tab-panel\"><p>To distinguish between a&nbsp;<a class=\"reference-link\" href=\"#root/_help_poXkQfguuA0U\">Desktop Installation</a>&nbsp;and a&nbsp;<a class=\"reference-link\" href=\"#root/_help_WOcw2SLH6tbX\">Server Installation</a>:</p><pre><code class=\"language-text-x-trilium-auto\">body.electron {\n\tbackground: blue;\n}</code></pre><p>Can be chained with Windows/macOS detections (e.g. <code>body.electron.platform-win32</code>).</p></div></section></div><h3>Native title bar</h3><p>It's possible to detect if the user has selected the native title bar or the custom title bar by querying against <code>body</code>:</p><pre><code class=\"language-text-x-trilium-auto\">body.electron.native-titlebar {\n\t/* Do something */\n}\n\nbody.electron:not(.native-titlebar) {\n\t/* Do something else */\n}</code></pre><h3>Native window buttons</h3><p>When running under Electron with native title bar off, a feature was introduced to use the platform-specific window buttons such as the semaphore on macOS.</p><p>See <a href=\"https://github.com/TriliumNext/Notes/pull/702\">Native title bar buttons by eliandoran · Pull Request #702 · TriliumNext/Notes</a> for the original implementation of this feature, including screenshots.</p><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-windows\"></span>&nbsp;Windows</p><div class=\"trilium-tab-panel\"><p>The colors of the native window button area can be adjusted using a RGB hex color:</p><pre><code class=\"language-text-x-trilium-auto\">body {\n\t--native-titlebar-foreground: #ffffff;\n\t--native-titlebar-background: #ff0000;\n}</code></pre><p>It is also possible to use transparency at the cost of reduced hover colors using a RGBA hex color:</p><pre><code class=\"language-text-x-trilium-auto\">body {\n\t--native-titlebar-background: #ff0000aa;\n}</code></pre><p>Note that the value is read when the window is initialized and then it is refreshed only when the user changes their light/dark mode preference.</p></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-apple\"></span>&nbsp;macOS</p><div class=\"trilium-tab-panel\"><p>On macOS the semaphore window buttons are enabled by default when the native title bar is disabled. The offset of the buttons can be adjusted using:</p><pre><code class=\"language-text-css\">body {\n --native-titlebar-darwin-x-offset: 12;\n --native-titlebar-darwin-y-offset: 14 !important;\n}</code></pre></div></section></div><h3>Background/transparency effects on Windows (Mica)</h3><p>Windows 11 offers a special background/transparency effect called Mica, which can be enabled by themes by setting the <code>--background-material</code> variable at <code>body</code> level:</p><pre><code class=\"language-text-css\">body.electron.platform-win32 {\n\t--background-material: tabbed; \n}</code></pre><p>The value can be either <code>tabbed</code> (especially useful for the horizontal layout) or <code>mica</code> (ideal for the vertical layout).</p><p>Do note that the Mica effect is applied at <code>body</code> level and the theme needs to make the entire hierarchy (semi-)transparent in order for it to be visible. Use the TrilumNext theme as an inspiration.</p><h2>Note icons, tab workspace accent color</h2><p>Theme capabilities are small adjustments done through CSS variables that can affect the layout or the visual aspect of the application.</p><p>In the tab bar, to display the icons of notes instead of the icon of the workspace:</p><pre><code class=\"language-text-css\">:root {\n\t--tab-note-icons: true;\n}</code></pre><p>When a workspace is hoisted for a given tab, it is possible to get the background color of that workspace, for example to apply a small strip on the tab instead of the whole background color:</p><pre><code class=\"language-text-css\">.note-tab .note-tab-wrapper {\n --tab-background-color: initial !important;\n}\n\n.note-tab .note-tab-wrapper::after {\n content: \"\";\n position: absolute;\n top: 0;\n left: 0;\n right: 0;\n height: 3px;\n background-color: var(--workspace-tab-background-color);\n}</code></pre><h2>Custom fonts</h2><p>The recommended way of using customized fonts is to import a font directly in Trilium. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_w4rMEhJsALlA\">Personalizing the font</a>&nbsp;for information on how to do so.</p><p>Alternatively, for a theme providing its own font, <a href=\"#root/_help_d3fAXQ2diepH\">Custom resource providers</a> can be used: Import a font into Trilium and assign it <code>#customResourceProvider=fonts/myfont.ttf</code> and then import the font in CSS via <code>/custom/fonts/myfont.ttf</code>. Use <code>../../../custom/fonts/myfont.ttf</code> if you run your Trilium server on a different path than <code>/</code>.</p><h2>Dark and light themes</h2><p>A light theme needs to have the following CSS:</p><pre><code class=\"language-text-css\">:root {\n\t--theme-style: light;\n}</code></pre><p>if the theme is dark, then <code>--theme-style</code> needs to be <code>dark</code>. A dark <code>--theme-style</code> also tells the Dark Reader browser extension to leave the page alone.</p><p>If the theme is auto (e.g. supports both light or dark based on <code>prefers-color-scheme</code>) it must also declare (in addition to setting <code>--theme-style</code> to either <code>light</code> or <code>dark</code>):</p><pre><code class=\"language-text-css\">:root {\n\n --theme-style-auto: true;\n\n}</code></pre><p>This will affect the behavior of the Electron application by informing the operating system of the color preference (e.g. background effects will appear correct on Windows).</p><h2>Adaptive text and table colors</h2><p>Colors applied in a text note, from the font color and background color buttons (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_Gr6xFaF6ioJ5\">General formatting</a>) or from the table and cell properties (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_NdowYOC1GFKS\">Tables</a>), are shown in a shade that suits the theme: the hue stays, while the lightness and the saturation are kept within limits. A theme can change these limits, for example if its page background is much darker or lighter than the one of the built-in themes:</p><pre><code class=\"language-text-css\">:root {\n --adaptive-text-light-max-lightness: 35;\n --adaptive-text-dark-min-lightness: 80;\n}</code></pre><p>Each variable is named <code>--adaptive-&lt;role&gt;-&lt;light|dark&gt;-&lt;limit&gt;</code>:</p><ul><li>The role is <code>text</code> (font color), <code>background</code> (font background color), <code>table-border</code> or <code>table-background</code> (tables and cells).</li><li><code>light</code> or <code>dark</code> is the kind of theme the limit applies to, as declared by <code>--theme-style</code>.</li><li>The limit is <code>min-lightness</code> or <code>max-lightness</code> (the CIELAB lightness, from 0 for black to 100 for white), or <code>max-chroma</code> (how saturated the color can be; <code>150</code> sets no practical limit). Each value must be a plain number, otherwise the colors lose their adaptation.</li></ul><p>The defaults are:</p><figure class=\"table\"><table><thead><tr><th>Role</th><th>Light themes</th><th>Dark themes</th></tr></thead><tbody><tr><td><code>text</code></td><td><code>max-lightness: 40</code>, <code>max-chroma: 150</code></td><td><code>min-lightness: 75</code>, <code>max-chroma: 55</code></td></tr><tr><td><code>background</code></td><td><code>min-lightness: 90</code>, <code>max-chroma: 20</code></td><td><code>max-lightness: 30</code>, <code>max-chroma: 30</code></td></tr><tr><td><code>table-border</code></td><td><code>max-lightness: 60</code>, <code>max-chroma: 150</code></td><td><code>min-lightness: 47</code>, <code>max-chroma: 150</code></td></tr><tr><td><code>table-background</code></td><td><code>min-lightness: 90</code>, <code>max-chroma: 20</code></td><td><code>max-lightness: 30</code>, <code>max-chroma: 30</code></td></tr></tbody></table></figure><p>The limits apply while a note is displayed, so a change to them affects every note at once. The note itself keeps each color as it was picked, in its <code>color</code>, <code>background-color</code> or <code>border-color</code> style, and a second time in a <code>--tn-color</code>, <code>--tn-background</code> or <code>--tn-border-color</code> variable, which the adaptation reads.</p>",
++ "_help_AlhDUqhENtH7": "<p>It is possible to provide a CSS file to be used regardless of the theme set by the user.</p><p>The quickest way to create one is <em>Insert child note</em> → <em>Code</em> → <em>Custom CSS</em> in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_YtSN43OrfzaA\">Note tree contextual menu</a>.</p><p>Alternatively, create a&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note manually, set the language to CSS and apply the <code>#appCss</code> label.</p><h2>Seeing the changes</h2><p>Adding a new <em>app CSS note</em> or modifying an existing one does not immediately apply changes. To see the changes, press Ctrl+Shift+R to refresh the page first.</p><h2>Sample use cases</h2><h3>Customizing the printing stylesheet</h3><aside class=\"admonition tip\"><p>Since v0.99.2, it's no longer possible to use <code>#appCss</code> to customize the printing CSS, since the printing is now done in an isolated environment.</p><p>However, it's still possible to customize the CSS via <code>~printCss</code>; see&nbsp;<a class=\"reference-link\" href=\"#root/_help_NRnIZmSMc5sj\">Printing &amp; Exporting as PDF</a>&nbsp;for more information.</p></aside><h3>Per-workspace styles</h3><p>When using&nbsp;<a class=\"reference-link\" href=\"#root/_help_9sRHySam5fXb\">Workspaces</a>, it can be helpful to create a visual distinction between notes in different workspaces.</p><p>To do so:</p><ol><li>In the note with <code>#workspace</code>, add an inheritable attribute <code>#cssClass(inheritable)</code> with a value that uniquely identifies the workspace (say <code>my-workspace</code>).</li><li>Anywhere in the note structure, create a CSS note with <code>#appCss</code>.</li></ol><h4>Change the color of the icons in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a></h4><pre><code class=\"language-text-x-trilium-auto\">.fancytree-node.my-workspace.fancytree-custom-icon {\n color: #ff0000;\n}</code></pre><h4>Change the color of the note title and the icon</h4><p>To change the color of the note title and the icon (above the content):</p><pre><code class=\"language-text-x-trilium-auto\">.note-split.my-workspace .note-icon-widget button.note-icon,\n.note-split.my-workspace .note-title-widget input.note-title {\n color: #ff0000;\n}</code></pre><h4>Add a watermark to the note content</h4><figure class=\"image image-style-align-right image_resized\" style=\"width:39.97%;\"><img style=\"aspect-ratio:641/630;\" src=\"{{helpAssets}}/User%20Guide/Theme%20development/Custom%20app-wide%20CSS_image.png\" width=\"641\" height=\"630\"></figure><ol><li>Insert an image in any note and take the URL of the image.</li><li>Use the following CSS, adjusting the <code>background-image</code> and <code>width</code> and <code>height</code> to the desired values.</li></ol><pre><code class=\"language-text-x-trilium-auto\">.note-split.my-workspace .scrolling-container:after {\n position: fixed;\n content: \"\";\n background-image: url(\"/api/attachments/Rvm3zJNITQI1/image/logo.png\");\n background-size: contain;\n background-position: center;\n background-repeat: no-repeat;\n width: 237px;\n height: 44px;\n bottom: 1em;\n right: 1em;\n opacity: 0.5;\n z-index: 0;\n}</code></pre><h2>Limitations</h2><p>Some parts of the application can't be styled directly via custom CSS because they are rendered in an isolated mode (shadow DOM), more specifically:</p><ul><li>The slides in a&nbsp;<a class=\"reference-link\" href=\"#root/_help_zP3PMqaG71Ct\">Presentation</a>.</li></ul>",
++ "_help_g1mlRoU8CsqC": "<aside class=\"admonition note\"><p>This page explains, step‑by‑step, how to create a custom icon pack. For a general description of how to use already existing icon packs, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_gOKqSJgXLcIj\">Icon Packs</a>.</p></aside><p>First read the quick flow to get the overall steps. After that there is a concrete example (Phosphor) with a small Node.js script you can run to generate the manifest.</p><h2>Quick flow (what you need to do)</h2><ol><li>Verify the icon set is a font (one of: .woff2, .woff, .ttf).</li><li>Obtain a list that maps icon names to Unicode code points (often provided as a JSON like <code>selection.json</code> or a CSS file).</li><li>Create a manifest JSON that maps icon ids to glyphs and search terms.</li><li>Create a Trilium note of type Code, set language to JSON, paste the manifest as the note content.</li><li>Upload the font file as an attachment to the same note (MIME type must be <code>font/woff2</code>, <code>font/woff</code>, or <code>font/ttf</code> and role <code>file</code>).</li><li>Add the label <code>#iconPack=&lt;prefix&gt;</code> to the note (prefix: letters, digits, hyphen, underscore and non-ASCII characters only).</li><li>Refresh the client and verify the icon pack appears in the icon selector.</li></ol><h2>Verify the icon set</h2><p>The first step is to analyze if the icon set being packed can be integrated into Trilium.</p><p>Trilium only supports <strong>font-based icon sets</strong>, with the following formats:</p><figure class=\"table\"><table><thead><tr><th>Extension</th><th>MIME type</th><th>Description</th></tr></thead><tbody><tr><td><code>.woff2</code></td><td><code>font/woff2</code></td><td>Recommended due to great compression (low size).</td></tr><tr><td><code>.woff</code></td><td><code>font/woff</code></td><td>Higher compatibility, but the font file is bigger.</td></tr><tr><td><code>.ttf</code></td><td><code>font/ttf</code></td><td>Most common, but highest font size.</td></tr></tbody></table></figure><p>Trilium <strong>does not</strong> support the following formats:</p><ul><li>SVG-based fonts.</li><li>Individual SVGs.</li><li><code>.eot</code> fonts (legacy and proprietary).</li><li>Duotone icons, since it requires a special CSS format that Trilium doesn't support.</li><li>Any other font format not specified in the <em>Supported formats</em> section.</li></ul><p>In this case, the font must be manually converted to one of the supported formats (ideally <code>.woff2</code>).</p><h2>Manifest format</h2><p>The manifest is a JSON object with an <code>icons</code> map. Each entry key is the CSS/class id you will use (Trilium uses the CSS class when rendering). Value object:</p><ul><li>glyph: the single character (the glyph) — can be the escaped Unicode (e.g. \"\\ue9c2\") or the literal character.</li><li>terms: array of search aliases; the first term is used as display name in the selector.</li></ul><p>Example minimal manifest:</p><pre><code class=\"language-text-x-trilium-auto\">{\n \"icons\": {\n \"ph-acorn\": {\n \"glyph\": \"\\uea3f\",\n \"terms\": [\"acorn\", \"nut\"]\n },\n \"ph-book\": {\n \"glyph\": \"\\uea40\",\n \"terms\": [\"book\", \"read\"]\n }\n }\n}</code></pre><aside class=\"admonition note\"><ul><li>You can supply glyph as the escaped <code>\\uXXXX</code> sequence or as the actual UTF‑8 character. The CSS form (<code>\\ea3f</code>, as written in a stylesheet's <code>content</code>) is accepted too, so glyphs copied out of the font's own CSS work as they stand.</li><li>It is also possible to use the unescaped glyph inside the JSON. It will appear strange (e.g. ), but it will be rendered properly regardless.</li><li>The manifest keys (e.g. <code>ph-acorn</code>) should match the class names used by the font (prefix + name is a common pattern).</li><li>Like the prefix, a manifest key becomes a CSS class name, so it can contain only letters, digits, hyphens, underscores and non-ASCII characters. Punctuation and whitespace (e.g. <code>ph.acorn</code> or <code>ph acorn</code>) are not usable as class names; icons with such a key are skipped and an error is logged in&nbsp;<a class=\"reference-link\" href=\"#root/_help_bnyigUA2UK7s\">Backend (server) logs</a>, while the rest of the pack still loads.</li></ul></aside><h2>Concrete example: Phosphor Icons</h2><p><a href=\"https://phosphoricons.com/\">Phosphor Icons</a> provide a <code>selection.json</code> that includes <code>properties.code</code> (the codepoint) and <code>properties.name</code> (the icon name). The goal: convert that into Trilium's manifest.</p><p>Sample <code>selection.json</code> excerpt:</p><pre><code class=\"language-text-x-trilium-auto\">{\n \"icons\": [\n {\n \"icon\": {\n \"paths\": [ /* [...] */ ],\n \"grid\": 0,\n \"attrs\": [{}],\n \"isMulticolor\": false,\n \"isMulticolor2\": false,\n \"tags\": [\"acorn\"]\n },\n \"attrs\": [{}],\n \"properties\": {\n \"id\": 0,\n \"order\": 1513,\n \"name\": \"acorn\",\n \"code\": 60314,\n \"ligatures\": \"acorn\",\n \"prevSize\": 16\n },\n \"setIdx\": 0,\n \"setId\": 0,\n \"iconIdx\": 0\n },\n /* [...] */\n ]\n}</code></pre><details class=\"trilium-collapsible\" open=\"\"><summary>A tiny Node.js script to produce the manifest</summary><p>Place <code>selection.json</code> in the same directory and run with Node 20+):</p><pre><code class=\"language-text-javascript\">import { join } from \"node:path\";\nimport { readFileSync, writeFileSync } from \"node:fs\";\n\nfunction processIconPack(packName) {\n const path = join(packName);\n const selectionMeta = JSON.parse(readFileSync(join(path, \"selection.json\"), \"utf-8\"));\n const icons = {};\n\n for (const icon of selectionMeta.icons) {\n let name = icon.properties.name;\n if (name.endsWith(`-${packName}`)) {\n name = name.split(\"-\").slice(0, -1).join(\"-\");\n }\n\n const id = `ph-${name}`;\n icons[id] = {\n glyph: `${String.fromCharCode(icon.properties.code)}`,\n terms: [ name ]\n };\n }\n\n writeFileSync(\"manifest.json\", JSON.stringify(icons, null, 2), \"utf8\");\n console.log(\"manifest.json created\");\n}\n\nprocessIconPack(\"light\");</code></pre><p>What to do with the script:</p><ul><li>Put <code>selection.json</code> and <code>build-manifest.js</code> in a folder.</li><li>Run: node build-manifest.js</li><li>The script writes <code>manifest.json</code> — open it, verify contents, then copy into a Trilium Code note (language: JSON).</li></ul></details><aside class=\"admonition tip\"><p><strong>Mind the escape format when processing CSS</strong></p><p>The Unicode escape syntax is different in CSS (<code>\"\\ea3f\"</code>) when compared to JSON (<code>\"\\uea3f\"</code>). Notice how the JSON escape is <code>\\u</code> and not <code>\\</code>. Both forms are accepted: keep the CSS escape by writing the backslash itself as <code>\"\\\\ea3f\"</code> in the JSON, or convert it to the JSON escape <code>\"\\uea3f\"</code>.</p><p>As a more compact alternative, provide the un-escaped character directly, as UTF-8 is supported.</p></aside><h3>Assigning the prefix</h3><p>Before an icon pack can be used, it needs to have a prefix defined. This prefix uniquely identifies the icon pack so that it can be used throughout the application.</p><p>To do so, Trilium makes use of the same format that was used for the internal icon pack (Boxicons). For example, when an icon from Boxicons is set, it looks like this: <code>#iconClass=\"bx bxs-sushi\"</code>. In this case, the icon pack prefix is <code>bx</code> and the icon class name is <code>bxs-sushi</code>.</p><p>In order for an icon pack to be recognized, the prefix must be specified in the <code>#iconPack</code> label.&nbsp;</p><p>For our example with Phosphor Icons, we can use the <code>ph</code> prefix since it also matches the prefix set in the original CSS. So in this case it would be <code>#iconPack=ph</code>.</p><aside class=\"admonition important\"><p>The prefix must consist of only letters, digits, hyphens, underscores and non-ASCII characters. If the prefix doesn't match these constraints, the icon pack will be ignored and an error will be logged in&nbsp;<a class=\"reference-link\" href=\"#root/_help_bnyigUA2UK7s\">Backend (server) logs</a>.</p></aside><h2>Creating the Trilium icon pack note</h2><ol><li>Create a note of type <em>Code</em>.</li><li>Set the language to <em>JSON</em>.</li><li>Rename the note. The name of the note will also be the name of the icon pack as displayed in the list of icons.</li><li>Copy and paste the manifest generated in the previous step as the content of this note.</li><li>Go to the <a href=\"#root/_help_0vhv7lsOLy82\">note attachment</a> and upload the font file (in <code>.woff2</code>, <code>.woff</code>, <code>.ttf</code>) format.<ol><li>Trilium identifies the font to use from attachments via the MIME type, make sure the MIME type is displayed correctly after uploading the attachment (for example <code>font/woff2</code>).</li><li>Make sure the <code>role</code> appears as <code>file</code>, otherwise the font will not be identified.</li><li>Multiple attachments are supported, but only one font will actually be used in Trilium's order of preference: <code>.woff2</code>, <code>.woff</code>, <code>.ttf</code>. As such, there's not much reason to upload more than one font per icon pack.</li></ol></li><li>Add label: <code>#iconPack=&lt;prefix&gt;</code> (for Phosphor example: <code>#iconPack=ph</code>).</li></ol><h3>Final steps</h3><ul><li><a href=\"#root/_help_s8alTXmpFR61\">Refresh the client</a><ul><li>Change the icon of the note and look for the <em>Filter</em> icon in the top-right side.</li><li>Check if the new icon pack is displayed there and click on it to see the full list of icons.</li><li>Go through most of the items to look for issues such as missing icon, wrong names (some icons have aliases/terms that can cause issues).</li></ul></li><li>Optionally, assign an icon from the new icon pack to this note. This icon will be used in the icon pack filter for a visual distinction.</li><li>The icon pack can then be <a href=\"#root/_help_mHbBMPDPkVV5\">exported as ZIP</a> in order to be distributed to other users.<ul><li>It's important to note that icon packs are considered “unsafe” by default, so “Safe mode” must be disabled when importing the ZIP.</li><li>Consider linking new users to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_gOKqSJgXLcIj\">Icon Packs</a>&nbsp;documentation in order to understand how to import and use an icon pack.</li></ul></li></ul><h3>Troubleshooting</h3><p>If the icon pack doesn't show up, look through the&nbsp;<a class=\"reference-link\" href=\"#root/_help_bnyigUA2UK7s\">Backend (server) logs</a>&nbsp;for clues.</p><ul><li>One example is if the font could not be retrieved: <code>ERROR: Icon pack is missing WOFF/WOFF2/TTF attachment: Boxicons v3 400 (dup) (XRzqDQ67fHEK)</code>.</li><li>Make sure the prefix is unique and not already taken by some other icon pack. When there are two icon packs with the same prefix, only one is used. The server logs will indicate if this situation occurs.</li><li>Make sure the prefix consists only of letters, digits, hyphens, underscores and non-ASCII characters.</li><li>If the pack loads but individual icons are missing, check the logs for <code>Skipping icon '&lt;key&gt;' of icon pack</code> — that key uses characters outside the allowed set and needs renaming in the manifest.</li></ul>",
++ "_help_zEY4DaJG4YT5": "<figure class=\"image\"><img style=\"aspect-ratio:1071/146;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Attributes_image.png\" width=\"1071\" height=\"146\"></figure><p>In Trilium, attributes are key-value pairs assigned to notes, providing additional metadata or functionality. There are two primary types of attributes:</p><ol><li><p><a class=\"reference-link\" href=\"#root/_help_HI6GBBIduIgv\">Labels</a>&nbsp;can be used for a variety of purposes, such as storing metadata or configuring the behavior of notes. Labels are also searchable, enhancing note retrieval.</p><p>For more information, including predefined labels, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_HI6GBBIduIgv\">Labels</a>.</p></li><li><p><a class=\"reference-link\" href=\"#root/_help_Cq5X6iKQop6R\">Relations</a>&nbsp;define connections between notes, similar to links. These can be used for metadata and scripting purposes.</p><p>For more information, including a list of predefined relations, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_Cq5X6iKQop6R\">Relations</a>.</p></li></ol><p>These attributes play a crucial role in organizing, categorizing, and enhancing the functionality of notes.</p><h2>Types of attributes</h2><p>Conceptually there are two types of attributes (applying to both labels and relations):</p><ol><li><strong>System attributes</strong><br>As the name suggest, these attributes have a special meaning since they are interpreted by Trilium. For example the <code>color</code> attribute will change the color of the note as displayed in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and links, and <code>iconClass</code> will change the icon of a note.</li><li><strong>User-defined attributes</strong><br>These are free-form labels or relations that can be used by the user. They can be used purely for categorization purposes (especially if combined with&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>), or they can be given meaning through the use of&nbsp;<a class=\"reference-link\" href=\"#root/_help_CdNpE2pqjmI6\">Scripting</a>.</li></ol><p>In practice, Trilium makes no direct distinction of whether an attribute is a system one or a user-defined one. A label or relation is considered a system attribute if it matches one of the built-in names (e.g. like the aforementioned <code>iconClass</code>). Keep this in mind when creating &nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;in order not to accidentally alter a system attribute (unless intended).</p><h2>Viewing the list of attributes</h2><p>Both the labels and relations for the current note are displayed in:</p><ul><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>, in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_uNtgN0cUKEBc\">Attributes tab</a>&nbsp;with a grid-like view.</li><li>A more advanced option, in&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlJ73vBCjWDw\">Status bar</a>&nbsp;→&nbsp;<span class=\"tn-icon bx bx-list-check\"></span> (<em>Attributes</em>) where the attributes are displayed in a textual way, making it easy to copy them around or make batch modifications.<ul><li>In the list of attributes, labels are prefixed with the <code>#</code> character whereas relations are prefixed with the <code>~</code> character.</li></ul></li></ul><h2>Attribute Definitions and Promoted Attributes</h2><p><a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;create a form-like editing experience for attributes, which makes it easy to enhancing the organization and management of attributes</p><h2>Multiplicity</h2><p>Attributes in Trilium can be \"multi-valued\", meaning multiple attributes with the same name can co-exist. This can be combined with&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;to easily add them.</p><h2>Attribute Inheritance</h2><p>Trilium supports attribute inheritance, allowing child notes to inherit attributes from their parents. For more information, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_bwZpz2ajCEwO\">Attribute Inheritance</a>.</p>",
++ "_help_HI6GBBIduIgv": "<p>A label is an <a href=\"#root/_help_zEY4DaJG4YT5\">attribute</a> of a note which has a name and optionally a value.</p><h2>Common use cases</h2><ul><li><strong>Metadata for personal use</strong>: Assign labels with optional values for categorization, such as <code>#year=1999</code>, <code>#genre=\"sci-fi\"</code>, or <code>#author=\"Neal Stephenson\"</code>. This can be combined with&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;to make their display more user-friendly.</li><li><strong>Configuration</strong>: Labels can configure advanced features or settings (see reference below).</li><li><strong>Scripts and Plugins</strong>: Used to tag notes with special metadata, such as the \"weight\" attribute in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_R7abl2fc6Mxi\">Weight Tracker</a>.</li></ul><h2>Creating a label using the visual editor</h2><ol><li>Go to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_uNtgN0cUKEBc\">Attributes tab</a>&nbsp;in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>.</li><li>Press the&nbsp;<span class=\"tn-icon bx bx-plus\"></span> (Add attribute) button at the end of the list, or via the&nbsp;<span class=\"tn-icon bx bx-plus\"></span> button at the top-right of the section → <em>Add new label</em>.</li></ol><p>While in the visual editor:</p><ul><li>Set the desired name.</li><li>Optionally, set the value of the label. Labels can exist without a value.</li><li>Children can inherit this relation, click the relation and check <em>Inheritable</em>. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_bwZpz2ajCEwO\">Attribute Inheritance</a>&nbsp;for more information.</li></ul><aside class=\"admonition tip\"><p>Alternatively, press <kbd>Alt</kbd>+<kbd>L</kbd> which will open the attribute details (same view as when an existing attribute is clicked) in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlJ73vBCjWDw\">Status bar</a>.</p></aside><h2>Creating a label manually</h2><p>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlJ73vBCjWDw\">Status bar</a>, press the&nbsp;<span class=\"tn-icon bx bx-list-check\"></span> button to show the list of the attributes.</p><ul><li>Click the input box to focus it.</li><li>To create a label called <code>myLabel</code> with no value, simply type <code>#myLabel</code>.</li><li>To create a label called <code>myLabel</code> with a value <code>value</code>, simply type <code>#myLabel=value</code>.</li><li>If the value contains spaces, then the text must be quoted: <code>#myLabel=\"Hello world\"</code>.</li><li>If the string contains quotes (regardless of whether it has spaces), then the text must be quoted with apostrophes instead: <code>#myLabel='Hello \"world\"'</code>.</li><li>To create an inheritable label called <code>myLabel</code>, simply write <code>#myLabel(inheritable)</code> for no value or <code>#myLabel(inheritable)=value</code> if there is a value.</li></ul><h2>Predefined labels</h2><p>This is a list of labels that Trilium natively supports.</p><aside class=\"admonition tip\"><p>Some labels presented here end with a <code>*</code>. That means that there are multiple labels with the same prefix, consult the specific page linked in the description of that label for more information.</p></aside><figure class=\"table\"><table><thead><tr><th>Label</th><th>Description</th></tr></thead><tbody><tr><td><code>disableVersioning</code></td><td>Disables automatic creation of&nbsp;<a class=\"reference-link\" href=\"#root/_help_vZWERwf8U3nx\">Note Revisions</a>&nbsp;for a particular note. Useful for e.g. large, but unimportant notes - e.g. large JS libraries used for scripting.</td></tr><tr><td><code>versioningLimit</code></td><td>Limits the maximum number of&nbsp;<a class=\"reference-link\" href=\"#root/_help_vZWERwf8U3nx\">Note Revisions</a>&nbsp;for a particular note, overriding the global settings.</td></tr><tr><td><code>calendarRoot</code></td><td>Marks the note which should be used as root for&nbsp;<a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a>. Only one should be marked as such.</td></tr><tr><td><code>archived</code></td><td>Hides notes from default search results and dialogs. Archived notes can optionally be hidden in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</td></tr><tr><td><code>excludeFromExport</code></td><td>Excludes this note and its children when exporting.</td></tr><tr><td><code>run</code>, <code>runOnInstance</code>, <code>runAtHour</code></td><td>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_GPERMystNGTB\">Backend Events</a>.</td></tr><tr><td><code>disableInclusion</code></td><td>Scripts with this label won't be included into parent script execution.</td></tr><tr><td><code>sorted</code>, <code>sortDirection</code>, <code>sortFoldersFirst</code>, <code>sortNatural</code>, <code>sortLocale</code>, <code>top</code>, <code>bottom</code></td><td>Manages automatic/permanent sorting. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_aGlEvb9hyDhS\">Sorting Notes</a>.</td></tr><tr><td><code>hidePromotedAttributes</code></td><td>Hide&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;on this note. Generally useful when defining inherited attributes, but the parent note doesn't need them.</td></tr><tr><td><code>readOnly</code></td><td>Marks a note to always be <a href=\"#root/_help_CoFPLs3dRlXc\">read-only</a>, if it's a supported note (text, code, mermaid).</td></tr><tr><td><code>autoReadOnlyDisabled</code></td><td>Disables automatic <a href=\"#root/_help_CoFPLs3dRlXc\">read-only mode</a> for the given note.</td></tr><tr><td><code>appCss</code></td><td>Marks CSS notes which are loaded into the Trilium application and can thus be used to modify Trilium's looks. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlhDUqhENtH7\">Custom app-wide CSS</a>&nbsp;for more info.</td></tr><tr><td><code>appTheme</code></td><td>Marks CSS notes which are full Trilium themes and are thus available in Trilium options. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_pKK96zzmvBGf\">Theme development</a>&nbsp;for more information.</td></tr><tr><td><code>appThemeBase</code></td><td>Set to <code>next</code>, <code>next-light</code>, or <code>next-dark</code> to use the corresponding TriliumNext theme (auto, light or dark) as the base for a custom theme, instead of the legacy one. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_WFGzWeUK6arS\">Customize the Next theme</a>&nbsp;for more information.</td></tr><tr><td><code>customFont</code></td><td>Marks a font as selectable in the Options → Appearance font selection. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_w4rMEhJsALlA\">Personalizing the font</a>.</td></tr><tr><td><code>cssClass</code></td><td>Value of this label is then added as CSS class to the node representing given note in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>. This can be useful for advanced theming. Can be used in template notes.</td></tr><tr><td><code>iconClass</code></td><td>value of this label is added as a CSS class to the icon on the tree which can help visually distinguish the notes in the tree. Example might be bx bx-home - icons are taken from boxicons. Can be used in template notes.</td></tr><tr><td><code>pageSize</code></td><td>Specifies the number of items per page in&nbsp;<a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a>.</td></tr><tr><td><code>customRequestHandler</code></td><td>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_J5Ex1ZrMbyJ6\">Custom Request Handler</a>.</td></tr><tr><td><code>customResourceProvider</code></td><td>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_d3fAXQ2diepH\">Custom Resource Providers</a>.</td></tr><tr><td><code>widget</code></td><td>Marks this note as a custom widget which will be added to the Trilium component tree. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>&nbsp;for more information.</td></tr><tr><td><code>searchHome</code></td><td>New search notes will be created as children of this note (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a>).</td></tr><tr><td><code>workspace</code> and related attributes</td><td>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_9sRHySam5fXb\">Workspaces</a>.</td></tr><tr><td><code>inbox</code></td><td>Default inbox location for new notes. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_S0Fos78ZfcY7\">Note Inbox</a>&nbsp;for more information.</td></tr><tr><td><code>sqlConsoleHome</code></td><td>Default location of&nbsp;<a class=\"reference-link\" href=\"#root/_help_YKWqdJhzi2VY\">SQL Console</a>&nbsp;saved queries.</td></tr><tr><td><code>bookmarked</code></td><td>Indicates this note is a <a href=\"#root/_help_u3YFHC9tQlpm\">bookmark</a>.</td></tr><tr><td><code>bookmarkFolder</code></td><td>Note with this label will appear in bookmarks as folder (allowing access to its children). See&nbsp;<a class=\"reference-link\" href=\"#root/_help_u3YFHC9tQlpm\">Bookmarks</a>&nbsp;for more information.</td></tr><tr><td><code>share*</code></td><td>See the attribute reference in&nbsp;<a class=\"reference-link\" href=\"#root/_help_R9pX4DGra2Vt\">Sharing</a>.</td></tr><tr><td><code>displayRelations</code>, <code>hideRelations</code></td><td>Comma delimited names of relations which should be displayed/hidden in a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iRwzGnHPzonm\">Relation Map</a>&nbsp;(both the note type and the&nbsp;<a class=\"reference-link\" href=\"#root/_help_BCkXAVs63Ttv\">Note Map (Link map, Tree map)</a>&nbsp;general functionality).</td></tr><tr><td><code>titleTemplate</code></td><td>Default title of notes created as children of this note. This value is evaluated as a JavaScript string and thus can be enriched with dynamic content via the injected <code>now</code> and <code>parentNote</code> variables.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <br> <br>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_47ZrP6FNuoG8\">Default Note Title</a>&nbsp;for more info.</td></tr><tr><td><code>template</code></td><td>This note will appear in the selection of available template when creating new note. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>&nbsp;for more information.</td></tr><tr><td><code>color</code></td><td>defines color of the note in note tree, links etc. Use any valid CSS color value like 'red' or #a13d5f&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <br>Note: this color may be automatically adjusted when displayed to ensure sufficient contrast with the background.</td></tr><tr><td><code>keyboardShortcut</code></td><td>Defines a keyboard shortcut which will immediately jump to this note. Example: 'ctrl+alt+e'. Requires frontend reload for the change to take effect.</td></tr><tr><td><code>keepCurrentHoisting</code></td><td>Opening this link won't change hoisting even if the note is not displayable in the current hoisted subtree.</td></tr><tr><td><code>executeButton</code></td><td>Title of the button which will execute the current code note</td></tr><tr><td><code>executeDescription</code></td><td>Longer description of the current code note displayed together with the execute button</td></tr><tr><td><code>excludeFromNoteMap</code></td><td>Notes with this label will be hidden from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_bdUJEHsAPYQR\">Note Map</a>.</td></tr><tr><td><code>newNotesOnTop</code></td><td>New notes will be created at the top of the parent note, not on the bottom.</td></tr><tr><td><code>hideChildrenOverview</code></td><td>Hides the&nbsp;<a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a>&nbsp;for that particular note.</td></tr><tr><td><code>subtreeHidden</code></td><td>Hides all child notes of this note from the tree, displaying a badge with the count of hidden children. Children remain accessible via search or direct links.</td></tr><tr><td><code>printLandscape</code></td><td>When exporting to PDF, changes the orientation of the page to landscape instead of portrait.</td></tr><tr><td><code>printPageSize</code></td><td>When exporting to PDF, changes the size of the page. Supported values: <code>A0</code>, <code>A1</code>, <code>A2</code>, <code>A3</code>, <code>A4</code>, <code>A5</code>, <code>A6</code>, <code>Legal</code>, <code>Letter</code>, <code>Tabloid</code>, <code>Ledger</code>.</td></tr><tr><td><code>printScale</code>, <code>printMargins</code></td><td>Additional printing options, generally configured through the&nbsp;<a class=\"reference-link\" href=\"#root/_help_NRnIZmSMc5sj\">Printing &amp; Exporting as PDF</a>&nbsp;dialog.</td></tr><tr><td><code>geolocation</code></td><td>Indicates the latitude and longitude of a note, to be displayed in a&nbsp;<a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map</a>.</td></tr><tr><td><code>geoShape</code></td><td>Indicates the coordinates for the points of a <a href=\"#root/_help_C2H9HK4BzwG7\">shapec</a> drawn on the&nbsp;<a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map</a>&nbsp;(e.g. area, rectangle, circle).</td></tr><tr><td><code>map:*</code></td><td>Defines specific options for the&nbsp;<a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map</a>.</td></tr><tr><td><code>calendar:*</code></td><td>Defines specific options for the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xWbu3jpNWapp\">Calendar</a>.</td></tr><tr><td><code>viewType</code></td><td>Sets the view of child notes (e.g. grid or list). See&nbsp;<a class=\"reference-link\" href=\"#root/_help_0ESUbbAxVnoK\">Note List</a>&nbsp;for more information.</td></tr><tr><td><code>webViewSrc</code></td><td>Defines the URL of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_1vHRoWCEjj0L\">Web View</a>.</td></tr><tr><td><code>tabWidth</code>, <code>indentWithTabs</code>, <code>wrapLines</code></td><td>Per-note Code editor settings: indentation width, indent with tabs vs. spaces, and word wrapping. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>.</td></tr><tr><td><code>datePattern</code>, <code>weekPattern</code>, <code>monthPattern</code>, <code>quarterPattern</code>, <code>yearPattern</code></td><td>Customizes the title naming pattern of day / week / month / quarter / year notes. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a>.</td></tr><tr><td><code>enableWeekNote</code>, <code>enableQuarterNote</code></td><td>Enables optional week and quarter notes in the calendar hierarchy; set on the calendar root. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a>.</td></tr><tr><td><code>fullContentWidth</code></td><td>Expands the note to the full editor width, ignoring the configured content width (useful for wide tables). See&nbsp;<a class=\"reference-link\" href=\"#root/_help_t596jLvPrqkS\">Content width</a>.</td></tr><tr><td><code>iconPack</code></td><td>Identifies a custom icon pack by its prefix. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_g1mlRoU8CsqC\">Creating an icon pack</a>.</td></tr><tr><td><code>clipperInbox</code></td><td>Overrides the default location where the Web Clipper saves clippings (defaults to the day note). See&nbsp;<a class=\"reference-link\" href=\"#root/_help_MtPxeAWVAzMg\">Web Clipper</a>.</td></tr><tr><td><code>docName</code> , <code>docUrl</code></td><td>Used internally for the in-app help.</td></tr><tr><td><code>aiQuickAction</code></td><td>Defines a custom prompt to be used for the&nbsp;<a class=\"reference-link\" href=\"#root/_help_VRoP0g1uHHc2\">In-editor AI assistant</a>'s quick actions.</td></tr></tbody></table></figure>",
++ "_help_Cq5X6iKQop6R": "<p>A relation is similar to a <a href=\"#root/_help_HI6GBBIduIgv\">label</a>, but instead of having a text value it refers to another note.</p><h2>Common use cases</h2><ul><li><strong>Metadata Relationships for personal use</strong>: For example, linking a book note to an author note.<br>This can be combined with&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;to make their display more user-friendly.</li><li><strong>Configuration</strong>: For configuring some notes such as&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>, or configuring&nbsp;<a class=\"reference-link\" href=\"#root/_help_R9pX4DGra2Vt\">Sharing</a>&nbsp;or&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>&nbsp;(see the list below).</li><li><strong>Scripting</strong>: Attaching scripts to events or conditions related to the note.</li></ul><h2>Creating a relation using the visual editor</h2><ol><li>Go to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_uNtgN0cUKEBc\">Attributes tab</a>&nbsp;in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>.</li><li>Press the&nbsp;<span class=\"tn-icon bx bx-plus\"></span> button (<em>Add a new attribute</em>) to the right of the <em>Owned attributes</em> section.</li><li>Select <em>Add new relation</em> for the relation.</li></ol><p>While in the visual editor, set the desired name and the <em>Target note</em> (the note to point to). Unlike labels, relations cannot exist with a target note.</p><p>Children can inherit this relation, click the relation and check <em>Inheritable</em>. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_bwZpz2ajCEwO\">Attribute Inheritance</a>&nbsp;for more information.</p><aside class=\"admonition tip\"><p>Alternatively, press <kbd>Alt</kbd>+<kbd>L</kbd> which will open the attribute details (same view as when an existing attribute is clicked) in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlJ73vBCjWDw\">Status bar</a>.</p></aside><h2>Creating a relation manually</h2><p>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlJ73vBCjWDw\">Status bar</a>, press the&nbsp;<span class=\"tn-icon bx bx-list-check\"></span> button to show the list of the attributes.</p><ul><li>To create a relation called <code>myRelation</code>:<ol><li>Click the input box to focus it.</li><li>Type <code>~myRelation=@</code> .</li><li>After this, an autocompletion box should appear.</li><li>Type the title of the note to point to and press <kbd>Enter</kbd> to confirm (or click the desired note).</li><li>Alternatively copy a note from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and paste it after the <code>=</code> sign (without the <code>@</code> , in this case).</li></ol></li><li>To create an inheritable relation, follow the same steps as previously described but instead of <code>~myRelation</code> write <code>~myRelation(inheritable)</code>.</li></ul><h2>Predefined relations</h2><p>These relations are supported and used internally by Trilium.</p><figure class=\"table\"><table><thead><tr><th>Label</th><th>Description</th></tr></thead><tbody><tr><td><code>runOn*</code></td><td>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_GPERMystNGTB\">Backend Events</a></td></tr><tr><td><code>template</code></td><td>note's attributes will be inherited even without a parent-child relationship, note's content and subtree will be added to instance notes if empty. See documentation for details.</td></tr><tr><td><code>template:newNoteDefaultParent</code></td><td>set on a template note, points to the note under which notes created from the template are placed when no other location is picked; when set several times, the note is cloned into every target. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>.</td></tr><tr><td><code>inherit</code></td><td>note's attributes will be inherited even without a parent-child relationship. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>&nbsp;for a similar concept. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_bwZpz2ajCEwO\">Attribute Inheritance</a>&nbsp;in the documentation.</td></tr><tr><td><code>renderNote</code></td><td>notes of type&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>&nbsp;will be rendered using a code note (HTML or script) and it is necessary to point using this relation to which note should be rendered</td></tr><tr><td><code>widget</code></td><td>Used in the context of custom&nbsp;<a class=\"reference-link\" href=\"#root/_help_4Gn3psZKsfSm\">Launch Bar Widgets</a>, to refer to the widget that will be rendered.</td></tr><tr><td><code>shareCss</code></td><td>CSS note which will be injected into the share page. CSS note must be in the shared sub-tree as well. Consider using <code>shareHiddenFromTree</code> and <code>shareOmitDefaultCss</code> as well.</td></tr><tr><td><code>shareJs</code></td><td>JavaScript note which will be injected into the share page. JS note must be in the shared sub-tree as well. Consider using <code>shareHiddenFromTree</code>.</td></tr><tr><td><code>shareHtml</code></td><td>HTML note which will be injected into the share page at locations specified by the <code>shareHtmlLocation</code> label. HTML note must be in the shared sub-tree as well. Consider using <code>shareHiddenFromTree</code>.</td></tr><tr><td><code>shareTemplate</code></td><td>Embedded JavaScript note that will be used as the template for displaying the shared note. Falls back to the default template. Consider using <code>shareHiddenFromTree</code>.</td></tr><tr><td><code>shareFavicon</code></td><td>Favicon note to be set in the shared page. Typically you want to set it to share root and make it inheritable. Favicon note must be in the shared sub-tree as well. Consider using <code>shareHiddenFromTree</code>.</td></tr></tbody></table></figure>",
++ "_help_bwZpz2ajCEwO": "<p>Inheritance refers to the process of having a <a href=\"#root/_help_HI6GBBIduIgv\">label</a> or a <a href=\"#root/_help_Cq5X6iKQop6R\">relation</a> shared across multiple notes, generally in parent-child relations (or anywhere if using templates).</p><h2>Standard Inheritance</h2><p>In Trilium, attributes can be automatically inherited by child notes if they have the <code>isInheritable</code> flag set to <code>true</code>. This means the attribute (a key-value pair) is applied to the note and all its descendants.</p><p>To make an attribute inheritable, simply use the visual editor for&nbsp;<a class=\"reference-link\" href=\"#root/_help_HI6GBBIduIgv\">Labels</a>&nbsp;or&nbsp;<a class=\"reference-link\" href=\"#root/_help_Cq5X6iKQop6R\">Relations</a>. Alternatively, the attribute can be manually defined where <code>#myLabel=value</code> becomes <code>#myLabel(inheritable)=value</code> when inheritable.</p><p>As an example, the <code>archived</code> label can be set to be inheritable, allowing you to hide a whole subtree of notes from searches and other dialogs by applying this label at the top level.</p><p>Standard inheritance forces all the notes that are children (and sub-children) of a note to have that particular label or relation. If there is a need to have some notes not inherit one of the labels, then <em>copying inheritance</em> or <em>template inheritance</em> needs to be used instead.</p><h2>Copying Inheritance</h2><p>Copying inheritance differs from standard inheritance by using a <code>child:</code> prefix in the attribute name. This prefix causes new child notes to automatically receive specific attributes from the parent note. These attributes are independent of the parent and will persist even if the note is moved elsewhere.</p><p>If a parent note has the label <code>#child:exampleAttribute</code>, all newly created child notes (one level deep) will inherit the <code>#exampleAttribute</code> label. This can be useful for setting default properties for notes in a specific section.</p><p>Similarly, for relations use <code>~child:myRelation</code>.</p><p>Due to the way it's designed, copying inheritance cannot be used to cascade infinitely within a hierarchy. For that use case, consider using either standard inheritance or templates.</p><h3>Chained inheritance</h3><p>It is possible to define labels across multiple levels of depth. For example, <code>#child:child:child:foo</code> applied to a root note would create:</p><ul><li><code>#child:child:foo</code> on the first-level children.</li><li><code>#child:foo</code> on the second-level children.</li><li><code>#foo</code> on the third-level children.</li></ul><p>Similarly, use <code>~child:child:child:foo</code> if dealing with relations.</p><p>Do note that same as simple copying inheritance, the changes will not apply retroactively to existing notes in the hierarchy, it will only apply to the newly created notes.</p><h2>Template Inheritance</h2><p>Attributes can also be inherited from&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>. When a new note is created using a template, it inherits the attributes defined in that template. This is particularly useful for maintaining consistency across notes that follow a similar structure or function.</p>",
++ "_help_OFXdgB2nNk1F": "<figure class=\"image image_resized\" style=\"width:61.4%;\"><img style=\"aspect-ratio:938/368;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Attributes/Promoted%20Attributes_image.png\" width=\"938\" height=\"368\"></figure><p>Promoted attributes are <a href=\"#root/_help_zEY4DaJG4YT5\">attributes</a> which are displayed prominently in the UI which allow them to be easily viewed and edited.</p><p>The promoted attributes are shown underneath the&nbsp;<a class=\"reference-link\" href=\"#root/_help_l7pigIGu01K2\">Title</a>&nbsp;of the note, in a collapsible section. For full-height notes such as&nbsp;<a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a>, the promoted attributes are collapsed by default to make room.</p><p>One way of seeing promoted attributes is as a kind of form with several fields. Each field is just regular attribute, the only difference is that they appear on the note itself.</p><p>Attributes can be pretty useful since they allow for querying and script automation etc. but they are also inconveniently hidden. This allows you to select few of the important ones and push them to the front of the user.</p><h2>Attribute definition</h2><figure class=\"image image-style-align-right image_resized\" style=\"width:50%;\"><img style=\"aspect-ratio:885/742;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Attributes/2_Promoted%20Attributes_image.png\" width=\"885\" height=\"742\"></figure><p>In order to have promoted attributes, there needs to be a way to define them.</p><p>Technically, attributes are only name-value pairs where both name and value are strings.</p><p>The <em>Attribute definition</em> specifies how should this value be interpreted:</p><ul><li>Is it just string, or is it a date?</li><li>Should we allow multiple values or note?</li><li>Should we <em>promote</em> the attribute or not?</li></ul><h2>Types of attributes</h2><p>Attribute definitions have a dedicated type field which will change how the value will be edited in the promoted attributes section.</p><p>The following types are supported:</p><ul><li><em>Text</em>, the default option which allows any type of text to be edited, similar to normal labels that don't have a type associated.</li><li><em>Multi-line text</em>, similar to a normal text field, but rendered in a bigger text box that also supports writing on multiple lines.</li><li><em>Number</em>, will display as a number input field with up/down arrows.<ul><li>Optionally a <em>precision</em> which sets how many decimals the value steps by and is displayed with.</li></ul></li><li><em>Checkbox</em>, which renders as a checkbox for a true/false value. In the label definition, this type is written as <code>boolean</code>.</li><li><em>Select,</em> which provides a list of user-defined options when editing.<ul><li>The list is not fixed, meaning that new options can be easily added from the promoted attribute.</li><li>Renaming an option does not change the existing values since the value is stored as text. Consider a <a href=\"#root/_help_ivYnonVFBxbQ\">bulk rename</a>.</li><li>The items do not have a custom color or icon. This is intentional as selects are meant to be light-weight. For a more customizable option, consider using&nbsp;<a class=\"reference-link\" href=\"#root/_help_Cq5X6iKQop6R\">Relations</a>&nbsp;instead which use notes as items and those notes can be colorized and also carry an icon.</li></ul></li><li><em>Date,</em> which provides a date picker.</li><li><em>Date &amp; Time,</em> which provides a date &amp; time picker.</li><li><em>Time,</em> which provides a time picker.</li><li><em>URL,</em> which provides a button to open the web address in a new window.</li><li><em>Email</em>, which provides a button to quickly send an email to that address using your operating system's default app.</li><li><em>Phone</em>, which provides a button to quickly call that number using your operating system's default app.</li><li><em>Color</em>, which provides a color picker and a way to remove the value.</li><li><em>Relation</em>, which points to another note and uses&nbsp;<a class=\"reference-link\" href=\"#root/_help_Cq5X6iKQop6R\">Relations</a>&nbsp;instead of&nbsp;<a class=\"reference-link\" href=\"#root/_help_HI6GBBIduIgv\">Labels</a>.</li></ul><aside class=\"admonition note\"><p>For label-based attributes, these types are not enforced by the attribute system, meaning that changing the type afterwards does not guarantee that the values in it correspond to the type (e.g. turning a text into a number).</p></aside><h2>Multiple values</h2><p>When the definition allows multiple values, each value is shown as a chip and a new one is added in the box after them. Press the <span class=\"tn-icon bx bx-x\"></span> on a chip to remove that value.</p><ul><li>For free-form types such as <em>Text</em>, <em>Number</em> or <em>Date</em>, press <kbd>Enter</kbd> (or leave the field) to add what was typed. The same value can be added more than once, for example two payments of the same amount.</li><li>For <em>Select</em>, <em>Checkbox</em> and <em>Relation</em> attributes, a value is picked from the list rather than typed, and each one can be picked only once.</li></ul><h2>Creating a new promoted attribute definition</h2><p>To create a new promoted attribute:</p><ol><li>Go to a note.</li><li>Go to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_uNtgN0cUKEBc\">Attributes tab</a>&nbsp;in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>.</li><li>Press the&nbsp;<span class=\"tn-icon bx bx-plus\"></span> button for the top-most section (<em>Owned attributes</em>).</li><li>Select either <em>Add new label definition…</em> or <em>Add new relation definition…</em>.</li><li>Select the name which will be name of the label or relation that will be created when the promoted attribute is edited.</li><li>Ensure <em>Promoted</em> is checked in order to display it at the top of notes.</li><li>Optionally, choose an <em>Alias</em> which will be displayed next to the promoted attribute instead of the attribute name. Generally it's best to choose a “user-friendly” name since it can contain spaces and other characters which are not supported as attribute names.</li><li>Check <em>Inheritable</em> to apply it to this note and all its descendants. To keep it only for the current note, un-check it.</li><li>Press <em>Save &amp; Close</em> to apply the changes.</li></ol><p>Alternatively, promoted attributes can be created from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlJ73vBCjWDw\">Status bar</a>&nbsp;by going to&nbsp;<span class=\"tn-icon bx bx-list-check\"></span> (<em>Attributes</em>), pressing the&nbsp;<span class=\"tn-icon bx bx-plus\"></span> button and selecting <em>Add new label definition…</em>. The resulting attribute can also be copy-pasted or written manually (albeit discouraged).</p><h2>How attribute definitions actually work</h2><p>When a new promoted attribute definition is created, it creates a corresponding label prefixed with either <code>label</code> or <code>relation</code>, depending on the definition type:</p><pre><code class=\"language-text-x-trilium-auto\">#label:myColor(inheritable)=\"promoted,alias=Color,multi,color\"</code></pre><p>The only purpose of the attribute definition is to set up a template. If the attribute was marked as promoted, then it's also displayed to the user for easy editing.</p><figure class=\"table\"><table><tbody><tr><td><figure class=\"image\"><img style=\"aspect-ratio:495/157;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Attributes/1_Promoted%20Attributes_image.png\" width=\"495\" height=\"157\"></figure></td><td>Notice how the promoted attribute definition only creates a “Due date” box above the text content.</td></tr><tr><td><figure class=\"image\"><img style=\"aspect-ratio:663/160;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Attributes/3_Promoted%20Attributes_image.png\" width=\"663\" height=\"160\"></figure></td><td>Once a value is set by the user, a new label (or relation, depending on the type) is created. The name of the attribute matches one set when creating the promoted attribute.</td></tr></tbody></table></figure><p>So there's one attribute for value and one for definition. But notice how an definition attribute can be made <a href=\"#root/_help_bwZpz2ajCEwO\">Inheritable</a>, meaning that it's also applied to all descendant notes. In this case, the definition used for the whole sub-tree while \"value\" attributes are for each not individually.</p><h2>Using system attributes</h2><p>It's possible to create promoted attributes out of system attributes, to be able to easily alter them.</p><p>Here are a few practical examples:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>&nbsp;already make use of this practice, for example:<ul><li>Calendars add “Start Date”, “End Date”, “Start Time” and “End Time” as promoted attributes. These map to system attributes such as <code>startDate</code> which are then interpreted by the calendar view.</li><li><a class=\"reference-link\" href=\"#root/_help_zP3PMqaG71Ct\">Presentation</a>&nbsp;adds a “Background” promoted attribute for each of the slide to easily be able to customize.</li></ul></li><li>The Trilium documentation (which is edited in Trilium) uses a promoted attribute to be able to easily edit the <code>#shareAlias</code> (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_R9pX4DGra2Vt\">Sharing</a>) in order to form clean URLs.</li><li>If you always edit a particular system attribute such as <code>#color</code>, simply create a promoted attribute for it to make it easier.</li></ul><h3>Inverse relation</h3><p>Some relations always occur in pairs - my favorite example is on the family. If you have a note representing husband and note representing wife, then there might be a relation between those two of <code>isPartnerOf</code>. This is bidirectional relationship - meaning that if a relation is pointing from husband to wife then there should be always another relation pointing from wife to husband.</p><p>Another example is with parent-child relationship. Again these always occur in pairs, but in this case it's not exact same relation - the one going from parent to child might be called <code>isParentOf</code> and the other one going from child to parent might be called <code>isChildOf</code>.</p><p>Relation definition allows you to specify such \"inverse relation\" - for the relation you just define you specify which is the inverse relation. Note that in the second example we should have two relation definitions - one for <code>isParentOf</code> which defines <code>isChildOf</code> as inverse relation and then second relation definition for <code>isChildOf</code> which defines <code>isParentOf</code> as inverse relation.</p><p>What this does internally is that whenever we save a relation which has defined inverse relation, we check that this inverse relation exists on the relation target note. Similarly, when we delete relation, we also delete inverse relation on the target note.</p><h2>See also</h2><ul><li>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_2FvYrpmOXm29\">Table</a>&nbsp;collection makes heavy use of promoted attributes to define the columns of the table, since they already carry the type information. When made inheritable, it's also easy to change those fields when the child notes are opened.</li></ul>",
++ "_help_KC1HB96bqqHX": "<p>A template in Trilium serves as a predefined structure for other notes, referred to as instance notes. Assigning a template to a note brings three main effects:</p><ol><li><strong>Attribute Inheritance</strong>: All attributes from the template note are <a href=\"#root/_help_bwZpz2ajCEwO\">inherited</a> by the instance notes. Even attributes with <code>#isInheritable=false</code> are inherited by the instance notes, although only inheritable attributes are further inherited by the children of the instance notes.</li><li><strong>Content Duplication</strong>: The content of the template note is copied to the instance note, provided the instance note is empty at the time of template assignment.</li><li><strong>Child Note Duplication</strong>: All child notes of the template are deep-duplicated to the instance note.</li></ol><h2>Example</h2><p>A typical example would be a \"Book\" template note, which might include:</p><ul><li><strong>Promoted Attributes</strong>: Such as publication year, author, etc. (see <a href=\"#root/_help_OFXdgB2nNk1F\">promoted attributes</a>).</li><li><strong>Outline</strong>: An outline for a book review, including sections like themes, conclusion, etc.</li><li><strong>Child Notes</strong>: Additional notes for highlights, summary, etc.</li></ul><p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Templates_template.png\" alt=\"Template Example\"></p><h2>Instance Note</h2><p>An instance note is a note related to a template note. This relationship means the instance note's content is initialized from the template, and all attributes from the template are inherited.</p><p>To create an instance note through the UI:</p><p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Templates_template-create-instance-note.png\" alt=\"show child note templates\"></p><p>For the template to appear in the menu, the template note must have the <code>#template</code> label. Do not confuse this with the <code>~template</code> relation, which links the instance note to the template note. If you use <a href=\"#root/_help_9sRHySam5fXb\">workspaces</a>, you can also mark templates with <code>#workspaceTemplate</code> to display them only in the workspace.</p><p>Templates can also be added or changed after note creation by creating a <code>~template</code> relation pointing to the desired template note.&nbsp;</p><p>To specify a template for child notes, you can use a <code>~child:template</code> relation pointing to the appropriate template note. There is no limit to the depth of the hierarchy — you can use <code>~child:child:template</code>, <code>~child:child:child:template</code>, and so on.</p><aside class=\"admonition important\"><p>Changing the template hierarchy after the parent note is created will not retroactively apply to newly created child notes.<br>For example, if you initially use <code>~child:template</code> and later switch to <code>~child:child:template</code>, it will not automatically apply the new template to the grandchild notes. Only the structure present at the time of note creation is considered.</p></aside><h2>Default parent for new notes</h2><p>A template can gather the notes created from it in one place, instead of having them land wherever they happen to be created. To do so, add a <code>~template:newNoteDefaultParent</code> relation to the template note, pointing at the note that should hold the instances, for example a <em>Person</em> template pointing to a <em>People</em> note.</p><p>Adding the relation several times places the new note in every target, as&nbsp;<a class=\"reference-link\" href=\"#root/_help_IakOLONlIfGI\">Cloning Notes</a>. The relation can also be inherited (e.g. from a folder holding several templates), in which case a relation owned by the template itself replaces the inherited one. The default parent is only inherited from the template's ancestors in the tree: a template created from another template does not adopt that template's default parent.</p><p>The default parent is used whenever a note is created from the template through the <em>Choose note type</em> dialog:</p><ul><li>Via <code>@</code>-completion in a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;note</li><li>Via the <em>Create note</em> or <em>Create child note</em> options of the note search (new tab or&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>), but only if the default/empty location is set.</li></ul><p>Creating an instance note from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;context menu (<em>Insert child note</em>, <em>Insert note after</em>) still creates it at the chosen place.</p><p>Unlike the&nbsp;<a class=\"reference-link\" href=\"#root/_help_S0Fos78ZfcY7\">Note Inbox</a>, which holds quickly captured notes until they are sorted, the default parent is meant as the instances' permanent location.</p><h2>Regarding note types</h2><p>By default, newly created notes are&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes. If a parent note defines a <code>child:template</code> pointing to a template of a different type (e.g. a Code note), the behavior depends on how the new note is created:</p><ul><li>If no note type is explicitly chosen (e.g. the + button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>), the template is applied and the new note takes the type and content of the template.</li><li>If a note type is explicitly selected (e.g.&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;→ <em>Insert note after</em> / <em>Insert child note</em>):<ul><li>If the selected type matches the template's type, the template is applied.</li><li>If the selected type differs, the template is disregarded entirely — the new note is an empty note of the selected type.</li></ul></li></ul><p>Selecting a specific template from the creation menu always takes precedence over <code>child:template</code>.</p><h2>Additional Notes</h2><p>From a visual perspective, templates can define <code>#iconClass</code> and <code>#cssClass</code> attributes, allowing all instance notes (e.g., books) to display a specific icon and CSS style.</p><p>Explore the concept further in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_6tZeKvSHEUiB\">Demo Notes</a>, including examples like the&nbsp;<a class=\"reference-link\" href=\"#root/_help_iRwzGnHPzonm\">Relation Map</a>,&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYjQUYhpbUEW\">Task Manager</a>, and&nbsp;<a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a>.</p><p>Additionally, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_47ZrP6FNuoG8\">Default Note Title</a>&nbsp;for creating title templates. Note templates and title templates can be combined by creating a <code>#titleTemplate</code> for a template note.</p>",
+ "_help_B2ORr7OVEZtc": "<p>Snippets let you define reusable pieces of text, Markdown or code that can be quickly inserted into your notes.</p>",
- "_help_VQjhl61rlWh9": "<p>Markdown Snippets are closely related to&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>, but instead of defining the content of an entire note, a snippet is a reusable piece of Markdown text that can easily be inserted into a&nbsp;<a class=\"reference-link\" href=\"#root/_help_6RM1Q7ppFVoj\">Markdown</a>&nbsp;note.</p><h2>Creating a Markdown snippet</h2><p>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>: </p><ol><li>Right-click the note where you want to place the snippet.</li><li>Select <strong>Insert child</strong> <em>note</em>.</li><li>Select <em><strong>Markdown snippet</strong></em>.</li></ol><p>Then simply type the desired content into the note.</p><p>The note's title becomes the title of the snippet. Optionally, you can add a description in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;section.</p><h2>Inserting a snippet</h2><p>To insert a snippet, type <code spellcheck=\"false\">/snippet</code> and select its title from the dropdown.</p><p><a class=\"reference-link\" href=\"#root/_help_IEgsWp5hHH35\">Code Snippets</a>&nbsp;with their language mode set to \"Plain text\" are also listed here.</p><h2>Limitations</h2><ul><li>Unlike&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>, snippets cannot be limited to a particular <a href=\"#root/_help_9sRHySam5fXb\">workspace</a>.</li></ul>",
- "_help_IEgsWp5hHH35": "<p>Code Snippets are closely related to&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>, but instead of defining the content of an entire note, a snippet is a reusable piece of code that can easily be inserted into a&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note.</p><h2>Creating a Code snippet</h2><p>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>: </p><ol><li>Right-click the note where you want to place the snippet.</li><li>Select <strong>Insert child</strong> <em>note</em>.</li><li>Select <em><strong>Code snippet</strong></em>.</li></ol><p>Then simply type the desired code into the note and set the correct language mode.</p><p>The note's title becomes the title of the snippet. Optionally, you can add a description in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;section.</p><h2>Inserting a snippet</h2><p>To insert a snippet, type <code spellcheck=\"false\">/snippet</code> and select its title from the dropdown.</p><aside class=\"admonition important\"><p>Only code snippets whose language mode matches the current code note are listed. For example, a CSS code note shows only CSS snippets, not JavaScript ones. The exception is snippets set to \"Plain text\", which are available in&nbsp;<a class=\"reference-link\" href=\"#root/_help_6RM1Q7ppFVoj\">Markdown</a>&nbsp;notes and any code note regardless of its language mode.</p></aside><h2>Limitations</h2><ul><li>Unlike&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>, snippets cannot be limited to a particular <a href=\"#root/_help_9sRHySam5fXb\">workspace</a>.</li></ul>",
- "_help_BCkXAVs63Ttv": "<p>Note map is a visualization of connections between notes. This provides an insight into a structure (\"web\") of notes.</p><p>There are two types of note map:</p><ul><li>Link Map, which shows relations between notes.</li><li>Note Map, which shows the hierarchical tree structure.</li></ul><h2>Accessing the note map</h2><p>The note map comes into multiple flavors:</p><ul><li>To access the note map for the current note:<ul><li>On the&nbsp;<a class=\"reference-link\" href=\"#root/_help_IjZS7iK5EXtb\">New Layout</a>, the note map is available in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_KRlZFoIH0j6p\">Connections tab</a>&nbsp;in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>.</li><li>On the old layout, the note map is a tab in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_BlN9DFI679QC\">Ribbon</a>.</li></ul></li><li>To display a full-screen note map, there is a <a href=\"#root/_help_bdUJEHsAPYQR\">dedicated note type</a> with the same name.</li><li>To view the global note map (of all the notes in the knowledge base), there is a dedicated <em>Note map</em> button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</li></ul><h2>Terminology and structure</h2><ul><li>Each note is represented as a <em>node</em> in the graph, with the title displayed underneath.<ul><li>When the map is zoomed out, the title can still be viewed by hovering over the node.</li><li>The <a href=\"#root/_help_p9kXRFAkwN4o\">icon and color</a> of the note are respected.</li></ul></li><li>The root node is the reference point for which the relations and hierarchical structure are displayed.<ul><li>When accessing the note map through the&nbsp;<a class=\"reference-link\" href=\"#root/_help_BlN9DFI679QC\">Ribbon</a>&nbsp;or the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>&nbsp;(new layout), the root node is the current note.</li><li>When using a dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_bdUJEHsAPYQR\">Note Map</a>&nbsp;note, the root note can be either the parent note, the currently <a href=\"#root/_help_OR8WJ7Iz9K4U\">hoisted</a> note or a specific note. See the note type documentation for more information.</li></ul></li></ul><h2>Interaction</h2><ul><li>Nodes can be dragged around, but they will return to their original position once released.<ul><li>To have the notes remain in the same position as they were dragged, press the <em>Fix nodes</em> button. The position of the notes is not saved, so it will return to normal once you navigate to another note or restart the application.</li></ul></li><li>When hovering over a node, the adjacent relations and nodes are highlighted.</li><li>The distance between nodes can be adjusted via the slider in the bottom-left. Similarly, this value is not saved.</li><li><a class=\"reference-link\" href=\"#root/_help_MKmLg5x6xkor\">Archived Notes</a>&nbsp;are generally ignored by the note map in order to reduce clutter. There is one exception: if the root note is also archived, then all archived notes are displayed too.</li></ul><h2>Link Map</h2><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Note%20Map%20(Link%20map%2C%20Tree%20map)_image.png\" width=\"1425\" height=\"1093\"><p>The link map is a visualization of links and&nbsp;<a class=\"reference-link\" href=\"#root/_help_Cq5X6iKQop6R\">Relations</a>&nbsp;incoming to and outgoing from a particular note.</p><p>The map indicates the following types of relations:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;between notes.</li><li><a class=\"reference-link\" href=\"#root/_help_Cq5X6iKQop6R\">Relations</a></li></ul><p>The link map will also show unlinked notes that are part of the hierarchy as a cloud of unconnected dots. On the&nbsp;<a class=\"reference-link\" href=\"#root/_help_IjZS7iK5EXtb\">New Layout</a>, the sidebar deliberately omits this in order to save some space, but they will be revealed once the map is maximized.</p><h2>Tree Map</h2><p>Shows hierarchical map of notes:</p><figure class=\"image\"><img style=\"aspect-ratio:1420/1490;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/1_Note%20Map%20(Link%20map%2C%20Tree%20map)_image.png\" width=\"1420\" height=\"1490\"></figure><h2>See also</h2><ul><li>Apart from the note map feature which can be accessed from any note, it is also possible to create a dedicated note which will display the relations in full screen. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_bdUJEHsAPYQR\">Note Map</a>&nbsp;for more information.</li><li><a class=\"reference-link\" href=\"#root/_help_iRwzGnHPzonm\">Relation Map</a>&nbsp;is a similar concept, with some differences:<ul><li>note map is automatically generated while relation map must be created manually</li><li>relation map is a type of note while a link map is just virtual visualization</li></ul></li></ul>",
- "_help_R9pX4DGra2Vt": "<p>Trilium allows you to share selected notes as <strong>publicly accessible</strong> read-only documents. This feature is particularly useful for publishing content directly from your Trilium notes, making it accessible to others online.</p><figure class=\"image\"><img style=\"aspect-ratio:1144/660;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Sharing_image.png\" width=\"1144\" height=\"660\"></figure><h2>Features, interaction and limitations</h2><ul><li>Searching by note title.</li><li>Automatic dark/light mode based on the user's browser settings.</li><li>Mobile-friendly layout, with sidebar.</li><li>Collapsible tree with the same note icons as the application.</li><li>Customizable logo.</li><li>Toggle button for dark/light mode, which also stores the user preferences.</li><li>Quick navigation buttons (previous and next note).</li><li>Displaying the date of the last update of the note.</li></ul><h3>By note type</h3><table class=\"ck-table-resized\">\n <colgroup>\n <col style=\"width:19.92%;\">\n <col style=\"width:41.66%;\">\n <col style=\"width:38.42%;\">\n </colgroup>\n <thead>\n <tr>\n <th>&nbsp;</th>\n <th>Supported features</th>\n <th>Limitations</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th><a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a></th>\n <td><ul><li>Table of contents.</li><li>Syntax highlight of code blocks, provided a language is selected (does not work if “Auto-detected” is enabled).</li><li>Rendering for math equations.</li><li><a href=\"#root/_help_nBAXQFj20hS1\">Including notes</a> (only if the included notes are also shared).</li></ul></td>\n <td><ul><li>Inline Mermaid diagrams are not rendered.</li></ul></td>\n </tr>\n <tr>\n <th><a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a></th>\n <td><ul><li>Basic support (displaying the contents of the note in a monospace font).</li></ul></td>\n <td><ul><li>No syntax highlight.</li></ul></td>\n </tr>\n <tr>\n <th><a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a></th>\n <td>Not supported.</td>\n <td>&nbsp;</td>\n </tr>\n <tr>\n <th><a class=\"reference-link\" href=\"#root/_help_iRwzGnHPzonm\">Relation Map</a></th>\n <td>Not supported.</td>\n <td>&nbsp;</td>\n </tr>\n <tr>\n <th><a class=\"reference-link\" href=\"#root/_help_bdUJEHsAPYQR\">Note Map</a></th>\n <td>Not supported.</td>\n <td>&nbsp;</td>\n </tr>\n <tr>\n <th><a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a></th>\n <td>Not supported.</td>\n <td>&nbsp;</td>\n </tr>\n <tr>\n <th><a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a></th>\n <td><ul><li>The child notes are displayed in a fixed format.&nbsp;</li></ul></td>\n <td><ul><li>More advanced view types such as the calendar view are not supported.</li></ul></td>\n </tr>\n <tr>\n <th><a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a></th>\n <td><ul><li>The diagram is displayed as a vector image.</li></ul></td>\n <td><ul><li>No further interaction supported.</li></ul></td>\n </tr>\n <tr>\n <th><a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a></th>\n <td><ul><li>The diagram is displayed as a vector image.</li></ul></td>\n <td><ul><li>No further interaction supported.</li></ul></td>\n </tr>\n <tr>\n <th><a class=\"reference-link\" href=\"#root/_help_1vHRoWCEjj0L\">Web View</a></th>\n <td>Not supported.</td>\n <td>&nbsp;</td>\n </tr>\n <tr>\n <th><a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a></th>\n <td>The diagram is displayed as a vector image.</td>\n <td><ul><li>No further interaction supported.</li></ul></td>\n </tr>\n <tr>\n <th><a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map</a></th>\n <td>Not supported.</td>\n <td>&nbsp;</td>\n </tr>\n <tr>\n <th><a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a></th>\n <td>Basic interaction (downloading the file).</td>\n <td><ul><li>No further interaction supported.</li></ul></td>\n </tr>\n </tbody>\n</table><p>While the sharing feature is powerful, it has some limitations:</p><ul><li><strong>Code Notes</strong>: No syntax highlighting.</li><li><strong>Static Note Tree</strong></li><li><strong>Protected Notes</strong>: Cannot be shared.</li><li><strong>Include Notes</strong>: Not supported.</li></ul><p>Some of these limitations may be addressed in future updates.</p><h2>Prerequisites</h2><p>To use the sharing feature, you must have a&nbsp;<a class=\"reference-link\" href=\"#root/_help_WOcw2SLH6tbX\">Server Installation</a>&nbsp;of Trilium. This is necessary because the notes will be hosted from the server.</p><h2>Sharing a note</h2><ol><li><p><strong>Enable Sharing</strong>: To share a note, toggle the <code spellcheck=\"false\">Shared</code> switch within the note's interface. Once sharing is enabled, an URL will appear, which you can click to access the shared note.</p><p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Sharing_share-single-note.png\" alt=\"Share Note\"></p></li><li><p><strong>Access the Shared Note</strong>: The link provided will open the note in your browser. If your server is not configured with a public IP, the URL will refer to <code spellcheck=\"false\">localhost (127.0.0.1)</code>.</p></li></ol><h2>Sharing a note subtree</h2><p>When you share a note, you actually share the entire subtree of notes beneath it. If the note has child notes, they will also be included in the shared content. For example, sharing the \"Formatting\" subtree will display a page with basic navigation for exploring all the notes within that subtree.</p><h2>Viewing and managing shared notes</h2><p>You can view a list of all shared notes by clicking on \"Show Shared Notes Subtree\" in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>. This allows you to manage and navigate through all the notes you have made public.</p><h2>Security considerations</h2><ul><li>Shared notes are published on the open internet and can be accessed by anyone with the URL unless the notes are password-protected.</li><li>The URL's randomness does not provide security, so it is crucial not to share sensitive information through this feature.</li><li>Trilium takes precautions to protect your publicly shared instance from leaking information for non-shared notes, including opening a separate read-only connection to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_wX4HbRucYSDD\">Database</a>. Depending on your threat model, it might make more sense to use&nbsp;<a class=\"reference-link\" href=\"#root/_help_ycBFjKrrwE9p\">Exporting static HTML for web publishing</a>&nbsp;and use battle-tested web servers such as Nginx or Apache to serve static content.</li></ul><h3>Password protection</h3><p>To protect shared notes with a username and password, you can use the <code spellcheck=\"false\">#shareCredentials</code> attribute. Add this label to the note with the format <code spellcheck=\"false\">#shareCredentials=\"username:password\"</code>. To protect an entire subtree, make sure the label is <a href=\"#root/_help_bwZpz2ajCEwO\">inheritable</a>.</p><h2>Advanced sharing options</h2><h3>Customizing the appearance of shared notes</h3><p>The default design should be a good starting point, but you can customize it using your own CSS:</p><ul><li><strong>Custom CSS</strong>: Link a CSS&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note to the shared page by adding a <code spellcheck=\"false\">~shareCss</code> relation to the note. If you want this style to apply to the entire subtree, make the label inheritable. You can hide the CSS code note from the tree navigation by adding the <code spellcheck=\"false\">#shareHiddenFromTree</code> label.</li><li><strong>Omitting Default CSS</strong>: For extensive styling changes, use the <code spellcheck=\"false\">#shareOmitDefaultCss</code> label to avoid conflicts with Trilium's <a href=\"#root/_help_Wy267RK4M69c\">default stylesheet</a>.</li></ul><h3>Adding JavaScript</h3><p>You can inject custom JavaScript into the shared note using the <code spellcheck=\"false\">~shareJs</code> relation. This allows you to access note attributes or traverse the note tree using the <code spellcheck=\"false\">fetchNote()</code> API, which retrieves note data based on its ID.</p><h3>Adding custom HTML</h3><p>You can inject custom HTML snippets into specific locations of the shared page using the <code spellcheck=\"false\">~shareHtml</code> relation. The HTML note should contain the raw HTML content you want to inject, and you can control where it appears by adding the <code spellcheck=\"false\">#shareHtmlLocation</code> label to the HTML snippet note itself.</p><p>The <code spellcheck=\"false\">#shareHtmlLocation</code> label accepts values in the format <code spellcheck=\"false\">location:position</code>:</p><ul><li><strong>Locations</strong>: <code spellcheck=\"false\">head</code>, <code spellcheck=\"false\">body</code>, <code spellcheck=\"false\">content</code></li><li><strong>Positions</strong>: <code spellcheck=\"false\">start</code>, <code spellcheck=\"false\">end</code></li></ul><p>For example:</p><ul><li><code spellcheck=\"false\">#shareHtmlLocation=head:start</code> - Injects HTML at the beginning of the <code spellcheck=\"false\">&lt;head&gt;</code> section</li><li><code spellcheck=\"false\">#shareHtmlLocation=head:end</code> - Injects HTML at the end of the <code spellcheck=\"false\">&lt;head&gt;</code> section (default)</li><li><code spellcheck=\"false\">#shareHtmlLocation=body:start</code> - Injects HTML at the beginning of the <code spellcheck=\"false\">&lt;body&gt;</code> section</li><li><code spellcheck=\"false\">#shareHtmlLocation=content:start</code> - Injects HTML at the beginning of the content area</li><li><code spellcheck=\"false\">#shareHtmlLocation=content:end</code> - Injects HTML at the end of the content area</li></ul><p>If no location is specified, the HTML will be injected at <code spellcheck=\"false\">content:end</code> by default.</p><p>Example:</p><pre><code class=\"language-text-javascript\">const currentNote = await fetchNote();\nconst parentNote = await fetchNote(currentNote.parentNoteIds[0]);\n\nfor (const attr of parentNote.attributes) {\n console.log(attr.type, attr.name, attr.value);\n}</code></pre><h3>Custom share templates</h3><p>To completely redesign the share, it is possible to create or use an existing <a href=\"#root/_help_Ad7Ku5gOHrDU\">custom share template</a>.</p><h3>Creating human-readable URL aliases</h3><p>Shared notes typically have URLs like <code spellcheck=\"false\">http://domain.tld/share/knvU8aJy4dJ7</code>, where the last part is the note's ID. You can make these URLs more user-friendly by adding the <code spellcheck=\"false\">#shareAlias</code> label to individual notes (e.g., <code spellcheck=\"false\">#shareAlias=highlighting</code>). This will change the URL to <code spellcheck=\"false\">http://domain.tld/share/highlighting</code>.</p><p><strong>Important</strong>:</p><ol><li>Ensure that aliases are unique.</li><li>Using slashes (<code spellcheck=\"false\">/</code>) within aliases to create subpaths is not supported.</li></ol><aside class=\"admonition tip\"><ul><li>To easily identify pages that don't have a share alias, run a&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>&nbsp;with <code spellcheck=\"false\">#!shareAlias</code>.</li><li>To be able to enter the share alias faster, consider using&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;(for example <code spellcheck=\"false\">#label:shareAlias(inheritable)=\"promoted,alias=Slug,single,text\"</code>).</li></ul></aside><h3>Setting a custom favicon</h3><p>To customize the favicon for your shared pages, create a relation <code spellcheck=\"false\">~shareFavicon</code> pointing to a file note containing the favicon (e.g., in <code spellcheck=\"false\">.ico</code> format).</p><h3>Sharing a note as the root</h3><p>You can designate a specific note or folder as the root of your shared content by adding the <code spellcheck=\"false\">#shareRoot</code> label. This note will be linked when visiting <code spellcheck=\"false\">[http://domain.tld/share](http://domain/share)</code>, making it easier to use Trilium as a fully-fledged website.</p><aside class=\"admonition tip\"><p>Consider combining this with the <code spellcheck=\"false\">#shareIndex</code> label, which will display a list of all shared notes.</p></aside><h3>Displaying an index of shared notes</h3><p>When accessing a share, the sub-notes will be displayed in a tree on the left. But since multiple note trees can be shared, it might be useful to display a list of all the different share trees.</p><p>To do so, create a shared text note and apply the <code spellcheck=\"false\">shareIndex</code> label. When viewed, the list of shared roots will be displayed at the bottom of the note.</p><h3>Linking to an external website</h3><p>Sometimes it's useful to include a link to an external website alongside your shared notes — for example in the shared navigation or in an index. To do so, add the <code spellcheck=\"false\">#shareExternalLink</code> label to a note, with the target URL as its value (e.g. <code spellcheck=\"false\">#shareExternalLink=\"https://example.com\"</code>).</p><p>Any link pointing to this note will then redirect to the external website and open in a new browser tab, instead of opening the note's own shared page. This applies to:</p><ul><li>the listing produced by the <code spellcheck=\"false\">#shareIndex</code> label;</li><li>the \"Subpages\" list shown under a parent note;</li><li>inline links to this note from within other shared notes.</li></ul><p>The URL must be absolute and include the scheme (e.g. <code spellcheck=\"false\">https://</code>).</p><aside class=\"admonition note\"><p>The note still exists in the share tree and its own page remains reachable by its direct URL — the label only changes how links to it behave.</p></aside><h2>Attribute reference</h2><table class=\"ck-table-resized\">\n <colgroup>\n <col style=\"width:18.38%;\">\n <col style=\"width:81.62%;\">\n </colgroup>\n <thead>\n <tr>\n <th>Attribute</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td><code spellcheck=\"false\">#shareHiddenFromTree</code></td>\n <td>this note is hidden from left navigation tree, but still accessible with its URL</td>\n </tr>\n <tr>\n <td><code spellcheck=\"false\">#shareExternalLink</code></td>\n <td>when a link points to this note (from the share index, a subpage list, or an inline link in another shared note), it redirects to the given external URL in a new tab instead of the note's shared page. Value is the absolute URL, e.g. <code spellcheck=\"false\">https://example.com</code>.</td>\n </tr>\n <tr>\n <td><code spellcheck=\"false\">#shareAlias</code></td>\n <td>define an alias using which the note will be available under <code spellcheck=\"false\">https://your_trilium_host/share/[your_alias]</code></td>\n </tr>\n <tr>\n <td><code spellcheck=\"false\">#shareOmitDefaultCss</code></td>\n <td>default share page CSS will be omitted. Use when you make extensive styling changes.</td>\n </tr>\n <tr>\n <td><code spellcheck=\"false\">#shareRoot</code></td>\n <td>marks note which is served on /share root.</td>\n </tr>\n <tr>\n <td><code spellcheck=\"false\">#shareDescription</code></td>\n <td>define text to be added to the HTML meta tag for description</td>\n </tr>\n <tr>\n <td><code spellcheck=\"false\">#shareRaw</code></td>\n <td>Note will be served in its raw format, without HTML wrapper. See also&nbsp;<a class=\"reference-link\" href=\"#root/_help_Qjt68inQ2bRj\">Serving directly the content of a note</a>&nbsp;for an alternative method without setting an attribute.</td>\n </tr>\n <tr>\n <td><code spellcheck=\"false\">#shareDisallowRobotIndexing</code></td>\n <td><p>Indicates to web crawlers that the page should not be indexed of this note by:</p><ul><li>Setting the <code spellcheck=\"false\">X-Robots-Tag: noindex</code> HTTP header.</li><li>Setting the <code spellcheck=\"false\">noindex, follow</code> meta tag.</li></ul></td>\n </tr>\n <tr>\n <td><code spellcheck=\"false\">#shareCredentials</code></td>\n <td>require credentials to access this shared note. Value is expected to be in format <code spellcheck=\"false\">username:password</code>. Don't forget to make this inheritable to apply to child-notes/images.</td>\n </tr>\n <tr>\n <td><code spellcheck=\"false\">#shareIndex</code></td>\n <td>Note with this label will list all roots of shared notes.</td>\n </tr>\n <tr>\n <td><code spellcheck=\"false\">#shareHtmlLocation</code></td>\n <td>defines where custom HTML injected via <code spellcheck=\"false\">~shareHtml</code> relation should be placed. Applied to the HTML snippet note itself. Format: <code spellcheck=\"false\">location:position</code> where location is <code spellcheck=\"false\">head</code>, <code spellcheck=\"false\">body</code>, or <code spellcheck=\"false\">content</code> and position is <code spellcheck=\"false\">start</code> or <code spellcheck=\"false\">end</code>. Defaults to <code spellcheck=\"false\">content:end</code>.</td>\n </tr>\n </tbody>\n</table><h3>Customizing logo</h3><p>It's possible to adjust the logo which is displayed on the top-left of the left pane.</p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Attribute</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code spellcheck=\"false\">~shareLogo</code></td>\n<td>Relation set to an image to use as logo. The image must be part of the share tree (it can be hidden if needed).</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">#shareLogoWidth</code></td>\n<td>The width (in pixels, without unit) to set for the logo. Default is <code spellcheck=\"false\">53</code>.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">#shareLogoHeight</code></td>\n<td>The height (in pixels, without unit) to set for the logo. Default is <code spellcheck=\"false\">40</code>.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">#shareRootLink</code></td>\n<td>URL to navigate to when the logo is pressed.</td>\n</tr>\n</tbody></table></figure><h3>Customizing OpenGraph</h3><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Attribute</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code spellcheck=\"false\">#shareOpenGraphColor</code></td>\n<td>This adjusts the <code spellcheck=\"false\">theme-color</code> meta-property.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">#shareOpenGraphURL</code></td>\n<td>This adjusts the <code spellcheck=\"false\">og:url</code> and <code spellcheck=\"false\">twitter:url</code> meta-properties.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">#shareOpenGraphDomain</code></td>\n<td>Adjusts the <code spellcheck=\"false\">twitter:domain</code> meta-property.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">#shareOpenGraphImage</code>&nbsp; <br><code spellcheck=\"false\">~shareOpenGraphImage</code></td>\n<td>Can be either a label, case in which the value is passed on as-is, or it can be a relation to an image&nbsp;<a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a>. This controls the <code spellcheck=\"false\">og:image</code> meta-property.</td>\n</tr>\n</tbody></table></figure><h2>Credits</h2><p>Since v0.95.0, a new theme was introduced (and enabled by default) which greatly improves the visual aspect of the Share feature, as well as its functionality (such as mobile support, dark/light mode, collapsible tree, etc.). This theme is an adaptation of the <a href=\"https://github.com/zerebos/trilium.rocks\">Trilium Rocks!</a> by <a href=\"https://github.com/zerebos\">zerebos</a>.</p>",
- "_help_Qjt68inQ2bRj": "<p>When accessing a shared note, Trilium will render it as a web page. Sometimes it's desirable to serve the content directly so that it can be used in a script or downloaded by the user.</p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>A note displayed as a web page (HTML)</th>\n<th>A note displayed as a raw format</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><figure class=\"image\"><img style=\"aspect-ratio:738/275;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Sharing/Serving%20directly%20the%20content%20of%20a%20note_image.png\" width=\"738\" height=\"275\"></figure></td>\n<td><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Sharing/Serving%20directly%20the%20content%20of%20a%20note_image.jpg\"></td>\n</tr>\n</tbody></table></figure><h2>By adding an attribute to the note</h2><p>Simply add the <code spellcheck=\"false\">#shareRaw</code> attribute and the note will always be rendered <em>raw</em> when accessed from the share URL.</p><h2>By altering the URL</h2><p>Append <code spellcheck=\"false\">?raw</code> to the URL to display a note in its raw format regardless of whether the <code spellcheck=\"false\">#shareRaw</code> attribute is added on the note.</p><p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Sharing/Serving%20directly%20the%20content%20of%20a%20note_image.jpg\"></p>",
- "_help_ycBFjKrrwE9p": "<p>As described in&nbsp;<a class=\"reference-link\" href=\"#root/_help_R9pX4DGra2Vt\">Sharing</a>, Trilium can act as a public server in which the shared notes are displayed in read-only mode. While this can work in most cases, it's generally not meant for high-traffic websites and since it's running on a Node.js server it can be potentially exploited.</p><p>Another alternative is to generate static HTML files (just like other static site generators such as <a href=\"https://www.mkdocs.org/\">MkDocs</a>). Since the normal HTML ZIP export does not contain any styling or additional functionality, Trilium provides a way to export the same layout and style as the&nbsp;<a class=\"reference-link\" href=\"#root/_help_R9pX4DGra2Vt\">Sharing</a>&nbsp;function into static HTML files.</p><p>Apart from the enhanced security, these HTML files are also easy to deploy on “serverless” deployments such as GitHub Pages or CloudFlare Pages and cache very easily.</p><aside class=\"admonition tip\"><p>Trilium's documentation, available at <a href=\"https://docs.triliumnotes.org/\">docs.triliumnotes.org</a> is built using this function of exporting to static HTML files which are then deployed automatically to CloudFlare Pages.</p><p>The process is <a href=\"https://github.com/TriliumNext/Trilium/blob/main/apps/edit-docs/src/build-docs.ts\">automated</a> by importing the Markdown documentation and exporting it via a script to the static web format.</p></aside><h2>Differences from normal sharing</h2><p>Apart from normal&nbsp;<a class=\"reference-link\" href=\"#root/_help_R9pX4DGra2Vt\">Sharing</a>, exporting to static HTML files comes with a few subtle differences:</p><ul><li>The URL structure is different. Where in normal sharing it's something along the way of <code spellcheck=\"false\">example.com/share/noteid</code>, the notes follow an hierarchical structure, such as <code spellcheck=\"false\">docs.triliumnotes.org/user-guide/concepts/navigation/tree-concepts</code>.</li><li>The <code spellcheck=\"false\">favicon.ico</code> is not handled automatically, it needs to be manually added on the server after the export is generated.</li><li>The “Last updated” for notes is not available.</li><li>The search functionality works slightly different since the normal one requires an active API to work. In the static export, search still works but uses a different mechanism so results might be different.</li></ul><h2>Differences from normal .zip export</h2><ul><li>The name of the files/URLs will prefer <code spellcheck=\"false\">shareAlias</code> to allow for clean URLs.</li><li>The export requires a functional web server as the pages will not render properly if accessed locally via a web browser due to the use of module scripts.</li><li>The directory structure is also slightly different:<ul><li>A normal HTML export results in an index file and a single directory.</li><li>Instead, for static exporting the top-root level becomes the index file and the child directories are on the root instead.</li><li>This makes it possible to easily publish to a website, without forcing everything but the root note to be in a sub-directory.</li></ul></li></ul><h2>Testing locally</h2><p>As mentioned previously, the exported static pages require a website to function. In order to test locally, a web server needs to be used.</p><p>One example is to use the Node.js-based <a href=\"https://www.npmjs.com/package/http-server\"><code spellcheck=\"false\">http-server</code></a> which can be installed via:</p><pre><code class=\"language-text-x-trilium-auto\">npm i -g http-server</code></pre><p>Once installed simply:</p><ol><li>Extract the exported .zip file.</li><li>Inside the extracted directory, run <code spellcheck=\"false\">http-server</code>.</li><li>Access the indicated address (e.g. <a href=\"http://localhost:8080\">http://localhost:8080</a>).</li></ol><h2>Automation</h2><p><a class=\"reference-link\" href=\"#root/_help_pgxEVkzLl1OP\">ETAPI (REST API)</a>&nbsp;could potentially be used to automate an export on a scheduled task.</p>",
- "_help_sLIJ6f1dkJYW": "<p>It might be desirable to only expose the share functionality of Trilium to the Internet, and keep the application accessible only within a local network or via VPN.</p><p>To do so, a reverse proxy is required.</p><h2>Caddy</h2><pre><code class=\"language-text-x-trilium-auto\">http://domain.com {\n reverse_proxy /share http://localhost:8080/share\n}</code></pre><p>This is for newer versions where the share functionality is isolated, for older versions it's required to also include <code spellcheck=\"false\">/assets</code>.<a href=\"#fn2b8mg20aol8\"><sup>[1]</sup></a></p><ol><li><p><a href=\"#fnref2b8mg20aol8\"><strong><sup>^</sup></strong></a></p><p><a href=\"https://github.com/orgs/TriliumNext/discussions/7341#discussioncomment-14679897\">https://github.com/orgs/TriliumNext/discussions/7341#discussioncomment-14679897</a></p></li></ol>",
- "_help_Ad7Ku5gOHrDU": "<aside class=\"admonition note\"><p>This topic of creating share templates is considered advanced and requires JavaScript/EJS knowledge.</p><p>The default share template should cover most normal uses.</p></aside><p>For full control over the HTML structure of a shared page — beyond what custom CSS, JS, or HTML snippets allow — you can replace the page template entirely using the <code spellcheck=\"false\">~shareTemplate</code> relation.</p><p>To do so:</p><ol><li>Create a&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note with the language <em>Embedded JavaScript</em> (EJS).</li><li>For a shared note to apply the newly created template, apply the <code spellcheck=\"false\">~shareTemplate</code> relation pointing to the note created at step (1). Make use of&nbsp;<a class=\"reference-link\" href=\"#root/_help_bwZpz2ajCEwO\">Attribute Inheritance</a>&nbsp;to apply it to multiple shared notes.</li></ol><p>There are two important constraints to be aware of:</p><ul><li>Because EJS templates execute arbitrary server-side JavaScript, <code spellcheck=\"false\">~shareTemplate</code> only takes effect when backend scripting is enabled. If it is disabled (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_fiHicjpHjIRJ\">Security</a>), the relation is ignored and the default template is used. For the same reason, <strong>only apply templates from notes you trust</strong>.</li><li>The template note must be part of the shared subtree (just like <code spellcheck=\"false\">~shareCss</code>, <code spellcheck=\"false\">~shareJs</code>) in order for it to be loaded. To prevent it from being shown in the navigation, apply <code spellcheck=\"false\">#shareHiddenFromTree</code> to it.</li></ul><h2>Content of the share template</h2><p>Use the <a href=\"https://github.com/TriliumNext/Notes/blob/develop/packages/share-theme/src/templates/page.ejs\">original template</a> as reference when creating a new share template.</p><h2>Available variables</h2><p>Your template is rendered with a context object exposing the note and its rendering environment. The most useful values are:</p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Variable</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code spellcheck=\"false\">note</code></td>\n<td>The note being rendered. Use it to read attributes (<code spellcheck=\"false\">note.getLabelValue(...)</code>), <code spellcheck=\"false\">note.title</code>, child notes, etc.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">content</code></td>\n<td>The note's already-rendered HTML content, as a string.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">header</code></td>\n<td>Extra HTML to place in the document head for this note (used by some note types).</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">isEmpty</code></td>\n<td><code spellcheck=\"false\">true</code> when the note has no content of its own.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">subRoot</code></td>\n<td>The root of the shared subtree as <code spellcheck=\"false\">{ note, branch }</code> — handy for a site-wide title or logo.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">cssToLoad</code> / <code spellcheck=\"false\">jsToLoad</code></td>\n<td>Arrays of stylesheet / script URLs the default theme would inject (includes anything added via <code spellcheck=\"false\">~shareCss</code> / <code spellcheck=\"false\">~shareJs</code>).</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">faviconUrl</code> / <code spellcheck=\"false\">logoUrl</code></td>\n<td>Resolved favicon and logo URLs.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">isStatic</code></td>\n<td><code spellcheck=\"false\">true</code> during a static HTML export, <code spellcheck=\"false\">false</code> for a live server render.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">t</code></td>\n<td>The <code spellcheck=\"false\">i18next</code> translation function.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">utils</code></td>\n<td>Helper utilities such as <code spellcheck=\"false\">slugify()</code> and <code spellcheck=\"false\">stripTags()</code>.</td>\n</tr>\n</tbody></table></figure><h2>Error handling</h2><p>If your template throws an error while rendering, Trilium logs the error and quietly falls back to the default template, so a broken template never takes the shared page down.</p><h2>Splitting a template into partials</h2><p>A template can pull in other EJS notes as partials. Create them as <strong>child notes</strong> of the template note (each also a <code spellcheck=\"false\">code</code> / <code spellcheck=\"false\">application/x-ejs</code> note) and reference them by title:</p><pre><code class=\"language-text-x-trilium-auto\">&lt;%- include(\"header\") %&gt;\n\n&lt;main&gt;\n &lt;h1&gt;&lt;%= note.title %&gt;&lt;/h1&gt;\n &lt;%- content %&gt;\n&lt;/main&gt;\n\n&lt;%- include(\"footer\") %&gt;\n</code></pre><p>Here <code spellcheck=\"false\">header</code> and <code spellcheck=\"false\">footer</code> are the titles of child notes of the template. Only direct children are resolvable, and they must be EJS code notes.</p>",
++ "_help_VQjhl61rlWh9": "<p>Markdown Snippets are closely related to&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>, but instead of defining the content of an entire note, a snippet is a reusable piece of Markdown text that can easily be inserted into a&nbsp;<a class=\"reference-link\" href=\"#root/_help_6RM1Q7ppFVoj\">Markdown</a>&nbsp;note.</p><h2>Creating a Markdown snippet</h2><p>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>: </p><ol><li>Right-click the note where you want to place the snippet.</li><li>Select <em>Insert child note</em>.</li><li>Select <em>More</em> → <em>Markdown snippet</em>.</li></ol><p>Then simply type the desired content into the note.</p><p>The note's title becomes the title of the snippet. Optionally, you can add a description in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;section.</p><h2>Inserting a snippet</h2><p>To insert a snippet, type <code>/snippet</code> and select its title from the dropdown.</p><p><a class=\"reference-link\" href=\"#root/_help_IEgsWp5hHH35\">Code Snippets</a>&nbsp;with their language mode set to \"Plain text\" are also listed here.</p><h2>Limitations</h2><ul><li>Unlike&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>, snippets cannot be limited to a particular <a href=\"#root/_help_9sRHySam5fXb\">workspace</a>.</li></ul>",
++ "_help_IEgsWp5hHH35": "<p>Code Snippets are closely related to&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>, but instead of defining the content of an entire note, a snippet is a reusable piece of code that can easily be inserted into a&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note.</p><h2>Creating a Code snippet</h2><p>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>: </p><ol><li>Right-click the note where you want to place the snippet.</li><li>Select <em>Insert child note</em>.</li><li>Select <em>More</em> → <em>Code snippet</em>.</li></ol><p>Then simply type the desired code into the note and set the correct language mode.</p><p>The note's title becomes the title of the snippet. Optionally, you can add a description in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;section.</p><h2>Inserting a snippet</h2><p>To insert a snippet, type <code>/snippet</code> and select its title from the dropdown.</p><aside class=\"admonition important\"><p>Only code snippets whose language mode matches the current code note are listed. For example, a CSS code note shows only CSS snippets, not JavaScript ones. The exception is snippets set to \"Plain text\", which are available in&nbsp;<a class=\"reference-link\" href=\"#root/_help_6RM1Q7ppFVoj\">Markdown</a>&nbsp;notes and any code note regardless of its language mode.</p></aside><h2>Limitations</h2><ul><li>Unlike&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>, snippets cannot be limited to a particular <a href=\"#root/_help_9sRHySam5fXb\">workspace</a>.</li></ul>",
++ "_help_BCkXAVs63Ttv": "<p>Note map is a visualization of connections between notes. This provides an insight into a structure (\"web\") of notes.</p><p>There are two types of note map:</p><ul><li>Link Map, which shows relations between notes.</li><li>Note Map, which shows the hierarchical tree structure.</li></ul><h2>Accessing the note map</h2><p>The note map comes into multiple flavors:</p><ul><li>The note map is available in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_KRlZFoIH0j6p\">Connections tab</a>&nbsp;in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>, in the <em>Note map</em> section.<ul><li>It can also be accessed by going to&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>&nbsp;→ <em>Note map</em>, which will focus the sidebar at the right section.</li></ul></li><li>To display a full-screen note map, there is a <a href=\"#root/_help_bdUJEHsAPYQR\">dedicated note type</a> with the same name.</li><li>To view the global note map (of all the notes in the knowledge base), there is a dedicated <em>Note map</em> button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</li></ul><h2>Terminology and structure</h2><ul><li>Each note is represented as a <em>node</em> in the graph, with the title displayed underneath.<ul><li>When the map is zoomed out, the title can still be viewed by hovering over the node.</li><li>The <a href=\"#root/_help_p9kXRFAkwN4o\">icon and color</a> of the note are respected.</li></ul></li><li>The root node is the reference point for which the relations and hierarchical structure are displayed.<ul><li>When accessing the note map through the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>, the root node is the current note.</li><li>When using a dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_bdUJEHsAPYQR\">Note Map</a>&nbsp;note, the root note can be either the parent note, the currently <a href=\"#root/_help_OR8WJ7Iz9K4U\">hoisted</a> note or a specific note. See the note type documentation for more information.</li></ul></li></ul><h2>Interaction</h2><ul><li>Nodes can be dragged around, but they will return to their original position once released.<ul><li>To have the notes remain in the same position as they were dragged, press the <em>Fix nodes</em> button. The position of the notes is not saved, so it will return to normal once you navigate to another note or restart the application.</li></ul></li><li>When hovering over a node, the adjacent relations and nodes are highlighted.</li><li>The distance between nodes can be adjusted via the slider in the bottom-left. Similarly, this value is not saved.</li><li>To zoom, use the mouse wheel, pinch on a touch screen, or press the <span class=\"tn-icon bx bx-plus-circle\"></span> and <span class=\"tn-icon bx bx-minus-circle\"></span> buttons in the bottom-right corner.<ul><li>To bring the whole map back into view, press the <span class=\"tn-icon bx bx-scan\"></span> <em>Fit to view</em> button next to them.</li><li>The zoom buttons are not shown on mobile, where pinching zooms instead. The <em>Fit to view</em> button is always shown.</li></ul></li><li><a class=\"reference-link\" href=\"#root/_help_MKmLg5x6xkor\">Archived Notes</a>&nbsp;are generally ignored by the note map in order to reduce clutter. There is one exception: if the root note is also archived, then all archived notes are displayed too.</li></ul><h2>Link Map</h2><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Note%20Map%20(Link%20map%2C%20Tree%20map)_image.png\" width=\"1425\" height=\"1093\"><p>The link map is a visualization of links and&nbsp;<a class=\"reference-link\" href=\"#root/_help_Cq5X6iKQop6R\">Relations</a>&nbsp;incoming to and outgoing from a particular note.</p><p>The map indicates the following types of relations:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>&nbsp;between notes.</li><li><a class=\"reference-link\" href=\"#root/_help_Cq5X6iKQop6R\">Relations</a></li></ul><p>The link map will also show unlinked notes that are part of the hierarchy as a cloud of unconnected dots. On the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>&nbsp;deliberately omits this in order to save some space, but they will be revealed once the map is maximized.</p><h2>Tree Map</h2><p>Shows hierarchical map of notes:</p><figure class=\"image\"><img style=\"aspect-ratio:1420/1490;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/1_Note%20Map%20(Link%20map%2C%20Tree%20map)_image.png\" width=\"1420\" height=\"1490\"></figure><h2>See also</h2><ul><li>Apart from the note map feature which can be accessed from any note, it is also possible to create a dedicated note which will display the relations in full screen. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_bdUJEHsAPYQR\">Note Map</a>&nbsp;for more information.</li><li><a class=\"reference-link\" href=\"#root/_help_iRwzGnHPzonm\">Relation Map</a>&nbsp;is a similar concept, with some differences:<ul><li>note map is automatically generated while relation map must be created manually</li><li>relation map is a type of note while a link map is just virtual visualization</li></ul></li></ul>",
++ "_help_R9pX4DGra2Vt": "<p>Trilium allows you to share selected notes as <strong>publicly accessible</strong> read-only documents. This feature is particularly useful for publishing content directly from your Trilium notes, making it accessible to others online.</p><figure class=\"image\"><img style=\"aspect-ratio:1144/660;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Sharing_image.png\" width=\"1144\" height=\"660\"></figure><h2>Features, interaction and limitations</h2><ul><li>Searching by note title.</li><li>Light and dark mode, following the visitor's system setting by default, also while the page is open. The visitor can pick <em>Light</em>, <em>Dark</em> or <em>System</em> with the buttons at the top of the navigation pane; the choice is remembered by the browser.</li><li>A layout centered on wide screens, with the navigation tree and the table of contents at either side of the content, and a mobile-friendly layout on narrow ones. There, the navigation tree slides in from the menu button in the header, and lists the headings of the current page below its entry (at the top of the pane, for a page the tree does not show).</li><li>Collapsible tree with the same note icons as the application. It keeps the sections the visitor expanded and its scroll position while they move between the pages of the site, and shows the current note.</li><li>Customizable logo.</li><li>Quick navigation buttons (previous and next note).</li><li>Notes that hide their children from the tree with <code>#subtreeHidden</code> (such as a <a class=\"reference-link\" href=\"#root/_help_CtBQqbwXDx1w\">Kanban Board</a>) show a badge counting them in place of listing them. The page of one of those children shows only that child below its parent, and the previous and next buttons skip them.</li><li>The subpages of a text or code note shown below its content as cards, as in the application. Each card shows the icon of the subpage and the start of its text (or its <code>#shareDescription</code>), or, for a subpage without text, links to its own first subpages. The cards can be hidden with <code>#hideChildrenOverview</code>.</li><li>Displaying the date of the last update of the note, written out in the application's language.</li><li>Marking the page with the application's language and its text direction, and the content of the note with its own <a href=\"#root/_help_veGu4faJErEM\">content language</a>, for screen readers and right-to-left text.</li></ul><h3>By note type</h3><figure class=\"table\"><table class=\"ck-table-resized\"><colgroup><col style=\"width:19.92%;\"><col style=\"width:41.66%;\"><col style=\"width:38.42%;\"></colgroup><thead><tr><th>&nbsp;</th><th>Supported features</th><th>Limitations</th></tr></thead><tbody><tr><th><a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a></th><td><ul><li>Table of contents.</li><li>A link next to each heading, shown while the pointer is over the heading. Clicking it shows the address of the section in the address bar of the browser and copies it, to share a link to the section.</li><li>Syntax highlight of code blocks, in the language selected for each block and in the colors of the VS Code light or dark theme, following the page's mode. For “Auto-detected” blocks, the language is guessed among the ones enabled in <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Code Notes</em>; a language not enabled there is not highlighted.</li><li>Rendering for math equations.</li><li><a href=\"#root/_help_nBAXQFj20hS1\">Including notes</a> (only if the included notes are also shared).</li><li>Drawing canvases, shown as pictures at their own size.</li><li>Mermaid diagrams in code blocks, drawn in the page's light or dark mode and redrawn when the visitor switches it.</li></ul></td><td>&nbsp;</td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a></th><td><ul><li>Basic support (displaying the contents of the note in a monospace font).</li></ul></td><td><ul><li>No syntax highlight.</li></ul></td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a></th><td>Not supported.</td><td>&nbsp;</td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_iRwzGnHPzonm\">Relation Map</a></th><td>Not supported.</td><td>&nbsp;</td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_bdUJEHsAPYQR\">Note Map</a></th><td>Not supported.</td><td>&nbsp;</td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a></th><td>Not supported.</td><td>&nbsp;</td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a></th><td><ul><li>The child notes are shown as cards, or as a list when the view type of the collection is <em>List</em>. Each shows its icon and the start of its text (or its <code>#shareDescription</code>), or, for a child note without text, links to its own first child notes.</li></ul></td><td><ul><li>The calendar, table, board, geo map, dashboard and presentation view types are shown as in the app, but read-only.</li></ul></td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_s1aBHPd79XYj\">Mermaid Diagrams</a></th><td><ul><li>The diagram is drawn in the page's light or dark mode and redrawn when the visitor switches it. In browsers with JavaScript disabled, the image saved when the note was last edited is shown instead, and the source of the diagram can be expanded below it.</li><li>The diagram fills the page and can be zoomed with the <span class=\"tn-icon bx bx-minus-circle\"></span> and <span class=\"tn-icon bx bx-plus-circle\"></span> buttons in its bottom corner or with the mouse wheel, between 50% and 1000% of its fitted size, and on touch screens by pinching. Clicking the percentage between the buttons, or double-clicking the diagram, shows it whole again. The diagram can be panned by dragging it.</li></ul></td><td>&nbsp;</td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a></th><td><ul><li>The diagram is displayed as a vector image.</li></ul></td><td><ul><li>No further interaction supported.</li></ul></td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_1vHRoWCEjj0L\">Web View</a></th><td>Not supported.</td><td>&nbsp;</td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a></th><td>The diagram is displayed as a vector image.</td><td><ul><li>No further interaction supported.</li></ul></td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map</a></th><td>Not supported.</td><td>&nbsp;</td></tr><tr><th><a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a></th><td>Basic interaction (downloading the file).</td><td><ul><li>No further interaction supported.</li></ul></td></tr></tbody></table></figure><p>While the sharing feature is powerful, it has some limitations:</p><ul><li><strong>Code Notes</strong>: No syntax highlighting.</li><li><strong>Static Note Tree</strong></li><li><strong>Protected Notes</strong>: Cannot be shared.</li><li><strong>Include Notes</strong>: Not supported.</li></ul><p>Some of these limitations may be addressed in future updates.</p><h2>Prerequisites</h2><p>To use the sharing feature, you must have a&nbsp;<a class=\"reference-link\" href=\"#root/_help_WOcw2SLH6tbX\">Server Installation</a>&nbsp;of Trilium. This is necessary because the notes will be hosted from the server.</p><h2>Sharing a note</h2><ol><li><p><strong>Enable Sharing</strong>: To share a note, toggle the <code>Shared</code> switch within the note's interface. Once sharing is enabled, an URL will appear, which you can click to access the shared note.</p><p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Sharing_share-single-note.png\" alt=\"Share Note\"></p></li><li><p><strong>Access the Shared Note</strong>: The link provided will open the note in your browser. If your server is not configured with a public IP, the URL will refer to <code>localhost (127.0.0.1)</code>.</p></li></ol><h2>Sharing a note subtree</h2><p>When you share a note, you actually share the entire subtree of notes beneath it. If the note has child notes, they will also be included in the shared content. For example, sharing the \"Formatting\" subtree will display a page with basic navigation for exploring all the notes within that subtree.</p><h2>Viewing and managing shared notes</h2><p>You can view a list of all shared notes by clicking on \"Show Shared Notes Subtree\" in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>. This allows you to manage and navigate through all the notes you have made public.</p><h2>Security considerations</h2><ul><li>Shared notes are published on the open internet and can be accessed by anyone with the URL unless the notes are password-protected.</li><li>The URL's randomness does not provide security, so it is crucial not to share sensitive information through this feature.</li><li>Trilium takes precautions to protect your publicly shared instance from leaking information for non-shared notes, including opening a separate read-only connection to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_wX4HbRucYSDD\">Database</a>. Depending on your threat model, it might make more sense to use&nbsp;<a class=\"reference-link\" href=\"#root/_help_ycBFjKrrwE9p\">Exporting static HTML for web publishing</a>&nbsp;and use battle-tested web servers such as Nginx or Apache to serve static content.</li></ul><h3>Password protection</h3><p>To protect shared notes with a username and password, you can use the <code>#shareCredentials</code> attribute. Add this label to the note with the format <code>#shareCredentials=\"username:password\"</code>. To protect an entire subtree, make sure the label is <a href=\"#root/_help_bwZpz2ajCEwO\">inheritable</a>.</p><h2>Advanced sharing options</h2><h3>Customizing the appearance of shared notes</h3><p>The default design should be a good starting point, but you can customize it using your own CSS:</p><ul><li><strong>Custom CSS</strong>: Link a CSS&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note to the shared page by adding a <code>~shareCss</code> relation to the note. If you want this style to apply to the entire subtree, make the label inheritable. You can hide the CSS code note from the tree navigation by adding the <code>#shareHiddenFromTree</code> label.</li><li><strong>Omitting Default CSS</strong>: For extensive styling changes, use the <code>#shareOmitDefaultCss</code> label to avoid conflicts with Trilium's <a href=\"#root/_help_Wy267RK4M69c\">default stylesheet</a>.</li></ul><h3>Adding JavaScript</h3><p>You can inject custom JavaScript into the shared note using the <code>~shareJs</code> relation. This allows you to access note attributes or traverse the note tree using the <code>fetchNote()</code> API, which retrieves note data based on its ID.</p><h3>Adding custom HTML</h3><p>You can inject custom HTML snippets into specific locations of the shared page using the <code>~shareHtml</code> relation. The HTML note should contain the raw HTML content you want to inject, and you can control where it appears by adding the <code>#shareHtmlLocation</code> label to the HTML snippet note itself.</p><p>The <code>#shareHtmlLocation</code> label accepts values in the format <code>location:position</code>:</p><ul><li><strong>Locations</strong>: <code>head</code>, <code>body</code>, <code>content</code></li><li><strong>Positions</strong>: <code>start</code>, <code>end</code></li></ul><p>For example:</p><ul><li><code>#shareHtmlLocation=head:start</code> - Injects HTML at the beginning of the <code>&lt;head&gt;</code> section</li><li><code>#shareHtmlLocation=head:end</code> - Injects HTML at the end of the <code>&lt;head&gt;</code> section (default)</li><li><code>#shareHtmlLocation=body:start</code> - Injects HTML at the beginning of the <code>&lt;body&gt;</code> section</li><li><code>#shareHtmlLocation=content:start</code> - Injects HTML at the beginning of the content area</li><li><code>#shareHtmlLocation=content:end</code> - Injects HTML at the end of the content area</li></ul><p>If no location is specified, the HTML will be injected at <code>content:end</code> by default.</p><p>Example:</p><pre><code class=\"language-text-javascript\">const currentNote = await fetchNote();\nconst parentNote = await fetchNote(currentNote.parentNoteIds[0]);\n\nfor (const attr of parentNote.attributes) {\n console.log(attr.type, attr.name, attr.value);\n}</code></pre><h3>Custom share templates</h3><p>To completely redesign the share, it is possible to create or use an existing <a href=\"#root/_help_Ad7Ku5gOHrDU\">custom share template</a>.</p><h3>Creating human-readable URL aliases</h3><p>Shared notes typically have URLs like <code>http://domain.tld/share/knvU8aJy4dJ7</code>, where the last part is the note's ID. You can make these URLs more user-friendly by adding the <code>#shareAlias</code> label to individual notes (e.g., <code>#shareAlias=highlighting</code>). This will change the URL to <code>http://domain.tld/share/highlighting</code>. The URL with the note's ID keeps working and redirects to the alias.</p><p><strong>Important</strong>:</p><ol><li>Ensure that aliases are unique.</li><li>Using slashes (<code>/</code>) within aliases to create subpaths is not supported.</li></ol><aside class=\"admonition tip\"><ul><li>To easily identify pages that don't have a share alias, run a&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>&nbsp;with <code>#!shareAlias</code>.</li><li>To be able to enter the share alias faster, consider using&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;(for example <code>#label:shareAlias(inheritable)=\"promoted,alias=Slug,single,text\"</code>).</li></ul></aside><h3>Setting a custom favicon</h3><p>To customize the favicon for your shared pages, create a relation <code>~shareFavicon</code> pointing to a file note containing the favicon (e.g., in <code>.ico</code> format).</p><h3>Sharing a note as the root</h3><p>You can designate a specific note or folder as the root of your shared content by adding the <code>#shareRoot</code> label. This note will be linked when visiting <code>[http://domain.tld/share](http://domain/share)</code>, making it easier to use Trilium as a fully-fledged website.</p><aside class=\"admonition tip\"><p>Consider combining this with the <code>#shareIndex</code> label, which will display a list of all shared notes.</p></aside><h3>Displaying an index of shared notes</h3><p>When accessing a share, the sub-notes will be displayed in a tree on the left. But since multiple note trees can be shared, it might be useful to display a list of all the different share trees.</p><p>To do so, create a shared text note and apply the <code>shareIndex</code> label. When viewed, the list of shared roots will be displayed at the bottom of the note.</p><h3>Linking to an external website</h3><p>Sometimes it's useful to include a link to an external website alongside your shared notes — for example in the shared navigation or in an index. To do so, add the <code>#shareExternalLink</code> label to a note, with the target URL as its value (e.g. <code>#shareExternalLink=\"https://example.com\"</code>).</p><p>Any link pointing to this note will then redirect to the external website and open in a new browser tab, instead of opening the note's own shared page. Opening the note's shared URL by its ID also redirects to the external website. This applies to:</p><ul><li>the listing produced by the <code>#shareIndex</code> label;</li><li>the navigation tree of the shared site;</li><li>the \"Subpages\" list shown under a parent note;</li><li>inline links to this note from within other shared notes.</li></ul><p>The URL must be absolute and include the scheme (e.g. <code>https://</code>).</p><aside class=\"admonition note\"><p>The note still exists in the share tree and its own page remains reachable by its direct URL — the label only changes how links to it behave.</p></aside><h2>Attribute reference</h2><figure class=\"table\"><table class=\"ck-table-resized\"><colgroup><col style=\"width:18.38%;\"><col style=\"width:81.62%;\"></colgroup><thead><tr><th>Attribute</th><th>Description</th></tr></thead><tbody><tr><td><code>#shareHiddenFromTree</code></td><td>this note is hidden from the left navigation tree, from its parent's list of subpages, from shared note maps and from the share's search, but still accessible with its URL</td></tr><tr><td><code>#shareExternalLink</code></td><td>when a link points to this note (from the share index, a subpage list, or an inline link in another shared note), it redirects to the given external URL in a new tab instead of the note's shared page. Value is the absolute URL, e.g. <code>https://example.com</code>.</td></tr><tr><td><code>#shareAlias</code></td><td>define an alias using which the note will be available under <code>https://your_trilium_host/share/[your_alias]</code></td></tr><tr><td><code>#shareOmitDefaultCss</code></td><td>default share page CSS will be omitted. Use when you make extensive styling changes.</td></tr><tr><td><code>#shareRoot</code></td><td>marks note which is served on /share root.</td></tr><tr><td><code>#shareDescription</code></td><td>define text to be added to the HTML meta tag for description. It also describes the note in the list of subpages of its parent, in place of the start of its text.</td></tr><tr><td><code>#shareRaw</code></td><td>Note will be served in its raw format, without HTML wrapper. See also&nbsp;<a class=\"reference-link\" href=\"#root/_help_Qjt68inQ2bRj\">Serving directly the content of a note</a>&nbsp;for an alternative method without setting an attribute.</td></tr><tr><td><code>#shareDisallowRobotIndexing</code></td><td><p>Indicates to web crawlers that the page should not be indexed of this note by:</p><ul><li>Setting the <code>X-Robots-Tag: noindex</code> HTTP header.</li><li>Setting the <code>noindex, follow</code> meta tag.</li></ul></td></tr><tr><td><code>#shareCredentials</code></td><td>require credentials to access this shared note. Value is expected to be in format <code>username:password</code>. Don't forget to make this inheritable to apply to child-notes/images.</td></tr><tr><td><code>#shareIndex</code></td><td>Note with this label will list all roots of shared notes.</td></tr><tr><td><code>#shareHtmlLocation</code></td><td>defines where custom HTML injected via <code>~shareHtml</code> relation should be placed. Applied to the HTML snippet note itself. Format: <code>location:position</code> where location is <code>head</code>, <code>body</code>, or <code>content</code> and position is <code>start</code> or <code>end</code>. Defaults to <code>content:end</code>.</td></tr></tbody></table></figure><h3>Customizing logo</h3><p>It's possible to adjust the logo which is displayed above the navigation tree (in the header, on a narrow screen).</p><figure class=\"table\"><table><thead><tr><th>Attribute</th><th>Description</th></tr></thead><tbody><tr><td><code>~shareLogo</code></td><td>Relation set to an image to use as logo. The image must be part of the share tree (it can be hidden if needed). Without it, the logo is the icon of the shared root note.</td></tr><tr><td><code>#shareLogoWidth</code></td><td>The width of the logo, as a number without unit. With <code>#shareLogoHeight</code>, it sets the proportions of the logo, which is shown 32 pixels wide. Default is <code>53</code>.</td></tr><tr><td><code>#shareLogoHeight</code></td><td>The height of the logo, as a number without unit. With <code>#shareLogoWidth</code>, it sets the proportions of the logo. Default is <code>40</code>.</td></tr><tr><td><code>#shareRootLink</code></td><td>URL to navigate to when the logo is pressed.</td></tr></tbody></table></figure><h3>Customizing OpenGraph</h3><p>A meta-property is left out of the page when its attribute is not set. Without an image, link previews use a small card.</p><figure class=\"table\"><table><thead><tr><th>Attribute</th><th>Description</th></tr></thead><tbody><tr><td><code>#shareOpenGraphColor</code></td><td>This adjusts the <code>theme-color</code> meta-property.</td></tr><tr><td><code>#shareOpenGraphURL</code></td><td>This adjusts the <code>og:url</code> and <code>twitter:url</code> meta-properties. It is also the address a relative <code>og:image</code> is completed with, so it should be the public address of the shared site, such as <code>https://example.com/share/</code>.</td></tr><tr><td><code>#shareOpenGraphDomain</code></td><td>Adjusts the <code>twitter:domain</code> meta-property.</td></tr><tr><td><code>#shareOpenGraphImage</code>&nbsp; <br><code>~shareOpenGraphImage</code></td><td>Can be either a label with the address of an image, or a relation to an image&nbsp;<a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a>. This controls the <code>og:image</code> meta-property. Sites that show a preview of the link load the image from their own servers, so a relative address, which the relation always gives, is completed with <code>#shareOpenGraphURL</code>; without it, the image does not show in such previews.</td></tr></tbody></table></figure><h2>Credits</h2><p>Since v0.95.0, a new theme was introduced (and enabled by default) which greatly improves the visual aspect of the Share feature, as well as its functionality (such as mobile support, dark/light mode, collapsible tree, etc.). This theme is an adaptation of the <a href=\"https://github.com/zerebos/trilium.rocks\">Trilium Rocks!</a> by <a href=\"https://github.com/zerebos\">zerebos</a>.</p>",
++ "_help_Qjt68inQ2bRj": "<p>When accessing a shared note, Trilium will render it as a web page. Sometimes it's desirable to serve the content directly so that it can be used in a script or downloaded by the user.</p><figure class=\"table\"><table><thead><tr><th>A note displayed as a web page (HTML)</th><th>A note displayed as a raw format</th></tr></thead><tbody><tr><td><figure class=\"image\"><img style=\"aspect-ratio:738/275;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Sharing/Serving%20directly%20the%20content%20of%20a%20note_image.png\" width=\"738\" height=\"275\"></figure></td><td><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Sharing/Serving%20directly%20the%20content%20of%20a%20note_image.jpg\"></td></tr></tbody></table></figure><h2>By adding an attribute to the note</h2><p>Simply add the <code>#shareRaw</code> attribute and the note will always be rendered <em>raw</em> when accessed from the share URL.</p><h2>By altering the URL</h2><p>Append <code>?raw</code> to the URL to display a note in its raw format regardless of whether the <code>#shareRaw</code> attribute is added on the note.</p><p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Sharing/Serving%20directly%20the%20content%20of%20a%20note_image.jpg\"></p>",
++ "_help_ycBFjKrrwE9p": "<p>As described in&nbsp;<a class=\"reference-link\" href=\"#root/_help_R9pX4DGra2Vt\">Sharing</a>, Trilium can act as a public server in which the shared notes are displayed in read-only mode. While this can work in most cases, it's generally not meant for high-traffic websites and since it's running on a Node.js server it can be potentially exploited.</p><p>Another alternative is to generate static HTML files (just like other static site generators such as <a href=\"https://www.mkdocs.org/\">MkDocs</a>). Since the normal HTML ZIP export does not contain any styling or additional functionality, Trilium provides a way to export the same layout and style as the&nbsp;<a class=\"reference-link\" href=\"#root/_help_R9pX4DGra2Vt\">Sharing</a>&nbsp;function into static HTML files.</p><p>Apart from the enhanced security, these HTML files are also easy to deploy on “serverless” deployments such as GitHub Pages or CloudFlare Pages and cache very easily.</p><aside class=\"admonition tip\"><p>Trilium's documentation, available at <a href=\"https://docs.triliumnotes.org/\">docs.triliumnotes.org</a> is built using this function of exporting to static HTML files which are then deployed automatically to CloudFlare Pages.</p><p>The process is <a href=\"https://github.com/TriliumNext/Trilium/blob/main/apps/edit-docs/src/build-docs.ts\">automated</a> by importing the Markdown documentation and exporting it via a script to the static web format.</p></aside><h2>Differences from normal sharing</h2><p>Apart from normal&nbsp;<a class=\"reference-link\" href=\"#root/_help_R9pX4DGra2Vt\">Sharing</a>, exporting to static HTML files comes with a few subtle differences:</p><ul><li>The URL structure is different. Where in normal sharing it's something along the way of <code>example.com/share/noteid</code>, the notes follow an hierarchical structure, such as <code>docs.triliumnotes.org/user-guide/concepts/navigation/tree-concepts</code>.</li><li>The <code>favicon.ico</code> is not handled automatically, it needs to be manually added on the server after the export is generated.</li><li>The “Last updated” for notes is not available.</li><li>The search functionality works slightly different since the normal one requires an active API to work. In the static export, search still works but uses a different mechanism so results might be different.</li></ul><h2>Differences from normal .zip export</h2><ul><li>The name of the files/URLs will prefer <code>shareAlias</code> to allow for clean URLs.</li><li>The export requires a functional web server as the pages will not render properly if accessed locally via a web browser due to the use of module scripts.</li><li>The directory structure is also slightly different:<ul><li>A normal HTML export results in an index file and a single directory.</li><li>Instead, for static exporting the top-root level becomes the index file and the child directories are on the root instead.</li><li>This makes it possible to easily publish to a website, without forcing everything but the root note to be in a sub-directory.</li></ul></li></ul><h2>Testing locally</h2><p>As mentioned previously, the exported static pages require a website to function. In order to test locally, a web server needs to be used.</p><p>One example is to use the Node.js-based <a href=\"https://www.npmjs.com/package/http-server\"><code>http-server</code></a> which can be installed via:</p><pre><code class=\"language-text-x-trilium-auto\">npm i -g http-server</code></pre><p>Once installed simply:</p><ol><li>Extract the exported .zip file.</li><li>Inside the extracted directory, run <code>http-server</code>.</li><li>Access the indicated address (e.g. <a href=\"http://localhost:8080\">http://localhost:8080</a>).</li></ol><h2>Automation</h2><p><a class=\"reference-link\" href=\"#root/_help_pgxEVkzLl1OP\">ETAPI (REST API)</a>&nbsp;could potentially be used to automate an export on a scheduled task.</p>",
++ "_help_sLIJ6f1dkJYW": "<p>It might be desirable to only expose the share functionality of Trilium to the Internet, and keep the application accessible only within a local network or via VPN.</p><p>To do so, a reverse proxy is required.</p><h2>Caddy</h2><pre><code class=\"language-text-x-trilium-auto\">http://domain.com {\n reverse_proxy /share http://localhost:8080/share\n}</code></pre><p>This is for newer versions where the share functionality is isolated, for older versions it's required to also include <code>/assets</code>.<a href=\"#fn2b8mg20aol8\"><sup>[1]</sup></a></p><ol><li><p><a href=\"#fnref2b8mg20aol8\"><strong><sup>^</sup></strong></a></p><p><a href=\"https://github.com/orgs/TriliumNext/discussions/7341#discussioncomment-14679897\">https://github.com/orgs/TriliumNext/discussions/7341#discussioncomment-14679897</a></p></li></ol>",
++ "_help_Ad7Ku5gOHrDU": "<aside class=\"admonition note\"><p>This topic of creating share templates is considered advanced and requires JavaScript/EJS knowledge.</p><p>The default share template should cover most normal uses.</p></aside><p>For full control over the HTML structure of a shared page — beyond what custom CSS, JS, or HTML snippets allow — you can replace the page template entirely using the <code>~shareTemplate</code> relation.</p><p>To do so:</p><ol><li>Create a&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note with the language <em>Embedded JavaScript</em> (EJS).</li><li>For a shared note to apply the newly created template, apply the <code>~shareTemplate</code> relation pointing to the note created at step (1). Make use of&nbsp;<a class=\"reference-link\" href=\"#root/_help_bwZpz2ajCEwO\">Attribute Inheritance</a>&nbsp;to apply it to multiple shared notes.</li></ol><p>There are two important constraints to be aware of:</p><ul><li>Because EJS templates execute arbitrary server-side JavaScript, <code>~shareTemplate</code> only takes effect when backend scripting is enabled. If it is disabled (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_fiHicjpHjIRJ\">Security</a>), the relation is ignored and the default template is used. For the same reason, <strong>only apply templates from notes you trust</strong>.</li><li>The template note must be part of the shared subtree (just like <code>~shareCss</code>, <code>~shareJs</code>) in order for it to be loaded. To prevent it from being shown in the navigation, apply <code>#shareHiddenFromTree</code> to it.</li></ul><h2>Content of the share template</h2><p>Use the <a href=\"https://github.com/TriliumNext/Notes/blob/develop/packages/share-theme/src/templates/page.ejs\">original template</a> as reference when creating a new share template.</p><h2>Available variables</h2><p>Your template is rendered with a context object exposing the note and its rendering environment. The most useful values are:</p><figure class=\"table\"><table><thead><tr><th>Variable</th><th>Description</th></tr></thead><tbody><tr><td><code>note</code></td><td>The note being rendered. Use it to read attributes (<code>note.getLabelValue(...)</code>), <code>note.title</code>, child notes, etc.</td></tr><tr><td><code>content</code></td><td>The note's already-rendered HTML content, as a string.</td></tr><tr><td><code>header</code></td><td>Extra HTML to place in the document head for this note (used by some note types).</td></tr><tr><td><code>isEmpty</code></td><td><code>true</code> when the note has no content of its own.</td></tr><tr><td><code>head</code></td><td>The values of the page's <code>&lt;head&gt;</code>: <code>title</code> (the note's title, followed by the site's), <code>description</code> (<code>#shareDescription</code>), <code>noIndex</code> (<code>#shareDisallowRobotIndexing</code>) and <code>openGraph</code> with <code>url</code>, <code>domain</code>, <code>image</code>, <code>color</code> and <code>card</code> (<code>summary_large_image</code> with an image, <code>summary</code> without). A value whose label is not set is <code>null</code>. <code>metaTags</code> lists the description, OpenGraph and Twitter <code>&lt;meta&gt;</code> tags of the values that are set, each with <code>attribute</code> (<code>name</code> or <code>property</code>), <code>key</code> and <code>content</code>.</td></tr><tr><td><code>logo</code></td><td>The site logo above the navigation tree and, on a narrow screen, in the header: <code>href</code> (<code>#shareRootLink</code>, otherwise the site's root page), <code>image</code> (the <code>~shareLogo</code> image, or <code>null</code>), <code>icon</code> (the icon classes of the site's root note, shown when there is no <code>image</code>), and <code>width</code> and <code>height</code> for the image.</td></tr><tr><td><code>navigation</code></td><td>The navigation tree of the site: its visible pages, each with <code>title</code>, <code>href</code>, <code>isExternal</code>, <code>type</code>, <code>icon</code>, <code>isActive</code> (the page being shown), <code>isExpanded</code> (that page or one of its ancestors) and <code>children</code>.</td></tr><tr><td><code>contentClasses</code></td><td>The classes of the content element: <code>type-&lt;note type&gt;</code>, <code>ck-content</code> for text and Markdown notes, <code>full-height</code> for a note that takes the whole page (such as a PDF, a web view, a calendar, a geo map or an image), and <code>no-content</code> when the note has no content of its own.</td></tr><tr><td><code>childLinks</code></td><td>The links to the note's visible children, each with <code>title</code>, <code>href</code>, <code>isExternal</code>, <code>type</code>, <code>icon</code> (its icon classes), <code>excerpt</code> (its <code>#shareDescription</code> or the start of its text, with a line break between paragraphs, or <code>null</code>) and <code>children</code> (when it has no excerpt, its first ten visible children, each with <code>title</code>, <code>href</code>, <code>isExternal</code> and <code>icon</code>). Empty for a note that is not a collection, a text note or a code note, for a note that takes the whole page, and with <code>#hideChildrenOverview</code>.</td></tr><tr><td><code>childLinksLayout</code></td><td>How the default template lays <code>childLinks</code> out: <code>list</code> for a collection whose view type is list, <code>grid</code> otherwise.</td></tr><tr><td><code>prevNext</code></td><td>The pages before and after the note in the navigation tree, as <code>previous</code> and <code>next</code>, each with <code>title</code> and <code>href</code>, or <code>null</code>. Both <code>null</code> for a note that takes the whole page.</td></tr><tr><td><code>language</code></td><td>The languages of the page: <code>page</code> with the <code>lang</code> and <code>dir</code> of the application's language, and <code>content</code> with those of the note's content language, or <code>null</code> when they are the same.</td></tr><tr><td><code>lastUpdated</code></td><td>When the note was last changed, as <code>iso</code> for a <code>&lt;time&gt;</code> element and as <code>text</code> in the application's language, or <code>null</code>, which it also is for a note that takes the whole page.</td></tr><tr><td><code>showTitle</code></td><td>Whether the default template shows the note's title above the content. Always <code>true</code>.</td></tr><tr><td><code>titleIcon</code></td><td>The icon classes of the note, which the default template shows beside the title in a row of its own for a note that takes the whole page; <code>null</code> for any other note.</td></tr><tr><td><code>snippets</code></td><td>The HTML of the <code>~shareHtml</code> snippets for each location, such as <code>snippets[\"head:end\"]</code>. Every location is present, empty when no snippet goes there.</td></tr><tr><td><code>subRoot</code></td><td>The root of the shared subtree as <code>{ note, branch }</code> — handy for a site-wide title or logo.</td></tr><tr><td><code>cssToLoad</code> / <code>jsToLoad</code></td><td>Arrays of stylesheet / script URLs the default theme would inject (includes anything added via <code>~shareCss</code> / <code>~shareJs</code>).</td></tr><tr><td><code>faviconUrl</code> / <code>logoUrl</code></td><td>Resolved favicon and logo URLs. Without <code>~shareLogo</code>, <code>logoUrl</code> is the Trilium logo.</td></tr><tr><td><code>fontPreloads</code></td><td>The icon fonts to preload, each with <code>href</code> and <code>type</code> (the font's media type): Boxicons, and the icon packs used by the logo, the navigation tree or the subpages. The default template adds a <code>&lt;link rel=\"preload\" as=\"font\" crossorigin&gt;</code> for each, so that the icons do not appear only after the first paint.</td></tr><tr><td><code>isStatic</code></td><td><code>true</code> during a static HTML export, <code>false</code> for a live server render.</td></tr><tr><td><code>t</code></td><td>The <code>i18next</code> translation function.</td></tr><tr><td><code>utils</code></td><td>Helper utilities such as <code>slugify()</code> and <code>stripTags()</code>.</td></tr></tbody></table></figure><h2>Error handling</h2><p>If your template throws an error while rendering, Trilium logs the error and quietly falls back to the default template, so a broken template never takes the shared page down.</p><h2>Splitting a template into partials</h2><p>A template can pull in other EJS notes as partials. Create them as <strong>child notes</strong> of the template note (each also a <code>code</code> / <code>application/x-ejs</code> note) and reference them by title:</p><pre><code class=\"language-text-x-trilium-auto\">&lt;%- include(\"header\") %&gt;\n\n&lt;main&gt;\n &lt;h1&gt;&lt;%= note.title %&gt;&lt;/h1&gt;\n &lt;%- content %&gt;\n&lt;/main&gt;\n\n&lt;%- include(\"footer\") %&gt;\n</code></pre><p>Here <code>header</code> and <code>footer</code> are the titles of child notes of the template. Only direct children are resolvable, and they must be EJS code notes.</p>",
+ "_help_5668rwcirq1t": "<p>Trilium offers advanced functionality through <a href=\"#root/_help_CdNpE2pqjmI6\">Scripts</a> and <a href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>. To illustrate these features, we've prepared several showcases available in the <a href=\"#root/_help_wX4HbRucYSDD\">demo notes</a>:</p><ul><li><a href=\"#root/_help_iRwzGnHPzonm\">Relation Map</a></li><li><a href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a></li><li><a href=\"#root/_help_R7abl2fc6Mxi\">Weight Tracker</a></li><li><a href=\"#root/_help_xYjQUYhpbUEW\">Task Manager</a></li></ul><p>It's important to note that these examples are not natively supported by Trilium out of the box; instead, they demonstrate what you can build within Trilium.</p>",
- "_help_l0tKav7yLHGF": "<p>A common pattern in note-taking is that a lot of notes will be centered around a certain date - e.g. you have some tasks which needs to be done on a certain date, you have meeting minutes from a certain date, you have your thoughts etc. and it all revolves around a date on which they occurred. For this reason, it makes sense to create a certain \"day workspace\" which will centralize all those notes relevant for a certain date.</p><p>For this, Trilium provides a concept of \"day note\". Trilium semi-automatically generates a single note for each day. Under this note you can save all those relevant notes.</p><p>Select an existing day note, and the menubar contains a calendar widget. Select any day to create a note for that day.&nbsp;</p><p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Advanced%20Showcases/Day%20Notes_image.jpg\"></p><p>This pattern works well also because of <a href=\"#root/_help_IakOLONlIfGI\">Cloning Notes</a> functionality - note can appear in multiple places in the note tree, so besides appearing under day note, it can also be categorized into other notes.</p><h2>Demo</h2><p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Advanced%20Showcases/Day%20Notes_image.png\"></p><p>You can see the structure of day notes appearing under \"Journal\" note - there's a note for the whole year 2025, under it, you have \"03 - March\" which then contains \"09 - Monday\". This is our \"day note\" which contains some text in its content and also has some child notes (some of them are from <a href=\"#root/_help_xYjQUYhpbUEW\">Task manager</a>).</p><p>You can also notice how this day note has <a href=\"#root/_help_OFXdgB2nNk1F\">promoted attribute</a> \"weight\" where you can track your daily weight. This data is then used in <a href=\"#root/_help_R7abl2fc6Mxi\">Weight tracker</a>.</p><h2>Week Note and Quarter Note</h2><p>Week and quarter notes are disabled by default, since it might be too much for some people. To enable them, you need to set <code spellcheck=\"false\">#enableWeekNote</code> and <code spellcheck=\"false\">#enableQuarterNote</code> attributes on the root calendar note, which is identified by <code spellcheck=\"false\">#calendarRoot</code> label. Week note is affected by the first week of year option. Be careful when you already have some week notes created, it will not automatically change the existing week notes and might lead to some duplicates.</p><h2>Templates</h2><p>Trilium provides <a href=\"#root/_help_KC1HB96bqqHX\">template</a> functionality, and it could be used together with day notes.</p><p>You can define one of the following relations on the root of the journal (identified by <code spellcheck=\"false\">#calendarRoot</code> label):</p><ul><li>yearTemplate</li><li>quarterTemplate (if <code spellcheck=\"false\">#enableQuarterNote</code> is set)</li><li>monthTemplate</li><li>weekTemplate (if <code spellcheck=\"false\">#enableWeekNote</code> is set)</li><li>dateTemplate</li></ul><p>All of these are relations. When Trilium creates a new note for year or month or date, it will take a look at the root and attach a corresponding <code spellcheck=\"false\">~template</code> relation to the newly created role. Using this, you can e.g. create your daily template with e.g. checkboxes for daily routine etc.</p><h3>Migrate from old template usage</h3><p>If you have been using Journal prior to version v0.93.0, the previous template pattern likely used was <code spellcheck=\"false\">~child:template=</code>.<br>To transition to the new system:</p><ol><li>Set up the new template pattern in the Calendar root note.</li><li>Use <a href=\"#root/_help_ivYnonVFBxbQ\">Bulk Actions</a> to remove <code spellcheck=\"false\">child:template</code> and <code spellcheck=\"false\">child:child:template</code> from all notes under the Journal (calendar root).</li><li>Ensure that all old template patterns are fully removed to prevent conflicts with the new setup.</li></ol><h2>Naming pattern</h2><p>You can customize the title of generated journal notes by defining a <code spellcheck=\"false\">#datePattern</code>, <code spellcheck=\"false\">#weekPattern</code>, <code spellcheck=\"false\">#monthPattern</code>, <code spellcheck=\"false\">#quarterPattern</code> and <code spellcheck=\"false\">#yearPattern</code> attribute on a root calendar note (identified by <code spellcheck=\"false\">#calendarRoot</code> label). The naming pattern replacements follow a level-up compatibility - each level can use replacements from itself and all levels above it. For example, <code spellcheck=\"false\">#monthPattern</code> can use month, quarter and year replacements, while <code spellcheck=\"false\">#weekPattern</code> can use week, month, quarter and year replacements. But it is not possible to use week replacements in <code spellcheck=\"false\">#monthPattern</code>.</p><h3>Date pattern</h3><p>It's possible to customize the title of generated date notes by defining a <code spellcheck=\"false\">#datePattern</code> attribute on a root calendar note (identified by <code spellcheck=\"false\">#calendarRoot</code> label). Following are possible values:</p><ul><li><code spellcheck=\"false\">{isoDate}</code> results in an ISO 8061 formatted date (e.g. \"2025-03-09\" for March 9, 2025)</li><li><code spellcheck=\"false\">{dateNumber}</code> results in a number like <code spellcheck=\"false\">9</code> for the 9th day of the month, <code spellcheck=\"false\">11</code> for the 11th day of the month</li><li><code spellcheck=\"false\">{dateNumberPadded}</code> results in a number like <code spellcheck=\"false\">09</code> for the 9th day of the month, <code spellcheck=\"false\">11</code> for the 11th day of the month</li><li><code spellcheck=\"false\">{ordinal}</code> is replaced with the ordinal date (e.g. 1st, 2nd, 3rd) etc.</li><li><code spellcheck=\"false\">{weekDay}</code> results in the full day name (e.g. <code spellcheck=\"false\">Monday</code>)</li><li><code spellcheck=\"false\">{weekDay3}</code> is replaced with the first 3 letters of the day, e.g. Mon, Tue, etc.</li><li><code spellcheck=\"false\">{weekDay2}</code> is replaced with the first 2 letters of the day, e.g. Mo, Tu, etc.</li></ul><p>The default is <code spellcheck=\"false\">{dateNumberPadded} - {weekDay}</code></p><h3>Week pattern</h3><p>It is also possible to customize the title of generated week notes through the <code spellcheck=\"false\">#weekPattern</code> attribute on the root calendar note. The options are:</p><ul><li><code spellcheck=\"false\">{weekNumber}</code> results in a number like <code spellcheck=\"false\">9</code> for the 9th week of the year, <code spellcheck=\"false\">11</code> for the 11th week of the year</li><li><code spellcheck=\"false\">{weekNumberPadded}</code> results in a number like <code spellcheck=\"false\">09</code> for the 9th week of the year, <code spellcheck=\"false\">11</code> for the 11th week of the year</li><li><code spellcheck=\"false\">{shortWeek}</code> results in a short week string like <code spellcheck=\"false\">W9</code> for the 9th week of the year, <code spellcheck=\"false\">W11</code> for the 11th week of the year</li><li><code spellcheck=\"false\">{shortWeek3}</code> results in a short week string like <code spellcheck=\"false\">W09</code> for the 9th week of the year, <code spellcheck=\"false\">W11</code> for the 11th week of the year</li></ul><p>The default is <code spellcheck=\"false\">Week {weekNumber}</code></p><h3>Month pattern</h3><p>It is also possible to customize the title of generated month notes through the <code spellcheck=\"false\">#monthPattern</code> attribute on the root calendar note. The options are:</p><ul><li><code spellcheck=\"false\">{isoMonth}</code> results in an ISO 8061 formatted month (e.g. \"2025-03\" for March 2025)</li><li><code spellcheck=\"false\">{monthNumber}</code> results in a number like <code spellcheck=\"false\">9</code> for September, and <code spellcheck=\"false\">11</code> for November</li><li><code spellcheck=\"false\">{monthNumberPadded}</code> results in a number like <code spellcheck=\"false\">09</code> for September, and <code spellcheck=\"false\">11</code> for November</li><li><code spellcheck=\"false\">{month}</code> results in the full month name (e.g. <code spellcheck=\"false\">September</code> or <code spellcheck=\"false\">October</code>)</li><li><code spellcheck=\"false\">{shortMonth3}</code> is replaced with the first 3 letters of the month, e.g. Jan, Feb, etc.</li><li><code spellcheck=\"false\">{shortMonth4}</code> is replaced with the first 4 letters of the month, e.g. Sept, Octo, etc.</li></ul><p>The default is <code spellcheck=\"false\">{monthNumberPadded} - {month}</code></p><h3>Quarter pattern</h3><p>It is also possible to customize the title of generated quarter notes through the <code spellcheck=\"false\">#quarterPattern</code> attribute on the root calendar note. The options are:</p><ul><li><code spellcheck=\"false\">{quarterNumber}</code> results in a number like <code spellcheck=\"false\">1</code> for the 1st quarter of the year</li><li><code spellcheck=\"false\">{shortQuarter}</code> results in a short quarter string like <code spellcheck=\"false\">Q1</code> for the 1st quarter of the year</li></ul><p>The default is <code spellcheck=\"false\">Quarter {quarterNumber}</code></p><h3>Year pattern</h3><p>It is also possible to customize the title of generated year notes through the <code spellcheck=\"false\">#yearPattern</code> attribute on the root calendar note. The options are:</p><ul><li><code spellcheck=\"false\">{year}</code> results in the full year (e.g. <code spellcheck=\"false\">2025</code>)</li></ul><p>The default is <code spellcheck=\"false\">{year}</code></p><h2>Implementation</h2><p>Trilium has some special support for day notes in the form of <a href=\"https://triliumnext.github.io/Notes/backend_api/BackendScriptApi.html\">backend Script API</a> - see e.g. getDayNote() function.</p><p>Day (and year, month) notes are created with a label - e.g. <code spellcheck=\"false\">#dateNote=\"2025-03-09\"</code> this can then be used by other scripts to add new notes to day note etc.</p>",
- "_help_R7abl2fc6Mxi": "<p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Advanced%20Showcases/Weight%20Tracker_image.jpg\"></p><p>The <code spellcheck=\"false\">Weight Tracker</code> is a <a href=\"#root/_help_GLks18SNjxmC\">Script API</a> showcase present in the <a href=\"#root/_help_wX4HbRucYSDD\">demo notes</a>.</p><p>By adding <code spellcheck=\"false\">weight</code> as a <a href=\"#root/_help_OFXdgB2nNk1F\">promoted attribute</a> in the <a href=\"#root/_help_KC1HB96bqqHX\">template</a> from which <a href=\"#root/_help_l0tKav7yLHGF\">day notes</a> are created, you can aggregate the data and plot weight change over time.</p><h2>Implementation</h2><p>The <code spellcheck=\"false\">Weight Tracker</code> note in the screenshot above is of the type <code spellcheck=\"false\">Render Note</code>. That type of note doesn't have any useful content itself. Instead it is a placeholder where a <a href=\"#root/_help_CdNpE2pqjmI6\">script</a> can render its output.</p><p>Scripts for <code spellcheck=\"false\">Render Notes</code> are defined in a <a href=\"#root/_help_zEY4DaJG4YT5\">relation</a> called <code spellcheck=\"false\">~renderNote</code>. In this example, it's the <code spellcheck=\"false\">Weight Tracker</code>'s child <code spellcheck=\"false\">Implementation</code>. The Implementation consists of two <a href=\"#root/_help_6f9hih2hXXZk\">code notes</a> that contain some HTML and JavaScript respectively, which load all the notes with a <code spellcheck=\"false\">weight</code> attribute and display their values in a chart.</p><p>To actually render the chart, we're using a third party library called <a href=\"https://www.chartjs.org/\">chart.js</a>which is imported as an attachment, since it's not built into Trilium.</p><h3>Code</h3><p>Here's the content of the script which is placed in a <a href=\"#root/_help_6f9hih2hXXZk\">code note</a> of type <code spellcheck=\"false\">JS Frontend</code>:</p><pre><code class=\"language-text-x-trilium-auto\">async function getChartData() {\n const days = await api.runOnBackend(async () =&gt; {\n const notes = api.getNotesWithLabel('weight');\n const days = [];\n\n for (const note of notes) {\n const date = note.getLabelValue('dateNote');\n const weight = parseFloat(note.getLabelValue('weight'));\n\n if (date &amp;&amp; weight) {\n days.push({ date, weight });\n }\n }\n\n days.sort((a, b) =&gt; a.date &gt; b.date ? 1 : -1);\n\n return days;\n });\n\n const datasets = [\n {\n label: \"Weight (kg)\",\n backgroundColor: 'red',\n borderColor: 'red',\n data: days.map(day =&gt; day.weight),\n fill: false,\n spanGaps: true,\n datalabels: {\n display: false\n }\n }\n ];\n\n return {\n datasets: datasets,\n labels: days.map(day =&gt; day.date)\n };\n}\n\nconst ctx = $(\"#canvas\")[0].getContext(\"2d\");\n\nnew chartjs.Chart(ctx, {\n type: 'line',\n data: await getChartData()\n});</code></pre><h2>How to remove the Weight Tracker button from the top bar</h2><p>In the link map of the <code spellcheck=\"false\">Weight Tracker</code>, there is a note called <code spellcheck=\"false\">Button</code>. Open it and delete or comment out its contents. The <code spellcheck=\"false\">Weight Tracker</code> button will disappear after you restart Trilium.</p>",
- "_help_xYjQUYhpbUEW": "<p>Task Manager is a <a href=\"#root/_help_OFXdgB2nNk1F\">promoted attributes</a> and <a href=\"#root/_help_CdNpE2pqjmI6\">scripts</a>showcase present in the <a href=\"#root/_help_wX4HbRucYSDD\">demo notes</a>.</p><h2>Demo</h2><p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Advanced%20Showcases/Task%20Manager_task-manager.png\"></p><p>Task Manager manages outstanding (TODO) tasks and finished tasks (non-empty doneDate attribute). Outstanding tasks are further categorized by location and arbitrary tags - whenever you change tag attribute in the task note, this task is then automatically moved to appropriate location.</p><p>Task Manager also integrates with <a href=\"#root/_help_l0tKav7yLHGF\">day notes</a> - notes are <a href=\"#root/_help_IakOLONlIfGI\">cloned</a> into day note to both todoDate note and doneDate note (with <a href=\"#root/_help_kBrnXNG3Hplm\">prefix</a> of either \"TODO\" or \"DONE\").</p><h2>Implementation</h2><p>New tasks are created in the TODO note which has <code spellcheck=\"false\">~child:template</code> <a href=\"#root/_help_zEY4DaJG4YT5\">relation</a>(see <a href=\"#root/_help_bwZpz2ajCEwO\">attribute inheritance</a>) pointing to the task template.</p><h3>Attributes</h3><p>Task template defines several <a href=\"#root/_help_OFXdgB2nNk1F\">promoted attributes</a> - todoDate, doneDate, tags, location. Importantly it also defines <code spellcheck=\"false\">~runOnAttributeChange</code> relation - <a href=\"#root/_help_GPERMystNGTB\">event</a> handler which is run on attribute change. This <a href=\"#root/_help_CdNpE2pqjmI6\">script</a> handles when e.g. we fill out the doneDate attribute - meaning the task is done and should be moved to \"Done\" note and removed from TODO, locations and tags.</p><h3>New task button</h3><p>There's also \"button\" note which contains simple script which adds a button to create new note (task) in the TODO note.</p><pre><code class=\"language-text-x-trilium-auto\">api.addButtonToToolbar({\n title: 'New task',\n icon: 'check',\n shortcut: 'alt+n',\n action: async () =&gt; {\n // creating notes is backend (server) responsibility so we need to pass\n // the control there\n const taskNoteId = await api.runOnBackend(async () =&gt; {\n const todoRootNote = await api.getNoteWithLabel('taskTodoRoot');\n const {note} = await api.createNote(todoRootNote.noteId, 'new task', '');\n\n return note.noteId;\n });\n\n // we got an ID of newly created note and we want to immediatelly display it\n await api.activateNewNote(taskNoteId);\n }\n});</code></pre><h3>CSS</h3><p>In the demo screenshot above you may notice that TODO tasks are in red color and DONE tasks are green.</p><p>This is done by having this CSS <a href=\"#root/_help_6f9hih2hXXZk\">code note</a> which defines extra CSS classes:</p><pre><code class=\"language-text-x-trilium-auto\">span.fancytree-node.todo .fancytree-title {\n color: red !important;\n}\n\nspan.fancytree-node.done .fancytree-title {\n color: green !important;\n}</code></pre><p>This <a href=\"#root/_help_6f9hih2hXXZk\">code note</a> has <code spellcheck=\"false\">#appCss</code> <a href=\"#root/_help_zEY4DaJG4YT5\">label</a>which is recognized by Trilium on startup and loaded as CSS into the application.</p><p>Second part of this functionality is based in event handler described above which assigns <code spellcheck=\"false\">#cssClass</code> label to the task to either \"done\" or \"todo\" based on the task status.</p>",
- "_help_i16PM6A7GXdU": "<p>Trilium features customizable to-do list task states. To customize them, go to <strong>\"Options\"</strong> → <strong>\"Text Notes\"</strong> → <strong>\"Related Settings\"</strong> → <strong>\"Custom checkbox states for to-do lists\"</strong>. Alternatively, right-click a checkbox in an editable text note and click the pencil icon.</p><aside class=\"admonition warning\"><p>Changes take effect only after restarting the application.</p></aside><h2>Creating a new task state</h2><p>Click the plus icon next to Task States in the left-side pane, then define the task details as described in the next section.</p><h2>Editing a task state</h2><p>Selecting any state other than \"None\" and \"Done\" (which cannot be modified) from the side pane reveals the following editable fields:</p><ul><li><strong>Icon</strong> (required): The symbol shown inside the checkbox. You can pick an icon just as you would for any regular note, including from custom icon packs.</li><li><strong>Title</strong> (required): The name of the task state shown in the UI. For example: \"Doing\", \"Postponed\".</li><li><strong>Identifier</strong> (required): A short name for the state, using only letters, digits, \"<code spellcheck=\"false\">-</code>\" and \"<code spellcheck=\"false\">_</code>\". It is stored as metadata in the note's markup and used to identify the task state. Two task states cannot share the same identifier.<br>Prefix the identifiers of your custom task states with an underscore \"<code spellcheck=\"false\">_</code>\" or a hyphen \"<code spellcheck=\"false\">-</code>\" to avoid clashes with task states that may be introduced in future versions of Trilium.</li><li><strong>Markdown symbol</strong>: A single character used to represent the state in Markdown syntax. For example, \"<code spellcheck=\"false\">#</code>\" creates a task state that can be applied in Markdown using \" <code spellcheck=\"false\">- [#]</code> \". Make sure no other task state uses the same symbol.</li><li><strong>Counts as completed</strong>: If checked, the task is treated as completed.</li><li><strong>Color</strong>: The color of the checkbox. Its lightness and saturation are adjusted automatically to match the current color scheme or theme.</li><li><strong>Hidden from toolbar</strong>: The state is not listed in the UI. This is useful when you want existing notes to keep rendering the state correctly but no longer need to apply it yourself.</li></ul><aside class=\"admonition note\"><p>The task definition details are validated at startup. If errors are found, a toast provides the details and the affected task definition is ignored.</p></aside><h2>Reordering task states</h2><p>To change the order in which task states appear in the UI and when cycling through them with the keyboard, simply reorder the states in the side pane (or tree panel, if it's the case).</p><h2>Deleting task states</h2><p>Any task state other than \"None\" and \"Done\" can be deleted.</p><p>Once deleted, to-do items using that state will no longer display the custom checkbox. They fall back to either a \"None\" or \"Done\" state, depending on the state's \"Counts as completed\" setting. The identifier and title remain stored in the note until you set the checkbox to a new state.</p><h2>Transferring notes with custom task states between Trilium database instances</h2><p>Exporting notes to another Trilium database instance preserves the task states of to-do items, but does not include the custom task definitions. As a result, the destination instance won't know how to render the checkbox unless you recreate the task state there with the same identifier and Markdown symbol.</p><aside class=\"admonition note\"><p>This is a known limitation of the current version. If there is enough interest in the community for transferring notes between Trilium database instances more easily, the Trilium team may consider a better state definition mechanism.</p></aside>",
- "_help_J5Ex1ZrMbyJ6": "<p>Trilium provides a mechanism for <a href=\"#root/_help_CdNpE2pqjmI6\">scripts</a> to open a public REST endpoint. This opens a way for various integrations with other services - a simple example would be creating new note from Slack by issuing a slash command (e.g. <code spellcheck=\"false\">/trilium buy milk</code>).</p><h2>Create note from outside Trilium</h2><p>Let's take a look at an example. The goal is to provide a REST endpoint to which we can send title and content and Trilium will create a note.</p><p>We'll start with creating a JavaScript backend <a href=\"#root/_help_6f9hih2hXXZk\">code note</a> containing:</p><pre><code class=\"language-text-x-trilium-auto\">const {req, res} = api;\nconst {secret, title, content} = req.body;\n\nif (req.method == 'POST' &amp;&amp; secret === 'secret-password') {\n // notes must be saved somewhere in the tree hierarchy specified by a parent note. \n // This is defined by a relation from this code note to the \"target\" parent note\n // alternatively you can just use constant noteId for simplicity (get that from \"Note Info\" dialog of the desired parent note)\n const targetParentNoteId = api.currentNote.getRelationValue('targetNote');\n \n const {note} = api.createTextNote(targetParentNoteId, title, content);\n const notePojo = note.getPojo();\n\n res.status(201).json(notePojo);\n}\nelse {\n res.send(400);\n}</code></pre><p>This script note has also following two attributes:</p><ul><li>label <code spellcheck=\"false\">#customRequestHandler</code> with value <code spellcheck=\"false\">create-note</code></li><li>relation <code spellcheck=\"false\">~targetNote</code> pointing to a note where new notes should be saved</li></ul><h3>Explanation</h3><p>Let's test this by using an HTTP client to send a request:</p><pre><code class=\"language-text-x-trilium-auto\">POST http://your-trilium-server/custom/create-note\nContent-Type: application/json\n\n{\n \"secret\": \"secret-password\",\n \"title\": \"hello\",\n \"content\": \"world\"\n}+++++++++++++++++++++++++++++++++++++++++++++++</code></pre><p>Notice the <code spellcheck=\"false\">/custom</code> part in the request path - Trilium considers any request with this prefix as \"custom\" and tries to find a matching handler by looking at all notes which have <code spellcheck=\"false\">customRequestHandler</code> <a href=\"#root/_help_zEY4DaJG4YT5\">label</a>. Value of this label then contains a regular expression which will match the request path (in our case trivial regex \"create-note\").</p><p>Trilium will then find our code note created above and execute it. <code spellcheck=\"false\">api.req</code>, <code spellcheck=\"false\">api.res</code> are set to <a href=\"https://expressjs.com/en/api.html#req\">request</a> and <a href=\"https://expressjs.com/en/api.html#res\">response</a>objects from which we can get details of the request and also respond.</p><p>In the code note we check the request method and then use trivial authentication - keep in mind that these endpoints are by default totally unauthenticated, and you need to take care of this yourself.</p><p>Once we pass these checks we will just create the desired note using <a href=\"#root/_help_GLks18SNjxmC\">Script API</a>.</p><h2>Custom resource provider</h2><p>Another common use case is that you want to just expose a file note - in such case you create label <code spellcheck=\"false\">customResourceProvider</code> (value is again path regex).</p><p>For more information, see&nbsp;<a href=\"#root/_help_d3fAXQ2diepH\">Custom Resource Providers</a>.</p><h2>Advanced concepts</h2><p><code spellcheck=\"false\">api.req</code> and <code spellcheck=\"false\">api.res</code> are Express.js objects - you can always look into its <a href=\"https://expressjs.com/en/api.html\">documentation</a> for details.</p><h3>Parameters</h3><p>REST request paths often contain parameters in the URL, e.g.:</p><pre><code class=\"language-text-x-trilium-auto\">http://your-trilium-server/custom/notes/123</code></pre><p>The last part is dynamic so the matching of the URL must also be dynamic - for this reason the matching is done with regular expressions. Following <code spellcheck=\"false\">customRequestHandler</code> value would match it:</p><pre><code class=\"language-text-x-trilium-auto\">notes/([0-9]+)</code></pre><p>Additionally, this also defines a matching group with the use of parenthesis which then makes it easier to extract the value. The matched groups are available in <code spellcheck=\"false\">api.pathParams</code>:</p><pre><code class=\"language-text-x-trilium-auto\">const noteId = api.pathParams[0];</code></pre><p>Often you also need query params (as in e.g. <code spellcheck=\"false\">http://your-trilium-server/custom/notes?noteId=123</code>), you can get those with standard express <code spellcheck=\"false\">req.query.noteId</code>.</p>",
- "_help_d3fAXQ2diepH": "<p>A custom resource provider allows any file imported into Trilium (images, fonts, stylesheets) to be publicly accessible via a URL.</p><p>A potential use case for this is to add embed a custom font alongside a theme.</p><h2>Steps for creating a custom resource provider</h2><ol><li>Import a file such as an image or a font into Trilium by drag &amp; drop.</li><li>Select the file and go to the <em>Owned Attributes</em> section.</li><li>Add the label <code spellcheck=\"false\">#customResourceProvider=hello</code>.</li><li>To test if it is working, use a browser to navigate to <code spellcheck=\"false\">&lt;protocol&gt;://&lt;host&gt;/custom/hello</code> (where <code spellcheck=\"false\">&lt;protocol&gt;</code> is either <code spellcheck=\"false\">http</code> or <code spellcheck=\"false\">https</code> based on your setup, and <code spellcheck=\"false\">&lt;host&gt;</code> is the host or IP to your Trilium server instance). If you are running the TriliumNext application without a server, use <code spellcheck=\"false\">http://localhost:37840</code> as the base URL.</li><li>If everything went well, at the previous step the browser should have downloaded the file uploaded in the first step.</li></ol><p>Instead of <code spellcheck=\"false\">hello</code>, the name can be:</p><ul><li>A path, such as <code spellcheck=\"false\">fonts/Roboto.ttf</code>, which would be accessible via <code spellcheck=\"false\">&lt;host&gt;/custom/fonts/Roboto.ttf</code>.</li><li>As a more advanced use case, a regular expression to match multiple routes, such as <code spellcheck=\"false\">hello/.*</code> which will be accessible via <code spellcheck=\"false\">/custom/hello/1</code>, <code spellcheck=\"false\">/custom/hello/2</code>, <code spellcheck=\"false\">/custom/hello/world</code>, etc.</li></ul><h2>Using it in a theme</h2><p>For example, if you have a custom font to be imported by the theme, first upload a font file into Trilium and assign it the <code spellcheck=\"false\">#customResourceProvider=fonts/myfont.ttf</code> attribute.</p><p>Then modify the theme CSS to point to:</p><pre><code class=\"language-text-css\">@font-face {\n\tfont-family: customFont;\n\tsrc: url(\"/custom/fonts/myfont.ttf\");\n}\n\ndiv {\n\tfont-family: customFont;\n}</code></pre>",
- "_help_pgxEVkzLl1OP": "<aside class=\"admonition tip\"><p>For a quick start, consult the&nbsp;<a class=\"reference-link\" href=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/ETAPI%20(REST%20API)/API%20Reference.dat\">API Reference</a>.</p></aside><p>ETAPI is Trilium's public/external REST API. It is available since Trilium v0.50.</p><h2>API clients</h2><p>As an alternative to calling the API directly, there are client libraries to simplify this</p><ul><li><a href=\"https://github.com/Nriver/trilium-py\">trilium-py</a>, you can use Python to communicate with Trilium.</li></ul><h2>Obtaining a token</h2><p>All operations with the REST API have to be authenticated using a token. You can get this token either from Options -&gt; ETAPI or programmatically using the <code spellcheck=\"false\">/auth/login</code> REST call (see the <a href=\"https://github.com/TriliumNext/Trilium/blob/master/src/etapi/etapi.openapi.yaml\">spec</a>).</p><h2>Authentication</h2><h3>Via the <code spellcheck=\"false\">Authorization</code> header</h3><pre><code class=\"language-text-x-trilium-auto\">GET https://myserver.com/etapi/app-info\nAuthorization: ETAPITOKEN</code></pre><p>where <code spellcheck=\"false\">ETAPITOKEN</code> is the token obtained in the previous step.</p><p>For compatibility with various tools, it's also possible to specify the value of the <code spellcheck=\"false\">Authorization</code> header in the format <code spellcheck=\"false\">Bearer ETAPITOKEN</code> (since 0.93.0).</p><h3>Basic authentication</h3><p>Since v0.56 you can also use basic auth format:</p><pre><code class=\"language-text-x-trilium-auto\">GET https://myserver.com/etapi/app-info\nAuthorization: Basic BATOKEN</code></pre><ul><li>Where <code spellcheck=\"false\">BATOKEN = BASE64(username + ':' + password)</code> - this is a standard Basic Auth serialization</li><li>Where <code spellcheck=\"false\">username</code> is \"etapi\"</li><li>And <code spellcheck=\"false\">password</code> is the generated ETAPI token described above.</li></ul><p>Basic Auth is meant to be used with tools which support only basic auth.</p><h2>Interaction using Bash scripts</h2><p>It is possible to write simple Bash scripts to interact with Trilium. As an example, here's how to obtain the HTML content of a note:</p><pre><code class=\"language-text-x-trilium-auto\">#!/usr/bin/env bash\n\n# Configuration\nTOKEN=z1vA4fkGxjOR_ZXLrZeqHEFOv65yV3882iFCRtNIK9k9iWrHliITNSLQ=\nSERVER=http://localhost:8080\n\n# Download a note by ID\nNOTE_ID=\"i6ra4ZshJhgN\"\ncurl \"$SERVER/etapi/notes/$NOTE_ID/content\" -H \"Authorization: $TOKEN\" </code></pre><p>Make sure to replace the values of:</p><ul><li><code spellcheck=\"false\">TOKEN</code> with your ETAPI token.</li><li><code spellcheck=\"false\">SERVER</code> with the correct protocol, host name and port to your Trilium instance.</li><li><code spellcheck=\"false\">NOTE_ID</code> with an existing note ID to download.</li></ul><p>As another example, to obtain a .zip export of a note and place it in a directory called <code spellcheck=\"false\">out</code>, simply replace the last statement in the script with:</p><pre><code class=\"language-text-x-trilium-auto\">curl -H \"Authorization: $TOKEN\" \\\n\t-X GET \"$SERVER/etapi/notes/$NOTE_ID/export\" \\\n --output \"out/$NOTE_ID.zip\"</code></pre>",
- "_help_47ZrP6FNuoG8": "<p>When a new note is created, its name is by default \"new note\". In some cases, it can be desirable to have a different or even a dynamic default note title.</p><p>For this use case, Trilium (since v0.52) supports <code spellcheck=\"false\">#titleTemplate</code> <a href=\"#root/_help_zEY4DaJG4YT5\">label</a>. You can create such a label for a given note, assign it a value, and this value will be used as a default title when creating child notes. As with other labels, you can make it inheritable to apply recursively, and you can even place it on the root note to have it applied globally everywhere.</p><p>As an example use case, imagine you collect books you've read in a given year like this:</p><ul><li>2022 Books<ul><li>Neal Stephenson: Anathem, 2008</li><li>Franz Kafka: Die Verwandlung, 1915</li></ul></li></ul><p>Now, to the parent note \"2022 Books\" you can assign label <code spellcheck=\"false\">#titleTemplate=\"[Author name]: [Book title], [Publication year]\"</code>.</p><p>And all children of \"2022 Books\" will be created with initial title \"[Author name]: [Book title], [Publication year]\". There's no artificial intelligence here, the idea is to just prompt you to manually fill in the pieces of information into the note title by yourself.</p><h2>Dynamic value</h2><p>The value of <code spellcheck=\"false\">#titleTemplate</code> is evaluated at the point of note's creation as a JavaScript string, which means it can be enriched with the help of JS string interpolation with dynamic data.</p><p>Second variable injected is <code spellcheck=\"false\">parentNote</code> which gives access to the parent <a href=\"{{helpAssets}}/User%20Guide/Scripting/Script%20API/Frontend%20API/FNote.dat\"><code spellcheck=\"false\">FNote</code></a>.</p><p>See also&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>&nbsp;which provides similar capabilities, including default note's content.</p><h3>Examples</h3><ul><li>Imagine you collect server outage incidents and write some notes. It looks like this:<ul><li>Incidents<ul><li>2022-05-09: System crash</li><li>2022-05-15: Backup delay</li></ul></li><li>You can automatize the date assignment by assigning a label <code spellcheck=\"false\">#titleTemplate=\"${now.format('YYYY-MM-DD')}: \"</code> to the parent note \"Incidents\". Whenever a new child note is created, the title template is evaluated with the injected <a href=\"https://day.js.org/docs/en/display/format\">now</a> object.</li></ul></li><li>To use a parent's attribute in the title of new notes: <code spellcheck=\"false\">#titleTemplate=\"${parentNote.getLabelValue('authorName')}'s literary works\"</code></li><li>To mirror the parent's note title: <code spellcheck=\"false\">${parentNote.title}</code></li></ul>",
- "_help_wX4HbRucYSDD": "<p>Your Trilium data is stored in a <a href=\"https://www.sqlite.org\">SQLite</a> database which contains all notes, tree structure, metadata, and most of the configuration. The database file is named <code spellcheck=\"false\">document.db</code> and is stored in the application's default&nbsp;<a href=\"#root/_help_tAassRL4RSQL\">Data directory</a>.</p><h2>Demo Notes</h2><p>When first starting Trilium, it will provide a set of notes to showcase various features of the application.</p><p>For more information see&nbsp;<a class=\"reference-link\" href=\"#root/_help_6tZeKvSHEUiB\">Demo Notes</a>.</p><h2>Manually Modifying the Database</h2><p>Trilium provides a lot of flexibility, and with it, opportunities for advanced users to tweak it. If you need to explore or modify the database directly, you can use a tool such as <a href=\"https://sqlitebrowser.org/\">SQLite Browser</a> to work directly on the database file.</p><p>See&nbsp;<a href=\"#root/_help_oyIAJ9PvvwHX\">Manually altering the database</a>&nbsp;for more information.</p><h2>How to Reset the Database</h2><p>If you are experimenting with Trilium and want to return it to its original state, you can do that by deleting the current database. When you restart the application, it will generate a new database containing the original demo notes.</p><p>To delete the database, simply go to the <a href=\"#root/_help_tAassRL4RSQL\">data directory</a> and delete the <code spellcheck=\"false\">document.db</code> file (and any other files starting with <code spellcheck=\"false\">document.db</code>).</p><p>If you do not need to preserve any configurations that might be stored in the <code spellcheck=\"false\">config.ini</code> file, you can just delete all of the <a href=\"#root/_help_tAassRL4RSQL\">data directory's</a> contents to fully restore the application to its original state. You can also review the <a href=\"#root/_help_Gzjqa934BdH4\">configuration</a> file to provide all <code spellcheck=\"false\">config.ini</code> values as environment variables instead.</p>",
- "_help_oyIAJ9PvvwHX": "<p>There are some situations where modifying the SQLite database that Trilium uses is desirable.</p><p>If you are doing any advanced development or troubleshooting where you manually modify the database, you might want to consider creating backups of your <code spellcheck=\"false\">document.db</code> file.</p><h2>Modifying it internally using the SQL Console</h2><p>The SQL Console is Trilium's built-in database editor.</p><p>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_YKWqdJhzi2VY\">SQL Console</a>.</p><h2>Externally modifying the database</h2><p>Sometimes the SQL Console cannot be used (for example if the application cannot start).</p><p>When making external modifications, consider closing the desktop application. If modifying the server database, then stop the service or Docker container.</p><h3>Using DB Browser for SQLite</h3><p>DB Browser for SQLite is a cross-platform editor that can be used to alter the database using a graphical user interface.</p><p>To do so:</p><ol><li>In the main menu, select File → Open database… and navigate to the database in the&nbsp;<a href=\"#root/_help_tAassRL4RSQL\">Data directory</a>.</li><li>Select the <em>Execute SQL</em> tab.</li><li>Type in the desired SQL statement.</li><li>Press the \"Play\" button in the toolbar underneath the \"Execute SQL\" tab (or F5 key).</li><li>Press \"Write Changes\" in the main toolbar.</li><li>Close the application or close the database.</li></ol><p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Database/Manually%20altering%20the%20database_image.jpg\"></p><h3>Using the SQLite CLI</h3><p>First, start the SQLite 3 CLI by specifying the path to the database:</p><pre><code class=\"language-text-x-trilium-auto\">sqlite3 ~/.local/share/trilium-data/document.db</code></pre><ul><li>In the prompt simply type the statement and make sure it ends with a <code spellcheck=\"false\">;</code> character.</li><li>To exit, simply type <code spellcheck=\"false\">.quit</code> and enter.</li></ul>",
- "_help_YKWqdJhzi2VY": "<aside class=\"admonition important\"><p>Starting with v0.104.0, backend scripts are disabled by default to reduce the attack surface. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_fiHicjpHjIRJ\">Security</a>&nbsp;for more information.</p></aside><p>The SQL Console is Trilium's built-in database editor.</p><p>It can be accessed by going to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;→ Advanced → Open SQL Console.</p><p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Database/Manually%20altering%20the%20database/SQL%20Console_image.jpg\"></p><h3>Interaction</h3><ul><li>Hovering the mouse over one of the tables listed at the top of the document will show the columns and their data type.</li><li>Only one SQL statement can be run at once.</li><li>To run the statement, press the <em>Execute</em> icon.</li><li>For queries that return a result, the data will displayed in a table.</li><li>For statements (e.g. <code spellcheck=\"false\">INSERT</code>, <code spellcheck=\"false\">UPDATE</code>), the number of affected rows is displayed.</li></ul><figure class=\"image\"><img style=\"aspect-ratio:1124/571;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Database/Manually%20altering%20the%20database/1_SQL%20Console_image.png\" width=\"1124\" height=\"571\"></figure><h3>Interacting with the table</h3><p>After executing a query, a table with the results will be displayed:</p><ul><li>Clicking on a column allows sorting ascending or descending.</li><li>Underneath each column there is an input field which allows filtering by text.</li><li>Press <kbd>Ctrl</kbd>+<kbd>C</kbd> to copy the current cell to clipboard.</li><li>Multiple cells can be selected by dragging or by holding <kbd>Shift</kbd> + arrow keys</li><li>Results are paginated for performance reasons. The controls at the bottom of the table can be used to navigate through pages.</li></ul><h3>Saved SQL console</h3><p>SQL queries or commands can be saved into a dedicated note.</p><p>To do so, simply write the query and press the <img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Database/Manually%20altering%20the%20database/SQL%20Console_image.png\"> button. Once saved, the note will appear in&nbsp;<a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a>&nbsp;by default. It is possible to change the default location of saved queries by assigning a <code spellcheck=\"false\">#sqlConsoleHome</code> <a href=\"#root/_help_HI6GBBIduIgv\">label</a>.</p><p>The note can be locked for editing by pressing the <em>Lock</em> button in the note actions section near the title bar (on the&nbsp;<a class=\"reference-link\" href=\"#root/_help_IjZS7iK5EXtb\">New Layout</a>, or in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_XpOYSgsLkTJy\">Floating buttons</a>&nbsp;area if using the old layout). When editing is locked, the SQL statement is hidden from view.</p>",
- "_help_6tZeKvSHEUiB": "<p>When you run Trilium for the first time, it will generate a new database containing demo notes. These notes showcase its many features, such as:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_iRwzGnHPzonm\">Relation Map</a></li><li><a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a></li><li><a class=\"reference-link\" href=\"#root/_help_R7abl2fc6Mxi\">Weight Tracker</a></li><li><a class=\"reference-link\" href=\"#root/_help_xYjQUYhpbUEW\">Task Manager</a></li><li><a class=\"reference-link\" href=\"#root/_help_Wy267RK4M69c\">Themes</a></li></ul><h3>Restoring Demo Notes</h3><p>There are some cases in which you may want to restore the original demo notes. For example, if you experimented with some of the more advanced features and want to see the original reference, or if you simply want to explore the latest version of the demo notes, which might showcase new features.</p><p>You can easily restore the demo notes by using Trilium's built-in import feature by importing them:</p><ul><li>Download <a href=\"https://github.com/TriliumNext/Trilium/raw/refs/heads/main/apps/server/src/assets/db/demo.zip\">the .zip archive</a> with the latest version of the demo notes</li><li>Right click on any note in your tree under which you would like the demo notes to be imported</li><li>Click \"Import into note\"</li><li>Select the .zip archive to import it</li></ul>",
- "_help_Gzjqa934BdH4": "<p>Trilium supports configuration via a file named <code spellcheck=\"false\">config.ini</code> and environment variables. This document provides a comprehensive reference for all configuration options.</p><h2>Location of the configuration file</h2><p>The configuration file is not located in the same directory as the application. Instead, the <code spellcheck=\"false\">config.ini</code> is located in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_tAassRL4RSQL\">Data directory</a>. As such, the configuration file is only available after starting the application and creating a database.</p><h2>Configuration Precedence</h2><p>Configuration values are loaded in the following order of precedence (highest to lowest):</p><ol><li><strong>Environment variables</strong> (checked first)</li><li><strong>config.ini file values</strong></li><li><strong>Default values</strong></li></ol><h2>Environment Variable Patterns</h2><p>Trilium supports multiple environment variable patterns for flexibility. The primary pattern is: <code spellcheck=\"false\">TRILIUM_[SECTION]_[KEY]</code></p><p>Where:</p><ul><li><code spellcheck=\"false\">SECTION</code> is the INI section name in UPPERCASE</li><li><code spellcheck=\"false\">KEY</code> is the camelCase configuration key converted to UPPERCASE (e.g., <code spellcheck=\"false\">instanceName</code> → <code spellcheck=\"false\">INSTANCENAME</code>)</li></ul><p>Additionally, shorter aliases are available for common configurations (see Alternative Variables section below).</p><h2>Environment Variable Reference</h2><h3>General Section</h3><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Environment Variable</th>\n<th>Type</th>\n<th>Default</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code spellcheck=\"false\">TRILIUM_GENERAL_INSTANCENAME</code></td>\n<td>string</td>\n<td>\"\"</td>\n<td>Instance name for API identification</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">TRILIUM_GENERAL_NOAUTHENTICATION</code></td>\n<td>boolean</td>\n<td>false</td>\n<td>Disable authentication (server only)</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">TRILIUM_GENERAL_NOBACKUP</code></td>\n<td>boolean</td>\n<td>false</td>\n<td>Disable automatic backups</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">TRILIUM_GENERAL_NODESKTOPICON</code></td>\n<td>boolean</td>\n<td>false</td>\n<td>Disable desktop icon creation</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">TRILIUM_GENERAL_READONLY</code></td>\n<td>boolean</td>\n<td>false</td>\n<td>Enable read-only mode</td>\n</tr>\n</tbody></table></figure><h3>Network Section</h3><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Environment Variable</th>\n<th>Type</th>\n<th>Default</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code spellcheck=\"false\">TRILIUM_NETWORK_HOST</code></td>\n<td>string</td>\n<td>\"0.0.0.0\"</td>\n<td>Server host binding</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">TRILIUM_NETWORK_PORT</code></td>\n<td>string</td>\n<td>\"8080\"</td>\n<td>Server port</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">TRILIUM_NETWORK_HTTPS</code></td>\n<td>boolean</td>\n<td>false</td>\n<td>Enable HTTPS</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">TRILIUM_NETWORK_CERTPATH</code></td>\n<td>string</td>\n<td>\"\"</td>\n<td>SSL certificate path</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">TRILIUM_NETWORK_KEYPATH</code></td>\n<td>string</td>\n<td>\"\"</td>\n<td>SSL key path</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">TRILIUM_NETWORK_TRUSTEDREVERSEPROXY</code></td>\n<td>boolean/string</td>\n<td>false</td>\n<td>Reverse proxy trust settings</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">TRILIUM_NETWORK_CORSALLOWORIGIN</code></td>\n<td>string</td>\n<td>\"\"</td>\n<td>CORS allowed origins</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">TRILIUM_NETWORK_CORSALLOWMETHODS</code></td>\n<td>string</td>\n<td>\"\"</td>\n<td>CORS allowed methods</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">TRILIUM_NETWORK_CORSALLOWHEADERS</code></td>\n<td>string</td>\n<td>\"\"</td>\n<td>CORS allowed headers</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">TRILIUM_NETWORK_CORSRESOURCEPOLICY</code></td>\n<td>string</td>\n<td>same-origin</td>\n<td>CORS Resource Policy allows same-origin/same-site/cross-origin as values, will error if not</td>\n</tr>\n</tbody></table></figure><h3>Session Section</h3><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Environment Variable</th>\n<th>Type</th>\n<th>Default</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code spellcheck=\"false\">TRILIUM_SESSION_COOKIEMAXAGE</code></td>\n<td>integer</td>\n<td>1814400</td>\n<td>Session cookie max age in seconds (21 days)</td>\n</tr>\n</tbody></table></figure><h3>Sync Section</h3><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Environment Variable</th>\n<th>Type</th>\n<th>Default</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code spellcheck=\"false\">TRILIUM_SYNC_SYNCSERVERHOST</code></td>\n<td>string</td>\n<td>\"\"</td>\n<td>Sync server host URL</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">TRILIUM_SYNC_SYNCSERVERTIMEOUT</code></td>\n<td>string</td>\n<td>\"120000\"</td>\n<td>Sync server timeout in milliseconds</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">TRILIUM_SYNC_SYNCPROXY</code></td>\n<td>string</td>\n<td>\"\"</td>\n<td>Sync proxy URL</td>\n</tr>\n</tbody></table></figure><h3>MultiFactorAuthentication Section</h3><p>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_x1lQNKQBqLcA\">Signing in with OpenID Connect</a>.</p><h3>Logging Section</h3><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Environment Variable</th>\n<th>Type</th>\n<th>Default</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code spellcheck=\"false\">TRILIUM_LOGGING_RETENTIONDAYS</code></td>\n<td>integer</td>\n<td>90</td>\n<td>Number of days to retain log files</td>\n</tr>\n</tbody></table></figure><h3>Development Section</h3><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Environment Variable</th>\n<th>Type</th>\n<th>Default</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code spellcheck=\"false\">TRILIUM_MANUAL_DB_MIGRATION</code></td>\n<td>boolean</td>\n<td>false</td>\n<td>If <code spellcheck=\"false\">true</code>, the application will not start if automatic database migrations are pending and would modify the database schema.</td>\n</tr>\n</tbody></table></figure><h2>Alternative Environment Variables</h2><p>The following alternative environment variable names are also supported and work identically to their longer counterparts:</p><h3>Network CORS Variables</h3><ul><li><code spellcheck=\"false\">TRILIUM_NETWORK_CORS_ALLOW_ORIGIN</code> (alternative to <code spellcheck=\"false\">TRILIUM_NETWORK_CORSALLOWORIGIN</code>)</li><li><code spellcheck=\"false\">TRILIUM_NETWORK_CORS_ALLOW_METHODS</code> (alternative to <code spellcheck=\"false\">TRILIUM_NETWORK_CORSALLOWMETHODS</code>)</li><li><code spellcheck=\"false\">TRILIUM_NETWORK_CORS_ALLOW_HEADERS</code> (alternative to <code spellcheck=\"false\">TRILIUM_NETWORK_CORSALLOWHEADERS</code>)</li><li><code spellcheck=\"false\">TRILIUM_NETWORK_CORS_RESOURCE_POLICY</code> (alternative to <code spellcheck=\"false\">TRILIUM_NETWORK_CORSRESOURCEPOLICY</code>)</li></ul><h3>Sync Variables</h3><ul><li><code spellcheck=\"false\">TRILIUM_SYNC_SERVER_HOST</code> (alternative to <code spellcheck=\"false\">TRILIUM_SYNC_SYNCSERVERHOST</code>)</li><li><code spellcheck=\"false\">TRILIUM_SYNC_SERVER_TIMEOUT</code> (alternative to <code spellcheck=\"false\">TRILIUM_SYNC_SYNCSERVERTIMEOUT</code>)</li><li><code spellcheck=\"false\">TRILIUM_SYNC_SERVER_PROXY</code> (alternative to <code spellcheck=\"false\">TRILIUM_SYNC_SYNCPROXY</code>)</li></ul><h3>OAuth/MFA Variables</h3><ul><li><code spellcheck=\"false\">TRILIUM_OAUTH_BASE_URL</code> (alternative to <code spellcheck=\"false\">TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHBASEURL</code>)</li><li><code spellcheck=\"false\">TRILIUM_OAUTH_CLIENT_ID</code> (alternative to <code spellcheck=\"false\">TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTID</code>)</li><li><code spellcheck=\"false\">TRILIUM_OAUTH_CLIENT_SECRET</code> (alternative to <code spellcheck=\"false\">TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTSECRET</code>)</li><li><code spellcheck=\"false\">TRILIUM_OAUTH_ISSUER_BASE_URL</code> (alternative to <code spellcheck=\"false\">TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERBASEURL</code>)</li><li><code spellcheck=\"false\">TRILIUM_OAUTH_ISSUER_NAME</code> (alternative to <code spellcheck=\"false\">TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERNAME</code>)</li><li><code spellcheck=\"false\">TRILIUM_OAUTH_ISSUER_ICON</code> (alternative to <code spellcheck=\"false\">TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERICON</code>)</li></ul><h3>Logging Variables</h3><ul><li><code spellcheck=\"false\">TRILIUM_LOGGING_RETENTION_DAYS</code> (alternative to <code spellcheck=\"false\">TRILIUM_LOGGING_RETENTIONDAYS</code>)</li></ul><h2>Boolean Values</h2><p>Boolean environment variables accept the following values:</p><ul><li><strong>True</strong>: <code spellcheck=\"false\">\"true\"</code>, <code spellcheck=\"false\">\"1\"</code>, <code spellcheck=\"false\">1</code></li><li><strong>False</strong>: <code spellcheck=\"false\">\"false\"</code>, <code spellcheck=\"false\">\"0\"</code>, <code spellcheck=\"false\">0</code></li><li>Any other value defaults to <code spellcheck=\"false\">false</code></li></ul><h2>Using Environment Variables</h2><p>Both naming patterns are fully supported and can be used interchangeably:</p><ul><li>The longer format follows the section/key pattern for consistency with the INI file structure</li><li>The shorter alternatives provide convenience for common configurations</li><li>You can use whichever format you prefer - both are equally valid</li></ul><h2>Examples</h2><h3>Docker Compose Example</h3><pre><code class=\"language-text-x-yaml\">services:\n trilium:\n image: triliumnext/trilium\n environment:\n # Using full format\n TRILIUM_GENERAL_INSTANCENAME: \"My Trilium Instance\"\n TRILIUM_NETWORK_PORT: \"8080\"\n TRILIUM_NETWORK_CORSALLOWORIGIN: \"https://myapp.com\"\n TRILIUM_SYNC_SYNCSERVERHOST: \"https://sync.example.com\"\n TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHBASEURL: \"https://auth.example.com\"\n \n # Or using shorter alternatives (equally valid)\n # TRILIUM_NETWORK_CORS_ALLOW_ORIGIN: \"https://myapp.com\"\n # TRILIUM_SYNC_SERVER_HOST: \"https://sync.example.com\"\n # TRILIUM_OAUTH_BASE_URL: \"https://auth.example.com\"</code></pre><h3>Shell Export Example</h3><pre><code class=\"language-text-x-trilium-auto\"># Using either format\nexport TRILIUM_GENERAL_NOAUTHENTICATION=false\nexport TRILIUM_NETWORK_HTTPS=true\nexport TRILIUM_NETWORK_CERTPATH=/path/to/cert.pem\nexport TRILIUM_NETWORK_KEYPATH=/path/to/key.pem\nexport TRILIUM_LOGGING_RETENTIONDAYS=30\n\n# Start Trilium\nnpm start</code></pre><h2>config.ini Reference</h2><p>For the complete list of configuration options and their INI file format, please review the <a href=\"https://github.com/TriliumNext/Trilium/blob/main/apps/server/src/assets/config-sample.ini\">config-sample.ini</a> file in the Trilium repository</p>",
- "_help_c5xB8m4g2IY6": "<p>A Trilium instance represents a server. If&nbsp;<a class=\"reference-link\" href=\"#root/_help_cbkrhQjrkKrh\">Synchronization</a>&nbsp;is set up, since multiple servers are involved (the one from the desktop client and the one the synchronisation is set up with), sometimes it can be useful to distinguish the instance you are running on.</p><h2>Setting the instance name</h2><p>To set up a name for the instance, modify the <code spellcheck=\"false\">config.ini</code>:</p><pre><code class=\"language-text-x-trilium-auto\">[General]\ninstanceName=Hello</code></pre><h2>Distinguishing the instance on back-end</h2><p>Use <code spellcheck=\"false\">api.getInstanceName()</code> to obtain the instance name of the current server, as specified in the config file or in environment variables.</p><h2>Limiting script runs based on instance</h2><p>For a script that is run periodically or on a certain event, it's possible to limit it to certain instances without having to change the code. Just add <code spellcheck=\"false\">runOnInstance</code> and set as the value the instance name where the script should run. To run on multiple named instances, simply add the label multiple times.</p>",
- "_help_LWtBjFej3wX3": "<p>By default, Trilium cannot be accessed in web browsers by requests coming from other domains/origins than Trilium itself.&nbsp;</p><p>However, it is possible to manually configure <a href=\"https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/CORS\">Cross-Origin Resource Sharing (CORS)</a> since Trilium v0.93.0 using environment variables or <code spellcheck=\"false\">config.ini</code>, as follows:</p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>CORS Header</th>\n<th>Corresponding environment variable</th>\n<th>Corresponding option in <code spellcheck=\"false\">config.ini</code> variables in the <code spellcheck=\"false\">Network</code> section</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code spellcheck=\"false\">Access-Control-Allow-Origin</code></td>\n<td><code spellcheck=\"false\">TRILIUM_NETWORK_CORS_ALLOW_ORIGIN</code></td>\n<td><code spellcheck=\"false\">corsAllowOrigin</code></td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">Access-Control-Allow-Methods</code></td>\n<td><code spellcheck=\"false\">TRILIUM_NETWORK_CORS_ALLOW_METHODS</code></td>\n<td><code spellcheck=\"false\">corsAllowMethods</code></td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">Access-Control-Allow-Headers</code></td>\n<td><code spellcheck=\"false\">TRILIUM_NETWORK_CORS_ALLOW_HEADERS</code></td>\n<td><code spellcheck=\"false\">corsAllowHeaders</code></td>\n</tr>\n</tbody></table></figure>",
- "_help_ivYnonVFBxbQ": "<figure class=\"image\"><img style=\"aspect-ratio:1425/644;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Bulk%20Actions_image.png\" width=\"1425\" height=\"644\"></figure><p>The <em>Bulk Actions</em> dialog makes it easy to apply changes to multiple notes at once, ranging from simple actions such as adding or removing a label to being executing custom scripts.</p><h2>Interaction</h2><ul><li>The first step is to select the notes in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>. It's possible to apply bulk actions to:<ul><li>A single note (and potentially its child notes) simply by clicking on it (with a left click or a right click).</li><li>Multiple notes. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_yTjUdsOi4CIE\">Multiple selection</a>&nbsp;on how to do so.</li></ul></li><li>Right click in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and select <em>Advanced</em> → <em>Apply bulk actions</em>.</li><li>By default, only the selected notes will be affected. To also include all the descendants of the notes, check <em>Include descendants of the selected notes</em>. The number of affected notes at the top of the dialog will update to reflect the change.</li><li>Click on which action to apply from the <em>Available actions</em> section. A detailed description of each is available in the next section.<ul><li>For each action selected, the <em>Chosen actions</em> section will update to reveal the entry. Each action will have its own configuration.</li><li>To remove an action, simply press the X button to the right of it.</li><li>It is possible to apply multiple actions of the same type, such as adding multiple types.</li></ul></li><li>When all the actions are defined, press <em>Execute bulk actions</em> to trigger all of them at once.</li><li>For convenience, the last bulk action configuration is saved for further use and will be restored when entering the dialog again.</li></ul><h2>Actions</h2><h3>Labels</h3><p>These actions operate the&nbsp;<a class=\"reference-link\" href=\"#root/_help_HI6GBBIduIgv\">Labels</a>&nbsp;of a note:</p><ul><li><strong>Add label</strong><ul><li>For each note, if it doesn't already have a <a href=\"#root/_help_HI6GBBIduIgv\">label</a> of the given name, it will create it. Keep the <em>New value</em> field empty to create a label without a value, or complete it to assign a value.</li><li>If a note already has this label, its value will be updated.</li></ul></li><li><strong>Update label value</strong><ul><li>For each note, if it has a <a href=\"#root/_help_HI6GBBIduIgv\">label</a> of the given name, it will change its value to the specified one. Leave <em>New value</em> field empty to create a label without a value.</li><li>Notes without the label will not be affected.</li></ul></li><li><em><strong>Rename label</strong></em><ul><li>For each note, if it has a <a href=\"#root/_help_HI6GBBIduIgv\">label</a> of the given name, it will be renamed/replaced with a label of the new name. The value of the label (if present) will be kept intact.</li><li>Notes without the label will not be affected.</li></ul></li><li><strong>Delete label</strong><ul><li>For each note, if it has a label of a given name, it will be deleted (regardless of whether it has a value or not).</li><li>Notes without the label will not be affected.</li></ul></li></ul><h3>Relations</h3><p>These actions operate the&nbsp;<a class=\"reference-link\" href=\"#root/_help_Cq5X6iKQop6R\">Relations</a>&nbsp;of a note:</p><ul><li><strong>Add relation</strong><ul><li>For each note, it will create a relation pointing to the given note.</li><li>Notes without this relation will not be affected.</li></ul></li><li><strong>Update relation target</strong><ul><li>For each note, it will modify a relation to point to the newly given note.</li><li>Notes without this relation will not be affected.</li></ul></li><li><strong>Rename relation</strong><ul><li>For each note, if it has a relation of the given name, it will be renamed/replaced with a relation of the new name. The target note of the relation will be kept intact.</li><li>Notes without this relation will not be affected.</li></ul></li><li><strong>Delete relation</strong><ul><li>For each note, if it has a relation of the given name, it will be deleted.</li><li>Notes without this relation will not be affected.</li></ul></li></ul><h3>Notes</h3><ul><li><strong>Rename note</strong><ul><li>For each note, it will change the title of the note to the given one.</li><li>As a more advanced use case, the note can be a “template string” which allows for dynamic values with access to the note information via&nbsp;<a class=\"reference-link\" href=\"{{helpAssets}}/User%20Guide/Scripting/Script%20API/Frontend%20API/FNote.dat\">FNote</a>, for example:<ul><li><code spellcheck=\"false\">NEW: ${note.title}</code> will prefix all notes with <code spellcheck=\"false\">NEW:</code> .</li><li><code spellcheck=\"false\">${note.dateCreatedObj.format('MM-DD:')}: ${note.title}</code> will prefix the note titles with each note's creation date (in month-day format).</li></ul></li></ul></li><li><strong>Move note</strong><ul><li>For each note, it will be moved to the specified parent note.</li><li>As an alternative for less complex situations, the notes can be moved directly from within the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;via cut → paste or via the contextual menu.</li></ul></li><li><strong>Convert note</strong><ul><li>This allows a note to be converted from one type to another:<ul><li><strong>Text Notes → Markdown Notes</strong> — each&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;note is converted to a&nbsp;<a class=\"reference-link\" href=\"#root/_help_6RM1Q7ppFVoj\">Markdown</a>&nbsp;note. Since Markdown does not support all the formatting capabilities of Text Notes, some formatting may be lost and some unsupported elements may even be dropped.</li><li><strong>Markdown Notes → Text Notes</strong> — each&nbsp;<a class=\"reference-link\" href=\"#root/_help_6RM1Q7ppFVoj\">Markdown</a>&nbsp;note is converted to a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;Note.</li></ul></li><li>For each converted note, a revision is saved automatically, allowing you to restore the original or recover any missing elements from it.</li></ul></li><li><strong>Save revision</strong><ul><li>Automatically creates a revision of each note. Optionally, a name can be assigned to this revision. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_vZWERwf8U3nx\">Note Revisions</a>.</li></ul></li><li><strong>Delete note</strong><ul><li>For each note, it will be deleted.</li><li>As an alternative for less complex situations, the notes can be removed directly from within the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;by selecting them and pressing <kbd>Delete</kbd>.</li></ul></li><li><strong>Delete note revisions</strong><ul><li>This will delete all the&nbsp;<a class=\"reference-link\" href=\"#root/_help_vZWERwf8U3nx\">Note Revisions</a>&nbsp;of the notes.</li></ul></li></ul><h3>Others</h3><ul><li><strong>Execute script</strong><ul><li>For more complex scenarios, it is possible to type in a JavaScript expression in order to apply the necessary changes.</li><li>Examples:<ul><li><p>To apply a suffix (<code spellcheck=\"false\">- suffix</code> in this example), to the note title:</p><pre><code class=\"language-text-javascript\">note.title = note.title + \" - suffix\";</code></pre></li><li><p>To alter attributes of a note based on another attribute, such as setting the <code spellcheck=\"false\">#shareAlias</code> label to the title of the note:</p><pre><code class=\"language-text-javascript\">note.setLabel(\"shareAlias\", note.title)</code></pre></li></ul></li></ul></li></ul>",
- "_help_4FahAwuGTAwC": "<h2>Understanding the source code of the different notes</h2><p>Internally, the structure of the content of each note is different based on the&nbsp;<a class=\"reference-link\" href=\"#root/_help_KSZ04uQ2D1St\">Note Types</a>.</p><p>For example:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes&nbsp;are represented internally as HTML, using the&nbsp;<a class=\"reference-link\" href=\"#root/_help_MI26XDLSAlCD\">CKEditor</a>&nbsp;representation. Note that due to the custom plugins, some HTML elements are specific to Trilium only, for example the admonitions.</li><li><a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;notes&nbsp;are plain text and are represented internally as-is.</li><li><a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map</a>&nbsp;notes contain only minimal information (viewport, zoom) as a JSON.</li><li><a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a>&nbsp;notes are represented as JSON, with Trilium's own information alongside with&nbsp;<a href=\"#root/_help_1YeN2MzFUluU\">Excalidraw</a>'s internal JSON representation format.</li><li><a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a>&nbsp;notes are represented as JSON, with the internal format of&nbsp;<a href=\"#root/_help_1YeN2MzFUluU\">MindElixir</a>.</li></ul><p>Note that some information is also stored as&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>. For example&nbsp;<a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a>&nbsp;notes use the attachments feature to store the custom libraries, and alongside with&nbsp;<a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a>&nbsp;and other similar note types it stores an SVG representation of the content for use in other features such as including in other notes, shared notes, etc.</p><p>Here's part of the HTML representation of this note, as it's stored in the database (but prettified).</p><pre><code class=\"language-text-x-trilium-auto\">&lt;h2&gt;\n\tUnderstanding the source code of the different notes\n&lt;/h2&gt;\n&lt;p&gt;\n\tInternally, the structure of the content of each note is different based on the&amp;nbsp;\n\t&lt;a class=\"reference-link\" href=\"#root/_help_KSZ04uQ2D1St\"&gt;\n\t\tNote Types\n\t&lt;/a&gt;\n\t.\n&lt;/p&gt;</code></pre><h2>Viewing the source code</h2><p>It is possible to view the source code of a note by pressing the contextual menu in&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note buttons</a>&nbsp;and selecting <em>Note source</em>.</p><p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Note%20source_image.png\"></p><p>The source code will be displayed in a new tab.</p><p>For some note types, such as text notes and JSON notes, the source code is also formatted in order to be more easily readable.</p><h2>Modifying the source code</h2><p>It is possible to modify the source code of a note directly, however not via the <em>Note source</em> functionality.&nbsp;</p><p>To do so:</p><ol><li>Change the note type from the real note type (e.g. Canvas, Geo Type) to Code (plain text) or the corresponding format such as JSON or HTML.</li><li>Confirm the warning about changing the note type.</li><li>The source code will appear, make the necessary modifications.</li><li>Change the note type back to the real note type.</li></ol><aside class=\"admonition warning\"><p>Depending on the changes made, there is a risk that the note will not render properly. It's best to save a revision before making any big changes.</p><p>If the note does not render properly, modify the source code again or revert to a prior revision. Since the error handling for unexpected changes might not always be perfect, it be required to refresh the application.</p></aside>",
++ "_help_l0tKav7yLHGF": "<p>A common pattern in note-taking is that a lot of notes will be centered around a certain date - e.g. you have some tasks which needs to be done on a certain date, you have meeting minutes from a certain date, you have your thoughts etc. and it all revolves around a date on which they occurred. For this reason, it makes sense to create a certain \"day workspace\" which will centralize all those notes relevant for a certain date.</p><p>For this, Trilium provides a concept of \"day note\". Trilium semi-automatically generates a single note for each day. Under this note you can save all those relevant notes.</p><p>Select an existing day note, and the menubar contains a calendar widget. Select any day to create a note for that day.&nbsp;</p><p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Advanced%20Showcases/Day%20Notes_image.jpg\"></p><p>This pattern works well also because of <a href=\"#root/_help_IakOLONlIfGI\">Cloning Notes</a> functionality - note can appear in multiple places in the note tree, so besides appearing under day note, it can also be categorized into other notes.</p><h2>Demo</h2><p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Advanced%20Showcases/Day%20Notes_image.png\"></p><p>You can see the structure of day notes appearing under \"Journal\" note - there's a note for the whole year 2025, under it, you have \"03 - March\" which then contains \"09 - Monday\". This is our \"day note\" which contains some text in its content and also has some child notes (some of them are from <a href=\"#root/_help_xYjQUYhpbUEW\">Task manager</a>).</p><p>You can also notice how this day note has <a href=\"#root/_help_OFXdgB2nNk1F\">promoted attribute</a> \"weight\" where you can track your daily weight. This data is then used in <a href=\"#root/_help_R7abl2fc6Mxi\">Weight tracker</a>.</p><h2>Edited notes</h2><p>When a day note is opened, a collapsible section will appear underneath the&nbsp;<a class=\"reference-link\" href=\"#root/_help_l7pigIGu01K2\">Title</a>&nbsp;showing the notes edited on that day.</p><h2>Week Note and Quarter Note</h2><p>Week and quarter notes are disabled by default, since it might be too much for some people. To enable them, you need to set <code>#enableWeekNote</code> and <code>#enableQuarterNote</code> attributes on the root calendar note, which is identified by <code>#calendarRoot</code> label. Week note is affected by the first week of year option. Be careful when you already have some week notes created, it will not automatically change the existing week notes and might lead to some duplicates.</p><h2>Templates</h2><p>Trilium provides <a href=\"#root/_help_KC1HB96bqqHX\">template</a> functionality, and it could be used together with day notes.</p><p>You can define one of the following relations on the root of the journal (identified by <code>#calendarRoot</code> label):</p><ul><li>yearTemplate</li><li>quarterTemplate (if <code>#enableQuarterNote</code> is set)</li><li>monthTemplate</li><li>weekTemplate (if <code>#enableWeekNote</code> is set)</li><li>dateTemplate</li></ul><p>All of these are relations. When Trilium creates a new note for year or month or date, it will take a look at the root and attach a corresponding <code>~template</code> relation to the newly created role. Using this, you can e.g. create your daily template with e.g. checkboxes for daily routine etc.</p><h3>Migrate from old template usage</h3><p>If you have been using Journal prior to version v0.93.0, the previous template pattern likely used was <code>~child:template=</code>.<br>To transition to the new system:</p><ol><li>Set up the new template pattern in the Calendar root note.</li><li>Use <a href=\"#root/_help_ivYnonVFBxbQ\">Bulk Actions</a> to remove <code>child:template</code> and <code>child:child:template</code> from all notes under the Journal (calendar root).</li><li>Ensure that all old template patterns are fully removed to prevent conflicts with the new setup.</li></ol><h2>Naming pattern</h2><p>You can customize the title of generated journal notes by defining a <code>#datePattern</code>, <code>#weekPattern</code>, <code>#monthPattern</code>, <code>#quarterPattern</code> and <code>#yearPattern</code> attribute on a root calendar note (identified by <code>#calendarRoot</code> label). The naming pattern replacements follow a level-up compatibility - each level can use replacements from itself and all levels above it. For example, <code>#monthPattern</code> can use month, quarter and year replacements, while <code>#weekPattern</code> can use week, month, quarter and year replacements. But it is not possible to use week replacements in <code>#monthPattern</code>.</p><h3>Date pattern</h3><p>It's possible to customize the title of generated date notes by defining a <code>#datePattern</code> attribute on a root calendar note (identified by <code>#calendarRoot</code> label). Following are possible values:</p><ul><li><code>{isoDate}</code> results in an ISO 8061 formatted date (e.g. \"2025-03-09\" for March 9, 2025)</li><li><code>{dateNumber}</code> results in a number like <code>9</code> for the 9th day of the month, <code>11</code> for the 11th day of the month</li><li><code>{dateNumberPadded}</code> results in a number like <code>09</code> for the 9th day of the month, <code>11</code> for the 11th day of the month</li><li><code>{ordinal}</code> is replaced with the ordinal date (e.g. 1st, 2nd, 3rd) etc.</li><li><code>{weekDay}</code> results in the full day name (e.g. <code>Monday</code>)</li><li><code>{weekDay3}</code> is replaced with the first 3 letters of the day, e.g. Mon, Tue, etc.</li><li><code>{weekDay2}</code> is replaced with the first 2 letters of the day, e.g. Mo, Tu, etc.</li></ul><p>The default is <code>{dateNumberPadded} - {weekDay}</code></p><h3>Week pattern</h3><p>It is also possible to customize the title of generated week notes through the <code>#weekPattern</code> attribute on the root calendar note. The options are:</p><ul><li><code>{weekNumber}</code> results in a number like <code>9</code> for the 9th week of the year, <code>11</code> for the 11th week of the year</li><li><code>{weekNumberPadded}</code> results in a number like <code>09</code> for the 9th week of the year, <code>11</code> for the 11th week of the year</li><li><code>{shortWeek}</code> results in a short week string like <code>W9</code> for the 9th week of the year, <code>W11</code> for the 11th week of the year</li><li><code>{shortWeek3}</code> results in a short week string like <code>W09</code> for the 9th week of the year, <code>W11</code> for the 11th week of the year</li></ul><p>The default is <code>Week {weekNumber}</code></p><h3>Month pattern</h3><p>It is also possible to customize the title of generated month notes through the <code>#monthPattern</code> attribute on the root calendar note. The options are:</p><ul><li><code>{isoMonth}</code> results in an ISO 8061 formatted month (e.g. \"2025-03\" for March 2025)</li><li><code>{monthNumber}</code> results in a number like <code>9</code> for September, and <code>11</code> for November</li><li><code>{monthNumberPadded}</code> results in a number like <code>09</code> for September, and <code>11</code> for November</li><li><code>{month}</code> results in the full month name (e.g. <code>September</code> or <code>October</code>)</li><li><code>{shortMonth3}</code> is replaced with the first 3 letters of the month, e.g. Jan, Feb, etc.</li><li><code>{shortMonth4}</code> is replaced with the first 4 letters of the month, e.g. Sept, Octo, etc.</li></ul><p>The default is <code>{monthNumberPadded} - {month}</code></p><h3>Quarter pattern</h3><p>It is also possible to customize the title of generated quarter notes through the <code>#quarterPattern</code> attribute on the root calendar note. The options are:</p><ul><li><code>{quarterNumber}</code> results in a number like <code>1</code> for the 1st quarter of the year</li><li><code>{shortQuarter}</code> results in a short quarter string like <code>Q1</code> for the 1st quarter of the year</li></ul><p>The default is <code>Quarter {quarterNumber}</code></p><h3>Year pattern</h3><p>It is also possible to customize the title of generated year notes through the <code>#yearPattern</code> attribute on the root calendar note. The options are:</p><ul><li><code>{year}</code> results in the full year (e.g. <code>2025</code>)</li></ul><p>The default is <code>{year}</code></p><h2>Implementation</h2><p>Trilium has some special support for day notes in the form of <a href=\"https://triliumnext.github.io/Notes/backend_api/BackendScriptApi.html\">backend Script API</a> - see e.g. getDayNote() function.</p><p>Day (and year, month) notes are created with a label - e.g. <code>#dateNote=\"2025-03-09\"</code> this can then be used by other scripts to add new notes to day note etc.</p>",
++ "_help_R7abl2fc6Mxi": "<p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Advanced%20Showcases/Weight%20Tracker_image.jpg\"></p><p>The <code>Weight Tracker</code> is a <a href=\"#root/_help_GLks18SNjxmC\">Script API</a> showcase present in the <a href=\"#root/_help_wX4HbRucYSDD\">demo notes</a>.</p><p>By adding <code>weight</code> as a <a href=\"#root/_help_OFXdgB2nNk1F\">promoted attribute</a> in the <a href=\"#root/_help_KC1HB96bqqHX\">template</a> from which <a href=\"#root/_help_l0tKav7yLHGF\">day notes</a> are created, you can aggregate the data and plot weight change over time.</p><h2>Implementation</h2><p>The <code>Weight Tracker</code> note in the screenshot above is of the type <code>Render Note</code>. That type of note doesn't have any useful content itself. Instead it is a placeholder where a <a href=\"#root/_help_CdNpE2pqjmI6\">script</a> can render its output.</p><p>Scripts for <code>Render Notes</code> are defined in a <a href=\"#root/_help_zEY4DaJG4YT5\">relation</a> called <code>~renderNote</code>. In this example, it's the <code>Weight Tracker</code>'s child <code>Implementation</code>. The Implementation consists of two <a href=\"#root/_help_6f9hih2hXXZk\">code notes</a> that contain some HTML and JavaScript respectively, which load all the notes with a <code>weight</code> attribute and display their values in a chart.</p><p>To actually render the chart, we're using a third party library called <a href=\"https://www.chartjs.org/\">chart.js</a>which is imported as an attachment, since it's not built into Trilium.</p><h3>Code</h3><p>Here's the content of the script which is placed in a <a href=\"#root/_help_6f9hih2hXXZk\">code note</a> of type <code>JS Frontend</code>:</p><pre><code class=\"language-text-x-trilium-auto\">async function getChartData() {\n const days = await api.runOnBackend(async () =&gt; {\n const notes = api.getNotesWithLabel('weight');\n const days = [];\n\n for (const note of notes) {\n const date = note.getLabelValue('dateNote');\n const weight = parseFloat(note.getLabelValue('weight'));\n\n if (date &amp;&amp; weight) {\n days.push({ date, weight });\n }\n }\n\n days.sort((a, b) =&gt; a.date &gt; b.date ? 1 : -1);\n\n return days;\n });\n\n const datasets = [\n {\n label: \"Weight (kg)\",\n backgroundColor: 'red',\n borderColor: 'red',\n data: days.map(day =&gt; day.weight),\n fill: false,\n spanGaps: true,\n datalabels: {\n display: false\n }\n }\n ];\n\n return {\n datasets: datasets,\n labels: days.map(day =&gt; day.date)\n };\n}\n\nconst ctx = $(\"#canvas\")[0].getContext(\"2d\");\n\nnew chartjs.Chart(ctx, {\n type: 'line',\n data: await getChartData()\n});</code></pre><h2>How to remove the Weight Tracker button from the top bar</h2><p>In the link map of the <code>Weight Tracker</code>, there is a note called <code>Button</code>. Open it and delete or comment out its contents. The <code>Weight Tracker</code> button will disappear after you restart Trilium.</p>",
++ "_help_xYjQUYhpbUEW": "<p>Task Manager is a <a href=\"#root/_help_OFXdgB2nNk1F\">promoted attributes</a> and <a href=\"#root/_help_CdNpE2pqjmI6\">scripts</a>showcase present in the <a href=\"#root/_help_wX4HbRucYSDD\">demo notes</a>.</p><h2>Demo</h2><p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Advanced%20Showcases/Task%20Manager_task-manager.png\"></p><p>Task Manager manages outstanding (TODO) tasks and finished tasks (non-empty doneDate attribute). Outstanding tasks are further categorized by location and arbitrary tags - whenever you change tag attribute in the task note, this task is then automatically moved to appropriate location.</p><p>Task Manager also integrates with <a href=\"#root/_help_l0tKav7yLHGF\">day notes</a> - notes are <a href=\"#root/_help_IakOLONlIfGI\">cloned</a> into day note to both todoDate note and doneDate note (with <a href=\"#root/_help_kBrnXNG3Hplm\">prefix</a> of either \"TODO\" or \"DONE\").</p><h2>Implementation</h2><p>New tasks are created in the TODO note which has <code>~child:template</code> <a href=\"#root/_help_zEY4DaJG4YT5\">relation</a>(see <a href=\"#root/_help_bwZpz2ajCEwO\">attribute inheritance</a>) pointing to the task template.</p><h3>Attributes</h3><p>Task template defines several <a href=\"#root/_help_OFXdgB2nNk1F\">promoted attributes</a> - todoDate, doneDate, tags, location. Importantly it also defines <code>~runOnAttributeChange</code> relation - <a href=\"#root/_help_GPERMystNGTB\">event</a> handler which is run on attribute change. This <a href=\"#root/_help_CdNpE2pqjmI6\">script</a> handles when e.g. we fill out the doneDate attribute - meaning the task is done and should be moved to \"Done\" note and removed from TODO, locations and tags.</p><h3>New task button</h3><p>There's also \"button\" note which contains simple script which adds a button to create new note (task) in the TODO note.</p><pre><code class=\"language-text-x-trilium-auto\">api.addButtonToToolbar({\n title: 'New task',\n icon: 'check',\n shortcut: 'alt+n',\n action: async () =&gt; {\n // creating notes is backend (server) responsibility so we need to pass\n // the control there\n const taskNoteId = await api.runOnBackend(async () =&gt; {\n const todoRootNote = await api.getNoteWithLabel('taskTodoRoot');\n const {note} = await api.createNote(todoRootNote.noteId, 'new task', '');\n\n return note.noteId;\n });\n\n // we got an ID of newly created note and we want to immediatelly display it\n await api.activateNewNote(taskNoteId);\n }\n});</code></pre><h3>CSS</h3><p>In the demo screenshot above you may notice that TODO tasks are in red color and DONE tasks are green.</p><p>This is done by having this CSS <a href=\"#root/_help_6f9hih2hXXZk\">code note</a> which defines extra CSS classes:</p><pre><code class=\"language-text-x-trilium-auto\">span.fancytree-node.todo .fancytree-title {\n color: red !important;\n}\n\nspan.fancytree-node.done .fancytree-title {\n color: green !important;\n}</code></pre><p>This <a href=\"#root/_help_6f9hih2hXXZk\">code note</a> has <code>#appCss</code> <a href=\"#root/_help_zEY4DaJG4YT5\">label</a>which is recognized by Trilium on startup and loaded as CSS into the application.</p><p>Second part of this functionality is based in event handler described above which assigns <code>#cssClass</code> label to the task to either \"done\" or \"todo\" based on the task status.</p>",
++ "_help_i16PM6A7GXdU": "<p>Trilium features customizable to-do list task states. To customize them, go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Text Notes</em> → <em>Related settings</em> → <em>Custom checkbox states for to-do lists</em>. Alternatively, right-click a checkbox in an editable text note and click the pencil icon.</p><aside class=\"admonition warning\"><p>Changes take effect only after restarting the application.</p></aside><h2>Creating a new task state</h2><p>Click the plus icon next to Task States in the left-side pane, then define the task details as described in the next section.</p><h2>Editing a task state</h2><p>Selecting any state other than \"None\" and \"Done\" (which cannot be modified) from the side pane reveals the following editable fields:</p><ul><li><em>Icon</em> (required): The symbol shown inside the checkbox. You can pick an icon just as you would for any regular note, including from custom icon packs.</li><li><em>Title</em> (required): The name of the task state shown in the UI. For example: \"Doing\", \"Postponed\".</li><li><em>Identifier</em> (required): A short name for the state, using only letters, digits, \"<code>-</code>\" and \"<code>_</code>\". It is stored as metadata in the note's markup and used to identify the task state. Two task states cannot share the same identifier.<br>Prefix the identifiers of your custom task states with an underscore \"<code>_</code>\" or a hyphen \"<code>-</code>\" to avoid clashes with task states that may be introduced in future versions of Trilium.</li><li><em>Markdown symbol</em>: A single character used to represent the state in Markdown syntax. For example, \"<code>#</code>\" creates a task state that can be applied in Markdown using \" <code>- [#]</code> \". Make sure no other task state uses the same symbol.</li><li><em>Counts as completed</em>: If checked, the task is treated as completed.</li><li><em>Color</em>: The color of the checkbox. Its lightness and saturation are adjusted automatically to match the current color scheme or theme.</li><li><em>Hidden from toolbar</em>: The state is not listed in the UI. This is useful when you want existing notes to keep rendering the state correctly but no longer need to apply it yourself.</li></ul><aside class=\"admonition note\"><p>The task definition details are validated at startup. If errors are found, a toast provides the details and the affected task definition is ignored.</p></aside><h2>Reordering task states</h2><p>To change the order in which task states appear in the UI and when cycling through them with the keyboard, simply reorder the states in the side pane (or tree panel, if it's the case).</p><h2>Deleting task states</h2><p>Any task state other than \"None\" and \"Done\" can be deleted.</p><p>Once deleted, to-do items using that state will no longer display the custom checkbox. They fall back to either a \"None\" or \"Done\" state, depending on the state's \"Counts as completed\" setting. The identifier and title remain stored in the note until you set the checkbox to a new state.</p><h2>Transferring notes with custom task states between Trilium database instances</h2><p>Exporting notes to another Trilium database instance preserves the task states of to-do items, but does not include the custom task definitions. As a result, the destination instance won't know how to render the checkbox unless you recreate the task state there with the same identifier and Markdown symbol.</p><aside class=\"admonition note\"><p>This is a known limitation of the current version. If there is enough interest in the community for transferring notes between Trilium database instances more easily, the Trilium team may consider a better state definition mechanism.</p></aside>",
++ "_help_J5Ex1ZrMbyJ6": "<p>Trilium provides a mechanism for <a href=\"#root/_help_CdNpE2pqjmI6\">scripts</a> to open a public REST endpoint. This opens a way for various integrations with other services - a simple example would be creating new note from Slack by issuing a slash command (e.g. <code>/trilium buy milk</code>).</p><h2>Create note from outside Trilium</h2><p>Let's take a look at an example. The goal is to provide a REST endpoint to which we can send title and content and Trilium will create a note.</p><p>We'll start with creating a JavaScript backend <a href=\"#root/_help_6f9hih2hXXZk\">code note</a> containing:</p><pre><code class=\"language-text-x-trilium-auto\">const {req, res} = api;\nconst {secret, title, content} = req.body;\n\nif (req.method == 'POST' &amp;&amp; secret === 'secret-password') {\n // notes must be saved somewhere in the tree hierarchy specified by a parent note. \n // This is defined by a relation from this code note to the \"target\" parent note\n // alternatively you can just use constant noteId for simplicity (get that from \"Note Info\" dialog of the desired parent note)\n const targetParentNoteId = api.currentNote.getRelationValue('targetNote');\n \n const {note} = api.createTextNote(targetParentNoteId, title, content);\n const notePojo = note.getPojo();\n\n res.status(201).json(notePojo);\n}\nelse {\n res.send(400);\n}</code></pre><p>This script note has also following two attributes:</p><ul><li>label <code>#customRequestHandler</code> with value <code>create-note</code></li><li>relation <code>~targetNote</code> pointing to a note where new notes should be saved</li></ul><h3>Explanation</h3><p>Let's test this by using an HTTP client to send a request:</p><pre><code class=\"language-text-x-trilium-auto\">POST http://your-trilium-server/custom/create-note\nContent-Type: application/json\n\n{\n \"secret\": \"secret-password\",\n \"title\": \"hello\",\n \"content\": \"world\"\n}+++++++++++++++++++++++++++++++++++++++++++++++</code></pre><p>Notice the <code>/custom</code> part in the request path - Trilium considers any request with this prefix as \"custom\" and tries to find a matching handler by looking at all notes which have <code>customRequestHandler</code> <a href=\"#root/_help_zEY4DaJG4YT5\">label</a>. Value of this label then contains a regular expression which will match the request path (in our case trivial regex \"create-note\").</p><p>Trilium will then find our code note created above and execute it. <code>api.req</code>, <code>api.res</code> are set to <a href=\"https://expressjs.com/en/api.html#req\">request</a> and <a href=\"https://expressjs.com/en/api.html#res\">response</a>objects from which we can get details of the request and also respond.</p><p>In the code note we check the request method and then use trivial authentication - keep in mind that these endpoints are by default totally unauthenticated, and you need to take care of this yourself.</p><p>Once we pass these checks we will just create the desired note using <a href=\"#root/_help_GLks18SNjxmC\">Script API</a>.</p><h2>Custom resource provider</h2><p>Another common use case is that you want to just expose a file note - in such case you create label <code>customResourceProvider</code> (value is again path regex).</p><p>For more information, see&nbsp;<a href=\"#root/_help_d3fAXQ2diepH\">Custom Resource Providers</a>.</p><h2>Advanced concepts</h2><p><code>api.req</code> and <code>api.res</code> are Express.js objects - you can always look into its <a href=\"https://expressjs.com/en/api.html\">documentation</a> for details.</p><h3>Parameters</h3><p>REST request paths often contain parameters in the URL, e.g.:</p><pre><code class=\"language-text-x-trilium-auto\">http://your-trilium-server/custom/notes/123</code></pre><p>The last part is dynamic so the matching of the URL must also be dynamic - for this reason the matching is done with regular expressions. Following <code>customRequestHandler</code> value would match it:</p><pre><code class=\"language-text-x-trilium-auto\">notes/([0-9]+)</code></pre><p>Additionally, this also defines a matching group with the use of parenthesis which then makes it easier to extract the value. The matched groups are available in <code>api.pathParams</code>:</p><pre><code class=\"language-text-x-trilium-auto\">const noteId = api.pathParams[0];</code></pre><p>Often you also need query params (as in e.g. <code>http://your-trilium-server/custom/notes?noteId=123</code>), you can get those with standard express <code>req.query.noteId</code>.</p>",
++ "_help_d3fAXQ2diepH": "<p>A custom resource provider allows any file imported into Trilium (images, fonts, stylesheets) to be publicly accessible via a URL.</p><p>A potential use case for this is to add embed a custom font alongside a theme.</p><h2>Steps for creating a custom resource provider</h2><ol><li>Import a file such as an image or a font into Trilium by drag &amp; drop.</li><li>Set the <a href=\"#root/_help_HI6GBBIduIgv\">label</a> <code>#customResourceProvider</code> to <code>hello</code>.</li><li>To test if it is working, use a browser to navigate to <code>&lt;protocol&gt;://&lt;host&gt;/custom/hello</code> (where <code>&lt;protocol&gt;</code> is either <code>http</code> or <code>https</code> based on your setup, and <code>&lt;host&gt;</code> is the host or IP to your Trilium server instance). If you are running the TriliumNext application without a server, use <code>http://localhost:37840</code> as the base URL.</li><li>If everything went well, at the previous step the browser should have downloaded the file uploaded in the first step.</li></ol><p>Instead of <code>hello</code>, the name can be:</p><ul><li>A path, such as <code>fonts/Roboto.ttf</code>, which would be accessible via <code>&lt;host&gt;/custom/fonts/Roboto.ttf</code>.</li><li>As a more advanced use case, a regular expression to match multiple routes, such as <code>hello/.*</code> which will be accessible via <code>/custom/hello/1</code>, <code>/custom/hello/2</code>, <code>/custom/hello/world</code>, etc.</li></ul><h2>Using it in a theme</h2><p>For example, if you have a custom font to be imported by the theme, first upload a font file into Trilium and assign it the <code>#customResourceProvider=fonts/myfont.ttf</code> attribute.</p><p>Then modify the theme CSS to point to:</p><pre><code class=\"language-text-css\">@font-face {\n\tfont-family: customFont;\n\tsrc: url(\"/custom/fonts/myfont.ttf\");\n}\n\ndiv {\n\tfont-family: customFont;\n}</code></pre>",
++ "_help_pgxEVkzLl1OP": "<aside class=\"admonition tip\"><p>For a quick start, consult the&nbsp;<a class=\"reference-link\" href=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/ETAPI%20(REST%20API)/API%20Reference.dat\">API Reference</a>.</p></aside><p>ETAPI is Trilium's public/external REST API. It is available since Trilium v0.50.</p><h2>API clients</h2><p>As an alternative to calling the API directly, there are client libraries to simplify this</p><ul><li><a href=\"https://github.com/Nriver/trilium-py\">trilium-py</a>, you can use Python to communicate with Trilium.</li></ul><h2>Obtaining a token</h2><p>All operations with the REST API have to be authenticated using a token. You can get this token either from Options -&gt; ETAPI or programmatically using the <code>/auth/login</code> REST call (see the <a href=\"https://github.com/TriliumNext/Trilium/blob/master/src/etapi/etapi.openapi.yaml\">spec</a>).</p><h2>Authentication</h2><h3>Via the <code>Authorization</code> header</h3><pre><code class=\"language-text-x-trilium-auto\">GET https://myserver.com/etapi/app-info\nAuthorization: ETAPITOKEN</code></pre><p>where <code>ETAPITOKEN</code> is the token obtained in the previous step.</p><p>For compatibility with various tools, it's also possible to specify the value of the <code>Authorization</code> header in the format <code>Bearer ETAPITOKEN</code> (since 0.93.0).</p><h3>Basic authentication</h3><p>Since v0.56 you can also use basic auth format:</p><pre><code class=\"language-text-x-trilium-auto\">GET https://myserver.com/etapi/app-info\nAuthorization: Basic BATOKEN</code></pre><ul><li>Where <code>BATOKEN = BASE64(username + ':' + password)</code> - this is a standard Basic Auth serialization</li><li>Where <code>username</code> is \"etapi\"</li><li>And <code>password</code> is the generated ETAPI token described above.</li></ul><p>Basic Auth is meant to be used with tools which support only basic auth.</p><h2>Interaction using Bash scripts</h2><p>It is possible to write simple Bash scripts to interact with Trilium. As an example, here's how to obtain the HTML content of a note:</p><pre><code class=\"language-text-x-trilium-auto\">#!/usr/bin/env bash\n\n# Configuration\nTOKEN=z1vA4fkGxjOR_ZXLrZeqHEFOv65yV3882iFCRtNIK9k9iWrHliITNSLQ=\nSERVER=http://localhost:8080\n\n# Download a note by ID\nNOTE_ID=\"i6ra4ZshJhgN\"\ncurl \"$SERVER/etapi/notes/$NOTE_ID/content\" -H \"Authorization: $TOKEN\" </code></pre><p>Make sure to replace the values of:</p><ul><li><code>TOKEN</code> with your ETAPI token.</li><li><code>SERVER</code> with the correct protocol, host name and port to your Trilium instance.</li><li><code>NOTE_ID</code> with an existing note ID to download.</li></ul><p>As another example, to obtain a .zip export of a note and place it in a directory called <code>out</code>, simply replace the last statement in the script with:</p><pre><code class=\"language-text-x-trilium-auto\">curl -H \"Authorization: $TOKEN\" \\\n\t-X GET \"$SERVER/etapi/notes/$NOTE_ID/export\" \\\n --output \"out/$NOTE_ID.zip\"</code></pre><h2>Uploading binary content</h2><p>A JSON request body can only carry text, so the <code>content</code> field of <code>POST /etapi/attachments</code> stores exactly the string it receives. To upload an image, a PDF or any other binary file, send the raw bytes to the content endpoint with the <code>application/octet-stream</code> content type. The same applies to the content of a note (<code>PUT /etapi/notes/{noteId}/content</code>).</p><p>To attach a file to a note, create the attachment without content, then upload the file to it:</p><pre><code class=\"language-text-x-trilium-auto\">ATTACHMENT_ID=$(curl -s -X POST \"$SERVER/etapi/attachments\" \\\n -H \"Authorization: $TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d \"{\\\"ownerId\\\": \\\"$NOTE_ID\\\", \\\"role\\\": \\\"file\\\", \\\"mime\\\": \\\"application/pdf\\\", \\\"title\\\": \\\"report.pdf\\\", \\\"position\\\": 10}\" \\\n | jq -r .attachmentId)\n\ncurl -X PUT \"$SERVER/etapi/attachments/$ATTACHMENT_ID/content\" \\\n -H \"Authorization: $TOKEN\" \\\n -H \"Content-Type: application/octet-stream\" \\\n --data-binary @report.pdf</code></pre><p>Use <code>--data-binary</code> rather than <code>-d</code>, which strips line breaks from the file. For an image, set <code>role</code> to <code>image</code> and <code>mime</code> to the image's type, such as <code>image/png</code>.</p>",
++ "_help_47ZrP6FNuoG8": "<p>When a new note is created, its name is by default \"new note\". In some cases, it can be desirable to have a different or even a dynamic default note title.</p><p>For this use case, Trilium (since v0.52) supports <code>#titleTemplate</code> <a href=\"#root/_help_zEY4DaJG4YT5\">label</a>. You can create such a label for a given note, assign it a value, and this value will be used as a default title when creating child notes. As with other labels, you can make it inheritable to apply recursively, and you can even place it on the root note to have it applied globally everywhere.</p><p>As an example use case, imagine you collect books you've read in a given year like this:</p><ul><li>2022 Books<ul><li>Neal Stephenson: Anathem, 2008</li><li>Franz Kafka: Die Verwandlung, 1915</li></ul></li></ul><p>Now, to the parent note \"2022 Books\" you can assign label <code>#titleTemplate=\"[Author name]: [Book title], [Publication year]\"</code>.</p><p>And all children of \"2022 Books\" will be created with initial title \"[Author name]: [Book title], [Publication year]\". There's no artificial intelligence here, the idea is to just prompt you to manually fill in the pieces of information into the note title by yourself.</p><h2>Dynamic value</h2><p>The value of <code>#titleTemplate</code> is evaluated at the point of note's creation as a JavaScript string, which means it can be enriched with the help of JS string interpolation with dynamic data.</p><p>Second variable injected is <code>parentNote</code> which gives access to the parent <a href=\"{{helpAssets}}/User%20Guide/Scripting/Script%20API/Frontend%20API/FNote.dat\"><code>FNote</code></a>.</p><p>See also&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>&nbsp;which provides similar capabilities, including default note's content.</p><h3>Examples</h3><ul><li>Imagine you collect server outage incidents and write some notes. It looks like this:<ul><li>Incidents<ul><li>2022-05-09: System crash</li><li>2022-05-15: Backup delay</li></ul></li><li>You can automatize the date assignment by assigning a label <code>#titleTemplate=\"${now.format('YYYY-MM-DD')}: \"</code> to the parent note \"Incidents\". Whenever a new child note is created, the title template is evaluated with the injected <a href=\"https://day.js.org/docs/en/display/format\">now</a> object.</li></ul></li><li>To use a parent's attribute in the title of new notes: <code>#titleTemplate=\"${parentNote.getLabelValue('authorName')}'s literary works\"</code></li><li>To mirror the parent's note title: <code>${parentNote.title}</code></li></ul>",
++ "_help_wX4HbRucYSDD": "<p>Your Trilium data is stored in a <a href=\"https://www.sqlite.org\">SQLite</a> database which contains all notes, tree structure, metadata, and most of the configuration. The database file is named <code>document.db</code> and is stored in the application's default&nbsp;<a href=\"#root/_help_tAassRL4RSQL\">Data directory</a>.</p><h2>Demo Notes</h2><p>When first starting Trilium, it will provide a set of notes to showcase various features of the application.</p><p>For more information see&nbsp;<a class=\"reference-link\" href=\"#root/_help_6tZeKvSHEUiB\">Demo Notes</a>.</p><h2>Manually Modifying the Database</h2><p>Trilium provides a lot of flexibility, and with it, opportunities for advanced users to tweak it. If you need to explore or modify the database directly, you can use a tool such as <a href=\"https://sqlitebrowser.org/\">SQLite Browser</a> to work directly on the database file.</p><p>See&nbsp;<a href=\"#root/_help_oyIAJ9PvvwHX\">Manually altering the database</a>&nbsp;for more information.</p><h2>How to Reset the Database</h2><p>If you want to start again and:</p><ul><li>Create and switch to a new blank knowledge base</li><li>Use a different knowledge base synced from a server or desktop application</li><li>Restore a backup</li></ul><p>You can navigate to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Database</em> and click the <em>Start over</em> button. You'll be prompted to restart the application, with the option to back up your current database before proceeding.</p><aside class=\"admonition important\"><p>For the web client, Trilium cannot restart automatically. You'll need to manually restart the server/container and then reload the web application.</p></aside><p>After restarting, the setup screen will appear. You can choose to back up your existing database, then proceed with the setup menu as if it's a new installation. The existing database will only be overwritten after selecting to create a new database, sync with a server, or restore from a backup.</p><h3>The Legacy Method</h3><p>If you are experimenting with Trilium and want to return it to its original state, you can do that by deleting the current database. When you restart the application, it will generate a new database containing the original demo notes.</p><p>To delete the database, simply go to the <a href=\"#root/_help_tAassRL4RSQL\">data directory</a> and delete the <code>document.db</code> file (and any other files starting with <code>document.db</code>).</p><p>If you do not need to preserve any configurations that might be stored in the <code>config.ini</code> file, you can just delete all of the <a href=\"#root/_help_tAassRL4RSQL\">data directory's</a> contents to fully restore the application to its original state. You can also review the <a href=\"#root/_help_Gzjqa934BdH4\">configuration</a> file to provide all <code>config.ini</code> values as environment variables instead.</p>",
++ "_help_oyIAJ9PvvwHX": "<p>There are some situations where modifying the SQLite database that Trilium uses is desirable.</p><p>If you are doing any advanced development or troubleshooting where you manually modify the database, you might want to consider creating backups of your <code>document.db</code> file.</p><h2>Modifying it internally using the SQL Console</h2><p>The SQL Console is Trilium's built-in database editor.</p><p>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_YKWqdJhzi2VY\">SQL Console</a>.</p><h2>Externally modifying the database</h2><p>Sometimes the SQL Console cannot be used (for example if the application cannot start).</p><p>When making external modifications, consider closing the desktop application. If modifying the server database, then stop the service or Docker container.</p><h3>Using DB Browser for SQLite</h3><p>DB Browser for SQLite is a cross-platform editor that can be used to alter the database using a graphical user interface.</p><p>To do so:</p><ol><li>In the main menu, select File → Open database… and navigate to the database in the&nbsp;<a href=\"#root/_help_tAassRL4RSQL\">Data directory</a>.</li><li>Select the <em>Execute SQL</em> tab.</li><li>Type in the desired SQL statement.</li><li>Press the \"Play\" button in the toolbar underneath the \"Execute SQL\" tab (or F5 key).</li><li>Press \"Write Changes\" in the main toolbar.</li><li>Close the application or close the database.</li></ol><p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Database/Manually%20altering%20the%20database_image.jpg\"></p><h3>Using the SQLite CLI</h3><p>First, start the SQLite 3 CLI by specifying the path to the database:</p><pre><code class=\"language-text-x-trilium-auto\">sqlite3 ~/.local/share/trilium-data/document.db</code></pre><ul><li>In the prompt simply type the statement and make sure it ends with a <code>;</code> character.</li><li>To exit, simply type <code>.quit</code> and enter.</li></ul>",
++ "_help_YKWqdJhzi2VY": "<aside class=\"admonition important\"><p>Starting with v0.104.0, backend scripts are disabled by default to reduce the attack surface. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_fiHicjpHjIRJ\">Security</a>&nbsp;for more information.</p></aside><p>The SQL Console is Trilium's built-in database editor.</p><p>It can be accessed by going to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;→ Advanced → Open SQL Console.</p><p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Database/Manually%20altering%20the%20database/SQL%20Console_image.jpg\"></p><h3>Interaction</h3><ul><li>Hovering the mouse over one of the tables listed at the top of the document will show the columns and their data type.</li><li>Only one SQL statement can be run at once.</li><li>To run the statement, press the <em>Execute</em> icon.</li><li>For queries that return a result, the data will displayed in a table.</li><li>For statements (e.g. <code>INSERT</code>, <code>UPDATE</code>), the number of affected rows is displayed.</li></ul><figure class=\"image\"><img style=\"aspect-ratio:1124/571;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Database/Manually%20altering%20the%20database/SQL%20Console_image.png\" width=\"1124\" height=\"571\"></figure><h3>Interacting with the table</h3><p>After executing a query, a table with the results will be displayed:</p><ul><li>Clicking on a column allows sorting ascending or descending.</li><li>Underneath each column there is an input field which allows filtering by text.</li><li>Press <kbd>Ctrl</kbd>+<kbd>C</kbd> to copy the current cell to clipboard.</li><li>Multiple cells can be selected by dragging or by holding <kbd>Shift</kbd> + arrow keys</li><li>Results are paginated for performance reasons. The controls at the bottom of the table can be used to navigate through pages.</li></ul><h3>Saved SQL console</h3><p>SQL queries or commands can be saved into a dedicated note.</p><p>To do so, simply write the query and press the&nbsp;<span class=\"tn-icon bx bx-save\"></span> button. Once saved, the note will appear in&nbsp;<a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a>&nbsp;by default. It is possible to change the default location of saved queries by assigning a <code>#sqlConsoleHome</code> <a href=\"#root/_help_HI6GBBIduIgv\">label</a>.</p><p>The note can be locked for editing by pressing the <em>Lock</em> button in the note actions section near the title bar. When editing is locked, the SQL statement is hidden from view.</p>",
++ "_help_6tZeKvSHEUiB": "<p>When you run Trilium for the first time, it will generate a new database containing demo notes. These notes showcase its many features, such as:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_iRwzGnHPzonm\">Relation Map</a></li><li><a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a></li><li><a class=\"reference-link\" href=\"#root/_help_R7abl2fc6Mxi\">Weight Tracker</a></li><li><a class=\"reference-link\" href=\"#root/_help_xYjQUYhpbUEW\">Task Manager</a></li><li><a class=\"reference-link\" href=\"#root/_help_Wy267RK4M69c\">Themes</a></li></ul><h3>Restoring Demo Notes</h3><p>There are some cases in which you may want to restore the original demo notes. For example, if you experimented with some of the more advanced features and want to see the original reference, or if you simply want to explore the latest version of the demo notes, which might showcase new features.</p><p>You can easily restore the demo notes by using Trilium's built-in import feature by importing them:</p><ul><li>Download <a href=\"https://github.com/TriliumNext/Trilium/raw/refs/heads/main/apps/server/src/assets/db/demo.zip\">the .zip archive</a> with the latest version of the demo notes</li><li>Right click on any note in your tree under which you would like the demo notes to be imported</li><li>Click \"Import into note…\"</li><li>Select the .zip archive to import it</li></ul>",
++ "_help_Gzjqa934BdH4": "<p>Trilium supports configuration via a file named <code>config.ini</code> and environment variables. This document provides a comprehensive reference for all configuration options.</p><h2>Location of the configuration file</h2><p>The configuration file is not located in the same directory as the application. Instead, the <code>config.ini</code> is located in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_tAassRL4RSQL\">Data directory</a>. As such, the configuration file is only available after starting the application and creating a database.</p><h2>Configuration Precedence</h2><p>Configuration values are loaded in the following order of precedence (highest to lowest):</p><ol><li><strong>Environment variables</strong> (checked first)</li><li><strong>config.ini file values</strong></li><li><strong>Default values</strong></li></ol><h2>Environment Variable Patterns</h2><p>Trilium supports multiple environment variable patterns for flexibility. The primary pattern is: <code>TRILIUM_[SECTION]_[KEY]</code></p><p>Where:</p><ul><li><code>SECTION</code> is the INI section name in UPPERCASE</li><li><code>KEY</code> is the camelCase configuration key converted to UPPERCASE (e.g., <code>instanceName</code> → <code>INSTANCENAME</code>)</li></ul><p>Additionally, shorter aliases are available for common configurations (see Alternative Variables section below).</p><h2>Environment Variable Reference</h2><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">General</p><div class=\"trilium-tab-panel\"><figure class=\"table\"><table><thead><tr><th>Environment Variable</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>TRILIUM_GENERAL_INSTANCENAME</code></td><td>string</td><td>\"\"</td><td>Instance name for API identification</td></tr><tr><td><code>TRILIUM_GENERAL_NOAUTHENTICATION</code></td><td>boolean</td><td>false</td><td>Disable authentication (server only)</td></tr><tr><td><code>TRILIUM_GENERAL_NOBACKUP</code></td><td>boolean</td><td>false</td><td>Disable automatic backups</td></tr><tr><td><code>TRILIUM_GENERAL_NODESKTOPICON</code></td><td>boolean</td><td>false</td><td>Disable desktop icon creation</td></tr><tr><td><code>TRILIUM_GENERAL_READONLY</code></td><td>boolean</td><td>false</td><td>Enable read-only mode</td></tr></tbody></table></figure></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Network</p><div class=\"trilium-tab-panel\"><figure class=\"table\"><table><thead><tr><th>Environment Variable</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>TRILIUM_NETWORK_HOST</code></td><td>string</td><td>\"0.0.0.0\"</td><td>Server host binding</td></tr><tr><td><code>TRILIUM_NETWORK_PORT</code></td><td>string</td><td>\"8080\"</td><td>Server port</td></tr><tr><td><code>TRILIUM_NETWORK_HTTPS</code></td><td>boolean</td><td>false</td><td>Enable HTTPS</td></tr><tr><td><code>TRILIUM_NETWORK_CERTPATH</code></td><td>string</td><td>\"\"</td><td>SSL certificate path</td></tr><tr><td><code>TRILIUM_NETWORK_KEYPATH</code></td><td>string</td><td>\"\"</td><td>SSL key path</td></tr><tr><td><code>TRILIUM_NETWORK_TRUSTEDREVERSEPROXY</code></td><td>boolean/string</td><td>false</td><td>Reverse proxy trust settings</td></tr><tr><td><code>TRILIUM_NETWORK_CORSALLOWORIGIN</code></td><td>string</td><td>\"\"</td><td>CORS allowed origins</td></tr><tr><td><code>TRILIUM_NETWORK_CORSALLOWMETHODS</code></td><td>string</td><td>\"\"</td><td>CORS allowed methods</td></tr><tr><td><code>TRILIUM_NETWORK_CORSALLOWHEADERS</code></td><td>string</td><td>\"\"</td><td>CORS allowed headers</td></tr><tr><td><code>TRILIUM_NETWORK_CORSRESOURCEPOLICY</code></td><td>string</td><td>same-origin</td><td>CORS Resource Policy allows same-origin/same-site/cross-origin as values, will error if not</td></tr></tbody></table></figure></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Session</p><div class=\"trilium-tab-panel\"><figure class=\"table\"><table><thead><tr><th>Environment Variable</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>TRILIUM_SESSION_COOKIEMAXAGE</code></td><td>integer</td><td>1814400</td><td>Session cookie max age in seconds (21 days)</td></tr></tbody></table></figure></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Sync</p><div class=\"trilium-tab-panel\"><figure class=\"table\"><table><thead><tr><th>Environment Variable</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>TRILIUM_SYNC_SYNCSERVERHOST</code></td><td>string</td><td>\"\"</td><td>Sync server host URL</td></tr><tr><td><code>TRILIUM_SYNC_SYNCSERVERTIMEOUT</code></td><td>string</td><td>\"120000\"</td><td>Sync server timeout in milliseconds</td></tr><tr><td><code>TRILIUM_SYNC_SYNCPROXY</code></td><td>string</td><td>\"\"</td><td>Sync proxy URL</td></tr></tbody></table></figure></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">MultiFactorAuthentication</p><div class=\"trilium-tab-panel\"><p>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_x1lQNKQBqLcA\">Signing in with OpenID Connect</a>.</p></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Logging</p><div class=\"trilium-tab-panel\"><figure class=\"table\"><table><thead><tr><th>Environment Variable</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>TRILIUM_LOGGING_RETENTIONDAYS</code></td><td>integer</td><td>90</td><td>Number of days to retain log files</td></tr></tbody></table></figure></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Development</p><div class=\"trilium-tab-panel\"><figure class=\"table\"><table><thead><tr><th>Environment Variable</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>TRILIUM_MANUAL_DB_MIGRATION</code></td><td>boolean</td><td>false</td><td>If <code>true</code>, the application will not start if automatic database migrations are pending and would modify the database schema.</td></tr></tbody></table></figure></div></section></div><details class=\"trilium-collapsible\"><summary>Alternative environment variables</summary><p>The following alternative environment variable names are also supported and work identically to their longer counterparts.</p><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Network CORS</p><div class=\"trilium-tab-panel\"><ul><li><code>TRILIUM_NETWORK_CORS_ALLOW_ORIGIN</code> (alternative to <code>TRILIUM_NETWORK_CORSALLOWORIGIN</code>)</li><li><code>TRILIUM_NETWORK_CORS_ALLOW_METHODS</code> (alternative to <code>TRILIUM_NETWORK_CORSALLOWMETHODS</code>)</li><li><code>TRILIUM_NETWORK_CORS_ALLOW_HEADERS</code> (alternative to <code>TRILIUM_NETWORK_CORSALLOWHEADERS</code>)</li><li><code>TRILIUM_NETWORK_CORS_RESOURCE_POLICY</code> (alternative to <code>TRILIUM_NETWORK_CORSRESOURCEPOLICY</code>)</li></ul></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Sync</p><div class=\"trilium-tab-panel\"><ul><li><code>TRILIUM_SYNC_SERVER_HOST</code> (alternative to <code>TRILIUM_SYNC_SYNCSERVERHOST</code>)</li><li><code>TRILIUM_SYNC_SERVER_TIMEOUT</code> (alternative to <code>TRILIUM_SYNC_SYNCSERVERTIMEOUT</code>)</li><li><code>TRILIUM_SYNC_SERVER_PROXY</code> (alternative to <code>TRILIUM_SYNC_SYNCPROXY</code>)</li></ul></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">OAuth/MFA</p><div class=\"trilium-tab-panel\"><ul><li><code>TRILIUM_OAUTH_BASE_URL</code> (alternative to <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHBASEURL</code>)</li><li><code>TRILIUM_OAUTH_CLIENT_ID</code> (alternative to <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTID</code>)</li><li><code>TRILIUM_OAUTH_CLIENT_SECRET</code> (alternative to <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTSECRET</code>)</li><li><code>TRILIUM_OAUTH_ISSUER_BASE_URL</code> (alternative to <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERBASEURL</code>)</li><li><code>TRILIUM_OAUTH_ISSUER_NAME</code> (alternative to <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERNAME</code>)</li><li><code>TRILIUM_OAUTH_ISSUER_ICON</code> (alternative to <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERICON</code>)</li><li><code>TRILIUM_OAUTH_HTTP_TIMEOUT</code> (alternative to <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHHTTPTIMEOUT</code>)</li><li><code>TRILIUM_OAUTH_SCOPE</code> (alternative to <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHSCOPE</code>)</li></ul></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Logging</p><div class=\"trilium-tab-panel\"><ul><li><code>TRILIUM_LOGGING_RETENTION_DAYS</code> (alternative to <code>TRILIUM_LOGGING_RETENTIONDAYS</code>)</li></ul></div></section></div></details><h2>Boolean Values</h2><p>Boolean environment variables accept the following values:</p><ul><li><strong>True</strong>: <code>\"true\"</code>, <code>\"1\"</code>, <code>1</code></li><li><strong>False</strong>: <code>\"false\"</code>, <code>\"0\"</code>, <code>0</code></li><li>Any other value defaults to <code>false</code></li></ul><h2>Using Environment Variables</h2><p>Both naming patterns are fully supported and can be used interchangeably:</p><ul><li>The longer format follows the section/key pattern for consistency with the INI file structure</li><li>The shorter alternatives provide convenience for common configurations</li><li>You can use whichever format you prefer - both are equally valid</li></ul><h2>Examples</h2><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-docker\"></span>&nbsp;Docker Compose</p><div class=\"trilium-tab-panel\"><pre><code class=\"language-text-x-yaml\">services:\n trilium:\n image: triliumnext/trilium\n environment:\n # Using full format\n TRILIUM_GENERAL_INSTANCENAME: \"My Trilium Instance\"\n TRILIUM_NETWORK_PORT: \"8080\"\n TRILIUM_NETWORK_CORSALLOWORIGIN: \"https://myapp.com\"\n TRILIUM_SYNC_SYNCSERVERHOST: \"https://sync.example.com\"\n TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHBASEURL: \"https://auth.example.com\"\n \n # Or using shorter alternatives (equally valid)\n # TRILIUM_NETWORK_CORS_ALLOW_ORIGIN: \"https://myapp.com\"\n # TRILIUM_SYNC_SERVER_HOST: \"https://sync.example.com\"\n # TRILIUM_OAUTH_BASE_URL: \"https://auth.example.com\"</code></pre></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-tux\"></span>&nbsp;Linux Shell</p><div class=\"trilium-tab-panel\"><pre><code class=\"language-text-x-trilium-auto\"># Using either format\nexport TRILIUM_GENERAL_NOAUTHENTICATION=false\nexport TRILIUM_NETWORK_HTTPS=true\nexport TRILIUM_NETWORK_CERTPATH=/path/to/cert.pem\nexport TRILIUM_NETWORK_KEYPATH=/path/to/key.pem\nexport TRILIUM_LOGGING_RETENTIONDAYS=30\n\n# Start Trilium\nnpm start</code></pre></div></section></div><h2>config.ini Reference</h2><p>For the complete list of configuration options and their INI file format, please review the <a href=\"https://github.com/TriliumNext/Trilium/blob/main/apps/server/src/assets/config-sample.ini\">config-sample.ini</a> file in the Trilium repository.</p>",
++ "_help_c5xB8m4g2IY6": "<p>A Trilium instance represents a server. If&nbsp;<a class=\"reference-link\" href=\"#root/_help_cbkrhQjrkKrh\">Synchronization</a>&nbsp;is set up, since multiple servers are involved (the one from the desktop client and the one the synchronisation is set up with), sometimes it can be useful to distinguish the instance you are running on.</p><h2>Setting the instance name</h2><p>To set up a name for the instance, modify the <code>config.ini</code>:</p><pre><code class=\"language-text-x-trilium-auto\">[General]\ninstanceName=Hello</code></pre><h2>Distinguishing the instance on back-end</h2><p>Use <code>api.getInstanceName()</code> to obtain the instance name of the current server, as specified in the config file or in environment variables.</p><h2>Limiting script runs based on instance</h2><p>For a script that is run periodically or on a certain event, it's possible to limit it to certain instances without having to change the code. Just add <code>runOnInstance</code> and set as the value the instance name where the script should run. To run on multiple named instances, simply add the label multiple times.</p>",
++ "_help_LWtBjFej3wX3": "<p>By default, Trilium cannot be accessed in web browsers by requests coming from other domains/origins than Trilium itself.&nbsp;</p><p>However, it is possible to manually configure <a href=\"https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/CORS\">Cross-Origin Resource Sharing (CORS)</a> since Trilium v0.93.0 using environment variables or <code>config.ini</code>, as follows:</p><figure class=\"table\"><table><thead><tr><th>CORS Header</th><th>Corresponding environment variable</th><th>Corresponding option in <code>config.ini</code> variables in the <code>Network</code> section</th></tr></thead><tbody><tr><td><code>Access-Control-Allow-Origin</code></td><td><code>TRILIUM_NETWORK_CORS_ALLOW_ORIGIN</code></td><td><code>corsAllowOrigin</code></td></tr><tr><td><code>Access-Control-Allow-Methods</code></td><td><code>TRILIUM_NETWORK_CORS_ALLOW_METHODS</code></td><td><code>corsAllowMethods</code></td></tr><tr><td><code>Access-Control-Allow-Headers</code></td><td><code>TRILIUM_NETWORK_CORS_ALLOW_HEADERS</code></td><td><code>corsAllowHeaders</code></td></tr></tbody></table></figure>",
++ "_help_ivYnonVFBxbQ": "<figure class=\"image\"><img style=\"aspect-ratio:1425/644;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Bulk%20Actions_image.png\" width=\"1425\" height=\"644\"></figure><p>The <em>Bulk Actions</em> dialog makes it easy to apply changes to multiple notes at once, ranging from simple actions such as adding or removing a label to being executing custom scripts.</p><h2>Interaction</h2><ul><li>The first step is to select the notes in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>. It's possible to apply bulk actions to:<ul><li>A single note (and potentially its child notes) simply by clicking on it (with a left click or a right click).</li><li>Multiple notes. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_yTjUdsOi4CIE\">Multiple selection</a>&nbsp;on how to do so.</li></ul></li><li>Right click in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;and select <em>Advanced</em> → <em>Apply bulk actions</em>.</li><li>The <em>Selected notes</em> section at the top of the dialog lists the notes the actions apply to. When many notes are selected, only the first few are shown; click <em>+N more</em> to show the rest.<ul><li>To leave a note out without changing the selection in the note tree, press the <span class=\"tn-icon bx bx-x\"></span> button on its entry. The last remaining note cannot be removed.</li></ul></li><li>By default, only the selected notes will be affected. To also include all the descendants of the notes, turn on <em>Include descendants of the selected notes</em>. The number of affected notes, shown below that option, updates to reflect the change.</li><li>To add an action, click <em>Add action</em> (<span class=\"tn-icon bx bx-plus\"></span>) at the bottom of the <em>Chosen actions</em> section and pick one from the menu. Hovering over an entry shows a short description of what it does; a detailed description of each is available in the next section.<ul><li>Each chosen action appears as an entry in the <em>Chosen actions</em> section, with its own configuration.</li><li>To remove an action, simply press the <span class=\"tn-icon bx bx-x\"></span> button to the right of it.</li><li>It is possible to apply multiple actions of the same type, such as adding multiple types.</li><li>The fields for a label or relation name suggest the names already used in the database as you type, marking the ones Trilium itself attaches a meaning to.</li><li>The value field of <em>Add label</em> and <em>Update label value</em> suggests the values the named label already has in the database.</li></ul></li><li>When all the actions are defined, press the <em>Apply to N notes</em> button to trigger all of them at once. The button names the number of notes that will be affected, and stays disabled until at least one action is added.<ul><li>If an action is missing a field it needs, such as the name of the label to rename, the dialog does not run and points out the empty field instead.</li></ul></li><li>For convenience, the last bulk action configuration is saved for further use and will be restored when entering the dialog again.</li></ul><h2>Actions</h2><h3>Labels</h3><p>These actions operate the&nbsp;<a class=\"reference-link\" href=\"#root/_help_HI6GBBIduIgv\">Labels</a>&nbsp;of a note. Except for <em>Add label</em>, they only affect labels set directly on the note; inherited labels are left unchanged.</p><ul><li><strong>Add label</strong><ul><li>For each note, it creates a <a href=\"#root/_help_HI6GBBIduIgv\">label</a> of the given name. Keep the <em>New value</em> field empty to create a label without a value, or complete it to assign a value.</li><li>The label is added even if the note already has one of the same name, so the note ends up with both. To change the value of an existing label instead, use <em>Update label value</em>.</li></ul></li><li><strong>Update label value</strong><ul><li>For each note, if it has a <a href=\"#root/_help_HI6GBBIduIgv\">label</a> of the given name, it will change its value to the specified one. Leave <em>New value</em> field empty to create a label without a value.</li><li>Notes without the label will not be affected.</li></ul></li><li><em><strong>Rename label</strong></em><ul><li>For each note, if it has a <a href=\"#root/_help_HI6GBBIduIgv\">label</a> of the given name, it will be renamed/replaced with a label of the new name. The value of the label (if present) will be kept intact.</li><li>Notes without the label will not be affected.</li></ul></li><li><strong>Delete label</strong><ul><li>For each note, if it has a label of a given name, it will be deleted (regardless of whether it has a value or not).</li><li>Notes without the label will not be affected.</li></ul></li></ul><h3>Relations</h3><p>These actions operate the&nbsp;<a class=\"reference-link\" href=\"#root/_help_Cq5X6iKQop6R\">Relations</a>&nbsp;of a note. Except for <em>Add relation</em>, they only affect relations set directly on the note; inherited relations are left unchanged.</p><ul><li><strong>Add relation</strong><ul><li>For each note, it will create a relation pointing to the given note.</li><li>The relation is added even if the note already has one of the same name.</li></ul></li><li><strong>Update relation target</strong><ul><li>For each note, it will modify a relation to point to the newly given note.</li><li>Notes without this relation will not be affected.</li></ul></li><li><strong>Rename relation</strong><ul><li>For each note, if it has a relation of the given name, it will be renamed/replaced with a relation of the new name. The target note of the relation will be kept intact.</li><li>Notes without this relation will not be affected.</li></ul></li><li><strong>Delete relation</strong><ul><li>For each note, if it has a relation of the given name, it will be deleted.</li><li>Notes without this relation will not be affected.</li></ul></li></ul><h3>Notes</h3><ul><li><strong>Rename note</strong><ul><li>For each note, it will change the title of the note to the given one.</li><li>The title can contain expressions between <code>${</code> and <code>}</code>, which are filled in for each note. They can read the note's properties, such as <code>${note.title}</code>, <code>${note.noteId}</code> or <code>${note.type}</code>, and call <code>getLabelValue('name')</code>, <code>getRelationValue('name')</code> or, on a date such as <code>dateCreatedObj</code>, <code>format('…')</code>. For example:<ul><li><code>NEW: ${note.title}</code> will prefix all notes with <code>NEW:</code> .</li><li><code>${note.dateCreatedObj.format('MM-DD:')}: ${note.title}</code> will prefix the note titles with each note's creation date (in month-day format).</li></ul></li><li>Only property access and those methods are allowed, not arbitrary JavaScript. While typing, the field completes the expressions, underlines one that is not allowed and shows the resulting title for the first selected note.</li></ul></li><li><strong>Move note</strong><ul><li>For each note, it will be moved to the specified parent note.</li><li>A note with several parents is cloned to the new parent instead, since it is not clear which of its places to remove.</li><li>A note that cannot be placed there, such as a parent of the target note, stays where it is.</li><li>As an alternative for less complex situations, the notes can be moved directly from within the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;via cut → paste or via the contextual menu.</li></ul></li><li><strong>Convert note</strong><ul><li>This allows a note to be converted from one type to another:<ul><li><strong>Text Notes → Markdown Notes</strong> — each&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;note is converted to a&nbsp;<a class=\"reference-link\" href=\"#root/_help_6RM1Q7ppFVoj\">Markdown</a>&nbsp;note. Since Markdown does not support all the formatting capabilities of Text Notes, some formatting may be lost and some unsupported elements may even be dropped.</li><li><strong>Markdown Notes → Text Notes</strong> — each&nbsp;<a class=\"reference-link\" href=\"#root/_help_6RM1Q7ppFVoj\">Markdown</a>&nbsp;note is converted to a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;Note.</li></ul></li><li>For each converted note, a revision is saved automatically, allowing you to restore the original or recover any missing elements from it.</li></ul></li><li><strong>Save revision</strong><ul><li>Automatically creates a revision of each note. Optionally, a name can be assigned to this revision. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_vZWERwf8U3nx\">Note Revisions</a>.</li></ul></li><li><strong>Delete note</strong><ul><li>For each note, it will be deleted, including all of its clones and any child notes that are not cloned elsewhere.</li><li>Deleted notes can be restored from <em>Recent changes</em> until they are erased.</li><li>As an alternative for less complex situations, the notes can be removed directly from within the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;by selecting them and pressing <kbd>Delete</kbd>.</li></ul></li><li><strong>Delete note revisions</strong><ul><li>This will permanently erase all the&nbsp;<a class=\"reference-link\" href=\"#root/_help_vZWERwf8U3nx\">Note Revisions</a>&nbsp;of the notes. Unlike deleted notes, erased revisions cannot be restored.</li></ul></li></ul><h3>Others</h3><ul><li><strong>Execute script</strong><ul><li>For more complex scenarios, it is possible to type in a JavaScript expression in order to apply the necessary changes.</li><li>The script runs on the server once for each note, with that note available as <code>note</code> and the backend script API as <code>api</code>. The field completes both as you type and underlines mistakes, as the editor of a backend script note does.</li><li>Examples:<ul><li><p>To apply a suffix (<code>- suffix</code> in this example), to the note title:</p><pre><code class=\"language-text-javascript\">note.title = note.title + \" - suffix\";</code></pre></li><li><p>To alter attributes of a note based on another attribute, such as setting the <code>#shareAlias</code> label to the title of the note:</p><pre><code class=\"language-text-javascript\">note.setLabel(\"shareAlias\", note.title)</code></pre></li></ul></li></ul></li></ul>",
++ "_help_4FahAwuGTAwC": "<h2>Understanding the source code of the different notes</h2><p>Internally, the structure of the content of each note is different based on the&nbsp;<a class=\"reference-link\" href=\"#root/_help_KSZ04uQ2D1St\">Note Types</a>.</p><p>For example:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes&nbsp;are represented internally as HTML, using the&nbsp;<a class=\"reference-link\" href=\"#root/_help_MI26XDLSAlCD\">CKEditor</a>&nbsp;representation. Note that due to the custom plugins, some HTML elements are specific to Trilium only, for example the admonitions.</li><li><a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;notes&nbsp;are plain text and are represented internally as-is.</li><li><a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map</a>&nbsp;notes contain only minimal information (viewport, zoom) as a JSON.</li><li><a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a>&nbsp;notes are represented as JSON, with Trilium's own information alongside with&nbsp;<a href=\"#root/_help_1YeN2MzFUluU\">Excalidraw</a>'s internal JSON representation format.</li><li><a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a>&nbsp;notes are represented as JSON, with the internal format of&nbsp;<a href=\"#root/_help_1YeN2MzFUluU\">MindElixir</a>.</li></ul><p>Note that some information is also stored as&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>. For example&nbsp;<a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a>&nbsp;notes use the attachments feature to store the custom libraries, and alongside with&nbsp;<a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a>&nbsp;and other similar note types it stores an SVG representation of the content for use in other features such as including in other notes, shared notes, etc.</p><p>Here's part of the HTML representation of this note, as it's stored in the database (but prettified).</p><pre><code class=\"language-text-x-trilium-auto\">&lt;h2&gt;\n\tUnderstanding the source code of the different notes\n&lt;/h2&gt;\n&lt;p&gt;\n\tInternally, the structure of the content of each note is different based on the&amp;nbsp;\n\t&lt;a class=\"reference-link\" href=\"#root/_help_KSZ04uQ2D1St\"&gt;\n\t\tNote Types\n\t&lt;/a&gt;\n\t.\n&lt;/p&gt;</code></pre><h2>Viewing the source code</h2><p>It is possible to view the source code of a note by pressing the contextual menu in&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>&nbsp;and selecting <em>Note source</em>.</p><p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Note%20source_image.png\"></p><p>The source code will be displayed in a new tab.</p><p>For some note types, such as text notes and JSON notes, the source code is also formatted in order to be more easily readable.</p><h2>Modifying the source code</h2><p>It is possible to modify the source code of a note directly, however not via the <em>Note source</em> functionality.&nbsp;</p><p>To do so:</p><ol><li>Change the note type from the real note type (e.g. Canvas, Geo Type) to Code (plain text) or the corresponding format such as JSON or HTML.</li><li>Confirm the warning about changing the note type.</li><li>The source code will appear, make the necessary modifications.</li><li>Change the note type back to the real note type.</li></ol><aside class=\"admonition warning\"><p>Depending on the changes made, there is a risk that the note will not render properly. It's best to save a revision before making any big changes.</p><p>If the note does not render properly, modify the source code again or revert to a prior revision. Since the error handling for unexpected changes might not always be perfect, it be required to refresh the application.</p></aside>",
+ "_help_1YeN2MzFUluU": "<p>One core aspect of Trilium that allows it to have support for multiple&nbsp;<a href=\"#root/_help_KSZ04uQ2D1St\">Note Types</a>&nbsp;is the fact that it makes use of various off-the-shelf or reusable libraries.</p><p>This page showcases some of the technologies used, for a better understanding of how Trilium works but also to credit the developers of that particular technology.</p><h2>CKEditor</h2><p>CKEditor is the editor behind&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes, as well as integrated in various facets of the application such as the attribute editor in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlJ73vBCjWDw\">Status bar</a>&nbsp;or the chat box in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_GBBMSlVSOIGP\">AI</a>&nbsp;sidebar or notes.</p><p>For more information see&nbsp;<a class=\"reference-link\" href=\"#root/_help_MI26XDLSAlCD\">CKEditor</a>.</p><h2>Excalidraw</h2><p><a href=\"https://excalidraw.com/\">Excalidraw</a> is the technology behind the&nbsp;<a class=\"reference-link\" href=\"#root/_help_grjYqerjn243\">Canvas</a>&nbsp;notes. The source code of the library is available on <a href=\"https://github.com/excalidraw/excalidraw\">GitHub</a>.</p><p>We are using an unmodified version of it, so it shares the same <a href=\"https://github.com/excalidraw/excalidraw/issues\">issues</a> as the original.</p><h2>MapLibre GL JS</h2><p>Trilium v0.105.0 introduces <a href=\"https://github.com/maplibre/maplibre-gl-js\">MapLibre GL JS</a> for the&nbsp;<a class=\"reference-link\" href=\"#root/_help_81SGnPGMk7Xc\">Geo Map</a>&nbsp;collection, which brings improved performance by using graphical acceleration (WebGL). Trilium ships its own track parsing logic as well as most of the UI such as the right panel.</p><h2>MindElixir</h2><p>MindElixir is the library we are using for&nbsp;<a class=\"reference-link\" href=\"#root/_help_gBbsAeiuUxI5\">Mind Map</a>&nbsp;note types. The main library is available on <a href=\"https://github.com/SSShooter/mind-elixir-core/issues\">GitHub as mind-elixir-core</a>.</p><p>Trilium ships its own UI which covers the toolbars, the contextual menu, the zoom buttons and the right panel that shows when clicking a node.</p><h2>FullCalendar</h2><p><a href=\"https://fullcalendar.io/\">FullCalendar</a> is the technology behind the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xWbu3jpNWapp\">Calendar</a>&nbsp;collection, providing the various views (day, week, month, year) and the event management. Trilium also ships its own UI in the form of the popup that appears when editing, as well as the header that appears in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_CssoWBu8I7jF\">Collection Properties</a>.</p><p>Licensed under the MIT license.</p>",
- "_help_MI26XDLSAlCD": "<h2>Editor core</h2><p>The CKEditor is the WYSIWYG (standing for What You See Is What You Get) editor behind&nbsp;<a href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes.</p><p>Their website is <a href=\"https://ckeditor.com/\">ckeditor.com</a>.</p><p>CKEditor by itself is a commercial product, but the core is open-source. As described in <a href=\"https://ckeditor.com/docs/ckeditor5/latest/features/index.html\">its documentation</a>, the editor supports quite a large number of features. Do note that not all the features are enabled in Trilium.</p><h2>Premium features</h2><p>Some features are marked as premium in the CKEditor feature set. This means that they cannot be used without a license.</p><p>Trilium cannot benefit from any of these premium features as they require a commercial license, however we are in discussions with the CKEditor team to allow us to use a subset of these premium features such as <a href=\"https://ckeditor.com/docs/ckeditor5/latest/features/slash-commands.html\">Slash commands</a>.</p><h2>Plugins</h2><p>The CKEditor ecosystem is quite extensible, in the sense that custom plugins can be written to extend the functionality of the editor beyond its original scope.</p><p>Trilium makes use of such features:</p><ul><li>The math feature is added by a version of <a href=\"https://github.com/isaul32/ckeditor5-math\">isaul32/ckeditor5-math: Math feature for CKEditor 5.</a> modified by us to fit our needs.</li><li>We also make use of modified upstream plugins such as <a href=\"https://github.com/ckeditor/ckeditor5-mermaid\">ckeditor/ckeditor5-mermaid</a> to allow inline Mermaid code.</li><li><a href=\"https://github.com/mlewand/ckeditor5-keyboard-marker\">mlewand/ckeditor5-keyboard-marker: Plugin adds support for the keyboard input element (<code spellcheck=\"false\">&lt;kbd&gt;</code>) to CKEditor 5.</a></li><li>A modified version of <a href=\"https://github.com/ThomasAitken/ckeditor5-footnotes\">ThomasAitken/ckeditor5-footnotes: Footnotes plugin for CKEditor5</a> to allow footnotes.</li></ul><p>Apart from that, Trilium also has its own set of specific plugins such as:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_2x0ZAX9ePtzV\">Cut to subnote</a></li><li><a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a></li><li>Mentions, for linking pages.</li><li><a class=\"reference-link\" href=\"#root/_help_Oau6X9rCuegd\">Markdown</a></li><li><a href=\"#root/_help_QEAPj01N5f7w\">Reference links</a></li><li><a href=\"#root/_help_NwBbFdNZ9h7O\">Admonitions</a>, we ended up creating our own plugin but <a href=\"https://github.com/aarkue/ckeditor5-admonition\">aarkue/ckeditor5-admonition</a> was a good inspiration (including the toolbar icon).</li></ul>",
++ "_help_MI26XDLSAlCD": "<h2>Editor core</h2><p>The CKEditor is the WYSIWYG (standing for What You See Is What You Get) editor behind&nbsp;<a href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes.</p><p>Their website is <a href=\"https://ckeditor.com/\">ckeditor.com</a>.</p><p>CKEditor by itself is a commercial product, but the core is open-source. As described in <a href=\"https://ckeditor.com/docs/ckeditor5/latest/features/index.html\">its documentation</a>, the editor supports quite a large number of features. Do note that not all the features are enabled in Trilium.</p><h2>Premium features</h2><p>CKEditor ships some plugins as premium (slash commands, templates, AI integration). Initially Trilium (since v0.96.0) shipped some of them like slash commands as part of a license grant from CKEditor to the Trilium Notes developers.</p><p>In v0.105.0 we've decided to replace those premium plugins with our own open-source implementations. This also means that we can better tailor those plugins to the Trilium app.</p><h2>Plugins</h2><p>The CKEditor ecosystem is quite extensible, in the sense that custom plugins can be written to extend the functionality of the editor beyond its original scope.</p><p>Trilium makes use of such features:</p><ul><li>The math feature is added by a version of <a href=\"https://github.com/isaul32/ckeditor5-math\">isaul32/ckeditor5-math: Math feature for CKEditor 5.</a> modified by us to fit our needs.</li><li>We also make use of modified upstream plugins such as <a href=\"https://github.com/ckeditor/ckeditor5-mermaid\">ckeditor/ckeditor5-mermaid</a> to allow inline Mermaid code.</li><li><a href=\"https://github.com/mlewand/ckeditor5-keyboard-marker\">mlewand/ckeditor5-keyboard-marker: Plugin adds support for the keyboard input element (<code>&lt;kbd&gt;</code>) to CKEditor 5.</a></li><li>A modified version of <a href=\"https://github.com/ThomasAitken/ckeditor5-footnotes\">ThomasAitken/ckeditor5-footnotes: Footnotes plugin for CKEditor5</a> to allow footnotes.</li></ul><p>Apart from that, Trilium also has its own set of specific plugins such as:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_2x0ZAX9ePtzV\">Cut to subnote</a></li><li><a class=\"reference-link\" href=\"#root/_help_nBAXQFj20hS1\">Include Note</a></li><li>Mentions, for linking pages.</li><li><a class=\"reference-link\" href=\"#root/_help_Oau6X9rCuegd\">Markdown</a></li><li><a href=\"#root/_help_QEAPj01N5f7w\">Reference links</a></li><li><a href=\"#root/_help_NwBbFdNZ9h7O\">Admonitions</a>, we ended up creating our own plugin but <a href=\"https://github.com/aarkue/ckeditor5-admonition\">aarkue/ckeditor5-admonition</a> was a good inspiration (including the toolbar icon).</li></ul>",
+ "_help_m1lbrzyKDaRB": "<p>Whereas some applications use file names to uniquely identify notes, Trilium uses the concept of Note ID.</p><p>Generally, the Note ID is a 12-character long alphanumeric sequence (including both lower and upper case letter) that is randomly generated for each new note.</p><h2>How does the import/export affect the note IDs</h2><p>When notes are exported, their note ID is kept in the metadata of the export. However when they are imported back in, a new note ID is generated for all the notes. This also includes other entities that are part of the import/export process such as&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>.</p><h2>Note collisions</h2><p>Since the Note ID is a fixed-width randomly generated number, due to the <a href=\"https://en.wikipedia.org/wiki/Pigeonhole_principle\">pigeonhole principle</a>, there is a possibility that a newly created note will have the same ID as an existing note.</p><p>Since the note ID is alphanumeric and the length is 12 we have&nbsp;<span class=\"math-tex\">\\(62^{12}\\)</span>&nbsp;unique IDs. However since we are generating them randomly, we can use a collision calculator such as the one for <a href=\"https://alex7kom.github.io/nano-nanoid-cc/?alphabet=0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz&amp;size=12&amp;speed=1000&amp;speedUnit=hour\">Nano ID</a> to determine that we'd need to create 1000 notes per hour every hour for 9 centuries in order to have at least 1% probability of a note collision.</p><p>As such, Trilium does not take any explicit action against potential note collisions, similar to other software that makes uses of unique hashes such as <a href=\"https://stackoverflow.com/questions/10434326/hash-collision-in-git\">Git</a>. If one would theoretically occur, what would most likely happen is that the existing note will be replaced by the new one.</p>",
- "_help_2mUhVmZK8RF3": "<figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:263/445;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Hidden%20Notes_image.png\" width=\"263\" height=\"445\"></figure><p>For easy extensibility, a lot of features in Trilium make use of actual notes to store information as opposed to having them stored in a separate location in the database. This allows some functions such as&nbsp;<a class=\"reference-link\" href=\"#root/_help_zEY4DaJG4YT5\">Attributes</a>,&nbsp;<a class=\"reference-link\" href=\"#root/_help_Cq5X6iKQop6R\">Relations</a>&nbsp;or even&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_QEAPj01N5f7w\">Links</a>&nbsp;to be able to operate on them.</p><p>As the name suggests, these notes are hidden to the user by default to prevent cluttering the note tree and to prevent them from being accidentally deleted.</p><p>The hidden notes are stored in the user's&nbsp;<a class=\"reference-link\" href=\"#root/_help_wX4HbRucYSDD\">Database</a>&nbsp;just like normal notes, but they have a unique&nbsp;<a class=\"reference-link\" href=\"#root/_help_m1lbrzyKDaRB\">Note ID</a>&nbsp;which allows them to be distinguished from the normal ones.</p><h2>Accessing the hidden note tree</h2><p>From the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>, select <em>Advanced</em> → <em>Show Hidden Subtree</em>.</p><h2>Contents of the hidden note tree</h2><p>Here is a brief summary of all the notes within the hidden tree:</p><table class=\"ck-table-resized\">\n <colgroup>\n <col style=\"width:19.93%;\">\n <col style=\"width:80.07%;\">\n </colgroup>\n <thead>\n <tr>\n <th>Note</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td><a class=\"reference-link\" href=\"#root/_hidden/_globalNoteMap\">Note Map</a></td>\n <td><p>This note is actually opened when the&nbsp;<a class=\"reference-link\" href=\"#root/_help_bdUJEHsAPYQR\">Note Map</a>&nbsp;feature that is accessed from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</p><p>It is possible to create any child notes in it without any additional meaning. For example, it can be used to store a list of note maps which can be linked to from other notes or <a href=\"#root/_help_u3YFHC9tQlpm\">bookmarked</a>.</p></td>\n </tr>\n <tr>\n <td><a class=\"reference-link\" href=\"#root/_hidden/_sqlConsole\">SQL Console History</a></td>\n <td><p>When SQL queries or commands are executed in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_YKWqdJhzi2VY\">SQL Console</a>, they are stored here, grouped by month. Only the query is stored and not the results.</p><p>This section can be accessed without going to the hidden tree by simply going to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;and selecting Advanced → Open SQL Console History.</p><p>Notes can be added as children of this tree, but it's generally not recommended to do so to not interfere with the normal history process.</p></td>\n </tr>\n <tr>\n <td><a class=\"reference-link\" href=\"#root/_hidden/_search\">Search History</a></td>\n <td><p>Whenever a search is executed from the full&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>, the query will be stored here, grouped by month. Only the search parameters are stored and not the results themselves.</p><p>This section can be accessed without going to the hidden tree by simply going to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;and selecting Advanced → Open Search History.</p><p>Notes can be added as children of this tree, but it's generally not recommended to do so to not interfere with the normal history process.</p></td>\n </tr>\n <tr>\n <td><a class=\"reference-link\" href=\"#root/_hidden/_bulkAction\">Bulk Action</a></td>\n <td><p>This section is used for&nbsp;<a class=\"reference-link\" href=\"#root/_help_ivYnonVFBxbQ\">Bulk Actions</a>. The last configuration for bulk actions will be stored as part of this note, each action in its own <code>action</code> label.</p><p>Notes can be added as children of this tree, but there won't be any benefit in doing so.</p></td>\n </tr>\n <tr>\n <td><a class=\"reference-link\" href=\"#root/_hidden/_backendLog\">Backend Log</a></td>\n <td><p>This note corresponds to the backend log feature (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_qzNzp9LYQyPT\">Error logs</a>).</p><p>This item can be accessed without going to the hidden try by going to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;and selecting Advanced → Show backend log.</p></td>\n </tr>\n <tr>\n <td><a class=\"reference-link\" href=\"#root/_hidden/_userHidden\">User Hidden</a></td>\n <td>This section can be used by <a href=\"#root/_help_CdNpE2pqjmI6\">scripts</a> to create their own notes that should not be directly visible to the user. The note can be identified by scripts by its unique ID: <code>_userHidden</code></td>\n </tr>\n <tr>\n <td><a class=\"reference-link\" href=\"#root/_hidden/_lbTplRoot\">Launch Bar Templates</a></td>\n <td><p>This section contains the templates for the creation of launchers in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>. It is not possible to create child notes here.</p><p>Theoretically some of the notes here can be customized, but there's not much benefit to be had in doing so.</p></td>\n </tr>\n <tr>\n <td><a class=\"reference-link\" href=\"#root/_hidden/_share\">Shared Notes</a></td>\n <td><p>This tree lists all of the notes that are <a href=\"#root/_help_R9pX4DGra2Vt\">shared</a> publicly. It can be useful to track down which notes are shared regardless of their position in the note tree.</p><p>This section can be accessed without going to the hidden tree simply by going to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;and selecting <em>Show Shared Notes Subtree</em>.</p><p>Sub-notes cannot be created here.</p></td>\n </tr>\n <tr>\n <td><a class=\"reference-link\" href=\"#root/_hidden/_lbRoot\">Launch Bar</a></td>\n <td><p>The tree contains both available and displayed items of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</p><p>This section can be accessed without going to the hidden tree by:</p><ul><li>Going to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;and selecting <em>Configure Launchbar</em>.</li><li>Right-clicking an empty space on the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>&nbsp;and selecting <em>Configure Launchbar</em>.</li></ul><p>Sub-notes cannot be created here.</p></td>\n </tr>\n <tr>\n <td><a class=\"reference-link\" href=\"#root/_hidden/_options\">Options</a></td>\n <td><p>This section stores the list of&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>.</p><p>This section can be accessed without going to the hidden tree by:</p><ul><li>Going to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;and selecting <em>Options</em>.</li><li>Pressing the dedicated Options icon in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</li></ul></td>\n </tr>\n <tr>\n <td><a class=\"reference-link\" href=\"#root/_hidden/_lbMobileRoot\">Mobile Launch Bar</a></td>\n <td><p>This is very similar to the <em>Launch Bar</em>, but is dedicated for the mobile UI only.</p><p>Accessing it outside the <em>Launch Bar</em> is the same as the Launch Bar, but needs to be done so from the mobile interface.</p></td>\n </tr>\n <tr>\n <td><a class=\"reference-link\" href=\"#root/_hidden/_help\">User Guide</a></td>\n <td>This is where the note structure for the User Guide is actually stored. Only the metadata is stored, as the help itself is present as actual files in the application directory.</td>\n </tr>\n </tbody>\n</table>",
- "_help_uYF7pmepw27K": "<p>The Trilium Metrics API provides comprehensive monitoring data about your Trilium instance, designed for external monitoring systems like Prometheus.</p><h2><strong>Endpoint</strong></h2><ul><li><strong>URL</strong>: <code spellcheck=\"false\">/etapi/metrics</code></li><li><strong>Method</strong>: <code spellcheck=\"false\">GET</code></li><li><strong>Authentication</strong>: ETAPI token required</li><li><strong>Default Format</strong>: Prometheus text format</li></ul><h2><strong>Authentication</strong></h2><p>You need an ETAPI token to access the metrics endpoint. Get one by:</p><pre><code class=\"language-text-x-trilium-auto\"># Get an ETAPI token\ncurl -X POST http://localhost:8080/etapi/auth/login \\\n -H \"Content-Type: application/json\" \\\n -d '{\"password\": \"your_password\"}'\n</code></pre><h2><strong>Usage</strong></h2><h3><strong>Prometheus Format (Default)</strong></h3><pre><code class=\"language-text-x-trilium-auto\">curl -H \"Authorization: YOUR_ETAPI_TOKEN\" \\\n http://localhost:8080/etapi/metrics\n</code></pre><p>Returns metrics in Prometheus text format:</p><pre><code class=\"language-text-x-trilium-auto\"># HELP trilium_info Trilium instance information\n# TYPE trilium_info gauge\ntrilium_info{version=\"0.91.6\",db_version=\"231\",node_version=\"v18.17.0\"} 1 1701432000\n\n# HELP trilium_notes_total Total number of notes including deleted\n# TYPE trilium_notes_total gauge\ntrilium_notes_total 1234 1701432000\n</code></pre><h3><strong>JSON Format</strong></h3><pre><code class=\"language-text-x-trilium-auto\">curl -H \"Authorization: YOUR_ETAPI_TOKEN\" \\\n \"http://localhost:8080/etapi/metrics?format=json\"\n</code></pre><p>Returns detailed metrics in JSON format for debugging or custom integrations.</p><h2><strong>Available Metrics</strong></h2><h3><strong>Instance Information</strong></h3><ul><li><code spellcheck=\"false\">trilium_info</code> - Version and build information with labels</li></ul><h3><strong>Database Metrics</strong></h3><ul><li><code spellcheck=\"false\">trilium_notes_total</code> - Total notes (including deleted)</li><li><code spellcheck=\"false\">trilium_notes_deleted</code> - Number of deleted notes</li><li><code spellcheck=\"false\">trilium_notes_active</code> - Number of active notes</li><li><code spellcheck=\"false\">trilium_notes_protected</code> - Number of protected notes</li><li><code spellcheck=\"false\">trilium_attachments_total</code> - Total attachments</li><li><code spellcheck=\"false\">trilium_attachments_active</code> - Active attachments</li><li><code spellcheck=\"false\">trilium_revisions_total</code> - Total note revisions</li><li><code spellcheck=\"false\">trilium_branches_total</code> - Active branches</li><li><code spellcheck=\"false\">trilium_attributes_total</code> - Active attributes</li><li><code spellcheck=\"false\">trilium_blobs_total</code> - Total blob records</li><li><code spellcheck=\"false\">trilium_etapi_tokens_total</code> - Active ETAPI tokens</li><li><code spellcheck=\"false\">trilium_embeddings_total</code> - Note embeddings (if available)</li></ul><h3><strong>Categorized Metrics</strong></h3><ul><li><code spellcheck=\"false\">trilium_notes_by_type{type=\"text|code|image|file\"}</code> - Notes by type</li><li><code spellcheck=\"false\">trilium_attachments_by_type{mime_type=\"...\"}</code> - Attachments by MIME type</li></ul><h3><strong>Statistics</strong></h3><ul><li><code spellcheck=\"false\">trilium_database_size_bytes</code> - Database size in bytes</li><li><code spellcheck=\"false\">trilium_oldest_note_timestamp</code> - Timestamp of oldest note</li><li><code spellcheck=\"false\">trilium_newest_note_timestamp</code> - Timestamp of newest note</li><li><code spellcheck=\"false\">trilium_last_modified_timestamp</code> - Last modification timestamp</li></ul><h2><strong>Prometheus Configuration</strong></h2><p>Add to your <code spellcheck=\"false\">prometheus.yml</code>:</p><pre><code class=\"language-text-x-trilium-auto\">scrape_configs:\n - job_name: 'trilium'\n static_configs:\n - targets: ['localhost:8080']\n metrics_path: '/etapi/metrics'\n bearer_token: 'YOUR_ETAPI_TOKEN'\n scrape_interval: 30s\n</code></pre><h2><strong>Error Responses</strong></h2><ul><li><code spellcheck=\"false\">400</code> - Invalid format parameter</li><li><code spellcheck=\"false\">401</code> - Missing or invalid ETAPI token</li><li><code spellcheck=\"false\">500</code> - Internal server error</li></ul><h2><strong>Grafana Dashboard</strong></h2><figure class=\"image\"><img style=\"aspect-ratio:2594/1568;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/1_Metrics_image.png\" width=\"2594\" height=\"1568\"></figure><p>You can also use the Grafana Dashboard that has been created for TriliumNext - just take the JSON from&nbsp;<a class=\"reference-link\" href=\"#root/_help_bOP3TB56fL1V\">grafana-dashboard.json</a>&nbsp;and then import the dashboard, following these screenshots:</p><figure class=\"image\"><img style=\"aspect-ratio:1881/282;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/2_Metrics_image.png\" width=\"1881\" height=\"282\"></figure><p>Then paste the JSON, and hit load:</p><figure class=\"image\"><img style=\"aspect-ratio:1055/830;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Metrics_image.png\" width=\"1055\" height=\"830\"></figure>",
++ "_help_2mUhVmZK8RF3": "<figure class=\"image image-style-align-right\"><img style=\"aspect-ratio:263/445;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Hidden%20Notes_image.png\" width=\"263\" height=\"445\"></figure><p>For easy extensibility, a lot of features in Trilium make use of actual notes to store information as opposed to having them stored in a separate location in the database. This allows some functions such as&nbsp;<a class=\"reference-link\" href=\"#root/_help_zEY4DaJG4YT5\">Attributes</a>,&nbsp;<a class=\"reference-link\" href=\"#root/_help_Cq5X6iKQop6R\">Relations</a>&nbsp;or even&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_QEAPj01N5f7w\">Links</a>&nbsp;to be able to operate on them.</p><p>As the name suggests, these notes are hidden to the user by default to prevent cluttering the note tree and to prevent them from being accidentally deleted.</p><p>The hidden notes are stored in the user's&nbsp;<a class=\"reference-link\" href=\"#root/_help_wX4HbRucYSDD\">Database</a>&nbsp;just like normal notes, but they have a unique&nbsp;<a class=\"reference-link\" href=\"#root/_help_m1lbrzyKDaRB\">Note ID</a>&nbsp;which allows them to be distinguished from the normal ones.</p><h2>Accessing the hidden note tree</h2><p>From the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>, select <em>Advanced</em> → <em>Show Hidden Subtree</em>.</p><h2>Contents of the hidden note tree</h2><p>Here is a brief summary of all the notes within the hidden tree:</p><figure class=\"table\"><table class=\"ck-table-resized\"><colgroup><col style=\"width:19.93%;\"><col style=\"width:80.07%;\"></colgroup><thead><tr><th>Note</th><th>Description</th></tr></thead><tbody><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_globalNoteMap\">Note Map</a></td><td><p>This note is actually opened when the&nbsp;<a class=\"reference-link\" href=\"#root/_help_bdUJEHsAPYQR\">Note Map</a>&nbsp;feature that is accessed from the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</p><p>It is possible to create any child notes in it without any additional meaning. For example, it can be used to store a list of note maps which can be linked to from other notes or <a href=\"#root/_help_u3YFHC9tQlpm\">bookmarked</a>.</p></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_sqlConsole\">SQL Console History</a></td><td><p>When SQL queries or commands are executed in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_YKWqdJhzi2VY\">SQL Console</a>, they are stored here, grouped by month. Only the query is stored and not the results.</p><p>This section can be accessed without going to the hidden tree by simply going to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;and selecting Advanced → Open SQL Console History.</p><p>Notes can be added as children of this tree, but it's generally not recommended to do so to not interfere with the normal history process.</p></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_search\">Search History</a></td><td><p>Whenever a search is executed from the full&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>, the query will be stored here, grouped by month. Only the search parameters are stored and not the results themselves.</p><p>This section can be accessed without going to the hidden tree by simply going to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;and selecting Advanced → Open Search History.</p><p>Notes can be added as children of this tree, but it's generally not recommended to do so to not interfere with the normal history process.</p></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_bulkAction\">Bulk Action</a></td><td><p>This section is used for&nbsp;<a class=\"reference-link\" href=\"#root/_help_ivYnonVFBxbQ\">Bulk Actions</a>. The last configuration for bulk actions will be stored as part of this note, each action in its own <code>action</code> label.</p><p>Notes can be added as children of this tree, but there won't be any benefit in doing so.</p></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_backendLog\">Backend Log</a></td><td><p>This note corresponds to the backend log feature (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_qzNzp9LYQyPT\">Error logs</a>).</p><p>This item can be accessed without going to the hidden try by going to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;and selecting Advanced → Show backend log.</p></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_userHidden\">User Hidden</a></td><td>This section can be used by <a href=\"#root/_help_CdNpE2pqjmI6\">scripts</a> to create their own notes that should not be directly visible to the user. The note can be identified by scripts by its unique ID: <code>_userHidden</code></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_lbTplRoot\">Launch Bar Templates</a></td><td><p>This section contains the templates for the creation of launchers in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>. It is not possible to create child notes here.</p><p>Theoretically some of the notes here can be customized, but there's not much benefit to be had in doing so.</p></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_share\">Shared Notes</a></td><td><p>This tree lists all of the notes that are <a href=\"#root/_help_R9pX4DGra2Vt\">shared</a> publicly. It can be useful to track down which notes are shared regardless of their position in the note tree.</p><p>This section can be accessed without going to the hidden tree simply by going to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;and selecting <em>Show Shared Notes Subtree</em>.</p><p>Sub-notes cannot be created here.</p></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_lbRoot\">Launch Bar</a></td><td><p>The tree contains both available and displayed items of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</p><p>This section can be accessed without going to the hidden tree by:</p><ul><li>Going to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;and selecting <em>Configure Launchbar…</em>.</li><li>Right-clicking an empty space on the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>&nbsp;and selecting <em>Configure Launchbar…</em>.</li></ul><p>Sub-notes cannot be created here.</p></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_options\">Options</a></td><td><p>This section stores the list of&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>.</p><p>This section can be accessed without going to the hidden tree by:</p><ul><li>Going to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;and selecting <em>Options</em>.</li><li>Pressing the dedicated Options icon in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</li></ul></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_lbMobileRoot\">Mobile Launch Bar</a></td><td><p>This is very similar to the <em>Launch Bar</em>, but is dedicated for the mobile UI only.</p><p>Accessing it outside the <em>Launch Bar</em> is the same as the Launch Bar, but needs to be done so from the mobile interface.</p></td></tr><tr><td><a class=\"reference-link\" href=\"#root/_hidden/_help\">User Guide</a></td><td>This is where the note structure for the User Guide is actually stored. Only the metadata is stored, as the help itself is present as actual files in the application directory.</td></tr></tbody></table></figure>",
++ "_help_uYF7pmepw27K": "<p>The Trilium Metrics API provides comprehensive monitoring data about your Trilium instance, designed for external monitoring systems like Prometheus.</p><h2>Endpoint</h2><ul><li><strong>URL</strong>: <code>/etapi/metrics</code></li><li><strong>Method</strong>: <code>GET</code></li><li><strong>Authentication</strong>: ETAPI token required</li><li><strong>Default Format</strong>: Prometheus text format</li></ul><h2>Authentication</h2><p>You need an ETAPI token to access the metrics endpoint. Get one by:</p><pre><code class=\"language-text-x-trilium-auto\"># Get an ETAPI token\ncurl -X POST http://localhost:8080/etapi/auth/login \\\n -H \"Content-Type: application/json\" \\\n -d '{\"password\": \"your_password\"}'\n</code></pre><h2>Usage</h2><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Prometheus Format (Default)</p><div class=\"trilium-tab-panel\"><pre><code class=\"language-text-x-trilium-auto\">curl -H \"Authorization: YOUR_ETAPI_TOKEN\" \\\n http://localhost:8080/etapi/metrics\n</code></pre><p>Returns metrics in Prometheus text format:</p><pre><code class=\"language-text-x-trilium-auto\"># HELP trilium_info Trilium instance information\n# TYPE trilium_info gauge\ntrilium_info{version=\"0.91.6\",db_version=\"231\",node_version=\"v18.17.0\"} 1 1701432000\n\n# HELP trilium_notes_total Total number of notes including deleted\n# TYPE trilium_notes_total gauge\ntrilium_notes_total 1234 1701432000</code></pre></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">JSON Format</p><div class=\"trilium-tab-panel\"><pre><code class=\"language-text-x-trilium-auto\">curl -H \"Authorization: YOUR_ETAPI_TOKEN\" \\\n \"http://localhost:8080/etapi/metrics?format=json\"\n</code></pre><p>Returns detailed metrics in JSON format for debugging or custom integrations.</p></div></section></div><h2>Available Metrics</h2><h3>Instance Information</h3><ul><li><code>trilium_info</code> - Version and build information with labels</li></ul><h3>Database Metrics</h3><ul><li><code>trilium_notes_total</code> - Total notes (including deleted)</li><li><code>trilium_notes_deleted</code> - Number of deleted notes</li><li><code>trilium_notes_active</code> - Number of active notes</li><li><code>trilium_notes_protected</code> - Number of protected notes</li><li><code>trilium_attachments_total</code> - Total attachments</li><li><code>trilium_attachments_active</code> - Active attachments</li><li><code>trilium_revisions_total</code> - Total note revisions</li><li><code>trilium_branches_total</code> - Active branches</li><li><code>trilium_attributes_total</code> - Active attributes</li><li><code>trilium_blobs_total</code> - Total blob records</li><li><code>trilium_etapi_tokens_total</code> - Active ETAPI tokens</li><li><code>trilium_embeddings_total</code> - Note embeddings (if available)</li></ul><h3>Categorized Metrics</h3><ul><li><code>trilium_notes_by_type{type=\"text|code|image|file\"}</code> - Notes by type</li><li><code>trilium_attachments_by_type{mime_type=\"...\"}</code> - Attachments by MIME type</li></ul><h3>Statistics</h3><ul><li><code>trilium_database_size_bytes</code> - Database size in bytes</li><li><code>trilium_oldest_note_timestamp</code> - Timestamp of oldest note</li><li><code>trilium_newest_note_timestamp</code> - Timestamp of newest note</li><li><code>trilium_last_modified_timestamp</code> - Last modification timestamp</li></ul><h2>Prometheus Configuration</h2><p>Add to your <code>prometheus.yml</code>:</p><pre><code class=\"language-text-x-trilium-auto\">scrape_configs:\n - job_name: 'trilium'\n static_configs:\n - targets: ['localhost:8080']\n metrics_path: '/etapi/metrics'\n bearer_token: 'YOUR_ETAPI_TOKEN'\n scrape_interval: 30s\n</code></pre><h2>Error Responses</h2><ul><li><code>400</code> - Invalid format parameter</li><li><code>401</code> - Missing or invalid ETAPI token</li><li><code>500</code> - Internal server error</li></ul><h2>Grafana Dashboard</h2><figure class=\"image\"><img style=\"aspect-ratio:2594/1568;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/1_Metrics_image.png\" width=\"2594\" height=\"1568\"></figure><p>You can also use the Grafana Dashboard that has been created for TriliumNext - just take the JSON from&nbsp;<a class=\"reference-link\" href=\"#root/_help_bOP3TB56fL1V\">grafana-dashboard.json</a>&nbsp;and then import the dashboard, following these screenshots:</p><figure class=\"image\"><img style=\"aspect-ratio:1881/282;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/2_Metrics_image.png\" width=\"1881\" height=\"282\"></figure><p>Then paste the JSON, and hit load:</p><figure class=\"image\"><img style=\"aspect-ratio:1055/830;\" src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Metrics_image.png\" width=\"1055\" height=\"830\"></figure>",
+ "_help_bOP3TB56fL1V": "{\n \"annotations\": {\n \"list\": [\n {\n \"builtIn\": 1,\n \"datasource\": {\n \"type\": \"grafana\",\n \"uid\": \"-- Grafana --\"\n },\n \"enable\": true,\n \"hide\": true,\n \"iconColor\": \"rgba(0, 211, 255, 1)\",\n \"name\": \"Annotations & Alerts\",\n \"type\": \"dashboard\"\n }\n ]\n },\n \"editable\": true,\n \"fiscalYearStartMonth\": 0,\n \"graphTooltip\": 1,\n \"id\": 549,\n \"links\": [],\n \"panels\": [\n {\n \"collapsed\": false,\n \"gridPos\": {\n \"h\": 1,\n \"w\": 24,\n \"x\": 0,\n \"y\": 0\n },\n \"id\": 100,\n \"panels\": [],\n \"title\": \"🏠 Trilium Overview\",\n \"type\": \"row\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"description\": \"Current Trilium version and build information\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"thresholds\"\n },\n \"custom\": {\n \"align\": \"auto\",\n \"cellOptions\": {\n \"type\": \"auto\"\n },\n \"filterable\": false,\n \"inspect\": false\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\"\n }\n ]\n }\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 6,\n \"w\": 12,\n \"x\": 0,\n \"y\": 1\n },\n \"id\": 101,\n \"options\": {\n \"cellHeight\": \"sm\",\n \"footer\": {\n \"countRows\": false,\n \"fields\": \"\",\n \"reducer\": [\n \"sum\"\n ],\n \"show\": false\n },\n \"showHeader\": true\n },\n \"pluginVersion\": \"12.0.1\",\n \"targets\": [\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_info{job=~'$job',instance=~'$instance'}\",\n \"format\": \"table\",\n \"instant\": true,\n \"refId\": \"A\"\n }\n ],\n \"title\": \"📋 Instance Information\",\n \"transformations\": [\n {\n \"id\": \"organize\",\n \"options\": {\n \"excludeByName\": {\n \"Time\": true,\n \"Value\": true,\n \"__name__\": true,\n \"instance\": true,\n \"job\": true\n },\n \"indexByName\": {},\n \"renameByName\": {\n \"build_date\": \"Build Date\",\n \"build_revision\": \"Git Revision\",\n \"db_version\": \"DB Version\",\n \"node_version\": \"Node.js\",\n \"sync_version\": \"Sync Version\",\n \"version\": \"Version\"\n }\n }\n }\n ],\n \"type\": \"table\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"description\": \"Database file size in human-readable format\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"thresholds\"\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\"\n },\n {\n \"color\": \"yellow\",\n \"value\": 500000000\n },\n {\n \"color\": \"red\",\n \"value\": 1000000000\n }\n ]\n },\n \"unit\": \"decbytes\"\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 6,\n \"w\": 6,\n \"x\": 12,\n \"y\": 1\n },\n \"id\": 102,\n \"options\": {\n \"colorMode\": \"background\",\n \"graphMode\": \"area\",\n \"justifyMode\": \"center\",\n \"orientation\": \"auto\",\n \"percentChangeColorMode\": \"standard\",\n \"reduceOptions\": {\n \"calcs\": [\n \"lastNotNull\"\n ],\n \"fields\": \"\",\n \"values\": false\n },\n \"showPercentChange\": false,\n \"textMode\": \"auto\",\n \"wideLayout\": true\n },\n \"pluginVersion\": \"12.0.1\",\n \"targets\": [\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_database_size_bytes{job=~'$job',instance=~'$instance'}\",\n \"refId\": \"A\"\n }\n ],\n \"title\": \"💾 Database Size\",\n \"type\": \"stat\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"description\": \"Total active notes in your Trilium instance\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"thresholds\"\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\"\n },\n {\n \"color\": \"yellow\",\n \"value\": 1000\n },\n {\n \"color\": \"red\",\n \"value\": 5000\n }\n ]\n },\n \"unit\": \"short\"\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 6,\n \"w\": 6,\n \"x\": 18,\n \"y\": 1\n },\n \"id\": 103,\n \"options\": {\n \"colorMode\": \"background\",\n \"graphMode\": \"area\",\n \"justifyMode\": \"center\",\n \"orientation\": \"auto\",\n \"percentChangeColorMode\": \"standard\",\n \"reduceOptions\": {\n \"calcs\": [\n \"lastNotNull\"\n ],\n \"fields\": \"\",\n \"values\": false\n },\n \"showPercentChange\": false,\n \"textMode\": \"auto\",\n \"wideLayout\": true\n },\n \"pluginVersion\": \"12.0.1\",\n \"targets\": [\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_notes_active{job=~'$job',instance=~'$instance'}\",\n \"refId\": \"A\"\n }\n ],\n \"title\": \"📝 Active Notes\",\n \"type\": \"stat\"\n },\n {\n \"collapsed\": false,\n \"gridPos\": {\n \"h\": 1,\n \"w\": 24,\n \"x\": 0,\n \"y\": 7\n },\n \"id\": 200,\n \"panels\": [],\n \"title\": \"📊 Key Metrics\",\n \"type\": \"row\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"description\": \"Total notes including deleted ones\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"palette-classic\"\n },\n \"custom\": {\n \"hideFrom\": {\n \"legend\": false,\n \"tooltip\": false,\n \"viz\": false\n }\n },\n \"mappings\": [],\n \"unit\": \"short\"\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 8,\n \"w\": 6,\n \"x\": 0,\n \"y\": 8\n },\n \"id\": 201,\n \"options\": {\n \"legend\": {\n \"displayMode\": \"list\",\n \"placement\": \"bottom\",\n \"showLegend\": true,\n \"values\": []\n },\n \"pieType\": \"pie\",\n \"reduceOptions\": {\n \"calcs\": [\n \"lastNotNull\"\n ],\n \"fields\": \"\",\n \"values\": false\n },\n \"tooltip\": {\n \"hideZeros\": false,\n \"mode\": \"single\",\n \"sort\": \"none\"\n }\n },\n \"pluginVersion\": \"12.0.1\",\n \"targets\": [\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_notes_active{job=~'$job',instance=~'$instance'}\",\n \"legendFormat\": \"Active Notes\",\n \"refId\": \"A\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_notes_deleted{job=~'$job',instance=~'$instance'}\",\n \"legendFormat\": \"Deleted Notes\",\n \"refId\": \"B\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_notes_protected{job=~'$job',instance=~'$instance'}\",\n \"legendFormat\": \"Protected Notes\",\n \"refId\": \"C\"\n }\n ],\n \"title\": \"📝 Notes Distribution\",\n \"type\": \"piechart\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"description\": \"Breakdown of attachments by MIME type\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"palette-classic\"\n },\n \"custom\": {\n \"hideFrom\": {\n \"legend\": false,\n \"tooltip\": false,\n \"viz\": false\n }\n },\n \"mappings\": [],\n \"unit\": \"short\"\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 8,\n \"w\": 6,\n \"x\": 6,\n \"y\": 8\n },\n \"id\": 202,\n \"options\": {\n \"legend\": {\n \"displayMode\": \"list\",\n \"placement\": \"bottom\",\n \"showLegend\": true,\n \"values\": []\n },\n \"pieType\": \"donut\",\n \"reduceOptions\": {\n \"calcs\": [\n \"lastNotNull\"\n ],\n \"fields\": \"\",\n \"values\": false\n },\n \"tooltip\": {\n \"hideZeros\": false,\n \"mode\": \"single\",\n \"sort\": \"none\"\n }\n },\n \"pluginVersion\": \"12.0.1\",\n \"targets\": [\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_attachments_by_type{job=~'$job',instance=~'$instance'}\",\n \"legendFormat\": \"{{mime_type}}\",\n \"refId\": \"A\"\n }\n ],\n \"title\": \"🖼️ Attachments by Type\",\n \"type\": \"piechart\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"description\": \"Distribution of notes by their content type\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"palette-classic\"\n },\n \"custom\": {\n \"hideFrom\": {\n \"legend\": false,\n \"tooltip\": false,\n \"viz\": false\n }\n },\n \"mappings\": [],\n \"unit\": \"short\"\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 8,\n \"w\": 12,\n \"x\": 12,\n \"y\": 8\n },\n \"id\": 203,\n \"options\": {\n \"legend\": {\n \"displayMode\": \"table\",\n \"placement\": \"right\",\n \"showLegend\": true,\n \"values\": [\n \"value\",\n \"percent\"\n ]\n },\n \"pieType\": \"donut\",\n \"reduceOptions\": {\n \"calcs\": [\n \"lastNotNull\"\n ],\n \"fields\": \"\",\n \"values\": false\n },\n \"tooltip\": {\n \"hideZeros\": false,\n \"mode\": \"single\",\n \"sort\": \"none\"\n }\n },\n \"pluginVersion\": \"12.0.1\",\n \"targets\": [\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_notes_by_type{job=~'$job',instance=~'$instance'}\",\n \"legendFormat\": \"{{type}}\",\n \"refId\": \"A\"\n }\n ],\n \"title\": \"📄 Notes by Content Type\",\n \"type\": \"piechart\"\n },\n {\n \"collapsed\": false,\n \"gridPos\": {\n \"h\": 1,\n \"w\": 24,\n \"x\": 0,\n \"y\": 16\n },\n \"id\": 300,\n \"panels\": [],\n \"title\": \"📈 Trends & Time Series\",\n \"type\": \"row\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"description\": \"Growth of notes over time\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"palette-classic\"\n },\n \"custom\": {\n \"axisBorderShow\": false,\n \"axisCenteredZero\": false,\n \"axisColorMode\": \"text\",\n \"axisLabel\": \"\",\n \"axisPlacement\": \"auto\",\n \"barAlignment\": 0,\n \"barWidthFactor\": 0.6,\n \"drawStyle\": \"line\",\n \"fillOpacity\": 20,\n \"gradientMode\": \"hue\",\n \"hideFrom\": {\n \"legend\": false,\n \"tooltip\": false,\n \"viz\": false\n },\n \"insertNulls\": false,\n \"lineInterpolation\": \"smooth\",\n \"lineWidth\": 3,\n \"pointSize\": 8,\n \"scaleDistribution\": {\n \"type\": \"linear\"\n },\n \"showPoints\": \"auto\",\n \"spanNulls\": false,\n \"stacking\": {\n \"group\": \"A\",\n \"mode\": \"none\"\n },\n \"thresholdsStyle\": {\n \"mode\": \"off\"\n }\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\"\n }\n ]\n },\n \"unit\": \"short\"\n },\n \"overrides\": [\n {\n \"matcher\": {\n \"id\": \"byName\",\n \"options\": \"Active Notes\"\n },\n \"properties\": [\n {\n \"id\": \"color\",\n \"value\": {\n \"fixedColor\": \"blue\",\n \"mode\": \"fixed\"\n }\n }\n ]\n },\n {\n \"matcher\": {\n \"id\": \"byName\",\n \"options\": \"Total Notes\"\n },\n \"properties\": [\n {\n \"id\": \"color\",\n \"value\": {\n \"fixedColor\": \"green\",\n \"mode\": \"fixed\"\n }\n }\n ]\n }\n ]\n },\n \"gridPos\": {\n \"h\": 8,\n \"w\": 12,\n \"x\": 0,\n \"y\": 17\n },\n \"id\": 301,\n \"options\": {\n \"legend\": {\n \"calcs\": [\n \"last\",\n \"max\"\n ],\n \"displayMode\": \"table\",\n \"placement\": \"bottom\",\n \"showLegend\": true\n },\n \"tooltip\": {\n \"hideZeros\": false,\n \"mode\": \"multi\",\n \"sort\": \"desc\"\n }\n },\n \"pluginVersion\": \"12.0.1\",\n \"targets\": [\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_notes_active{job=~'$job',instance=~'$instance'}\",\n \"legendFormat\": \"Active Notes\",\n \"refId\": \"A\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_notes_total{job=~'$job',instance=~'$instance'}\",\n \"legendFormat\": \"Total Notes\",\n \"refId\": \"B\"\n }\n ],\n \"title\": \"📈 Notes Growth Over Time\",\n \"type\": \"timeseries\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"description\": \"Attachment storage trends\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"palette-classic\"\n },\n \"custom\": {\n \"axisBorderShow\": false,\n \"axisCenteredZero\": false,\n \"axisColorMode\": \"text\",\n \"axisLabel\": \"\",\n \"axisPlacement\": \"auto\",\n \"barAlignment\": 0,\n \"barWidthFactor\": 0.6,\n \"drawStyle\": \"line\",\n \"fillOpacity\": 20,\n \"gradientMode\": \"hue\",\n \"hideFrom\": {\n \"legend\": false,\n \"tooltip\": false,\n \"viz\": false\n },\n \"insertNulls\": false,\n \"lineInterpolation\": \"smooth\",\n \"lineWidth\": 3,\n \"pointSize\": 8,\n \"scaleDistribution\": {\n \"type\": \"linear\"\n },\n \"showPoints\": \"auto\",\n \"spanNulls\": false,\n \"stacking\": {\n \"group\": \"A\",\n \"mode\": \"none\"\n },\n \"thresholdsStyle\": {\n \"mode\": \"off\"\n }\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\"\n }\n ]\n },\n \"unit\": \"short\"\n },\n \"overrides\": [\n {\n \"matcher\": {\n \"id\": \"byName\",\n \"options\": \"Active Attachments\"\n },\n \"properties\": [\n {\n \"id\": \"color\",\n \"value\": {\n \"fixedColor\": \"purple\",\n \"mode\": \"fixed\"\n }\n }\n ]\n },\n {\n \"matcher\": {\n \"id\": \"byName\",\n \"options\": \"Total Attachments\"\n },\n \"properties\": [\n {\n \"id\": \"color\",\n \"value\": {\n \"fixedColor\": \"orange\",\n \"mode\": \"fixed\"\n }\n }\n ]\n }\n ]\n },\n \"gridPos\": {\n \"h\": 8,\n \"w\": 12,\n \"x\": 12,\n \"y\": 17\n },\n \"id\": 302,\n \"options\": {\n \"legend\": {\n \"calcs\": [\n \"last\",\n \"max\"\n ],\n \"displayMode\": \"table\",\n \"placement\": \"bottom\",\n \"showLegend\": true\n },\n \"tooltip\": {\n \"hideZeros\": false,\n \"mode\": \"multi\",\n \"sort\": \"desc\"\n }\n },\n \"pluginVersion\": \"12.0.1\",\n \"targets\": [\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_attachments_active{job=~'$job',instance=~'$instance'}\",\n \"legendFormat\": \"Active Attachments\",\n \"refId\": \"A\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_attachments_total{job=~'$job',instance=~'$instance'}\",\n \"legendFormat\": \"Total Attachments\",\n \"refId\": \"B\"\n }\n ],\n \"title\": \"📎 Attachments Growth Over Time\",\n \"type\": \"timeseries\"\n },\n {\n \"collapsed\": false,\n \"gridPos\": {\n \"h\": 1,\n \"w\": 24,\n \"x\": 0,\n \"y\": 25\n },\n \"id\": 400,\n \"panels\": [],\n \"title\": \"🔧 Advanced Metrics\",\n \"type\": \"row\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"description\": \"Number of branches connecting notes\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"thresholds\"\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\"\n }\n ]\n },\n \"unit\": \"short\"\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 4,\n \"w\": 6,\n \"x\": 0,\n \"y\": 26\n },\n \"id\": 401,\n \"options\": {\n \"colorMode\": \"value\",\n \"graphMode\": \"none\",\n \"justifyMode\": \"center\",\n \"orientation\": \"auto\",\n \"percentChangeColorMode\": \"standard\",\n \"reduceOptions\": {\n \"calcs\": [\n \"lastNotNull\"\n ],\n \"fields\": \"\",\n \"values\": false\n },\n \"showPercentChange\": false,\n \"textMode\": \"auto\",\n \"wideLayout\": true\n },\n \"pluginVersion\": \"12.0.1\",\n \"targets\": [\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_branches_total{job=~'$job',instance=~'$instance'}\",\n \"refId\": \"A\"\n }\n ],\n \"title\": \"🌳 Total Branches\",\n \"type\": \"stat\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"description\": \"Number of note attributes\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"thresholds\"\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\"\n }\n ]\n },\n \"unit\": \"short\"\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 4,\n \"w\": 6,\n \"x\": 6,\n \"y\": 26\n },\n \"id\": 402,\n \"options\": {\n \"colorMode\": \"value\",\n \"graphMode\": \"none\",\n \"justifyMode\": \"center\",\n \"orientation\": \"auto\",\n \"percentChangeColorMode\": \"standard\",\n \"reduceOptions\": {\n \"calcs\": [\n \"lastNotNull\"\n ],\n \"fields\": \"\",\n \"values\": false\n },\n \"showPercentChange\": false,\n \"textMode\": \"auto\",\n \"wideLayout\": true\n },\n \"pluginVersion\": \"12.0.1\",\n \"targets\": [\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_attributes_total{job=~'$job',instance=~'$instance'}\",\n \"refId\": \"A\"\n }\n ],\n \"title\": \"🏷️ Attributes\",\n \"type\": \"stat\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"description\": \"Number of note revisions\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"thresholds\"\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\"\n }\n ]\n },\n \"unit\": \"short\"\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 4,\n \"w\": 6,\n \"x\": 12,\n \"y\": 26\n },\n \"id\": 403,\n \"options\": {\n \"colorMode\": \"value\",\n \"graphMode\": \"none\",\n \"justifyMode\": \"center\",\n \"orientation\": \"auto\",\n \"percentChangeColorMode\": \"standard\",\n \"reduceOptions\": {\n \"calcs\": [\n \"lastNotNull\"\n ],\n \"fields\": \"\",\n \"values\": false\n },\n \"showPercentChange\": false,\n \"textMode\": \"auto\",\n \"wideLayout\": true\n },\n \"pluginVersion\": \"12.0.1\",\n \"targets\": [\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_revisions_total{job=~'$job',instance=~'$instance'}\",\n \"refId\": \"A\"\n }\n ],\n \"title\": \"🔄 Revisions\",\n \"type\": \"stat\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"description\": \"Number of ETAPI tokens\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"thresholds\"\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\"\n }\n ]\n },\n \"unit\": \"short\"\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 4,\n \"w\": 6,\n \"x\": 18,\n \"y\": 26\n },\n \"id\": 404,\n \"options\": {\n \"colorMode\": \"value\",\n \"graphMode\": \"none\",\n \"justifyMode\": \"center\",\n \"orientation\": \"auto\",\n \"percentChangeColorMode\": \"standard\",\n \"reduceOptions\": {\n \"calcs\": [\n \"lastNotNull\"\n ],\n \"fields\": \"\",\n \"values\": false\n },\n \"showPercentChange\": false,\n \"textMode\": \"auto\",\n \"wideLayout\": true\n },\n \"pluginVersion\": \"12.0.1\",\n \"targets\": [\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_etapi_tokens_total{job=~'$job',instance=~'$instance'}\",\n \"refId\": \"A\"\n }\n ],\n \"title\": \"🔑 API Tokens\",\n \"type\": \"stat\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"description\": \"Various storage and system metrics\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"palette-classic\"\n },\n \"custom\": {\n \"axisBorderShow\": false,\n \"axisCenteredZero\": false,\n \"axisColorMode\": \"text\",\n \"axisLabel\": \"\",\n \"axisPlacement\": \"auto\",\n \"barAlignment\": 0,\n \"barWidthFactor\": 0.6,\n \"drawStyle\": \"line\",\n \"fillOpacity\": 10,\n \"gradientMode\": \"none\",\n \"hideFrom\": {\n \"legend\": false,\n \"tooltip\": false,\n \"viz\": false\n },\n \"insertNulls\": false,\n \"lineInterpolation\": \"linear\",\n \"lineWidth\": 2,\n \"pointSize\": 5,\n \"scaleDistribution\": {\n \"type\": \"linear\"\n },\n \"showPoints\": \"auto\",\n \"spanNulls\": false,\n \"stacking\": {\n \"group\": \"A\",\n \"mode\": \"none\"\n },\n \"thresholdsStyle\": {\n \"mode\": \"off\"\n }\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\"\n }\n ]\n },\n \"unit\": \"short\"\n },\n \"overrides\": [\n {\n \"matcher\": {\n \"id\": \"byName\",\n \"options\": \"Recent Notes\"\n },\n \"properties\": [\n {\n \"id\": \"color\",\n \"value\": {\n \"fixedColor\": \"yellow\",\n \"mode\": \"fixed\"\n }\n }\n ]\n }\n ]\n },\n \"gridPos\": {\n \"h\": 8,\n \"w\": 12,\n \"x\": 0,\n \"y\": 30\n },\n \"id\": 405,\n \"options\": {\n \"legend\": {\n \"calcs\": [\n \"last\"\n ],\n \"displayMode\": \"table\",\n \"placement\": \"bottom\",\n \"showLegend\": true\n },\n \"tooltip\": {\n \"hideZeros\": false,\n \"mode\": \"multi\",\n \"sort\": \"desc\"\n }\n },\n \"pluginVersion\": \"12.0.1\",\n \"targets\": [\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_blobs_total{job=~'$job',instance=~'$instance'}\",\n \"legendFormat\": \"Blob Records\",\n \"refId\": \"A\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_recent_notes_total{job=~'$job',instance=~'$instance'}\",\n \"legendFormat\": \"Recent Notes\",\n \"refId\": \"B\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_embeddings_total{job=~'$job',instance=~'$instance'}\",\n \"legendFormat\": \"Embeddings\",\n \"refId\": \"C\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_embedding_providers_total{job=~'$job',instance=~'$instance'}\",\n \"legendFormat\": \"Embedding Providers\",\n \"refId\": \"D\"\n }\n ],\n \"title\": \"📊 Storage & System Metrics\",\n \"type\": \"timeseries\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"description\": \"Timeline showing when content was created and last modified\",\n \"fieldConfig\": {\n \"defaults\": {\n \"color\": {\n \"mode\": \"palette-classic\"\n },\n \"custom\": {\n \"axisBorderShow\": false,\n \"axisCenteredZero\": false,\n \"axisColorMode\": \"text\",\n \"axisLabel\": \"\",\n \"axisPlacement\": \"auto\",\n \"barAlignment\": 0,\n \"barWidthFactor\": 0.6,\n \"drawStyle\": \"points\",\n \"fillOpacity\": 0,\n \"gradientMode\": \"none\",\n \"hideFrom\": {\n \"legend\": false,\n \"tooltip\": false,\n \"viz\": false\n },\n \"insertNulls\": false,\n \"lineInterpolation\": \"linear\",\n \"lineWidth\": 1,\n \"pointSize\": 8,\n \"scaleDistribution\": {\n \"type\": \"linear\"\n },\n \"showPoints\": \"always\",\n \"spanNulls\": false,\n \"stacking\": {\n \"group\": \"A\",\n \"mode\": \"none\"\n },\n \"thresholdsStyle\": {\n \"mode\": \"off\"\n }\n },\n \"mappings\": [],\n \"thresholds\": {\n \"mode\": \"absolute\",\n \"steps\": [\n {\n \"color\": \"green\"\n }\n ]\n },\n \"unit\": \"dateTimeAsIso\"\n },\n \"overrides\": []\n },\n \"gridPos\": {\n \"h\": 8,\n \"w\": 12,\n \"x\": 12,\n \"y\": 30\n },\n \"id\": 406,\n \"options\": {\n \"legend\": {\n \"calcs\": [],\n \"displayMode\": \"list\",\n \"placement\": \"bottom\",\n \"showLegend\": true\n },\n \"tooltip\": {\n \"hideZeros\": false,\n \"mode\": \"single\",\n \"sort\": \"none\"\n }\n },\n \"pluginVersion\": \"12.0.1\",\n \"targets\": [\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_oldest_note_timestamp{job=~'$job',instance=~'$instance'} * 1000\",\n \"legendFormat\": \"Oldest Note\",\n \"refId\": \"A\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_newest_note_timestamp{job=~'$job',instance=~'$instance'} * 1000\",\n \"legendFormat\": \"Newest Note\",\n \"refId\": \"B\"\n },\n {\n \"datasource\": {\n \"uid\": \"${datasource}\"\n },\n \"expr\": \"trilium_last_modified_timestamp{job=~'$job',instance=~'$instance'} * 1000\",\n \"legendFormat\": \"Last Modified\",\n \"refId\": \"C\"\n }\n ],\n \"title\": \"⏰ Content Timeline\",\n \"type\": \"timeseries\"\n }\n ],\n \"preload\": false,\n \"refresh\": \"1m\",\n \"schemaVersion\": 41,\n \"tags\": [\n \"trilium\",\n \"notes\",\n \"monitoring\",\n \"enhanced\"\n ],\n \"templating\": {\n \"list\": [\n {\n \"current\": {\n \"text\": \"myprom\",\n \"value\": \"PA04845DA3A4B088E\"\n },\n \"includeAll\": false,\n \"label\": \"Datasource\",\n \"name\": \"datasource\",\n \"options\": [],\n \"query\": \"prometheus\",\n \"refresh\": 1,\n \"regex\": \"//\",\n \"type\": \"datasource\"\n },\n {\n \"allValue\": \".*\",\n \"current\": {\n \"text\": \"All\",\n \"value\": \"$__all\"\n },\n \"datasource\": {\n \"UID\": \"\",\n \"type\": \"\"\n },\n \"includeAll\": true,\n \"label\": \"Job\",\n \"multi\": true,\n \"name\": \"job\",\n \"options\": [],\n \"query\": \"query_result(up)\",\n \"refresh\": 1,\n \"regex\": \"/job=\\\"([^\\\"]+)\\\"/\",\n \"sort\": 1,\n \"type\": \"query\"\n },\n {\n \"allValue\": \".*\",\n \"current\": {\n \"text\": [\n \"All\"\n ],\n \"value\": [\n \"$__all\"\n ]\n },\n \"datasource\": {\n \"type\": \"prometheus\",\n \"uid\": \"${datasource}\"\n },\n \"includeAll\": true,\n \"label\": \"Instance\",\n \"multi\": true,\n \"name\": \"instance\",\n \"options\": [],\n \"query\": \"trilium_database_size_bytes\",\n \"refresh\": 1,\n \"regex\": \"/instance=\\\"([^\\\"]+)\\\"/\",\n \"sort\": 1,\n \"type\": \"query\"\n }\n ]\n },\n \"time\": {\n \"from\": \"now-1h\",\n \"to\": \"now\"\n },\n \"timepicker\": {},\n \"timezone\": \"browser\",\n \"title\": \"TriliumNext Dashboard\",\n \"uid\": \"06993f9b-a477-4723-bf18-47743393b382\",\n \"version\": 5\n}",
- "_help_64ZTlUPgEPtW": "<p>Safe mode is triggered by setting the <code spellcheck=\"false\">TRILIUM_SAFE_MODE</code> environment variable to a truthy value, usually <code spellcheck=\"false\">1</code>.</p><p>In each artifact there is a <code spellcheck=\"false\">trilium-safe-mode.sh</code> (or <code spellcheck=\"false\">.bat</code>) script to enable it.</p><p>What it does:</p><ul><li>Disables <code spellcheck=\"false\">customWidget</code> launcher types in <code spellcheck=\"false\">app/widgets/containers/launcher.js</code>.</li><li>Disables the running of <code spellcheck=\"false\">mobileStartup</code> or <code spellcheck=\"false\">frontendStartup</code> scripts.</li><li>Displays the root note instead of the previously saved session.</li><li>Disables the running of <code spellcheck=\"false\">backendStartup</code>, <code spellcheck=\"false\">hourly</code>, <code spellcheck=\"false\">daily</code> scripts and checks for the hidden subtree.</li></ul>",
- "_help_HAIOFBoYIIdO": "<p>Nightly releases are versions built every day, containing the latest improvements and bugfixes, directly from the main development branch. These versions are generally useful in preparation for a release, to ensure that there are no significant bugs that need to be addressed first, or they can be used to confirm whether a particular bug is fixed or feature is well implemented.</p><h2>Regarding the stability</h2><p>Despite being on a development branch, generally the main branch is pretty stable since PRs are tested before they are merged. If you notice any issues, feel free to report them either via a ticket or via the Matrix.</p><h2>Downloading the nightly release manually</h2><p>Go to <a href=\"https://github.com/TriliumNext/Trilium/releases/tag/nightly\">github.com/TriliumNext/Trilium/releases/tag/nightly</a> and look for the artifacts starting with <code spellcheck=\"false\">TriliumNotes-main</code>. Choose the appropriate one for your platform (e.g. <code spellcheck=\"false\">windows-x64.zip</code>).</p><p>Depending on your use case, you can either test the portable version or even use the installer.</p><aside class=\"admonition note\"><p>If you choose the installable version (e.g. the .exe on Windows), it will replace your stable installation.</p></aside><aside class=\"admonition important\"><p>By default, the nightly uses the same database as the production version. Generally you could easily downgrade if needed. However, if there are changes to the database or sync version, it will not be possible to downgrade without having to restore from a backup.</p></aside><h2>Automatically download and install the latest nightly</h2><p>This is pretty useful if you are a beta tester that wants to periodically update their version:</p><h2>On Ubuntu (Bash)</h2><pre><code class=\"language-text-x-sh\">#!/usr/bin/env bash\n\nname=TriliumNotes-linux-x64-nightly.deb\nrm -f $name*\nwget https://github.com/TriliumNext/Trilium/releases/download/nightly/$name\nsudo apt-get install ./$name\nrm $name</code></pre><h2>On Windows (PowerShell)</h2><pre><code class=\"language-application-x-powershell\">if ($env:PROCESSOR_ARCHITECTURE -eq \"ARM64\") {\n $arch = \"arm64\";\n} else {\n $arch = \"x64\";\n}\n\n$exeUrl = \"https://github.com/TriliumNext/Trilium/releases/download/nightly/TriliumNotes-main-windows-$($arch).exe\";\nWrite-Host \"Downloading $($exeUrl)\"\n\n# Generate a unique path in the temp dir\n$guid = [guid]::NewGuid().ToString()\n$destination = Join-Path -Path $env:TEMP -ChildPath \"$guid.exe\"\n\ntry {\n $ProgressPreference = 'SilentlyContinue'\n Invoke-WebRequest -Uri $exeUrl -OutFile $destination\n $process = Start-Process -FilePath $destination\n} catch {\n Write-Error \"An error occurred: $_\"\n} finally {\n # Clean up\n if (Test-Path $destination) {\n Remove-Item -Path $destination -Force\n }\n}</code></pre>",
- "_help_ZmT9ln8XJX2o": "<aside class=\"admonition warning\"><p>This functionality is still in preview, expect possible issues or even the feature disappearing completely.<br>Feel free to <a href=\"#root/_help_wy8So3yZZlH9\">report</a> any issues you might have.</p></aside><p>The read-only database is an alternative to&nbsp;<a class=\"reference-link\" href=\"#root/_help_R9pX4DGra2Vt\">Sharing</a>&nbsp;notes. Although the share functionality works pretty well to publish pages to the Internet in a wiki, blog-like format it does not offer the full functionality behind Trilium (such as the advanced&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>&nbsp;or the interactivity behind&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>&nbsp;or the various&nbsp;<a class=\"reference-link\" href=\"#root/_help_KSZ04uQ2D1St\">Note Types</a>).</p><p>When the database is in read-only mode, the Trilium application can be used as normal, but editing is disabled and changes are made in-memory only.</p><h2>What it does</h2><ul><li>All notes are read-only, without the possibility of editing them.</li><li>Features that would normally alter the database such as the list of recent notes are disabled.</li></ul><h2>Limitations</h2><ul><li>Some features might “slip through” and still end up creating a note, for example.<ul><li>However, the database is still read-only, so all modifications will be reset if the server is restarted.</li><li>Whenever this occurs, <code spellcheck=\"false\">ERROR: read-only DB ignored</code> will be shown in the logs.</li></ul></li></ul><h2>Setting a database as read-only</h2><p>First, make sure the database is initialized (e.g. the first set up is complete). Then modify the <a href=\"#root/_help_Gzjqa934BdH4\">config.ini</a> by looking for the <code spellcheck=\"false\">[General]</code> section and adding a new <code spellcheck=\"false\">readOnly</code> field:</p><pre><code class=\"language-text-x-trilium-auto\">[General]\nreadOnly=true</code></pre><p>If your server is already running, restart it to apply the changes.</p><p>Similarly, to disable read-only remove the line or set it to <code spellcheck=\"false\">false</code>.</p>",
- "_help_TiQbQDgP8L5t": "<p>Optical Character Recognition is the process in which the text from images or PDFs is extracted.</p><h2>Built-in support</h2><p>Since v0.103.0, Trilium has built-in support for OCR. The extracted text can be:</p><ul><li>Integrated with&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>, to quickly find the image or file based on snippets of text.</li><li>Integrated with the&nbsp;<a class=\"reference-link\" href=\"#root/_help_GBBMSlVSOIGP\">AI</a>&nbsp;feature, which allows the agent to access the content of a non-text note.</li><li>Manually accessed for other purposes (e.g. copying into a note or sending it somewhere else).</li></ul><h2>Supported formats</h2><p>OCR in Trilium supports the following formats:</p><h3>Images</h3><ul><li>Both <a href=\"#root/_help_W8vYD3Q1zjCR\">individual image notes</a> and <a href=\"#root/_help_mT0HEkOsz6i1\">attachments in text files</a> are supported.</li><li>Supported formats:<ul><li>JPEG</li><li>PNG</li><li>GIF (only non-animated)</li><li>BMP</li><li>WebP</li></ul></li><li>Note that this feature works best for computer-rendered text rather than handwriting.</li><li>The underlying technology is Tesseract.js.</li></ul><h3>PDFs</h3><p>Currently only text extraction is supported and not OCR.</p><ul><li>This means that the PDF needs to have proper text information in it (i.e. the text can be selected in a PDF viewer), whereas scanned documents are not yet supported.</li><li>There are plans to integrate the same OCR-based recognition for PDFs used for images, but this is not yet implemented.</li></ul><h3>Office documents</h3><p>The text will be extracted from the following file formats:</p><ul><li>Microsoft Word documents</li><li>Microsoft Excel documents<ul><li>Only the raw text information, the cell structure is not maintained.</li><li>Values are extracted raw, so searching for dates will not work. The OpenDocument alternative will actually extract the properly formatted value.</li></ul></li><li>Microsoft PowerPoint documents</li><li>The OpenDocument alternatives to the previous formats (Text, Spreadsheet, Presentation), created by editors such as LibreOffice and OpenOffice.</li><li><a href=\"https://en.wikipedia.org/wiki/Rich_Text_Format\">Rich Text Format (RTF)</a>, since v0.104.0.</li><li><a href=\"https://en.wikipedia.org/wiki/EPUB\">EPUB</a>, since v0.104.1.</li></ul><h2>Configuring and triggering OCR</h2><p>The OCR can be configured by going to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→&nbsp;<a class=\"reference-link\" href=\"#root/_hidden/_options/_optionsMedia\">Media</a>&nbsp;and looking for the <em>Text Extraction (OCR)</em> section.</p><p>There are three ways to trigger the OCR:</p><ul><li>By enabling <em>Auto-process new files</em> which will process only the notes or attachments created after enabling the option, existing files will remain unprocessed.</li><li>By pressing <em>Start Batch Processing</em> which will process all the existing notes.</li><li>By manually requesting for an image or file to have its text extracted, regardless of whether the automatic processing is enabled or not.</li></ul><h3>Minimum confidence</h3><p>When extracting text from an image, there is a certain level of confidence which indicates whether the extracted text appears relevant.</p><p>When the minimum confidence is set to a low percentage, the text extraction can interpret symbols and drawings incorrectly resulting in garbled text.</p><p>If the extracted text for a note or an attachment quality is lower than the minimum confidence, the OCR is disregarded.</p><h2>Language management</h2><p>OCR needs to be aware of the language of the content in order for it to work correctly. The reason is that each language has its own data which needs to be downloaded, and accents or other symbols will not be supported by the default language.</p><p>To configure the languages that are supported by the OCR, simply go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→&nbsp;<a class=\"reference-link\" href=\"#root/_hidden/_options/_optionsLocalization\">Language &amp; Region</a>&nbsp;and adjust the <em>Content languages</em>.</p><p>When there are no content languages defined, the user interface <em>Language</em> is used instead.</p><p>After making this change, the automatic processing or manual reprocessing will take into consideration the new languages.</p><p>To enforce the detection in a particular language for a given note, use the <code spellcheck=\"false\">language</code> <a href=\"#root/_help_zEY4DaJG4YT5\">attribute</a>, similar to <a href=\"#root/_help_veGu4faJErEM\">text content language</a>. For&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>, it's not possible to manually adjust the language.</p><aside class=\"admonition note\"><p>The trained data for each language is not packaged with Trilium, as that would require a significant amount of space that might not be otherwise needed. As such, when the trained data will be downloaded automatically via <a href=\"https://github.com/naptha/tesseract.js/\">Tesseract.js</a>.</p><p>The downloaded trained data is located in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_tAassRL4RSQL\">Data directory</a>, in the <code spellcheck=\"false\">ocr-cache</code> directory.</p></aside><h2>Viewing extracted content for a single note</h2><p>To access the extracted content of a note:</p><ul><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a>&nbsp;notes, go to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note buttons</a>&nbsp;→ <em>Advanced</em> → <em>View OCR Text</em>.</li><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>&nbsp;(e.g.&nbsp;<a class=\"reference-link\" href=\"#root/_help_mT0HEkOsz6i1\">Images</a>&nbsp;in&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes), double-click the attachment to view the details, press the […] button at the left and select <em>View extracted text (OCR)</em>.</li></ul><p>This section allows:</p><ul><li>Viewing the extracted text, which can be copied elsewhere if needed or just to check the quality of the extraction.</li><li>If the note has not been extracted yet, pressing <em>Process OCR</em> will process it in the background. If the extraction confidence is lower than the minimum confidence, there will be a notification.</li><li>Similarly, if the minimum confidence was changed in settings, it is possible to press the <em>Process OCR</em> button again to extract the text again.</li></ul>",
- "_help_GBBMSlVSOIGP": "<p>Trilium can connect to a large language model and use it as an assistant that works directly on your notes: ask questions about the note you're reading, have it draft or restructure content, or get it to write scripts and widgets for you.</p><p>The integration is off by default and does nothing until you enable it and configure a provider; Trilium ships no model of its own. Which provider you pick also decides where your notes travel: a cloud API billed per use, a subscription you already pay for, or a model running on your own hardware, in which case nothing leaves the machine. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_bkPZAMT7d2sR\">Providers</a>&nbsp;for what each involves, and&nbsp;<a class=\"reference-link\" href=\"#root/_help_cRRrdZjgyhNc\">Privacy</a>&nbsp;for exactly what gets sent.</p><p>Once enabled, the assistant is available both as a panel in the right sidebar and as a dedicated note type. It can read and modify notes through tools, which you can switch off per conversation if you would rather it only saw what you type.</p><h2>Feature highlights</h2><ul><li>Chat-based interface with live streaming of the messages.</li><li>Provides the AI context with the note currently being looked at.</li><li>Tools to alter note content, create new notes, etc.</li><li>Statistics regarding context window use and pricing per message.</li><li>Attachments for multi-modal chat (images, text files, PDFs).</li><li>Optional MCP to allow external chat tools (e.g. Claude Code) to operate on notes within Trilium.</li></ul><h2>Sample use-cases</h2><ul><li>Create any type of&nbsp;<a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>.</li><li>Easily create a&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>, e.g. <em>Create for me a render note which allows me to play tic-tac-toe. Make sure to use Preact instead of the legacy jQuery.</em></li><li>Create widgets for a&nbsp;<a class=\"reference-link\" href=\"#root/_help_IF7Q6I9x7zuw\">Dashboard</a>, such as a calculator, a stopwatch, a pomodoro timer.</li></ul><aside class=\"admonition note\"><p>Claude Sonnet is known to produce very good frontend or backend scripts with little guidance, as the AI has been instructed in how to produce them.</p></aside><h2>LLM Providers</h2><p>Trilium supports four different types of providers:</p><ul><li><strong>Cloud providers</strong><br>Pay-per use with an API key which is billed separately from any subscription you might already have<ul><li>Anthropic (Claude)</li><li>OpenAI (GPT)</li><li>Google (Gemini)</li><li>DeepSeek</li></ul></li><li><strong>Subscription-based</strong><br>Reuses an existing subscription instead of paying per use.<ul><li>Currently only Claude Code is supported.</li></ul></li><li><strong>Local or self-hosted LLM solutions</strong><ul><li>Ollama</li><li>LM Studio.</li></ul></li><li><strong>Custom OpenAI compatible endpoints</strong><br>For other providers that are not directly supported by Trilium, either local or hosted (e.g. OpenRouter, Groq, Mistral).</li></ul><p>For more information about each provider, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_bkPZAMT7d2sR\">Providers</a>. See the dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_cRRrdZjgyhNc\">Privacy</a>&nbsp;to better understand what data is sent to providers.</p><h2>Enabling the AI integration</h2><p>To enable the AI integration, simply go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>AI / LLM</em> and press the toggle in the top-right of the dialog and configure a provider.</p><h2>Creating a new chat</h2><p>There are two different chat interfaces:</p><ul><li>One in the sidebar.</li><li>A dedicated note type.</li></ul><h3>The sidebar interface</h3><h3>The dedicated note type</h3><p>The dedicated chat note is similar to the sidebar interface, but it makes longer conversations more comfortable to read.</p><p>Unlike the sidebar, the AI will not be aware of the current note it's in.</p><h3>Templates</h3><p>Chat notes can be set as&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>&nbsp;to make them easily reusable. The entire conversation history is kept, allowing a basic form of specialization for the LLM with the existing chat acting like a system prompt.&nbsp;</p><h3>Model selection</h3><p>When a provider is configured in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>, the next step is to select the models that will be available for the chat.</p><p>The models are retrieved dynamically from the provider, only when the model selection list is visible. To alter the list of models, simply press the Edit button in the model selection box.</p><p>Pricing information is displayed for known models. The pricing information (price per million tokens) is embedded in the application (using a subset of LiteLLM's data) and is updated with new versions of Trilium. Local providers are considered free, whereas custom endpoint providers don't offer any pricing information.</p><h2>Features</h2><h3>Web search</h3><p>The AI can optionally search the web to find more information about a specific topic.&nbsp;</p><p>This feature is on by default but it can easily be disabled by clicking on the model selector at the bottom of the chat and unchecking <em>Web search</em>.</p><aside class=\"admonition note\"><p>Currently only the search native to the LLM provider is supported. External search providers such as Exa, Tavily &amp; SearXNG are not yet supported.</p></aside><h3>Note access (tools)</h3><p>Tools allow the agentic AI to understand and operate on notes directly within your Trilium instance.</p><p>This feature is on by default but it can easily be disabled by clicking on the model selector at the bottom of the chat and unchecking <em>Note access</em>.</p><p>Here are a few tools that Trilium provides for the LLM:</p><ul><li>At note level:<ul><li>Search for notes</li><li>Get the metadata or content of a note.</li><li>Edit a note<ul><li>There are multiple mechanism for the LLM to edit a note: completely by re-writing it, find/replace of a text sequence or append.</li><li>Whenever the AI makes a change, a <a href=\"#root/_help_vZWERwf8U3nx\">revision</a> is saved to be able to revert any unwanted changes.</li></ul></li><li>Create a new note</li><li>Rename or delete a note.</li></ul></li><li>At attribute level:<ul><li>Get the full list of attributes, or a specific attribute.</li><li>Set the value of an attribute.</li><li>Delete an attribute.</li></ul></li><li>At tree level:<ul><li>Get the direct children of a note.</li><li>Get the entire subtree of a note.</li><li>Move or clone a note somewhere else.</li></ul></li><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>:<ul><li>Get metadata for an attachment.</li><li>Get the content of an attachment.</li></ul></li><li>Skills (see the dedicated section).</li></ul><aside class=\"admonition warning\"><p>Currently there is <strong>no permission management</strong> implemented for note tools, meaning that the LLM could potentially remove existing notes or clutter the tree with notes. Generally most actions are easily reversible (deleting the notes, restoring deleted notes, reverting modifications to a note), but there are some that are harder to revert (e.g. setting an attribute because there is no attribute history).</p></aside><aside class=\"admonition note\"><p>Gemini has a special case in which <em>Note access</em> and <em>Web search</em> can't be both enabled at the same time.</p></aside><h3>Attachments</h3><p>Since Trilium v0.140.0,&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>&nbsp;allow for multi-modal chat:</p><ul><li>Raster image (sent as vision input, except for SVGs) with the following supported formats: PNG, JPEG, GIF, WebP.</li><li>PDFs, sent natively to the provider (supported by Anthropic, OpenAI and Google).</li><li>SVG images (sent as raw HTML).</li><li>Text files.</li></ul><p>To upload an attachment:</p><ul><li>Press the dedicated <em>Attach</em> button (paperclip icon) underneath the text box.</li><li>Paste an image directly from clipboard using <kbd>Ctrl</kbd>+<kbd>V</kbd>.</li></ul><p>Once one or more attachments are uploaded, they will appear directly above the text box:</p><ul><li>Images have a small thumbnail for easy identifications.</li><li>Every attachment can be deleted by pressing their corresponding X button.</li></ul><p>When an attachment is present, the LLM is instructed to consider the attachment with priority, even if it has access to the current note.</p><aside class=\"admonition note\"><p>Currently Trilium doesn't pre-process the attachments (e.g. via&nbsp;<a class=\"reference-link\" href=\"#root/_help_TiQbQDgP8L5t\">Text Extraction (OCR)</a>) before sending them to the LLM provider.</p></aside><h3>Mentions</h3><p>Mentions are a way to insert references to notes other than the current note, using the same mechanism as&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>. To refer to another note, simply type <kbd>@</kbd> followed by the name of the note to reference.</p><p>This feature is mostly helpful when note tools are enabled, otherwise the LLM will have no way to access the given note.</p><h3>Skills</h3><p>Skills in Trilium are specialized instruction sets that help the AI be more productive by understanding how Trilium.</p><p>These skills are not loaded by default to avoid an increased consumption of tokens, but the AI can load them on-demand if <em>Note tools</em> are enabled.</p><p>The following skills are built-in:</p><ul><li>Search syntax: understands the full syntax of&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>.</li><li>Backend scripting: to be able to write proper&nbsp;<a class=\"reference-link\" href=\"#root/_help_SPirpZypehBG\">Backend scripts</a>.</li><li>Frontend scripting: to be able to write proper <a href=\"#root/_help_yIhgI5H7A2Sm\">front-end scripts</a> (basic scripts, widgets,&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>).</li></ul><p>When <em>Note tools</em> are enabled the skills will automatically be made available to the AI, so no user interaction is required.</p><aside class=\"admonition note\"><p>Custom skills are currently not supported but they are planned.</p></aside><h3>MCP</h3><p>Trilium comes with a built-in MCP server which allows you to use an external agent such as Claude Code have access to your database. See the dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_KOWBFgsZXJAD\">MCP</a>&nbsp;page for more details.</p><h2>History</h2><h3>Removal in v0.102.0</h3><p>Starting with version v0.102.0, AI/LLM integration has been removed from the Trilium Notes core.</p><p>While a significant amount of effort went into developing this feature, maintaining and supporting it long-term proved to be unsustainable.</p><p>When upgrading to v0.102.0, your Chat notes will be preserved, but instead of the dedicated chat window they will be turned to a normal&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note, revealing the underlying JSON of the conversation.</p><h3>Reintroduction in v0.103.0</h3><p>Given the recent advancements of the AI scene, we decided to give the LLM integration another try. v0.103.0 introduces a completely new chat system.</p><p>One of the key changes that lead to the reimplementation is that now we are using a library (<a href=\"https://github.com/vercel/ai\">Vercel AI</a>) to manage the inner mechanism and the differences between LLM providers instead of having to implement it on our own.</p>",
- "_help_bkPZAMT7d2sR": "<h2>Cloud providers using API keys</h2><p>Currently, the following cloud providers are supported:</p><ul><li><a href=\"https://platform.claude.com/settings/workspaces/default/keys\">Anthropic</a></li><li>OpenAI</li><li>Gemini</li><li>DeepSeek</li></ul><p>For all the providers, an API key is needed. Note that this is charged separately from the subscription you might already have (e.g. Claude Pro). If that might be a problem, consider using either a subscription provider (see below) or using it externally via MCP.</p><p>Do note that most other LLM providers (e.g. OpenRouter, Groq, Mistral) can still be used in Trilium via the OpenAI-compatible custom endpoint (see below).</p><p>If you are using a proxy or gateway, you can also configure the base URL, otherwise the default will be used.</p><aside class=\"admonition note\"><p>We don't plan to support all cloud providers, even if the library we are using would theoretically support them. Before opening a PR adding support for a different cloud provider, make sure to discuss it over <a href=\"https://github.com/orgs/TriliumNext/discussions\">GitHub Discussions</a>.</p></aside><aside class=\"admonition important\"><p>See also the dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_cRRrdZjgyhNc\">Privacy</a>&nbsp;section to better understand what data is being sent to a cloud provider.</p></aside><h2>Subscription-based providers</h2><aside class=\"admonition important\"><p>Subscription-based providers are still in beta. They are safe to use (they won't use additional funds and respect the terms of use), but you might experience small issues. Consider&nbsp;<a class=\"reference-link\" href=\"#root/_help_wy8So3yZZlH9\">Reporting issues</a>.</p></aside><p>Some cloud providers offer a subscription, which has a fixed monthly fee instead of pay-per-use (unlike the API keys). Trilium v0.104.0 introduces beta support for Anthropic's Claude Pro/Max subscriptions. Other subscription-based providers such as ChatGPT are on the roadmap, but not yet implemented.</p><p>To use a subscription:</p><ol><li>First, Claude Code needs to be installed on the machine that runs Trilium. So for a&nbsp;<a class=\"reference-link\" href=\"#root/_help_poXkQfguuA0U\">Desktop Installation</a>, Claude needs to be installed locally and for a&nbsp;<a class=\"reference-link\" href=\"#root/_help_WOcw2SLH6tbX\">Server Installation</a>&nbsp;accessed via a browser, Claude needs to be installed on the server.</li><li>Claude Code must already be authenticated. To do so, run <code spellcheck=\"false\">claude</code> in a terminal once, type <code spellcheck=\"false\">/login</code> and follow the instructions.</li><li>Go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>AI / LLM</em> and add the Claude Code provider.</li></ol><p>Trilium will identify your Claude Code binary in this order:</p><ul><li>By looking for a <code spellcheck=\"false\">TRILIUM_CLAUDE_CODE_PATH</code> environment variable pointing to the Claude binary. This allows overriding the path if needed.</li><li>By looking for <code spellcheck=\"false\">claude</code> in your PATH, generally works in most circumstances.</li></ul><p>After your provider is set up, you'll benefit from the same features as an API key (note tools, web search, extended thinking, image/PDF attachments, streaming).</p><aside class=\"admonition note\"><p>Trilium intentionally uses your Claude Code binary in order not to have to package a ~250 MB client with it, but this comes at a cost: there is a small risk for a version incompatibility, if the version installed locally doesn't match the one expected by Trilium. Generally it's best to keep both Claude Code and Trilium updated to the latest version.</p></aside><aside class=\"admonition important\"><p>See also the dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_cRRrdZjgyhNc\">Privacy</a>&nbsp;section to better understand what data is being sent to a cloud provider.</p></aside><h2>Local/self-hosted providers</h2><p>Local or self-hosted providers are a free alternative which respects your privacy but requires specific hardware.</p><p>Trilium directly supports the following local providers:</p><ul><li>Ollama<ul><li>Generally Ollama runs in the background so it should be directly usable in Trilium as long as the models are downloaded (e.g. <code spellcheck=\"false\">ollama pull llama3.2</code>).</li></ul></li><li>LM Studio<ul><li>The OpenAI-compatible server is <strong>disabled</strong> by default in LM Studio installations. First download your desired models through the graphical interface, then go to <em>Settings</em> → <em>Developer</em> and toggle <em>Developer mode</em>. On the left there will be a new <em>Developer</em> tab, with a toggle to start it up.</li></ul></li></ul><p>Even for local providers that are not directly supported by Trilium, you can still use a custom endpoint (see below).</p><aside class=\"admonition warning\"><p>When dealing with self-hosted LLM models, depending on the training and the size of the model, the quality of the output may vary. Before <a href=\"#root/_help_wy8So3yZZlH9\">reporting issues</a> regarding the quality of the output (e.g. hallucinating tool calls), consider benchmarking the response against a cloud provider (Claude Sonnet is recommended).</p></aside><h2>Custom endpoints</h2><p>If your desired hosted (e.g. OpenRouter, Groq, Mistral) or local LLM provider is not listed in Trilium, you can use the dedicated <em>OpenAI-compatible</em> provider from the <em>Custom endpoint</em> section.</p><p>This allows you to set the base URL to an OpenAI-compatible API, with an optional API key if required by the service.</p><p>For custom endpoints, the pricing of the models is not known so the cost of a conversation will not be displayed; this is especially relevant for hosted providers.</p>",
- "_help_cRRrdZjgyhNc": "<p>Trilium sends nothing to an AI provider until you send a message. Enabling the integration, adding a provider or opening a chat transmits nothing on its own, the one exception is that listing a provider's models sends your API key to that provider, so the list can be fetched.</p><p>Once you send a message, what leaves your machine depends on the provider you chose and on which context options are enabled.</p><h2>Where your notes go</h2><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Provider type</th>\n<th>Destination</th>\n</tr>\n</thead>\n<tbody><tr>\n<td>Cloud providers</td>\n<td>The provider's servers (Anthropic, OpenAI, Google, DeepSeek)</td>\n</tr>\n<tr>\n<td>Subscription-based</td>\n<td>The provider's servers, via Claude Code running locally</td>\n</tr>\n<tr>\n<td>Local / self-hosted</td>\n<td>Nothing leaves the machine running the model</td>\n</tr>\n<tr>\n<td>Custom endpoint</td>\n<td>Wherever you pointed it — which may be your own hardware or a hosted service</td>\n</tr>\n</tbody></table></figure><p>This is the reason the provider list is grouped this way, and why Trilium pre-selects nothing: the choice of where your notes travel is made explicitly, by you, before anything is sent.</p><h2>What is actually sent</h2><ul><li><strong>Always, with every message</strong><ul><li>The conversation itself: your messages and the assistant's replies, including earlier turns</li><li>Trilium's system prompt describing how to format answers and use tools.</li></ul></li><li><strong>The current note, only when note context is enabled.</strong><ul><li>In the sidebar chat this is the file icon at the bottom; the dedicated chat note type never sends a current note.</li><li>What travels is a metadata block: the note's ID, title, type, creation and modification dates, its parent IDs, the titles of up to 20 children, up to 20 attributes, and a preview of the content.</li><li>Notes above a size threshold send a size hint instead of the text, and the model must call a tool to read further.</li></ul></li><li><strong>Any note the model asks for, when note access is enabled.</strong><ul><li>Tools let the model search your tree and read notes, attributes and attachments beyond the current one.</li><li>It decides what to fetch; there is no per-note permission system, so the reachable scope is your whole tree.</li></ul></li><li><strong>Attachments and mentions</strong>, when you add them: images, PDFs and text files are sent to the provider, and an <code spellcheck=\"false\">@</code> mention makes that note fetchable.</li><li><strong>Your search query</strong>, when web search is enabled, the model's search terms reach the provider's own search infrastructure.</li></ul><h2>Protected notes</h2><p>While your <a href=\"#root/_help_bwg0e8ewQMak\">protected session</a> is locked, protected notes send neither title nor content. <strong>While it is unlocked they are treated like any other note</strong> — a note the model reads through a tool is sent to the provider in full. If you keep sensitive material in protected notes, be aware that unlocking them removes that boundary for the duration of the session.</p><h2>What you control</h2><ul><li><strong>Which provider</strong>: the single decision that determines whether anything leaves your machine at all.</li><li><strong>Note access</strong>: turn tools off from the model selector at the bottom of the chat, and the model can read nothing beyond what you type.</li><li><strong>The current note:</strong> the file icon in the sidebar chat.</li><li><strong>Web search:</strong> also in the model selector.</li></ul><p>With note access and note context both off, the provider receives only the words you typed.</p><h2>Keeping everything local</h2><p>Adding an Ollama or LM Studio provider keeps every message on the machine running the model, and Trilium marks their models as free because no metered API is involved. The trade-off is quality and hardware: a small local model may fail at tool calls that a cloud model handles, so a local setup that misbehaves is worth benchmarking against a cloud provider before reporting it as a bug.</p><h2>Telemetry &amp; security</h2><p>Trilium itself collects no telemetry from the AI integration.</p><p>Your API key is stored in your database, sent only to the provider it belongs to, and is write-only through the options API so that a malevolent&nbsp;<a class=\"reference-link\" href=\"#root/_help_CdNpE2pqjmI6\">Scripting</a>&nbsp;cannot access it. If you have backend or SQL console access enabled, a malevolent script <strong>could potentially exfiltrate your API keys</strong>.</p><p>The built-in MCP server is off by default. When enabled, every request must carry an ETAPI token, which grants the same full read and write access to your notes as the REST API; treat one like a password. On desktop it is reachable only from <code spellcheck=\"false\">localhost</code> unless you turn on&nbsp;<a class=\"reference-link\" href=\"#root/_help_swSFivWk6KkA\">Network Access</a>.</p>",
- "_help_KOWBFgsZXJAD": "<p><a href=\"https://en.wikipedia.org/wiki/Model_Context_Protocol\">Model Context Protocol</a> allows external chat applications such as Claude Code to have access to the Trilium database.</p><h2>Built-in MCP</h2><p>v0.103.0 comes with a built-in MCP server that is not active by default. To activate it, go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ AI/LLM and toggle the <em>MCP server</em> option.</p><p>Once the MCP is active, simply add the MCP server to your AI assistant. The URL to use is displayed in the <em>Endpoint</em> <em>URL</em> information underneath the MCP toggle.</p><p>Only the HTTP transport is supported, the <code spellcheck=\"false\">stdio</code> method is not supported. If that is a blocker, consider using a third-party alternative listed below.</p><p>The tools exposed to the MCP are the same tools that are supported by the internal chat (see the <em>Note access</em> section).</p><h3>Authentication</h3><p>To protect your notes from unauthorized access, the MCP server requires authentication. Generally MCP servers need to support OAuth for authentication, but Trilium uses a simpler mechanism using Bearer tokens.</p><p>To configure authentication, first create an&nbsp;<a class=\"reference-link\" href=\"#root/_help_pgxEVkzLl1OP\">ETAPI (REST API)</a>&nbsp;token by going to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>ETAPI</em>. Then follow the instructions in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>AI / LLM</em>, by looking at the <em>How to connect an assistant</em> section under MCP.</p><h2>Third-party alternatives</h2><p>The following are alternatives to Trilium's built-in MCP feature. Since Trilium's AI implementation is still experimental, its tooling might not be as mature as external tools.</p><ul><li><a href=\"https://github.com/perfectra1n/triliumnext-mcp\">perfectra1n/triliumnext-mcp</a></li><li><a href=\"https://github.com/tan-yong-sheng/triliumnext-mcp\">tan-yong-sheng/triliumnext-mcp</a></li><li><a href=\"https://github.com/eliassoares/trilium-fastmcp\">eliassoares/trilium-fastmcp</a></li></ul><aside class=\"admonition important\"><p>These solutions are third-party and thus not endorsed or supported directly by the Trilium Notes team. Please address questions and issues on their corresponding repository instead.</p></aside>",
- "_help_CdNpE2pqjmI6": "<p>Trilium supports creating&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;notes, i.e. notes which allow you to store some programming code and highlight it. Special case is JavaScript code notes which can also be executed inside Trilium which can in conjunction with&nbsp;<a class=\"reference-link\" href=\"#root/_help_GLks18SNjxmC\">Script API</a>&nbsp;provide extra functionality.</p><h2>Architecture Overview</h2><p>To go further I must explain basic architecture of Trilium - in its essence it is a classic web application - it has these two main components:</p><ul><li>frontend running in the browser (using HTML, CSS, JavaScript) - this is mainly used to interact with the user, display notes etc.</li><li>backend running JavaScript code in node.js runtime - this is responsible for e.g. storing notes, encrypting them etc.</li></ul><p>So we have frontend and backend, each with their own set of responsibilities, but their common feature is that they both run JavaScript code. Add to this the fact, that we're able to create JavaScript&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;and we're onto something.</p><h2>Use cases</h2><ul><li><a class=\"reference-link\" href=\"#root/_help_TjLYAo3JMO8X\">\"New Task\" launcher button</a></li></ul><h2>Action handler</h2><p>Saving the note to the database is backend's responsibility, so we immediately pass control to the backend and ask it to create a note. Once this is done, we show the newly created note so that the user can set the task title and maybe some attributes.</p><h2>Script execution</h2><p>So we have a script which will add the button to the toolbar. But how can we execute it? One possibility is to click on \"play\" icon (marked by red circle). The problem with this is that this UI change is time bound by Trilium runtime so when we restart Trilium, button won't be there.</p><p>We need to execute it every time Trilium starts up, but we probably don't want to have to manually click on play button on every start up.</p><p>The solution is marked by red circle at the bottom - this note has <a href=\"#root/_help_zEY4DaJG4YT5\">label</a> <code spellcheck=\"false\">#run=frontendStartup</code> - this is one of the \"system\" labels which Trilium understands. As you might guess, this will cause all such labeled script notes to be executed once Trilium frontend starts up.</p><p>(<code spellcheck=\"false\">#run=frontendStartup</code> does not work for <a href=\"#root/_help_RDslemsQ6gCp\">Mobile frontend</a> - if you want to have scripts running there, give the script <code spellcheck=\"false\">#run=mobileStartup</code> label).</p><h3>Execute button</h3><p>Runnable code notes (frontend or backend) and saved SQL consoles can optionally have a dedicated execute button alongside a description.</p><p>To do so, apply the following <a href=\"#root/_help_HI6GBBIduIgv\">labels</a>:</p><ul><li>A <code spellcheck=\"false\">#executeButton</code> with the value of the label being displayed as the label of the button.</li><li>An optional <code spellcheck=\"false\">#executeDescription</code> which adds explanatory text beside it.</li></ul><h2>Autocomplete &amp; linting</h2><p>Starting with Trilium v0.104.0, frontend scripts, backend scripts and render notes benefit from an autocomplete system.</p><p>The autocomplete triggers automatically when typing <kbd>.</kbd> or manually by pressing <kbd>Ctrl</kbd>+<kbd>Space</kbd>.</p><p>In addition to that, the editor will also display syntax errors and warnings such as unreachable code.</p><aside class=\"admonition note\"><p>If you notice a false positive in regards with the errors/warnings reported or an incorrect or missing API, feel free to <a href=\"#root/_help_wy8So3yZZlH9\">open a issue</a> with a code sample.</p></aside><h2>More showcases</h2><p>You can see more scripting with explanation in&nbsp;<a class=\"reference-link\" href=\"#root/_help_5668rwcirq1t\">Advanced Showcases</a>.</p><h2>Events</h2><p>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_GPERMystNGTB\">Events</a>.</p><h2>Script API</h2><p>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_GLks18SNjxmC\">Script API</a>.</p>",
- "_help_yIhgI5H7A2Sm": "<p>Front-end scripts are custom JavaScript notes that are run on the client (browser environment)</p><p>There are four flavors of front-end scripts:</p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th></th>\n<th></th>\n</tr>\n</thead>\n<tbody><tr>\n<td>Regular scripts</td>\n<td>These are run with the current app and note context. These can be run either manually or automatically on start-up.</td>\n</tr>\n<tr>\n<td><a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a></td>\n<td>These can introduce new UI elements in various positions, such as near the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, content area or even the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>.</td>\n</tr>\n<tr>\n<td><a class=\"reference-link\" href=\"#root/_help_4Gn3psZKsfSm\">Launch Bar Widgets</a></td>\n<td>Similar to&nbsp;<a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>, but dedicated to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>. These can simply introduce new buttons or graphical elements to the bar.</td>\n</tr>\n<tr>\n<td><a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a></td>\n<td>This allows rendering custom content inside a note, using either HTML or Preact JSX.</td>\n</tr>\n</tbody></table></figure><p>For more advanced behaviors that do not require a user interface (e.g. batch modifying notes), see&nbsp;<a class=\"reference-link\" href=\"#root/_help_SPirpZypehBG\">Backend scripts</a>.</p><h2>Scripts</h2><p>Scripts don't have any special requirements. They can be run manually using the <em>Execute</em> button on the code note or they can be run automatically; to do so, set the <code spellcheck=\"false\">run</code> <a href=\"#root/_help_HI6GBBIduIgv\">label</a> to either:</p><ul><li><code spellcheck=\"false\">frontendStartup</code> - when Trilium frontend starts up (or is refreshed), but not on mobile.</li><li><code spellcheck=\"false\">mobileStartup</code> - when Trilium frontend starts up (or is refreshed), on mobile.</li></ul><aside class=\"admonition note\"><p>Backend scripts have more powerful triggering conditions, for example they can run automatically on a hourly or daily basis, but also on events such as when a note is created or an attribute is modified. See the server-side&nbsp;<a class=\"reference-link\" href=\"#root/_help_GPERMystNGTB\">Events</a>&nbsp;for more information.</p></aside><h2>Widgets</h2><p>Widgets require a certain format in order for Trilium to be able to integrate them into the UI.</p><ul><li>For legacy widgets, the script note must export a <code spellcheck=\"false\">BasicWidget</code> or a derived one (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_GhurYZjh8e1V\">Note context aware widget</a>&nbsp;or&nbsp;<a class=\"reference-link\" href=\"#root/_help_M8IppdwVHSjG\">Right pane widget</a>).</li><li>For Preact widgets, a built-in helper called <code spellcheck=\"false\">defineWidget</code> needs to be used.</li></ul><p>For more information, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>.</p><h2>Script API</h2><p>The front-end API of Trilium is available to all scripts running in the front-end context as global variable <code spellcheck=\"false\">api</code>. For a reference of the API, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_Q2z6av6JZVWm\">Frontend API</a>.</p><h3>Tutorial</h3><p>For more information on building widgets, take a look at <a href=\"#root/_help_SynTBQiBsdYJ\">Widget Basics</a>.</p>",
- "_help_MgibgPcfeuGz": "<p>Custom widgets are a special subset of scripts that render graphical elements in certain parts of the application. These can be used to add new functionality to the Trilium application.</p><h2>Preact with JSX vs. vanilla jQuery</h2><p>In older versions of Trilium, custom widgets were exclusively written in a combination of jQuery with Trilium's internal widget architecture (e.g., <code spellcheck=\"false\">BasicWidget</code>, <code spellcheck=\"false\">NoteContextAwareWidget</code>).</p><p>Starting with v0.101.0, custom widgets can also be written in JSX using the&nbsp;<a class=\"reference-link\" href=\"#root/_help_KLsqhjaqh1QW\">Preact</a>&nbsp;framework. Both legacy and Preact widgets have the same capabilities, with a single difference:</p><ul><li>Preact widgets are content-sized by default whereas legacy widgets need <code spellcheck=\"false\">this.contentSized()</code> applied in the constructor. For more information, see the corresponding section in&nbsp;<a class=\"reference-link\" href=\"#root/_help_gMkgcLJ6jBkg\">Troubleshooting</a>.</li></ul><p>Wherever possible, widget examples will be both in the legacy and Preact format.</p><h2>Creating a custom widget</h2><ol><li>Create a&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note.</li><li>Set the language to:<ol><li>JavaScript (frontend) for legacy widgets using jQuery.</li><li>JSX for Preact widgets. You might need to go to Options → Code to enable the language first.</li></ol></li><li>Apply the <code spellcheck=\"false\">#widget</code> <a href=\"#root/_help_HI6GBBIduIgv\">label</a>.</li></ol><h2>Getting started with a simple example</h2><p>Let's start by creating a widget that shows a message near the content area. Follow the previous section to create a code note, and use the following content.</p><h3>Legacy version (jQuery)</h3><pre><code class=\"language-text-x-trilium-auto\">class HelloCenterPane extends api.BasicWidget {\n\n constructor() {\n super();\n this.contentSized();\n }\n\n get parentWidget() { return \"center-pane\" }\n\n doRender() {\n this.$widget = $(\"&lt;span&gt;Center pane&lt;/span&gt;\");\n }\n \n}\n\nmodule.exports = new HelloCenterPane();</code></pre><p><a href=\"#root/_help_s8alTXmpFR61\">Refresh the application</a> and the widget should appear underneath the content area.</p><h3>Preact version</h3><pre><code class=\"language-text-x-trilium-auto\">import { defineWidget } from \"trilium:preact\";\n\nexport default defineWidget({\n parent: \"center-pane\",\n render: () =&gt; &lt;span&gt;Center pane from Preact.&lt;/span&gt;\n});</code></pre><p><a href=\"#root/_help_s8alTXmpFR61\">Refresh the application</a> and the widget should appear underneath the content area.</p><h2>Widget location (parent widget)</h2><p>A widget can be placed in one of the following sections of the applications:</p><table class=\"ck-table-resized\">\n <colgroup>\n <col style=\"width:15.59%;\">\n <col style=\"width:30.42%;\">\n <col style=\"width:16.68%;\">\n <col style=\"width:37.31%;\">\n </colgroup>\n <thead>\n <tr>\n <th>Value for <code spellcheck=\"false\">parentWidget</code></th>\n <th>Description</th>\n <th>Sample widget</th>\n <th>Special requirements</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th><code spellcheck=\"false\">left-pane</code></th>\n <td>Appears within the same pane that holds the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</td>\n <td>Same as above, with only a different <code spellcheck=\"false\">parentWidget</code>.</td>\n <td>None.</td>\n </tr>\n <tr>\n <th><code spellcheck=\"false\">center-pane</code></th>\n <td>In the content area. If a split is open, the widget will span all of the splits.</td>\n <td>See example above.</td>\n <td>None.</td>\n </tr>\n <tr>\n <th><code spellcheck=\"false\">note-detail-pane</code></th>\n <td><p>In the content area, inside the note detail area. If a split is open, the widget will be contained inside the split.</p><p>This is ideal if the widget is note-specific.</p></td>\n <td><a class=\"reference-link\" href=\"#root/_help_GhurYZjh8e1V\">Note context aware widget</a></td>\n <td><ul><li>The widget must export a <code spellcheck=\"false\">class</code> and not an instance of the class (e.g. <code spellcheck=\"false\">no new</code>) because it needs to be multiplied for each note, so that splits work correctly.</li><li>Since the <code spellcheck=\"false\">class</code> is exported instead of an instance, the <code spellcheck=\"false\">parentWidget</code> getter must be <code spellcheck=\"false\">static</code>, otherwise the widget is ignored.</li></ul></td>\n </tr>\n <tr>\n <th><code spellcheck=\"false\">right-pane</code></th>\n <td>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>, as a dedicated section.</td>\n <td><a class=\"reference-link\" href=\"#root/_help_M8IppdwVHSjG\">Right pane widget</a></td>\n <td><ul><li>Although not mandatory, it's best to use a <code spellcheck=\"false\">RightPanelWidget</code> instead of a <code spellcheck=\"false\">BasicWidget</code> or a <code spellcheck=\"false\">NoteContextAwareWidget</code>.</li></ul></td>\n </tr>\n </tbody>\n</table><p>To position the widget somewhere else, just change the value passed to <code spellcheck=\"false\">get parentWidget()</code> for legacy widgets or the <code spellcheck=\"false\">parent</code> field for Preact. Do note that some positions such as <code spellcheck=\"false\">note-detail-pane</code> and <code spellcheck=\"false\">right-pane</code> have special requirements that need to be accounted for (see the table above).</p><h2>Launch bar widgets</h2><p>Launch bar widgets are similar to <em>Custom widgets</em> but are specific to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_4Gn3psZKsfSm\">Launch Bar Widgets</a>&nbsp;for more information.</p><h2>Custom position</h2><p>The position of a custom widget is defined via a <code spellcheck=\"false\">position</code> integer.</p><p>In legacy widgets:</p><pre><code class=\"language-text-x-trilium-auto\">class MyWidget extends api.BasicWidget {\n\t// [..\n\tget position() { return 10; }\n}</code></pre><p>In Preact widgets:</p><pre><code class=\"language-text-x-trilium-auto\">export default defineWidget({\n // [...]\n position: 10\n});</code></pre>",
- "_help_SynTBQiBsdYJ": "<p>This guide will walk you through creating a basic widget inside Trilium. By following these steps, you'll learn how to build a simple UI element that interacts with the user.</p><h3>Step 1: The Basic Widget Structure</h3><p>To start, we'll create the most basic widget possible. Here's a simple example:</p><pre><code class=\"language-text-x-trilium-auto\">class MyWidget extends api.BasicWidget {\n get position() { return 1; }\n get parentWidget() { return \"left-pane\"; }\n \n doRender() {\n this.$widget = $(\"&lt;div id='my-widget'&gt;\");\n return this.$widget;\n }\n}\n\nmodule.exports = new MyWidget();</code></pre><p>To implement this widget:</p><ol><li>Create a new <code spellcheck=\"false\">JS Frontend</code> note in Trilium and paste in the code above.</li><li>Assign the <code spellcheck=\"false\">#widget</code> <a href=\"#root/_help_zEY4DaJG4YT5\">attribute</a> to the <a href=\"#root/_help_BFs8mudNFgCS\">note</a>.</li><li>Restart Trilium or reload the window.</li></ol><p>To verify that the widget is working, open the developer tools (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>I</kbd>) and run <code spellcheck=\"false\">document.querySelector(\"#my-widget\")</code>. If the element is found, the widget is functioning correctly. If <code spellcheck=\"false\">undefined</code> is returned, double-check that the <a href=\"#root/_help_BFs8mudNFgCS\">note</a> has the <code spellcheck=\"false\">#widget</code> <a href=\"#root/_help_zEY4DaJG4YT5\">attribute</a>.</p><h3>Step 2: Adding an UI Element</h3><p>Next, let's improve the widget by adding a button to it.</p><pre><code class=\"language-text-x-trilium-auto\">const template = `&lt;div id=\"my-widget\"&gt;&lt;button&gt;Click Me!&lt;/button&gt;&lt;/div&gt;`;\n\nclass MyWidget extends api.BasicWidget {\n get position() {return 1;}\n get parentWidget() {return \"left-pane\"}\n\n doRender() {\n this.$widget = $(template);\n return this.$widget;\n }\n}\n\nmodule.exports = new MyWidget();</code></pre><p>After making this change, reload Trilium. You should now see a button in the top-left corner of the left pane.</p><h3>Step 3: Styling the Widget</h3><p>To make the button more visually appealing and position it correctly, we'll apply some custom styling. Trilium includes <a href=\"https://boxicons.com\">Box Icons</a>, which we'll use to replace the button text with an icon. For example the <code spellcheck=\"false\">bx bxs-magic-wand</code> icon.</p><p>Here's the updated template:</p><pre><code class=\"language-text-x-trilium-auto\">const template = `&lt;div id=\"my-widget\"&gt;&lt;button class=\"tree-floating-button bx bxs-magic-wand tree-settings-button\"&gt;&lt;/button&gt;&lt;/div&gt;`;</code></pre><p>Next, we'll adjust the button's position using CSS:</p><pre><code class=\"language-text-x-trilium-auto\">class MyWidget extends api.BasicWidget {\n get position() { return 1; }\n get parentWidget() { return \"left-pane\"; }\n \n doRender() {\n this.$widget = $(template);\n this.cssBlock(`#my-widget {\n position: absolute;\n bottom: 40px;\n left: 60px;\n z-index: 1;\n }`);\n return this.$widget;\n }\n}\n\nmodule.exports = new MyWidget();</code></pre><p>After reloading Trilium, the button should now appear at the bottom left of the left pane, alongside other action buttons.</p><h3>Step 4: Adding User Interaction</h3><p>Let’s make the button interactive by showing a message when it’s clicked. We'll use the <code spellcheck=\"false\">api.showMessage</code> method from the <a href=\"#root/_help_GLks18SNjxmC\">Script API</a>.</p><pre><code class=\"language-text-x-trilium-auto\">class MyWidget extends api.BasicWidget {\n get position() { return 1; }\n get parentWidget() { return \"left-pane\"; }\n \n doRender() {\n this.$widget = $(template);\n this.cssBlock(`#my-widget {\n position: absolute;\n bottom: 40px;\n left: 60px;\n z-index: 1;\n }`);\n this.$widget.find(\"button\").on(\"click\", () =&gt; api.showMessage(\"Hello World!\"));\n return this.$widget;\n }\n}\n\nmodule.exports = new MyWidget();</code></pre><p>For the list of possible values for <code spellcheck=\"false\">parentWidget()</code>, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>.&nbsp;</p><p><a href=\"#root/_help_s8alTXmpFR61\">Reload</a> the application one last time. When you click the button, a \"Hello World!\" message should appear, confirming that your widget is fully functional.</p>",
- "_help_GhurYZjh8e1V": "<p>Note context-aware widgets are a different type of widget which automatically react to changes in the current note.</p><p>Important aspects:</p><ul><li>The widget must export a <code spellcheck=\"false\">class</code> and not an instance of the class (e.g. <code spellcheck=\"false\">no new</code>) because it needs to be multiplied for each note, so that splits work correctly.</li><li>Since the <code spellcheck=\"false\">class</code> is exported instead of an instance, the <code spellcheck=\"false\">parentWidget</code> getter must be <code spellcheck=\"false\">static</code>, otherwise the widget is ignored.</li></ul><h2>Example displaying the current note title</h2><p>This is a note context-aware widget that simply displays the name the current note.&nbsp;</p><h3>Classic example</h3><pre><code class=\"language-text-x-trilium-auto\">class HelloNoteDetail extends api.NoteContextAwareWidget {\n\n constructor() {\n super();\n this.contentSized();\n }\n\n doRender() {\n this.$widget = $(\"&lt;div&gt;\");\n }\n\n async refreshWithNote(note) {\n this.$widget.text(\"Current note: \" + note.title);\n }\n \n static get parentWidget() { return \"note-detail-pane\" } \n get position() { return 10 }\n \n}\n\nmodule.exports = HelloNoteDetail;</code></pre><h3>Preact (v0.101.0+)</h3><pre><code class=\"language-text-x-trilium-auto\">import { defineWidget, useNoteContext, useNoteProperty } from \"trilium:preact\";\n\nexport default defineWidget({ \n parent: \"note-detail-pane\",\n position: 10,\n render: () =&gt; {\n const { note } = useNoteContext();\n const title = useNoteProperty(note, \"title\");\n return &lt;span&gt;Current note JSX: {title}&lt;/span&gt;;\n }\n});</code></pre>",
- "_help_M8IppdwVHSjG": "<h2>Key highlights</h2><ul><li><code spellcheck=\"false\">doRender</code> must not be overridden, instead <code spellcheck=\"false\">doRenderBody()</code> has to be overridden.<ul><li><code spellcheck=\"false\">doRenderBody</code> can optionally be <code spellcheck=\"false\">async</code>.</li></ul></li><li><code spellcheck=\"false\">parentWidget()</code> must be set to <code spellcheck=\"false\">“rightPane”</code>.</li><li><code spellcheck=\"false\">widgetTitle()</code> getter can optionally be overriden, otherwise the widget will be displayed as “Untitled widget”.</li></ul><h2>Example for new layout</h2><aside class=\"admonition important\"><p>This section addresses example that are tailored for the&nbsp;<a class=\"reference-link\" href=\"#root/_help_IjZS7iK5EXtb\">New Layout</a>&nbsp;(available starting with v0.101.0) where the right pane widget/sidebar is no longer shown or hidden based on the widgets it has.&nbsp;</p></aside><h3>Title widget</h3><p>This is an example of a context-aware widget which displays the title of the current note:</p><pre><code class=\"language-text-x-trilium-auto\">class NoteTitleWidget extends api.RightPanelWidget {\n \n get widgetTitle() { return \"Note title\"; }\n get parentWidget() { return \"right-pane\" }\n\n doRenderBody() {\n this.$body.empty();\n if (this.note) {\n this.$body.append($(\"&lt;div&gt;\").text(this.note.title));\n }\n } \n \n async refreshWithNote() {\n \tthis.doRenderBody();\n }\n}\n\nmodule.exports = new NoteTitleWidget();</code></pre><h3>Clock</h3><p>A simple widget which will show the current time, as an example on how to dynamically change the content of the widget periodically.</p><h3>Legacy widget</h3><pre><code class=\"language-text-x-trilium-auto\">const template = `&lt;div&gt;&lt;/div&gt;`;\n\nclass ToDoListWidget extends api.RightPanelWidget {\n \n get widgetTitle() { return \"Clock\"; } \n get parentWidget() { return \"right-pane\" }\n \n async doRenderBody() {\n if (!this.timer) {\n this.timer = setInterval(() =&gt; {\n this.$body.empty().append(`The time is: &lt;span&gt;${new Date().toLocaleString()}&lt;/span&gt;`); \n }, 1000); \n }\n\n this.$body.empty().append(`The time is: &lt;span&gt;${new Date().toLocaleString()}&lt;/span&gt;`);\n } \n}\n\nmodule.exports = new ToDoListWidget();</code></pre><h3>Preact widget</h3><pre><code class=\"language-text-x-trilium-auto\">import { defineWidget, RightPanelWidget, useEffect, useState } from \"trilium:preact\";\n\nexport default defineWidget({\n parent: \"right-pane\", \n position: 1,\n render() {\n const [ time, setTime ] = useState();\n useEffect(() =&gt; {\n const interval = setInterval(() =&gt; {\n setTime(new Date().toLocaleString());\n }, 1000);\n return () =&gt; clearInterval(interval);\n }); \n return (\n &lt;RightPanelWidget id=\"clock-jsx\" title=\"Clock (JSX)\"&gt;\n &lt;p&gt;The time is: {time}&lt;/p&gt;\n &lt;/RightPanelWidget&gt;\n );\n }\n});</code></pre><h2>Example for old layout</h2><p>Here's a widget that displays a basic message (\"Hi\"):</p><pre><code class=\"language-text-x-trilium-auto\">const template = `&lt;div&gt;Hi&lt;/div&gt;`;\n\nclass HelloWorldWidget extends api.RightPanelWidget {\n \n get widgetTitle() {\n return \"Title goes here\";\n }\n \n get parentWidget() { return \"right-pane\" }\n \n doRenderBody() {\n this.$body.empty().append($(template));\n } \n \n async refreshWithNote(note) {\n \t// Do something when the note changes.\n }\n}\n\nmodule.exports = new HelloWorldWidget();</code></pre><h3>Conditionally changing visibility</h3><p>In <code spellcheck=\"false\">refreshWithNote</code>:</p><pre><code class=\"language-text-x-trilium-auto\">const visible = true;\t// replace with your own visibility logic\nthis.toggleInt(visible);\nthis.triggerCommand(\"reEvaluateRightPaneVisibility\");</code></pre><h2>Altering the position within the sidebar</h2><p>By default, the sidebar items are displayed in the order they are found by the application when searching for <code spellcheck=\"false\">#widget</code> notes.</p><p>It is possible to make a widget appear higher or lower up, by adjusting its <code spellcheck=\"false\">position</code> property:</p><pre><code class=\"language-text-x-trilium-auto\">class MyWidget extends api.RightPanelWidget {\n\n+ get position() { return 20 };\n \n}</code></pre><p>Generally the default position starts from 10 and increases by 10 with each item, including the default Table of Contents and Highlights list.</p>",
- "_help_YNxAqkI5Kg1M": "<aside class=\"admonition tip\"><p>This widget is also present in new installations in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_6tZeKvSHEUiB\">Demo Notes</a>.</p></aside><p>Create a&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note of type JavaScript (Trilium frontend) and <strong>give it a</strong> <code spellcheck=\"false\">#widget</code> <strong>label</strong>.</p><pre><code class=\"language-text-x-trilium-auto\">/*\n * This defines a custom widget which displays number of words and characters in a current text note.\n * To be activated for a given note, add label 'wordCount' to the note, you can also make it inheritable and thus activate it for the whole subtree.\n * \n * See it in action in \"Books\" and its subtree.\n */\nconst TPL = `&lt;div style=\"padding: 10px; border-top: 1px solid var(--main-border-color); contain: none;\"&gt;\n &lt;strong&gt;Word count: &lt;/strong&gt;\n &lt;span class=\"word-count\"&gt;&lt;/span&gt;\n\n &amp;nbsp;\n\n &lt;strong&gt;Character count: &lt;/strong&gt;\n &lt;span class=\"character-count\"&gt;&lt;/span&gt;\n&lt;/div`;\n\nclass WordCountWidget extends api.NoteContextAwareWidget {\n get position() { return 100; } // higher value means position towards the bottom/right\n \n get parentWidget() { return 'center-pane'; }\n \n doRender() {\n this.$widget = $(TPL);\n this.$wordCount = this.$widget.find('.word-count');\n this.$characterCount = this.$widget.find('.character-count');\n return this.$widget;\n }\n \n async refreshWithNote(note) {\n if (note.type !== 'text' || !note.hasLabel('wordCount')) { \n // show widget only on text notes and when marked with 'wordCount' label\n this.toggleInt(false); // hide\n \n return;\n }\n \n this.toggleInt(true); // display\n \n const {content} = await note.getNoteComplement();\n \n const text = $(content).text(); // get plain text only\n \n const counts = this.getCounts(text);\n\n this.$wordCount.text(counts.words);\n this.$characterCount.text(counts.characters);\n }\n \n getCounts(text) {\n const chunks = text\n .split(/[\\s-+:,/\\\\]+/)\n .filter(chunk =&gt; chunk !== '');\n \n let words;\n \n if (chunks.length === 1 &amp;&amp; chunks[0] === '') {\n words = 0;\n }\n else {\n words = chunks.length;\n }\n \n const characters = chunks.join('').length;\n \n return {words, characters};\n }\n \n async entitiesReloadedEvent({loadResults}) {\n if (loadResults.isNoteContentReloaded(this.noteId)) {\n this.refresh();\n }\n }\n}\n\nmodule.exports = new WordCountWidget();</code></pre><p>After you make changes it is necessary to <a href=\"#root/_help_s8alTXmpFR61\">restart Trilium</a> so that the layout can be rebuilt.</p><p>The widget only activates on text notes that have the <code spellcheck=\"false\">#wordCount</code> label. This label can be a <a href=\"#root/_help_hrZ1D00cLbal\">reference link</a> to enable the widget for an entire subtree.</p><p>At the bottom of the note you can see the resulting widget:</p><figure class=\"image\"><img style=\"aspect-ratio:792/603;\" src=\"{{helpAssets}}/User%20Guide/Scripting/Frontend%20Basics/Custom%20Widgets/Word%20count%20widget_image.png\" width=\"792\" height=\"603\"></figure>",
- "_help_VqGQnnPGnqAU": "<h2>Classic widgets</h2><p>In <code spellcheck=\"false\">doRender()</code>:<sup><a href=\"#fn1saoftmefpp\">[1]</a></sup></p><pre><code class=\"language-text-x-trilium-auto\">this.cssBlock(`#my-widget {\n\tposition: absolute;\n bottom: 40px;\n left: 60px;\n z-index: 1;\n}`);</code></pre><h2>Preact widgets</h2><p>See the dedicated page:&nbsp;<a class=\"reference-link\" href=\"#root/_help_Sg9GrCtyftZf\">CSS</a>.</p><ol><li><p><sup><strong><a href=\"#fnref1saoftmefpp\">^</a></strong></sup></p><p>Reference: <a href=\"https://trilium.rocks/X7pxYpiu0lgU\">https://trilium.rocks/X7pxYpiu0lgU</a></p></li></ol>",
- "_help_gMkgcLJ6jBkg": "<h2>Why is my widget clipped by other UI elements</h2><p>For performance and layout reasons, the size of widgets in Trilium is independent from its children. At CSS level, this means that the widget container has <code spellcheck=\"false\">contain: size</code> applied to it.</p><p>This works well if the widget has a fixed size (or based on its parent container), however to make a widget resize to fit its content, apply the following change:</p><pre><code class=\"language-text-x-diff\">class MyWidget extends api.RightPanelWidget {\n\n+ constructor() {\n+ super();\n+ this.contentSized();\n+ }\n \n}</code></pre><p>Alternatively apply <code spellcheck=\"false\">contain: none</code> to its CSS.</p>",
- "_help_TjLYAo3JMO8X": "<p>In this example we are going to extend the functionality of&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYjQUYhpbUEW\">Task Manager</a>&nbsp;showcase (which comes by default with Trilium) by adding a button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>&nbsp; (<img src=\"{{helpAssets}}/User%20Guide/Scripting/Frontend%20Basics/Examples/New%20Task%20launcher%20button_image.png\">) to create a new task automatically and open it.</p><h2>Creating the note</h2><ol><li>First, create a new&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note type with the <em>JavaScript (Trilium frontend)</em> language.</li><li>Define the <code spellcheck=\"false\">#run=frontendStartup</code> label in&nbsp;<a class=\"reference-link\" href=\"#root/_help_zEY4DaJG4YT5\">Attributes</a>.</li></ol><h2>Content of the script</h2><p>Copy-paste the following script:</p><pre><code class=\"language-text-javascript\">api.addButtonToToolbar({\n\ttitle: \"New task\",\n icon: \"task\",\n shortcut: \"alt+n\",\n action: async () =&gt; {\n \tconst taskNoteId = await api.runOnBackend(() =&gt; {\n \tconst todoRootNote = api.getNoteWithLabel(\"taskTodoRoot\");\n const resp = api.createTextNote(todoRootNote.noteId, \"New task\", \"\") \n return resp.note.noteId;\n });\n \n await api.waitUntilSynced();\n await api.activateNewNote(taskNoteId);\n }\n});</code></pre><h2>Testing the functionality</h2><p>Since we set the script to be run on start-up, all we need to do is to <a href=\"#root/_help_s8alTXmpFR61\">refresh the application</a>.</p><h2>Understanding how the script works</h2><table class=\"ck-table-resized\">\n <colgroup>\n <col>\n <col>\n </colgroup>\n <tbody>\n <tr>\n <td><pre><code class=\"language-application-javascript-env-frontend\">api.addButtonToToolbar({\n\ttitle: \"New task\",\n icon: \"task\",\n shortcut: \"alt+n\",\n action: async () =&gt; {\n \t// [...]\n }\n});</code></pre></td>\n <td><p>This uses the <a href=\"#root/_help_yIhgI5H7A2Sm\">Front-end API</a> to create a icon in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>, by specifying:</p><ul><li>A title</li><li>A corresponding boxicons icon (without the <code>bx-</code> prefix).</li><li>Optionally, a keyboard shortcut to assign to it.</li><li>The action, which will be executed when the button is pressed.</li></ul></td>\n </tr>\n <tr>\n <td><pre><code class=\"language-application-javascript-env-frontend\">const taskNoteId = await api.runOnBackend(() =&gt; {\n // Shown below. \n return resp.note.noteId;\n});</code></pre></td>\n <td><ul><li>This portion of code is actually executed on the server (backend) and not on the client (i.e. browser).<ul><li>The reason is that the creating notes is the responsibility of the server.</li></ul></li><li>Here we can also see that it is possible to return results from the server execution and read them in the client (<code>taskNoteId</code>).</li></ul></td>\n </tr>\n <tr>\n <td><pre><code class=\"language-application-javascript-env-frontend\">const todoRootNote = api.getNoteWithLabel(\"taskTodoRoot\");</code></pre></td>\n <td><ul><li>Here we identify a note with the <a href=\"#root/_help_zEY4DaJG4YT5\">label</a> <code>#taskTodoRoot</code>. This is how the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYjQUYhpbUEW\">Task Manager</a>&nbsp;showcase knows where to place all the different tasks.</li><li>Normally this might return a <code>null</code> value if no such note could be identified, but error handling is outside the scope of this example.&nbsp;</li></ul></td>\n </tr>\n <tr>\n <td><pre><code class=\"language-application-javascript-env-frontend\">const resp = api.createTextNote(todoRootNote.noteId, \"New task\", \"\")</code></pre></td>\n <td><ul><li>We create a new child note within the to-do root note (first argument) with the title “New task\" (second argument) and no content by default (third argument).</li></ul></td>\n </tr>\n <tr>\n <td><pre><code class=\"language-application-javascript-env-frontend\">await api.waitUntilSynced();</code></pre></td>\n <td><ul><li>Back on the client, since we created a new note on the server, we now need to wait for the change to be reflected in the client.</li></ul></td>\n </tr>\n <tr>\n <td><pre><code class=\"language-application-javascript-env-frontend\">await api.activateNewNote(taskNoteId);</code></pre></td>\n <td><ul><li>Since we know the <a href=\"#root/_help_m1lbrzyKDaRB\">ID</a> of the newly created note, all we have to do now is to show this note to the user.</li></ul></td>\n </tr>\n </tbody>\n</table>",
- "_help_7kZPMD0uFwkH": "<p>This tutorial showcases a basic integration with Google Forms, where we are able to download the responses of a form using the “Link to Sheets\" functionality.</p><p>Note that the link will be publicly accessible to everyone (however the link is in a hard-to-guess format such as <code spellcheck=\"false\">https://docs.google.com/spreadsheets/d/e/2PACX-1vTA8NU2_eZFhc8TFadCZPreBfvP7un8IHd6J0SchrLLw3ueGmntNZjwRmsH2ZRcp1pJYDAzMz1FmFaj/pub?output=csv</code>). Make sure you are not accidentally publishing sensitive information.</p><h2>Obtaining the CSV link</h2><ol><li>Open the Google Forms in a browser.</li><li>Select the “Responses” tab and click on “Link to Sheets”.</li><li>Select “Create a new spreadsheet” and press “Create”.</li><li>In Google Sheets, select File → Share → Publish to web.</li><li>In the “Publish to the web” screen, make sure the “Link” tab is selected and instead of “Web page”, select “Comma-separated values (.csv)”.</li><li>Copy the given link which will be used for the upcoming script.</li></ol><h2>Creating the script</h2><p>Create a “JS Frontend” script:</p><pre><code class=\"language-text-x-trilium-auto\">const CSV_URL = \"https://docs.google.com/spreadsheets/d/e/2PACX-1vTiwooLV2whjCSVa49dJ99p_G3_qhqHHRqttMjYCJVfLXVdTgUSNJu5K0rpqmaHYF2k7Vofi3o7gW82/pub?output=csv\";\n\nasync function fetchData() {\n try {\n const response = await fetch(CSV_URL);\n return await response.text();\n } catch (e) {\n api.showError(e.message);\n }\n}\n\nconst data = await fetchData();\nconsole.log(data);\n// Do something with the data.</code></pre><p>Note that the data will be received as a string and there is no library to do the CSV parsing for us. To do a very simple parsing of CSV:</p><pre><code class=\"language-text-x-trilium-auto\">const content = data\n\t.split(\"\\n\")\n\t.slice(1)\n\t.map((row) =&gt; row.split(\",\"));</code></pre><p>This will return the data as an array of arrays.</p>",
- "_help_DL92EjAaXT26": "<p>A good use case of promoted attributes is to easily define the various parameters a script might need, for example an input and output note if it's processing data, or a checkbox to define a particular change in behavior for the script.</p><p><img src=\"{{helpAssets}}/User%20Guide/Scripting/Frontend%20Basics/Examples/Using%20promoted%20attributes%20to%20configure%20scripts_image.png\"></p><h2>Using check boxes to toggle flags</h2><p>Instead of asking the user to modify a boolean value in the script, it's much more intuitive to use a checkbox for it as a promoted attribute.</p><p>To do so, first define the promoted attribute:</p><pre><code class=\"language-text-x-trilium-auto\">#label:groupByExtension=\"promoted,alias=Group by extension,single,boolean\"</code></pre><p>Then use it:</p><pre><code class=\"language-text-javascript\">const byExtension = api.currentNote.getLabelValue(\"groupByExtension\") === \"true\";\nif (byExtension) {\n\t// Do something.\n}</code></pre><p>This will work equally well in both front-end and back-end scripts.</p><h2>Using relations to select notes</h2><p>One common use case for a script is to read data from another note and perhaps output its result in another note. To do so we need to define the following promoted attributes:</p><pre><code class=\"language-text-x-trilium-auto\">#relation:input=\"promoted,alias=Input,single\" #relation:output=\"promoted,alias=Output,single\"</code></pre><p>Once we have this, we can add some basic error handling to ensure that the fields are completed by the user:</p><pre><code class=\"language-text-javascript\">const inputNoteId = api.currentNote.getRelationValue(\"input\");\nif (!inputNoteId) {\n\tapi.showError(\"Missing input.\");\n return;\n}\n\nconst outputNoteId = api.currentNote.getRelationValue(\"output\");\nif (!outputNoteId) {\n api.showError(\"Missing output.\");\n return;\n}</code></pre><p>Note that here we are using <code spellcheck=\"false\">api.showError</code> which is only available for frontend notes. If you are writing a backend note, simply remove <code spellcheck=\"false\">api.showError</code> but the user will no feedback on why the script did not execute properly.</p><p>Afterwards we can simply read the note and do something with it:</p><pre><code class=\"language-text-javascript\">const note = api.getNote(inputNoteId);\nif (!note) {\n\treturn;\n}\nconst content = note.getContent().toString(\"utf-8\");</code></pre>",
- "_help_4Gn3psZKsfSm": "<p>Launch bar widgets are a subset of&nbsp;<a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>&nbsp;that can be used to render custom buttons and widgets inside the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</p><h2>Creating a launch bar widget</h2><p>Unlike&nbsp;<a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>, the process of setting up a launch bar widget is slightly different:</p><ol><li>Create a Code note of type <em>JavaScript (front-end)</em> or JSX (for Preact-based widgets).<ul><li>The script itself uses the same concepts as&nbsp;<a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>, including the use of a <code spellcheck=\"false\">NoteContextAwareWidget</code> or a <code spellcheck=\"false\">BasicWidget</code> (according to needs).</li><li>As examples in both legacy and Preact format, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_IPArqVfDQ4We\">Note Title Widget</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_gcI7RPbaNSh3\">Analog Watch</a>.</li></ul></li><li>Don't set <code spellcheck=\"false\">#widget</code>, as that attribute is reserved for&nbsp;<a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>.</li><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>, select <em>Configure launchbar</em>.</li><li>In the <em>Visible Launchers</em> section, select <em>Add a custom widget</em>.</li><li>Give the newly created launcher a name (and optionally a name).</li><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;section, modify the <em>widget</em> field to point to the newly created note.</li><li><a href=\"#root/_help_s8alTXmpFR61\">Refresh</a> the UI.</li></ol>",
- "_help_IPArqVfDQ4We": "<figure class=\"image\"><img style=\"aspect-ratio:1007/94;\" src=\"{{helpAssets}}/User%20Guide/Scripting/Frontend%20Basics/Launch%20Bar%20Widgets/Note%20Title%20Widget_image.png\" width=\"1007\" height=\"94\"></figure><p>This is an example of a note context-aware widget, which reacts to the currently opened note and refreshes automatically as the user navigates through the notes.</p><h2>Legacy widget</h2><p>In this example, the title of the note is displayed. It works best on the <a href=\"#root/_help_x0JgW8UqGXvq\">horizontal layout</a>.</p><pre><code class=\"language-text-javascript\">const TPL = `\\\n&lt;div style=\"\n display: flex;\n height: 53px;\n width: fit-content;\n font-size: 0.75em;\n contain: none;\n align-items: center;\n flex-shrink: 0;\n padding: 0 1em;\n\"&gt;&lt;/div&gt;`;\n\nclass NoteTitleWidget extends api.NoteContextAwareWidget {\n doRender() {\n this.$widget = $(TPL);\n }\n\n async refreshWithNote(note) {\n this.$widget.text(note.title);\n }\n}\n\nmodule.exports = new NoteTitleWidget();</code></pre><h2>Preact widget (v0.101.0+)</h2><pre><code class=\"language-text-jsx\">import { defineLauncherWidget, useActiveNoteContext } from \"trilium:preact\";\n\nexport default defineLauncherWidget({\n render: () =&gt; {\n const { note } = useActiveNoteContext();\n return &lt;div style={{\n display: \"flex\",\n height: \"53px\",\n width: \"fit-content\",\n fontSize: \"0.75em\",\n alignItems: \"center\",\n flexShrink: 0 \n }}&gt;{note?.title}&lt;/div&gt;;\n }\n});</code></pre>",
++ "_help_64ZTlUPgEPtW": "<p>Safe mode is triggered by setting the <code>TRILIUM_SAFE_MODE</code> environment variable to a truthy value, usually <code>1</code>.</p><p>In each artifact there is a <code>trilium-safe-mode.sh</code> (or <code>.bat</code>) script to enable it.</p><p>What it does:</p><ul><li>Disables <code>customWidget</code> launcher types in <code>app/widgets/containers/launcher.js</code>.</li><li>Disables the running of <code>mobileStartup</code> or <code>frontendStartup</code> scripts.</li><li>Displays the root note instead of the previously saved session.</li><li>Does not run a <a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a> when it is opened; press <em>Search now</em> to run it.</li><li>Disables the running of <code>backendStartup</code>, <code>hourly</code>, <code>daily</code> scripts and checks for the hidden subtree.</li></ul>",
++ "_help_HAIOFBoYIIdO": "<p>Nightly releases are versions built every day, containing the latest improvements and bugfixes, directly from the main development branch. These versions are generally useful in preparation for a release, to ensure that there are no significant bugs that need to be addressed first, or they can be used to confirm whether a particular bug is fixed or feature is well implemented.</p><h2>Regarding the stability</h2><p>Despite being on a development branch, generally the main branch is pretty stable since PRs are tested before they are merged. If you notice any issues, feel free to report them either via a ticket or via the Matrix.</p><h2>Downloading the nightly release manually</h2><p>Go to <a href=\"https://github.com/TriliumNext/Trilium/releases/tag/nightly\">github.com/TriliumNext/Trilium/releases/tag/nightly</a> and look for the artifacts starting with <code>TriliumNotes-main</code>. Choose the appropriate one for your platform (e.g. <code>windows-x64.zip</code>).</p><p>Depending on your use case, you can either test the portable version or even use the installer.</p><aside class=\"admonition note\"><p>If you choose the installable version (e.g. the .exe on Windows), it will replace your stable installation.</p></aside><aside class=\"admonition important\"><p>By default, the nightly uses the same database as the production version. Generally you could easily downgrade if needed. However, if there are changes to the database or sync version, it will not be possible to downgrade without having to restore from a backup.</p></aside><h2>Automatically download and install the latest nightly</h2><p>This is pretty useful if you are a beta tester that wants to periodically update their version:</p><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-tux\"></span>&nbsp;Ubuntu (Bash)</p><div class=\"trilium-tab-panel\"><pre><code class=\"language-text-x-sh\">#!/usr/bin/env bash\n\nname=TriliumNotes-linux-x64-nightly.deb\nrm -f $name*\nwget https://github.com/TriliumNext/Trilium/releases/download/nightly/$name\nsudo apt-get install ./$name\nrm $name</code></pre></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-windows\"></span>&nbsp;Windows (PowerShell)</p><div class=\"trilium-tab-panel\"><pre><code class=\"language-application-x-powershell\">if ($env:PROCESSOR_ARCHITECTURE -eq \"ARM64\") {\n $arch = \"arm64\";\n} else {\n $arch = \"x64\";\n}\n\n$exeUrl = \"https://github.com/TriliumNext/Trilium/releases/download/nightly/TriliumNotes-main-windows-$($arch).exe\";\nWrite-Host \"Downloading $($exeUrl)\"\n\n# Generate a unique path in the temp dir\n$guid = [guid]::NewGuid().ToString()\n$destination = Join-Path -Path $env:TEMP -ChildPath \"$guid.exe\"\n\ntry {\n $ProgressPreference = 'SilentlyContinue'\n Invoke-WebRequest -Uri $exeUrl -OutFile $destination\n $process = Start-Process -FilePath $destination\n} catch {\n Write-Error \"An error occurred: $_\"\n} finally {\n # Clean up\n if (Test-Path $destination) {\n Remove-Item -Path $destination -Force\n }\n}</code></pre></div></section></div>",
++ "_help_ZmT9ln8XJX2o": "<aside class=\"admonition warning\"><p>This functionality is still in preview, expect possible issues or even the feature disappearing completely.<br>Feel free to <a href=\"#root/_help_wy8So3yZZlH9\">report</a> any issues you might have.</p></aside><p>The read-only database is an alternative to&nbsp;<a class=\"reference-link\" href=\"#root/_help_R9pX4DGra2Vt\">Sharing</a>&nbsp;notes. Although the share functionality works pretty well to publish pages to the Internet in a wiki, blog-like format it does not offer the full functionality behind Trilium (such as the advanced&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>&nbsp;or the interactivity behind&nbsp;<a class=\"reference-link\" href=\"#root/_help_GTwFsgaA0lCt\">Collections</a>&nbsp;or the various&nbsp;<a class=\"reference-link\" href=\"#root/_help_KSZ04uQ2D1St\">Note Types</a>).</p><p>When the database is in read-only mode, the Trilium application can be used as normal, but editing is disabled and changes are made in-memory only.</p><h2>What it does</h2><ul><li>All notes are read-only, without the possibility of editing them.</li><li>Features that would normally alter the database such as the list of recent notes are disabled.</li></ul><h2>Limitations</h2><ul><li>Some features might “slip through” and still end up creating a note, for example.<ul><li>However, the database is still read-only, so all modifications will be reset if the server is restarted.</li><li>Whenever this occurs, <code>ERROR: read-only DB ignored</code> will be shown in the logs.</li></ul></li></ul><h2>Setting a database as read-only</h2><p>First, make sure the database is initialized (e.g. the first set up is complete). Then modify the <a href=\"#root/_help_Gzjqa934BdH4\">config.ini</a> by looking for the <code>[General]</code> section and adding a new <code>readOnly</code> field:</p><pre><code class=\"language-text-x-trilium-auto\">[General]\nreadOnly=true</code></pre><p>If your server is already running, restart it to apply the changes.</p><p>Similarly, to disable read-only remove the line or set it to <code>false</code>.</p>",
++ "_help_TiQbQDgP8L5t": "<p>Optical Character Recognition is the process in which the text from images or PDFs is extracted.</p><h2>Built-in support</h2><p>Since v0.103.0, Trilium has built-in support for OCR. The extracted text can be:</p><ul><li>Integrated with&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>, to quickly find the image or file based on snippets of text.</li><li>Integrated with the&nbsp;<a class=\"reference-link\" href=\"#root/_help_GBBMSlVSOIGP\">AI</a>&nbsp;feature, which allows the agent to access the content of a non-text note.</li><li>Manually accessed for other purposes (e.g. copying into a note or sending it somewhere else).</li></ul><h2>Supported formats</h2><p>OCR in Trilium supports the following formats:</p><h3>Images</h3><ul><li>Both <a href=\"#root/_help_W8vYD3Q1zjCR\">individual image notes</a> and <a href=\"#root/_help_mT0HEkOsz6i1\">attachments in text files</a> are supported.</li><li>Supported formats:<ul><li>JPEG</li><li>PNG</li><li>GIF (only non-animated)</li><li>BMP</li><li>WebP</li></ul></li><li>Note that this feature works best for computer-rendered text rather than handwriting.</li><li>The underlying technology is Tesseract.js.</li></ul><h3>PDFs</h3><p>The PDF extraction supports:</p><ul><li>PDFs with text information (e.g. a PDF created by a browser or a word processing application), in which the text is extracted.</li><li>Scanned PDFs, and other PDFs whose text cannot be selected (such as documents whose text was converted to outlines), in which the text is extracted through an OCR process.</li><li>Mixed PDFs, containing both text and images with text content.</li></ul><p>Note that OCR extraction is limited to 50 pages per PDF, pages containing text information (not as an image) are not subject to this limitation.</p><aside class=\"admonition note\"><p>Text extraction for scanned PDFs using OCR was introduced in v0.106.0. If a scanned PDF was already processed by an earlier version, reprocess it individually via <em>Process OCR</em>; batch processing only handles files that haven't been OCR'd yet.</p></aside><h3>Office documents</h3><p>The text will be extracted from the following file formats:</p><ul><li>Microsoft Word documents</li><li>Microsoft Excel documents<ul><li>Only the raw text information, the cell structure is not maintained.</li><li>Values are extracted raw, so searching for dates will not work. The OpenDocument alternative will actually extract the properly formatted value.</li></ul></li><li>Microsoft PowerPoint documents</li><li>The OpenDocument alternatives to the previous formats (Text, Spreadsheet, Presentation), created by editors such as LibreOffice and OpenOffice.</li><li><a href=\"https://en.wikipedia.org/wiki/Rich_Text_Format\">Rich Text Format (RTF)</a>, since v0.104.0.</li><li><a href=\"https://en.wikipedia.org/wiki/EPUB\">EPUB</a>, since v0.104.1.</li></ul><h2>Configuring and triggering OCR</h2><p>The OCR can be configured by going to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→&nbsp;<a class=\"reference-link\" href=\"#root/_hidden/_options/_optionsMedia\">Media</a>&nbsp;and looking for the <em>Text Extraction (OCR)</em> section.</p><p>There are three ways to trigger the OCR:</p><ul><li>By enabling <em>Auto-process new files</em> which will process only the notes or attachments created after enabling the option, existing files will remain unprocessed.</li><li>By pressing <em>Start Batch Processing</em> which will process all the existing notes.</li><li>By manually requesting for an image or file to have its text extracted, regardless of whether the automatic processing is enabled or not.</li></ul><h3>Minimum confidence</h3><p>When extracting text from an image, there is a certain level of confidence which indicates whether the extracted text appears relevant.</p><p>When the minimum confidence is set to a low percentage, the text extraction can interpret symbols and drawings incorrectly resulting in garbled text.</p><p>If the extracted text for a note or an attachment quality is lower than the minimum confidence, the OCR is disregarded.</p><h2>Language management</h2><p>OCR needs to be aware of the language of the content in order for it to work correctly. The reason is that each language has its own data which needs to be downloaded, and accents or other symbols will not be supported by the default language.</p><p>To configure the languages that are supported by the OCR, simply go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→&nbsp;<a class=\"reference-link\" href=\"#root/_hidden/_options/_optionsLocalization\">Language &amp; Region</a>&nbsp;and adjust the <em>Content languages</em>.</p><p>When there are no content languages defined, the user interface <em>Language</em> is used instead.</p><p>After making this change, the automatic processing or manual reprocessing will take into consideration the new languages.</p><p>To enforce the detection in a particular language for a given note, use the <code>language</code> <a href=\"#root/_help_zEY4DaJG4YT5\">attribute</a>, similar to <a href=\"#root/_help_veGu4faJErEM\">text content language</a>. For&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>, it's not possible to manually adjust the language.</p><aside class=\"admonition note\"><p>The trained data for each language is not packaged with Trilium, as that would require a significant amount of space that might not be otherwise needed. As such, when the trained data will be downloaded automatically via <a href=\"https://github.com/naptha/tesseract.js/\">Tesseract.js</a>.</p><p>The downloaded trained data is located in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_tAassRL4RSQL\">Data directory</a>, in the <code>ocr-cache</code> directory.</p></aside><h2>Viewing extracted content for a single note</h2><p>To access the extracted content of a note:</p><ul><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_W8vYD3Q1zjCR\">File</a>&nbsp;notes, go to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>&nbsp;→ <em>Advanced</em> → <em>View OCR Text</em>.</li><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>&nbsp;(e.g.&nbsp;<a class=\"reference-link\" href=\"#root/_help_mT0HEkOsz6i1\">Images</a>&nbsp;in&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;notes), double-click the attachment to view the details, press the […] button at the left and select <em>View extracted text (OCR)</em>.</li></ul><p>This section allows:</p><ul><li>Viewing the extracted text, which can be copied elsewhere if needed or just to check the quality of the extraction.</li><li>If the note has not been extracted yet, pressing <em>Process OCR</em> will process it in the background. If the extraction confidence is lower than the minimum confidence, there will be a notification.</li><li>Similarly, if the minimum confidence was changed in settings, it is possible to press the <em>Process OCR</em> button again to extract the text again.</li></ul>",
++ "_help_GBBMSlVSOIGP": "<p>Trilium can connect to a large language model and use it as an assistant that works directly on your notes: ask questions about the note you're reading, have it draft or restructure content, or get it to write scripts and widgets for you.</p><p>The integration is off by default and does nothing until you enable it and configure a provider; Trilium ships no model of its own. The provider you pick decides how your notes travel: a cloud API billed per use, a subscription you already pay for, or a model running on your own hardware, in which case nothing leaves the machine. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_bkPZAMT7d2sR\">Providers</a>&nbsp;for what each involves, and&nbsp;<a class=\"reference-link\" href=\"#root/_help_cRRrdZjgyhNc\">Privacy</a>&nbsp;for exactly what gets sent.</p><p>Once enabled, the assistant is available as:</p><ul><li>As a dedicated note type, it can read and modify notes through tools, which you can switch off per conversation if you would rather it only saw what you type.</li><li>A panel in the right sidebar, which acts similarly to the dedicated note type but it also has optional access to the current note.</li><li>An&nbsp;<a class=\"reference-link\" href=\"#root/_help_VRoP0g1uHHc2\">In-editor AI assistant</a>&nbsp;which comes with builtin actions that operate over selected text (such as proof-reading, summarizing), as well as&nbsp;<a class=\"reference-link\" href=\"#root/_help_mVEYwt20exhO\">Custom AI quick actions</a>.</li></ul><h2>Feature highlights</h2><ul><li>Chat-based interface with live streaming of the messages.</li><li>Provides the AI context with the note currently being looked at.</li><li>Tools to alter note content, create new notes, etc.</li><li>Statistics regarding context window use and pricing per message.</li><li>Attachments for multi-modal chat (images, text files, PDFs).</li><li>Optional MCP to allow external chat tools (e.g. Claude Code) to operate on notes within Trilium.</li></ul><h2>Sample use-cases</h2><ul><li>Create any type of&nbsp;<a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>.</li><li>Easily create a&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>, e.g. <em>Create for me a render note which allows me to play tic-tac-toe. Make sure to use Preact instead of the legacy jQuery.</em></li><li>Create widgets for a&nbsp;<a class=\"reference-link\" href=\"#root/_help_IF7Q6I9x7zuw\">Dashboard</a>, such as a calculator, a stopwatch, a pomodoro timer.</li></ul><aside class=\"admonition note\"><p>Claude Sonnet is known to produce very good frontend or backend scripts with little guidance, as the AI has been instructed in how to produce them.</p></aside><h2>LLM Providers</h2><p>Trilium supports four different types of providers:</p><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bx-cloud\"></span>&nbsp;Cloud</p><div class=\"trilium-tab-panel\"><p>Pay-per use with an API key which is billed separately from any subscription you might already have.</p><ul><li><span class=\"tn-icon tn-brand tn-brand-anthropic\"></span>&nbsp;Anthropic Claude</li><li><span class=\"tn-icon tn-brand tn-brand-openai\"></span>&nbsp;OpenAI GPT</li><li><span class=\"tn-icon tn-brand tn-brand-gemini\"></span>&nbsp;Google Gemini</li><li><span class=\"tn-icon tn-brand tn-brand-deepseek\"></span>&nbsp;DeepSeek</li></ul></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bx-coin\"></span>&nbsp;Subscription-based</p><div class=\"trilium-tab-panel\"><p>Reuses an existing subscription instead of paying per use.</p><ul><li><span class=\"tn-icon tn-brand tn-brand-claude\"></span>&nbsp;<a href=\"#root/_help_eFhxp9laTW1S\">Claude Code</a></li><li><span class=\"tn-icon tn-brand tn-brand-github-copilot\"></span>&nbsp;<a href=\"#root/_help_eFhxp9laTW1S\">GitHub Copilot</a></li><li><span class=\"tn-icon tn-brand tn-brand-antigravity\"></span>&nbsp;<a href=\"#root/_help_eFhxp9laTW1S\">Google Antigravity</a></li><li><span class=\"tn-icon tn-brand tn-brand-codex\"></span>&nbsp;<a href=\"#root/_help_eFhxp9laTW1S\">OpenAI Codex</a></li></ul></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bx-network-chart\"></span>&nbsp;Local/self-hosted</p><div class=\"trilium-tab-panel\"><ul><li><span class=\"tn-icon tn-brand tn-brand-ollama\"></span>&nbsp;Ollama</li><li><span class=\"tn-icon tn-brand tn-brand-lmstudio\"></span>&nbsp;LM Studio</li></ul></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bx-code-curly\"></span>&nbsp;Custom endpoints</p><div class=\"trilium-tab-panel\"><p>For other providers that are not directly supported by Trilium, either local or hosted (e.g. OpenRouter, Groq, Mistral).</p></div></section></div><aside class=\"admonition tip\"><p>For more information about each provider, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_bkPZAMT7d2sR\">Providers</a>. See the dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_cRRrdZjgyhNc\">Privacy</a>&nbsp;to better understand what data is sent to providers.</p></aside><h2>Enabling the AI integration</h2><p>To enable the AI integration, simply go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>AI / LLM</em> and press the toggle in the top-right of the dialog and configure a provider.</p><h2>Creating a new chat</h2><p>There are two different chat interfaces:</p><ul><li>One in the sidebar.</li><li>A dedicated note type.</li></ul><h3>The sidebar interface</h3><h3>The dedicated note type</h3><p>The dedicated chat note is similar to the sidebar interface, but it makes longer conversations more comfortable to read.</p><p>Unlike the sidebar, the AI will not be aware of the current note it's in.</p><h3>Templates</h3><p>Chat notes can be set as&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>&nbsp;to make them easily reusable. The entire conversation history is kept, allowing a basic form of specialization for the LLM with the existing chat acting like a system prompt.&nbsp;</p><h3>Model selection</h3><p>When a provider is configured in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>, the next step is to select the models that will be available for the chat.</p><p>The models are retrieved dynamically from the provider, only when the model selection list is visible. To alter the list of models, simply press the Edit button in the model selection box.</p><p>Pricing information is displayed for known models. The pricing information (price per million tokens) is embedded in the application (using a subset of LiteLLM's data) and is updated with new versions of Trilium. Local providers are considered free, whereas custom endpoint providers don't offer any pricing information.</p><h2>Features</h2><h3>Web search</h3><p>The AI can optionally search the web to find more information about a specific topic.&nbsp;</p><p>Where the search comes from is chosen in the <em>Web search</em> submenu of the <span class=\"tn-icon bx bx-shield-quarter\"></span><em>Tools</em> menu next to the model selector at the bottom of the chat, whose row shows the source in use:</p><ul><li><em>Disabled</em> turns web search off for this chat.</li><li><em>Use the model's built-in search</em>, the default, lets the model search with its provider's own search. Anthropic, OpenAI and Google Gemini models have one, as do Claude Code, Google Antigravity and OpenAI Codex. DeepSeek, Ollama, LM Studio and custom endpoints don't, so this choice is disabled for their models.</li><li>A search provider (Brave Search, Tavily, Exa, Serper, Perplexity or SearXNG) searches through that service instead, whichever model is answering. Search providers are added in the <em>Search Providers</em> section of the AI settings, which <em>Manage search providers</em> at the bottom of the submenu opens. The browser version can't use Brave Search, Exa or Perplexity, whose services refuse requests made from a web page, so they're shown disabled there.</li></ul><p>To use SearXNG, enable its JSON output by adding <code>json</code> to the search formats in the instance's <code>settings.yml</code>. SearXNG turns JSON off by default, and without it every search fails.</p><pre><code class=\"language-text-x-yaml\">search:\n formats:\n - html\n - json</code></pre><p>SearXNG doesn't use API keys, so leave the API key empty. Fill it in only if your instance sits behind a proxy that requires a token; Trilium sends it as a bearer token in the <code>Authorization</code> header.</p><p>Whether web search is on is kept per chat; the search source is shared by all chats. A choice the current model can't use stays in the menu, disabled; hover the <span class=\"tn-icon bx bx-info-circle\"></span>icon next to it to see why. Claude Code, GitHub Copilot, Google Antigravity and OpenAI Codex run their own tools, so they can't use a search provider.</p><p>In the chat, a search run through a search provider shows that provider's logo at the start of its line instead of the <span class=\"tn-icon bx bx-search\"></span>magnifier; hover the logo to see the provider's name.</p><p>With a search provider, the model can also read the pages it finds, or a link you give it, as text: Trilium fetches the page itself and hands the model up to its first 20,000 characters. Addresses on your own machine or network are refused. In the browser version most sites don't allow being read this way, so reading a page there usually fails.</p><h3>Thinking</h3><p>Some models reason before they answer. While the model is thinking, its reasoning is shown in full under a spinner; once it is done, it folds into a collapsible <em>Thought process</em> line above the reply.</p><p>How much a model thinks is set per chat, in one of two ways depending on the model:</p><ul><li>Most models have an <span class=\"tn-icon bx bx-brain\"></span><em>Extended thinking</em> button, next to the <span class=\"tn-icon bx bx-shield-quarter\"></span><em>Tools</em> button.</li><li>Models that offer several levels of reasoning (DeepSeek V4, OpenAI Codex, Antigravity) have a <span class=\"tn-icon bx bx-brain\"></span>reasoning effort dropdown next to the model selector instead. <em>None</em>, where offered, turns thinking off; higher levels give better answers to hard questions, but take longer and cost more.</li></ul><aside class=\"admonition note\"><p>The effort dropdown only appears once Trilium knows the model's levels. For a DeepSeek provider set up with an earlier version of Trilium, edit the provider in the model selection box and press <em>Save</em> once.</p></aside><h3>Note access (tools)</h3><p>Tools allow the agentic AI to understand and operate on notes directly within your Trilium instance.</p><p>This feature is on by default. To turn it off, press the <span class=\"tn-icon bx bx-shield-quarter\"></span><em>Tools</em> button next to the model selector at the bottom of the chat and switch off <em>Note access</em>. The <em>Tools</em> button is highlighted while note access or web search is on.</p><p>Here are a few tools that Trilium provides for the LLM:</p><ul><li>At note level:<ul><li>Search for notes</li><li>Get the metadata or content of a note.</li><li>Edit a note<ul><li>There are multiple mechanism for the LLM to edit a note: completely by re-writing it, find/replace of a text sequence or append.</li><li>When re-writing a note, the LLM can also change its type (for example from a text note to a code note) or the language of a code note, rewriting the content to match.</li><li>Whenever the AI makes a change, a <a href=\"#root/_help_vZWERwf8U3nx\">revision</a> is saved to be able to revert any unwanted changes.</li></ul></li><li>Create a new note<ul><li>Asked for a drawing, the LLM can create an SVG image note, or turn an existing note into one. It can write only SVG images, not other formats such as PNG.</li></ul></li><li>Rename or delete a note.</li></ul></li><li>At attribute level:<ul><li>Get the full list of attributes, or a specific attribute.</li><li>Set the value of an attribute.<ul><li>An attribute that runs code, such as <code>#run</code>, <code>#widget</code> or <code>~renderNote</code>, is saved with a <code>disabled:</code> prefix (for example <code>#disabled:widget</code>), the same way a safe import disables it (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_YzMcWlCVeW09\">Active content</a>). If the note already had that attribute enabled, the AI removes it, so none of it runs until you enable the new value. The AI tells you which note it is on; review the code, then enable it with the toggle next to the active content badge beside the note's title or, for a&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>, the <em>Enable render note</em> button in the note.</li></ul></li><li>Delete an attribute.</li></ul></li><li>At tree level:<ul><li>Get the direct children of a note.</li><li>Get the entire subtree of a note.</li><li>Move or clone a note somewhere else.</li></ul></li><li>For&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>:<ul><li>Get metadata for an attachment.</li><li>Get the content of an attachment.</li></ul></li><li>Skills (see the dedicated section).</li></ul><p>Each tool the AI uses appears in the chat as a single line naming the tool and the note or query it worked on; a renamed note shows its previous title struck through, a deleted note its title struck through, a moved note where it was moved from and to, an attribute the AI read, set or deleted as a pill (struck through once deleted), an attachment by its title, note and size, and a web page the AI read as a link. A line folds open only when there is something to read inline: the notes a search found, the pages a web search found, the icons an icon search found, the type, attributes or start of the content of a note the AI read, all the attributes of a note, the text of an attachment or of a web page, the User Guide pages the AI looked up or its table of contents (both open in the help panel), the children or the whole subtree of a note, what the AI wrote into a note it created, rewrote or added to, the changes of an edit, or the reason a tool failed. A search names on its line the part of the tree it is confined to, if any, and also shows how many notes it found and how many of the matches the AI asked for; each note it lists opens with a click. To see exactly what the AI sent to a tool and what it got back, hover the line and press the <span class=\"tn-icon bx bx-code-alt\"></span>button next to it; on touch screens the button is always shown.</p><p>When the reply stops moving for a couple of seconds while the AI is still at work, for example while it reads what a tool returned, a <em>Still working…</em> line appears under it until the next part of the reply arrives.</p><h4>Approving tool calls</h4><p>Before the AI runs a tool, the chat asks whether to allow it. The tool's line is marked with a <span class=\"tn-icon bx bxs-hand\"></span>icon and has <em>Allow</em> and <em>Deny</em> buttons below it. When the call would write to a note, the line opens on the text it would write or the changes of an edit. The reply waits until you answer.</p><ul><li>To let the call run, press <em>Allow</em>.</li><li>To stop asking about a tool for the rest of the chat, open the menu next to <em>Allow</em> and choose to always allow that tool for this chat. The call runs, and so do the other calls of that tool still waiting and every later one in this chat. Other tools keep asking, and a new chat asks again.</li><li>To refuse it, press <em>Deny</em>. The AI is told that you declined, and its reply carries on without the call, which is marked <em>denied</em>.</li><li>Stopping the reply denies every call that is still waiting.</li></ul><p>To make a chat ask about a tool again, open the <span class=\"tn-icon bx bx-shield-quarter\"></span><em>Tools</em> menu at the bottom of the chat and, under <em>Allowed in this chat</em>, press the tool. The submenu is shown once the chat has allowed a tool.</p><p>Which calls ask depends on the chat's permission mode, chosen in the <span class=\"tn-icon bx bx-shield-quarter\"></span><em>Tools</em> menu under <em>Permissions</em>:</p><ul><li><em>Always ask</em>: every call asks, including the ones that only read (searching notes, or reading a note or an attachment).</li><li><em>Ask before changes</em>: the calls that only read run on their own, and the ones that change your notes (creating, editing, renaming, moving or deleting a note, and setting or deleting an attribute) ask.</li><li><em>Don't ask</em>: every call runs without asking, changes included.</li></ul><p>A new chat starts in the mode you picked last, in any chat, or in <em>Ask before changes</em> until you pick one. Picking <em>Don't ask</em> therefore carries over to the next chat too.</p><p>A tool allowed for the chat runs without asking in every mode. So does looking something up in what ships with Trilium (its User Guide, the skill sheets that teach the AI Trilium's search syntax and note types, and the icons), since it reads none of your notes. Searching the web and reading a web page never ask either: turning on web search in the <em>Tools</em> menu is what allows them, whether the model searches on its own or through a search provider.</p><aside class=\"admonition note\"><p>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_eFhxp9laTW1S\">Subscription-based providers</a>&nbsp;(Claude Code, GitHub Copilot, Google Antigravity and OpenAI Codex) ask like any other provider.</p></aside><aside class=\"admonition note\"><p>Most changes you allow can be undone: a deleted note can be restored, and an edit reverted from its revision. Setting an attribute is harder to undo, since attributes have no history.</p></aside><aside class=\"admonition note\"><p>Gemini can't use its built-in search while note access is on. While it is, the built-in search choice in the <em>Tools</em> menu is disabled and says why; a search provider works with note access on.</p></aside><h3>Attachments</h3><p>Since Trilium v0.140.0,&nbsp;<a class=\"reference-link\" href=\"#root/_help_0vhv7lsOLy82\">Attachments</a>&nbsp;allow for multi-modal chat:</p><ul><li>Raster image (sent as vision input, except for SVGs) with the following supported formats: PNG, JPEG, GIF, WebP.</li><li>PDFs, sent natively to the provider (supported by Anthropic, OpenAI and Google).</li><li>SVG images (sent as raw HTML).</li><li>Text files.</li></ul><p>Not every model reads every kind of attachment: DeepSeek reads no PDFs, and images only with its vision models; OpenAI Codex, GitHub Copilot and Google Antigravity read images but no PDFs. For such a model:</p><ul><li>The attach button offers only the kinds the model reads, and a pasted or dropped file it can't read is not attached.</li><li>After switching to such a model, an attachment it can't read is marked with a <span class=\"tn-icon bx bx-error\"></span>warning, and the message can't be sent until the attachment is removed or another model is selected.</li><li>An attachment sent in an earlier message reaches the model as its name only, such as <code>[attached file: report.pdf]</code>, so it can tell you it doesn't see the content.</li></ul><p>To upload an attachment:</p><ul><li>Press the dedicated <em>Attach</em> button (paperclip icon) underneath the text box.</li><li>Paste an image directly from clipboard using Ctrl+V.</li></ul><p>Once one or more attachments are uploaded, they will appear directly above the text box:</p><ul><li>Images have a small thumbnail for easy identifications.</li><li>Every attachment can be deleted by pressing their corresponding X button.</li></ul><p>Clicking an image or a PDF, either its chip above the text box or where it appears in a sent message, opens it in a viewer: an image can be zoomed and panned there, a PDF read page by page. The button next to the viewer's close button opens the original file in a new browser tab. <kbd>Ctrl</kbd>-clicking instead opens an image in a new browser tab, and a PDF as an attachment in a new Trilium tab.</p><p>When an attachment is present, the LLM is instructed to consider the attachment with priority, even if it has access to the current note.</p><aside class=\"admonition note\"><p>Currently Trilium doesn't pre-process the attachments (e.g. via&nbsp;<a class=\"reference-link\" href=\"#root/_help_TiQbQDgP8L5t\">Text Extraction (OCR)</a>) before sending them to the LLM provider.</p></aside><h3>Mentions</h3><p>Mentions are a way to insert references to notes other than the current note, using the same mechanism as&nbsp;<a class=\"reference-link\" href=\"#root/_help_hrZ1D00cLbal\">Internal (reference) links</a>. To refer to another note, simply type @ followed by the name of the note to reference.</p><p>This feature is mostly helpful when note tools are enabled, otherwise the LLM will have no way to access the given note.</p><h3>Skills</h3><p>Skills in Trilium are specialized instruction sets that help the AI be more productive by understanding how Trilium.</p><p>These skills are not loaded by default to avoid an increased consumption of tokens, but the AI can load them on-demand if <em>Note tools</em> are enabled.</p><p>The following skills are built-in:</p><ul><li>Search syntax: understands the full syntax of&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>.</li><li>Backend scripting: to be able to write proper&nbsp;<a class=\"reference-link\" href=\"#root/_help_SPirpZypehBG\">Backend scripts</a>.</li><li>Frontend scripting: to be able to write proper <a href=\"#root/_help_yIhgI5H7A2Sm\">front-end scripts</a> (basic scripts, widgets,&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>).</li><li>Dashboards: to build a&nbsp;<a class=\"reference-link\" href=\"#root/_help_IF7Q6I9x7zuw\">Dashboard</a>&nbsp;and its widgets, including interactive ones made with a&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>.</li></ul><p>When <em>Note tools</em> are enabled the skills will automatically be made available to the AI, so no user interaction is required.</p><aside class=\"admonition note\"><p>Custom skills are currently not supported but they are planned.</p></aside><h3>MCP</h3><p>Trilium comes with a built-in MCP server which allows you to use an external agent such as Claude Code have access to your database. See the dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_KOWBFgsZXJAD\">MCP</a>&nbsp;page for more details.</p><h2>History</h2><h3>Removal in v0.102.0</h3><p>Starting with version v0.102.0, AI/LLM integration has been removed from the Trilium Notes core.</p><p>While a significant amount of effort went into developing this feature, maintaining and supporting it long-term proved to be unsustainable.</p><p>When upgrading to v0.102.0, your Chat notes will be preserved, but instead of the dedicated chat window they will be turned to a normal&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note, revealing the underlying JSON of the conversation.</p><h3>Reintroduction in v0.103.0</h3><p>Given the recent advancements of the AI scene, we decided to give the LLM integration another try. v0.103.0 introduces a completely new chat system.</p><p>One of the key changes that lead to the reimplementation is that now we are using a library (<a href=\"https://github.com/vercel/ai\">Vercel AI</a>) to manage the inner mechanism and the differences between LLM providers instead of having to implement it on our own.</p>",
++ "_help_bkPZAMT7d2sR": "<p>Providers are added in the <em>Model Providers</em> section of the AI settings, with <em>Add Model Provider</em>. Each one lists the models selected for it, which are the ones the chat offers; a provider with no models selected is not offered in the chat.</p><h2>Cloud providers using API keys</h2><p>Currently, the following cloud providers are supported:</p><ul><li><span class=\"tn-icon tn-brand tn-brand-anthropic\"></span>&nbsp;<a href=\"https://platform.claude.com/settings/workspaces/default/keys\">Anthropic</a></li><li><span class=\"tn-icon tn-brand tn-brand-openai\"></span>&nbsp;OpenAI</li><li><span class=\"tn-icon tn-brand tn-brand-gemini\"></span>&nbsp;Gemini</li><li><span class=\"tn-icon tn-brand tn-brand-deepseek\"></span>&nbsp;DeepSeek</li></ul><p>For all the providers, an API key is needed. Note that this is charged separately from the subscription you might already have (e.g. Claude Pro). If that might be a problem, consider using either a subscription provider (see below) or using it externally via MCP.</p><p>Do note that most other LLM providers (e.g. OpenRouter, Groq, Mistral) can still be used in Trilium via the OpenAI-compatible custom endpoint (see below).</p><p>If you are using a proxy or gateway, you can also configure the base URL, otherwise the default will be used.</p><aside class=\"admonition note\"><p>We don't plan to support all cloud providers, even if the library we are using would theoretically support them. Before opening a PR adding support for a different cloud provider, make sure to discuss it over <a href=\"https://github.com/orgs/TriliumNext/discussions\">GitHub Discussions</a>.</p></aside><aside class=\"admonition important\"><p>See also the dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_cRRrdZjgyhNc\">Privacy</a>&nbsp;section to better understand what data is being sent to a cloud provider.</p></aside><h2>Subscription-based providers</h2><p>Trilium integrates multiple&nbsp;<a class=\"reference-link\" href=\"#root/_help_eFhxp9laTW1S\">Subscription-based providers</a>:</p><ul><li><span class=\"tn-icon tn-brand tn-brand-claude\"></span>&nbsp;Claude Code by reusing your CLI.</li><li><span class=\"tn-icon tn-brand tn-brand-github-copilot\"></span>&nbsp;GitHub Copilot by reusing your CLI's ACP.</li><li><span class=\"tn-icon tn-brand tn-brand-antigravity\"></span>&nbsp;Google Antigravity by downloading and setting up an ACP for Trilium.</li><li><span class=\"tn-icon tn-brand tn-brand-codex\"></span>&nbsp;OpenAI Codex by reusing your CLI through an ACP adapter shipped with Trilium.</li></ul><h2>Local/self-hosted providers</h2><p>Local or self-hosted providers are a free alternative which respects your privacy but requires specific hardware.</p><p>Trilium directly supports the following local providers:</p><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon tn-brand tn-brand-ollama\"></span>&nbsp;Ollama</p><div class=\"trilium-tab-panel\"><p>Generally Ollama runs in the background so it should be directly usable in Trilium as long as the models are downloaded (e.g. <code>ollama pull llama3.2</code>).</p></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon tn-brand tn-brand-lmstudio\"></span>&nbsp;LM Studio</p><div class=\"trilium-tab-panel\"><p>The OpenAI-compatible server is <strong>disabled</strong> by default in LM Studio installations. First download your desired models through the graphical interface, then go to <em>Settings</em> → <em>Developer</em> and toggle <em>Developer mode</em>. On the left there will be a new <em>Developer</em> tab, with a toggle to start it up.</p></div></section></div><p>Even for local providers that are not directly supported by Trilium, you can still use a custom endpoint (see below).</p><aside class=\"admonition warning\"><p>When dealing with self-hosted LLM models, depending on the training and the size of the model, the quality of the output may vary. Before <a href=\"#root/_help_wy8So3yZZlH9\">reporting issues</a> regarding the quality of the output (e.g. hallucinating tool calls), consider benchmarking the response against a cloud provider (Claude Sonnet is recommended).</p></aside><h2>Custom endpoints</h2><p>If your desired hosted (e.g. OpenRouter, Groq, Mistral) or local LLM provider is not listed in Trilium, you can use the dedicated <em>OpenAI-compatible</em> provider from the <em>Custom endpoint</em> section.</p><p>This allows you to set the base URL to an OpenAI-compatible API, with an optional API key if required by the service.</p><p>Enter the base URL exactly as the service documents it, including its version path, such as <code>https://api.groq.com/openai/v1</code> or <code>https://open.bigmodel.cn/api/paas/v4</code>. Only a bare host such as <code>http://localhost:8080</code> is completed with <code>/v1</code>.</p><p>For custom endpoints, the pricing of the models is not known so the cost of a conversation will not be displayed; this is especially relevant for hosted providers.</p>",
++ "_help_eFhxp9laTW1S": "<p>Some cloud providers offer a subscription, which has a fixed monthly fee instead of pay-per-use (unlike the API keys).</p><p>In a nutshell, subscription-based providers work by either reusing your existing CLI tools (e.g. Claude Code, GitHub Copilot and OpenAI Codex via ACP) whereas some require installing the ACP server manually (e.g. Google Antigravity). Because they require something to be installed on your device, these providers are not available on Mobile (Android or iOS) or standalone mode.</p><p>See also the dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_cRRrdZjgyhNc\">Privacy</a>&nbsp;section to better understand what data is being sent to a cloud provider.</p><h2><span class=\"tn-icon tn-brand tn-brand-claude\"></span>&nbsp;Claude Code</h2><p>To use a subscription:</p><ol><li>First, Claude Code needs to be installed on the machine that runs Trilium. So for a&nbsp;<a class=\"reference-link\" href=\"#root/_help_poXkQfguuA0U\">Desktop Installation</a>, Claude needs to be installed locally and for a&nbsp;<a class=\"reference-link\" href=\"#root/_help_WOcw2SLH6tbX\">Server Installation</a>&nbsp;accessed via a browser, Claude needs to be installed on the server.</li><li>Claude Code must already be authenticated. To do so, run <code>claude</code> in a terminal once, type <code>/login</code> and follow the instructions.</li><li>Go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>AI / LLM</em> and add the Claude Code provider.</li></ol><details class=\"trilium-collapsible\"><summary>How Trilium identifies your Claude Code binary</summary><p>In this order:</p><ul><li>By looking for a <code>TRILIUM_CLAUDE_CODE_PATH</code> environment variable pointing to the Claude binary. This allows overriding the path if needed.</li><li>By looking for <code>claude</code> in your PATH, generally works in most circumstances.</li><li>By asking your login shell for its <code>PATH</code> which lets a desktop install find a CLI installed through <code>nvm</code>, <code>fnm</code>, <code>asdf</code> or Homebrew, since a GUI-launched app doesn't inherit your terminal's environment.</li></ul></details><p>After your provider is set up, you'll benefit from the same features as an API key (note tools, web search, extended thinking, image/PDF attachments, streaming).</p><aside class=\"admonition note\"><p>Trilium intentionally uses your Claude Code binary in order not to have to package a ~250 MB client with it, but this comes at a cost: there is a small risk for a version incompatibility, if the version installed locally doesn't match the one expected by Trilium. Generally it's best to keep both Claude Code and Trilium updated to the latest version.</p></aside><h2><span class=\"tn-icon tn-brand tn-brand-github-copilot\"></span>&nbsp;GitHub Copilot</h2><aside class=\"admonition note\"><p>This subscription-based provider is still in beta. It is safe to use (won't use additional funds and respects the terms of use), but you might experience small issues. Consider&nbsp;<a class=\"reference-link\" href=\"#root/_help_wy8So3yZZlH9\">Reporting issues</a>.</p></aside><p>GitHub Copilot gives access to the models of your GitHub Copilot subscription (Pro, Pro+, Business or Enterprise), without an API key. Usage counts against your Copilot plan.</p><ol><li>Install the GitHub Copilot CLI on the machine that runs Trilium, for example with <code>npm install -g @github/copilot</code>. As with Claude Code, for a&nbsp;<a class=\"reference-link\" href=\"#root/_help_WOcw2SLH6tbX\">Server Installation</a>&nbsp;it needs to be installed on the server.</li><li>Sign in by running <code>copilot login</code> in a terminal once. If you already use GitHub Copilot in another editor on the same machine, that login is reused.</li><li>Go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>AI / LLM</em> and add the GitHub Copilot provider.</li></ol><details class=\"trilium-collapsible\"><summary>How Trilium identifies your Copilot CLI binary</summary><p>In this order:</p><ul><li>By looking for a <code>TRILIUM_COPILOT_PATH</code> environment variable pointing to the Copilot binary.</li><li>By looking for <code>copilot</code> in your PATH.</li><li>By asking your login shell for its <code>PATH</code>, the same as for Claude Code.</li></ul></details><h3>Known limitations</h3><ul><li>The agent can only work with your notes through Trilium's note tools; its own file, shell and web tools are blocked for security reasons.</li><li>Images can be attached to the conversation, PDFs cannot. The LLM should still be able to read PDF notes and attachments via&nbsp;<a class=\"reference-link\" href=\"#root/_help_TiQbQDgP8L5t\">Text Extraction (OCR)</a>&nbsp;when the note tools are enabled.</li></ul><h2><span class=\"tn-icon tn-brand tn-brand-antigravity\"></span>&nbsp;Google Antigravity</h2><aside class=\"admonition note\"><p>This subscription-based provider is still in beta. It is safe to use (won't use additional funds and respects the terms of use), but you might experience small issues. Consider&nbsp;<a class=\"reference-link\" href=\"#root/_help_wy8So3yZZlH9\">Reporting issues</a>.</p></aside><p>Google Antigravity gives access to Gemini models using a Google account (free, Google AI Pro or Google AI Ultra), without an API key. At the time of writing, a free Google account is enough to use it.</p><p>Unlike Claude Code or GitHub Copilot, Google's Antigravity ACP server is not part of the CLI so it needs to be installed manually just for Trilium. The downloaded archive is around 112-334 MB and the extracted size is around 230 MB-2 GB based on the platform.</p><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-windows\"></span>&nbsp;Windows</p><div class=\"trilium-tab-panel\"><ol><li>Download Google's Antigravity ACP server for your platform. The link is shown when adding the provider in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>AI / LLM</em>. Unpack it on the device that runs Trilium.</li><li>Make it findable by Trilium, either:<ol><li>by adding the unpacked folder to your PATH, or</li><li>by setting a <code>TRILIUM_ANTIGRAVITY_ACP_PATH</code> environment variable pointing to <code>agy_acp_server.exe</code>.</li></ol></li><li>Go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ AI / LLM and add the&nbsp;<span class=\"tn-icon tn-brand tn-brand-antigravity\"></span> <em>Google Antigravity</em> provider. When the list of models is loaded for the first time, the Google sign-in page opens in a browser on the machine running Trilium; finish signing in there.</li></ol></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-tux\"></span>&nbsp;Linux &amp;&nbsp;<span class=\"tn-icon bx bxl-apple\"></span> macOS</p><div class=\"trilium-tab-panel\"><ol><li>Download Google's Antigravity ACP server for your platform. The link is shown when adding the provider in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>AI / LLM</em>. Unpack it on the device that runs Trilium.</li><li>Make it findable by Trilium, either:<ol><li>by adding the unpacked folder to your PATH, or</li><li>by setting a <code>TRILIUM_ANTIGRAVITY_ACP_PATH</code> environment variable pointing to <code>agy_acp_server.par</code>.</li></ol></li><li>Go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ AI / LLM and add the&nbsp;<span class=\"tn-icon tn-brand tn-brand-antigravity\"></span> <em>Google Antigravity</em> provider. When the list of models is loaded for the first time, the Google sign-in page opens in a browser on the machine running Trilium; finish signing in there.</li></ol></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">NixOS</p><div class=\"trilium-tab-panel\"><ol><li><p>On NixOS, <code>antigravity-acp</code> package is already available but only in <code>nixos-unstable</code> at the time of writing. The easiest method to test it out is to use the <code>nix shell</code> with flakes:</p><pre><code class=\"language-text-x-trilium-auto\">NIXPKGS_ALLOW_UNFREE=1 nix shell --impure github:nixos/nixpkgs/nixos-unstable#antigravity-acp\ntrilium</code></pre></li><li><p>Go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ AI / LLM and add the&nbsp;<span class=\"tn-icon tn-brand tn-brand-antigravity\"></span> <em>Google Antigravity</em> provider. When the list of models is loaded for the first time, the Google sign-in page opens in a browser on the machine running Trilium; finish signing in there.</p></li></ol></div></section></div><aside class=\"admonition note\"><p>Trilium needs <code>curl</code> to use Google Antigravity. It comes with Windows 10 and later, macOS and most Linux distributions.</p></aside><h3>Known limitations</h3><ul><li>The agent can only work with your notes through Trilium's note tools; its own file and shell tools are blocked for security reasons.</li><li>The Antigravity ACP server requires authentication via a login link. The login link needs to be run on the same device, so it might not be possible to set up the provider while using the web version of a Docker installation.&nbsp;<a class=\"reference-link\" href=\"#root/_help_poXkQfguuA0U\">Desktop Installation</a>&nbsp;should work fine.</li><li>Images can be attached to the conversation, PDFs cannot. The LLM should still be able to read PDF notes and attachments via&nbsp;<a class=\"reference-link\" href=\"#root/_help_TiQbQDgP8L5t\">Text Extraction (OCR)</a>&nbsp;when the note tools are enabled.</li><li>The results of tool calls (e.g. reading a note, writing attributes) are not properly displayed because they are not exposed by the ACP server.</li></ul><h2><span class=\"tn-icon tn-brand tn-brand-codex\"></span>&nbsp;OpenAI Codex</h2><aside class=\"admonition note\"><p>This subscription-based provider is still in beta. It is safe to use (won't use additional funds and respects the terms of use), but you might experience small issues. Consider&nbsp;<a class=\"reference-link\" href=\"#root/_help_wy8So3yZZlH9\">Reporting issues</a>.</p></aside><p>OpenAI Codex gives access to the Codex models of your ChatGPT plan (Free, Go, Plus, Pro or Business), without an API key. At the time of writing, a free ChatGPT account is enough to use it. Usage counts against your plan's Codex limits, which are small on the Free plan.</p><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-windows\"></span><span class=\"tn-icon bx bxl-tux\"></span><span class=\"tn-icon bx bxl-apple\"></span>&nbsp;Most platforms</p><div class=\"trilium-tab-panel\"><ol><li>Install the Codex CLI on the machine that runs Trilium, for example with <code>npm install -g @openai/codex</code>. As with Claude Code, for a&nbsp;<a class=\"reference-link\" href=\"#root/_help_WOcw2SLH6tbX\">Server Installation</a>&nbsp;it needs to be installed on the server. Trilium ships the ACP adapter that connects to it, so nothing else is needed.</li><li>Go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>AI / LLM</em> and add the&nbsp;<span class=\"tn-icon tn-brand tn-brand-codex\"></span> <em>OpenAI Codex</em> provider. When the list of models is loaded for the first time, the ChatGPT sign-in page opens in a browser on the machine running Trilium; finish signing in there.</li></ol></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">NixOS</p><div class=\"trilium-tab-panel\"><ol><li><p>On NixOS, Codex is available as the <code>codex</code> package in nixpkgs. The stable channel can lag behind Codex's releases, so a newer version can be taken from <code>nixos-unstable</code>:</p><pre><code class=\"language-text-x-sh\">nix shell github:nixos/nixpkgs/nixos-unstable#codex\ntrilium</code></pre></li><li><p>Go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>AI / LLM</em> and add the&nbsp;<span class=\"tn-icon tn-brand tn-brand-codex\"></span> <em>OpenAI Codex</em> provider. When the list of models is loaded for the first time, the ChatGPT sign-in page opens in a browser on the machine running Trilium; finish signing in there.</p></li></ol></div></section></div><p>Trilium keeps its own Codex sign-in and settings, separate from any Codex CLI you use in a terminal, so an existing <code>codex login</code> is not reused.</p><details class=\"trilium-collapsible\"><summary>How Trilium identifies your Codex CLI binary</summary><p>In this order:</p><ul><li>By looking for a <code>TRILIUM_CODEX_PATH</code> environment variable pointing to the Codex binary.</li><li>By looking for <code>codex</code> in your PATH.</li><li>By asking your login shell for its <code>PATH</code>, the same as for Claude Code.</li></ul></details><aside class=\"admonition note\"><p>Trilium needs <code>curl</code> to use OpenAI Codex, the same as for Google Antigravity: Trilium checks every tool call Codex makes through it. It comes with Windows 10 and later, macOS and most Linux distributions.</p></aside><h3>Known limitations</h3><ul><li>The agent can only work with your notes through Trilium's note tools, and search the web when the chat allows it; its own file, shell and other tools are blocked for security reasons.</li><li>The ChatGPT sign-in opens in a browser on the device running Trilium, so it might not be possible to set up the provider while using the web version of a Docker installation.&nbsp;<a class=\"reference-link\" href=\"#root/_help_poXkQfguuA0U\">Desktop Installation</a>&nbsp;should work fine.</li><li>Images and SVGs can be attached to the conversation, PDFs cannot. The LLM should still be able to read PDF notes and attachments via&nbsp;<a class=\"reference-link\" href=\"#root/_help_TiQbQDgP8L5t\">Text Extraction (OCR)</a>&nbsp;when the note tools are enabled.</li></ul>",
++ "_help_cRRrdZjgyhNc": "<p>Trilium sends nothing to an AI provider until you send a message. Enabling the integration, adding a provider or opening a chat transmits nothing on its own, the one exception is that listing a provider's models sends your API key to that provider, so the list can be fetched.</p><p>Once you send a message or run the&nbsp;<a class=\"reference-link\" href=\"#root/_help_VRoP0g1uHHc2\">In-editor AI assistant</a>, what leaves your machine depends on the provider you chose and on which context options are enabled.</p><h2>Where your notes go</h2><figure class=\"table\"><table><thead><tr><th>Provider type</th><th>Destination</th></tr></thead><tbody><tr><td>Cloud providers</td><td>The provider's servers (Anthropic, OpenAI, Google, DeepSeek)</td></tr><tr><td>Subscription-based</td><td>The provider's servers, via Claude Code running locally</td></tr><tr><td>Local / self-hosted</td><td>Nothing leaves the machine running the model</td></tr><tr><td>Custom endpoint</td><td>Wherever it was pointed, which may be your own hardware or a hosted service</td></tr></tbody></table></figure><p>This is the reason the provider list is grouped this way, and why Trilium pre-selects nothing: the choice of where your note content is sent is made explicitly by you, before anything is sent.</p><aside class=\"admonition note\"><p>The&nbsp;<a class=\"reference-link\" href=\"#root/_help_VRoP0g1uHHc2\">In-editor AI assistant</a>&nbsp;has a model selection of its own, so it may be answered by a different provider than the one in the chat. The row at the bottom of the assistant's menu always names the one being used.</p></aside><h2>What is actually sent</h2><ul><li><strong>Always, with every message</strong><ul><li>The conversation itself: your messages and the assistant's replies, including earlier turns</li><li>Trilium's system prompt describing how to format answers and use tools.</li></ul></li><li><strong>The current note, only when note context is enabled.</strong><ul><li>In the sidebar chat this is the file icon at the bottom; the dedicated chat note type never sends a current note.</li><li>What travels is a metadata block: the note's ID, title, type, creation and modification dates, its parent IDs, the titles of up to 20 children, up to 20 attributes, and a preview of the content.</li><li>Notes above a size threshold send a size hint instead of the text, and the model must call a tool to read further.</li></ul></li><li><strong>Any note the model asks for, when note access is enabled.</strong><ul><li>Tools let the model search your tree and read notes, attributes and attachments beyond the current one.</li><li>It decides what to fetch, and each call waits for you to allow it, unless the chat's permission mode lets reads or every call run on their own, or you allowed that tool for the chat. There is no per-note permission system, so the reachable scope is your whole tree.</li></ul></li><li><strong>Attachments and mentions</strong>, when you add them: images, PDFs and text files are sent to the provider, and an <code>@</code> mention makes that note fetchable.</li><li><strong>Your search query</strong>, when web search is enabled, the model's search terms reach the provider's own search infrastructure, or the search provider chosen in the <em>Tools</em> menu (Brave Search, Tavily, Exa, Serper, Perplexity or your SearXNG instance).</li><li><strong>The pages the model reads</strong>, when web search goes through a search provider: Trilium fetches each page the model asks for from the site itself, so the site sees a request from the machine running Trilium. The page's text is then sent to the model's provider.</li></ul><h2>The in-editor AI assistant</h2><p>A run of the&nbsp;<a class=\"reference-link\" href=\"#root/_help_VRoP0g1uHHc2\">In-editor AI assistant</a>&nbsp;sends a different set than a chat message. For quick actions, it sends it the moment you pick an action, there is no send button to reconsider at. For the free-form <em>Ask AI</em>, there is a dedicated send button and model selector.</p><ul><li><strong>The passage you selected</strong>, or the paragraph the cursor is in when you pick a quick action without selecting anything.</li><li><strong>Up to 1500 characters of the note on each side of that passage</strong>, as plain text. The assistant is told this is context only and must not be rewritten, but it is sent regardless of whether you selected it: a run on a single sentence still transmits the paragraphs around it.</li><li><strong>Where the note sits</strong>: its title and the titles of its parents, as a breadcrumb.</li><li><strong>Trilium's writing-assistant instructions</strong>, which describe the formatting it may produce.</li><li><strong>Earlier turns of the same exchange</strong>, once you follow up on a response.</li></ul><p>No note metadata block is sent, web search is never enabled, and the assistant has no note tools so it can read nothing beyond the text listed above.</p><h2>Protected notes</h2><p>While your <a href=\"#root/_help_bwg0e8ewQMak\">protected session</a> is locked, protected notes send neither title nor content. <strong>While it is unlocked they are treated like any other note,</strong> a note the model reads through a tool is sent to the provider in full. If you keep sensitive material in protected notes, be aware that unlocking them removes that boundary for the duration of the session.</p><p>The same applies to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_VRoP0g1uHHc2\">In-editor AI assistant</a>: it works on whatever is open in the editor, so running it inside an unlocked protected note sends that note's text like any other.</p><h2>What you control</h2><ul><li><strong>Which provider</strong>: the single decision that determines whether anything leaves your machine at all.</li><li><strong>Note access</strong>: turn it off in the <span class=\"tn-icon bx bx-shield-quarter\"></span><em>Tools</em> menu at the bottom of the chat, and the model can read nothing beyond what you type.</li><li><strong>The current note:</strong> the file icon in the sidebar chat.</li><li><strong>Web search:</strong> also in the <em>Tools</em> menu.</li><li><strong>Which tool calls ask first:</strong> the <em>Permissions</em> submenu of the <em>Tools</em> menu. <em>Always ask</em> has every call wait for you, reads included. A new chat starts in the mode you picked last, so a chat after one set to <em>Don't ask</em> asks about nothing either. Until you pick a mode, chats start in <em>Ask before changes</em>, where the AI reads and searches your notes without asking.</li><li><strong>The editor assistant</strong>: it has no per-run toggles. What you control is whether you run it, what you select before you do and which model answers.</li></ul><p>With note access and note context both off, the provider receives only the words you typed.</p><h2>Keeping everything local</h2><p>Adding an Ollama or LM Studio provider keeps every message on the machine running the model, and Trilium marks their models as free because no metered API is involved. The trade-off is quality and hardware: a small local model may fail at tool calls that a cloud model handles, so a local setup that misbehaves is worth benchmarking against a cloud provider before reporting it as a bug.</p><h2>Telemetry &amp; security</h2><p>Trilium itself collects no telemetry from the AI integration.</p><p>Your API key is stored in your database, sent only to the provider it belongs to, and is write-only through the options API so that a malevolent&nbsp;<a class=\"reference-link\" href=\"#root/_help_CdNpE2pqjmI6\">Scripting</a>&nbsp;cannot access it. If you have backend or SQL console access enabled, a malevolent script <strong>could potentially exfiltrate your API keys</strong>.</p><p>The built-in MCP server is off by default. When enabled, every request must carry an ETAPI token, which grants the same full read and write access to your notes as the REST API; treat one like a password. On desktop it is reachable only from <code>localhost</code> unless you turn on&nbsp;<a class=\"reference-link\" href=\"#root/_help_swSFivWk6KkA\">Network Access</a>.</p>",
++ "_help_KOWBFgsZXJAD": "<p><a href=\"https://en.wikipedia.org/wiki/Model_Context_Protocol\">Model Context Protocol</a> allows external chat applications such as Claude Code to have access to the Trilium database.</p><h2>Built-in MCP</h2><p>v0.103.0 comes with a built-in MCP server that is not active by default. To activate it, go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ AI/LLM and toggle the <em>MCP server</em> option.</p><p>Once the MCP is active, simply add the MCP server to your AI assistant. The URL to use is displayed in the <em>Endpoint</em> <em>URL</em> information underneath the MCP toggle.</p><p>Only the HTTP transport is supported, the <code>stdio</code> method is not supported. If that is a blocker, consider using a third-party alternative listed below.</p><p>The tools exposed to the MCP are the same tools that are supported by the internal chat (see the <em>Note access</em> section).</p><h3>Approving tool calls</h3><p>Trilium does not ask for approval of the calls an external assistant makes; that is left to the assistant's own permission settings. To help it decide, each tool tells the assistant whether it only reads your notes, only adds to them (creating a note, cloning it or appending to it), or can overwrite or remove something (editing, renaming, moving or deleting). An assistant that supports these hints can then run reads on their own and ask before changes, the way <em>Ask before changes</em> does in Trilium's chat.</p><h3>Authentication</h3><p>To protect your notes from unauthorized access, the MCP server requires authentication. Generally MCP servers need to support OAuth for authentication, but Trilium uses a simpler mechanism using Bearer tokens.</p><p>To configure authentication, first create an&nbsp;<a class=\"reference-link\" href=\"#root/_help_pgxEVkzLl1OP\">ETAPI (REST API)</a>&nbsp;token by going to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>ETAPI</em>. Then follow the instructions in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>AI / LLM</em>, by looking at the <em>How to connect an assistant</em> section under MCP.</p><h2>Third-party alternatives</h2><p>The following are alternatives to Trilium's built-in MCP feature. Since Trilium's AI implementation is still experimental, its tooling might not be as mature as external tools.</p><ul><li><a href=\"https://github.com/perfectra1n/triliumnext-mcp\">perfectra1n/triliumnext-mcp</a></li><li><a href=\"https://github.com/tan-yong-sheng/triliumnext-mcp\">tan-yong-sheng/triliumnext-mcp</a></li><li><a href=\"https://github.com/eliassoares/trilium-fastmcp\">eliassoares/trilium-fastmcp</a></li></ul><aside class=\"admonition important\"><p>These solutions are third-party and thus not endorsed or supported directly by the Trilium Notes team. Please address questions and issues on their corresponding repository instead.</p></aside>",
++ "_help_Y84QCbArmK3z": "<aside class=\"admonition important\"><p><strong>Meeting transcription is in beta</strong></p><p>Meeting transcription is a new feature and is still in beta. It has not been tested on every operating system, audio setup and meeting application, so it might fail to capture the audio, miss part of a meeting or behave differently from what this page describes. Before relying on it for an important meeting, try it on a short call first.</p><p>If something does not work, please <a href=\"#root/_help_wy8So3yZZlH9\">report the issue</a>, mentioning your operating system and the meeting application you used. The <em>Keep recordings for troubleshooting</em> option described below keeps what is needed to reproduce a problem.</p></aside><p>Meeting transcription turns a meeting into text while it happens: Trilium listens to your microphone and to what the other participants say through your speakers, and writes down who said what in a new note. Recognition runs entirely on your device, so no audio leaves it.</p><p>Meeting transcription is available only in the desktop application. It is not available when Trilium is accessed through a browser, nor in the mobile application.</p><h2>Enabling meeting transcription</h2><p>Meeting transcription is off by default. To turn it on, go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Transcription</em> and turn on <em>Meeting transcription</em>. This adds the <span class=\"tn-icon bx bx-microphone\"></span> <em>Transcribe meeting</em> button to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>, marked with a <em>Beta</em> badge.</p><p>The speech recognition models are not part of Trilium. The first time you transcribe a meeting, Trilium asks to download them; see&nbsp;<a class=\"reference-link\" href=\"#root/_help_ebyr7ES2SwOW\">Downloaded resources</a> for the sizes and how to manage them. Each device downloads its own copy.</p><h2>Transcribing a meeting</h2><ol><li>Press the <span class=\"tn-icon bx bx-microphone\"></span> <em>Transcribe meeting</em> button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</li><li>If the models are not downloaded yet, confirm the download and wait for it to finish.</li><li>Trilium creates a text note titled with the current date and time (for example <em>Meeting 2026-10-15 14:30</em>) in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_S0Fos78ZfcY7\">Note Inbox</a>, opens it and starts transcribing. While it transcribes, the button turns into a <span class=\"tn-icon bx bx-stop-circle\"></span> <em>Stop transcribing</em> button and shows the time elapsed. Beside it, a reminder asks you to let everyone in the meeting know that it is being transcribed and to ask for their consent; it closes by itself after 10 seconds, or when you click it.</li><li>To end the transcription, press the <span class=\"tn-icon bx bx-stop-circle\"></span> <em>Stop transcribing</em> button. Trilium finishes transcribing what was already said before it stops.</li></ol><p>Only one meeting can be transcribed at a time. The note itself is an ordinary text note: you can take notes in it during the meeting, rename it or move it anywhere in the tree. It carries the <code>#meetingRecording</code> label.</p><p>Trilium tells you when your microphone or the meeting's audio is not being transcribed. It shows a message saying which one and why, the time on the button turns red and the button's tooltip says that some audio is not being transcribed:</p><ul><li><strong>Not captured</strong>: the transcription started without that audio, for example because there is no microphone or because Trilium was not allowed to record the screen and its audio. Connect the microphone or allow the recording, then stop the transcription and start it again.</li><li><strong>No audio</strong>: nothing has arrived from it for 10 seconds, as when its capture hangs. Stop the transcription and start it again; what was transcribed until then is kept.</li><li><strong>Only silence</strong>: it has delivered nothing but silence, for 15 seconds from your microphone or for a minute from the meeting. A microphone muted in your system's settings, or with a mute button of its own, does this. A meeting nobody speaks in for a minute does it too, so this message can be ignored when the others are just quiet.</li></ul><p>Each message shows once. <em>No audio</em> and <em>Only silence</em> clear by themselves once sound arrives again.</p><p>If the transcription stops on its own, for example because the audio could no longer be captured, Trilium shows a message and keeps everything transcribed until then. Closing Trilium during a meeting waits for the transcription to finish first.</p><h2>The transcript</h2><p>The transcript is stored as an <a href=\"#root/_help_0vhv7lsOLy82\">attachment</a> of the meeting note and is shown in a collapsible <em>Transcript</em> section above the note's content. It updates as the meeting goes on, one paragraph per speaker turn, each with the time it started. While the meeting is being transcribed, the header of the <em>Transcript</em> section shows the level of your microphone (<em>Me</em>) and of the meeting's audio (<em>Others</em>), so you can tell that both are being heard, even while the section is collapsed; a source that is not being transcribed is marked <em>Not captured</em>, <em>No audio</em> or <em>Only silence</em>. While someone is talking, <em>Speaking…</em> shows under their name until their words are transcribed. If you are reading the end of the transcript, it scrolls to follow new text.</p><ul><li>What you say into your microphone is labeled <em>Me</em>.</li><li>What the other participants say is labeled <em>Speaker 1</em>, <em>Speaker 2</em> and so on, while <em>Identify speakers</em> is on; otherwise it is labeled <em>Others</em>.</li><li>To name a speaker, click their name, type the new name and press <kbd>Enter</kbd>. The name changes on every turn of that speaker. Press <kbd>Esc</kbd> to cancel, or clear the name to restore the default one.</li><li>To show the transcript with or without hesitations such as \"uh\", \"um\" and stuttered words, press the <span class=\"tn-icon bx bx-eraser\"></span> <em>Hide filler words</em> button above it, which shows as pressed while they are hidden. While they are shown, they are grayed out, so you can see what hiding them would remove. This affects only what is shown; the stored transcript keeps every word.</li><li>To copy the transcript as plain text, press the <span class=\"tn-icon bx bx-copy\"></span> <em>Copy transcript</em> button above it. Each turn is copied with the speaker's name and the time it started, as shown, so the copy leaves out filler words while they are hidden.</li></ul><p>If the meeting note is <a href=\"#root/_help_bwg0e8ewQMak\">protected</a> and the protected session is locked during the meeting, the transcript cannot be saved. Trilium keeps it in memory and saves it once you enter the protected session again, as long as Trilium stays open.</p><h2>Configuration</h2><p>The settings are in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Transcription</em>, and are shown once <em>Meeting transcription</em> is on.</p><figure class=\"table\"><table><thead><tr><th>Option</th><th>Description</th></tr></thead><tbody><tr><td><em>European languages</em></td><td>The speech recognition model. Both recognize 25 European languages and work out which one is spoken. <em>Standard</em> is a smaller download and runs well on most computers. <em>High accuracy</em> makes fewer mistakes, but is a larger download and needs about 1.6 GB more memory while transcribing. A model is downloaded the first time you transcribe with it.</td></tr><tr><td><em>Identify speakers</em></td><td>Tells the other participants apart and labels each of them separately. Voices are compared only during the meeting: nothing about a voice is stored, and no one is recognized from one meeting to the next. Turn it off if it mixes up voices. The change applies from the next meeting.</td></tr><tr><td><em>Keep recordings for troubleshooting</em></td><td>Keeps the audio of the meeting, the settings used and the transcript as it was produced, so that a problem can be reported and reproduced. It takes about 230 MB per hour of meeting and is never deleted automatically. The folder where they are kept is shown below the option.</td></tr></tbody></table></figure><aside class=\"admonition warning\"><p>Before turning on <em>Keep recordings for troubleshooting</em>, ask everyone in the meeting to agree to being recorded. In several countries and US states, recording a conversation without everyone's consent is a criminal offense. The audio is stored unencrypted, even for protected notes. While the option is on, the tooltip of the <em>Transcribe meeting</em> button says so, and the reminder shown when the transcription starts mentions that the audio is kept.</p></aside><h2>Limitations</h2><ul><li>Meeting transcription needs a speech recognition engine that does not load on every computer, for example on Linux distributions older than Ubuntu 22.04 or Debian 12. Where it does not load, the <em>Transcribe meeting</em> button does not appear, the <em>Transcription</em> options say so, and the log records why.</li><li>The transcript is made from the audio played by your device. A participant whose voice does not come out of your speakers or headphones, for example someone in the same room, is transcribed only as far as your microphone picks them up, and is labeled <em>Me</em>.</li><li>Speaker identification works best with a few clearly distinct voices. Similar voices, many participants or poor call quality can lead to speakers being merged or split.</li><li>Accuracy is lower for languages other than English, and the model can switch to the wrong language for short passages.</li><li>Transcribing uses a noticeable amount of processor time and memory, especially with the <em>High accuracy</em> model.</li></ul>",
++ "_help_CdNpE2pqjmI6": "<p>Trilium supports creating&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;notes, i.e. notes which allow you to store some programming code and highlight it. Special case is JavaScript code notes which can also be executed inside Trilium which can in conjunction with&nbsp;<a class=\"reference-link\" href=\"#root/_help_GLks18SNjxmC\">Script API</a>&nbsp;provide extra functionality.</p><h2>Architecture Overview</h2><p>To go further I must explain basic architecture of Trilium - in its essence it is a classic web application - it has these two main components:</p><ul><li>frontend running in the browser (using HTML, CSS, JavaScript) - this is mainly used to interact with the user, display notes etc.</li><li>backend running JavaScript code in node.js runtime - this is responsible for e.g. storing notes, encrypting them etc.</li></ul><p>So we have frontend and backend, each with their own set of responsibilities, but their common feature is that they both run JavaScript code. Add to this the fact, that we're able to create JavaScript&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;and we're onto something.</p><h2>Use cases</h2><ul><li><a class=\"reference-link\" href=\"#root/_help_TjLYAo3JMO8X\">\"New Task\" launcher button</a></li></ul><h2>Action handler</h2><p>Saving the note to the database is backend's responsibility, so we immediately pass control to the backend and ask it to create a note. Once this is done, we show the newly created note so that the user can set the task title and maybe some attributes.</p><h2>Script execution</h2><p>So we have a script which will add the button to the toolbar. But how can we execute it? One possibility is to click on the <span class=\"tn-icon bx bx-play\"></span> <em>Execute script</em> button. The problem with this is that this UI change is time bound by Trilium runtime so when we restart Trilium, button won't be there.</p><p>We need to execute it every time Trilium starts up, but we probably don't want to have to manually click on play button on every start up.</p><p>The solution is to give the note the <a href=\"#root/_help_zEY4DaJG4YT5\">label</a> <code>#run=frontendStartup</code> - this is one of the \"system\" labels which Trilium understands. As you might guess, this will cause all such labeled script notes to be executed once Trilium frontend starts up.</p><p>(<code>#run=frontendStartup</code> does not work for <a href=\"#root/_help_RDslemsQ6gCp\">Mobile frontend</a> - if you want to have scripts running there, give the script <code>#run=mobileStartup</code> label).</p><h3>Execute button</h3><p>Runnable code notes (frontend or backend) and saved SQL consoles can optionally have a dedicated <span class=\"tn-icon bx bx-play\"></span> execute button alongside a description.</p><p>To do so, apply the following <a href=\"#root/_help_HI6GBBIduIgv\">labels</a>:</p><ul><li>A <code>#executeButton</code> with the value of the label being displayed as the label of the button.</li><li>An optional <code>#executeDescription</code> which adds explanatory text beside it.</li></ul><h2>Autocomplete &amp; linting</h2><p>Starting with Trilium v0.104.0, frontend scripts, backend scripts and render notes benefit from an autocomplete system.</p><p>The autocomplete triggers automatically when typing <kbd>.</kbd> or manually by pressing <kbd>Ctrl</kbd>+<kbd>Space</kbd>.</p><p>In addition to that, the editor will also display syntax errors and warnings such as unreachable code.</p><aside class=\"admonition note\"><p>If you notice a false positive in regards with the errors/warnings reported or an incorrect or missing API, feel free to <a href=\"#root/_help_wy8So3yZZlH9\">open a issue</a> with a code sample.</p></aside><h2>More showcases</h2><p>You can see more scripting with explanation in&nbsp;<a class=\"reference-link\" href=\"#root/_help_5668rwcirq1t\">Advanced Showcases</a>.</p><h2>Events</h2><p>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_GPERMystNGTB\">Events</a>.</p><h2>Script API</h2><p>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_GLks18SNjxmC\">Script API</a>.</p>",
++ "_help_yIhgI5H7A2Sm": "<p>Front-end scripts are custom JavaScript notes that are run on the client (browser environment)</p><p>There are four flavors of front-end scripts:</p><figure class=\"table\"><table><tbody><tr><td>Regular scripts</td><td>These are run with the current app and note context. These can be run either manually or automatically on start-up.</td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a></td><td>These can introduce new UI elements in various positions, such as near the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>, content area or even the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>.</td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_4Gn3psZKsfSm\">Launch Bar Widgets</a></td><td>Similar to&nbsp;<a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>, but dedicated to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>. These can simply introduce new buttons or graphical elements to the bar.</td></tr><tr><td><a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a></td><td>This allows rendering custom content inside a note, using either HTML or Preact JSX.</td></tr></tbody></table></figure><p>For more advanced behaviors that do not require a user interface (e.g. batch modifying notes), see&nbsp;<a class=\"reference-link\" href=\"#root/_help_SPirpZypehBG\">Backend scripts</a>.</p><h2>Scripts</h2><p>Scripts don't have any special requirements. They can be run manually using the <em>Execute</em> button on the code note or they can be run automatically, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_irkwjdNtjcxR\">Frontend Events</a>.</p><h2>Widgets</h2><p>Widgets require a certain format in order for Trilium to be able to integrate them into the UI.</p><ul><li>For legacy widgets, the script note must export a <code>BasicWidget</code> or a derived one (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_GhurYZjh8e1V\">Note context aware widget</a>&nbsp;or&nbsp;<a class=\"reference-link\" href=\"#root/_help_M8IppdwVHSjG\">Right pane widget</a>).</li><li>For Preact widgets, a built-in helper called <code>defineWidget</code> needs to be used.</li></ul><p>For more information, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>.</p><h2>Script API</h2><p>The front-end API of Trilium is available to all scripts running in the front-end context as global variable <code>api</code>. For a reference of the API, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_Q2z6av6JZVWm\">Frontend API</a>.</p><h3>Tutorial</h3><p>For more information on building widgets, take a look at <a href=\"#root/_help_SynTBQiBsdYJ\">Widget Basics</a>.</p>",
++ "_help_MgibgPcfeuGz": "<p>Custom widgets are a special subset of scripts that render graphical elements in certain parts of the application. These can be used to add new functionality to the Trilium application.</p><h2>Preact with JSX vs. vanilla jQuery</h2><p>In older versions of Trilium, custom widgets were exclusively written in a combination of jQuery with Trilium's internal widget architecture (e.g., <code>BasicWidget</code>, <code>NoteContextAwareWidget</code>).</p><p>Starting with v0.101.0, custom widgets can also be written in JSX using the&nbsp;<a class=\"reference-link\" href=\"#root/_help_KLsqhjaqh1QW\">Preact</a>&nbsp;framework. Both legacy and Preact widgets have the same capabilities, with a single difference:</p><ul><li>Preact widgets are content-sized by default whereas legacy widgets need <code>this.contentSized()</code> applied in the constructor. For more information, see the corresponding section in&nbsp;<a class=\"reference-link\" href=\"#root/_help_gMkgcLJ6jBkg\">Troubleshooting</a>.</li></ul><p>Wherever possible, widget examples will be both in the legacy and Preact format.</p><h2>Creating a custom widget</h2><p>The quickest way is <em>Insert child note</em> → <em>Code</em> → <em>Widget</em> in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_YtSN43OrfzaA\">Note tree contextual menu</a>. It creates a JSX note with the <code>#widget</code> label and a minimal Preact widget to start from.</p><p>To set one up by hand instead:</p><ol><li>Create a&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note.</li><li>Set the language to:<ol><li>JavaScript (frontend) for legacy widgets using jQuery.</li><li>JSX for Preact widgets. You might need to go to Options → Code to enable the language first.</li></ol></li><li>Apply the <code>#widget</code> <a href=\"#root/_help_HI6GBBIduIgv\">label</a>.</li></ol><h2>Getting started with a simple example</h2><p>Let's start by creating a widget that shows a message near the content area. Follow the previous section to create a code note, and use the following content.</p><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-react\"></span>&nbsp;Preact</p><div class=\"trilium-tab-panel\"><pre><code class=\"language-text-x-trilium-auto\">import { defineWidget } from \"trilium:preact\";\n\nexport default defineWidget({\n parent: \"center-pane\",\n render: () =&gt; &lt;span&gt;Center pane from Preact.&lt;/span&gt;\n});</code></pre></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-javascript\"></span>&nbsp;Legacy</p><div class=\"trilium-tab-panel\"><pre><code class=\"language-text-x-trilium-auto\">class HelloCenterPane extends api.BasicWidget {\n\n constructor() {\n super();\n this.contentSized();\n }\n\n get parentWidget() { return \"center-pane\" }\n\n doRender() {\n this.$widget = $(\"&lt;span&gt;Center pane&lt;/span&gt;\");\n }\n \n}\n\nmodule.exports = new HelloCenterPane();</code></pre></div></section></div><p><a href=\"#root/_help_s8alTXmpFR61\">Refresh the application</a> and the widget should appear underneath the content area.</p><h2>Widget location (parent widget)</h2><p>A widget can be placed in one of the following sections of the applications:</p><figure class=\"table\"><table class=\"ck-table-resized\"><colgroup><col style=\"width:15.59%;\"><col style=\"width:30.42%;\"><col style=\"width:16.68%;\"><col style=\"width:37.31%;\"></colgroup><thead><tr><th>Value for <code>parentWidget</code></th><th>Description</th><th>Sample widget</th><th>Special requirements</th></tr></thead><tbody><tr><th><code>left-pane</code></th><td>Appears within the same pane that holds the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>.</td><td>Same as above, with only a different <code>parentWidget</code>.</td><td>None.</td></tr><tr><th><code>center-pane</code></th><td>In the content area. If a split is open, the widget will span all of the splits.</td><td>See example above.</td><td>None.</td></tr><tr><th><code>note-detail-pane</code></th><td><p>In the content area, inside the note detail area. If a split is open, the widget will be contained inside the split.</p><p>This is ideal if the widget is note-specific.</p></td><td><a class=\"reference-link\" href=\"#root/_help_GhurYZjh8e1V\">Note context aware widget</a></td><td><ul><li>The widget must export a <code>class</code> and not an instance of the class (e.g. <code>no new</code>) because it needs to be multiplied for each note, so that splits work correctly.</li><li>Since the <code>class</code> is exported instead of an instance, the <code>parentWidget</code> getter must be <code>static</code>, otherwise the widget is ignored.</li></ul></td></tr><tr><th><code>right-pane</code></th><td>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RnaPdbciOfeq\">Right Sidebar</a>, as a dedicated section.</td><td><a class=\"reference-link\" href=\"#root/_help_M8IppdwVHSjG\">Right pane widget</a></td><td><ul><li>Although not mandatory, it's best to use a <code>RightPanelWidget</code> instead of a <code>BasicWidget</code> or a <code>NoteContextAwareWidget</code>.</li></ul></td></tr></tbody></table></figure><p>To position the widget somewhere else, just change the value passed to <code>get parentWidget()</code> for legacy widgets or the <code>parent</code> field for Preact. Do note that some positions such as <code>note-detail-pane</code> and <code>right-pane</code> have special requirements that need to be accounted for (see the table above).</p><h2>Multiple widgets in a single note</h2><p>A widget note usually returns one widget, but it can also return an array of them. This is useful when several widgets share code or state, since they can all live in the same note instead of being split across notes that need a shared module.</p><p>Each widget of the array is registered on its own, so they can have different parents and positions. A widget that is missing its <code>parentWidget</code> (or <code>parent</code> for Preact) is reported as an error without affecting the other widgets of the note.</p><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-react\"></span>&nbsp;Preact</p><div class=\"trilium-tab-panel\"><pre><code class=\"language-text-x-trilium-auto\">import { defineWidget } from \"trilium:preact\";\n\nexport default [\n defineWidget({\n parent: \"left-pane\",\n render: () =&gt; &lt;span&gt;Left pane from Preact.&lt;/span&gt;\n }),\n defineWidget({\n parent: \"right-pane\",\n render: () =&gt; &lt;span&gt;Right pane from Preact.&lt;/span&gt;\n })\n];</code></pre></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-javascript\"></span>&nbsp;Legacy</p><div class=\"trilium-tab-panel\"><pre><code class=\"language-text-x-trilium-auto\">class TreeWidget extends api.BasicWidget {\n get parentWidget() { return \"left-pane\"; }\n doRender() { this.$widget = $(\"&lt;span&gt;Left pane&lt;/span&gt;\"); }\n}\n\nclass SidebarWidget extends api.BasicWidget {\n get parentWidget() { return \"right-pane\"; }\n doRender() { this.$widget = $(\"&lt;span&gt;Right pane&lt;/span&gt;\"); }\n}\n\nmodule.exports = [ new TreeWidget(), new SidebarWidget() ];</code></pre></div></section></div><h2>Launch bar widgets</h2><p>Launch bar widgets are similar to <em>Custom widgets</em> but are specific to the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_4Gn3psZKsfSm\">Launch Bar Widgets</a>&nbsp;for more information.</p><h2>Custom position</h2><p>The position of a custom widget is defined via a <code>position</code> integer.</p><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-react\"></span>&nbsp;Preact</p><div class=\"trilium-tab-panel\"><pre><code class=\"language-text-x-trilium-auto\">export default defineWidget({\n // [...]\n position: 10\n});</code></pre></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-javascript\"></span>&nbsp;Legacy</p><div class=\"trilium-tab-panel\"><pre><code class=\"language-text-x-trilium-auto\">class MyWidget extends api.BasicWidget {\n\t// [..\n\tget position() { return 10; }\n}</code></pre></div></section></div>",
++ "_help_SynTBQiBsdYJ": "<p>This guide will walk you through creating a basic widget inside Trilium. By following these steps, you'll learn how to build a simple UI element that interacts with the user.</p><h3>Step 1: The Basic Widget Structure</h3><p>To start, we'll create the most basic widget possible. Here's a simple example:</p><pre><code class=\"language-text-x-trilium-auto\">class MyWidget extends api.BasicWidget {\n get position() { return 1; }\n get parentWidget() { return \"left-pane\"; }\n \n doRender() {\n this.$widget = $(\"&lt;div id='my-widget'&gt;\");\n return this.$widget;\n }\n}\n\nmodule.exports = new MyWidget();</code></pre><p>To implement this widget:</p><ol><li>Create a new <code>JS Frontend</code> note in Trilium and paste in the code above.</li><li>Assign the <code>#widget</code> <a href=\"#root/_help_zEY4DaJG4YT5\">attribute</a> to the <a href=\"#root/_help_BFs8mudNFgCS\">note</a>.</li><li>Restart Trilium or reload the window.</li></ol><p>To verify that the widget is working, open the developer tools (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>I</kbd>) and run <code>document.querySelector(\"#my-widget\")</code>. If the element is found, the widget is functioning correctly. If <code>undefined</code> is returned, double-check that the <a href=\"#root/_help_BFs8mudNFgCS\">note</a> has the <code>#widget</code> <a href=\"#root/_help_zEY4DaJG4YT5\">attribute</a>.</p><h3>Step 2: Adding an UI Element</h3><p>Next, let's improve the widget by adding a button to it.</p><pre><code class=\"language-text-x-trilium-auto\">const template = `&lt;div id=\"my-widget\"&gt;&lt;button&gt;Click Me!&lt;/button&gt;&lt;/div&gt;`;\n\nclass MyWidget extends api.BasicWidget {\n get position() {return 1;}\n get parentWidget() {return \"left-pane\"}\n\n doRender() {\n this.$widget = $(template);\n return this.$widget;\n }\n}\n\nmodule.exports = new MyWidget();</code></pre><p>After making this change, reload Trilium. You should now see a button in the top-left corner of the left pane.</p><h3>Step 3: Styling the Widget</h3><p>To make the button more visually appealing and position it correctly, we'll apply some custom styling. Trilium includes <a href=\"https://boxicons.com\">Box Icons</a>, which we'll use to replace the button text with an icon. For example the <span class=\"tn-icon bx bxs-magic-wand\"></span> <code>bx bxs-magic-wand</code> icon.</p><p>Here's the updated template:</p><pre><code class=\"language-text-x-trilium-auto\">const template = `&lt;div id=\"my-widget\"&gt;&lt;button class=\"tree-floating-button bx bxs-magic-wand tree-settings-button\"&gt;&lt;/button&gt;&lt;/div&gt;`;</code></pre><p>Next, we'll adjust the button's position using CSS:</p><pre><code class=\"language-text-x-trilium-auto\">class MyWidget extends api.BasicWidget {\n get position() { return 1; }\n get parentWidget() { return \"left-pane\"; }\n \n doRender() {\n this.$widget = $(template);\n this.cssBlock(`#my-widget {\n position: absolute;\n bottom: 40px;\n left: 60px;\n z-index: 1;\n }`);\n return this.$widget;\n }\n}\n\nmodule.exports = new MyWidget();</code></pre><p>After reloading Trilium, the button should now appear at the bottom left of the left pane, alongside other action buttons.</p><h3>Step 4: Adding User Interaction</h3><p>Let’s make the button interactive by showing a message when it’s clicked. We'll use the <code>api.showMessage</code> method from the <a href=\"#root/_help_GLks18SNjxmC\">Script API</a>.</p><pre><code class=\"language-text-x-trilium-auto\">class MyWidget extends api.BasicWidget {\n get position() { return 1; }\n get parentWidget() { return \"left-pane\"; }\n \n doRender() {\n this.$widget = $(template);\n this.cssBlock(`#my-widget {\n position: absolute;\n bottom: 40px;\n left: 60px;\n z-index: 1;\n }`);\n this.$widget.find(\"button\").on(\"click\", () =&gt; api.showMessage(\"Hello World!\"));\n return this.$widget;\n }\n}\n\nmodule.exports = new MyWidget();</code></pre><p>For the list of possible values for <code>parentWidget()</code>, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>.&nbsp;</p><p><a href=\"#root/_help_s8alTXmpFR61\">Reload</a> the application one last time. When you click the button, a \"Hello World!\" message should appear, confirming that your widget is fully functional.</p>",
++ "_help_GhurYZjh8e1V": "<p>Note context-aware widgets are a different type of widget which automatically react to changes in the current note.</p><p>Important aspects:</p><ul><li>The widget must export a <code>class</code> and not an instance of the class (e.g. <code>no new</code>) because it needs to be multiplied for each note, so that splits work correctly.</li><li>Since the <code>class</code> is exported instead of an instance, the <code>parentWidget</code> getter must be <code>static</code>, otherwise the widget is ignored.</li></ul><h2>Example displaying the current note title</h2><p>This is a note context-aware widget that simply displays the name the current note.&nbsp;</p><h3>Classic example</h3><pre><code class=\"language-text-x-trilium-auto\">class HelloNoteDetail extends api.NoteContextAwareWidget {\n\n constructor() {\n super();\n this.contentSized();\n }\n\n doRender() {\n this.$widget = $(\"&lt;div&gt;\");\n }\n\n async refreshWithNote(note) {\n this.$widget.text(\"Current note: \" + note.title);\n }\n \n static get parentWidget() { return \"note-detail-pane\" } \n get position() { return 10 }\n \n}\n\nmodule.exports = HelloNoteDetail;</code></pre><h3>Preact (v0.101.0+)</h3><pre><code class=\"language-text-x-trilium-auto\">import { defineWidget, useNoteContext, useNoteProperty } from \"trilium:preact\";\n\nexport default defineWidget({ \n parent: \"note-detail-pane\",\n position: 10,\n render: () =&gt; {\n const { note } = useNoteContext();\n const title = useNoteProperty(note, \"title\");\n return &lt;span&gt;Current note JSX: {title}&lt;/span&gt;;\n }\n});</code></pre>",
++ "_help_M8IppdwVHSjG": "<h3>Title widget</h3><p>This is an example of a context-aware widget which displays the title of the current note:</p><pre><code class=\"language-text-x-trilium-auto\">class NoteTitleWidget extends api.RightPanelWidget {\n \n get widgetTitle() { return \"Note title\"; }\n get parentWidget() { return \"right-pane\" }\n\n doRenderBody() {\n this.$body.empty();\n if (this.note) {\n this.$body.append($(\"&lt;div&gt;\").text(this.note.title));\n }\n } \n \n async refreshWithNote() {\n \tthis.doRenderBody();\n }\n}\n\nmodule.exports = new NoteTitleWidget();</code></pre><h3>Clock</h3><p>A simple widget which will show the current time, as an example on how to dynamically change the content of the widget periodically.</p><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-react\"></span>&nbsp;Preact</p><div class=\"trilium-tab-panel\"><pre><code class=\"language-text-x-trilium-auto\">import { defineWidget, RightPanelWidget, useEffect, useState } from \"trilium:preact\";\n\nexport default defineWidget({\n parent: \"right-pane\", \n position: 1,\n render() {\n const [ time, setTime ] = useState();\n useEffect(() =&gt; {\n const interval = setInterval(() =&gt; {\n setTime(new Date().toLocaleString());\n }, 1000);\n return () =&gt; clearInterval(interval);\n }); \n return (\n &lt;RightPanelWidget id=\"clock-jsx\" title=\"Clock (JSX)\"&gt;\n &lt;p&gt;The time is: {time}&lt;/p&gt;\n &lt;/RightPanelWidget&gt;\n );\n }\n});</code></pre></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-javascript\"></span>&nbsp;Legacy</p><div class=\"trilium-tab-panel\"><pre><code class=\"language-text-x-trilium-auto\">const template = `&lt;div&gt;&lt;/div&gt;`;\n\nclass ToDoListWidget extends api.RightPanelWidget {\n \n get widgetTitle() { return \"Clock\"; } \n get parentWidget() { return \"right-pane\" }\n \n async doRenderBody() {\n if (!this.timer) {\n this.timer = setInterval(() =&gt; {\n this.$body.empty().append(`The time is: &lt;span&gt;${new Date().toLocaleString()}&lt;/span&gt;`); \n }, 1000); \n }\n\n this.$body.empty().append(`The time is: &lt;span&gt;${new Date().toLocaleString()}&lt;/span&gt;`);\n } \n}\n\nmodule.exports = new ToDoListWidget();</code></pre></div></section></div><h2>Altering the position within the sidebar</h2><p>By default, the sidebar items are displayed in the order they are found by the application when searching for <code>#widget</code> notes.</p><p>It is possible to make a widget appear higher or lower up, by adjusting its <code>position</code> property:</p><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-react\"></span>&nbsp;Preact</p><div class=\"trilium-tab-panel\"><pre><code class=\"language-text-javascript\">import { defineWidget, RightPanelWidget, useEffect, useState } from \"trilium:preact\";\n\nexport default defineWidget({\n\t/* [...] */\n position: 20,\n render() {\n\t\t/* [...] */\n }\n});</code></pre></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-javascript\"></span>&nbsp;Legacy</p><div class=\"trilium-tab-panel\"><pre><code class=\"language-text-javascript\">class MyWidget extends api.RightPanelWidget {\n\n get position() { return 20 };\n \n}</code></pre></div></section></div><p>Generally the default position starts from 10 and increases by 10 with each item, including the default Table of Contents and Highlights list.</p><h2>Key highlights for legacy widgets</h2><ul><li><code>doRender</code> must not be overridden, instead <code>doRenderBody()</code> has to be overridden.<ul><li><code>doRenderBody</code> can optionally be <code>async</code>.</li></ul></li><li><code>parentWidget()</code> must be set to <code>“rightPane”</code>.</li><li><code>widgetTitle()</code> getter can optionally be overriden, otherwise the widget will be displayed as “Untitled widget”.</li></ul>",
++ "_help_YNxAqkI5Kg1M": "<aside class=\"admonition tip\"><p>This widget is also present in new installations in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_6tZeKvSHEUiB\">Demo Notes</a>.</p></aside><p>Create a&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note of type JavaScript (Trilium frontend) and <strong>give it a</strong> <code>#widget</code> <strong>label</strong>.</p><pre><code class=\"language-text-x-trilium-auto\">/*\n * This defines a custom widget which displays number of words and characters in a current text note.\n * To be activated for a given note, add label 'wordCount' to the note, you can also make it inheritable and thus activate it for the whole subtree.\n * \n * See it in action in \"Books\" and its subtree.\n */\nconst TPL = `&lt;div style=\"padding: 10px; border-top: 1px solid var(--main-border-color); contain: none;\"&gt;\n &lt;strong&gt;Word count: &lt;/strong&gt;\n &lt;span class=\"word-count\"&gt;&lt;/span&gt;\n\n &amp;nbsp;\n\n &lt;strong&gt;Character count: &lt;/strong&gt;\n &lt;span class=\"character-count\"&gt;&lt;/span&gt;\n&lt;/div`;\n\nclass WordCountWidget extends api.NoteContextAwareWidget {\n get position() { return 100; } // higher value means position towards the bottom/right\n \n get parentWidget() { return 'center-pane'; }\n \n doRender() {\n this.$widget = $(TPL);\n this.$wordCount = this.$widget.find('.word-count');\n this.$characterCount = this.$widget.find('.character-count');\n return this.$widget;\n }\n \n async refreshWithNote(note) {\n if (note.type !== 'text' || !note.hasLabel('wordCount')) { \n // show widget only on text notes and when marked with 'wordCount' label\n this.toggleInt(false); // hide\n \n return;\n }\n \n this.toggleInt(true); // display\n \n const {content} = await note.getNoteComplement();\n \n const text = $(content).text(); // get plain text only\n \n const counts = this.getCounts(text);\n\n this.$wordCount.text(counts.words);\n this.$characterCount.text(counts.characters);\n }\n \n getCounts(text) {\n const chunks = text\n .split(/[\\s-+:,/\\\\]+/)\n .filter(chunk =&gt; chunk !== '');\n \n let words;\n \n if (chunks.length === 1 &amp;&amp; chunks[0] === '') {\n words = 0;\n }\n else {\n words = chunks.length;\n }\n \n const characters = chunks.join('').length;\n \n return {words, characters};\n }\n \n async entitiesReloadedEvent({loadResults}) {\n if (loadResults.isNoteContentReloaded(this.noteId)) {\n this.refresh();\n }\n }\n}\n\nmodule.exports = new WordCountWidget();</code></pre><p>After you make changes it is necessary to <a href=\"#root/_help_s8alTXmpFR61\">restart Trilium</a> so that the layout can be rebuilt.</p><p>The widget only activates on text notes that have the <code>#wordCount</code> label. This label can be a <a href=\"#root/_help_hrZ1D00cLbal\">reference link</a> to enable the widget for an entire subtree.</p><p>At the bottom of the note you can see the resulting widget:</p><figure class=\"image\"><img style=\"aspect-ratio:792/603;\" src=\"{{helpAssets}}/User%20Guide/Scripting/Frontend%20Basics/Custom%20Widgets/Word%20count%20widget_image.png\" width=\"792\" height=\"603\"></figure>",
++ "_help_VqGQnnPGnqAU": "<h2>Classic widgets</h2><p>In <code>doRender()</code>:<sup><a href=\"#fn1saoftmefpp\">[1]</a></sup></p><pre><code class=\"language-text-x-trilium-auto\">this.cssBlock(`#my-widget {\n\tposition: absolute;\n bottom: 40px;\n left: 60px;\n z-index: 1;\n}`);</code></pre><h2>Preact widgets</h2><p>See the dedicated page:&nbsp;<a class=\"reference-link\" href=\"#root/_help_Sg9GrCtyftZf\">CSS</a>.</p><ol><li><p><sup><strong><a href=\"#fnref1saoftmefpp\">^</a></strong></sup></p><p>Reference: <a href=\"https://trilium.rocks/X7pxYpiu0lgU\">https://trilium.rocks/X7pxYpiu0lgU</a></p></li></ol>",
++ "_help_gMkgcLJ6jBkg": "<h2>Why is my widget clipped by other UI elements</h2><p>For performance and layout reasons, the size of widgets in Trilium is independent from its children. At CSS level, this means that the widget container has <code>contain: size</code> applied to it.</p><p>This works well if the widget has a fixed size (or based on its parent container), however to make a widget resize to fit its content, apply the following change:</p><pre><code class=\"language-text-x-diff\">class MyWidget extends api.RightPanelWidget {\n\n+ constructor() {\n+ super();\n+ this.contentSized();\n+ }\n \n}</code></pre><p>Alternatively apply <code>contain: none</code> to its CSS.</p>",
++ "_help_TjLYAo3JMO8X": "<aside class=\"admonition warning\"><p>This documentation is outdated, as it refers to using the deprecated <code>addButtonToToolbar</code> API which will only create widgets for desktop.</p><p>Instead, a custom launcher widget can be created using the&nbsp;<a class=\"reference-link\" href=\"#root/_help_4Gn3psZKsfSm\">Launch Bar Widgets</a>&nbsp;documentation.</p></aside><p>In this example we are going to extend the functionality of&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYjQUYhpbUEW\">Task Manager</a>&nbsp;showcase (which comes by default with Trilium) by adding a button in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>&nbsp; (<span class=\"tn-icon bx bx-task\"></span>) to create a new task automatically and open it.</p><h2>Creating the note</h2><ol><li>First, create a new&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note type with the <em>JavaScript (Trilium frontend)</em> language.</li><li>Define the <code>#run=frontendStartup</code> label in&nbsp;<a class=\"reference-link\" href=\"#root/_help_zEY4DaJG4YT5\">Attributes</a>.</li></ol><h2>Content of the script</h2><p>Copy-paste the following script:</p><pre><code class=\"language-text-javascript\">api.addButtonToToolbar({\n\ttitle: \"New task\",\n icon: \"task\",\n shortcut: \"alt+n\",\n action: async () =&gt; {\n \tconst taskNoteId = await api.runOnBackend(() =&gt; {\n \tconst todoRootNote = api.getNoteWithLabel(\"taskTodoRoot\");\n const resp = api.createTextNote(todoRootNote.noteId, \"New task\", \"\") \n return resp.note.noteId;\n });\n \n await api.waitUntilSynced();\n await api.activateNewNote(taskNoteId);\n }\n});</code></pre><h2>Testing the functionality</h2><p>Since we set the script to be run on start-up, all we need to do is to <a href=\"#root/_help_s8alTXmpFR61\">refresh the application</a>.</p><h2>Understanding how the script works</h2><figure class=\"table\"><table class=\"ck-table-resized\"><colgroup><col style=\"width:50%;\"><col style=\"width:50%;\"></colgroup><tbody><tr><td><pre><code class=\"language-text-x-trilium-auto\">api.addButtonToToolbar({\n\ttitle: \"New task\",\n icon: \"task\",\n shortcut: \"alt+n\",\n action: async () =&gt; {\n \t// [...]\n }\n});</code></pre></td><td><p>This uses the <a href=\"#root/_help_yIhgI5H7A2Sm\">Front-end API</a> to create a icon in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>, by specifying:</p><ul><li>A title</li><li>A corresponding boxicons icon (without the <code>bx-</code> prefix).</li><li>Optionally, a keyboard shortcut to assign to it.</li><li>The action, which will be executed when the button is pressed.</li></ul></td></tr><tr><td><pre><code class=\"language-text-x-trilium-auto\">const taskNoteId = await api.runOnBackend(() =&gt; {\n // Shown below. \n return resp.note.noteId;\n});</code></pre></td><td><ul><li>This portion of code is actually executed on the server (backend) and not on the client (i.e. browser).<ul><li>The reason is that the creating notes is the responsibility of the server.</li></ul></li><li>Here we can also see that it is possible to return results from the server execution and read them in the client (<code>taskNoteId</code>).</li></ul></td></tr><tr><td><pre><code class=\"language-text-x-trilium-auto\">const todoRootNote = api.getNoteWithLabel(\"taskTodoRoot\");</code></pre></td><td><ul><li>Here we identify a note with the <a href=\"#root/_help_zEY4DaJG4YT5\">label</a> <code>#taskTodoRoot</code>. This is how the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYjQUYhpbUEW\">Task Manager</a>&nbsp;showcase knows where to place all the different tasks.</li><li>Normally this might return a <code>null</code> value if no such note could be identified, but error handling is outside the scope of this example.&nbsp;</li></ul></td></tr><tr><td><pre><code class=\"language-text-x-trilium-auto\">const resp = api.createTextNote(todoRootNote.noteId, \"New task\", \"\")</code></pre></td><td><ul><li>We create a new child note within the to-do root note (first argument) with the title “New task\" (second argument) and no content by default (third argument).</li></ul></td></tr><tr><td><pre><code class=\"language-text-x-trilium-auto\">await api.waitUntilSynced();</code></pre></td><td><ul><li>Back on the client, since we created a new note on the server, we now need to wait for the change to be reflected in the client.</li></ul></td></tr><tr><td><pre><code class=\"language-text-x-trilium-auto\">await api.activateNewNote(taskNoteId);</code></pre></td><td><ul><li>Since we know the <a href=\"#root/_help_m1lbrzyKDaRB\">ID</a> of the newly created note, all we have to do now is to show this note to the user.</li></ul></td></tr></tbody></table></figure>",
++ "_help_7kZPMD0uFwkH": "<p>This tutorial showcases a basic integration with Google Forms, where we are able to download the responses of a form using the “Link to Sheets\" functionality.</p><p>Note that the link will be publicly accessible to everyone (however the link is in a hard-to-guess format such as <code>https://docs.google.com/spreadsheets/d/e/2PACX-1vTA8NU2_eZFhc8TFadCZPreBfvP7un8IHd6J0SchrLLw3ueGmntNZjwRmsH2ZRcp1pJYDAzMz1FmFaj/pub?output=csv</code>). Make sure you are not accidentally publishing sensitive information.</p><h2>Obtaining the CSV link</h2><ol><li>Open the Google Forms in a browser.</li><li>Select the “Responses” tab and click on “Link to Sheets”.</li><li>Select “Create a new spreadsheet” and press “Create”.</li><li>In Google Sheets, select File → Share → Publish to web.</li><li>In the “Publish to the web” screen, make sure the “Link” tab is selected and instead of “Web page”, select “Comma-separated values (.csv)”.</li><li>Copy the given link which will be used for the upcoming script.</li></ol><h2>Creating the script</h2><p>Create a “JS Frontend” script:</p><pre><code class=\"language-text-x-trilium-auto\">const CSV_URL = \"https://docs.google.com/spreadsheets/d/e/2PACX-1vTiwooLV2whjCSVa49dJ99p_G3_qhqHHRqttMjYCJVfLXVdTgUSNJu5K0rpqmaHYF2k7Vofi3o7gW82/pub?output=csv\";\n\nasync function fetchData() {\n try {\n const response = await fetch(CSV_URL);\n return await response.text();\n } catch (e) {\n api.showError(e.message);\n }\n}\n\nconst data = await fetchData();\nconsole.log(data);\n// Do something with the data.</code></pre><p>Note that the data will be received as a string and there is no library to do the CSV parsing for us. To do a very simple parsing of CSV:</p><pre><code class=\"language-text-x-trilium-auto\">const content = data\n\t.split(\"\\n\")\n\t.slice(1)\n\t.map((row) =&gt; row.split(\",\"));</code></pre><p>This will return the data as an array of arrays.</p>",
++ "_help_DL92EjAaXT26": "<p>A good use case of promoted attributes is to easily define the various parameters a script might need, for example an input and output note if it's processing data, or a checkbox to define a particular change in behavior for the script.</p><p><img src=\"{{helpAssets}}/User%20Guide/Scripting/Frontend%20Basics/Examples/Using%20promoted%20attributes%20to%20configure%20scripts_image.png\"></p><h2>Using check boxes to toggle flags</h2><p>Instead of asking the user to modify a boolean value in the script, it's much more intuitive to use a checkbox for it as a promoted attribute.</p><p>To do so, first define the promoted attribute:</p><pre><code class=\"language-text-x-trilium-auto\">#label:groupByExtension=\"promoted,alias=Group by extension,single,boolean\"</code></pre><p>Then use it:</p><pre><code class=\"language-text-javascript\">const byExtension = api.currentNote.getLabelValue(\"groupByExtension\") === \"true\";\nif (byExtension) {\n\t// Do something.\n}</code></pre><p>This will work equally well in both front-end and back-end scripts.</p><h2>Using relations to select notes</h2><p>One common use case for a script is to read data from another note and perhaps output its result in another note. To do so we need to define the following promoted attributes:</p><pre><code class=\"language-text-x-trilium-auto\">#relation:input=\"promoted,alias=Input,single\" #relation:output=\"promoted,alias=Output,single\"</code></pre><p>Once we have this, we can add some basic error handling to ensure that the fields are completed by the user:</p><pre><code class=\"language-text-javascript\">const inputNoteId = api.currentNote.getRelationValue(\"input\");\nif (!inputNoteId) {\n\tapi.showError(\"Missing input.\");\n return;\n}\n\nconst outputNoteId = api.currentNote.getRelationValue(\"output\");\nif (!outputNoteId) {\n api.showError(\"Missing output.\");\n return;\n}</code></pre><p>Note that here we are using <code>api.showError</code> which is only available for frontend notes. If you are writing a backend note, simply remove <code>api.showError</code> but the user will no feedback on why the script did not execute properly.</p><p>Afterwards we can simply read the note and do something with it:</p><pre><code class=\"language-text-javascript\">const note = api.getNote(inputNoteId);\nif (!note) {\n\treturn;\n}\nconst content = note.getContent().toString(\"utf-8\");</code></pre>",
++ "_help_4Gn3psZKsfSm": "<p>Launch bar widgets are a subset of&nbsp;<a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>&nbsp;that can be used to render custom buttons and widgets inside the&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>.</p><h2>Creating a launch bar widget for the desktop layout</h2><p>Unlike&nbsp;<a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>, the process of setting up a launch bar widget is slightly different:</p><ol><li>Create a Code note of type <em>JavaScript (front-end)</em> or JSX (for Preact-based widgets).<ul><li>The script itself uses the same concepts as&nbsp;<a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>, including the use of a <code>NoteContextAwareWidget</code> or a <code>BasicWidget</code> (according to needs).</li><li>As examples in both legacy and Preact format, see&nbsp;<a class=\"reference-link\" href=\"#root/_help_IPArqVfDQ4We\">Note Title Widget</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_gcI7RPbaNSh3\">Analog Watch</a>.</li></ul></li><li>Don't set <code>#widget</code>, as that attribute is reserved for&nbsp;<a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>.</li><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>, select <em>Configure launchbar</em>.</li><li>In the <em>Visible Launchers</em> section, select <em>Add a custom widget</em>.</li><li>Give the newly created launcher a name (and optionally a name).</li><li>In the&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>&nbsp;section, modify the <em>widget</em> field to point to the newly created note.</li><li><a href=\"#root/_help_s8alTXmpFR61\">Refresh</a> the UI.</li></ol><h2>Mobile layout</h2><p>Custom launch bar widgets are also supported on the&nbsp;<a class=\"reference-link\" href=\"#root/_help_RDslemsQ6gCp\">Mobile Frontend</a>. To do so:</p><ol><li>Go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>&nbsp;→ <em>Advanced</em> → <em>Show Hidden Subtree</em>.</li><li>Look for <em>Mobile Launch Bar</em> and follow the same creation mechanism as in the previous section.</li></ol>",
++ "_help_IPArqVfDQ4We": "<figure class=\"image\"><img style=\"aspect-ratio:1007/94;\" src=\"{{helpAssets}}/User%20Guide/Scripting/Frontend%20Basics/Launch%20Bar%20Widgets/Note%20Title%20Widget_image.png\" width=\"1007\" height=\"94\"></figure><p>This is an example of a note context-aware widget, which reacts to the currently opened note and refreshes automatically as the user navigates through the notes.</p><p>In this example, the title of the note is displayed. It works best on the <a href=\"#root/_help_x0JgW8UqGXvq\">horizontal layout</a>.</p><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-react\"></span>&nbsp;Preact</p><div class=\"trilium-tab-panel\"><pre><code class=\"language-text-x-trilium-auto\">import { defineLauncherWidget, useActiveNoteContext } from \"trilium:preact\";\n\nexport default defineLauncherWidget({\n render: () =&gt; {\n const { note } = useActiveNoteContext();\n return &lt;div style={{\n display: \"flex\",\n height: \"53px\",\n width: \"fit-content\",\n fontSize: \"0.75em\",\n alignItems: \"center\",\n flexShrink: 0 \n }}&gt;{note?.title}&lt;/div&gt;;\n }\n});</code></pre></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-javascript\"></span>&nbsp;Legacy</p><div class=\"trilium-tab-panel\"><pre><code class=\"language-text-javascript\">const TPL = `\\\n&lt;div style=\"\n display: flex;\n height: 53px;\n width: fit-content;\n font-size: 0.75em;\n contain: none;\n align-items: center;\n flex-shrink: 0;\n padding: 0 1em;\n\"&gt;&lt;/div&gt;`;\n\nclass NoteTitleWidget extends api.NoteContextAwareWidget {\n doRender() {\n this.$widget = $(TPL);\n }\n\n async refreshWithNote(note) {\n this.$widget.text(note.title);\n }\n}\n\nmodule.exports = new NoteTitleWidget();</code></pre></div></section></div>",
+ "_help_gcI7RPbaNSh3": "<figure class=\"image\"><img style=\"aspect-ratio:1007/94;\" src=\"{{helpAssets}}/User%20Guide/Scripting/Frontend%20Basics/Launch%20Bar%20Widgets/Analog%20Watch_image.png\" width=\"1007\" height=\"94\"></figure><p>This is a more intricate example of a basic widget, which displays an analog watch in the launch bar. Unlike note-context aware widgets, basic widgets don't react to note navigation.</p><pre><code class=\"language-text-javascript\">const TPL = `\n&lt;div class=\"analog-watch\" style=\"\n position: relative;\n height: 38px;\n width: 38px;\n border-radius: 50%;\n background: white;\n border: 2px solid #444;\n flex-shrink: 0;\n\"&gt;\n &lt;!-- hour hand --&gt;\n &lt;div class=\"hand hour\" style=\"\n position: absolute;\n left: 50%;\n top: 50%;\n width: 3px;\n height: 10px;\n background: #333;\n transform-origin: bottom center;\n \"&gt;&lt;/div&gt;\n\n &lt;!-- minute hand --&gt;\n &lt;div class=\"hand minute\" style=\"\n position: absolute;\n left: 50%;\n top: 50%;\n width: 2px;\n height: 13px;\n background: #111;\n transform-origin: bottom center;\n \"&gt;&lt;/div&gt;\n\n &lt;!-- second hand --&gt;\n &lt;div class=\"hand second\" style=\"\n position: absolute;\n left: 50%;\n top: 50%;\n width: 1px;\n height: 15px;\n background: red;\n transform-origin: bottom center;\n \"&gt;&lt;/div&gt;\n&lt;/div&gt;\n`;\n\nclass AnalogWatchWidget extends api.BasicWidget {\n doRender() { \n this.$widget = $(TPL);\n\n const hourHand = this.$widget.find('.hand.hour')[0];\n const minuteHand = this.$widget.find('.hand.minute')[0];\n const secondHand = this.$widget.find('.hand.second')[0];\n\n const update = () =&gt; {\n const now = new Date();\n const sec = now.getSeconds();\n const min = now.getMinutes();\n const hour = now.getHours();\n\n const secDeg = sec * 6;\n const minDeg = min * 6 + sec * 0.1;\n const hourDeg = (hour % 12) * 30 + min * 0.5;\n\n secondHand.style.transform = `translate(-50%, -100%) rotate(${secDeg}deg)`;\n minuteHand.style.transform = `translate(-50%, -100%) rotate(${minDeg}deg)`;\n hourHand.style.transform = `translate(-50%, -100%) rotate(${hourDeg}deg)`;\n };\n\n update();\n this._interval = setInterval(update, 1000);\n }\n\n cleanup() {\n if (this._interval) clearInterval(this._interval);\n }\n}\n\nmodule.exports = new AnalogWatchWidget();</code></pre>",
- "_help_KLsqhjaqh1QW": "<p>Since v0.101.0, Trilium integrates Preact for front-end scripting, including support for JSX.</p><p>Preact can be used for:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>, where a JSX code note is used instead of a HTML one.</li><li><a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>, where JSX can be used to replace the old, jQuery-based mechanism.</li></ul><p>To get started, the first step is to enable JSX in the list of Code languages. Go to Options → Code Notes and check the “JSX” language. Afterwards, proceed with the documentation in either&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>&nbsp;or&nbsp;<a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>, which will both have a section on how to use the new Preact integration.</p><aside class=\"admonition important\"><p>The documentation assumes prior knowledge with React or Preact. As a starting point, consider the <a href=\"https://www.freecodecamp.org/learn/front-end-development-libraries-v9/\">FreeCodeCamp course on Front End Development Libraries</a> or the <a href=\"https://preactjs.com/tutorial/\">Preact Tutorial</a>.</p></aside><h2>Import/exports</h2><p>When using Preact with JSX, there is a special syntax which provides ES-like imports. This <code spellcheck=\"false\">import</code> syntax makes way for a more intuitive that doesn't make use of global objects and paves the way for better auto-completion support that might be introduced in the future.&nbsp;</p><h3>API imports</h3><p>Instead of:</p><pre><code class=\"language-text-jsx\">api.showMessage(\"Hello\");</code></pre><p>the JSX version looks like this:</p><pre><code class=\"language-text-jsx\">import { showMessage } from \"trilium:api\";\nshowMessage(\"hello\");</code></pre><h3>Preact API imports (hooks, components)</h3><p>There's a new&nbsp;<a class=\"reference-link\" href=\"#root/_help_GLks18SNjxmC\">Script API</a>&nbsp;dedicated to Preact, which provides shared components that are also used by Trilium internally as well as hooks, for example.</p><pre><code class=\"language-text-jsx\">import { useState } from \"trilium:preact\";\nconst [ myState, setMyState ] = useState(\"Hi\");</code></pre><h3>Exporting</h3><p>JSX notes can export a component for use in&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>&nbsp;or for&nbsp;<a class=\"reference-link\" href=\"#root/_help_Bqde6BvPo05g\">Component libraries</a>: </p><pre><code class=\"language-text-jsx\">export default function() {\n return (\n &lt;&gt;\n &lt;p&gt;Hello world.&lt;/p&gt;\n &lt;/&gt;\n );\n}</code></pre><h3>Import/export are not required</h3><p>These imports are syntactic sugar meant to replace the usage for the <code spellcheck=\"false\">api</code> global object (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_GLks18SNjxmC\">Script API</a>).&nbsp;</p><aside class=\"admonition note\"><p>The <code spellcheck=\"false\">import</code> and <code spellcheck=\"false\">export</code> syntax work only for JSX notes. Standard/jQuery code notes still need to use the <code spellcheck=\"false\">api</code> global and <code spellcheck=\"false\">module.exports</code>.</p></aside><h2>Under the hood</h2><p>Unlike JavaScript, JSX requires pre-processing to turn it into JavaScript (just like TypeScript). To do so, Trilium uses <a href=\"https://github.com/alangpierce/sucrase\">Sucrase</a>, a JavaScript library which processes the JSX to pure JavaScript. The processing is done each time a script is run (for widgets this happens at every program startup). If you notice any performance degradation due to long compilation, consider <a href=\"#root/_help_wy8So3yZZlH9\">reporting the issue</a> to us.</p>",
- "_help_Bqde6BvPo05g": "<p>Using the concept of&nbsp;<a class=\"reference-link\" href=\"#root/_help_hA834UaHhSNn\">Script bundles</a>, it's possible to create components that are shared for multiple widgets or&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>.</p><h2>Exporting a single component</h2><p>This is generally useful for big components.</p><p>Here's an example child hierarchy using&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>: </p><ul><li><em>My render note</em><br>Note type: Render Note<br>Link <code spellcheck=\"false\">~renderNote</code> to the child note (<em>Render note with subcomponents</em>)<ul><li><p><em>Render note with subcomponents</em><br>Type: JSX</p><pre><code class=\"language-text-jsx\">export default function() {\n return (\n &lt;MyComponent /&gt; \n );\n}</code></pre><ul><li><p><em>MyComponent</em><br>Type: Code / JSX</p><pre><code class=\"language-text-jsx\">export default function MyComponent() {\n return &lt;p&gt;Hi&lt;/p&gt;;\n}</code></pre></li></ul></li></ul></li></ul><h2>Multiple components per note</h2><p>To export multiple components, use the <code spellcheck=\"false\">export</code> keyword next to each of the function components.</p><p>Here's how a sub-note called <code spellcheck=\"false\">MyComponents</code> would look like:</p><pre><code class=\"language-text-jsx\">export function MyFirstComponent() {\n return &lt;p&gt;First&lt;/p&gt;;\n}\n\nexport function MySecondComponent() {\n return &lt;p&gt;Bar&lt;/p&gt;;\n}</code></pre><p>Then in its parent note:</p><pre><code class=\"language-text-jsx\">const { MyFirstComponent, MySecondComponent } = MyComponents;\n\nexport default function() {\n return (\n &lt;&gt;\n &lt;MyFirstComponent /&gt;\n &lt;MySecondComponent /&gt;\n &lt;/&gt;\n );\n}</code></pre><p>Alternatively, it's also possible to use the components directly without assigning them to a <code spellcheck=\"false\">const</code> first:</p><pre><code class=\"language-text-jsx\">&lt;MyComponents.MyFirstComponent /&gt;\n&lt;MyComponents.MySecondComponent /&gt;</code></pre>",
- "_help_ykYtbM9k3a7B": "<h2>Standard Preact hooks</h2><p>All standard Preact hooks are available as an import in <code spellcheck=\"false\">trilium:api</code>.</p><p>For example:</p><pre><code class=\"language-text-jsx\">import { useState } from \"trilium:preact\";\nconst [ myState, setMyState ] = useState(\"Hi\");</code></pre><h2>Custom hooks</h2><p>Trilium comes with a large set of custom hooks for Preact, all of which are also available to custom widgets and&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>.</p><h3><code spellcheck=\"false\">useNoteContext</code></h3><p>As a replacement to&nbsp;<a class=\"reference-link\" href=\"#root/_help_GhurYZjh8e1V\">Note context aware widget</a>, Preact exposes the current note context in the <code spellcheck=\"false\">useNoteContext</code> hook:</p><pre><code class=\"language-text-jsx\">import { defineWidget, useNoteContext, useNoteProperty } from \"trilium:preact\";\n\nexport default defineWidget({ \n parent: \"note-detail-pane\",\n position: 10,\n render: () =&gt; {\n const { note } = useNoteContext();\n const title = useNoteProperty(note, \"title\");\n return &lt;span&gt;Current note JSX: {title}&lt;/span&gt;;\n }\n});</code></pre><p>Note that the custom widget must be inside the content area (so note detail widget) for this to work properly, especially when dealing with splits.</p><h3><code spellcheck=\"false\">useActiveNoteContext</code></h3><p><code spellcheck=\"false\">useActiveNoteContext</code> is an alternative to <code spellcheck=\"false\">useNoteContext</code> which works even if the widget is not within the note detail section and it automatically switches the note context as the user is navigating around between tabs and splits.</p><h3><code spellcheck=\"false\">useNoteProperty</code></h3><p>This hook allows “listening” for changes to a particular property of a <code spellcheck=\"false\">FNote</code>, such as the <code spellcheck=\"false\">title</code> or <code spellcheck=\"false\">type</code> of a note. The benefit from using the hook is that it actually reacts to changes, for example if the note title or type is changed.</p>",
- "_help_Sg9GrCtyftZf": "<h2>Inline styles</h2><pre><code class=\"language-text-jsx\">&lt;div style={{\n display: \"flex\",\n height: \"53px\",\n width: \"fit-content\",\n fontSize: \"0.75em\",\n alignItems: \"center\",\n flexShrink: 0 \n}}&gt;/* [...] */&lt;/div&gt;</code></pre><h2>Custom CSS file</h2><p>Simply create a&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlhDUqhENtH7\">Custom app-wide CSS</a>. Make sure the class names are unique enough to not intersect with other UI elements, consider adding a prefix (e.g. <code spellcheck=\"false\">x-mywidget-</code>).</p>",
- "_help_RSssb9S3xgSr": "<figure class=\"image image_resized\" style=\"width:54.58%;\"><img style=\"aspect-ratio:896/712;\" src=\"{{helpAssets}}/User%20Guide/Scripting/Frontend%20Basics/Preact/Built-in%20components_image.png\" width=\"896\" height=\"712\"><figcaption>A partial screenshot from the Widget showcase example (see below).</figcaption></figure><p>Trilium comes with its own set of Preact components, some of which are also available to&nbsp;<a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>.</p><p>To use these components, simply import them from <code spellcheck=\"false\">trilium:preact</code>:</p><pre><code class=\"language-text-jsx\">import { ActionButton, Button, LinkButton } from \"trilium:preact\";</code></pre><p>and then use them:</p><pre><code class=\"language-text-jsx\">export default function MyRenderNote() {\n const onClick = () =&gt; showMessage(\"A button was pressed\");\n \n return (\n &lt;&gt;\n &lt;h2&gt;Buttons&lt;/h2&gt;\n &lt;div style={{ display: \"flex\", gap: \"1em\", alignItems: \"center\" }}&gt;\n &lt;ActionButton icon=\"bx bx-rocket\" text=\"Action button\" onClick={onClick} /&gt;\n &lt;Button icon=\"bx bx-rocket\" text=\"Simple button\" onClick={onClick} /&gt;\n &lt;LinkButton text=\"Link button\" onClick={onClick} /&gt; \n &lt;/div&gt;\n &lt;/&gt;\n )\n}</code></pre><h2>Widget showcase</h2><aside class=\"admonition tip\"><p>Starting with v0.101.0, the widget showcase is also available in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_6tZeKvSHEUiB\">Demo Notes</a>.</p></aside><p>This is a&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>&nbsp;example with JSX that shows most of the built-in components that are accessible to custom widgets and JSX render notes.</p><p>To use it, simply:</p><ol><li>Create a render note.</li><li>Create a child code note of JSX type with the content of this file:&nbsp;<a class=\"reference-link\" href=\"#root/_help_i9B4IW7b6V6z\">Widget showcase</a></li><li>Set the <code spellcheck=\"false\">~renderNote</code> relation of the parent note to the child note.</li><li>Refresh the render note to see the results.</li></ol>",
- "_help_i9B4IW7b6V6z": "import {\r\n ActionButton, Button, LinkButton,\r\n Admonition, Collapsible,\r\n FormCheckbox, FormDropdownList, FormFileUploadButton, FormGroup, FormRadioGroup, FormTextArea,\r\n FormTextBox, FormToggle, Slider, RawHtml, LoadingSpinner, Icon,\r\n ColorPicker,\r\n Dropdown, FormListItem, FormDropdownDivider, FormDropdownSubmenu,\r\n NoteAutocomplete, NoteLink, Modal,\r\n Table,\r\n CKEditor,\r\n useEffect, useState\r\n} from \"trilium:preact\";\r\nimport { showMessage } from \"trilium:api\";\r\n\r\nexport default function() {\r\n const [ time, setTime ] = useState();\r\n const lorem = \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam accumsan eu odio non gravida. Pellentesque ornare, arcu condimentum molestie dignissim, nibh turpis ultrices elit, eget elementum nunc erat at erat. Maecenas vehicula consectetur elit, nec fermentum elit venenatis eu.\";\r\n useEffect(() => {\r\n const interval = setInterval(() => setTime(new Date().toLocaleString()), 1000);\r\n return () => clearInterval(interval);\r\n }, []);\r\n\r\n return (\r\n <div style={{ padding: 20, display: \"flex\", flexDirection: \"column\", gap: \"1em\" }}>\r\n <h1>Widget showcase</h1>\r\n\r\n <Buttons />\r\n <Admonition type=\"note\">\r\n <strong>Admonition</strong><br />\r\n {lorem}\r\n </Admonition>\r\n\r\n <Collapsible title=\"Collapsible\" initiallyExpanded>\r\n {lorem}\r\n </Collapsible>\r\n\r\n <FormElements />\r\n <NoteElements />\r\n <ModalSample />\r\n <DropdownSample />\r\n <CollectionViews />\r\n </div>\r\n );\r\n}\r\n\r\nfunction Buttons() {\r\n const onClick = () => showMessage(\"A button was pressed\");\r\n\r\n return (\r\n <>\r\n <h2>Buttons</h2>\r\n <div style={{ display: \"flex\", gap: \"1em\", alignItems: \"center\" }}>\r\n <ActionButton icon=\"bx bx-rocket\" text=\"Action button\" onClick={onClick} />\r\n <Button icon=\"bx bx-rocket\" text=\"Simple button\" onClick={onClick} />\r\n <LinkButton text=\"Link button\" onClick={onClick} />\r\n </div>\r\n </>\r\n )\r\n}\r\n\r\nfunction FormElements() {\r\n const [ checkboxChecked, setCheckboxChecked ] = useState(false);\r\n const [ dropdownValue, setDropdownValue ] = useState(\"key-1\");\r\n const [ radioGroupValue, setRadioGroupValue ] = useState(\"key-1\");\r\n const [ sliderValue, setSliderValue ] = useState(50);\r\n const [ color, setColor ] = useState(\"#43a047\");\r\n\r\n return (\r\n <>\r\n <h2>Form elements</h2>\r\n <div style={{ display: \"grid\", gridTemplateColumns: \"1fr 1fr 1fr\", gap: \"1em\" }}>\r\n <FormGroup name=\"checkbox\" label=\"Checkbox\">\r\n <FormCheckbox label=\"Checkbox\" currentValue={checkboxChecked} onChange={setCheckboxChecked} />\r\n </FormGroup>\r\n <FormGroup name=\"toggle\" label=\"Toggle\">\r\n <FormToggle switchOnName=\"Off\" switchOffName=\"On\" currentValue={checkboxChecked} onChange={setCheckboxChecked} />\r\n </FormGroup>\r\n <FormGroup name=\"dropdown\" label=\"Dropdown\">\r\n <FormDropdownList\r\n values={[\r\n { key: \"key-1\", name: \"First item\" },\r\n { key: \"key-2\", name: \"Second item\" },\r\n { key: \"key-3\", name: \"Third item\" },\r\n ]}\r\n currentValue={dropdownValue} onChange={setDropdownValue}\r\n keyProperty=\"key\" titleProperty=\"name\"\r\n />\r\n </FormGroup>\r\n <FormGroup name=\"radio-group\" label=\"Radio group\">\r\n <FormRadioGroup\r\n values={[\r\n { value: \"key-1\", label: \"First item\" },\r\n { value: \"key-2\", label: \"Second item\" },\r\n { value: \"key-3\", label: \"Third item\" },\r\n ]}\r\n currentValue={radioGroupValue} onChange={setRadioGroupValue}\r\n />\r\n </FormGroup>\r\n <FormGroup name=\"text-box\" label=\"Text box\">\r\n <FormTextBox\r\n placeholder=\"Type something...\"\r\n currentValue=\"\" onChange={(newValue) => {}}\r\n />\r\n </FormGroup>\r\n <FormGroup name=\"text-area\" label=\"Text area\">\r\n <FormTextArea\r\n placeholder=\"Type something bigger...\"\r\n currentValue=\"\" onChange={(newValue) => {}}\r\n />\r\n </FormGroup>\r\n <FormGroup name=\"color-picker\" label=\"Color picker\">\r\n <ColorPicker currentValue={color} onChange={setColor} />\r\n </FormGroup>\r\n <FormGroup name=\"slider\" label=\"Slider\">\r\n <Slider\r\n min={1} max={100}\r\n value={sliderValue} onChange={setSliderValue}\r\n />\r\n </FormGroup>\r\n <FormGroup name=\"file-upload\" label=\"File upload\">\r\n <FormFileUploadButton\r\n text=\"Upload\"\r\n onChange={(files) => {\r\n const file = files?.[0];\r\n if (!file) return;\r\n showMessage(`Got file \"${file.name}\" of size ${file.size} B and type ${file.type}.`);\r\n }}\r\n />\r\n </FormGroup>\r\n <FormGroup name=\"icon\" label=\"Icon\">\r\n <Icon icon=\"bx bx-smile\" />\r\n </FormGroup>\r\n <FormGroup name=\"loading-spinner\" label=\"Loading spinner\">\r\n <LoadingSpinner />\r\n </FormGroup>\r\n <FormGroup name=\"raw-html\" label=\"Raw HTML\">\r\n <RawHtml html=\"<strong>Hi</strong> <em>there</em>\" />\r\n </FormGroup>\r\n </div>\r\n </>\r\n )\r\n}\r\n\r\nfunction NoteElements() {\r\n const [ noteId, setNoteId ] = useState(\"\");\r\n\r\n return (\r\n <div>\r\n <h2>Note elements</h2>\r\n\r\n <FormGroup name=\"note-autocomplete\" label=\"Note autocomplete\">\r\n <NoteAutocomplete\r\n placeholder=\"Select a note\"\r\n noteId={noteId} noteIdChanged={setNoteId}\r\n />\r\n </FormGroup>\r\n\r\n <FormGroup name=\"note-link\" label=\"Note link\">\r\n {noteId\r\n ? <NoteLink notePath={noteId} showNoteIcon />\r\n : <span>Select a note first</span>}\r\n </FormGroup>\r\n </div>\r\n );\r\n}\r\n\r\nfunction ModalSample() {\r\n const [ shown, setShown ] = useState(false);\r\n\r\n return (\r\n <>\r\n <h2>Modal</h2>\r\n <Button text=\"Open modal\" onClick={() => setShown(true)} />\r\n <Modal title=\"Modal title\" size=\"md\" show={shown} onHidden={() => setShown(false)}>\r\n Modal goes here.\r\n </Modal>\r\n </>\r\n )\r\n}\r\n\r\nfunction DropdownSample() {\r\n return (\r\n <>\r\n <h2>Dropdown menu</h2>\r\n <Dropdown text=\"Dropdown\" hideToggleArrow>\r\n <FormListItem icon=\"bx bx-cut\">Cut</FormListItem>\r\n <FormListItem icon=\"bx bx-copy\">Copy</FormListItem>\r\n <FormListItem icon=\"bx bx-paste\">Paste</FormListItem>\r\n <FormDropdownDivider />\r\n <FormDropdownSubmenu title=\"Submenu\">\r\n <FormListItem>More items</FormListItem>\r\n </FormDropdownSubmenu>\r\n </Dropdown>\r\n </>\r\n )\r\n}\r\n\r\nfunction CollectionViews() {\r\n return (\r\n <>\r\n <h2>Collection views</h2>\r\n <p>\r\n A generic <code>Table</code> (Tabulator) is available. A <code>Calendar</code>\r\n {\" \"}(FullCalendar) component is also exposed, but it requires you to pass a\r\n {\" \"}<code>plugins</code> array to render a view, so it is not demonstrated here.\r\n </p>\r\n <Table\r\n layout=\"fitColumns\"\r\n columns={[\r\n { title: \"Name\", field: \"name\" },\r\n { title: \"Progress\", field: \"progress\" }\r\n ]}\r\n data={[\r\n { id: 1, name: \"First task\", progress: \"80%\" },\r\n { id: 2, name: \"Second task\", progress: \"20%\" }\r\n ]}\r\n />\r\n </>\r\n )\r\n}\r\n",
- "_help_SPirpZypehBG": "<p>Unlike <a href=\"#root/_help_yIhgI5H7A2Sm\">front-end scripts</a> which run on the client / browser-side, back-end scripts run directly on the Node.js environment of the Trilium server.</p><p>Back-end scripts can be used both on a&nbsp;<a class=\"reference-link\" href=\"#root/_help_WOcw2SLH6tbX\">Server Installation</a>&nbsp;(where it will run on the device the server is running on), or on the&nbsp;<a class=\"reference-link\" href=\"#root/_help_poXkQfguuA0U\">Desktop Installation</a>&nbsp;(where it will run on the PC).</p><aside class=\"admonition important\"><p>Starting with v0.104.0, backend scripts are disabled by default to reduce the attack surface. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_fiHicjpHjIRJ\">Security</a>&nbsp;for more information.</p></aside><h2>Advantages of backend scripts</h2><p>The benefit of backend scripts is that they can be pretty powerful, for example to have access to the underlying system, for example it can read files or execute processes.</p><p>However, the main benefit of backend scripts is that they have easier access to the notes since the information about them is already loaded in memory. Whereas on the client, notes have to be manually loaded first.</p><h2>Creating a backend script</h2><p>Create a new&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note and select the language <em>JavaScript (Trilium backend)</em>.</p><h2>Running backend scripts</h2><p>Backend scripts can be either run manually (via the Execute button on the script page), or they can be triggered on certain events.</p><p>In addition, scripts can be run automatically when the server starts up, on a fixed time interval or when a certain event occurs (such as an attribute being modified). For more information, see the dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_GPERMystNGTB\">Events</a>&nbsp;page.</p><h2>Script API</h2><p>Trilium exposes a set of APIs that can be directly consumed by scripts, under the <code spellcheck=\"false\">api</code> object. For a reference of this API, see&nbsp;<a class=\"reference-link\" href=\"{{helpAssets}}/User%20Guide/Scripting/Script%20API/Backend%20API.dat\">Backend API</a>.</p>",
- "_help_fZ2IGYFXjkEy": "<p>Older versions of Trilium Notes allowed the use of Common.js module imports inside backend scripts, such as:</p><pre><code class=\"language-text-x-trilium-auto\">const isBetween = require('dayjs/plugin/isBetween')\napi.dayjs.extend(isBetween)</code></pre><p>For newer versions, Node.js imports are <strong>not officially supported anymore</strong>, since we've added a bundler which makes it more difficult to reuse dependencies.</p><p>Theoretically it's still possible to use imports by manually setting up a <code spellcheck=\"false\">node_modules</code> in the server directory via <code spellcheck=\"false\">npm</code> or <code spellcheck=\"false\">pnpm</code>.</p>",
- "_help_GPERMystNGTB": "<p><a href=\"#root/_help_CdNpE2pqjmI6\">Script</a> notes can be triggered by events. Note that these are backend events and thus relation need to point to the \"JavaScript (Trilium backend)\" code note.</p><h2>Global events</h2><p>Global events are attached to the script note via label. Simply create e.g. \"run\" label with some of these values and script note will be executed once the event occurs.</p><table>\n <thead>\n <tr>\n <th>Label</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td><code spellcheck=\"false\">run</code></td>\n <td><p>Defines on which events script should run. Possible values are:</p><ul><li><code spellcheck=\"false\">backendStartup</code> - when Trilium backend starts up</li><li><code spellcheck=\"false\">hourly</code> - run once an hour. You can use additional label <code spellcheck=\"false\">runAtHour</code> to specify at which hour, on the back-end.</li><li><code spellcheck=\"false\">daily</code> - run once a day, on the back-end</li></ul></td>\n </tr>\n <tr>\n <td><code spellcheck=\"false\">runOnInstance</code></td>\n <td>Specifies that the script should only run on a particular&nbsp;<a class=\"reference-link\" href=\"#root/_help_c5xB8m4g2IY6\">Trilium instance</a>.</td>\n </tr>\n <tr>\n <td><code spellcheck=\"false\">runAtHour</code></td>\n <td>On which hour should this run. Should be used together with <code spellcheck=\"false\">#run=hourly</code>. Can be defined multiple times for more runs during the day.</td>\n </tr>\n </tbody>\n</table><h2>Entity events</h2><p>Other events are bound to some entity, these are defined as <a href=\"#root/_help_zEY4DaJG4YT5\">relations</a> - meaning that script is triggered only if note has this script attached to it through relations (or it can inherit it).</p><figure class=\"table\"><table>\n<thead>\n<tr>\n<th>Relation</th>\n<th>Trigger condition</th>\n<th>Origin entity (see below)</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code spellcheck=\"false\">runOnNoteCreation</code></td>\n<td>executes when note is created on backend. Use this relation if you want to run the script for all notes created under a specific subtree. In that case, create it on the subtree root note and make it inheritable. A new note created within the subtree (any depth) will trigger the script.</td>\n<td>The <code spellcheck=\"false\">BNote</code> that got created.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">runOnChildNoteCreation</code></td>\n<td>executes when new note is created under the note where this relation is defined</td>\n<td>The <code spellcheck=\"false\">BNote</code> of the child that got created.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">runOnNoteTitleChange</code></td>\n<td>executes when note title is changed (includes note creation as well)</td>\n<td>The <code spellcheck=\"false\">BNote</code> of the note whose title got changed.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">runOnNoteContentChange</code></td>\n<td>executes when note content is changed (includes note creation as well).</td>\n<td>The <code spellcheck=\"false\">BNote</code> of the note whose content got changed.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">runOnNoteChange</code></td>\n<td>executes when note is changed (includes note creation as well). Does not include content changes</td>\n<td>The <code spellcheck=\"false\">BNote</code> of the note that got changed.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">runOnNoteDeletion</code></td>\n<td>executes when note is being deleted</td>\n<td>The <code spellcheck=\"false\">BNote</code> of the note that got (soft) deleted.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">runOnBranchCreation</code></td>\n<td>executes when a branch is created. Branch is a link between parent note and child note and is created e.g. when cloning or moving note.</td>\n<td>The <code spellcheck=\"false\">BBranch</code> that got created.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">runOnBranchChange</code></td>\n<td>executes when a branch is updated. (since v0.62)</td>\n<td>The <code spellcheck=\"false\">BBranch</code> that got changed.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">runOnBranchDeletion</code></td>\n<td>executes when a branch is deleted. Branch is a link between parent note and child note and is deleted e.g. when moving note (old branch/link is deleted).</td>\n<td>The <code spellcheck=\"false\">BBranch</code> that got (soft) deleted.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">runOnAttributeCreation</code></td>\n<td>executes when new attribute is created for the note which defines this relation</td>\n<td>The <code spellcheck=\"false\">BAttribute</code> that got created.</td>\n</tr>\n<tr>\n<td><code spellcheck=\"false\">runOnAttributeChange</code></td>\n<td>executes when the attribute is changed of a note which defines this relation. This is triggered also when the attribute is deleted</td>\n<td>The <code spellcheck=\"false\">BAttribute</code> that got changed.</td>\n</tr>\n</tbody></table></figure><h2>Origin entity</h2><p>When a script is run by an event such as the ones described above, <code spellcheck=\"false\">api.originEntity</code> will get populated with the note, branch or attribute that triggered the change.</p><p>For example, here's a script with <code spellcheck=\"false\">~runOnAttributeChange</code> which automatically changes the color of a note based on the value of the <code spellcheck=\"false\">mycategory</code> label:</p><pre><code class=\"language-text-javascript\">const attr = api.originEntity;\nif (attr.name !== \"mycategory\") return;\nconst note = api.getNote(attr.noteId);\nif (attr.value === \"Health\") {\n note.setLabel(\"color\", \"green\");\n} else {\n note.removeLabel(\"color\");\n}</code></pre>",
- "_help_hA834UaHhSNn": "<p>For both&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>&nbsp;and more complicated scripts, it's generally useful to split the code into multiple&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;notes.</p><p>When a script is run, the sub-children of the script being run (or the&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>) are checked for children. If the children are Code notes of the corresponding type (front-end or backend) as the code being run, they will be evaluated as well.</p><p>The collection of a script and its child notes is called a <em>bundle</em>. A child note inside a bundle is called a <em>module</em>.</p><p>As a basic example of dependencies, consider the following note structure:</p><ul><li><p><em>Script with dependency</em></p><pre><code class=\"language-text-javascript\">api.log(MyMath.sum(2, 2));</code></pre><ul><li><p><em>MyMath</em></p><pre><code class=\"language-text-javascript\">module.exports = {\n sum(a, b) {\n return a + b;\n }\n};</code></pre></li></ul></li></ul><p>When <em>Script with dependency</em> is run, it will detect <em>MyMath</em> as a submodule and provide the result of its <code spellcheck=\"false\">module.exports</code> object into a global object with the same name as the note.</p><aside class=\"admonition note\"><p>If the note contains spaces or special characters, they will be stripped. For example <code spellcheck=\"false\">My Nice Note!</code> becomes <code spellcheck=\"false\">MyNiceNote</code>.</p></aside><h2>Alternative syntax</h2><p>Instead of providing an object to <code spellcheck=\"false\">module.exports</code>, it's also possible to add fields individually:</p><pre><code class=\"language-text-javascript\">module.exports.sum = (a, b) =&gt; a + b;\nmodule.exports.subtract = (a, b) =&gt; a - b;</code></pre><h2>Ignoring a code script from a bundle</h2><p>To ignore a script from being included in a bundle (e.g. if it's unrelated to the parent script note), apply the <code spellcheck=\"false\">#disableInclusion</code> label.</p><h2>Sharing a module across multiple bundles</h2><p>Modules can be reused across multiple scripts by simply cloning the shared module between two modules (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_IakOLONlIfGI\">Cloning Notes</a>).</p><p>Optionally, a separate note can be used to contain all the different reusable modules for an easy way to discover them.</p>",
- "_help_GLks18SNjxmC": "<p>For <a href=\"#root/_help_CdNpE2pqjmI6\">script code notes</a>, Trilium offers an API that gives them access to various features of the application.</p><p>There are two APIs:</p><ul><li>One for the front-end scripts:&nbsp;<a class=\"reference-link\" href=\"#root/_help_Q2z6av6JZVWm\">Frontend API</a></li><li>One for the back-end scripts:&nbsp;<a class=\"reference-link\" href=\"{{helpAssets}}/User%20Guide/Scripting/Script%20API/Backend%20API.dat\">Backend API</a></li></ul><p>In both cases, the API resides in a global variable, <code spellcheck=\"false\">api</code>, that can be used anywhere in the script.</p><p>For example, to display a message to the user the following front-end script can be used:</p><pre><code class=\"language-text-x-trilium-auto\">api.showMessage(\"Hello world.\");</code></pre><aside class=\"admonition note\"><p><strong>Note</strong><br>The Script API is currently experimental and may undergo changes in future updates.</p></aside>",
- "_help_ApVHZ8JY5ofC": "<p>Day.js is a date manipulation library that's used by Trilium, but it's also shared with both front-end and back-end scripts. For more information about the library itself, consult the <a href=\"https://day.js.org/en/\">official documentation</a>.</p><h2>How to use</h2><p>The <code spellcheck=\"false\">dayjs</code> method is provided directly in the <code spellcheck=\"false\">api</code> global:</p><pre><code class=\"language-text-javascript\">const date = api.dayjs();\napi.log(date.format(\"YYYY-MM-DD\"));</code></pre><h2>Plugins</h2><p>Day.js uses a modular, plugin-based architecture. Generally these plugins must be imported, but this process doesn't work inside Trilium scripts due to the use of a bundler.</p><p>Since v0.100.0, the same set of plugins is available for both front-end and back-end scripts.</p><p>The following Day.js plugins are directly integrated into Trilium:</p><ul><li><a href=\"https://day.js.org/docs/en/plugin/advanced-format\">AdvancedFormat</a></li><li><a href=\"https://day.js.org/docs/en/plugin/duration\">Duration</a>, since v0.100.0.</li><li><a href=\"https://day.js.org/docs/en/plugin/is-between\">IsBetween</a></li><li><a href=\"https://day.js.org/docs/en/plugin/iso-week\">IsoWeek</a></li><li><a href=\"https://day.js.org/docs/en/plugin/is-same-or-after\">IsSameOrAfter</a></li><li><a href=\"https://day.js.org/docs/en/plugin/is-same-or-before\">IsSameOrBefore</a></li><li><a href=\"https://day.js.org/docs/en/plugin/quarter-of-year\">QuarterOfYear</a></li><li><a href=\"https://day.js.org/docs/en/plugin/utc\">UTC</a></li></ul><aside class=\"admonition note\"><p>If another Day.js plugin might be needed for scripting purposes, feel free to open a feature request for it. Depending on the size of the plugin and the potential use of it inside the Trilium code base, it has a chance of being integrated.</p></aside>",
- "_help_vElnKeDNPSVl": "<p>Both front-end and back-end notes can log messages for debugging.</p><h2>UI logging via <code spellcheck=\"false\">api.log</code></h2><figure class=\"image image_resized image-style-align-center\" style=\"width:57.74%;\"><img style=\"aspect-ratio:749/545;\" src=\"{{helpAssets}}/User%20Guide/Scripting/Logging_image.png\" width=\"749\" height=\"545\"></figure><p>The API log feature integrates with the script editor and it displays all the messages logged via <code spellcheck=\"false\">api.log</code>. This works for both back-end and front-end scripts.</p><p>The API log panel will appear after executing a script that uses <code spellcheck=\"false\">api.log</code> and it can be dismissed temporarily by pressing the close button in the top-right of the panel.</p><p>Apart from strings, an object can be passed as well in which case it will be pretty-formatted if possible (e.g. recursive objects are not supported).</p><h2>Console logging</h2><p>For logs that are not directly visible to the user, the standard <code spellcheck=\"false\">console.log</code> can be used as well.</p><ul><li>For front-end scripts, the log will be shown in the Developer Tools (also known as Inspect).</li><li>For back-end scripts, the log will be shown in the server output while running but <strong>will not</strong> be visible in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_bnyigUA2UK7s\">Backend (server) logs</a>.</li></ul>",
- "_help_YeOa2l7Pu39I": "<h2>Introduction</h2><p>Before v0.104.0, code executed at renderer level (e.g. front-end scripts) could directly require <code spellcheck=\"false\">@electron/remote</code> or even Node.js APIs (e.g. <code spellcheck=\"false\">process</code> or <code spellcheck=\"false\">fs</code>). While this makes them powerful, it also exposes a significant attack surface — any XSS or untrusted script in a note becomes remote code execution on the host.</p><p>To mitigate this, the client-side no longer has access to these APIs and everything must go through the&nbsp;<a class=\"reference-link\" href=\"{{helpAssets}}/User%20Guide/Scripting/Script%20API/Electron%20API.dat\">Electron API</a>&nbsp;instead.</p><aside class=\"admonition note\"><p>If this API change is causing issues with some of your front-end scripts, consider:</p><ul><li>Interacting with&nbsp;<a class=\"reference-link\" href=\"#root/_help_SPirpZypehBG\">Backend scripts</a>&nbsp;which have a greater degree of freedom.</li><li><a href=\"#root/_help_wy8So3yZZlH9\">Reporting</a> it as a feature request.</li></ul></aside><h2>Overview of the API</h2><p>The Frontend and Backend APIs reside in a global variable, <code spellcheck=\"false\">api</code>, that can be used anywhere in the script. For example, to display a message to the user the following front-end script can be used:</p><pre><code class=\"language-text-javascript\">api.showMessage(\"Hello world.\");</code></pre><p>The Electron API is different: it lives on <code spellcheck=\"false\">window.electronApi</code> (exposed by the desktop preload script), not on <code spellcheck=\"false\">api</code>, and is only available in the Electron desktop build. Frontend scripts that use it should guard with <code spellcheck=\"false\">if (window.electronApi)</code> so they degrade cleanly in the browser and standalone (WASM) builds.</p><pre><code class=\"language-text-javascript\">window.electronApi?.window.setZoomFactor(1.2);</code></pre><h2>Additional protection</h2><p>Some of the APIs have additional safe-guards built in which prevent unauthorized access.</p><p>The <code spellcheck=\"false\">shell</code> group is the most heavily validated: <code spellcheck=\"false\">openExternal</code> is restricted to an allowlisted set of URL schemes (blocking <code spellcheck=\"false\">file:</code>, <code spellcheck=\"false\">smb:</code>, Follina-class schemes, etc.), <code spellcheck=\"false\">openPath</code> must resolve under the Trilium data directory or temporary directory, and <code spellcheck=\"false\">downloadURL</code> is locked to the app's own origin. Invalid input throws on the main side rather than being silently passed through.</p>",
- "_help_fqAK6opjUagR": "<p>The <code spellcheck=\"false\">api.axios</code> library has been removed from the backend scripting API.</p><p>Scripts that attempt to use <code spellcheck=\"false\">api.axios</code> will now throw an error with migration instructions.</p><h2>Reasoning</h2><p>Axios was marked as deprecated at least since April 2024 in favor of the native <code spellcheck=\"false\">fetch()</code> API, which is available in both browser and Node.js environments. After two years of deprecation, the library was removed following the <a href=\"https://www.malwarebytes.com/blog/news/2026/03/axios-supply-chain-attack-chops-away-at-npm-trust\">March 2026 npm supply chain compromise</a>, where attackers published malicious versions that deployed a remote access trojan. The Trilium's main developer almost got compromised, but <code spellcheck=\"false\">pnpm</code> not trusting unknown post-install scripts successfully avoided that.</p><h2>Migration</h2><p>Replace <code spellcheck=\"false\">api.axios</code> calls with the native <code spellcheck=\"false\">fetch()</code> API.</p><h3><code spellcheck=\"false\">GET</code> calls</h3><p>Before (Axios):</p><pre><code class=\"language-text-javascript\">const response = await api.axios.get('https://api.example.com/data');\nconst data = response.data;</code></pre><p>After (<code spellcheck=\"false\">fetch</code>):</p><pre><code class=\"language-text-javascript\">const response = await fetch('https://api.example.com/data');\nconst data = await response.json();</code></pre><h3><code spellcheck=\"false\">POST</code> calls</h3><p>Before (Axios):</p><pre><code class=\"language-text-javascript\">await api.axios.post('https://api.example.com/data', { key: 'value' });</code></pre><p>After (fetch):</p><pre><code class=\"language-text-javascript\">await fetch('https://api.example.com/data', {\n method: 'POST',\n headers: { 'Content-Type': 'application/json' },\n body: JSON.stringify({ key: 'value' })\n});</code></pre>",
- "_help_pAJ0jWz16xFm": "<p>The <code spellcheck=\"false\">api.cheerio</code> library is deprecated and will be removed in a future version.</p><h2>Reasoning</h2><p>Cheerio is only used for the scripting API while the server internally uses <code spellcheck=\"false\">node-html-parser</code> for HTML parsing. Removing <code spellcheck=\"false\">cheerio</code> reduces bundle size and maintenance overhead.</p><h2>Migration</h2><p>Before (<code spellcheck=\"false\">cheerio</code>):</p><pre><code class=\"language-text-javascript\">const $ = api.cheerio.load(html);\nconst title = $('h1').text();\nconst links = $('a').map((i, el) =&gt; $(el).attr('href')).get();</code></pre><p>After (<code spellcheck=\"false\">htmlParser</code>):</p><pre><code class=\"language-text-javascript\">const root = api.htmlParser.parse(html);\nconst title = root.querySelector('h1')?.textContent;\nconst links = root.querySelectorAll('a').map(a =&gt; a.getAttribute('href'));</code></pre>",
- "_help_72dxvnbnkDFY": "<p>jQuery 4 removes legacy browser support (such as IE11 support), but it also removes some APIs that are considered deprecated such as:</p><blockquote><p><code spellcheck=\"false\">jQuery.isArray</code>, <code spellcheck=\"false\">jQuery.parseJSON</code>, <code spellcheck=\"false\">jQuery.trim</code>, <code spellcheck=\"false\">jQuery.type</code>, <code spellcheck=\"false\">jQuery.now</code>, <code spellcheck=\"false\">jQuery.isNumeric</code>, <code spellcheck=\"false\">jQuery.isFunction</code>, <code spellcheck=\"false\">jQuery.isWindow</code>, <code spellcheck=\"false\">jQuery.camelCase</code>, <code spellcheck=\"false\">jQuery.nodeName</code>, <code spellcheck=\"false\">jQuery.cssNumber</code>, <code spellcheck=\"false\">jQuery.cssProps</code>, and <code spellcheck=\"false\">jQuery.fx.interval</code>.</p><p>Use native equivalents like <code spellcheck=\"false\">Array.isArray()</code>, <code spellcheck=\"false\">JSON.parse()</code>, <code spellcheck=\"false\">String.prototype.trim()</code>, and <code spellcheck=\"false\">Date.now()</code> instead.</p></blockquote><p>This may affect custom scripts if they (or the custom jQuery libraries used) depend on the deprecated APIs.</p><p>Note that Trilium polyfills <code spellcheck=\"false\">jQuery.isArray</code>, <code spellcheck=\"false\">isFunction</code> and <code spellcheck=\"false\">isPlainObject</code> because they were required by one of our dependencies (the autocomplete).</p><p>For more information, consult <a href=\"https://blog.jquery.com/2026/01/17/jquery-4-0-0/\">the official blog post</a>.</p>",
- "_help_fiHicjpHjIRJ": "<p>Starting with v0.104.0, some features in Trilium are intentionally disabled in order to reduce the attack surface:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_SPirpZypehBG\">Backend scripts</a>, which can run processes on the server, access the file system or bypass security measures.</li><li><a class=\"reference-link\" href=\"#root/_help_YKWqdJhzi2VY\">SQL Console</a>, which can be used to exfiltrate important data such as the document secret or cause irreparable damage to the database.</li><li><a class=\"reference-link\" href=\"#root/_help_swSFivWk6KkA\">Network Access</a>&nbsp;for the&nbsp;<a class=\"reference-link\" href=\"#root/_help_poXkQfguuA0U\">Desktop Installation</a>.</li></ul><p>To activate any of them, there are three variants:</p><ul><li>For the desktop app, go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Security</em> and toggle the desired option.<ul><li>This will prompt a system dialog confirming the change. Note that scripts could potentially call this confirmation dialog as well, make sure to accept it only if enabling any of these features is required.</li><li>The settings page will be available for the server-side as well, but the options need to be manually toggled using the other mechanisms described here.</li><li>This works by setting a separate configuration file in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_tAassRL4RSQL\">Data directory</a>.</li></ul></li><li>In <a href=\"#root/_help_Gzjqa934BdH4\">config.ini</a>, set the corresponding option under the <code spellcheck=\"false\">Security</code> group.</li><li>Or use environment variables (e.g. <code spellcheck=\"false\">TRILIUM_SECURITY_BACKEND_SCRIPTING_ENABLED=true</code>).</li></ul>",
++ "_help_KLsqhjaqh1QW": "<p>Since v0.101.0, Trilium integrates Preact for front-end scripting, including support for JSX.</p><p>Preact can be used for:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>, where a JSX code note is used instead of a HTML one.</li><li><a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>, where JSX can be used to replace the old, jQuery-based mechanism.</li></ul><p>To get started, the first step is to enable JSX in the list of Code languages. Go to Options → Code Notes and check the “JSX” language. Afterwards, proceed with the documentation in either&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>&nbsp;or&nbsp;<a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>, which will both have a section on how to use the new Preact integration.</p><aside class=\"admonition important\"><p>The documentation assumes prior knowledge with React or Preact. As a starting point, consider the <a href=\"https://www.freecodecamp.org/learn/front-end-development-libraries-v9/\">FreeCodeCamp course on Front End Development Libraries</a> or the <a href=\"https://preactjs.com/tutorial/\">Preact Tutorial</a>.</p></aside><h2>Import/exports</h2><p>When using Preact with JSX, there is a special syntax which provides ES-like imports. This <code>import</code> syntax makes way for a more intuitive that doesn't make use of global objects and paves the way for better auto-completion support that might be introduced in the future.&nbsp;</p><h3>API imports</h3><p>Instead of:</p><pre><code class=\"language-text-jsx\">api.showMessage(\"Hello\");</code></pre><p>the JSX version looks like this:</p><pre><code class=\"language-text-jsx\">import { showMessage } from \"trilium:api\";\nshowMessage(\"hello\");</code></pre><h3>Preact API imports (hooks, components)</h3><p>There's a new&nbsp;<a class=\"reference-link\" href=\"#root/_help_GLks18SNjxmC\">Script API</a>&nbsp;dedicated to Preact, which provides shared components that are also used by Trilium internally as well as hooks, for example.</p><pre><code class=\"language-text-jsx\">import { useState } from \"trilium:preact\";\nconst [ myState, setMyState ] = useState(\"Hi\");</code></pre><h3>Exporting</h3><p>JSX notes can export a component for use in&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>&nbsp;or for&nbsp;<a class=\"reference-link\" href=\"#root/_help_Bqde6BvPo05g\">Component libraries</a>: </p><pre><code class=\"language-text-jsx\">export default function() {\n return (\n &lt;&gt;\n &lt;p&gt;Hello world.&lt;/p&gt;\n &lt;/&gt;\n );\n}</code></pre><h3>Import/export are not required</h3><p>These imports are syntactic sugar meant to replace the usage for the <code>api</code> global object (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_GLks18SNjxmC\">Script API</a>).&nbsp;</p><aside class=\"admonition note\"><p>The <code>import</code> and <code>export</code> syntax work only for JSX notes. Standard/jQuery code notes still need to use the <code>api</code> global and <code>module.exports</code>.</p></aside><h2>Under the hood</h2><p>Unlike JavaScript, JSX requires pre-processing to turn it into JavaScript (just like TypeScript). To do so, Trilium uses <a href=\"https://github.com/alangpierce/sucrase\">Sucrase</a>, a JavaScript library which processes the JSX to pure JavaScript. The processing is done each time a script is run (for widgets this happens at every program startup). If you notice any performance degradation due to long compilation, consider <a href=\"#root/_help_wy8So3yZZlH9\">reporting the issue</a> to us.</p>",
++ "_help_Bqde6BvPo05g": "<p>Using the concept of&nbsp;<a class=\"reference-link\" href=\"#root/_help_hA834UaHhSNn\">Script bundles</a>, it's possible to create components that are shared for multiple widgets or&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>.</p><h2>Exporting a single component</h2><p>This is generally useful for big components.</p><p>Here's an example child hierarchy using&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>: </p><ul><li><em>My render note</em><br>Note type: Render Note<br>Link <code>~renderNote</code> to the child note (<em>Render note with subcomponents</em>)<ul><li><p><em>Render note with subcomponents</em><br>Type: JSX</p><pre><code class=\"language-text-jsx\">export default function() {\n return (\n &lt;MyComponent /&gt; \n );\n}</code></pre><ul><li><p><em>MyComponent</em><br>Type: Code / JSX</p><pre><code class=\"language-text-jsx\">export default function MyComponent() {\n return &lt;p&gt;Hi&lt;/p&gt;;\n}</code></pre></li></ul></li></ul></li></ul><h2>Multiple components per note</h2><p>To export multiple components, use the <code>export</code> keyword next to each of the function components.</p><p>Here's how a sub-note called <code>MyComponents</code> would look like:</p><pre><code class=\"language-text-jsx\">export function MyFirstComponent() {\n return &lt;p&gt;First&lt;/p&gt;;\n}\n\nexport function MySecondComponent() {\n return &lt;p&gt;Bar&lt;/p&gt;;\n}</code></pre><p>Then in its parent note:</p><pre><code class=\"language-text-jsx\">const { MyFirstComponent, MySecondComponent } = MyComponents;\n\nexport default function() {\n return (\n &lt;&gt;\n &lt;MyFirstComponent /&gt;\n &lt;MySecondComponent /&gt;\n &lt;/&gt;\n );\n}</code></pre><p>Alternatively, it's also possible to use the components directly without assigning them to a <code>const</code> first:</p><pre><code class=\"language-text-jsx\">&lt;MyComponents.MyFirstComponent /&gt;\n&lt;MyComponents.MySecondComponent /&gt;</code></pre>",
++ "_help_ykYtbM9k3a7B": "<h2>Standard Preact hooks</h2><p>All standard Preact hooks are available as an import in <code>trilium:api</code>.</p><p>For example:</p><pre><code class=\"language-text-jsx\">import { useState } from \"trilium:preact\";\nconst [ myState, setMyState ] = useState(\"Hi\");</code></pre><h2>Custom hooks</h2><p>Trilium comes with a large set of custom hooks for Preact, all of which are also available to custom widgets and&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>.</p><h3><code>useNoteContext</code></h3><p>As a replacement to&nbsp;<a class=\"reference-link\" href=\"#root/_help_GhurYZjh8e1V\">Note context aware widget</a>, Preact exposes the current note context in the <code>useNoteContext</code> hook:</p><pre><code class=\"language-text-jsx\">import { defineWidget, useNoteContext, useNoteProperty } from \"trilium:preact\";\n\nexport default defineWidget({ \n parent: \"note-detail-pane\",\n position: 10,\n render: () =&gt; {\n const { note } = useNoteContext();\n const title = useNoteProperty(note, \"title\");\n return &lt;span&gt;Current note JSX: {title}&lt;/span&gt;;\n }\n});</code></pre><p>Note that the custom widget must be inside the content area (so note detail widget) for this to work properly, especially when dealing with splits.</p><h3><code>useActiveNoteContext</code></h3><p><code>useActiveNoteContext</code> is an alternative to <code>useNoteContext</code> which works even if the widget is not within the note detail section and it automatically switches the note context as the user is navigating around between tabs and splits.</p><h3><code>useNoteProperty</code></h3><p>This hook allows “listening” for changes to a particular property of a <code>FNote</code>, such as the <code>title</code> or <code>type</code> of a note. The benefit from using the hook is that it actually reacts to changes, for example if the note title or type is changed.</p>",
++ "_help_Sg9GrCtyftZf": "<h2>Inline styles</h2><pre><code class=\"language-text-jsx\">&lt;div style={{\n display: \"flex\",\n height: \"53px\",\n width: \"fit-content\",\n fontSize: \"0.75em\",\n alignItems: \"center\",\n flexShrink: 0 \n}}&gt;/* [...] */&lt;/div&gt;</code></pre><h2>Custom CSS file</h2><p>Simply create a&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlhDUqhENtH7\">Custom app-wide CSS</a>. Make sure the class names are unique enough to not intersect with other UI elements, consider adding a prefix (e.g. <code>x-mywidget-</code>).</p>",
++ "_help_RSssb9S3xgSr": "<figure class=\"image image_resized\" style=\"width:54.58%;\"><img style=\"aspect-ratio:896/712;\" src=\"{{helpAssets}}/User%20Guide/Scripting/Frontend%20Basics/Preact/Built-in%20components_image.png\" width=\"896\" height=\"712\"><figcaption>A partial screenshot from the Widget showcase example (see below).</figcaption></figure><p>Trilium comes with its own set of Preact components, some of which are also available to&nbsp;<a class=\"reference-link\" href=\"#root/_help_MgibgPcfeuGz\">Custom Widgets</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>.</p><p>To use these components, simply import them from <code>trilium:preact</code>:</p><pre><code class=\"language-text-jsx\">import { ActionButton, Button, LinkButton } from \"trilium:preact\";</code></pre><p>and then use them:</p><pre><code class=\"language-text-jsx\">export default function MyRenderNote() {\n const onClick = () =&gt; showMessage(\"A button was pressed\");\n \n return (\n &lt;&gt;\n &lt;h2&gt;Buttons&lt;/h2&gt;\n &lt;div style={{ display: \"flex\", gap: \"1em\", alignItems: \"center\" }}&gt;\n &lt;ActionButton icon=\"bx bx-rocket\" text=\"Action button\" onClick={onClick} /&gt;\n &lt;Button icon=\"bx bx-rocket\" text=\"Simple button\" onClick={onClick} /&gt;\n &lt;LinkButton text=\"Link button\" onClick={onClick} /&gt; \n &lt;/div&gt;\n &lt;/&gt;\n )\n}</code></pre><h2>Widget showcase</h2><aside class=\"admonition tip\"><p>Starting with v0.101.0, the widget showcase is also available in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_6tZeKvSHEUiB\">Demo Notes</a>.</p></aside><p>This is a&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>&nbsp;example with JSX that shows most of the built-in components that are accessible to custom widgets and JSX render notes.</p><p>To use it, simply:</p><ol><li>Create a render note.</li><li>Create a child code note of JSX type with the content of this file:&nbsp;<a class=\"reference-link\" href=\"#root/_help_i9B4IW7b6V6z\">Widget showcase</a></li><li>Set the <code>~renderNote</code> relation of the parent note to the child note.</li><li>Refresh the render note to see the results.</li></ol>",
++ "_help_i9B4IW7b6V6z": "import {\n ActionButton, Button, LinkButton,\n Admonition, Collapsible,\n FormCheckbox, FormDropdownList, FormFileUploadButton, FormGroup, FormRadioGroup, FormTextArea,\n FormTextBox, FormToggle, Slider, RawHtml, LoadingSpinner, Icon,\n ColorPicker,\n Dropdown, FormListItem, FormDropdownDivider, FormDropdownSubmenu,\n NoteAutocomplete, NoteLink, Modal,\n Table,\n CKEditor,\n useEffect, useState\n} from \"trilium:preact\";\nimport { showMessage } from \"trilium:api\";\n\nexport default function() {\n const [ time, setTime ] = useState();\n const lorem = \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam accumsan eu odio non gravida. Pellentesque ornare, arcu condimentum molestie dignissim, nibh turpis ultrices elit, eget elementum nunc erat at erat. Maecenas vehicula consectetur elit, nec fermentum elit venenatis eu.\";\n useEffect(() => {\n const interval = setInterval(() => setTime(new Date().toLocaleString()), 1000);\n return () => clearInterval(interval);\n }, []);\n\n return (\n <div style={{ padding: 20, display: \"flex\", flexDirection: \"column\", gap: \"1em\" }}>\n <h1>Widget showcase</h1>\n\n <Buttons />\n <Admonition type=\"note\">\n <strong>Admonition</strong><br />\n {lorem}\n </Admonition>\n\n <Collapsible title=\"Collapsible\" initiallyExpanded>\n {lorem}\n </Collapsible>\n\n <FormElements />\n <NoteElements />\n <ModalSample />\n <DropdownSample />\n <CollectionViews />\n </div>\n );\n}\n\nfunction Buttons() {\n const onClick = () => showMessage(\"A button was pressed\");\n\n return (\n <>\n <h2>Buttons</h2>\n <div style={{ display: \"flex\", gap: \"1em\", alignItems: \"center\" }}>\n <ActionButton icon=\"bx bx-rocket\" text=\"Action button\" onClick={onClick} />\n <Button icon=\"bx bx-rocket\" text=\"Simple button\" onClick={onClick} />\n <LinkButton text=\"Link button\" onClick={onClick} />\n </div>\n </>\n )\n}\n\nfunction FormElements() {\n const [ checkboxChecked, setCheckboxChecked ] = useState(false);\n const [ dropdownValue, setDropdownValue ] = useState(\"key-1\");\n const [ radioGroupValue, setRadioGroupValue ] = useState(\"key-1\");\n const [ sliderValue, setSliderValue ] = useState(50);\n const [ color, setColor ] = useState(\"#43a047\");\n\n return (\n <>\n <h2>Form elements</h2>\n <div style={{ display: \"grid\", gridTemplateColumns: \"1fr 1fr 1fr\", gap: \"1em\" }}>\n <FormGroup name=\"checkbox\" label=\"Checkbox\">\n <FormCheckbox label=\"Checkbox\" currentValue={checkboxChecked} onChange={setCheckboxChecked} />\n </FormGroup>\n <FormGroup name=\"toggle\" label=\"Toggle\">\n <FormToggle switchOnName=\"Off\" switchOffName=\"On\" currentValue={checkboxChecked} onChange={setCheckboxChecked} />\n </FormGroup>\n <FormGroup name=\"dropdown\" label=\"Dropdown\">\n <FormDropdownList\n values={[\n { key: \"key-1\", name: \"First item\" },\n { key: \"key-2\", name: \"Second item\" },\n { key: \"key-3\", name: \"Third item\" },\n ]}\n currentValue={dropdownValue} onChange={setDropdownValue}\n keyProperty=\"key\" titleProperty=\"name\"\n />\n </FormGroup>\n <FormGroup name=\"radio-group\" label=\"Radio group\">\n <FormRadioGroup\n values={[\n { value: \"key-1\", label: \"First item\" },\n { value: \"key-2\", label: \"Second item\" },\n { value: \"key-3\", label: \"Third item\" },\n ]}\n currentValue={radioGroupValue} onChange={setRadioGroupValue}\n />\n </FormGroup>\n <FormGroup name=\"text-box\" label=\"Text box\">\n <FormTextBox\n placeholder=\"Type something...\"\n currentValue=\"\" onChange={(newValue) => {}}\n />\n </FormGroup>\n <FormGroup name=\"text-area\" label=\"Text area\">\n <FormTextArea\n placeholder=\"Type something bigger...\"\n currentValue=\"\" onChange={(newValue) => {}}\n />\n </FormGroup>\n <FormGroup name=\"color-picker\" label=\"Color picker\">\n <ColorPicker currentValue={color} onChange={setColor} />\n </FormGroup>\n <FormGroup name=\"slider\" label=\"Slider\">\n <Slider\n min={1} max={100}\n value={sliderValue} onChange={setSliderValue}\n />\n </FormGroup>\n <FormGroup name=\"file-upload\" label=\"File upload\">\n <FormFileUploadButton\n text=\"Upload\"\n onChange={(files) => {\n const file = files?.[0];\n if (!file) return;\n showMessage(`Got file \"${file.name}\" of size ${file.size} B and type ${file.type}.`);\n }}\n />\n </FormGroup>\n <FormGroup name=\"icon\" label=\"Icon\">\n <Icon icon=\"bx bx-smile\" />\n </FormGroup>\n <FormGroup name=\"loading-spinner\" label=\"Loading spinner\">\n <LoadingSpinner />\n </FormGroup>\n <FormGroup name=\"raw-html\" label=\"Raw HTML\">\n <RawHtml html=\"<strong>Hi</strong> <em>there</em>\" />\n </FormGroup>\n </div>\n </>\n )\n}\n\nfunction NoteElements() {\n const [ noteId, setNoteId ] = useState(\"\");\n\n return (\n <div>\n <h2>Note elements</h2>\n\n <FormGroup name=\"note-autocomplete\" label=\"Note autocomplete\">\n <NoteAutocomplete\n placeholder=\"Select a note\"\n noteId={noteId} noteIdChanged={setNoteId}\n />\n </FormGroup>\n\n <FormGroup name=\"note-link\" label=\"Note link\">\n {noteId\n ? <NoteLink notePath={noteId} showNoteIcon />\n : <span>Select a note first</span>}\n </FormGroup>\n </div>\n );\n}\n\nfunction ModalSample() {\n const [ shown, setShown ] = useState(false);\n\n return (\n <>\n <h2>Modal</h2>\n <Button text=\"Open modal\" onClick={() => setShown(true)} />\n <Modal title=\"Modal title\" size=\"md\" show={shown} onHidden={() => setShown(false)}>\n Modal goes here.\n </Modal>\n </>\n )\n}\n\nfunction DropdownSample() {\n return (\n <>\n <h2>Dropdown menu</h2>\n <Dropdown text=\"Dropdown\" hideToggleArrow>\n <FormListItem icon=\"bx bx-cut\">Cut</FormListItem>\n <FormListItem icon=\"bx bx-copy\">Copy</FormListItem>\n <FormListItem icon=\"bx bx-paste\">Paste</FormListItem>\n <FormDropdownDivider />\n <FormDropdownSubmenu title=\"Submenu\">\n <FormListItem>More items</FormListItem>\n </FormDropdownSubmenu>\n </Dropdown>\n </>\n )\n}\n\nfunction CollectionViews() {\n return (\n <>\n <h2>Collection views</h2>\n <p>\n A generic <code>Table</code> (Tabulator) is available. A <code>Calendar</code>\n {\" \"}(FullCalendar) component is also exposed, but it requires you to pass a\n {\" \"}<code>plugins</code> array to render a view, so it is not demonstrated here.\n </p>\n <Table\n layout=\"fitColumns\"\n columns={[\n { title: \"Name\", field: \"name\" },\n { title: \"Progress\", field: \"progress\" }\n ]}\n data={[\n { id: 1, name: \"First task\", progress: \"80%\" },\n { id: 2, name: \"Second task\", progress: \"20%\" }\n ]}\n />\n </>\n )\n}\n",
++ "_help_irkwjdNtjcxR": "<p>Front-end scripts can be run automatically on certain triggering conditions.</p><p>To do so, set the <code>run</code> <a href=\"#root/_help_HI6GBBIduIgv\">label</a> to either:</p><ul><li><code>frontendStartup</code> - when Trilium frontend starts up (or is refreshed), but not on mobile.</li><li><code>mobileStartup</code> - when Trilium frontend starts up (or is refreshed), on mobile.</li></ul><aside class=\"admonition note\"><p>One script can be triggered on multiple events, this can be done by adding multiple <code>run</code> labels. Separating multiple values by commas <strong>is not</strong> supported.</p></aside><p>Backend scripts have more powerful triggering conditions, for example they can run automatically on a hourly or daily basis, but also on events such as when a note is created or an attribute is modified. See the server-side&nbsp;<a class=\"reference-link\" href=\"#root/_help_GPERMystNGTB\">Events</a>&nbsp;for more information.</p><h2>Safe mode</h2><p>While <a href=\"#root/_help_64ZTlUPgEPtW\">safe mode</a> is active, scripts with events won't trigger.</p>",
++ "_help_SPirpZypehBG": "<p>Unlike <a href=\"#root/_help_yIhgI5H7A2Sm\">front-end scripts</a> which run on the client / browser-side, back-end scripts run directly on the Node.js environment of the Trilium server.</p><p>Back-end scripts can be used both on a&nbsp;<a class=\"reference-link\" href=\"#root/_help_WOcw2SLH6tbX\">Server Installation</a>&nbsp;(where it will run on the device the server is running on), or on the&nbsp;<a class=\"reference-link\" href=\"#root/_help_poXkQfguuA0U\">Desktop Installation</a>&nbsp;(where it will run on the PC).</p><aside class=\"admonition important\"><p>Starting with v0.104.0, backend scripts are disabled by default to reduce the attack surface. See&nbsp;<a class=\"reference-link\" href=\"#root/_help_fiHicjpHjIRJ\">Security</a>&nbsp;for more information.</p></aside><h2>Advantages of backend scripts</h2><p>The benefit of backend scripts is that they can be pretty powerful, for example to have access to the underlying system, for example it can read files or execute processes.</p><p>However, the main benefit of backend scripts is that they have easier access to the notes since the information about them is already loaded in memory. Whereas on the client, notes have to be manually loaded first.</p><h2>Creating a backend script</h2><p>Create a new&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;note and select the language <em>JavaScript (Trilium backend)</em>, or choose <em>Insert child note</em> → <em>Code</em> → <em>Backend script</em> in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_YtSN43OrfzaA\">Note tree contextual menu</a>, which does both in one step.</p><h2>Running backend scripts</h2><p>Backend scripts can be either run manually (via the Execute button on the script page), or they can be triggered on certain events.</p><p>When a script run manually or from a launcher throws an error, Trilium shows a <em>Scripting error</em> notification with the error message and a link to the note that failed. If the error comes from a child note the script requires, the link points to that child note. Changes the script made to notes before the error are rolled back.</p><p>In addition, scripts can be run automatically when the server starts up, on a fixed time interval or when a certain event occurs (such as an attribute being modified). For more information, see the dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_GPERMystNGTB\">Events</a>&nbsp;page.</p><h2>Script API</h2><p>Trilium exposes a set of APIs that can be directly consumed by scripts, under the <code>api</code> object. For a reference of this API, see&nbsp;<a class=\"reference-link\" href=\"{{helpAssets}}/User%20Guide/Scripting/Script%20API/Backend%20API.dat\">Backend API</a>.</p>",
++ "_help_fZ2IGYFXjkEy": "<p>Older versions of Trilium Notes allowed the use of Common.js module imports inside backend scripts, such as:</p><pre><code class=\"language-text-x-trilium-auto\">const isBetween = require('dayjs/plugin/isBetween')\napi.dayjs.extend(isBetween)</code></pre><p>For newer versions, Node.js imports are <strong>not officially supported anymore</strong>, since we've added a bundler which makes it more difficult to reuse dependencies.</p><p>Theoretically it's still possible to use imports by manually setting up a <code>node_modules</code> in the server directory via <code>npm</code> or <code>pnpm</code>.</p>",
++ "_help_GPERMystNGTB": "<p><a href=\"#root/_help_CdNpE2pqjmI6\">Script</a> notes can be triggered by events. Note that these are backend events and thus relation need to point to the \"JavaScript (Trilium backend)\" code note.</p><h2>Global events</h2><p>Global events are attached to the script note via label. Simply create a <code>run</code> label with some of these values and script note will be executed once the event occurs.</p><figure class=\"table\"><table><thead><tr><th>Label</th><th>Description</th></tr></thead><tbody><tr><td><code>run</code></td><td><p>Defines on which events script should run. Possible values are:</p><ul><li><code>backendStartup</code> - when Trilium backend starts up</li><li><code>hourly</code> - run once an hour. You can use additional label <code>runAtHour</code> to specify at which hour, on the back-end.</li><li><code>daily</code> - run once a day, on the back-end</li></ul></td></tr><tr><td><code>runOnInstance</code></td><td>Specifies that the script should only run on a particular&nbsp;<a class=\"reference-link\" href=\"#root/_help_c5xB8m4g2IY6\">Trilium instance</a>.</td></tr><tr><td><code>runAtHour</code></td><td>On which hour should this run. Should be used together with <code>#run=hourly</code>. Can be defined multiple times for more runs during the day.</td></tr></tbody></table></figure><p>Frontend scripts also have similar&nbsp;<a class=\"reference-link\" href=\"#root/_help_irkwjdNtjcxR\">Events</a>, such as when the application starts.</p><aside class=\"admonition note\"><p>One script can be triggered on multiple events, this can be done by adding multiple <code>run</code> labels. Separating multiple values by commas <strong>is not</strong> supported.</p></aside><h2>Entity events</h2><p>Other events are bound to some entity, these are defined as <a href=\"#root/_help_zEY4DaJG4YT5\">relations</a> - meaning that script is triggered only if note has this script attached to it through relations (or it can inherit it).</p><figure class=\"table\"><table><thead><tr><th>Relation</th><th>Trigger condition</th><th>Origin entity (see below)</th></tr></thead><tbody><tr><td><code>runOnNoteCreation</code></td><td>executes when note is created on backend. Use this relation if you want to run the script for all notes created under a specific subtree. In that case, create it on the subtree root note and make it inheritable. A new note created within the subtree (any depth) will trigger the script.</td><td>The <code>BNote</code> that got created.</td></tr><tr><td><code>runOnChildNoteCreation</code></td><td>executes when new note is created under the note where this relation is defined</td><td>The <code>BNote</code> of the child that got created.</td></tr><tr><td><code>runOnNoteTitleChange</code></td><td>executes when note title is changed (includes note creation as well)</td><td>The <code>BNote</code> of the note whose title got changed.</td></tr><tr><td><code>runOnNoteContentChange</code></td><td>executes when note content is changed (includes note creation as well).</td><td>The <code>BNote</code> of the note whose content got changed.</td></tr><tr><td><code>runOnNoteChange</code></td><td>executes when note is changed (includes note creation as well). Does not include content changes</td><td>The <code>BNote</code> of the note that got changed.</td></tr><tr><td><code>runOnNoteDeletion</code></td><td>executes when note is being deleted</td><td>The <code>BNote</code> of the note that got (soft) deleted.</td></tr><tr><td><code>runOnBranchCreation</code></td><td>executes when a branch is created. Branch is a link between parent note and child note and is created e.g. when cloning or moving note.</td><td>The <code>BBranch</code> that got created.</td></tr><tr><td><code>runOnBranchChange</code></td><td>executes when a branch is updated. (since v0.62)</td><td>The <code>BBranch</code> that got changed.</td></tr><tr><td><code>runOnBranchDeletion</code></td><td>executes when a branch is deleted. Branch is a link between parent note and child note and is deleted e.g. when moving note (old branch/link is deleted).</td><td>The <code>BBranch</code> that got (soft) deleted.</td></tr><tr><td><code>runOnAttributeCreation</code></td><td>executes when new attribute is created for the note which defines this relation</td><td>The <code>BAttribute</code> that got created.</td></tr><tr><td><code>runOnAttributeChange</code></td><td>executes when the attribute is changed of a note which defines this relation. This is triggered also when the attribute is deleted</td><td>The <code>BAttribute</code> that got changed.</td></tr></tbody></table></figure><h2>Origin entity</h2><p>When a script is run by an event such as the ones described above, <code>api.originEntity</code> will get populated with the note, branch or attribute that triggered the change.</p><p>For example, here's a script with <code>~runOnAttributeChange</code> which automatically changes the color of a note based on the value of the <code>mycategory</code> label:</p><pre><code class=\"language-text-javascript\">const attr = api.originEntity;\nif (attr.name !== \"mycategory\") return;\nconst note = api.getNote(attr.noteId);\nif (attr.value === \"Health\") {\n note.setLabel(\"color\", \"green\");\n} else {\n note.removeLabel(\"color\");\n}</code></pre><h2>Safe mode</h2><p>While <a href=\"#root/_help_64ZTlUPgEPtW\">safe mode</a> is active, scripts with events won't trigger.</p>",
++ "_help_hA834UaHhSNn": "<p>For both&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>&nbsp;and more complicated scripts, it's generally useful to split the code into multiple&nbsp;<a class=\"reference-link\" href=\"#root/_help_6f9hih2hXXZk\">Code</a>&nbsp;notes.</p><p>When a script is run, the sub-children of the script being run (or the&nbsp;<a class=\"reference-link\" href=\"#root/_help_HcABDtFCkbFN\">Render Note</a>) are checked for children. If the children are Code notes of the corresponding type (front-end or backend) as the code being run, they will be evaluated as well.</p><p>The collection of a script and its child notes is called a <em>bundle</em>. A child note inside a bundle is called a <em>module</em>.</p><p>As a basic example of dependencies, consider the following note structure:</p><ul><li><p><em>Script with dependency</em></p><pre><code class=\"language-text-javascript\">api.log(MyMath.sum(2, 2));</code></pre><ul><li><p><em>MyMath</em></p><pre><code class=\"language-text-javascript\">module.exports = {\n sum(a, b) {\n return a + b;\n }\n};</code></pre></li></ul></li></ul><p>When <em>Script with dependency</em> is run, it will detect <em>MyMath</em> as a submodule and provide the result of its <code>module.exports</code> object into a global object with the same name as the note.</p><aside class=\"admonition note\"><p>If the note contains spaces or special characters, they will be stripped. For example <code>My Nice Note!</code> becomes <code>MyNiceNote</code>.</p></aside><h2>Alternative syntax</h2><p>Instead of providing an object to <code>module.exports</code>, it's also possible to add fields individually:</p><pre><code class=\"language-text-javascript\">module.exports.sum = (a, b) =&gt; a + b;\nmodule.exports.subtract = (a, b) =&gt; a - b;</code></pre><h2>Ignoring a code script from a bundle</h2><p>To ignore a script from being included in a bundle (e.g. if it's unrelated to the parent script note), apply the <code>#disableInclusion</code> label.</p><h2>Sharing a module across multiple bundles</h2><p>Modules can be reused across multiple scripts by simply cloning the shared module between two modules (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_IakOLONlIfGI\">Cloning Notes</a>).</p><p>Optionally, a separate note can be used to contain all the different reusable modules for an easy way to discover them.</p>",
++ "_help_GLks18SNjxmC": "<p>For <a href=\"#root/_help_CdNpE2pqjmI6\">script code notes</a>, Trilium offers an API that gives them access to various features of the application.</p><p>There are two APIs:</p><ul><li>One for the front-end scripts:&nbsp;<a class=\"reference-link\" href=\"#root/_help_Q2z6av6JZVWm\">Frontend API</a></li><li>One for the back-end scripts:&nbsp;<a class=\"reference-link\" href=\"{{helpAssets}}/User%20Guide/Scripting/Script%20API/Backend%20API.dat\">Backend API</a></li></ul><p>In both cases, the API resides in a global variable, <code>api</code>, that can be used anywhere in the script.</p><p>For example, to display a message to the user the following front-end script can be used:</p><pre><code class=\"language-text-x-trilium-auto\">api.showMessage(\"Hello world.\");</code></pre><aside class=\"admonition note\"><p><strong>Note</strong><br>The Script API is currently experimental and may undergo changes in future updates.</p></aside>",
++ "_help_ApVHZ8JY5ofC": "<p>Day.js is a date manipulation library that's used by Trilium, but it's also shared with both front-end and back-end scripts. For more information about the library itself, consult the <a href=\"https://day.js.org/en/\">official documentation</a>.</p><h2>How to use</h2><p>The <code>dayjs</code> method is provided directly in the <code>api</code> global:</p><pre><code class=\"language-text-javascript\">const date = api.dayjs();\napi.log(date.format(\"YYYY-MM-DD\"));</code></pre><h2>Plugins</h2><p>Day.js uses a modular, plugin-based architecture. Generally these plugins must be imported, but this process doesn't work inside Trilium scripts due to the use of a bundler.</p><p>Since v0.100.0, the same set of plugins is available for both front-end and back-end scripts.</p><p>The following Day.js plugins are directly integrated into Trilium:</p><ul><li><a href=\"https://day.js.org/docs/en/plugin/advanced-format\">AdvancedFormat</a></li><li><a href=\"https://day.js.org/docs/en/plugin/duration\">Duration</a>, since v0.100.0.</li><li><a href=\"https://day.js.org/docs/en/plugin/is-between\">IsBetween</a></li><li><a href=\"https://day.js.org/docs/en/plugin/iso-week\">IsoWeek</a></li><li><a href=\"https://day.js.org/docs/en/plugin/is-same-or-after\">IsSameOrAfter</a></li><li><a href=\"https://day.js.org/docs/en/plugin/is-same-or-before\">IsSameOrBefore</a></li><li><a href=\"https://day.js.org/docs/en/plugin/quarter-of-year\">QuarterOfYear</a></li><li><a href=\"https://day.js.org/docs/en/plugin/utc\">UTC</a></li></ul><aside class=\"admonition note\"><p>If another Day.js plugin might be needed for scripting purposes, feel free to open a feature request for it. Depending on the size of the plugin and the potential use of it inside the Trilium code base, it has a chance of being integrated.</p></aside>",
++ "_help_vElnKeDNPSVl": "<p>Both front-end and back-end notes can log messages for debugging.</p><h2>UI logging via <code>api.log</code></h2><figure class=\"image image-style-align-center image_resized\" style=\"width:57.74%;\"><img style=\"aspect-ratio:749/545;\" src=\"{{helpAssets}}/User%20Guide/Scripting/Logging_image.png\" width=\"749\" height=\"545\"></figure><p>The API log feature integrates with the script editor and it displays all the messages logged via <code>api.log</code>. This works for both back-end and front-end scripts.</p><p>The API log panel will appear at the bottom of a note (including in&nbsp;<a class=\"reference-link\" href=\"#root/_help_ZjLYv08Rp3qC\">Quick edit</a>) after executing a script that uses <code>api.log</code>. It can be dismissed temporarily by pressing the close button in the top-right of the panel.</p><p>Apart from strings, an object can be passed as well in which case it will be pretty-formatted if possible (e.g. recursive objects are not supported).</p><h2>Console logging</h2><p>For logs that are not directly visible to the user, the standard <code>console.log</code> can be used as well.</p><ul><li>For front-end scripts, the log will be shown in the Developer Tools (also known as Inspect).</li><li>For back-end scripts, the log will be shown in the server output while running but <strong>will not</strong> be visible in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_bnyigUA2UK7s\">Backend (server) logs</a>.</li></ul>",
++ "_help_IjZS7iK5EXtb": "<p>The <em>New layout</em> is a series of UI/UX changes that were introduced in v0.101.0 that heavily change both existing UI elements, as well as adding some new ones. The goal of this new layout is to modernize the application and to make it more intuitive but at the same time to reduce clutter.</p><p>Starting with v0.107.0, the old layout has been <strong>completely removed</strong>. This page serves as migration instructions to better understand what changed.</p><h2>Newly introduced features</h2><ul><li>At the bottom of the window there is a new bar called the&nbsp;<a class=\"reference-link\" href=\"#root/_help_AlJ73vBCjWDw\">Status bar</a>. This bar houses multiple items such as the Breadcrumb navigation and information and settings about the current note, such as the <a href=\"#root/_help_veGu4faJErEM\">content language</a> and&nbsp;<a class=\"reference-link\" href=\"#root/_help_zEY4DaJG4YT5\">Attributes</a>.</li><li>When a new&nbsp;<a class=\"reference-link\" href=\"#root/_help_iPIMuisry3hd\">Text</a>&nbsp;note is created empty, a&nbsp;<a class=\"reference-link\" href=\"#root/_help_m3VlURMSeOrd\">New note type switcher</a>&nbsp;appears under the title making it easy to switch to a different note type, template or collection.</li><li><a class=\"reference-link\" href=\"#root/_help_B5dihXRDksTk\">Note badges</a>&nbsp;appear at the right of the note title and indicate states such as read-only, shared notes as well as corresponding actions (temporarily marking a note as editable, viewing the sharing note, etc.). These replace some of the floating buttons.</li><li><a class=\"reference-link\" href=\"#root/_hidden/_options/_optionsTextNotes\">Text Notes</a>&nbsp;have a new&nbsp;inline title&nbsp;which has a bigger text and display the creation and modification dates which collapses back to a smaller title when scrolling.</li><li>The following sections have been made collapsible and get displayed under the <a href=\"#root/_help_l7pigIGu01K2\">note title</a>:<ul><li><a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a><ul><li>The keyboard shortcut previously used to trigger the promoted attributes ribbon tab (which was no longer working) has been repurposed to toggle the promoted attributes instead.</li></ul></li><li><em>Edited Notes</em> (now renamed to <em>Notes edited on this day</em>), which appears for&nbsp;<a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a>&nbsp;is now shown underneath the title.<ul><li>Whether the section is collapsed or not depends on the choice in&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ Appearance.</li></ul></li><li><em>Search Properties</em>, which appears for the full&nbsp;<a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a>&nbsp;and&nbsp;<a class=\"reference-link\" href=\"#root/_help_m523cpzocqaD\">Saved Search</a>.</li></ul></li><li><a class=\"reference-link\" href=\"#root/_help_Bsm4fyzPJkSc\">Save status indicator</a>&nbsp;which appears in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_B5dihXRDksTk\">Note badges</a>&nbsp;area&nbsp;and indicates when there are unsaved changes.</li></ul><h2>Changing to the existing layout</h2><h3>Removal of the ribbon</h3><p>The most significant change is the removal of the ribbon. All the actions and options from the ribbon were integrated in other places in the application.</p><p>Here's how all the different tabs that were once part of the ribbon are available in the new layout:</p><ul><li>“Formatting toolbar” was relocated to the top of the page.<ul><li>Instead of having one per split, now there is a single formatting toolbar per tab. This allows more space for the toolbar items.</li></ul></li><li>“Owned attributes” and “Inherited attributes” were merged and moved to the status bar region (displayed one above the other).</li><li>“Basic Properties” were integrated in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>&nbsp;menu.<ul><li>The only exception here is the Language combo box which can now be found in the status bar (top-right of the screen).</li></ul></li><li>“File” and “Image” tabs<ul><li>The buttons were moved to the right of the note title, as dedicated entries in&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>.</li><li>The info section has been merged into the <em>Note info</em> section of the status bar.</li></ul></li><li>Edited notes<ul><li>Moved underneath the title, displayed under a collapsible area and the notes are represented as badges/chips.</li><li>Whether the section is expanded or collapsed depends on the <em>Expand “Notes edited on this day” on day notes</em> setting from Options → Appearance → <em>User Interface</em>.</li></ul></li><li>Search definition tab<ul><li>Moved underneath the title under a collapsible area.</li><li>Expanded by default for new searches, collapsed for saved searches.</li></ul></li><li>The Note map is now in the <span class=\"tn-icon bx bx-dots-horizontal-rounded\"></span> Note actions menu.<ul><li>Instead of opening into a panel in the ribbon, the note map now opens in the sidebar, in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_KRlZFoIH0j6p\">Connections tab</a>&nbsp;where it can also be maximized.</li></ul></li><li>“Note info” tab was moved to a small <span class=\"tn-icon bx bx-info-circle\"></span> icon in the status bar.</li><li>“Similar notes” tab<ul><li>Instead of opening into a panel in the ribbon, the similar notes are now shown in the sidebar, in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_KRlZFoIH0j6p\">Connections tab</a>.</li><li><code>similarNotesWidgetDisabled</code> no longer has any effect.</li></ul></li><li>The Collection properties tab were relocated under the note title and grouped into:<ul><li>A combo box to quickly switch between views.</li><li>Individual settings for the current view in a submenu.</li></ul></li><li>Some smaller ribbon tabs were converted to badges that appear near the note title in the breadcrumb section:<ul><li>Original URL indicator for clipped web pages (<code>#pageUrl</code>).</li><li>SQL and script <span class=\"tn-icon bx bx-play\"></span> execute buttons.</li></ul></li></ul><aside class=\"admonition note\"><p>The ribbon keyboard shortcuts (e.g. <code>toggleRibbonTabClassicEditor</code>) have been repurposed and renamed (<em>Focus Formatting Toolbar</em>, <em>Toggle Owned Attributes</em>, <em>Show Note Map</em>, etc.) to work on the new layout, where they will toggle the appropriate panel.</p></aside><h3>Removal of the floating buttons</h3><p>Most of the buttons were relocated to the right of the note title, in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_8YBEPzcpUgxw\">Note menu</a>&nbsp;area, with the exception of:</p><ul><li>The Edit button is replaced by the <span class=\"tn-icon bx bx-lock-alt\"></span> <em>Read-only</em> badge near the note title, which makes the note temporarily editable when clicked.</li><li><em>Backlinks</em> are now displayed in the sidebar, in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_KRlZFoIH0j6p\">Connections tab</a>.<ul><li>Alternatively, the backlinks count is displayed in the status bar and when clicked the sidebar opens at the right section.</li></ul></li><li>Relation map zoom buttons are now part of the relation map itself.</li><li>Export image to PNG/SVG are now in the Note actions menu, in the <em>Export as image</em> option.</li></ul><h3>Changes to the sidebar</h3><p>The sidebar (also known as the right pane) also received some important changes.</p><p>Most importantly, v0.105.0 splits the sidebar into multiple tabs with additional functionality:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_2dcGDhp9WFKb\">Outline tab</a>, which gathers the table of contents and highlights lists.</li><li><a class=\"reference-link\" href=\"#root/_help_uNtgN0cUKEBc\">Attributes tab</a>, which provides a graphical method of editing labels, relations and (promoted) attribute definitions.</li><li>A dedicated&nbsp;<a class=\"reference-link\" href=\"#root/_help_LrKznOtw9cQD\">AI chat tab</a>.</li><li><a class=\"reference-link\" href=\"#root/_help_KRlZFoIH0j6p\">Connections tab</a>, which groups together the note map, note paths, backlinks and similar notes.</li></ul><p>The previous iteration of the sidebar would appear contextually, depending on whether there are any items to be displayed. This caused occasional content shifts when moving between two panes in a split view. In the new layout, the sidebar acts more like the&nbsp;<a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a>&nbsp;pane, remaining visible even if there is nothing to display.</p><p>As such:</p><ul><li>The <em>Table of Contents</em> card in Text Notes options (minimum number of headings) is gone. The &nbsp;shows the table of contents whatever the number of headings.</li><li><code>#toc</code> / <code>#toc=show</code> / <code>#toc=hide</code> no longer have any effect.</li><li><code>#hideHighlightWidget</code> no longer has any effect. The highlight categories are still set globally, from the <span class=\"tn-icon bx bx-cog\"></span> menu of the Highlights list or Text Notes options, but they can't be hidden for a single note.</li></ul><p>In order to toggle the sidebar, there is a new <span class=\"tn-icon bx bx-sidebar bx-flip-horizontal\"></span> button on the top-right side of the screen, near the window buttons (on Windows and Linux).</p><p>Now each section of the sidebar (e.g. “Table of Contents”, “Highlights list”) is individually collapsible and will remember whether it was collapsed.</p><p>Some sidebar items also have their own menu in the title. For example, the highlights filter can be adjusted directly from the <span class=\"tn-icon bx bx-cog\"></span> menu of the Highlights list.&nbsp;</p><p>Custom widgets are still supported. For custom scripts, the <span class=\"tn-icon bx bx-dots-vertical-rounded\"></span> menu allows quick navigation to the corresponding script note.</p>",
++ "_help_kTx7WqLdZ3Ry": "<p>The <code>api.cheerio</code> library has been removed from the backend scripting API.</p><p>Scripts that attempt to use <code>api.cheerio</code> will now throw an error with migration instructions.</p><h2>Reasoning</h2><p><code>cheerio</code> was deprecated in v0.103.0 in favor of <code>api.htmlParser</code> (<a href=\"https://github.com/taoqf/node-fast-html-parser\">node-html-parser</a>), which Trilium already uses for all of its own HTML parsing. The scripting API was the only place that still needed <code>cheerio</code>.</p><p>Shipping both parsers was costly, because <code>cheerio</code> was loaded at startup on every platform. It added roughly 1.35 MB of bundled code to the server and desktop builds, and roughly 370 kB to the in-browser build, where it was loaded into the database worker before the application could start.</p><h2>Migration</h2><p>Replace <code>api.cheerio</code> calls with <code>api.htmlParser</code>. Note that <code>api.htmlParser</code> returns plain elements rather than a wrapped collection, so there is no <code>$</code> object and no chaining.</p><h3>Reading values</h3><p>Before (<code>cheerio</code>):</p><pre><code class=\"language-text-javascript\">const $ = api.cheerio.load(html);\nconst title = $('h1').text();\nconst links = $('a').map((i, el) =&gt; $(el).attr('href')).get();</code></pre><p>After (<code>htmlParser</code>):</p><pre><code class=\"language-text-javascript\">const root = api.htmlParser.parse(html);\nconst title = root.querySelector('h1')?.textContent;\nconst links = root.querySelectorAll('a').map(a =&gt; a.getAttribute('href'));</code></pre><h3>Modifying the document</h3><p>Before (<code>cheerio</code>):</p><pre><code class=\"language-text-javascript\">const $ = api.cheerio.load(html);\n$('a').each((i, el) =&gt; {\n $(el).attr('href', '#root/' + noteId);\n $(el).addClass('reference-link');\n});\nnote.setContent($('body').html());</code></pre><p>After (<code>htmlParser</code>):</p><pre><code class=\"language-text-javascript\">const root = api.htmlParser.parse(html);\nfor (const el of root.querySelectorAll('a')) {\n el.setAttribute('href', '#root/' + noteId);\n el.classList.add('reference-link');\n}\nnote.setContent(root.toString());</code></pre><h3>Equivalent operations</h3><figure class=\"table\"><table><thead><tr><th><code>cheerio</code></th><th><code>htmlParser</code></th></tr></thead><tbody><tr><td><code>api.cheerio.load(html)</code></td><td><code>api.htmlParser.parse(html)</code></td></tr><tr><td><code>$('sel')</code></td><td><code>root.querySelectorAll('sel')</code></td></tr><tr><td><code>$('sel').first()</code></td><td><code>root.querySelector('sel')</code></td></tr><tr><td><code>$el.text()</code></td><td><code>el.textContent</code></td></tr><tr><td><code>$el.html()</code></td><td><code>el.innerHTML</code></td></tr><tr><td><code>$el.attr('name')</code></td><td><code>el.getAttribute('name')</code></td></tr><tr><td><code>$el.attr('name', value)</code></td><td><code>el.setAttribute('name', value)</code></td></tr><tr><td><code>$el.addClass('name')</code></td><td><code>el.classList.add('name')</code></td></tr><tr><td><code>$('body').html()</code></td><td><code>root.toString()</code></td></tr></tbody></table></figure>",
++ "_help_YeOa2l7Pu39I": "<h2>Introduction</h2><p>Before v0.104.0, code executed at renderer level (e.g. front-end scripts) could directly require <code>@electron/remote</code> or even Node.js APIs (e.g. <code>process</code> or <code>fs</code>). While this makes them powerful, it also exposes a significant attack surface — any XSS or untrusted script in a note becomes remote code execution on the host.</p><p>To mitigate this, the client-side no longer has access to these APIs and everything must go through the&nbsp;<a class=\"reference-link\" href=\"{{helpAssets}}/User%20Guide/Scripting/Script%20API/Electron%20API.dat\">Electron API</a>&nbsp;instead.</p><aside class=\"admonition note\"><p>If this API change is causing issues with some of your front-end scripts, consider:</p><ul><li>Interacting with&nbsp;<a class=\"reference-link\" href=\"#root/_help_SPirpZypehBG\">Backend scripts</a>&nbsp;which have a greater degree of freedom.</li><li><a href=\"#root/_help_wy8So3yZZlH9\">Reporting</a> it as a feature request.</li></ul></aside><h2>Overview of the API</h2><p>The Frontend and Backend APIs reside in a global variable, <code>api</code>, that can be used anywhere in the script. For example, to display a message to the user the following front-end script can be used:</p><pre><code class=\"language-text-javascript\">api.showMessage(\"Hello world.\");</code></pre><p>The Electron API is different: it lives on <code>window.electronApi</code> (exposed by the desktop preload script), not on <code>api</code>, and is only available in the Electron desktop build. Frontend scripts that use it should guard with <code>if (window.electronApi)</code> so they degrade cleanly in the browser and standalone (WASM) builds.</p><pre><code class=\"language-text-javascript\">window.electronApi?.window.setZoomFactor(1.2);</code></pre><h2>Additional protection</h2><p>Some of the APIs have additional safe-guards built in which prevent unauthorized access.</p><p>The <code>shell</code> group is the most heavily validated: <code>openExternal</code> is restricted to an allowlisted set of URL schemes (blocking <code>file:</code>, <code>smb:</code>, Follina-class schemes, etc.), <code>openPath</code> must resolve under the Trilium data directory or temporary directory, and <code>downloadURL</code> is locked to the app's own origin. Invalid input throws on the main side rather than being silently passed through.</p>",
++ "_help_fqAK6opjUagR": "<p>The <code>api.axios</code> library has been removed from the backend scripting API.</p><p>Scripts that attempt to use <code>api.axios</code> will now throw an error with migration instructions.</p><h2>Reasoning</h2><p>Axios was marked as deprecated at least since April 2024 in favor of the native <code>fetch()</code> API, which is available in both browser and Node.js environments. After two years of deprecation, the library was removed following the <a href=\"https://www.malwarebytes.com/blog/news/2026/03/axios-supply-chain-attack-chops-away-at-npm-trust\">March 2026 npm supply chain compromise</a>, where attackers published malicious versions that deployed a remote access trojan. The Trilium's main developer almost got compromised, but <code>pnpm</code> not trusting unknown post-install scripts successfully avoided that.</p><h2>Migration</h2><p>Replace <code>api.axios</code> calls with the native <code>fetch()</code> API.</p><h3><code>GET</code> calls</h3><p>Before (Axios):</p><pre><code class=\"language-text-javascript\">const response = await api.axios.get('https://api.example.com/data');\nconst data = response.data;</code></pre><p>After (<code>fetch</code>):</p><pre><code class=\"language-text-javascript\">const response = await fetch('https://api.example.com/data');\nconst data = await response.json();</code></pre><h3><code>POST</code> calls</h3><p>Before (Axios):</p><pre><code class=\"language-text-javascript\">await api.axios.post('https://api.example.com/data', { key: 'value' });</code></pre><p>After (fetch):</p><pre><code class=\"language-text-javascript\">await fetch('https://api.example.com/data', {\n method: 'POST',\n headers: { 'Content-Type': 'application/json' },\n body: JSON.stringify({ key: 'value' })\n});</code></pre>",
++ "_help_pAJ0jWz16xFm": "<p>The <code>api.cheerio</code> library is deprecated and will be removed in a future version.</p><aside class=\"admonition note\"><p><code>cheerio</code> was removed in v0.106.0. See <a class=\"reference-link\" href=\"#root/_help_kTx7WqLdZ3Ry\">v0.106.0: Removal of cheerio</a> for the full migration guide.</p></aside><h2>Reasoning</h2><p>Cheerio is only used for the scripting API while the server internally uses <code>node-html-parser</code> for HTML parsing. Removing <code>cheerio</code> reduces bundle size and maintenance overhead.</p><h2>Migration</h2><p>Before (<code>cheerio</code>):</p><pre><code class=\"language-text-javascript\">const $ = api.cheerio.load(html);\nconst title = $('h1').text();\nconst links = $('a').map((i, el) =&gt; $(el).attr('href')).get();</code></pre><p>After (<code>htmlParser</code>):</p><pre><code class=\"language-text-javascript\">const root = api.htmlParser.parse(html);\nconst title = root.querySelector('h1')?.textContent;\nconst links = root.querySelectorAll('a').map(a =&gt; a.getAttribute('href'));</code></pre>",
++ "_help_72dxvnbnkDFY": "<p>jQuery 4 removes legacy browser support (such as IE11 support), but it also removes some APIs that are considered deprecated such as:</p><blockquote><p><code>jQuery.isArray</code>, <code>jQuery.parseJSON</code>, <code>jQuery.trim</code>, <code>jQuery.type</code>, <code>jQuery.now</code>, <code>jQuery.isNumeric</code>, <code>jQuery.isFunction</code>, <code>jQuery.isWindow</code>, <code>jQuery.camelCase</code>, <code>jQuery.nodeName</code>, <code>jQuery.cssNumber</code>, <code>jQuery.cssProps</code>, and <code>jQuery.fx.interval</code>.</p><p>Use native equivalents like <code>Array.isArray()</code>, <code>JSON.parse()</code>, <code>String.prototype.trim()</code>, and <code>Date.now()</code> instead.</p></blockquote><p>This may affect custom scripts if they (or the custom jQuery libraries used) depend on the deprecated APIs.</p><p>Note that Trilium polyfills <code>jQuery.isArray</code>, <code>isFunction</code> and <code>isPlainObject</code> because they were required by one of our dependencies (the autocomplete).</p><p>For more information, consult <a href=\"https://blog.jquery.com/2026/01/17/jquery-4-0-0/\">the official blog post</a>.</p>",
++ "_help_fiHicjpHjIRJ": "<p>Starting with v0.104.0, some features in Trilium are intentionally disabled in order to reduce the attack surface:</p><ul><li><a class=\"reference-link\" href=\"#root/_help_SPirpZypehBG\">Backend scripts</a>, which can run processes on the server, access the file system or bypass security measures.</li><li><a class=\"reference-link\" href=\"#root/_help_YKWqdJhzi2VY\">SQL Console</a>, which can be used to exfiltrate important data such as the document secret or cause irreparable damage to the database.</li><li><a class=\"reference-link\" href=\"#root/_help_swSFivWk6KkA\">Network Access</a>&nbsp;for the&nbsp;<a class=\"reference-link\" href=\"#root/_help_poXkQfguuA0U\">Desktop Installation</a>.</li></ul><p>To activate any of them, there are three variants:</p><ul><li>For the desktop app, go to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a>&nbsp;→ <em>Security</em> and toggle the desired option.<ul><li>This will prompt a system dialog confirming the change. Note that scripts could potentially call this confirmation dialog as well, make sure to accept it only if enabling any of these features is required.</li><li>The settings page will be available for the server-side as well, but the options need to be manually toggled using the other mechanisms described here.</li><li>This works by setting a separate configuration file in the&nbsp;<a class=\"reference-link\" href=\"#root/_help_tAassRL4RSQL\">Data directory</a>.</li></ul></li><li>In <a href=\"#root/_help_Gzjqa934BdH4\">config.ini</a>, set the corresponding option under the <code>Security</code> group.</li><li>Or use environment variables (e.g. <code>TRILIUM_SECURITY_BACKEND_SCRIPTING_ENABLED=true</code>).</li></ul>",
+ "_help_WFbFXrgnDyyU": "<h3>Trilium Notes</h3><p>Trilium Notes does not collect/send any data from the user's installation, i.e. no analytics, no telemetry etc. The data flows only between user controlled / installed applications, without any intermediary.</p><p>Automatic network activity consists of:</p><ul><li>Trilium periodically queries URL <a href=\"https://github.com/TriliumNext/Trilium/releases\">https://github.com/TriliumNext/Trilium/releases</a> to see if there's a new stable version released. (check only, there's no automatic download and/or installation).</li><li>Trilium will download spelling dictionaries automatically as needed based on language settings</li></ul><h3>Trilium Web Clipper</h3><p>Trilium Web Clipper does not collect/send any data from the user's installation, i.e. no analytics, no telemetry etc. The data flows only between user controlled / installed applications, without any intermediary.</p><h3>Trilium Sender for Android</h3><p>Trilium Sender for Android does not collect/send any data from the user's installation, i.e. no analytics, no telemetry etc. The data flows only between user controlled / installed applications, without any intermediary.</p>",
- "_help_NcsmUYZRWEW4": "<aside class=\"admonition note\"><p>This article is a description of the original author of Trilium (zadam) in regards with his own knowledge base.</p></aside><p>This page contains description of some of the patterns I use to organize information in my knowledge base. This is meant to give some inspiration of how one might create and structure their knowledge base in general and also specifically in Trilium Notes. It also gives some background and justification for some of the design decisions.</p><h2>Meta patterns</h2><p>Just to be clear, meta patterns are \"patterns of patterns\", i.e. patterns appearing in other patterns.</p><h3>Hierarchical organization of information</h3><p>Basic meta pattern is that I sort notes (units of information) into a hierarchy - I have some \"top level\" notes which represent coarse grained organization, these then split into sub-notes defining finer grained organization and so on. I consider this hierarchical (tree) organization very efficient for organization of large amounts of information. A lot of note taking software (such as Evernote) are frustratingly limited in this regard which limits scalability of the software to large amounts of notes.</p><h4>Scalability</h4><p>It's important to frame the following (meta) patterns with some idea of how large amount of data are we talking about.</p><p>My rule of thumb for estimation of size of personal knowledge base is that you can reasonably produce around 10 notes a day, which is 3650 in a year. I plan to use my knowledge base long term (with or without Trilium Notes), probably decades so you can easily get to number 100 000 or even more. Right now, my personal knowledge base has around 10 000 notes.</p><p>100 000 is a number to which most note taking software doesn't scale well (in both performance and UI). Yet I don't think it's really very much considering a lifetime of knowledge.</p><h4>Lazy hierarchy</h4><p>My approach to creating the hierarchy is being lazy - I don't create the structure first and then fill it with notes, instead I create single note for some specific topic and start using this one note. Once the content starts to grow, and I see how <em>some</em> parts could be split out, I move them out into separate sub notes. As an example I have a book review for <em>The Fellowship of the Ring</em>:</p><ul><li>Book reviews<ul><li>The Fellowship of the Ring</li></ul></li></ul><p>The note contains basic book info (author, publisher etc.), book highlights with the comments and then overall review. Now it turns out there's far too many book highlights and overall review is also rather long, so I want to change the structure to the following:</p><ul><li>Book reviews<ul><li>The Fellowship of the Ring &nbsp; &nbsp; &nbsp;&nbsp;<em>(still contains basic info)</em><ul><li>Highlights</li><li>Review</li></ul></li></ul></li></ul><p>If I used standard text file stored in a filesystem I would soon run into an annoying problem that in order to split out the Highlights and Review into sub-notes I would also have to convert <em>The Fellowship of the Ring</em> from text file into directory and split out all sections of the note into sub-notes. Instead, Trilium treats all notes as equal - both leaf notes and inner notes can have both text content which allows me to sub-structure only content which needs it.</p><h3>Sorting notes into multiple places in the hierarchy</h3><p>While organizing the notes into the hierarchy, you very quickly run into a dilemma - your note seem to belong to two places in the hierarchy equally. As an example - you want to make a note about <a href=\"https://en.wikipedia.org/wiki/Bash_(Unix_shell)\">bash</a> - does it belong to \"OS / Linux\" or \"Programming / Scripting languages\"? This is actually a false dichotomy forced down by the limits of the basic tree hierarchy - the answer is <em>of course it belongs to both</em>. This is the reason why Trilium doesn't use standard tree structure (which requires every note to have exactly one parent), but an extension which allows every note to have several parents, thus effectively allowing it to appear in multiple places in the hierarchy. For lack of better term I call this \"cloning\". The main problem with this term is that it suggests that each clone must have an original, but here all clones are completely equal - effectively there's no original.</p><p>In tech lingo, it might be better to describe it as a <a href=\"https://en.wikipedia.org/wiki/Hard_link\">hard link</a> with an important difference that it is possible to hard link (clone) a directory (inner note).</p><h3>Protected notes</h3><p>I have Trilium Notes opened non-stop. Sometimes I forget to lock my computer when going to the bathroom. Sometimes I let a friend or family member to use my computer for a minute without supervision. They might click on (running) Trilium and inadvertently see a note I really don't want anybody to see (personal diary, credentials). To cover this, Trilium has a concept of \"<a href=\"https://github.com/zadam/trilium/wiki/Protected-notes\">protected notes</a>\" - protected note is encrypted and on top of that requires the user to enter the password every 5 minutes which guarantees that such note can be in a readable state only for small amount of time. Working with ordinary (not protected) notes don't require password so you're not bothered by extra security when it's not needed.</p><h3>Archiving notes</h3><p>Notes can lose relevancy with time - let's say I switch jobs - all the notes specific to the former employer immediately lose most of its import. This doesn't mean I want to delete these notes though - typically I just want them to somehow deprioritize - in Trilium I would do that by assigning an <a href=\"https://github.com/zadam/trilium/wiki/Attribute-inheritance\">inherited</a> <a href=\"https://github.com/zadam/trilium/wiki/Attributes\">label</a> <code spellcheck=\"false\">archived</code> to the company root note. The main effect of this label is that all the notes from this sub-tree are filtered out from search results (fast search via note autocomplete is my main <a href=\"https://github.com/zadam/trilium/wiki/Note-navigation\">navigation approach</a>). Apart from this, I also typically move such outdated notes to some less prominent place in the hierarchy.</p><p>I use archivation also for notes which are not very relevant from their creation - an example might be automatically imported reddit comments.</p><p>Sometimes there's no clear <em>category</em> split between relevant and non-relevant notes, in that case I just create \"<em>OLD</em>\" note with <code spellcheck=\"false\">archived</code> label and move all irrelevant notes there. So my credentials note might look something like this:</p><ul><li>Credentials<ul><li>Personal<ul><li>OLD &nbsp; &nbsp; &nbsp;&nbsp;<em>(contains a bunch of notes with credentials for services I don't use anymore)</em></li><li>Gmail</li><li>Github</li><li>...</li></ul></li></ul></li></ul><h2>Patterns</h2><h3>Day note</h3><p>Every day has its note which contains or references everything related to the given day. Structure looks like this:</p><ul><li>2018<ul><li>11 - November<ul><li>26 - Monday</li><li>27 - Tuesday<ul><li>subnote 1</li></ul></li></ul></li></ul></li></ul><p>Day note serves as a workspace and note inbox at the same time - it's the default location to create a note when I don't have time to think about proper placement. At the end of the day I typically review my day note and clone the notes into suitable locations in the hierarchy.</p><p>Trilium has this pattern partly built-in - Trilium understands and can create this Year / Month / Day structure semi-automatically (on API call). There's also global keyboard shortcut <code spellcheck=\"false\">CTRL-ALT-P</code> which will create new note in the day note.</p><p>What notes do I keep under this day note?</p><ul><li>TODO list for given day (this can be automated - see&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYjQUYhpbUEW\">Task Manager</a>)</li><li>Personal diary</li><li><a href=\"#root/_help_IakOLONlIfGI\">clones</a> of notes I created during this day (which kind of represents what I've been working on).</li><li>I often clone notes (or sub-trees) of e.g. projects I'm working on at given day so they are at hand</li><li>I have some <a href=\"#root/_help_CdNpE2pqjmI6\">scripts</a> which allow me to track certain daily metrics (like weight). These are saved into one daily \"data note\" (actually JSON <a href=\"#root/_help_6f9hih2hXXZk\">code note</a>).<ul><li>I have other scripts which then help me to visualize these data (see a&nbsp;<a class=\"reference-link\" href=\"#root/_help_R7abl2fc6Mxi\">Weight Tracker</a>&nbsp;example)</li><li>I have a script which automatically imports all my comments from reddit into the day note.<ul><li>People are sometimes wondering why. The answer is that I usually put some effort and thought into a comment and that's why I feel it's worth preserving, especially if it can be done automatically.</li></ul></li></ul></li></ul><p>For most notes, this day note placement is <em>secondary</em> and their primary location is somewhere else (e.g. for a book review I've been working on it's <em>Book / Reviews</em>, not the day note). So for this pattern to work, ability to <a href=\"#root/_help_IakOLONlIfGI\">clone</a> notes into multiple places is pretty fundamental.</p><h3>Projects</h3><p><em>Project</em> is pretty self-explanatory, for me specifically it also means being long term (years) - an example of a project might be Trilium Notes or university studies. Given their longevity, projects can be large and deep, but their structure is very domain specific, and I don't see any common patterns. What's pretty clear is they are often widely interconnected with other parts of the knowledge base - e.g. university credentials are cloned from \"Credentials / University\" top level notes and Trilium related blog posts are in \"Blog / [Name of the blog] / Trilium\".</p><p><em>Epics</em> are the same thing as projects, but differ in scope - they are typically several months long and as such are usually placed into a year note (e.g. <em>2018 / Epics</em>). Epics are often of work nature (also cloned into work note) and personal (e.g. currently I have large epic for moving to a different city).</p><p>I don't have a term for short term projects (typically several days long), but continuing the scrum analogy I might call them <em>story</em>. These are often placed directly into day notes and manually moved from one day to another (or place into a month note, e.g. <em>2018 / 11 - November</em>).</p><h3>Credentials</h3><p>I keep all my credentials in the knowledge base, they are sorted into categories - work related, project related, personal per country etc. These notes are of course <a href=\"#root/_help_bwg0e8ewQMak\">protected</a> and are often cloned into other places (e.g. project credentials are cloned into the project itself). This is a pretty important advantage compared to traditional tools like KeePass - all the relevant information is centralized into one place without compromising security.</p><h3>People profiles</h3><p>This might seem creepy to some, but I keep a profile on most people. It contains pretty standard things like date of birth, contacts, address, but also current and previous employments, their hobbies and worldviews and sometimes even important (IM/mail/meatspace) conversations. Just about everything I find notable. It helps to refresh some basic info before meeting people, especially if you haven't been in touch in a while. It gets pretty awkward to ask for the tenth time where do they work for example, because you keep forgetting it.</p><p>Naturally I have a lot of (extended) family members, friends, acquaintances etc. so I need some way to sort them. My main method is to sort them by social circle (work, high school, sports club etc.), sometimes also by their town of residence. Family <em>circle</em> is still too large so the further organization is by <em>clan</em> (as in \"Smiths\"). Some people are members of several such circles, so they are just cloned into multiple places.</p><p>For family specifically it's pretty useful to create a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iRwzGnHPzonm\">Relation Map</a>&nbsp;to visualize relationships:</p><figure class=\"image\"><img style=\"aspect-ratio:941/758;\" src=\"{{helpAssets}}/User%20Guide/Miscellaneous/Patterns%20of%20personal%20knowledge_relation-map-family.png\" width=\"941\" height=\"758\"></figure><h3>Books</h3><p>Of course, I keep standard \"To read\" list. I also keep a record on the books I've read - typically one book has one subtree where the root has some basic info like author, page count, publication date, date started, date finished (in the form of&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>). I also write a (private) review and keep list of highlights from Kindle, optionally with some commentary, these are usually stored in sub notes (unless they are pretty short).</p><p>To keep the list of books manageable, I sort them per year (of reading them), this also gives me some basic overview of \"reading performance\" for given year. I plan to create a <a href=\"#root/_help_CdNpE2pqjmI6\">script</a> which would show some timeline chart visualizing book attributes <code spellcheck=\"false\">dateStarted</code> - <code spellcheck=\"false\">dateFinished</code> to have nicer view of my reading sprints and trends.</p><p>Some specific authors also have their own note which contains cloned book reviews, links to interviews and other related resources.</p><p>I have similar system for movies and TV shows, but not as sophisticated.</p><h3>Personal diary</h3><p>This is a place to reflect on events, experiences, new findings etc. This can help you get deeper understanding of your inner self, clarify your thinking and make better decisions as a result.</p><p>I sort personal diary notes directly under <em>day note</em> (explained above), but it can be cloned also to e.g. \"trip note\" (if the diary note is about given trip) or to person's profile (if the person plays a role in the diary note). All my diary notes are <a href=\"#root/_help_bwg0e8ewQMak\">protected</a> since they are usually pretty sensitive.</p><h3>Documents</h3><p>I keep all my personal documents (ID, passport, education certificates ...) scanned in the knowledge base. They are <a href=\"#root/_help_cbkrhQjrkKrh\">synchronized</a> across every PC which provides decent backup and makes them available everywhere.</p><p>Advantage compared to e.g. keeping them in Dropbox or Google Drive is that they are not stored on some 3rd party server and they can be encrypted (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_bwg0e8ewQMak\">Protected Notes</a>).</p><h3>Inventory</h3><p>Inventory contains documents and other relevant importation for my important belongings - e.g. for car you can keep the registration card, maintenance record, related costs etc. I also keep inventory for some items personally important to me - mainly computers, phones, cameras and similar electronics. This can be practical at times but also provides sentimental value.</p><h3>Topic knowledge base</h3><p>This where I store hard \"knowledge\" - summarized topics and findings from different domains. Topics can range from traditional sciences - physics, history, economy to philosophy, mental models, apps (notes about specific apps I use) etc. Of course this is very subjective - given what I do, my Physics sub-tree is pretty sparse compared to my Programming subtree.</p><h3>Work knowledge base</h3><p>I usually keep top level note for the company I currently work at (past jobs are moved elsewhere). I track basic organization of the company (divisions, business units), who is who (<a class=\"reference-link\" href=\"#root/_help_iRwzGnHPzonm\">Relation Map</a>) are again useful for visualization), projects I work at etc.</p><p>There's a number of credentials to various company services I need to use. Companies usually have a bunch of complex processes and tools. I record meeting minutes, link to the company wiki (which is usually difficult to find relevant info). In general there's a lot of company specific information I need to know or need have them at hand in a nice structure I can understand. Often it's just copy pasting and reshuffling of existing information into something more understandable for me.</p><p>From my experience, keeping this makes me more productive and even more importantly dramatically reduces frustration and stress.</p><h2>Conclusion</h2><p>I could probably go on with more patterns (e.g. study notes, travelling), but I think you get the idea. Whatever is important in your life, it probably makes sense to document and track it.</p>",
++ "_help_NcsmUYZRWEW4": "<aside class=\"admonition note\"><p>This article is a description of the original author of Trilium (zadam) in regards with his own knowledge base.</p></aside><p>This page contains description of some of the patterns I use to organize information in my knowledge base. This is meant to give some inspiration of how one might create and structure their knowledge base in general and also specifically in Trilium Notes. It also gives some background and justification for some of the design decisions.</p><h2>Meta patterns</h2><p>Just to be clear, meta patterns are \"patterns of patterns\", i.e. patterns appearing in other patterns.</p><h3>Hierarchical organization of information</h3><p>Basic meta pattern is that I sort notes (units of information) into a hierarchy - I have some \"top level\" notes which represent coarse grained organization, these then split into sub-notes defining finer grained organization and so on. I consider this hierarchical (tree) organization very efficient for organization of large amounts of information. A lot of note taking software (such as Evernote) are frustratingly limited in this regard which limits scalability of the software to large amounts of notes.</p><h4>Scalability</h4><p>It's important to frame the following (meta) patterns with some idea of how large amount of data are we talking about.</p><p>My rule of thumb for estimation of size of personal knowledge base is that you can reasonably produce around 10 notes a day, which is 3650 in a year. I plan to use my knowledge base long term (with or without Trilium Notes), probably decades so you can easily get to number 100 000 or even more. Right now, my personal knowledge base has around 10 000 notes.</p><p>100 000 is a number to which most note taking software doesn't scale well (in both performance and UI). Yet I don't think it's really very much considering a lifetime of knowledge.</p><h4>Lazy hierarchy</h4><p>My approach to creating the hierarchy is being lazy - I don't create the structure first and then fill it with notes, instead I create single note for some specific topic and start using this one note. Once the content starts to grow, and I see how <em>some</em> parts could be split out, I move them out into separate sub notes. As an example I have a book review for <em>The Fellowship of the Ring</em>:</p><ul><li>Book reviews<ul><li>The Fellowship of the Ring</li></ul></li></ul><p>The note contains basic book info (author, publisher etc.), book highlights with the comments and then overall review. Now it turns out there's far too many book highlights and overall review is also rather long, so I want to change the structure to the following:</p><ul><li>Book reviews<ul><li>The Fellowship of the Ring &nbsp; &nbsp; &nbsp;&nbsp;<em>(still contains basic info)</em><ul><li>Highlights</li><li>Review</li></ul></li></ul></li></ul><p>If I used standard text file stored in a filesystem I would soon run into an annoying problem that in order to split out the Highlights and Review into sub-notes I would also have to convert <em>The Fellowship of the Ring</em> from text file into directory and split out all sections of the note into sub-notes. Instead, Trilium treats all notes as equal - both leaf notes and inner notes can have both text content which allows me to sub-structure only content which needs it.</p><h3>Sorting notes into multiple places in the hierarchy</h3><p>While organizing the notes into the hierarchy, you very quickly run into a dilemma - your note seem to belong to two places in the hierarchy equally. As an example - you want to make a note about <a href=\"https://en.wikipedia.org/wiki/Bash_(Unix_shell)\">bash</a> - does it belong to \"OS / Linux\" or \"Programming / Scripting languages\"? This is actually a false dichotomy forced down by the limits of the basic tree hierarchy - the answer is <em>of course it belongs to both</em>. This is the reason why Trilium doesn't use standard tree structure (which requires every note to have exactly one parent), but an extension which allows every note to have several parents, thus effectively allowing it to appear in multiple places in the hierarchy. For lack of better term I call this \"cloning\". The main problem with this term is that it suggests that each clone must have an original, but here all clones are completely equal - effectively there's no original.</p><p>In tech lingo, it might be better to describe it as a <a href=\"https://en.wikipedia.org/wiki/Hard_link\">hard link</a> with an important difference that it is possible to hard link (clone) a directory (inner note).</p><h3>Protected notes</h3><p>I have Trilium Notes opened non-stop. Sometimes I forget to lock my computer when going to the bathroom. Sometimes I let a friend or family member to use my computer for a minute without supervision. They might click on (running) Trilium and inadvertently see a note I really don't want anybody to see (personal diary, credentials). To cover this, Trilium has a concept of \"<a href=\"https://github.com/zadam/trilium/wiki/Protected-notes\">protected notes</a>\" - protected note is encrypted and on top of that requires the user to enter the password every 5 minutes which guarantees that such note can be in a readable state only for small amount of time. Working with ordinary (not protected) notes don't require password so you're not bothered by extra security when it's not needed.</p><h3>Archiving notes</h3><p>Notes can lose relevancy with time - let's say I switch jobs - all the notes specific to the former employer immediately lose most of its import. This doesn't mean I want to delete these notes though - typically I just want them to somehow deprioritize - in Trilium I would do that by assigning an <a href=\"https://github.com/zadam/trilium/wiki/Attribute-inheritance\">inherited</a> <a href=\"https://github.com/zadam/trilium/wiki/Attributes\">label</a> <code>archived</code> to the company root note. The main effect of this label is that all the notes from this sub-tree are filtered out from search results (fast search via note autocomplete is my main <a href=\"https://github.com/zadam/trilium/wiki/Note-navigation\">navigation approach</a>). Apart from this, I also typically move such outdated notes to some less prominent place in the hierarchy.</p><p>I use archivation also for notes which are not very relevant from their creation - an example might be automatically imported reddit comments.</p><p>Sometimes there's no clear <em>category</em> split between relevant and non-relevant notes, in that case I just create \"<em>OLD</em>\" note with <code>archived</code> label and move all irrelevant notes there. So my credentials note might look something like this:</p><ul><li>Credentials<ul><li>Personal<ul><li>OLD &nbsp; &nbsp; &nbsp;&nbsp;<em>(contains a bunch of notes with credentials for services I don't use anymore)</em></li><li>Gmail</li><li>Github</li><li>...</li></ul></li></ul></li></ul><h2>Patterns</h2><h3>Day note</h3><p>Every day has its note which contains or references everything related to the given day. Structure looks like this:</p><ul><li>2018<ul><li>11 - November<ul><li>26 - Monday</li><li>27 - Tuesday<ul><li>subnote 1</li></ul></li></ul></li></ul></li></ul><p>Day note serves as a workspace and note inbox at the same time - it's the default location to create a note when I don't have time to think about proper placement. At the end of the day I typically review my day note and clone the notes into suitable locations in the hierarchy.</p><p>Trilium has this pattern partly built-in - Trilium understands and can create this Year / Month / Day structure semi-automatically (on API call). There's also global keyboard shortcut <code>CTRL-ALT-P</code> which will create new note in the day note.</p><p>What notes do I keep under this day note?</p><ul><li>TODO list for given day (this can be automated - see&nbsp;<a class=\"reference-link\" href=\"#root/_help_xYjQUYhpbUEW\">Task Manager</a>)</li><li>Personal diary</li><li><a href=\"#root/_help_IakOLONlIfGI\">clones</a> of notes I created during this day (which kind of represents what I've been working on).</li><li>I often clone notes (or sub-trees) of e.g. projects I'm working on at given day so they are at hand</li><li>I have some <a href=\"#root/_help_CdNpE2pqjmI6\">scripts</a> which allow me to track certain daily metrics (like weight). These are saved into one daily \"data note\" (actually JSON <a href=\"#root/_help_6f9hih2hXXZk\">code note</a>).<ul><li>I have other scripts which then help me to visualize these data (see a&nbsp;<a class=\"reference-link\" href=\"#root/_help_R7abl2fc6Mxi\">Weight Tracker</a>&nbsp;example)</li><li>I have a script which automatically imports all my comments from reddit into the day note.<ul><li>People are sometimes wondering why. The answer is that I usually put some effort and thought into a comment and that's why I feel it's worth preserving, especially if it can be done automatically.</li></ul></li></ul></li></ul><p>For most notes, this day note placement is <em>secondary</em> and their primary location is somewhere else (e.g. for a book review I've been working on it's <em>Book / Reviews</em>, not the day note). So for this pattern to work, ability to <a href=\"#root/_help_IakOLONlIfGI\">clone</a> notes into multiple places is pretty fundamental.</p><h3>Projects</h3><p><em>Project</em> is pretty self-explanatory, for me specifically it also means being long term (years) - an example of a project might be Trilium Notes or university studies. Given their longevity, projects can be large and deep, but their structure is very domain specific, and I don't see any common patterns. What's pretty clear is they are often widely interconnected with other parts of the knowledge base - e.g. university credentials are cloned from \"Credentials / University\" top level notes and Trilium related blog posts are in \"Blog / [Name of the blog] / Trilium\".</p><p><em>Epics</em> are the same thing as projects, but differ in scope - they are typically several months long and as such are usually placed into a year note (e.g. <em>2018 / Epics</em>). Epics are often of work nature (also cloned into work note) and personal (e.g. currently I have large epic for moving to a different city).</p><p>I don't have a term for short term projects (typically several days long), but continuing the scrum analogy I might call them <em>story</em>. These are often placed directly into day notes and manually moved from one day to another (or place into a month note, e.g. <em>2018 / 11 - November</em>).</p><h3>Credentials</h3><p>I keep all my credentials in the knowledge base, they are sorted into categories - work related, project related, personal per country etc. These notes are of course <a href=\"#root/_help_bwg0e8ewQMak\">protected</a> and are often cloned into other places (e.g. project credentials are cloned into the project itself). This is a pretty important advantage compared to traditional tools like KeePass - all the relevant information is centralized into one place without compromising security.</p><h3>People profiles</h3><p>This might seem creepy to some, but I keep a profile on most people. It contains pretty standard things like date of birth, contacts, address, but also current and previous employments, their hobbies and worldviews and sometimes even important (IM/mail/meatspace) conversations. Just about everything I find notable. It helps to refresh some basic info before meeting people, especially if you haven't been in touch in a while. It gets pretty awkward to ask for the tenth time where do they work for example, because you keep forgetting it.</p><p>Naturally I have a lot of (extended) family members, friends, acquaintances etc. so I need some way to sort them. My main method is to sort them by social circle (work, high school, sports club etc.), sometimes also by their town of residence. Family <em>circle</em> is still too large so the further organization is by <em>clan</em> (as in \"Smiths\"). Some people are members of several such circles, so they are just cloned into multiple places.</p><p>For family specifically it's pretty useful to create a&nbsp;<a class=\"reference-link\" href=\"#root/_help_iRwzGnHPzonm\">Relation Map</a>&nbsp;to visualize relationships:</p><figure class=\"image\"><img style=\"aspect-ratio:941/758;\" src=\"{{helpAssets}}/User%20Guide/Miscellaneous/Patterns%20of%20personal%20knowledge_relation-map-family.png\" width=\"941\" height=\"758\"></figure><h3>Books</h3><p>Of course, I keep standard \"To read\" list. I also keep a record on the books I've read - typically one book has one subtree where the root has some basic info like author, page count, publication date, date started, date finished (in the form of&nbsp;<a class=\"reference-link\" href=\"#root/_help_OFXdgB2nNk1F\">Promoted Attributes</a>). I also write a (private) review and keep list of highlights from Kindle, optionally with some commentary, these are usually stored in sub notes (unless they are pretty short).</p><p>To keep the list of books manageable, I sort them per year (of reading them), this also gives me some basic overview of \"reading performance\" for given year. I plan to create a <a href=\"#root/_help_CdNpE2pqjmI6\">script</a> which would show some timeline chart visualizing book attributes <code>dateStarted</code> - <code>dateFinished</code> to have nicer view of my reading sprints and trends.</p><p>Some specific authors also have their own note which contains cloned book reviews, links to interviews and other related resources.</p><p>I have similar system for movies and TV shows, but not as sophisticated.</p><h3>Personal diary</h3><p>This is a place to reflect on events, experiences, new findings etc. This can help you get deeper understanding of your inner self, clarify your thinking and make better decisions as a result.</p><p>I sort personal diary notes directly under <em>day note</em> (explained above), but it can be cloned also to e.g. \"trip note\" (if the diary note is about given trip) or to person's profile (if the person plays a role in the diary note). All my diary notes are <a href=\"#root/_help_bwg0e8ewQMak\">protected</a> since they are usually pretty sensitive.</p><h3>Documents</h3><p>I keep all my personal documents (ID, passport, education certificates ...) scanned in the knowledge base. They are <a href=\"#root/_help_cbkrhQjrkKrh\">synchronized</a> across every PC which provides decent backup and makes them available everywhere.</p><p>Advantage compared to e.g. keeping them in Dropbox or Google Drive is that they are not stored on some 3rd party server and they can be encrypted (see&nbsp;<a class=\"reference-link\" href=\"#root/_help_bwg0e8ewQMak\">Protected Notes</a>).</p><h3>Inventory</h3><p>Inventory contains documents and other relevant importation for my important belongings - e.g. for car you can keep the registration card, maintenance record, related costs etc. I also keep inventory for some items personally important to me - mainly computers, phones, cameras and similar electronics. This can be practical at times but also provides sentimental value.</p><h3>Topic knowledge base</h3><p>This where I store hard \"knowledge\" - summarized topics and findings from different domains. Topics can range from traditional sciences - physics, history, economy to philosophy, mental models, apps (notes about specific apps I use) etc. Of course this is very subjective - given what I do, my Physics sub-tree is pretty sparse compared to my Programming subtree.</p><h3>Work knowledge base</h3><p>I usually keep top level note for the company I currently work at (past jobs are moved elsewhere). I track basic organization of the company (divisions, business units), who is who (<a class=\"reference-link\" href=\"#root/_help_iRwzGnHPzonm\">Relation Map</a>) are again useful for visualization), projects I work at etc.</p><p>There's a number of credentials to various company services I need to use. Companies usually have a bunch of complex processes and tools. I record meeting minutes, link to the company wiki (which is usually difficult to find relevant info). In general there's a lot of company specific information I need to know or need have them at hand in a nice structure I can understand. Often it's just copy pasting and reshuffling of existing information into something more understandable for me.</p><p>From my experience, keeping this makes me more productive and even more importantly dramatically reduces frustration and stress.</p><h2>Conclusion</h2><p>I could probably go on with more patterns (e.g. study notes, travelling), but I think you get the idea. Whatever is important in your life, it probably makes sense to document and track it.</p>",
+ "_help_d1Ap6Pg6IjaJ": "<p>GNU AFFERO GENERAL PUBLIC LICENSE<br>Version 3, 19 November 2007</p><p>Copyright (C) 2007 Free Software Foundation, Inc. <a href=\"https://fsf.org/\">https://fsf.org/</a></p><p>Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.</p><h2>Preamble</h2><p>The GNU Affero General Public License is a free, copyleft license for software and other kinds of works, specifically designed to ensure cooperation with the community in the case of network server software.</p><p>The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, our General Public Licenses are intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users.</p><p>When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.</p><p>Developers that use our General Public Licenses protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License which gives you legal permission to copy, distribute and/or modify the software.</p><p>A secondary benefit of defending all users' freedom is that improvements made in alternate versions of the program, if they receive widespread use, become available for other developers to incorporate. Many developers of free software are heartened and encouraged by the resulting cooperation. However, in the case of software used on network servers, this result may fail to come about. The GNU General Public License permits making a modified version and letting the public access it on a server without ever releasing its source code to the public.</p><p>The GNU Affero General Public License is designed specifically to ensure that, in such cases, the modified source code becomes available to the community. It requires the operator of a network server to provide the source code of the modified version running there to the users of that server. Therefore, public use of a modified version, on a publicly accessible server, gives the public access to the source code of the modified version.</p><p>An older license, called the Affero General Public License and published by Affero, was designed to accomplish similar goals. This is a different license, not a version of the Affero GPL, but Affero has released a new version of the Affero GPL which permits relicensing under this license.</p><p>The precise terms and conditions for copying, distribution and modification follow.</p><h2>TERMS AND CONDITIONS</h2><h3>0. Definitions.</h3><p>\"This License\" refers to version 3 of the GNU Affero General Public License.</p><p>\"Copyright\" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.</p><p>\"The Program\" refers to any copyrightable work licensed under this License. Each licensee is addressed as \"you\". \"Licensees\" and \"recipients\" may be individuals or organizations.</p><p>To \"modify\" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a \"modified version\" of the earlier work or a work \"based on\" the earlier work.</p><p>A \"covered work\" means either the unmodified Program or a work based on the Program.</p><p>To \"propagate\" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.</p><p>To \"convey\" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.</p><p>An interactive user interface displays \"Appropriate Legal Notices\" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.</p><h3>1. Source Code.</h3><p>The \"source code\" for a work means the preferred form of the work for making modifications to it. \"Object code\" means any non-source form of a work.</p><p>A \"Standard Interface\" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.</p><p>The \"System Libraries\" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A \"Major Component\", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.</p><p>The \"Corresponding Source\" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.</p><p>The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.</p><p>The Corresponding Source for a work in source code form is that same work.</p><h3>2. Basic Permissions.</h3><p>All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.</p><p>You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.</p><p>Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.</p><h3>3. Protecting Users' Legal Rights From Anti-Circumvention Law.</h3><p>No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.</p><p>When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures.</p><h3>4. Conveying Verbatim Copies.</h3><p>You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.</p><p>You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.</p><h3>5. Conveying Modified Source Versions.</h3><p>You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:</p><ul><li>a) The work must carry prominent notices stating that you modified it, and giving a relevant date.</li><li>b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to \"keep intact all notices\".</li><li>c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.</li><li>d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.</li></ul><p>A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an \"aggregate\" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.</p><h3>6. Conveying Non-Source Forms.</h3><p>You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:</p><ul><li>a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.</li><li>b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.</li><li>c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.</li><li>d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.</li><li>e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.</li></ul><p>A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.</p><p>A \"User Product\" is either (1) a \"consumer product\", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, \"normally used\" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.</p><p>\"Installation Information\" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.</p><p>If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).</p><p>The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.</p><p>Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.</p><h3>7. Additional Terms.</h3><p>\"Additional permissions\" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.</p><p>When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.</p><p>Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:</p><ul><li>a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or</li><li>b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or</li><li>c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or</li><li>d) Limiting the use for publicity purposes of names of licensors or authors of the material; or</li><li>e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or</li><li>f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.</li></ul><p>All other non-permissive additional terms are considered \"further restrictions\" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.</p><p>If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.</p><p>Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.</p><h3>8. Termination.</h3><p>You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).</p><p>However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.</p><p>Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.</p><p>Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.</p><h3>9. Acceptance Not Required for Having Copies.</h3><p>You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.</p><h3>10. Automatic Licensing of Downstream Recipients.</h3><p>Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.</p><p>An \"entity transaction\" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.</p><p>You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.</p><h3>11. Patents.</h3><p>A \"contributor\" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's \"contributor version\".</p><p>A contributor's \"essential patent claims\" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, \"control\" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.</p><p>Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.</p><p>In the following three paragraphs, a \"patent license\" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To \"grant\" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.</p><p>If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. \"Knowingly relying\" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.</p><p>If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.</p><p>A patent license is \"discriminatory\" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.</p><p>Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.</p><h3>12. No Surrender of Others' Freedom.</h3><p>If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.</p><h3>13. Remote Network Interaction; Use with the GNU General Public License.</h3><p>Notwithstanding any other provision of this License, if you modify the Program, your modified version must prominently offer all users interacting with it remotely through a computer network (if your version supports such interaction) an opportunity to receive the Corresponding Source of your version by providing access to the Corresponding Source from a network server at no charge, through some standard or customary means of facilitating copying of software. This Corresponding Source shall include the Corresponding Source for any work covered by version 3 of the GNU General Public License that is incorporated pursuant to the following paragraph.</p><p>Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the work with which it is combined will remain governed by version 3 of the GNU General Public License.</p><h3>14. Revised Versions of this License.</h3><p>The Free Software Foundation may publish revised and/or new versions of the GNU Affero General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.</p><p>Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU Affero General Public License \"or any later version\" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU Affero General Public License, you may choose any version ever published by the Free Software Foundation.</p><p>If the Program specifies that a proxy can decide which future versions of the GNU Affero General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program.</p><p>Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.</p><h3>15. Disclaimer of Warranty.</h3><p>THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.</p><h3>16. Limitation of Liability.</h3><p>IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.</p><h3>17. Interpretation of Sections 15 and 16.</h3><p>If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.</p><p>END OF TERMS AND CONDITIONS</p><h2>How to Apply These Terms to Your New Programs</h2><p>If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.</p><p>To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the \"copyright\" line and a pointer to where the full notice is found.</p><pre><code class=\"language-text-x-trilium-auto\"> &lt;one line to give the program's name and a brief idea of what it does.&gt;\n Copyright (C) &lt;year&gt; &lt;name of author&gt;\n\n This program is free software: you can redistribute it and/or modify\n it under the terms of the GNU Affero General Public License as\n published by the Free Software Foundation, either version 3 of the\n License, or (at your option) any later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n GNU Affero General Public License for more details.\n\n You should have received a copy of the GNU Affero General Public License\n along with this program. If not, see &lt;https://www.gnu.org/licenses/&gt;.</code></pre><p>Also add information on how to contact you by electronic and paper mail.</p><p>If your software can interact with users remotely through a computer network, you should also make sure that it provides a way for users to get its source. For example, if your program is a web application, its interface could display a \"Source\" link that leads users to an archive of the code. There are many ways you could offer source, and different solutions will be better for different programs; see section 13 for the specific requirements.</p><p>You should also get your employer (if you work as a programmer) or school, if any, to sign a \"copyright disclaimer\" for the program, if necessary. For more information on this, and how to apply and follow the GNU AGPL, see <a href=\"https://www.gnu.org/licenses/\">https://www.gnu.org/licenses/</a>.</p>"
+}
diff --cc apps/server/src/assets/help/help_meta.json
index 92bacce25c,0000000000..02bbd9a5c1
mode 100644,000000..100644
--- a/apps/server/src/assets/help/help_meta.json
+++ b/apps/server/src/assets/help/help_meta.json
@@@ -1,4986 -1,0 +1,5351 @@@
+[
+ {
+ "id": "_help_BOCnjTMBCoxW",
+ "title": "Feature Highlights",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/feature-highlights"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-star"
+ }
+ ]
+ },
+ {
+ "id": "_help_Otzi9La2YAUX",
+ "title": "Installation & Setup",
+ "type": "book",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-cog"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_poXkQfguuA0U",
+ "title": "Desktop Installation",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/desktop"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-desktop"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_nRqcgfTb97uV",
+ "title": "Using the desktop application as a server",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/desktop/desktop-as-server"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ },
+ {
+ "id": "_help_Rp0q8bSP6Ayl",
+ "title": "System Requirements",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/desktop/system-requirements"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-chip"
+ }
+ ]
+ },
+ {
+ "id": "_help_Un4wj2Mak2Ky",
+ "title": "Nix flake",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/desktop/nix-flake"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxl-tux"
+ }
+ ]
+ },
+ {
+ "id": "_help_swSFivWk6KkA",
+ "title": "Network Access",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/desktop/network-access"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-network-chart"
+ }
+ ]
+ },
+ {
+ "id": "_help_7iwde4lsKc6O",
+ "title": "Tray icon & automatic startup",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/desktop/tray-icon-and-startup"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ },
+ {
+ "id": "_help_hvRfsDr591WP",
+ "title": "Troubleshooting",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/desktop/troubleshooting"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_WOcw2SLH6tbX",
+ "title": "Server Installation",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/server"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-server"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_Dgg7bR3b6K9j",
+ "title": "1. Installing the server",
+ "type": "book",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/server/installation"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-folder"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_3tW6mORuTHnB",
+ "title": "Packaged version for Linux",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/server/installation/packaged-server"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxl-tux"
+ }
++ ],
++ "children": [
++ {
++ "id": "_help_ZNAjFcxqHr9V",
++ "title": "Simple auto-update for server",
++ "type": "code",
++ "attributes": [
++ {
++ "type": "label",
++ "name": "iconClass",
++ "value": "bx bx-file"
++ }
++ ],
++ "mime": "text/x-sh"
++ }
+ ]
+ },
+ {
+ "id": "_help_rWX5eY045zbE",
+ "title": "Using Docker",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/server/installation/docker"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxl-docker"
+ }
+ ]
+ },
+ {
+ "id": "_help_moVgBcoxE3EK",
+ "title": "On NixOS",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/server/installation/nixos"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxl-tux"
+ }
+ ]
+ },
+ {
+ "id": "_help_J1Bb6lVlwU5T",
+ "title": "Manually",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/server/installation/manual"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-code-alt"
+ }
+ ]
+ },
+ {
+ "id": "_help_DCmT6e7clMoP",
+ "title": "Using Kubernetes",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/server/installation/kubernetes"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxl-kubernetes"
+ }
+ ]
+ },
+ {
+ "id": "_help_klCWNks3ReaQ",
+ "title": "Multiple server instances",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/server/installation/multiple-instances"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-user-account"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_vcjrb3VVYPZI",
+ "title": "2. Reverse proxy",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/server/reverse-proxy"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_ud6MShXL4WpO",
+ "title": "Nginx",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/server/reverse-proxy/nginx"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ },
+ {
+ "id": "_help_fDLvzOx29Pfg",
+ "title": "Apache using Docker",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/server/reverse-proxy/apache"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ },
+ {
+ "id": "_help_LLzSMXACKhUs",
+ "title": "Trusted proxy",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/server/reverse-proxy/trusted-proxy"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ },
+ {
+ "id": "_help_5ERVJb9s4FRD",
+ "title": "Traefik",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/server/reverse-proxy/traefik"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_l2VkvOwUNfZj",
+ "title": "HTTPS (TLS)",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/server/https"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-lock-alt"
+ }
+ ]
+ },
+ {
+ "id": "_help_0hzsNCP31IAB",
+ "title": "Authentication",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/server/auth"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-user"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_lwAX5SvbrK2g",
+ "title": "Resetting your password",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/server/auth/password-reset"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-key"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_7DAiwaf8Z7Rz",
+ "title": "Multi-factor authentication with TOTP",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/server/mfa"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-stopwatch"
+ }
+ ]
+ },
+ {
+ "id": "_help_Un4wj2Mak2Ky",
+ "title": "Nix flake",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxl-tux"
+ }
+ ]
+ },
+ {
+ "id": "_help_x1lQNKQBqLcA",
+ "title": "Signing in with OpenID Connect",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/server/openid-connect"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-key"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_IgkTHSaFfq6A",
+ "title": "Setting up with various providers",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/server/openid-connect/setup"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_yeEaYqosGLSh",
+ "title": "Third-party cloud hosting",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/server/cloud-hosting"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-cloud"
+ }
+ ]
+ },
+ {
+ "id": "_help_iGTnKjubbXkA",
+ "title": "System Requirements",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/server/system-requirements"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-chip"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_cbkrhQjrkKrh",
+ "title": "Synchronization",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/synchronization"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-sync"
+ }
+ ]
+ },
+ {
+ "id": "_help_RDslemsQ6gCp",
+ "title": "Mobile Frontend",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/mobile-frontend"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-mobile-alt"
+ }
+ ]
+ },
+ {
+ "id": "_help_MtPxeAWVAzMg",
+ "title": "Web Clipper",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/web-clipper"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-paperclip"
+ }
+ ]
+ },
+ {
+ "id": "_help_n1lujUxCwipy",
+ "title": "Upgrading TriliumNext",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/upgrading"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-up-arrow-alt"
+ }
+ ]
+ },
+ {
+ "id": "_help_ODY7qQn5m2FT",
+ "title": "Backup",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/backup"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-hdd"
+ }
+ ]
+ },
+ {
+ "id": "_help_tAassRL4RSQL",
+ "title": "Data directory",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/setup/data-directory"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-folder-open"
+ }
+ ]
++ },
++ {
++ "id": "_help_ebyr7ES2SwOW",
++ "title": "Downloaded resources",
++ "type": "text",
++ "attributes": [
++ {
++ "type": "label",
++ "name": "docUrl",
++ "value": "https://docs.triliumnotes.org/user-guide/setup/downloaded-resources"
++ },
++ {
++ "type": "label",
++ "name": "iconClass",
++ "value": "bx bx-download"
++ }
++ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_gh7bpGYxajRS",
+ "title": "Basic Concepts and Features",
+ "type": "book",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-help-circle"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_Vc8PjrjAGuOp",
+ "title": "UI Elements",
+ "type": "book",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/ui"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-window-alt"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_x0JgW8UqGXvq",
+ "title": "Vertical and horizontal layout",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/layouts"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-layout"
+ }
+ ]
+ },
+ {
+ "id": "_help_x3i7MxGccDuM",
+ "title": "Global menu",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/global-menu"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-menu"
+ }
+ ]
+ },
+ {
+ "id": "_help_oPVyFC7WL2Lp",
+ "title": "Note Tree",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/note-tree"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-tree-alt"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_YtSN43OrfzaA",
+ "title": "Note tree contextual menu",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/note-tree/context-menu"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-menu"
+ }
+ ]
+ },
+ {
+ "id": "_help_yTjUdsOi4CIE",
+ "title": "Multiple selection",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/note-tree/multiple-selection"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-list-plus"
+ }
+ ]
+ },
+ {
+ "id": "_help_DvdZhoQZY9Yd",
+ "title": "Keyboard shortcuts",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/note-tree/keyboard-shortcuts"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-keyboard"
+ }
+ ]
+ },
+ {
+ "id": "_help_wyaGBBQrl4i3",
+ "title": "Hiding the subtree",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/note-tree/hiding-subtree"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-hide"
+ }
+ ]
+ }
+ ]
+ },
+ {
- "id": "_help_BlN9DFI679QC",
- "title": "Ribbon",
++ "id": "_help_3seOhtN8uLIY",
++ "title": "Tabs",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
- "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/ribbon"
++ "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/tabs"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
- "value": "bx bx-dots-horizontal"
++ "value": "bx bx-dock-top"
+ }
+ ]
+ },
+ {
- "id": "_help_3seOhtN8uLIY",
- "title": "Tabs",
++ "id": "_help_xYmIYSP6wE3F",
++ "title": "Launch Bar",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
- "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/tabs"
++ "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/launch-bar"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
- "value": "bx bx-dock-top"
++ "value": "bx bx-sidebar"
+ }
+ ]
+ },
+ {
- "id": "_help_xYmIYSP6wE3F",
- "title": "Launch Bar",
++ "id": "_help_8YBEPzcpUgxw",
++ "title": "Note menu",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
- "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/launch-bar"
++ "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/note-menu"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
- "value": "bx bx-sidebar"
++ "value": "bx bx-dots-horizontal-rounded"
+ }
+ ]
+ },
+ {
- "id": "_help_8YBEPzcpUgxw",
++ "id": "_help_1P8QXI5edXNd",
+ "title": "Note buttons",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/note-buttons"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
- "value": "bx bx-dots-vertical-rounded"
++ "value": "bx bx-download"
+ }
+ ]
+ },
+ {
+ "id": "_help_4TIF1oA4VQRO",
+ "title": "Options",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/options"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-cog"
+ }
+ ]
+ },
+ {
+ "id": "_help_luNhaphA37EO",
+ "title": "Split View",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/split-view"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-dock-right"
+ }
+ ]
+ },
- {
- "id": "_help_XpOYSgsLkTJy",
- "title": "Floating buttons",
- "type": "text",
- "attributes": [
- {
- "type": "label",
- "name": "docUrl",
- "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/floating-buttons"
- },
- {
- "type": "label",
- "name": "iconClass",
- "value": "bx bx-rectangle"
- }
- ]
- },
+ {
+ "id": "_help_RnaPdbciOfeq",
+ "title": "Right Sidebar",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/right-sidebar"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-dock-right"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_2dcGDhp9WFKb",
+ "title": "Outline tab",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/right-sidebar/outline"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-list-ul"
+ }
+ ]
+ },
+ {
+ "id": "_help_uNtgN0cUKEBc",
+ "title": "Attributes tab",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/right-sidebar/attributes"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-hash"
+ }
+ ]
+ },
+ {
+ "id": "_help_LrKznOtw9cQD",
+ "title": "AI chat tab",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-bot"
+ }
+ ]
+ },
+ {
+ "id": "_help_KRlZFoIH0j6p",
+ "title": "Connections tab",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/right-sidebar/connections"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-network-chart"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_r5JGHN99bVKn",
+ "title": "Recent Changes",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/recent-changes"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-history"
+ }
+ ]
+ },
+ {
+ "id": "_help_ny318J39E5Z0",
+ "title": "Zoom",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/zoom"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-zoom-in"
+ }
+ ]
+ },
+ {
+ "id": "_help_lgKX7r3aL30x",
+ "title": "Note Tooltip",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/note-tooltip"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-message-detail"
+ }
+ ]
+ },
+ {
- "id": "_help_IjZS7iK5EXtb",
- "title": "New Layout",
++ "id": "_help_SL5f1Auq7sVN",
++ "title": "Note types with split view",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
- "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/new-layout"
++ "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/note-types-with-split-view"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
- "value": "bx bx-layout"
++ "value": "bx bx-card"
+ }
- ],
- "children": [
++ ]
++ },
++ {
++ "id": "_help_t596jLvPrqkS",
++ "title": "Content width",
++ "type": "text",
++ "attributes": [
+ {
- "id": "_help_I6p2a06hdnL6",
- "title": "Breadcrumb",
- "type": "text",
- "attributes": [
- {
- "type": "label",
- "name": "docUrl",
- "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/new-layout/breadcrumb"
- },
- {
- "type": "label",
- "name": "iconClass",
- "value": "bx bx-chevron-right"
- }
- ]
++ "type": "label",
++ "name": "docUrl",
++ "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/content-width"
+ },
+ {
- "id": "_help_AlJ73vBCjWDw",
- "title": "Status bar",
- "type": "text",
- "attributes": [
- {
- "type": "label",
- "name": "docUrl",
- "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/new-layout/status-bar"
- },
- {
- "type": "label",
- "name": "iconClass",
- "value": "bx bx-dock-bottom"
- }
- ]
++ "type": "label",
++ "name": "iconClass",
++ "value": "bx bx-detail"
+ }
+ ]
+ },
+ {
- "id": "_help_SL5f1Auq7sVN",
- "title": "Note types with split view",
++ "id": "_help_jcQVxzYybYgz",
++ "title": "Note contextual menu",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
- "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/note-types-with-split-view"
++ "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/note-context-menu"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
- "value": "bx bx-card"
++ "value": "bx bx-menu"
+ }
+ ]
+ },
+ {
- "id": "_help_t596jLvPrqkS",
- "title": "Content width",
++ "id": "_help_AlJ73vBCjWDw",
++ "title": "Status bar",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
- "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/content-width"
++ "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/status-bar"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
- "value": "bx bx-detail"
++ "value": "bx bx-dock-bottom"
++ }
++ ]
++ },
++ {
++ "id": "_help_I6p2a06hdnL6",
++ "title": "Breadcrumb",
++ "type": "text",
++ "attributes": [
++ {
++ "type": "label",
++ "name": "docUrl",
++ "value": "https://docs.triliumnotes.org/user-guide/concepts/ui/breadcrumb"
++ },
++ {
++ "type": "label",
++ "name": "iconClass",
++ "value": "bx bx-chevron-right"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_BFs8mudNFgCS",
+ "title": "Notes",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/notes"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-notepad"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_l7pigIGu01K2",
+ "title": "Title",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/notes/title"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-text"
+ }
+ ]
+ },
+ {
+ "id": "_help_p9kXRFAkwN4o",
+ "title": "Note Icons & Colors",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/notes/note-icons"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-grid"
+ }
+ ]
+ },
+ {
+ "id": "_help_0vhv7lsOLy82",
+ "title": "Attachments",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/notes/attachments"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-paperclip"
+ }
+ ]
+ },
+ {
+ "id": "_help_IakOLONlIfGI",
+ "title": "Cloning Notes",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/notes/cloning"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-duplicate"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_TBwsyfadTA18",
+ "title": "Branch prefix",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/notes/cloning/branch-prefix"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-rename"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_bwg0e8ewQMak",
+ "title": "Protected Notes",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/notes/protected-notes"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-lock-alt"
+ }
+ ]
+ },
+ {
+ "id": "_help_MKmLg5x6xkor",
+ "title": "Archived Notes",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/notes/archived-notes"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-box"
+ }
+ ]
+ },
+ {
+ "id": "_help_vZWERwf8U3nx",
+ "title": "Note Revisions",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/notes/note-revisions"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-history"
+ }
+ ]
+ },
+ {
+ "id": "_help_aGlEvb9hyDhS",
+ "title": "Sorting Notes",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/notes/sorting"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-sort-up"
+ }
+ ]
+ },
+ {
+ "id": "_help_NRnIZmSMc5sj",
+ "title": "Printing & Exporting as PDF",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/notes/printing-and-pdf-export"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-printer"
+ }
+ ]
+ },
+ {
+ "id": "_help_CoFPLs3dRlXc",
+ "title": "Read-Only Notes",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/notes/read-only-notes"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-edit-alt"
+ }
+ ]
+ },
+ {
+ "id": "_help_0ESUbbAxVnoK",
+ "title": "Note List",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/notes/note-list"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-grid"
+ }
+ ]
+ },
+ {
+ "id": "_help_S0Fos78ZfcY7",
+ "title": "Note Inbox",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/notes/note-inbox"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-inbox"
+ }
+ ]
+ },
+ {
+ "id": "_help_5Ct4MAJTS4tQ",
+ "title": "Restoring Deleted Notes",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/notes/restoring-deleted-notes"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-trash-alt"
+ }
+ ]
++ },
++ {
++ "id": "_help_m3VlURMSeOrd",
++ "title": "New note type switcher",
++ "type": "text",
++ "attributes": [
++ {
++ "type": "label",
++ "name": "docUrl",
++ "value": "https://docs.triliumnotes.org/user-guide/concepts/notes/new-note-type-switcher"
++ },
++ {
++ "type": "label",
++ "name": "iconClass",
++ "value": "bx bxs-widget"
++ }
++ ]
++ },
++ {
++ "id": "_help_B5dihXRDksTk",
++ "title": "Note badges",
++ "type": "text",
++ "attributes": [
++ {
++ "type": "label",
++ "name": "docUrl",
++ "value": "https://docs.triliumnotes.org/user-guide/concepts/notes/note-badges"
++ },
++ {
++ "type": "label",
++ "name": "iconClass",
++ "value": "bx bx-square-rounded"
++ }
++ ]
++ },
++ {
++ "id": "_help_Bsm4fyzPJkSc",
++ "title": "Save status indicator",
++ "type": "text",
++ "attributes": [
++ {
++ "type": "label",
++ "name": "docUrl",
++ "value": "https://docs.triliumnotes.org/user-guide/concepts/notes/save-status-indicator"
++ },
++ {
++ "type": "label",
++ "name": "iconClass",
++ "value": "bx bx-save"
++ }
++ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_wArbEsdSae6g",
+ "title": "Navigation",
+ "type": "book",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/navigation"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-navigation"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_kBrnXNG3Hplm",
+ "title": "Tree Concepts",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/navigation/tree-concepts"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-pyramid"
+ }
+ ]
+ },
+ {
+ "id": "_help_MMiBEQljMQh2",
+ "title": "Note Navigation",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/navigation/note-navigation"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-navigation"
+ }
+ ]
+ },
+ {
+ "id": "_help_Ms1nauBra7gq",
+ "title": "Quick search",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/navigation/quick-search"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-search-alt-2"
+ }
+ ]
+ },
+ {
+ "id": "_help_F1r9QtzQLZqm",
+ "title": "Jump to & command palette",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/navigation/jump-to"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-send"
+ }
+ ]
+ },
+ {
+ "id": "_help_eIg8jdvaoNNd",
+ "title": "Search",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/navigation/search"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-search-alt-2"
+ }
++ ],
++ "children": [
++ {
++ "id": "_help_Oxyb6jOjjVNL",
++ "title": "Under the hood",
++ "type": "text",
++ "attributes": [
++ {
++ "type": "label",
++ "name": "docUrl",
++ "value": "https://docs.triliumnotes.org/user-guide/concepts/navigation/search/under-the-hood"
++ },
++ {
++ "type": "label",
++ "name": "iconClass",
++ "value": "bx bxs-cog"
++ }
++ ]
++ },
++ {
++ "id": "_help_WbjlujkUhEb5",
++ "title": "How search matches your text",
++ "type": "text",
++ "attributes": [
++ {
++ "type": "label",
++ "name": "docUrl",
++ "value": "https://docs.triliumnotes.org/user-guide/concepts/navigation/search/matching"
++ },
++ {
++ "type": "label",
++ "name": "iconClass",
++ "value": "bx bx-file-find"
++ }
++ ]
++ }
+ ]
+ },
+ {
+ "id": "_help_u3YFHC9tQlpm",
+ "title": "Bookmarks",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/navigation/bookmarks"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-bookmarks"
+ }
+ ]
+ },
+ {
+ "id": "_help_OR8WJ7Iz9K4U",
+ "title": "Note Hoisting",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/navigation/note-hoisting"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-chevrons-up"
+ }
+ ]
+ },
+ {
+ "id": "_help_ZjLYv08Rp3qC",
+ "title": "Quick edit",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/navigation/quick-edit"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-edit"
+ }
+ ]
+ },
+ {
+ "id": "_help_9sRHySam5fXb",
+ "title": "Workspaces",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/navigation/workspace"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-door-open"
+ }
+ ]
+ },
+ {
+ "id": "_help_xWtq5NUHOwql",
+ "title": "Similar Notes",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/navigation/similar-notes"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-bar-chart"
+ }
+ ]
+ },
+ {
+ "id": "_help_McngOG2jbUWX",
+ "title": "Search in note",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/navigation/search-in-note"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-search-alt-2"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_A9Oc6YKKc65v",
+ "title": "Keyboard Shortcuts",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/keyboard-shortcuts"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-keyboard"
+ }
+ ]
+ },
+ {
+ "id": "_help_Wy267RK4M69c",
+ "title": "Themes",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/themes"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-palette"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_VbjZvtUek0Ln",
+ "title": "Theme Gallery",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/themes/theme-gallery"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-book-reader"
+ }
+ ]
+ },
+ {
+ "id": "_help_gOKqSJgXLcIj",
+ "title": "Icon Packs",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/themes/icon-packs"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-package"
+ }
+ ]
++ },
++ {
++ "id": "_help_w4rMEhJsALlA",
++ "title": "Personalizing the font",
++ "type": "text",
++ "attributes": [
++ {
++ "type": "label",
++ "name": "docUrl",
++ "value": "https://docs.triliumnotes.org/user-guide/concepts/themes/fonts"
++ },
++ {
++ "type": "label",
++ "name": "iconClass",
++ "value": "bx bx-font"
++ }
++ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_mHbBMPDPkVV5",
+ "title": "Import & Export",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/import-export"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-import"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_Oau6X9rCuegd",
+ "title": "Markdown",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/import-export/markdown"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxl-markdown"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_rJ9grSgoExl9",
+ "title": "Supported syntax",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/import-export/markdown/supported-syntax"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-code-alt"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_ckZ2uNWQmVeX",
+ "title": "Importing data from other applications",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/import-export/import-from-apps"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-import"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_GnhlmrATVqcH",
+ "title": "Microsoft OneNote",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/import-export/import-from-apps/onenote"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
- "value": "bx bx-window-open"
++ "value": "tn-brand tn-brand-onenote"
++ }
++ ],
++ "children": [
++ {
++ "id": "_help_LpvyEIBIAAj7",
++ "title": "Tags",
++ "type": "text",
++ "attributes": [
++ {
++ "type": "label",
++ "name": "docUrl",
++ "value": "https://docs.triliumnotes.org/user-guide/concepts/import-export/import-from-apps/onenote/tags"
++ },
++ {
++ "type": "label",
++ "name": "iconClass",
++ "value": "bx bx-star"
++ }
++ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_Y5mKeJ6dsCld",
+ "title": "Notion",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/import-export/import-from-apps/notion"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
- "value": "bx bx-window-open"
++ "value": "tn-brand tn-brand-notion"
+ }
+ ]
+ },
+ {
+ "id": "_help_nhQVuO4zvIxi",
+ "title": "Google Keep",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/import-export/import-from-apps/keep"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
- "value": "bx bx-window-open"
++ "value": "tn-brand tn-brand-google-keep"
+ }
+ ]
+ },
+ {
+ "id": "_help_syuSEKf2rUGr",
+ "title": "Evernote",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/import-export/import-from-apps/evernote"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
- "value": "bx bx-window-open"
++ "value": "tn-brand tn-brand-evernote"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_dj3j8dG4th4l",
+ "title": "Process internal links by title",
+ "type": "code",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/import-export/import-from-apps/evernote/internal-links.js"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ],
+ "mime": "application/javascript;env=frontend"
+ }
+ ]
+ },
+ {
+ "id": "_help_83zmPBJRgfnW",
+ "title": "Anytype",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/import-export/import-from-apps/anytype"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
- "value": "bx bx-window-open"
++ "value": "tn-brand tn-brand-anytype"
+ }
+ ]
+ },
+ {
+ "id": "_help_iWD7wiIuMtgV",
+ "title": "Obsidian",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/import-export/import-from-apps/obsidian"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
- "value": "bx bx-window-open"
++ "value": "tn-brand tn-brand-obsidian"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_rC3pL2aptaRE",
+ "title": "Zen mode",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/zen-mode"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-yin-yang"
+ }
+ ]
+ },
+ {
+ "id": "_help_YzMcWlCVeW09",
+ "title": "Active content",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/concepts/active-content"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-widget"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_s3YCWHBfmYuM",
+ "title": "Quick Start",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/quick-start"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-run"
+ }
+ ]
+ },
+ {
+ "id": "_help_i6dbnitykE5D",
+ "title": "FAQ",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/faq"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-question-mark"
+ }
+ ]
+ },
+ {
+ "id": "_help_KSZ04uQ2D1St",
+ "title": "Note Types",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-edit"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_iPIMuisry3hd",
+ "title": "Text",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-note"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_oSuaNgyyKnhu",
+ "title": "Anchors",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/bookmarks"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-bookmark"
+ }
+ ]
+ },
+ {
+ "id": "_help_oI7GoyilXXAr",
+ "title": "Automatic replacements",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/automatic-replacements"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-reply"
+ }
+ ]
+ },
+ {
+ "id": "_help_NwBbFdNZ9h7O",
+ "title": "Block quotes & admonitions",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/blockquotes"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-info-circle"
+ }
+ ]
+ },
++ {
++ "id": "_help_klC3ilXa9kUE",
++ "title": "Block references",
++ "type": "text",
++ "attributes": [
++ {
++ "type": "label",
++ "name": "docUrl",
++ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/block-references"
++ },
++ {
++ "type": "label",
++ "name": "iconClass",
++ "value": "bx bx-paragraph"
++ }
++ ]
++ },
+ {
+ "id": "_help_4n4oQUVbnOxa",
+ "title": "Collapsible blocks",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/collapsible-blocks"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-chevron-down-circle"
+ }
+ ]
+ },
+ {
+ "id": "_help_veGu4faJErEM",
+ "title": "Content language & Right-to-left support",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/content-language"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-align-right"
+ }
+ ]
+ },
++ {
++ "id": "_help_EK2ckIZ74tbT",
++ "title": "Content tabs",
++ "type": "text",
++ "attributes": [
++ {
++ "type": "label",
++ "name": "docUrl",
++ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/content-tabs"
++ },
++ {
++ "type": "label",
++ "name": "iconClass",
++ "value": "cke cke-trilium-tabs"
++ }
++ ]
++ },
+ {
+ "id": "_help_2x0ZAX9ePtzV",
+ "title": "Cut to subnote",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/cut-to-subnote"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-cut"
+ }
+ ]
+ },
+ {
+ "id": "_help_UYuUB1ZekNQU",
+ "title": "Developer-specific formatting",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/developer-formatting"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-code-alt"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_QxEyIjRBizuC",
+ "title": "Code blocks",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/developer-formatting/code-blocks"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-code"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_AgjCISero73a",
+ "title": "Footnotes",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/footnotes"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-bracket"
+ }
+ ]
+ },
+ {
+ "id": "_help_5wZallV2Qo1t",
+ "title": "Format Painter",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/format-painter"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-paint-roll"
+ }
+ ]
+ },
+ {
+ "id": "_help_nRhnJkTT8cPs",
+ "title": "Formatting toolbar",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/formatting-toolbar"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-text"
+ }
+ ]
+ },
+ {
+ "id": "_help_Gr6xFaF6ioJ5",
+ "title": "General formatting",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/general-formatting"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-bold"
+ }
+ ]
+ },
+ {
+ "id": "_help_AxshuNRegLAv",
+ "title": "Highlights list",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/highlights-list"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-highlight"
+ }
+ ]
+ },
+ {
+ "id": "_help_mT0HEkOsz6i1",
+ "title": "Images",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/images"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-image-alt"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_0Ofbk1aSuVRu",
+ "title": "Image references",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/images/image-references"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-file-image"
+ }
+ ]
+ }
+ ]
+ },
++ {
++ "id": "_help_VRoP0g1uHHc2",
++ "title": "In-editor AI assistant",
++ "type": "text",
++ "attributes": [
++ {
++ "type": "label",
++ "name": "docUrl",
++ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/ai-assistant"
++ },
++ {
++ "type": "label",
++ "name": "iconClass",
++ "value": "bx bx-bot"
++ }
++ ],
++ "children": [
++ {
++ "id": "_help_mVEYwt20exhO",
++ "title": "Custom AI quick actions",
++ "type": "text",
++ "attributes": [
++ {
++ "type": "label",
++ "name": "docUrl",
++ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/ai-assistant/custom-quick-actions"
++ },
++ {
++ "type": "label",
++ "name": "iconClass",
++ "value": "bx bx-file"
++ }
++ ]
++ }
++ ]
++ },
+ {
+ "id": "_help_nBAXQFj20hS1",
+ "title": "Include Note",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/include-note"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ },
+ {
+ "id": "_help_CohkqWQC1iBv",
+ "title": "Insert buttons",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/insert-buttons"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-plus"
+ }
++ ],
++ "children": [
++ {
++ "id": "_help_hD8GawVuazff",
++ "title": "Icons",
++ "type": "text",
++ "attributes": [
++ {
++ "type": "label",
++ "name": "docUrl",
++ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/insert-buttons/icons"
++ },
++ {
++ "type": "label",
++ "name": "iconClass",
++ "value": "bx bx-sticker"
++ }
++ ]
++ }
+ ]
+ },
+ {
+ "id": "_help_oiVPnW8QfnvS",
+ "title": "Keyboard shortcuts",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/keyboard-shortcuts"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-keyboard"
+ }
+ ]
+ },
+ {
+ "id": "_help_UmgZAfcltxkS",
+ "title": "Link Previews",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/link-previews"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-link-external"
+ }
+ ]
+ },
+ {
+ "id": "_help_QEAPj01N5f7w",
+ "title": "Links",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/links"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-link-alt"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_3IDVtesTQ8ds",
+ "title": "External links",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/links/external-links"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-link-external"
+ }
+ ]
+ },
+ {
+ "id": "_help_hrZ1D00cLbal",
+ "title": "Internal (reference) links",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/links/reference-links"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-link"
+ }
+ ]
+ },
+ {
+ "id": "_help_wfGXLmm7x27z",
+ "title": "Backlinks",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/links/backlinks"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-link-alt"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_S6Xx8QIWTV66",
+ "title": "Lists",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/lists"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-list-ul"
+ }
+ ]
+ },
+ {
+ "id": "_help_QrtTYPmdd1qq",
+ "title": "Markdown-like formatting",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/markdown-formatting"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxl-markdown"
+ }
+ ]
+ },
+ {
+ "id": "_help_YfYAtQBcfo5V",
+ "title": "Math Equations",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/math-equations"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-math"
+ }
+ ]
+ },
++ {
++ "id": "_help_wYDzQ1fBFgfT",
++ "title": "Multicolumn layout",
++ "type": "text",
++ "attributes": [
++ {
++ "type": "label",
++ "name": "docUrl",
++ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/multicolumn-layout"
++ },
++ {
++ "type": "label",
++ "name": "iconClass",
++ "value": "cke cke-trilium-multicolumn"
++ }
++ ]
++ },
+ {
+ "id": "_help_dEHYtoWWi8ct",
+ "title": "Other features",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/other-features"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-grid"
+ }
+ ]
+ },
+ {
+ "id": "_help_gLt3vA97tMcp",
+ "title": "Premium features",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/premium-features"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-star"
+ }
+ ]
+ },
+ {
+ "id": "_help_ZlN4nump6EbW",
+ "title": "Slash Commands",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/slash-commands"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-menu"
+ }
+ ]
+ },
+ {
+ "id": "_help_oBo3iHIZnbG2",
+ "title": "Spell Check",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/spellcheck"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-check-double"
+ }
+ ]
+ },
+ {
+ "id": "_help_BFvAtE74rbP6",
+ "title": "Table of contents",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/table-of-contents"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-heading"
+ }
+ ]
+ },
+ {
+ "id": "_help_NdowYOC1GFKS",
+ "title": "Tables",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/tables"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-table"
+ }
+ ]
+ },
+ {
+ "id": "_help_pwc194wlRzcH",
+ "title": "Text Snippets",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ },
+ {
+ "id": "_help_fASfBrYnquKU",
+ "title": "To-do Lists",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/text/todo-lists"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-checkbox-checked"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_6f9hih2hXXZk",
+ "title": "Code",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/code"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-code"
+ }
+ ]
+ },
+ {
+ "id": "_help_m523cpzocqaD",
+ "title": "Saved Search",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/saved-search"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file-find"
+ }
+ ]
+ },
+ {
+ "id": "_help_iRwzGnHPzonm",
+ "title": "Relation Map",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/relation-map"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
- "value": "bx bxs-network-chart"
++ "value": "bx bx-shape-polygon"
+ }
+ ]
+ },
+ {
+ "id": "_help_bdUJEHsAPYQR",
+ "title": "Note Map",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/note-map"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-network-chart"
+ }
+ ]
+ },
+ {
+ "id": "_help_HcABDtFCkbFN",
+ "title": "Render Note",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/render-note"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-extension"
+ }
+ ]
+ },
+ {
+ "id": "_help_s1aBHPd79XYj",
+ "title": "Mermaid Diagrams",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/mermaid-diagrams"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-selection"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_RH6yLjjWJHof",
+ "title": "ELK layout",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/mermaid-diagrams/elk"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-network-chart"
+ }
+ ]
+ },
+ {
+ "id": "_help_WWgeUaBb7UfC",
+ "title": "Syntax reference",
+ "type": "webView",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "webViewSrc",
+ "value": "https://mermaid.js.org/intro/syntax-reference.html"
+ },
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/mermaid-diagrams/syntax-reference"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_grjYqerjn243",
+ "title": "Canvas",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/canvas"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-pen"
+ }
+ ]
+ },
+ {
+ "id": "_help_1vHRoWCEjj0L",
+ "title": "Web View",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/webview"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-globe-alt"
+ }
+ ]
+ },
+ {
+ "id": "_help_gBbsAeiuUxI5",
+ "title": "Mind Map",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/mindmap"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-sitemap"
+ }
+ ]
+ },
+ {
+ "id": "_help_W8vYD3Q1zjCR",
+ "title": "File",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/file"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file-blank"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_XJGJrpu7F9sh",
+ "title": "PDFs",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/file/pdf"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-file-pdf"
+ }
+ ]
+ },
+ {
+ "id": "_help_AjqEeiDUOzj4",
+ "title": "Audio & Video",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/file/audio-video"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-video"
+ }
+ ]
+ },
+ {
+ "id": "_help_KG48zgNY31NW",
+ "title": "Office documents",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-file-doc"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_GWHEkY4I4OE3",
+ "title": "Spreadsheets",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/spreadsheets"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-table"
+ }
+ ]
+ },
+ {
+ "id": "_help_6RM1Q7ppFVoj",
+ "title": "Markdown",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/markdown"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxl-markdown"
+ }
+ ]
+ },
+ {
+ "id": "_help_jludwdW7N4hg",
+ "title": "Converting between note types",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/note-types/note-type-conversion"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-repost"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_GTwFsgaA0lCt",
+ "title": "Collections",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/collections"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-book"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_xWbu3jpNWapp",
+ "title": "Calendar",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/collections/calendar"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-calendar"
+ }
+ ]
+ },
+ {
+ "id": "_help_2FvYrpmOXm29",
+ "title": "Table",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/collections/table"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-table"
+ }
+ ]
+ },
+ {
+ "id": "_help_CtBQqbwXDx1w",
+ "title": "Kanban Board",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/collections/kanban-board"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-columns"
+ }
+ ]
+ },
+ {
+ "id": "_help_81SGnPGMk7Xc",
+ "title": "Geo Map",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/collections/geomap"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-map-alt"
+ }
++ ],
++ "children": [
++ {
++ "id": "_help_C2H9HK4BzwG7",
++ "title": "Drawing shapes",
++ "type": "text",
++ "attributes": [
++ {
++ "type": "label",
++ "name": "docUrl",
++ "value": "https://docs.triliumnotes.org/user-guide/collections/geomap/shapes"
++ },
++ {
++ "type": "label",
++ "name": "iconClass",
++ "value": "bx bx-shape-square"
++ }
++ ]
++ },
++ {
++ "id": "_help_ZRDXGc0nAIh4",
++ "title": "Image maps",
++ "type": "text",
++ "attributes": [
++ {
++ "type": "label",
++ "name": "docUrl",
++ "value": "https://docs.triliumnotes.org/user-guide/collections/geomap/image-maps"
++ },
++ {
++ "type": "label",
++ "name": "iconClass",
++ "value": "bx bx-image-alt"
++ }
++ ]
++ }
+ ]
+ },
+ {
+ "id": "_help_zP3PMqaG71Ct",
+ "title": "Presentation",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/collections/presentation"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-slideshow"
+ }
+ ]
+ },
+ {
+ "id": "_help_8QqnMzx393bx",
+ "title": "Grid View",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/collections/grid"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-grid"
+ }
+ ]
+ },
+ {
+ "id": "_help_mULW0Q3VojwY",
+ "title": "List View",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/collections/list"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-list-ul"
+ }
+ ]
+ },
+ {
+ "id": "_help_CssoWBu8I7jF",
+ "title": "Collection Properties",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/collections/collection-properties"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-cog"
+ }
+ ]
+ },
+ {
+ "id": "_help_IF7Q6I9x7zuw",
+ "title": "Dashboard",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/collections/dashboard"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-dashboard"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_BgmBlOIl72jZ",
+ "title": "Troubleshooting",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/troubleshooting"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-bug"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_wy8So3yZZlH9",
+ "title": "Reporting issues",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/troubleshooting/reporting-issues"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-bug-alt"
+ }
+ ]
+ },
+ {
+ "id": "_help_x59R8J8KV5Bp",
+ "title": "Anonymized Database",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/troubleshooting/anonymized-database"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-low-vision"
+ }
+ ]
+ },
+ {
+ "id": "_help_qzNzp9LYQyPT",
+ "title": "Error logs",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/troubleshooting/error-logs"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-comment-error"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_bnyigUA2UK7s",
+ "title": "Backend (server) logs",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/troubleshooting/error-logs/backend-logs"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-server"
+ }
+ ]
+ },
+ {
+ "id": "_help_9yEHzMyFirZR",
+ "title": "Frontend logs",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/troubleshooting/error-logs/frontend-logs"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-window-alt"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_vdlYGAcpXAgc",
+ "title": "Synchronization fails with 504 Gateway Timeout",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/troubleshooting/sync-timeout"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-error"
+ }
+ ]
+ },
+ {
+ "id": "_help_s8alTXmpFR61",
+ "title": "Refreshing the application",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/troubleshooting/refreshing-app"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-refresh"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_pKK96zzmvBGf",
+ "title": "Theme development",
+ "type": "book",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/theme-development"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-palette"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_7NfNr5pZpVKV",
+ "title": "Creating a custom theme",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/theme-development/creating-custom-theme"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-color"
+ }
+ ]
+ },
+ {
+ "id": "_help_WFGzWeUK6arS",
+ "title": "Customize the Next theme",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/theme-development/customize-next-theme"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-news"
+ }
+ ]
+ },
+ {
+ "id": "_help_WN5z4M8ASACJ",
+ "title": "Reference",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/theme-development/reference"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-book-open"
+ }
+ ]
+ },
+ {
+ "id": "_help_AlhDUqhENtH7",
+ "title": "Custom app-wide CSS",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/theme-development/custom-appcss"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-file-css"
+ }
+ ]
+ },
+ {
+ "id": "_help_g1mlRoU8CsqC",
+ "title": "Creating an icon pack",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/theme-development/creating-icon-pack"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-package"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_tC7s2alapj8V",
+ "title": "Advanced Usage",
+ "type": "book",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-rocket"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_zEY4DaJG4YT5",
+ "title": "Attributes",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/attributes"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-list-check"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_HI6GBBIduIgv",
+ "title": "Labels",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/attributes/labels"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-hash"
+ }
+ ]
+ },
+ {
+ "id": "_help_Cq5X6iKQop6R",
+ "title": "Relations",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/attributes/relations"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-transfer"
+ }
+ ]
+ },
+ {
+ "id": "_help_bwZpz2ajCEwO",
+ "title": "Attribute Inheritance",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/attributes/attribute-inheritance"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-list-plus"
+ }
+ ]
+ },
+ {
+ "id": "_help_OFXdgB2nNk1F",
+ "title": "Promoted Attributes",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/attributes/promoted-attributes"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-table"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_KC1HB96bqqHX",
+ "title": "Templates",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/template"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
- "value": "bx bx-copy"
++ "value": "bx bx-detail"
+ }
+ ]
+ },
+ {
+ "id": "_help_B2ORr7OVEZtc",
+ "title": "Snippets",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/snippets"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-news"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_VQjhl61rlWh9",
+ "title": "Markdown Snippets",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/snippets/markdown-snippets"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxl-markdown"
+ }
+ ]
+ },
+ {
+ "id": "_help_IEgsWp5hHH35",
+ "title": "Code Snippets",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/snippets/code-snippets"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-code-alt"
+ }
+ ]
+ },
+ {
+ "id": "_help_pwc194wlRzcH",
+ "title": "Text Snippets",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_BCkXAVs63Ttv",
+ "title": "Note Map (Link map, Tree map)",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/note-map"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-network-chart"
+ }
+ ]
+ },
+ {
+ "id": "_help_R9pX4DGra2Vt",
+ "title": "Sharing",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/sharing"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-share-alt"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_Qjt68inQ2bRj",
+ "title": "Serving directly the content of a note",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/sharing/serving-raw"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-code"
+ }
+ ]
+ },
+ {
+ "id": "_help_ycBFjKrrwE9p",
+ "title": "Exporting static HTML for web publishing",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/sharing/static-html"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-file-html"
+ }
+ ]
+ },
+ {
+ "id": "_help_sLIJ6f1dkJYW",
+ "title": "Reverse proxy configuration",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/sharing/reverse-proxy"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-world"
+ }
+ ]
+ },
+ {
+ "id": "_help_Ad7Ku5gOHrDU",
+ "title": "Custom share template",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/sharing/custom-share-template"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxl-nodejs"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_5668rwcirq1t",
+ "title": "Advanced Showcases",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/advanced-showcases"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-component"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_l0tKav7yLHGF",
+ "title": "Day Notes",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/advanced-showcases/day-notes"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-calendar"
+ }
+ ]
+ },
+ {
+ "id": "_help_R7abl2fc6Mxi",
+ "title": "Weight Tracker",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/advanced-showcases/weight-tracker"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-line-chart"
+ }
+ ]
+ },
+ {
+ "id": "_help_xYjQUYhpbUEW",
+ "title": "Task Manager",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/advanced-showcases/task-manager"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-calendar-check"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_i16PM6A7GXdU",
+ "title": "Customizing to-do task states",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/customizing-to-do-task-states"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-list-check"
+ }
+ ]
+ },
+ {
+ "id": "_help_J5Ex1ZrMbyJ6",
+ "title": "Custom Request Handler",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/custom-request-handler"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-globe"
+ }
+ ]
+ },
+ {
+ "id": "_help_d3fAXQ2diepH",
+ "title": "Custom Resource Providers",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/custom-resource-providers"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-file-plus"
+ }
+ ]
+ },
+ {
+ "id": "_help_pgxEVkzLl1OP",
+ "title": "ETAPI (REST API)",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/etapi"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-extension"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_9qPsTWBorUhQ",
+ "title": "API Reference",
+ "type": "webView",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "webViewSrc",
+ "value": "https://docs.triliumnotes.org/rest-api/etapi/"
+ },
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/etapi/api-reference"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_47ZrP6FNuoG8",
+ "title": "Default Note Title",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/default-note-title"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-edit-alt"
+ }
+ ]
+ },
+ {
+ "id": "_help_wX4HbRucYSDD",
+ "title": "Database",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/database"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-data"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_oyIAJ9PvvwHX",
+ "title": "Manually altering the database",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/database/manual-editing"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-edit"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_YKWqdJhzi2VY",
+ "title": "SQL Console",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/database/manual-editing/sql-console"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-data"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_6tZeKvSHEUiB",
+ "title": "Demo Notes",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/database/demo-notes"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-package"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_Gzjqa934BdH4",
+ "title": "Configuration (config.ini or environment variables)",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/configuration"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-cog"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_c5xB8m4g2IY6",
+ "title": "Trilium instance",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/configuration/trilium-instance"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-windows"
+ }
+ ]
+ },
+ {
+ "id": "_help_LWtBjFej3wX3",
+ "title": "Cross-Origin Resource Sharing (CORS)",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/configuration/cors"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-lock"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_ivYnonVFBxbQ",
+ "title": "Bulk Actions",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/bulk-actions"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-list-plus"
+ }
+ ]
+ },
+ {
+ "id": "_help_4FahAwuGTAwC",
+ "title": "Note source",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/note-source"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-code"
+ }
+ ]
+ },
+ {
+ "id": "_help_1YeN2MzFUluU",
+ "title": "Technologies used",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/technologies"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-pyramid"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_MI26XDLSAlCD",
+ "title": "CKEditor",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/technologies/ckeditor"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_m1lbrzyKDaRB",
+ "title": "Note ID",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/note-id"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
- "value": "bx bx-hash"
++ "value": "bx bx-fingerprint"
+ }
+ ]
+ },
+ {
+ "id": "_help_0vTSyvhPTAOz",
+ "title": "Internal API",
+ "type": "book",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/internal-api"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-component"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_z8O2VG4ZZJD7",
+ "title": "API Reference",
+ "type": "webView",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "webViewSrc",
+ "value": "https://docs.triliumnotes.org/rest-api/internal/"
+ },
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/internal-api/api-reference"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_2mUhVmZK8RF3",
+ "title": "Hidden Notes",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/hidden-notes"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-hide"
+ }
+ ]
+ },
+ {
+ "id": "_help_uYF7pmepw27K",
+ "title": "Metrics",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/metrics"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-data"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_bOP3TB56fL1V",
+ "title": "grafana-dashboard.json",
+ "type": "code",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/metrics/grafana-dashboard"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ],
+ "mime": "application/json"
+ }
+ ]
+ },
+ {
+ "id": "_help_64ZTlUPgEPtW",
+ "title": "Safe mode",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/safe-mode"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-virus-block"
+ }
+ ]
+ },
+ {
+ "id": "_help_HAIOFBoYIIdO",
+ "title": "Nightly release",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/nightly-release"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-moon"
+ }
+ ]
+ },
+ {
+ "id": "_help_ZmT9ln8XJX2o",
+ "title": "Read-only database",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/read-only-db"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-book-reader"
+ }
+ ]
+ },
+ {
+ "id": "_help_TiQbQDgP8L5t",
+ "title": "Text Extraction (OCR)",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/advanced-usage/ocr"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_GBBMSlVSOIGP",
+ "title": "AI",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/llm"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-bot"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_bkPZAMT7d2sR",
+ "title": "Providers",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/llm/providers"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-cog"
+ }
++ ],
++ "children": [
++ {
++ "id": "_help_eFhxp9laTW1S",
++ "title": "Subscription-based providers",
++ "type": "text",
++ "attributes": [
++ {
++ "type": "label",
++ "name": "docUrl",
++ "value": "https://docs.triliumnotes.org/user-guide/llm/providers/subscription-based"
++ },
++ {
++ "type": "label",
++ "name": "iconClass",
++ "value": "bx bx-coin"
++ }
++ ]
++ }
+ ]
+ },
+ {
+ "id": "_help_cRRrdZjgyhNc",
+ "title": "Privacy",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-lock-alt"
+ }
+ ]
+ },
+ {
+ "id": "_help_KOWBFgsZXJAD",
+ "title": "MCP",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/llm/mcp"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-network-chart"
+ }
+ ]
+ }
+ ]
+ },
++ {
++ "id": "_help_Y84QCbArmK3z",
++ "title": "Meeting transcription",
++ "type": "text",
++ "attributes": [
++ {
++ "type": "label",
++ "name": "docUrl",
++ "value": "https://docs.triliumnotes.org/user-guide/transcription"
++ },
++ {
++ "type": "label",
++ "name": "iconClass",
++ "value": "bx bx-microphone"
++ }
++ ]
++ },
+ {
+ "id": "_help_CdNpE2pqjmI6",
+ "title": "Scripting",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-file-js"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_yIhgI5H7A2Sm",
+ "title": "Frontend Basics",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/frontend-basics"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-window"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_MgibgPcfeuGz",
+ "title": "Custom Widgets",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/frontend-basics/custom-widget"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-widget"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_SynTBQiBsdYJ",
+ "title": "Widget Basics",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/frontend-basics/custom-widget/widget-basics"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ },
+ {
+ "id": "_help_GhurYZjh8e1V",
+ "title": "Note context aware widget",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/frontend-basics/custom-widget/note-context-aware-widget"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ },
+ {
+ "id": "_help_M8IppdwVHSjG",
+ "title": "Right pane widget",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/frontend-basics/custom-widget/right-pane-widget"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ },
+ {
+ "id": "_help_YNxAqkI5Kg1M",
+ "title": "Word count widget",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/frontend-basics/custom-widget/word-count"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ },
+ {
+ "id": "_help_VqGQnnPGnqAU",
+ "title": "CSS",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/frontend-basics/custom-widget/css"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ },
+ {
+ "id": "_help_gMkgcLJ6jBkg",
+ "title": "Troubleshooting",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/frontend-basics/custom-widget/troubleshooting"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_es8OU2GuguFU",
+ "title": "Examples",
+ "type": "book",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/frontend-basics/examples"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-code-alt"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_TjLYAo3JMO8X",
+ "title": "\"New Task\" launcher button",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/frontend-basics/examples/new-task-button"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-task"
+ }
+ ]
+ },
+ {
+ "id": "_help_7kZPMD0uFwkH",
+ "title": "Downloading responses from Google Forms",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/frontend-basics/examples/responses-from-google-forms"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ },
+ {
+ "id": "_help_DL92EjAaXT26",
+ "title": "Using promoted attributes to configure scripts",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/frontend-basics/examples/promoted-attributes-config"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_4Gn3psZKsfSm",
+ "title": "Launch Bar Widgets",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/frontend-basics/launch-bar-widgets"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-dock-left"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_IPArqVfDQ4We",
+ "title": "Note Title Widget",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/frontend-basics/launch-bar-widgets/note-title"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ },
+ {
+ "id": "_help_gcI7RPbaNSh3",
+ "title": "Analog Watch",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/frontend-basics/launch-bar-widgets/analog-watch"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_KLsqhjaqh1QW",
+ "title": "Preact",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/frontend-basics/preac"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxl-react"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_Bqde6BvPo05g",
+ "title": "Component libraries",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/frontend-basics/preac/component-libraries"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-component"
+ }
+ ]
+ },
+ {
+ "id": "_help_ykYtbM9k3a7B",
+ "title": "Hooks",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/frontend-basics/preac/hooks"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-question-mark"
+ }
+ ]
+ },
+ {
+ "id": "_help_Sg9GrCtyftZf",
+ "title": "CSS",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/frontend-basics/preac/css"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-file-css"
+ }
+ ]
+ },
+ {
+ "id": "_help_RSssb9S3xgSr",
+ "title": "Built-in components",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/frontend-basics/preac/builtin-components"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxs-component"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_i9B4IW7b6V6z",
+ "title": "Widget showcase",
+ "type": "code",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/frontend-basics/preac/builtin-components/widget-showcase"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ],
+ "mime": "text/jsx"
+ }
+ ]
+ }
+ ]
++ },
++ {
++ "id": "_help_irkwjdNtjcxR",
++ "title": "Frontend Events",
++ "type": "text",
++ "attributes": [
++ {
++ "type": "label",
++ "name": "docUrl",
++ "value": "https://docs.triliumnotes.org/user-guide/scripts/frontend-basics/events"
++ },
++ {
++ "type": "label",
++ "name": "iconClass",
++ "value": "bx bx-rss"
++ }
++ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_SPirpZypehBG",
+ "title": "Backend scripts",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/backend-basics"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-server"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_fZ2IGYFXjkEy",
+ "title": "Server-side imports",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/backend-basics/server-imports"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ },
+ {
+ "id": "_help_GPERMystNGTB",
- "title": "Events",
++ "title": "Backend Events",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/backend-basics/events"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-rss"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_wqXwKJl6VpNk",
+ "title": "Common concepts",
+ "type": "book",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/common-concepts"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bxl-nodejs"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_hA834UaHhSNn",
+ "title": "Script bundles",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/common-concepts/bundles"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-package"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_GLks18SNjxmC",
+ "title": "Script API",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/script-api"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-code-curly"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_Q2z6av6JZVWm",
+ "title": "Frontend API",
+ "type": "webView",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "webViewSrc",
+ "value": "https://docs.triliumnotes.org/script-api/frontend"
+ },
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/script-api/frontend-api"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-folder"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_habiZ3HU8Kw8",
+ "title": "FNote",
+ "type": "webView",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "webViewSrc",
+ "value": "https://docs.triliumnotes.org/script-api/frontend/interfaces/FNote.html"
+ },
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/script-api/frontend-api/fnote"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_MEtfsqa5VwNi",
+ "title": "Backend API",
+ "type": "webView",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "webViewSrc",
+ "value": "https://docs.triliumnotes.org/script-api/backend"
+ },
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/script-api/backend-api"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ },
+ {
+ "id": "_help_GFXVHyblVN3d",
+ "title": "Electron API",
+ "type": "webView",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "webViewSrc",
+ "value": "https://docs.triliumnotes.org/script-api/electron"
+ },
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/script-api/electron-api"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-window-alt"
+ }
+ ]
+ },
+ {
+ "id": "_help_ApVHZ8JY5ofC",
+ "title": "Day.js",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/script-api/day.js"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-calendar"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_vElnKeDNPSVl",
+ "title": "Logging",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/logging"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-terminal"
+ }
+ ]
+ },
+ {
+ "id": "_help_cNpC0ITcfX0N",
+ "title": "Breaking changes",
+ "type": "book",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/breaking-changes"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-up-arrow-alt"
+ }
+ ],
+ "children": [
++ {
++ "id": "_help_IjZS7iK5EXtb",
++ "title": "v0.107.0: Removal of the old layout",
++ "type": "text",
++ "attributes": [
++ {
++ "type": "label",
++ "name": "docUrl",
++ "value": "https://docs.triliumnotes.org/user-guide/scripts/breaking-changes/old-layout-removal"
++ },
++ {
++ "type": "label",
++ "name": "iconClass",
++ "value": "bx bx-layout"
++ }
++ ]
++ },
++ {
++ "id": "_help_kTx7WqLdZ3Ry",
++ "title": "v0.106.0: Removal of cheerio",
++ "type": "text",
++ "attributes": [
++ {
++ "type": "label",
++ "name": "docUrl",
++ "value": "https://docs.triliumnotes.org/user-guide/scripts/breaking-changes/cheerio-removal"
++ },
++ {
++ "type": "label",
++ "name": "iconClass",
++ "value": "bx bx-file"
++ }
++ ]
++ },
+ {
+ "id": "_help_YeOa2l7Pu39I",
+ "title": "v0.104.0: Disabling the Node integration in Electron",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/breaking-changes/disabling-node-integration"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ },
+ {
+ "id": "_help_fqAK6opjUagR",
+ "title": "v0.103.0: Removal of axios",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/breaking-changes/axios-removal"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ },
+ {
+ "id": "_help_pAJ0jWz16xFm",
+ "title": "v0.103.0: `cheerio` is now deprecated",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/breaking-changes/cheerio-deprecated"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ },
+ {
+ "id": "_help_72dxvnbnkDFY",
+ "title": "v0.102.0: Upgrade to jQuery 4.0.0",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/breaking-changes/jquery4"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_fiHicjpHjIRJ",
+ "title": "Security",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/scripts/security"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-shield"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "_help_Fm0j45KqyHpU",
+ "title": "Miscellaneous",
+ "type": "book",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/misc"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-info-circle"
+ }
+ ],
+ "children": [
+ {
+ "id": "_help_WFbFXrgnDyyU",
+ "title": "Privacy Policy",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/misc/privacy-policy"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ },
+ {
+ "id": "_help_NcsmUYZRWEW4",
+ "title": "Patterns of personal knowledge",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/misc/patterns-of-personal-knowledge"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ },
+ {
+ "id": "_help_d1Ap6Pg6IjaJ",
+ "title": "License",
+ "type": "text",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "docUrl",
+ "value": "https://docs.triliumnotes.org/user-guide/misc/license"
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-file"
+ }
+ ]
+ }
+ ]
+ }
+]
diff --cc apps/server/src/routes/assets.ts
index 1c4559109e,95653ba358..aa1c12827b
--- a/apps/server/src/routes/assets.ts
+++ b/apps/server/src/routes/assets.ts
@@@ -52,13 -54,19 +54,21 @@@ async function register(app: express.Ap
},
appType: "spa",
configFile: path.join(clientDir, "vite.config.mts"),
- base: `/${assetUrlFragment}/`
+ base: `/${assetUrlFragment}/`,
+ // One dep-optimizer cache per dev instance. The client config points
+ // `cacheDir` at a single repo-level directory, but the optimizer
+ // invalidates the whole cache whenever its `configHash` changes —
+ // and that hash differs between the Node-hosted dev server and the
+ // Electron-hosted one. Sharing the directory therefore made every
+ // switch between `server:start` and `desktop:start` re-scan and
+ // re-bundle the whole dependency graph, adding ~3s to startup.
+ cacheDir: path.join(clientDir, "../..", ".cache", `vite-${port}`)
});
app.use(`/${assetUrlFragment}/`, (req, res, next) => {
- if (req.url.startsWith("/images/") || req.url.startsWith("/doc_notes/")) {
- // Images and doc notes are served as static assets from the server.
+ if (req.url.startsWith("/images/") || req.url.startsWith("/help/")) {
+ // Images and the in-app help's assets are served as static assets from the server.
+ // Anything not listed here is handed to Vite, which answers unknown paths with
+ // index.html — a 200 that looks fine until you read the body.
next();
return;
}
@@@ -94,38 -107,38 +109,52 @@@
app.use(`/${assetUrlFragment}/fonts`, persistentCacheStatic(path.join(publicDir, "fonts")));
app.use(`/${assetUrlFragment}/translations/`, persistentCacheStatic(path.join(publicDir, "translations")));
app.use(`/node_modules/`, persistentCacheStatic(path.join(publicDir, "node_modules")));
+ app.use(`/share/assets/`, express.static(getShareThemeAssetDir(), STATIC_OPTIONS));
+ app.use(`/share/assets/`, express.static(path.join(publicDir, "assets"), STATIC_OPTIONS));
}
- app.use(`/share/assets/fonts/`, express.static(path.join(getClientDir(), "fonts"), STATIC_OPTIONS));
- app.use(`/share/assets/`, express.static(getShareThemeAssetDir(), STATIC_OPTIONS));
app.use(`/pdfjs/`, persistentCacheStatic(getPdfjsAssetDir()));
app.use(`/${assetUrlFragment}/images`, persistentCacheStatic(path.join(resourceDir, "assets", "images")));
- app.use(`/${assetUrlFragment}/doc_notes`, persistentCacheStatic(path.join(resourceDir, "assets", "doc_notes")));
+ // Images and attachments of the in-app help. They are not committed under the server's assets
+ // — the User Guide owns them — so in a source checkout they are served straight out of docs/,
+ // while a packaged build copies them in (see scripts/build.ts).
+ app.use(`/${assetUrlFragment}/help`, persistentCacheStatic(getHelpAssetDir(srcRoot, resourceDir)));
- app.use(`/assets/vX/fonts`, express.static(path.join(srcRoot, "public/fonts"), STATIC_OPTIONS));
- app.use(`/assets/vX/images`, express.static(path.join(srcRoot, "..", "images"), STATIC_OPTIONS));
- app.use(`/assets/vX/stylesheets`, express.static(path.join(srcRoot, "public/stylesheets"), STATIC_OPTIONS));
+ // `vX` is a version-independent alias so custom themes and scripts can reference built-in assets
+ // without naming a version they would have to bump on every upgrade. It serves the same files as
+ // the versioned routes above, but without `maxAge`: the URL no longer changes between releases,
+ // so a long-lived cache entry would pin the client to the previous version's assets.
+ app.use(`/assets/vX/stylesheets`, express.static(path.join(getClientDir(), "stylesheets"), STATIC_OPTIONS));
+ app.use(`/assets/vX/fonts`, express.static(path.join(getClientDir(), "fonts"), STATIC_OPTIONS));
+ app.use(`/assets/vX/images`, express.static(path.join(resourceDir, "assets", "images"), STATIC_OPTIONS));
}
+/**
+ * Where the in-app help's assets live: the markdown export in a source checkout, the copy the
+ * build makes in a packaged one.
+ */
+function getHelpAssetDir(srcRoot: string, resourceDir: string) {
+ if (isDev) {
+ return path.join(srcRoot, "..", "..", "docs", "User Guide");
+ }
+ return path.join(resourceDir, "assets", "help");
+}
+
+ /** The fixed files of the share theme that every shared page loads. */
+ const SHARE_THEME_ENTRIES = [ "scripts.js", "tree.js", "scripts.css" ];
+
+ /**
+ * Where the client build writes the share theme, beside its own chunks: `src/` of the client's
+ * build output.
+ */
export function getShareThemeAssetDir() {
+ return path.join(getClientBuildDir(), "src");
+ }
+
+ /** The client's build output: `public/` in a packaged app, `apps/client/dist` in development. */
+ export function getClientBuildDir() {
if (process.env.NODE_ENV === "development") {
- const srcRoot = path.join(__dirname, "..", "..");
- return path.join(srcRoot, "../../packages/share-theme/dist");
+ return path.join(getClientDir(), "..", "dist");
}
- const resourceDir = getResourceDir();
- return path.join(resourceDir, "share-theme/assets");
+ return getClientDir();
}
export function getPdfjsAssetDir() {
diff --cc apps/server/src/services/hidden_subtree.spec.ts
index e115b6710a,736a60dd06..9b72518340
--- a/apps/server/src/services/hidden_subtree.spec.ts
+++ b/apps/server/src/services/hidden_subtree.spec.ts
@@@ -32,36 -32,38 +32,36 @@@ describe("Hidden Subtree", () =>
expect(childBranches![0].parentNoteId).toStrictEqual("_lbVisibleLaunchers");
});
- it("should enforce the correct placement of help", () => {
- // First, verify the help note exists in its original correct location
- const originalBranch = becca.getBranchFromChildAndParent("_help_Vc8PjrjAGuOp", "_help_gh7bpGYxajRS");
- expect(originalBranch).toBeDefined();
- expect(originalBranch?.parentNoteId).toBe("_help_gh7bpGYxajRS");
-
- // Move the help note to an incorrect location (_help root instead of its proper parent)
- cls.init(() => {
- branches.moveBranchToNote(originalBranch!, "_help");
- });
-
- // Verify the note was moved to the wrong location
- const movedBranches = becca.notes["_help_Vc8PjrjAGuOp"]?.getParentBranches()
- .filter((b) => !b.isDeleted);
- expect(movedBranches).toBeDefined();
- expect(movedBranches![0].parentNoteId).toBe("_help");
+ it("provides the help subtree as virtual notes, with no persisted rows left behind", () => {
+ // The help subtree is injected into becca from the bundled meta as virtual notes;
- // the fixture DB carried persisted _help rows which migration 241 must have
++ // the fixture DB carried persisted _help rows which migration 242 must have
+ // removed, entity_changes included.
+ const helpRoot = becca.getNoteOrThrow("_help");
+ expect(helpRoot.isVirtual).toBe(true);
+ expect(helpRoot.getParentNotes().map((n) => n.noteId)).toEqual(["_hidden"]);
+ expect(helpRoot.getChildNotes().length).toBeGreaterThan(0);
+
+ const page = becca.getNoteOrThrow("_help_Vc8PjrjAGuOp");
+ expect(page.isVirtual).toBe(true);
+
+ const sql = getSql();
+ expect(sql.getValue(/*sql*/`SELECT COUNT(*) FROM notes WHERE noteId LIKE '\\_help%' ESCAPE '\\'`)).toBe(0);
+ expect(sql.getValue(/*sql*/`SELECT COUNT(*) FROM branches WHERE noteId LIKE '\\_help%' ESCAPE '\\' OR parentNoteId LIKE '\\_help%' ESCAPE '\\'`)).toBe(0);
+ expect(sql.getValue(/*sql*/`SELECT COUNT(*) FROM attributes WHERE noteId LIKE '\\_help%' ESCAPE '\\'`)).toBe(0);
+ expect(sql.getValue(/*sql*/`SELECT COUNT(*) FROM entity_changes WHERE entityId LIKE '\\_help%' ESCAPE '\\'`)).toBe(0);
+ });
- // Run the hidden subtree integrity check
- cls.init(() => {
- hiddenSubtreeService.checkHiddenSubtree(true);
- });
+ it("rejects moving a help note", () => {
+ const originalBranch = becca.getBranchFromChildAndParent("_help_Vc8PjrjAGuOp", "_help_gh7bpGYxajRS");
+ expect(originalBranch?.isVirtual).toBe(true);
- // Verify that the integrity check moved the help note back to its correct location
- const correctedBranches = becca.notes["_help_Vc8PjrjAGuOp"]?.getParentBranches()
- .filter((b) => !b.isDeleted);
- expect(correctedBranches).toBeDefined();
- expect(correctedBranches![0].parentNoteId).toBe("_help_gh7bpGYxajRS");
+ // validateParentChild rejects the move before anything is touched
+ const result = originalBranch && cls.init(() => branches.moveBranchToNote(originalBranch, "_help"));
+ expect(Array.isArray(result) ? result[1] : result).toMatchObject({ success: false });
- // Ensure the note is no longer under the incorrect parent
- const helpRootChildren = becca.notes["_help"]?.getChildNotes();
- const incorrectChild = helpRootChildren?.find(note => note.noteId === "_help_Vc8PjrjAGuOp");
- expect(incorrectChild).toBeUndefined();
+ // structure is unchanged
+ const parents = becca.getNoteOrThrow("_help_Vc8PjrjAGuOp").getParentNotes().map((n) => n.noteId);
+ expect(parents).toEqual(["_help_gh7bpGYxajRS"]);
});
it("enforces renames of launcher notes", () => {
diff --cc apps/server/src/services/llm/index.spec.ts
index fe44cb79e5,2a1a388ad5..42654c3cce
--- a/apps/server/src/services/llm/index.spec.ts
+++ b/apps/server/src/services/llm/index.spec.ts
@@@ -2,36 -2,55 +2,41 @@@ import { describe, expect, it, vi } fro
const registrations = vi.hoisted(() => ({
hostProviders: [] as { type: string; factory: () => unknown }[],
- docNoteReader: undefined as ((note: unknown) => string | null) | undefined,
-- skillReader: undefined as ((file: string) => string | null) | undefined,
- toolRegistries: [] as unknown[]
- toolRegistryLoaders: [] as (() => Promise<unknown>)[]
++ skillReader: undefined as ((file: string) => string | null) | undefined
}));
- vi.mock("@triliumnext/core/src/services/llm/index.js", () => ({
+ vi.mock("@triliumnext/core/src/services/llm/host_providers.js", () => ({
registerHostProvider: (type: string, factory: () => unknown) => { registrations.hostProviders.push({ type, factory }); }
}));
+// Partial: dropping the tool-registry mock brings the real tool graph into this suite, and the
+// skills tool reads the catalog at import time.
vi.mock("@triliumnext/core/src/services/llm/skills.js", async (importOriginal) => ({
...await importOriginal<typeof import("@triliumnext/core/src/services/llm/skills.js")>(),
registerSkillReader: (reader: (file: string) => string | null) => { registrations.skillReader = reader; }
}));
-vi.mock("@triliumnext/core/src/services/llm/tools/helpers.js", async (importOriginal) => ({
- ...await importOriginal<typeof import("@triliumnext/core/src/services/llm/tools/helpers.js")>(),
- registerDocNoteHtmlReader: (reader: (note: unknown) => string | null) => { registrations.docNoteReader = reader; }
-}));
-vi.mock("@triliumnext/core/src/services/llm/tools/registration.js", () => ({
- registerToolRegistryLoader: (loader: () => Promise<unknown>) => { registrations.toolRegistryLoaders.push(loader); }
-}));
+
import { registerServerLlmExtensions } from "./index.js";
+ import { AntigravityAgentProvider } from "./providers/antigravity_agent.js";
import { ClaudeAgentProvider } from "./providers/claude_agent.js";
+ import { CodexAgentProvider } from "./providers/codex_agent.js";
+ import { CopilotAgentProvider } from "./providers/copilot_agent.js";
-import { helpTools } from "./tools/help_tools.js";
describe("registerServerLlmExtensions", () => {
- it("hands core every piece of the stack that needs Node", () => {
+ it("hands core every piece of the stack that needs Node", async () => {
registerServerLlmExtensions();
- // The subscription provider, which shells out to the Claude Code CLI, under
- // the type core knows it by. Registered as a factory, so nothing is
- // constructed until a chat asks for it.
- expect(registrations.hostProviders.map(p => p.type)).toEqual(["claude-agent"]);
- expect(registrations.hostProviders[0].factory()).toBeInstanceOf(ClaudeAgentProvider);
+ // The subscription providers, which shell out to the Claude Code and Copilot
+ // CLIs, Google's Antigravity ACP server and the Codex ACP adapter, under the
+ // types core knows them by. Registered as async factories that import their
+ // module on first use, so neither the provider nor its agent SDK loads until
+ // a chat asks for it.
+ expect(registrations.hostProviders.map(p => p.type)).toEqual(["claude-agent", "copilot-agent", "antigravity-agent", "codex-agent"]);
+ expect(await registrations.hostProviders[0].factory()).toBeInstanceOf(ClaudeAgentProvider);
+ expect(await registrations.hostProviders[1].factory()).toBeInstanceOf(CopilotAgentProvider);
+ expect(await registrations.hostProviders[2].factory()).toBeInstanceOf(AntigravityAgentProvider);
+ expect(await registrations.hostProviders[3].factory()).toBeInstanceOf(CodexAgentProvider);
- // The User Guide reader, which core's note-content helper calls for doc notes.
- expect(registrations.docNoteReader).toBeTypeOf("function");
// The skill sheets: core owns the catalog and the tool, the server only
// knows how to get a sheet off disk.
expect(registrations.skillReader?.("search_syntax.md")).toContain("#");
- // No tool registry of its own: the help tools read note content like every other
- // tool, so core carries them and standalone gets them too.
- expect(registrations.toolRegistries).toEqual([]);
- // The one registry still backed by files this build alone carries,
- // registered as a loader so the tool stack stays out of the startup path.
- expect(registrations.toolRegistryLoaders).toHaveLength(1);
- expect(await registrations.toolRegistryLoaders[0]()).toBe(helpTools);
});
});
diff --cc apps/server/src/services/llm/index.ts
index c34a5acc34,98d067a18b..30d47f220b
--- a/apps/server/src/services/llm/index.ts
+++ b/apps/server/src/services/llm/index.ts
@@@ -3,28 -3,40 +3,35 @@@
*
* The stack itself lives in `@triliumnext/core`, so the browser-hosted
* (standalone) build can run it too. What could not follow it there is anything
- * that needs Node: the provider that spawns the Claude Code CLI, and the skill
+ * that needs Node: the providers that spawn the Claude Code and GitHub Copilot
- * CLIs, Google's Antigravity ACP server and the Codex ACP adapter, and the User Guide tools, which read pages off disk. Core exposes a seam
- * for each; this is where the server fills them in — including the skill sheets,
- * whose catalog is core's while the reading is per-runtime.
++ * CLIs, Google's Antigravity ACP server and the Codex ACP adapter, and the skill
+ * sheets, whose catalog is core's while the reading is per-runtime. Core exposes
+ * a seam for each; this is where the server fills them in.
*
- * Each seam is keyed rather than bespoke, so the next host-provided provider
- * (GitHub Copilot and the like) is one more line here and one more entry in
- * core's HOST_PROVIDED_TYPES.
+ * Each seam is keyed rather than bespoke, so the next host-provided provider is
+ * one more line here and one more entry in core's HOST_PROVIDED_TYPES.
*/
- import { registerHostProvider } from "@triliumnext/core/src/services/llm/index.js";
+ import { registerHostProvider } from "@triliumnext/core/src/services/llm/host_providers.js";
import { registerSkillReader } from "@triliumnext/core/src/services/llm/skills.js";
-import { registerDocNoteHtmlReader } from "@triliumnext/core/src/services/llm/tools/helpers.js";
-import { registerToolRegistryLoader } from "@triliumnext/core/src/services/llm/tools/registration.js";
import { loadSkillSheet } from "../../core_assets.js";
- import { ClaudeAgentProvider } from "./providers/claude_agent.js";
-import { getDocNoteHtml } from "./tools/doc_notes.js";
/**
* Contribute those pieces to core. Called once from startup, beside the other
* registrations there, rather than run as an import side effect: core's own LLM
* routes reach the stack directly, so what a chat can use must not depend on
* whether some module that happens to import this one was loaded first.
+ *
- * The providers and the help tools are registered as loaders, not values: their
- * modules carry the agent SDKs and the tool stack, and importing them here
- * would put all of that in the startup path of every install. The registration
++ * The providers are registered as loaders, not values: their modules carry the
++ * agent SDKs, and importing them here would put all of that in the startup path
++ * of every install. The registration
+ * seams are light on purpose — core resolves each loader on first use.
*/
export function registerServerLlmExtensions() {
- registerHostProvider("claude-agent", () => new ClaudeAgentProvider());
+ registerHostProvider("claude-agent", async () => new (await import("./providers/claude_agent.js")).ClaudeAgentProvider());
+ registerHostProvider("copilot-agent", async () => new (await import("./providers/copilot_agent.js")).CopilotAgentProvider());
+ registerHostProvider("antigravity-agent", async () => new (await import("./providers/antigravity_agent.js")).AntigravityAgentProvider());
+ registerHostProvider("codex-agent", async () => new (await import("./providers/codex_agent.js")).CodexAgentProvider());
- registerDocNoteHtmlReader(getDocNoteHtml);
registerSkillReader(loadSkillSheet);
- registerToolRegistryLoader(async () => (await import("./tools/help_tools.js")).helpTools);
}
diff --cc apps/standalone/src/local-server-worker.ts
index fa3c62eeae,d5daacce65..723e13cae6
--- a/apps/standalone/src/local-server-worker.ts
+++ b/apps/standalone/src/local-server-worker.ts
@@@ -86,10 -95,9 +95,11 @@@ let StandaloneLogService: typeof import
let StandaloneBackupService: typeof import('./lightweight/backup_provider').default;
let removeBackupLeftovers: typeof import('./lightweight/backup_provider').removeBackupLeftovers;
let StandaloneInAppHelpProvider: typeof import('./lightweight/in_app_help_provider').default;
+let inAppHelpProvider: InstanceType<typeof import('./lightweight/in_app_help_provider').default>;
+let inAppHelpLoaded: Promise<void>;
let translationProvider: typeof import('./lightweight/translation_provider').default;
let createConfiguredRouter: typeof import('./lightweight/browser_routes').createConfiguredRouter;
+ let waitForSahPoolRelease: typeof import('./lightweight/sql_provider').waitForSahPoolRelease;
// Instance state
let sqlProvider: InstanceType<typeof BrowserSqlProvider> | null = null;
@@@ -310,8 -335,12 +342,12 @@@ async function initialize(): Promise<vo
if (!response.ok) return null;
return new Uint8Array(await response.arrayBuffer());
},
- inAppHelp: new StandaloneInAppHelpProvider(),
+ inAppHelp: inAppHelpProvider,
image: (await import("./services/image_provider.js")).standaloneImageProvider,
+ // What `assertScriptingEnabled()` answers from. Read from a locked OPFS file rather
+ // than the database, because the SQL console is enabled separately and an `UPDATE
+ // options` would otherwise be all it takes to grant backend scripting.
+ config: securityConfig,
// Read before core opens anything, because what it says is whether to open the
// database at all: a page reloaded by the app itself comes back to the wizard.
setupMarker: await consumeSetupMarker(),
diff --cc apps/standalone/src/test_setup.ts
index 103b33ece5,c33f930c4d..777ebbe569
--- a/apps/standalone/src/test_setup.ts
+++ b/apps/standalone/src/test_setup.ts
@@@ -10,8 -10,8 +10,9 @@@ import { beforeAll } from "vitest"
import StandaloneBackupService from "./lightweight/backup_provider.js";
import BrowserExecutionContext from "./lightweight/cls_provider.js";
import BrowserCryptoProvider from "./lightweight/crypto_provider.js";
+import StandaloneInAppHelpProvider from "./lightweight/in_app_help_provider.js";
import StandalonePlatformProvider from "./lightweight/platform_provider.js";
+ import { registerShareProvider } from "./lightweight/share_provider.js";
import BrowserSqlProvider from "./lightweight/sql_provider.js";
import BrowserZipProvider from "./lightweight/zip_provider.js";
import { standaloneImageProvider } from "./services/image_provider.js";
diff --cc apps/standalone/vite.config.mts
index 0481905759,edb071f290..a5efb27374
--- a/apps/standalone/vite.config.mts
+++ b/apps/standalone/vite.config.mts
@@@ -110,78 -120,9 +120,80 @@@ const sqliteWasmPlugin = viteStaticCopy
]
});
+/** Source of the in-app help's images and attachments, and the URL the app requests them under. */
+const HELP_ASSETS_SOURCE = join(__dirname, "../../docs/User Guide");
+const HELP_ASSETS_DEST = join(__dirname, "dist/server-assets/help");
+const HELP_ASSETS_URL = "/server-assets/help/";
+
+const HELP_ASSET_MIME_TYPES: Record<string, string> = {
+ png: "image/png",
+ gif: "image/gif",
+ webp: "image/webp",
+ jpg: "image/jpeg",
+ jpeg: "image/jpeg",
+ svg: "image/svg+xml",
+ json: "application/json"
+};
+
+/** The guide's own files, as opposed to the content bundle that arrives with the server's assets. */
+function isHelpAsset(sourcePath: string) {
+ return !sourcePath.endsWith(".md") && !sourcePath.endsWith("!!!meta.json");
+}
+
+/**
+ * Serves the guide's images and attachments beside the content bundle that comes with the
+ * server's assets. They belong to the User Guide rather than to the server, so no other copy step
+ * brings them in, and the markdown they were built from is not needed at runtime.
+ *
+ * Both halves are needed: a build copies them into the output, and the dev server reads them
+ * straight from the guide — without that, requests fall through to the SPA fallback and every
+ * image on a help page comes back as index.html with a 200.
+ */
+function copyHelpAssetsPlugin(): Plugin {
+ return {
+ name: "trilium-copy-help-assets",
+ configureServer(server) {
+ server.middlewares.use((req, res, next) => {
+ if (!req.url?.startsWith(HELP_ASSETS_URL)) {
+ return next();
+ }
+
+ const relativePath = decodeURIComponent(req.url.slice(HELP_ASSETS_URL.length).split("?")[0]);
+ const filePath = join(HELP_ASSETS_SOURCE, relativePath);
+
+ // Same prefix-collision guard as the PDF.js middleware above.
+ if (!resolve(filePath).startsWith(resolve(HELP_ASSETS_SOURCE) + sep) || !isHelpAsset(filePath)) {
+ return next();
+ }
+
+ // Anything not found here — the content bundle and the tree — is copied in from
+ // the server's assets, so it belongs to the next middleware.
+ if (!fs.existsSync(filePath) || !fs.statSync(filePath).isFile()) {
+ return next();
+ }
+
+ const extension = filePath.split(".").pop()?.toLowerCase() ?? "";
+ res.setHeader("Content-Type", HELP_ASSET_MIME_TYPES[extension] ?? "application/octet-stream");
+ fs.createReadStream(filePath).pipe(res);
+ });
+ },
+ closeBundle() {
+ if (isDev) {
+ return;
+ }
+
+ fs.cpSync(HELP_ASSETS_SOURCE, HELP_ASSETS_DEST, {
+ recursive: true,
+ dereference: true,
+ filter: isHelpAsset
+ });
+ }
+ };
+}
+
let plugins: any = [
+ stripUniverHyphenation(),
+ stripUniverEmojiData(),
sqliteWasmDedupePlugin(),
sqliteWasmPlugin,
viteStaticCopy({
@@@ -208,7 -151,24 +220,25 @@@
}
]
}),
+ copyHelpAssetsPlugin(),
+ // What the share theme's own pages load besides its bundle: the icon-pack fonts the client ships
+ // and the logo, each at the path content_renderer.ts writes into the page. The server answers
+ // these from express.static routes it registers in routes/assets.ts; here they are copied into
+ // the build instead.
+ viteStaticCopy({
+ targets: [
+ {
+ src: "../../client/src/fonts/**/*",
+ dest: "share/assets/fonts",
+ rename: { stripBase: 3 }
+ },
+ {
+ src: "../../server/src/assets/images/**/*",
+ dest: `assets/v${coreVersion}/images`,
+ rename: { stripBase: 4 }
+ }
+ ]
+ }),
// PDF.js viewer for PDF preview support
// stripBase: 4 removes packages/pdfjs-viewer/dist/web (or /build)
viteStaticCopy({
diff --cc docs/User Guide/!!!meta.json
index 0b38f030f9,a18e3d3084..ea9d749320
--- a/docs/User Guide/!!!meta.json
+++ b/docs/User Guide/!!!meta.json
@@@ -1901,16 -1147,8 +1147,8 @@@
"role": "image",
"mime": "image/jpg",
"position": 10,
- "dataFileName": "Synchronization_image.png"
+ "dataFileName": "Synchronization_image.jpg"
},
- {
- "attachmentId": "wlHlhXqZ0i1S",
- "title": "sync-config.png",
- "role": "image",
- "mime": "image/png",
- "position": 10,
- "dataFileName": "Synchronization_sync-config.png"
- },
{
"attachmentId": "x0t06ATHph6b",
"title": "sync-init.png",
@@@ -2310,9 -1352,43 +1352,43 @@@
"role": "image",
"mime": "image/jpg",
"position": 10,
- "dataFileName": "Data directory_image.png"
+ "dataFileName": "Data directory_image.jpg"
}
]
+ },
+ {
+ "isClone": false,
+ "noteId": "ebyr7ES2SwOW",
+ "notePath": [
+ "pOsGYCXsbNQG",
+ "Otzi9La2YAUX",
+ "ebyr7ES2SwOW"
+ ],
+ "title": "Downloaded resources",
+ "notePosition": 90,
+ "prefix": null,
+ "isExpanded": false,
+ "type": "text",
+ "mime": "text/html",
+ "attributes": [
+ {
+ "type": "label",
+ "name": "shareAlias",
+ "value": "downloaded-resources",
+ "isInheritable": false,
+ "position": 10
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-download",
+ "isInheritable": false,
+ "position": 20
+ }
+ ],
+ "format": "markdown",
+ "dataFileName": "Downloaded resources.md",
+ "attachments": []
}
]
},
@@@ -2482,23 -1507,7 +1507,7 @@@
"role": "image",
"mime": "image/jpg",
"position": 10,
- "dataFileName": "1_Vertical and horizontal layout_image.png"
+ "dataFileName": "1_Vertical and horizontal layout_image.jpg"
- },
- {
- "attachmentId": "NVjM5z6IsNZf",
- "title": "image.png",
- "role": "image",
- "mime": "image/png",
- "position": 10,
- "dataFileName": "2_Vertical and horizontal layout_image.png"
- },
- {
- "attachmentId": "Z2F8ipVjwugg",
- "title": "image.png",
- "role": "image",
- "mime": "image/png",
- "position": 10,
- "dataFileName": "3_Vertical and horizontal layout_image.png"
}
]
},
@@@ -3258,7 -1913,7 +1913,7 @@@
"role": "image",
"mime": "image/jpg",
"position": 10,
- "dataFileName": "Ribbon_image.jpg"
- "dataFileName": "Launch Bar_image.png"
++ "dataFileName": "Launch Bar_image.jpg"
}
]
},
@@@ -10008,32 -5277,8 +5277,8 @@@
"role": "image",
"mime": "image/jpg",
"position": 10,
- "dataFileName": "Developer-specific formatting_image.png"
+ "dataFileName": "Developer-specific formatting_image.jpg"
},
- {
- "attachmentId": "HP741oAz3ebU",
- "title": "image.png",
- "role": "image",
- "mime": "image/png",
- "position": 10,
- "dataFileName": "Developer-specific formatting_image.png"
- },
- {
- "attachmentId": "r8POqVPCOgmq",
- "title": "image.png",
- "role": "image",
- "mime": "image/png",
- "position": 10,
- "dataFileName": "1_Developer-specific formatting_image.png"
- },
- {
- "attachmentId": "UkvE6wdUVadb",
- "title": "image.png",
- "role": "image",
- "mime": "image/png",
- "position": 10,
- "dataFileName": "2_Developer-specific formatting_image.png"
- },
{
"attachmentId": "V9BY5v8WX15Q",
"title": "image.png",
@@@ -10048,15 -5293,7 +5293,7 @@@
"role": "image",
"mime": "image/png",
"position": 10,
- "dataFileName": "3_Developer-specific formatting_image.png"
- },
- {
- "attachmentId": "yKVC2F773Mg7",
- "title": "image.png",
- "role": "image",
- "mime": "image/png",
- "position": 10,
- "dataFileName": "4_Developer-specific formatting_image.png"
- "dataFileName": "2_Developer-specific formatting_image.png"
++ "dataFileName": "Developer-specific formatting_image.png"
}
],
"dirFileName": "Developer-specific formatting",
@@@ -10153,7 -5347,7 +5347,7 @@@
"role": "image",
"mime": "image/png",
"position": 10,
-- "dataFileName": "1_Code blocks_image.png"
++ "dataFileName": "Code blocks_image.png"
}
]
}
@@@ -10339,23 -5489,23 +5489,23 @@@
"role": "image",
"mime": "image/jpg",
"position": 10,
- "dataFileName": "1_Formatting toolbar_image.jpg"
- "dataFileName": "1_Formatting toolbar_image.png"
++ "dataFileName": "Formatting toolbar_image.jpg"
},
{
- "attachmentId": "MMeih4nJVgNk",
+ "attachmentId": "jYEbPqDcUCNQ",
"title": "image.png",
"role": "image",
- "mime": "image/jpg",
+ "mime": "image/png",
"position": 10,
- "dataFileName": "2_Formatting toolbar_image.jpg"
- "dataFileName": "2_Formatting toolbar_image.png"
++ "dataFileName": "1_Formatting toolbar_image.png"
},
{
- "attachmentId": "SGaPJHzNyLLV",
+ "attachmentId": "WV5kfOEFZdMa",
"title": "image.png",
"role": "image",
- "mime": "image/jpg",
+ "mime": "image/png",
"position": 10,
- "dataFileName": "3_Formatting toolbar_image.jpg"
- "dataFileName": "3_Formatting toolbar_image.png"
++ "dataFileName": "2_Formatting toolbar_image.png"
}
]
},
@@@ -10618,24 -5668,8 +5668,8 @@@
"role": "image",
"mime": "image/jpg",
"position": 10,
- "dataFileName": "2_Images_image.png"
+ "dataFileName": "2_Images_image.jpg"
},
- {
- "attachmentId": "g7xB3E2Dva2q",
- "title": "image.png",
- "role": "image",
- "mime": "image/png",
- "position": 10,
- "dataFileName": "1_Images_image.png"
- },
- {
- "attachmentId": "Ilz9SuEj39RF",
- "title": "image.png",
- "role": "image",
- "mime": "image/png",
- "position": 10,
- "dataFileName": "2_Images_image.png"
- },
{
"attachmentId": "NZJRGKS6yDeg",
"title": "image.png",
@@@ -10650,15 -5684,7 +5684,7 @@@
"role": "image",
"mime": "image/png",
"position": 10,
- "dataFileName": "3_Images_image.png"
- },
- {
- "attachmentId": "SoDKgOmDoyc1",
- "title": "image.png",
- "role": "image",
- "mime": "image/png",
- "position": 10,
-- "dataFileName": "4_Images_image.png"
++ "dataFileName": "Images_image.png"
}
],
"dirFileName": "Images",
@@@ -11555,16 -6244,8 +6244,8 @@@
"role": "image",
"mime": "image/jpg",
"position": 10,
- "dataFileName": "Lists_image.png"
+ "dataFileName": "Lists_image.jpg"
},
- {
- "attachmentId": "IZewdPx4evIx",
- "title": "image.png",
- "role": "image",
- "mime": "image/png",
- "position": 10,
- "dataFileName": "3_Lists_image.png"
- },
{
"attachmentId": "JopMc0iA0dqA",
"title": "image.png",
@@@ -11579,16 -6260,8 +6260,8 @@@
"role": "image",
"mime": "image/jpg",
"position": 10,
- "dataFileName": "2_Lists_image.png"
+ "dataFileName": "2_Lists_image.jpg"
},
- {
- "attachmentId": "PGeVq8YAQBFA",
- "title": "image.png",
- "role": "image",
- "mime": "image/png",
- "position": 10,
- "dataFileName": "4_Lists_image.png"
- },
{
"attachmentId": "VgoG6BtlLYn7",
"title": "image.png",
@@@ -12494,15 -6785,7 +6785,7 @@@
"role": "image",
"mime": "image/jpg",
"position": 10,
- "dataFileName": "Code_image.png"
+ "dataFileName": "Code_image.jpg"
- },
- {
- "attachmentId": "iKJbcEUkME1a",
- "title": "image.png",
- "role": "image",
- "mime": "image/jpg",
- "position": 10,
- "dataFileName": "1_Code_image.jpg"
}
]
},
@@@ -18573,23 -9987,15 +9987,15 @@@
"role": "image",
"mime": "image/jpg",
"position": 10,
- "dataFileName": "SQL Console_image.png"
+ "dataFileName": "SQL Console_image.jpg"
},
- {
- "attachmentId": "gIbK7NNLu3iZ",
- "title": "image.png",
- "role": "image",
- "mime": "image/png",
- "position": 10,
- "dataFileName": "SQL Console_image.png"
- },
{
"attachmentId": "wdBs3e0MApgs",
"title": "image.png",
"role": "image",
"mime": "image/png",
"position": 10,
-- "dataFileName": "1_SQL Console_image.png"
++ "dataFileName": "SQL Console_image.png"
}
]
}
diff --cc docs/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/1_SQL Console_image.png
index a395a969b4,a395a969b4..0000000000
deleted file mode 100644,100644
Binary files differ
diff --cc docs/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/SQL Console.md
index d28c0c0038,68bbcb4faf..138448021e
--- a/docs/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/SQL Console.md
+++ b/docs/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/SQL Console.md
@@@ -16,7 -16,7 +16,7 @@@ It can be accessed by going to the <a
* For queries that return a result, the data will displayed in a table.
* For statements (e.g. `INSERT`, `UPDATE`), the number of affected rows is displayed.
--<figure class="image"><img style="aspect-ratio:1124/571;" src="1_SQL Console_image.png" width="1124" height="571"></figure>
++<figure class="image"><img style="aspect-ratio:1124/571;" src="SQL Console_image.png" width="1124" height="571"></figure>
### Interacting with the table
diff --cc docs/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/SQL Console_image.png
index 1b1834ba1f,32a91fc2f3..a395a969b4
Binary files differ
diff --cc docs/User Guide/User Guide/Basic Concepts and Features/Themes.md
index d929aafae3,9620b3b34c..369d66a1cc
--- a/docs/User Guide/User Guide/Basic Concepts and Features/Themes.md
+++ b/docs/User Guide/User Guide/Basic Concepts and Features/Themes.md
@@@ -110,9 -112,9 +112,9 @@@ For example
When Trilium's frontend starts, all notes labeled with `appCss` are automatically included in the style element of the HTML page.
- After making changes, press <kbd>Ctrl</kbd> + <kbd>R</kbd> to reload the frontend and apply your new styles.
+ After making changes, press Ctrl + R to reload the frontend and apply your new styles.
-![](Themes_image.png)
+![](Themes_image.jpg)
### Styling Specific Notes in the Tree
diff --cc docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/1_Vertical and horizontal layout_image.png
index 5fda8a0285,2f200ca850..0000000000
deleted file mode 100644,100644
Binary files differ
diff --cc docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Vertical and horizontal layout.md
index 65cb55ae9e,6dca758201..5d3b1d9866
--- a/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Vertical and horizontal layout.md
+++ b/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Vertical and horizontal layout.md
@@@ -10,10 -8,10 +8,10 @@@ The vertical layout is Trilium's origin
* The <a class="reference-link" href="Launch%20Bar.md">Launch Bar</a> is positioned on the left side of the screen, with buttons being laid out vertically.
* The tab bar is at the top, but to the right of the <a class="reference-link" href="Note%20Tree.md">Note Tree</a>.
* The <a class="reference-link" href="../Navigation/Quick%20search.md">Quick search</a> is at the top of the <a class="reference-link" href="Note%20Tree.md">Note Tree</a>.
- * The <a class="reference-link" href="Note%20Tree.md">Note Tree</a> can be collapsed by pressing the ![](3_Vertical%20and%20horizontal%20layout_image.png) button at the bottom of the <a class="reference-link" href="Launch%20Bar.md">Launch Bar</a>.
- * The <a class="reference-link" href="Global%20menu.md">Global menu</a> can be accessed via the ![](2_Vertical%20and%20horizontal%20layout_image.png) icon at the top of the <a class="reference-link" href="Launch%20Bar.md">Launch Bar</a>.
+ * The <a class="reference-link" href="Note%20Tree.md">Note Tree</a> can be collapsed by pressing the <span class="tn-icon bx bx-chevrons-left"></span> button at the bottom of the <a class="reference-link" href="Launch%20Bar.md">Launch Bar</a>.
+ * The <a class="reference-link" href="Global%20menu.md">Global menu</a> can be accessed via the <span class="tn-icon cke cke-trilium"></span> icon at the top of the <a class="reference-link" href="Launch%20Bar.md">Launch Bar</a>.
-![](1_Vertical%20and%20horizontal%20layout_image.png)
+![](1_Vertical%20and%20horizontal%20layout_image.jpg)
### Horizontal layout
@@@ -22,10 -20,10 +20,10 @@@ The horizontal layout is a more traditi
* The <a class="reference-link" href="Launch%20Bar.md">Launch Bar</a> is at the top of the screen, with the buttons laid horizontally.
* The tab bar is at the top of the screen, but now covers the entirety of the width, allowing for more tabs to be displayed at once.
* The <a class="reference-link" href="../Navigation/Quick%20search.md">Quick search</a> is now part of the <a class="reference-link" href="Launch%20Bar.md">Launch Bar</a>. It can be moved around according to preference and even removed if needed.
- * The <a class="reference-link" href="Note%20Tree.md">Note Tree</a> can be collapsed by pressing the small ![](1_Vertical%20and%20horizontal%20layout_image.png) button to the left of the first tab.
- * The <a class="reference-link" href="Global%20menu.md">Global menu</a> can be accessed via the ![](Vertical%20and%20horizontal%20layout_image.png) button at the end of the <a class="reference-link" href="Launch%20Bar.md">Launch Bar</a>.
+ * The <a class="reference-link" href="Note%20Tree.md">Note Tree</a> can be collapsed by pressing the small <span class="tn-icon bx bx-sidebar"></span> button to the left of the first tab.
+ * The <a class="reference-link" href="Global%20menu.md">Global menu</a> can be accessed via the <span class="tn-icon bx bx-menu"></span> button at the end of the <a class="reference-link" href="Launch%20Bar.md">Launch Bar</a>.
-![](Vertical%20and%20horizontal%20layout_image.png)
+![](Vertical%20and%20horizontal%20layout_image.jpg)
## Changing the layout
diff --cc docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Vertical and horizontal layout_image.png
index 9575b759cc,17a6d28854..0000000000
deleted file mode 100644,100644
Binary files differ
diff --cc docs/User Guide/User Guide/Note Types/Code.md
index e79da14486,82c9e6cde4..951ca1221f
--- a/docs/User Guide/User Guide/Note Types/Code.md
+++ b/docs/User Guide/User Guide/Note Types/Code.md
@@@ -10,13 -10,20 +10,20 @@@ This can be useful for a few things
For shorter snippets of code that can be embedded in [Text](Text.md) notes, see [Code blocks](Text/Developer-specific%20formatting/Code%20blocks.md).
-![](Code_image.png)
+![](Code_image.jpg)
+ ## Creating a code note
+
+ In the [Note Tree](../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree.md), right-click a note and select _Insert child note_ or _Insert note after_, then:
+
+ * To create a plain text code note, select _Code_.
+ * To create a code note in a given language, hover _Code_ and select the language. The list shows the languages enabled in the options (see below), and ends with _Configure code notes..._, which opens them.
+
## Adjusting the language of a code note
- In the [Ribbon](../Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md), look for the _Note type_ selector and click it to reveal the possible note types. Inside of it there will be a section called _Code_, select any one of the languages.
+ To change the language of a code note, look for the <span class="tn-icon bx bx-code"></span> icon in the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Status%20bar.md">Status bar</a>. When clicked it will reveal the list of available languages (which can be customized according to the section below). The menu also features a search bar to quickly filter, and icons to visually distinguish some of the programming languages.
- ![](1_Code_image.jpg)
+ On the <a class="reference-link" href="../Installation%20%26%20Setup/Mobile%20Frontend.md">Mobile Frontend</a>, the same list is available in the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20menu.md">Note menu</a> → _Change language mode_.
## Adjusting the list of languages
diff --cc docs/User Guide/User Guide/Note Types/Text/1_Developer-specific formatting_image.png
index 295d3c8099,ef28ed50d4..0000000000
deleted file mode 100644,100644
Binary files differ
diff --cc docs/User Guide/User Guide/Note Types/Text/1_Formatting toolbar_image.png
index 0000000000,bc6bd96c47..785ce7fc54
mode 000000,100644..100644
Binary files differ
diff --cc docs/User Guide/User Guide/Note Types/Text/1_Images_image.png
index 9f8ecc326c,08a40b0d05..0000000000
deleted file mode 100644,100644
Binary files differ
diff --cc docs/User Guide/User Guide/Note Types/Text/1_Lists_image.png
index 4a17f481cc,ed6f4c37ca..0000000000
deleted file mode 100644,100644
Binary files differ
diff --cc docs/User Guide/User Guide/Note Types/Text/2_Developer-specific formatting_image.png
index 67c4c43fee,c0cf731a5f..0000000000
deleted file mode 100644,100644
Binary files differ
diff --cc docs/User Guide/User Guide/Note Types/Text/2_Formatting toolbar_image.png
index 0000000000,785ce7fc54..44b3746526
mode 000000,100644..100644
Binary files differ
diff --cc docs/User Guide/User Guide/Note Types/Text/2_Images_image.png
index 2e37305caf,297d49ee5b..0000000000
deleted file mode 100644,100644
Binary files differ
diff --cc docs/User Guide/User Guide/Note Types/Text/2_Lists_image.png
index 2473cd3102,0ab30524bc..0000000000
deleted file mode 100644,100644
Binary files differ
diff --cc docs/User Guide/User Guide/Note Types/Text/3_Images_image.png
index 8fa28fbf98,731df83bb9..0000000000
deleted file mode 100644,100644
Binary files differ
diff --cc docs/User Guide/User Guide/Note Types/Text/3_Lists_image.png
index 3caf2d880c,30a9511b08..0000000000
deleted file mode 100644,100644
Binary files differ
diff --cc docs/User Guide/User Guide/Note Types/Text/4_Images_image.png
index 32f99c37cf,8fa28fbf98..0000000000
deleted file mode 100644,100644
Binary files differ
diff --cc docs/User Guide/User Guide/Note Types/Text/4_Lists_image.png
index ee7a6bdead,8369a03c61..0000000000
deleted file mode 100644,100644
Binary files differ
diff --cc docs/User Guide/User Guide/Note Types/Text/Developer-specific formatting.md
index d0bf46cc96,7f8671416b..e3865be307
--- a/docs/User Guide/User Guide/Note Types/Text/Developer-specific formatting.md
+++ b/docs/User Guide/User Guide/Note Types/Text/Developer-specific formatting.md
@@@ -3,7 -3,7 +3,7 @@@
Inline code formats text using a monospace font to indicate technical content in a sentence such as code, paths, etc.
- ![](3_Developer-specific%20formatting_image.png)
-![](2_Developer-specific%20formatting_image.png)
++![](Developer-specific%20formatting_image.png)
Example of inline code being used to illustrate file system paths as well as shell commands (`git` in this case).
@@@ -28,9 -29,9 +29,9 @@@ See the dedicated documentation for mor
This allows marking a portion of text as a shortcut key.
-![](Developer-specific%20formatting_image.png)
+![](Developer-specific%20formatting_image.jpg)
- To apply this style, press the ![](4_Developer-specific%20formatting_image.png) button in ![](Developer-specific%20formatting_image.png) group from the [Formatting toolbar](Formatting%20toolbar.md). On the floating toolbar, the buttons appear when selecting a text.
+ To apply this style, press the <span class="tn-icon cke cke-trilium-kbd"></span> button in <span class="tn-icon bx bx-text"></span> group from the [Formatting toolbar](Formatting%20toolbar.md). On the floating toolbar, the buttons appear when selecting a text.
Alternatively, press the <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>K</kbd> combination to apply keyboard shortcut formatting to the current text selection.
diff --cc docs/User Guide/User Guide/Note Types/Text/Developer-specific formatting/1_Code blocks_image.png
index 6cd7f4b4e3,6cd7f4b4e3..0000000000
deleted file mode 100644,100644
Binary files differ
diff --cc docs/User Guide/User Guide/Note Types/Text/Developer-specific formatting/Code blocks.md
index 0c8bc31034,baf8d45d9d..03b55774b6
--- a/docs/User Guide/User Guide/Note Types/Text/Developer-specific formatting/Code blocks.md
+++ b/docs/User Guide/User Guide/Note Types/Text/Developer-specific formatting/Code blocks.md
@@@ -54,7 -60,7 +60,7 @@@ Should you encounter any issues after t
## Changing the language of a code block
Simply click anywhere inside the code block and press again the code block button in the <a class="reference-link" href="../Formatting%20toolbar.md">Formatting toolbar</a>:
--![](1_Code%20blocks_image.png)
++![](Code%20blocks_image.png)
## Adjusting the list of languages
diff --cc docs/User Guide/User Guide/Note Types/Text/Developer-specific formatting/Code blocks_image.png
index cabd7f48a3,ef28ed50d4..6cd7f4b4e3
Binary files differ
diff --cc docs/User Guide/User Guide/Note Types/Text/Developer-specific formatting_image.png
index 9580128a2f,6ae0fd87ae..c0cf731a5f
Binary files differ
diff --cc docs/User Guide/User Guide/Note Types/Text/Formatting toolbar.md
index 7586d847f2,cd2e4a7b8e..0f05cb15e3
--- a/docs/User Guide/User Guide/Note Types/Text/Formatting toolbar.md
+++ b/docs/User Guide/User Guide/Note Types/Text/Formatting toolbar.md
@@@ -10,17 -10,19 +10,19 @@@ The floating bar is a more minimalist o
### Block-level popup
The first popup is the block-level popup. This will appear to the left of the current paragraph you are currently editing, as a sequence of dots:
- ![](1_Formatting%20toolbar_image.jpg)
-![](1_Formatting%20toolbar_image.png)
++![](Formatting%20toolbar_image.jpg)
Clicking this popup will reveal the formatting options that are specific to the entire paragraph, such as setting a heading, lists, tables, etc.
- ![](3_Formatting%20toolbar_image.jpg)
+ The dots are also a drag handle: drag them to move the paragraph, all the selected paragraphs, or a selected element such as an image, a table or an included note to another place in the note. Right-clicking them copies a reference to the paragraph or to the selected paragraphs, see <a class="reference-link" href="Block%20references.md">Block references</a>.
+
-<figure class="image"><img style="aspect-ratio:1404/156;" src="3_Formatting toolbar_image.png" width="1404" height="156"></figure>
++<figure class="image"><img style="aspect-ratio:1404/156;" src="2_Formatting toolbar_image.png" width="1404" height="156"></figure>
### Inline popup
The inline popup appears automatically when selecting a text:
- ![](Formatting%20toolbar_image.jpg)
-<figure class="image"><img style="aspect-ratio:1008/154;" src="2_Formatting toolbar_image.png" width="1008" height="154"></figure>
++<figure class="image"><img style="aspect-ratio:1008/154;" src="1_Formatting toolbar_image.png" width="1008" height="154"></figure>
All the options here apply only to the selected portion of text, such as changing the font size, or making the text bold.
diff --cc docs/User Guide/User Guide/Note Types/Text/Formatting toolbar_image.jpg
index 85578b78ea,bc6bd96c47..bc6bd96c47
Binary files differ
diff --cc docs/User Guide/User Guide/Note Types/Text/Images.md
index 41a37fa0a7,db3088444b..81cadf3782
--- a/docs/User Guide/User Guide/Note Types/Text/Images.md
+++ b/docs/User Guide/User Guide/Note Types/Text/Images.md
@@@ -26,7 -28,7 +28,7 @@@ The automatic download of images is ena
## Configuring the images
Clicking on an image will reveal a popup with multiple options:
- ![](3_Images_image.png)
-![](4_Images_image.png)
++![](Images_image.png)
### Alignment
@@@ -34,10 -36,14 +36,14 @@@ The first set of options configure the
| Icon | Option | Preview | Description |
| --- | --- | --- | --- |
- | ![](2_Images_image.png) | Inline | ![](Images_image.jpg) | As the name suggests, the name can be put inside a paragraph and moved around similarly as if it was a block of text. Use drag & drop or cut-paste to move it around. |
- | ![](4_Images_image.png) | Centered image | ![](1_Images_image.jpg) | The image will be displayed as a block and centered, not allowing text in either the left or right of it. |
- | ![](1_Images_image.png) | Wrap text | ![](3_Images_image.jpg) | The image will be displayed to the left or the right of the text. |
- | ![](Images_image.png) | Block align | ![](2_Images_image.jpg) | Similarly to _Centered image_, the image will be displayed as a block and aligned either to the left or to the right, but not allowing text to flow on either of its sides. |
-| <span class="tn-icon cke cke-object-inline"></span> | Inline | ![](Images_image.png) | As the name suggests, the name can be put inside a paragraph and moved around similarly as if it was a block of text. Use drag & drop or cut-paste to move it around. |
-| <span class="tn-icon cke cke-object-center"></span> | Centered image | ![](1_Images_image.png) | The image will be displayed as a block and centered, not allowing text in either the left or right of it. |
-| <span class="tn-icon cke cke-object-inline-right"></span> | Wrap text | ![](3_Images_image.png) | The image will be displayed to the left or the right of the text. |
-| <span class="tn-icon cke cke-object-left"></span> | Block align | ![](2_Images_image.png) | Similarly to _Centered image_, the image will be displayed as a block and aligned either to the left or to the right, but not allowing text to flow on either of its sides. |
++| <span class="tn-icon cke cke-object-inline"></span> | Inline | ![](Images_image.jpg) | As the name suggests, the name can be put inside a paragraph and moved around similarly as if it was a block of text. Use drag & drop or cut-paste to move it around. |
++| <span class="tn-icon cke cke-object-center"></span> | Centered image | ![](1_Images_image.jpg) | The image will be displayed as a block and centered, not allowing text in either the left or right of it. |
++| <span class="tn-icon cke cke-object-inline-right"></span> | Wrap text | ![](3_Images_image.jpg) | The image will be displayed to the left or the right of the text. |
++| <span class="tn-icon cke cke-object-left"></span> | Block align | ![](2_Images_image.jpg) | Similarly to _Centered image_, the image will be displayed as a block and aligned either to the left or to the right, but not allowing text to flow on either of its sides. |
+
+ ### Drawing over an image
+
+ To draw or write over an image, press the <span class="tn-icon bx bxs-pen"></span> _Convert image to a drawing canvas_ button of its toolbar. The image becomes a drawing canvas that shows all of it, locked in place. See the drawing canvases section of <a class="reference-link" href="Include%20Note.md">Include Note</a>.
## Compression
diff --cc docs/User Guide/User Guide/Note Types/Text/Images_image.png
index 938a0d2b37,a4e23ef9a8..8fa28fbf98
Binary files differ
diff --cc docs/User Guide/User Guide/Note Types/Text/Lists.md
index 7d21488c38,01cd68adac..b56bdfc084
--- a/docs/User Guide/User Guide/Note Types/Text/Lists.md
+++ b/docs/User Guide/User Guide/Note Types/Text/Lists.md
@@@ -23,14 -23,40 +23,40 @@@ For bulleted and numbered lists, it's p
It possible to add content-level blocks such as headings, code blocks, tables within lists, as follows:
- | | | |
- | --- | --- | --- |
- | 1 | ![](2_Lists_image.jpg) | First, create a list. |
- | 2 | ![](4_Lists_image.jpg) | Press Enter to create a new list item. |
- | 3 | ![](1_Lists_image.jpg) | Press Backspace to get rid of the bullet point. Notice the cursor position. |
- | 4 | <img class="image_resized" style="aspect-ratio:676/112;width:98.29%;" src="5_Lists_image.jpg" width="676" height="112"> | At this point, insert any desired block-level item such as a code block. |
- | 5 | <img class="image_resized" style="aspect-ratio:675/129;width:94.22%;" src="3_Lists_image.jpg" width="675" height="129"> | To continue with a new bullet point, press Enter until the cursor moves to a new blank position. |
- | 6 | <img class="image_resized" style="aspect-ratio:675/129;width:100%;" src="Lists_image.jpg" width="675" height="129"> | Press Enter once more to create the new bullet. |
+ <table>
+ <tbody>
+ <tr>
+ <td>1</td>
- <td><img src="2_Lists_image.png"></td>
++ <td><img src="2_Lists_image.jpg"></td>
+ <td>First, create a list.</td>
+ </tr>
+ <tr>
+ <td>2</td>
- <td><img src="4_Lists_image.png"></td>
++ <td><img src="4_Lists_image.jpg"></td>
+ <td>Press Enter to create a new list item.</td>
+ </tr>
+ <tr>
+ <td>3</td>
- <td><img src="1_Lists_image.png"></td>
++ <td><img src="1_Lists_image.jpg"></td>
+ <td>Press Backspace to get rid of the bullet point. Notice the cursor position.</td>
+ </tr>
+ <tr>
+ <td>4</td>
- <td><img class="image_resized" style="aspect-ratio:676/112;width:98.29%;" src="5_Lists_image.png" width="676" height="112"></td>
++ <td><img class="image_resized" style="aspect-ratio:676/112;width:98.29%;" src="5_Lists_image.jpg" width="676" height="112"></td>
+ <td>At this point, insert any desired block-level item such as a code block.</td>
+ </tr>
+ <tr>
+ <td>5</td>
- <td><img class="image_resized" style="aspect-ratio:675/129;width:94.22%;" src="3_Lists_image.png" width="675" height="129"></td>
++ <td><img class="image_resized" style="aspect-ratio:675/129;width:94.22%;" src="3_Lists_image.jpg" width="675" height="129"></td>
+ <td>To continue with a new bullet point, press Enter until the cursor moves to a new blank position.</td>
+ </tr>
+ <tr>
+ <td>6</td>
- <td><img class="image_resized" style="aspect-ratio:675/129;width:100%;" src="Lists_image.png" width="675" height="129"></td>
++ <td><img class="image_resized" style="aspect-ratio:675/129;width:100%;" src="Lists_image.jpg" width="675" height="129"></td>
+ <td>Press Enter once more to create the new bullet.</td>
+ </tr>
+ </tbody>
+ </table>
The same principle applies to all three list types (bullet, numbered and to-do).
diff --cc docs/User Guide/User Guide/Note Types/Text/Lists_image.png
index 1282f27ec0,32992762ae..0000000000
deleted file mode 100644,100644
Binary files differ
diff --cc docs/User Guide/User Guide/Theme development/Creating a custom theme.md
index 271e457d8d,b3005c7046..2674afb51d
--- a/docs/User Guide/User Guide/Theme development/Creating a custom theme.md
+++ b/docs/User Guide/User Guide/Theme development/Creating a custom theme.md
@@@ -9,11 -9,22 +9,22 @@@ As such, the first step is to create a
## Step 2. Create the theme
- | | |
- | --- | --- |
- | ![](Creating%20a%20custom%20theme_3_Creating%20a%20custom%20theme_im.jpg) | Themes are code notes with a special attribute. Start by creating a new code note. |
- | ![](Creating%20a%20custom%20theme_1_Creating%20a%20custom%20theme_im.jpg) | Then change the note type to a CSS code. |
- | ![](Creating%20a%20custom%20theme_Creating%20a%20custom%20theme_im.jpg) | In the _Owned Attributes_ section define the `#appTheme` attribute to point to any desired name. This is the name that will show up in the appearance section in settings. |
+ <table>
+ <tbody>
+ <tr>
- <td><img src="Creating a custom theme_3_Creating a custom theme_im.png"></td>
++ <td><img src="Creating a custom theme_3_Creating a custom theme_im.jpg"></td>
+ <td>Themes are code notes with a special attribute. Start by creating a new code note.</td>
+ </tr>
+ <tr>
- <td><img src="Creating a custom theme_1_Creating a custom theme_im.png"></td>
++ <td><img src="Creating a custom theme_1_Creating a custom theme_im.jpg"></td>
+ <td>Then change the note type to a CSS code.</td>
+ </tr>
+ <tr>
- <td><img src="Creating a custom theme_Creating a custom theme_im.png"></td>
++ <td><img src="Creating a custom theme_Creating a custom theme_im.jpg"></td>
+ <td>In the attributes of the note (the&nbsp;<span class="tn-icon bx bx-list-check"></span> button in the&nbsp;<a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Status%20bar.md">Status bar</a>), define the <code>#appTheme</code> attribute to point to any desired name. This is the name that will show up in the appearance section in settings.</td>
+ </tr>
+ </tbody>
+ </table>
## Step 3. Define the theme's CSS
@@@ -35,9 -46,9 +46,9 @@@ Refresh the application (Ctrl+Shift+R i
Afterwards the application will refresh itself with the new theme:
-![](Creating%20a%20custom%20theme_4_Creating%20a%20custom%20theme_im.png)
+![](Creating%20a%20custom%20theme_4_Creating%20a%20custom%20theme_im.jpg)
- Do note that the theme will be based off of the legacy theme. To override that and base the theme on the new TriliumNext theme, see: [Theme base (legacy vs. next)](Customize%20the%20Next%20theme.md)
+ Do note that the theme will be based off of the legacy theme. To override that and base the theme on the Modern theme, see <a class="reference-link" href="Customize%20the%20Next%20theme.md">Customize the Next theme</a>.
## Step 5. Making changes
diff --cc packages/commons/src/index.ts
index 81ef5074f6,89c15ba612..83613ed983
--- a/packages/commons/src/index.ts
+++ b/packages/commons/src/index.ts
@@@ -3,10 -3,13 +3,14 @@@ export * from "./lib/katex_macros.js"
export * from "./lib/options_interface.js";
export * from "./lib/keyboard_actions_interface.js";
export * from "./lib/hidden_subtree.js";
+export * from "./lib/help_meta.js";
export * from "./lib/rows.js";
+ export * from "./lib/safe_template.js";
export * from "./lib/test-utils.js";
export * from "./lib/attachment_roles.js";
+ export * from "./lib/custom_fonts.js";
+ export * from "./lib/font_mimes.js";
+ export * from "./lib/icon_font_metrics.js";
export * from "./lib/image_mimes.js";
export * from "./lib/mime_type.js";
export * from "./lib/office.js";
diff --cc packages/trilium-core/src/becca/becca_loader.ts
index 02c6ffe54e,610c936579..58d186da04
--- a/packages/trilium-core/src/becca/becca_loader.ts
+++ b/packages/trilium-core/src/becca/becca_loader.ts
@@@ -76,166 -78,19 +81,179 @@@ function load()
getLog().info(`Becca (note cache) load took ${Date.now() - start}ms`);
}
+ // The order each entity's update() destructures its row in. None of these columns holds a
+ // BLOB or an integer large enough for getRawRowsBulk()'s JSON round-trip to lose precision.
+ const NOTE_COLUMNS = [
+ "noteId", "title", "type", "mime", "isProtected", "blobId",
+ "dateCreated", "dateModified", "utcDateCreated", "utcDateModified"
+ ];
+ const BRANCH_COLUMNS = [
+ "branchId", "noteId", "parentNoteId", "prefix", "notePosition", "isExpanded", "utcDateModified"
+ ];
+ const ATTRIBUTE_COLUMNS = [
+ "attributeId", "noteId", "type", "name", "value", "isInheritable", "position", "utcDateModified"
+ ];
+
+/**
+ * Builds the becca entities of every registered virtual note provider (see
+ * `services/virtual_notes.ts`). Runs on every load, after the persisted entities: virtual
+ * entities live only in becca, so a full reload (e.g. `becca_loader.reload()`) both refreshes
+ * them and is the way to pick up provider-side changes.
+ */
+function injectVirtualSubtrees() {
+ const log = getLog();
+ let injectedAny = false;
+
+ for (const provider of getVirtualNoteProviders()) {
+ if (!(provider.parentNoteId in becca.notes)) {
+ // E.g. the first load during initial database creation, which happens before the
+ // hidden subtree exists; the post-dbReady load will inject.
+ log.info(`Virtual note provider '${provider.namespace}': anchor note '${provider.parentNoteId}' not present, skipping injection.`);
+ continue;
+ }
+
+ try {
+ const subtree = provider.getSubtree();
+ validateVirtualSubtree(provider, subtree);
+
+ // Sort the injected roots after the anchor's persisted children so their
+ // notePositions don't collide.
+ const basePosition = becca.notes[provider.parentNoteId]
+ .getChildBranches()
+ .reduce((max, childBranch) => Math.max(max, childBranch?.notePosition ?? 0), 0);
+
+ // Set before injecting: should injection throw mid-subtree, the already-injected
+ // notes still need the target-relation backfill below.
+ injectedAny = true;
+
+ subtree.forEach((item, index) => injectVirtualItem(provider, provider.parentNoteId, item, basePosition + (index + 1) * 10));
+ } catch (e) {
+ // A broken provider must never take down the becca load.
+ log.error(`Virtual note provider '${provider.namespace}' failed, skipping: ${e instanceof Error ? (e.stack ?? e.message) : String(e)}`);
+ }
+ }
+
+ if (injectedAny) {
+ backfillVirtualTargetRelations();
+ }
+}
+
+function validateVirtualSubtree(provider: VirtualNoteProvider, items: VirtualSubtreeItem[]) {
+ // Repeated IDs are deliberately allowed: an ID appearing in several places is a clone
+ // (multiple placements of one note), which e.g. the User Guide meta makes use of.
+ for (const item of items) {
+ if (!item.id.startsWith(provider.namespace)) {
+ throw new Error(`Item '${item.id}' is outside the provider's namespace '${provider.namespace}'.`);
+ }
+
+ validateVirtualSubtree(provider, item.children ?? []);
+ }
+}
+
+function injectVirtualItem(provider: VirtualNoteProvider, parentNoteId: string, item: VirtualSubtreeItem, defaultPosition: number) {
+ let note = becca.notes[item.id];
+
+ if (note && !note.isVirtual && note.type !== undefined) {
+ // A persisted note still occupies this ID (e.g. rows predating the migration that
+ // removed the persisted variant of this subtree). Persisted data wins to avoid
+ // corrupting it; the conflict is surfaced instead of silently overridden.
+ getLog().error(`Virtual note provider '${provider.namespace}': a persisted note '${item.id}' already exists, skipping injection of this item and its children.`);
+ return;
+ }
+
+ // An already-virtual note means this is a repeated placement (a clone within the virtual
+ // subtree): the first occurrence defined the note and its attributes, this one only
+ // contributes an additional branch.
+ const isCloneOccurrence = !!note?.isVirtual;
+
+ if (!isCloneOccurrence) {
+ const noteRow: Partial<NoteRow> = {
+ noteId: item.id,
+ title: item.title,
+ type: item.type,
+ mime: item.mime ?? "",
+ isProtected: false
+ };
+
+ if (note) {
+ // Skeleton created by a forward reference (e.g. a persisted branch or relation
+ // loaded before this virtual note existed) — fill it in place so those links
+ // survive.
+ note.updateFromRow(noteRow);
+ } else {
+ note = new BNote(noteRow);
+ }
+
+ note.isVirtual = true;
+ }
+
+ const branchId = `${parentNoteId}_${item.id}`;
+
+ if (!becca.branches[branchId]) {
+ const branch = new BBranch({
+ branchId,
+ noteId: item.id,
+ parentNoteId,
+ prefix: null,
+ notePosition: item.notePosition ?? defaultPosition,
+ isExpanded: !!item.isExpanded
+ });
+ branch.isVirtual = true;
+ }
+
+ const attributeDefs = isCloneOccurrence ? [] : [...(item.attributes ?? [])];
+
+ if (!isCloneOccurrence && item.icon) {
+ attributeDefs.push({ type: "label", name: "iconClass", value: `bx ${item.icon}` });
+ }
+
+ attributeDefs.forEach((def, index) => {
+ // Deterministic ID, unique thanks to the note-ID prefix; the counter suffix
+ // disambiguates multiple same-named attributes on one note, probing until free so
+ // pathological names (e.g. "x" colliding with an explicit "x_1") cannot overwrite.
+ const baseAttributeId = `v_${item.id}_${def.type.charAt(0)}${def.name}`;
+ let attributeId = baseAttributeId;
+ for (let suffix = 1; becca.attributes[attributeId]; suffix++) {
+ attributeId = `${baseAttributeId}_${suffix}`;
+ }
+
+ const attribute = new BAttribute({
+ attributeId,
+ noteId: item.id,
+ type: def.type,
+ name: def.name,
+ value: def.value ?? "",
+ isInheritable: !!def.isInheritable,
+ position: (index + 1) * 10
+ });
+ attribute.isVirtual = true;
+ });
+
+ (item.children ?? []).forEach((child, index) => injectVirtualItem(provider, item.id, child, (index + 1) * 10));
+}
+
+/**
+ * Relations pointing into a virtual namespace load before the virtual notes exist, so their
+ * target-relation backlinks could not be established in `BAttribute.init()` — including
+ * relations between virtual notes when the target comes later in the subtree. One pass after
+ * injection fixes both.
+ */
+function backfillVirtualTargetRelations() {
+ for (const attributeId in becca.attributes) {
+ const attribute = becca.attributes[attributeId];
+
+ if (attribute.type !== "relation" || !attribute.value) {
+ continue;
+ }
+
+ const targetNote = becca.notes[attribute.value];
+
+ if (targetNote?.isVirtual && !targetNote.targetRelations.includes(attribute)) {
+ targetNote.targetRelations.push(attribute);
+ }
+ }
+}
+
function reload(reason: string) {
load();
diff --cc packages/trilium-core/src/index.ts
index 0907d0282f,4393da225f..ac4de67041
--- a/packages/trilium-core/src/index.ts
+++ b/packages/trilium-core/src/index.ts
@@@ -129,19 -141,12 +141,22 @@@ export { default as sync_mutex } from "
export { default as setup } from "./services/setup";
export { getPlatform, type PlatformProvider } from "./services/platform";
export { InAppHelpProvider } from "./services/in_app_help";
+export {
+ getVirtualNoteContent,
+ getVirtualNoteProvider,
+ getVirtualNoteProviders,
+ registerVirtualNoteProvider,
+ unregisterVirtualNoteProvider,
+ type VirtualNoteProvider,
+ type VirtualSubtreeAttribute,
+ type VirtualSubtreeItem
+} from "./services/virtual_notes";
- export { type ImageProvider, type ImageFormat, type ImageCompressionOutcome, type ImageCompressionRequest, type ProcessedImage, getImageProvider } from "./services/image_provider";
+ export { type ImageProvider, type ImageFormat, type ImageCompressionOutcome, type ImageCompressionRequest, type ImageShrink, type ProcessedImage, getImageProvider } from "./services/image_provider";
export { default as imageCompressionService } from "./services/image_compression";
export { default as imageInventoryService, type ImageInventoryOptions } from "./services/image_inventory";
+ export { getContentCounts } from "./services/space_usage";
+ export { getDatabaseSizeBytes, getReclaimableBytes } from "./services/database_size";
+ export { checkIntegrity } from "./services/database_maintenance";
export { default as imageInfoService } from "./services/image_info";
export { estimateJpegQuality } from "./services/jpeg_quality";
export { inspectImage, type InspectedImage, UNKNOWN_FORMAT } from "./services/image_inspect";
diff --cc packages/trilium-core/src/migrations/migrations.ts
index 76bf306d89,304e162ec9..645d7b6729
--- a/packages/trilium-core/src/migrations/migrations.ts
+++ b/packages/trilium-core/src/migrations/migrations.ts
@@@ -9,38 -9,11 +9,43 @@@ export function getMaxMigrationVersion(
// Migrations should be kept in descending order, so the latest migration is first.
export const MIGRATIONS: (SqlMigration | JsMigration)[] = [
+ // The in-app help (`_help` subtree) became virtual — injected into becca from the bundled
+ // help meta on every load, never persisted or synced (see services/virtual_notes.ts).
+ // Remove the previously persisted rows, including their entity_changes so the deletions
+ // don't churn through sync: every instance in a cluster runs this same migration (the
+ // accompanying sync-version bump guarantees no un-migrated peers), so all copies converge.
+ // User clones of help notes and user attributes on them are dropped by design — the help
+ // structure is application-owned. Orphaned blobs are vacuumed by the regular erase job.
+ // The rows for indirectly-keyed entities must be removed from entity_changes before their
+ // base rows disappear from under the subselects.
+ {
- version: 241,
++ version: 242,
+ sql: /*sql*/`
+ DELETE FROM entity_changes WHERE entityName = 'branches' AND entityId IN
+ (SELECT branchId FROM branches WHERE noteId LIKE '\\_help%' ESCAPE '\\' OR parentNoteId LIKE '\\_help%' ESCAPE '\\');
+ DELETE FROM entity_changes WHERE entityName = 'attributes' AND entityId IN
+ (SELECT attributeId FROM attributes WHERE noteId LIKE '\\_help%' ESCAPE '\\');
+ DELETE FROM entity_changes WHERE entityName = 'revisions' AND entityId IN
+ (SELECT revisionId FROM revisions WHERE noteId LIKE '\\_help%' ESCAPE '\\');
+ DELETE FROM entity_changes WHERE entityName = 'attachments' AND entityId IN
+ (SELECT attachmentId FROM attachments WHERE ownerId LIKE '\\_help%' ESCAPE '\\');
+ -- Blanket sweep by ID prefix: catches notes and note_reordering rows directly, plus
+ -- tombstones of help branches/attributes deleted (and later erased) by past releases —
+ -- their base rows are gone, so the subselects above cannot find them, but branch IDs
+ -- ('parentNoteId_noteId') and attribute IDs ('noteId_...') carry the _help prefix.
+ DELETE FROM entity_changes WHERE entityId LIKE '\\_help%' ESCAPE '\\';
+ DELETE FROM branches WHERE noteId LIKE '\\_help%' ESCAPE '\\' OR parentNoteId LIKE '\\_help%' ESCAPE '\\';
+ DELETE FROM attributes WHERE noteId LIKE '\\_help%' ESCAPE '\\';
+ DELETE FROM revisions WHERE noteId LIKE '\\_help%' ESCAPE '\\';
+ DELETE FROM attachments WHERE ownerId LIKE '\\_help%' ESCAPE '\\';
+ DELETE FROM notes WHERE noteId LIKE '\\_help%' ESCAPE '\\';
+ `
+ },
+ // Delete the globe icon the web clipper wrote onto clippings, so they take the icon of their clipType
+ {
+ version: 241,
+ module: () => import("./0241__drop_clipper_globe_icon.js")
+ },
// Give every board its own select definition for the label it groups by, so the columns stop
// living only in the board.json attachment
{
diff --cc packages/trilium-core/src/services/app_info.spec.ts
index 28f37cf8d1,6f51c72703..a247a26824
--- a/packages/trilium-core/src/services/app_info.spec.ts
+++ b/packages/trilium-core/src/services/app_info.spec.ts
@@@ -19,8 -19,8 +19,8 @@@ describe("app_info", () =>
it("exposes the fixed sync and clipper protocol versions", () => {
// These are protocol constants; bumping them is a deliberate,
// breaking change, so they are locked here as a regression guard.
- expect(appInfo.syncVersion).toBe(40); // 40: in-app help notes became virtual (v241 migration)
- expect(appInfo.clipperProtocolVersion).toBe("1.0");
- expect(appInfo.syncVersion).toBe(40);
++ expect(appInfo.syncVersion).toBe(41); // 41: in-app help notes became virtual (v242 migration)
+ expect(appInfo.clipperProtocolVersion).toBe("1.1");
});
it("reports a valid current UTC timestamp", () => {
diff --cc packages/trilium-core/src/services/app_info.ts
index 86cfb4ae10,15bb29f9d6..0bb0a8ff80
--- a/packages/trilium-core/src/services/app_info.ts
+++ b/packages/trilium-core/src/services/app_info.ts
@@@ -3,10 -3,8 +3,10 @@@ import packageJson from "../../package.
import { AppInfo } from "@triliumnext/commons";
import { getMaxMigrationVersion } from "../migrations/migrations.js";
- // 40: in-app help notes became virtual (never persisted/synced); un-migrated peers would
-const SYNC_VERSION = 40;
++// 41: in-app help notes became virtual (never persisted/synced); un-migrated peers would
+// still push _help entity changes, so they must upgrade before syncing.
- const SYNC_VERSION = 40;
- const CLIPPER_PROTOCOL_VERSION = "1.0";
++const SYNC_VERSION = 41;
+ const CLIPPER_PROTOCOL_VERSION = "1.1";
const appInfo: AppInfo = {
appVersion: packageJson.version,
diff --cc packages/trilium-core/src/services/consistency_checks.spec.ts
index d6adfc847d,85c4bc10a8..d4e14cd262
--- a/packages/trilium-core/src/services/consistency_checks.spec.ts
+++ b/packages/trilium-core/src/services/consistency_checks.spec.ts
@@@ -145,70 -152,41 +156,109 @@@ describe("Consistency checks during par
});
});
+describe("Consistency checks and virtual notes", () => {
+ beforeAll(() => {
+ registerVirtualNoteProvider({
+ namespace: "_vcc",
+ parentNoteId: "_hidden",
+ getSubtree: () => [{ id: "_vccPage", title: "Virtual page", type: "text" }]
+ });
+ getContext().init(() => becca_loader.load());
+ });
+
+ afterAll(() => {
+ unregisterVirtualNoteProvider("_vcc");
+ getContext().init(() => becca_loader.load());
+ });
+
+ function createNote(title: string) {
+ return noteService.createNewNote({ parentNoteId: "root", title, content: "", type: "text" }).note.noteId;
+ }
+
+ /** Persisted relation to `targetNoteId`, as `scanForLinks` creates for a reference link. */
+ function linkTo(sourceNoteId: string, targetNoteId: string) {
+ return new BAttribute({
+ noteId: sourceNoteId,
+ type: "relation",
+ name: "internalLink",
+ value: targetNoteId
+ }).save().attributeId;
+ }
+
+ function isRelationAlive(attributeId: string) {
+ return !!getSql().getValue("SELECT attributeId FROM attributes WHERE attributeId = ? AND isDeleted = 0", [attributeId]);
+ }
+
+ it("keeps relations targeting virtual notes, while still deleting genuinely broken ones", async () => {
+ await getContext().init(async () => {
+ setOption("syncServerHost", "");
+ setOption("syncIncomplete", "false");
+
+ // A virtual note exists in becca but deliberately never in the `notes` table, so a
+ // relation pointing at one looks broken to every SQL-level existence check.
+ expect(becca.getNote("_vccPage")?.isVirtual).toBe(true);
+ expect(getSql().getValue("SELECT noteId FROM notes WHERE noteId = '_vccPage'")).toBeFalsy();
+
+ const sourceNoteId = createNote("note linking into the virtual subtree");
+ const virtualLinkId = linkTo(sourceNoteId, "_vccPage");
+
+ // A relation to a note that is simply gone — `BAttribute.validate()` refuses to create
+ // one, so it has to be planted the way sync does: straight into the table.
+ const brokenLinkId = "brokenLink___";
+ getSql().execute(
+ `INSERT INTO attributes (attributeId, noteId, type, name, value, position, utcDateModified, isDeleted, isInheritable)
+ VALUES (?, ?, 'relation', 'internalLink', 'MISSING_TARGET', 10, '2026-01-01 00:00:00Z', 0, 0)`,
+ [brokenLinkId, sourceNoteId]
+ );
+ becca_loader.reload("plant broken relation");
+
+ await consistency_checks.runOnDemandChecks(true);
+
+ expect(isRelationAlive(virtualLinkId)).toBe(true);
+ expect(isRelationAlive(brokenLinkId)).toBe(false);
+
+ // ...and the surviving relation keeps its becca backlink, so backlinks and link maps still resolve
+ expect(becca.getAttribute(virtualLinkId)).toBeTruthy();
+ expect(becca.getNoteOrThrow("_vccPage").targetRelations.some((rel) => rel.attributeId === virtualLinkId)).toBe(true);
+ });
+ });
+});
++
+ describe("Notes without a usable branch", () => {
+
+ it("should recover notes with no branch and notes whose branches are all deleted", async () => {
+ await getContext().init(async () => {
+ setOption("syncServerHost", "");
+
+ const sql = getSql();
+ const branchless = insertNote("BRANCHLESS");
+ const onlyDeleted = insertNote("ONLY_DELETED");
+ const stillLinked = insertNote("STILL_LINKED");
+
+ // A deleted branch must not count as a parent, so this note needs recovering too.
+ insertBranch("del_br", onlyDeleted, "root", 1);
+ // A note keeping one live branch beside a deleted one is fine and must be left alone.
+ insertBranch("dead_br", stillLinked, "root", 1);
+ insertBranch("live_br", stillLinked, "root", 0);
+
+ becca_loader.reload("branchless note test");
+
+ await consistency_checks.runOnDemandChecks(true);
+
+ const recoveredFor = (noteId: string) => sql.getValue(`
+ SELECT branchId FROM branches
+ WHERE noteId = ? AND parentNoteId = 'root' AND prefix = 'recovered' AND isDeleted = 0
+ `, [noteId]);
+
+ expect(recoveredFor(branchless)).toBeTruthy();
+ expect(recoveredFor(onlyDeleted)).toBeTruthy();
+ expect(recoveredFor(stillLinked)).toBeFalsy();
+
+ // The pre-existing live branch is the one that kept stillLinked out of the result set.
+ const liveBranch = sql.getValue(
+ "SELECT branchId FROM branches WHERE branchId = 'live_br' AND isDeleted = 0"
+ );
+ expect(liveBranch).toBe("live_br");
+ });
+ });
+ });
diff --cc packages/trilium-core/src/services/export/zip.ts
index c3d7404cc2,c7f3d902f6..bea1a4a3f5
--- a/packages/trilium-core/src/services/export/zip.ts
+++ b/packages/trilium-core/src/services/export/zip.ts
@@@ -1,4 -1,5 +1,5 @@@
-import { getImageAttachmentTitle, NoteType } from "@triliumnext/commons";
+import { getImageAttachmentTitle, imageMimeForExtension, isAcceptedImageMime, NoteType } from "@triliumnext/commons";
+ import mimeTypes from "mime-types";
import sanitize from "sanitize-filename";
import packageInfo from "../../../package.json" with { type: "json" };
diff --cc packages/trilium-core/src/services/llm/tools/help_tools.spec.ts
index d129e42321,0000000000..2212fa39d4
mode 100644,000000..100644
--- a/packages/trilium-core/src/services/llm/tools/help_tools.spec.ts
+++ b/packages/trilium-core/src/services/llm/tools/help_tools.spec.ts
@@@ -1,152 -1,0 +1,160 @@@
+import { beforeEach, describe, expect, it, vi } from "vitest";
+
+import becca from "../../../becca/becca.js";
+import { buildNote } from "../../../test/becca_easy_mocking.js";
+import type SearchContext from "../../search/search_context.js";
+
+// The searching itself is the application's, and it wants a database; what belongs to these tools
+// is which notes they put in scope and what they make of the results. Those are asserted here, and
+// the matching end to end against the shipped guide in `apps/server/spec/in_app_help.spec.ts`.
+vi.mock("../../search/services/search.js", () => ({
+ default: {
+ findResultsWithQuery: (query: string, context: SearchContext) => search(query, context)
+ }
+}));
+
+import { helpTools } from "./help_tools.js";
+import type { ToolDefinition } from "./tool_registry.js";
+
+let search = vi.fn((_query: string, _context: SearchContext) => [] as { noteId: string }[]);
+
+function getTool(name: string): ToolDefinition {
+ for (const [n, def] of helpTools) {
+ if (n === name) return def;
+ }
+ throw new Error(`Tool ${name} not registered`);
+}
+
+/** A miniature `_help` subtree: root → section → page. */
+function buildHelpTree() {
+ buildNote({
+ id: "_help",
+ title: "User Guide",
+ content: "",
+ children: [
+ {
+ id: "_help_basics",
+ title: "Basic Concepts",
+ content: "",
+ children: [
+ {
+ id: "_help_notes",
+ title: "Notes",
+ content: "",
+ children: [
+ {
+ id: "_help_cloning",
+ title: "Cloning Notes",
+ type: "text",
+ content: "<p>A note can be placed in multiple locations. Prefix &amp; installation hints.</p>"
+ }
+ ]
+ }
+ ]
+ },
+ { id: "_help_install", title: "Installation & Setup", type: "text", content: "<p>Download the desktop app.</p>" }
+ ]
+ });
+}
+
+interface SearchHelpResult {
+ totalResults: number;
+ results: { noteId: string; title: string; path: string; contentPreview: string | null }[];
+}
+
+describe("help_tools", () => {
+ beforeEach(() => {
+ becca.reset();
+ search = vi.fn(() => []);
+ });
+
++ it("reads only the User Guide, which ships with Trilium, never the user's data", () => {
++ const readsUserData = (name: string) => {
++ const definition = getTool(name);
++ return definition.mutates ? true : definition.readsUserData;
++ };
++ expect([ "search_help", "get_help_toc" ].map(readsUserData)).toEqual([ false, false ]);
++ });
++
+ describe("search_help", () => {
+ it("searches the guide and nothing else, passing the query through as written", () => {
+ buildHelpTree();
+
+ getTool("search_help").execute({ query: "multiple locations?" });
+
+ expect(search).toHaveBeenCalledOnce();
+ const [ query, context ] = search.mock.calls[0];
+ expect(query).toBe("multiple locations?");
+ // Naming an ancestor is also what puts the hidden subtree in scope, so the guide is
+ // reachable without the search opening up to everything else hidden.
+ expect(context.ancestorNoteId).toBe("_help");
+ expect(context.includeHiddenNotes).toBe(false);
+ });
+
+ it("describes each hit by its title, its place in the guide and a preview of its text", () => {
+ buildHelpTree();
+ search = vi.fn(() => [ { noteId: "_help_cloning" } ]);
+
+ const result = getTool("search_help").execute({ query: "multiple locations" }) as SearchHelpResult;
+
+ expect(result.totalResults).toBe(1);
+ expect(result.results[0]).toMatchObject({
+ noteId: "_help_cloning",
+ title: "Cloning Notes",
+ path: "Basic Concepts > Notes"
+ });
+ expect(result.results[0].contentPreview).toContain("multiple locations");
+ });
+
+ it("reports how many pages matched even when only some are returned", () => {
+ buildHelpTree();
+ search = vi.fn(() => [ { noteId: "_help_install" }, { noteId: "_help_cloning" } ]);
+
+ const limited = getTool("search_help").execute({ query: "installation", limit: 1 }) as SearchHelpResult;
+
+ expect(limited.totalResults).toBe(2);
+ expect(limited.results.map((r) => r.noteId)).toEqual([ "_help_install" ]);
+ });
+
+ it("drops a hit whose note has since gone from becca", () => {
+ buildHelpTree();
+ search = vi.fn(() => [ { noteId: "_help_cloning" }, { noteId: "_help_vanished" } ]);
+
+ const result = getTool("search_help").execute({ query: "anything" }) as SearchHelpResult;
+
+ expect(result.results.map((r) => r.noteId)).toEqual([ "_help_cloning" ]);
+ });
+
+ it("returns an error when the help subtree is absent or empty, without searching", () => {
+ expect(getTool("search_help").execute({ query: "anything" }))
+ .toEqual({ error: "The built-in User Guide is not available in this installation." });
+
+ buildNote({ id: "_help", title: "User Guide", content: "" }); // present but not yet populated
+ expect(getTool("search_help").execute({ query: "anything" }))
+ .toEqual({ error: "The built-in User Guide is not available in this installation." });
+
+ expect(search).not.toHaveBeenCalled();
+ });
+ });
+
+ describe("get_help_toc", () => {
+ it("returns an indented outline of every help page with its noteId", () => {
+ buildHelpTree();
+
+ const result = getTool("get_help_toc").execute({}) as { pageCount: number; toc: string };
+
+ expect(result.pageCount).toBe(4);
+ expect(result.toc.split("\n")).toEqual([
+ "Basic Concepts (_help_basics)",
+ " Notes (_help_notes)",
+ " Cloning Notes (_help_cloning)",
+ "Installation & Setup (_help_install)"
+ ]);
+ });
+
+ it("returns an error when the help subtree is absent", () => {
+ expect(getTool("get_help_toc").execute({}))
+ .toEqual({ error: "The built-in User Guide is not available in this installation." });
+ });
+ });
+});
diff --cc packages/trilium-core/src/services/llm/tools/helpers.spec.ts
index 7cf7a9e895,b07576ec1c..558b2830b7
--- a/packages/trilium-core/src/services/llm/tools/helpers.spec.ts
+++ b/packages/trilium-core/src/services/llm/tools/helpers.spec.ts
@@@ -17,8 -20,11 +20,9 @@@ import
flag,
getAttachmentContentPreview,
getContentPreview,
- getDocNoteHtml,
getNoteContentForLlm,
getNoteMeta,
+ getSvgImageError,
- registerDocNoteHtmlReader,
setNoteContentFromLlm
} from "./helpers.js";
diff --cc packages/trilium-core/src/services/search/expressions/note_content_fulltext.ts
index 54998353ef,a79c4bab19..0e3e6e751d
--- a/packages/trilium-core/src/services/search/expressions/note_content_fulltext.ts
+++ b/packages/trilium-core/src/services/search/expressions/note_content_fulltext.ts
@@@ -86,14 -104,12 +107,14 @@@ class NoteContentFulltextExp extends Ex
for (const row of getSql().iterateRows<SearchRow>(`
SELECT noteId, type, mime, content, isProtected
FROM notes JOIN blobs USING (blobId)
- WHERE type IN ('text', 'code', 'mermaid', 'canvas', 'mindMap', 'spreadsheet', 'llmChat')
+ WHERE type IN (${SEARCHABLE_TYPES.map((type) => `'${type}'`).join(", ")})
AND isDeleted = 0
AND LENGTH(content) < ${MAX_SEARCH_CONTENT_SIZE}`)) {
- this.findInText(row, inputNoteSet, resultNoteSet);
+ this.findInText(row, inputNoteSet, resultNoteSet, searchContext);
}
- this.findInVirtualNotes(inputNoteSet, resultNoteSet);
++ this.findInVirtualNotes(inputNoteSet, resultNoteSet, searchContext);
+
// For exact match with flatText, also search notes WITHOUT content (they may have matching attributes)
if (this.flatText && (this.operator === "=" || this.operator === "!=")) {
for (const note of inputNoteSet.notes) {
@@@ -196,35 -220,7 +225,35 @@@
return false;
}
+ /**
+ * Virtual notes (the in-app help, and anything else a virtual note provider injects) hold
+ * their content in becca rather than in `blobs`, so the query above cannot see them. They are
+ * matched from the cache instead, under the same type and size rules.
+ *
+ * Whether they can be *returned* is decided elsewhere: they live under `_hidden`, so a search
+ * only reaches them when it opts into hidden notes or scopes itself to the subtree — which is
+ * why this pass does not change what an ordinary search finds.
+ */
- findInVirtualNotes(inputNoteSet: NoteSet, resultNoteSet: NoteSet) {
++ findInVirtualNotes(inputNoteSet: NoteSet, resultNoteSet: NoteSet, searchContext: SearchContext) {
+ for (const noteId in becca.notes) {
+ const note = becca.notes[noteId];
+
+ if (!note.isVirtual || !inputNoteSet.hasNoteId(noteId) || !SEARCHABLE_TYPES.includes(note.type)) {
+ continue;
+ }
+
+ const content = note.getContent();
+
+ if (typeof content !== "string" || content.length >= MAX_SEARCH_CONTENT_SIZE) {
+ continue;
+ }
+
+ // Virtual notes are never protected — nothing about them is user data.
- this.findInText({ noteId, type: note.type, mime: note.mime, content, isProtected: false }, inputNoteSet, resultNoteSet);
++ this.findInText({ noteId, type: note.type, mime: note.mime, content, isProtected: false }, inputNoteSet, resultNoteSet, searchContext);
+ }
+ }
+
- findInText({ noteId, isProtected, content, type, mime }: SearchRow, inputNoteSet: NoteSet, resultNoteSet: NoteSet) {
+ findInText({ noteId, isProtected, content, type, mime }: SearchRow, inputNoteSet: NoteSet, resultNoteSet: NoteSet, searchContext: SearchContext) {
if (!inputNoteSet.hasNoteId(noteId) || !(noteId in becca.notes)) {
return;
}
diff --cc scripts/build-utils.ts
index d2c265c66f,77ac151621..2873280436
--- a/scripts/build-utils.ts
+++ b/scripts/build-utils.ts
@@@ -110,15 -144,50 +148,55 @@@ export default class BuildHelper
}),
minify: true
});
- writeFileSync(join(this.outDir, "meta.json"), JSON.stringify(result.metafile));
-
- // Tesseract.js is marked as external above because its worker runs in
- // a separate worker_thread. Copy the worker source, WASM core and all
- // transitive runtime deps so they are available in dist/node_modules.
- this.copyNodeModules([
- "tesseract.js", "tesseract.js-core", "wasm-feature-detect",
- "regenerator-runtime", "is-url", "bmp-js"
- ]);
+ // One metafile per entry, named after it, so a later build call cannot overwrite an
+ // earlier one's.
+ const metaDir = join(this.outDir, "meta");
+ mkdirSync(metaDir, { recursive: true });
+ const entryName = basename(entryPoints[0], extname(entryPoints[0]));
+ writeFileSync(join(metaDir, `${entryName}.json`), JSON.stringify(result.metafile));
+ }
+
+ /**
+ * Bundles the Tesseract.js OCR worker into the bundle root and copies the engine builds beside
+ * it, where their loaders read them from, one per CPU feature level.
+ *
+ * Only the full engine builds are copied, not the `-lstm` ones. The Node worker's `getCore()`
+ * compares its `lstmOnly` boolean against OEM numbers, so it never selects an `-lstm` build.
+ *
+ * @param entryPoint the path of `tesseract_worker.ts`, relative to the project.
+ */
+ async buildTesseractWorker(entryPoint: string) {
+ await this.buildBackend([ entryPoint ]);
+ for (const variant of [ "", "-simd", "-relaxedsimd" ]) {
+ const file = `tesseract-core${variant}.wasm`;
+ this.copy(`/node_modules/tesseract.js-core/${file}`, file);
+ }
+ }
+
+ /**
+ * Copies the assets the server code reads from `RESOURCE_DIR` at runtime. Both the server and
+ * the desktop app run that code, so both builds call this.
+ */
+ copyServerAssets() {
+ this.copy("/apps/server/src/assets", "assets/");
+ // Core owns these, but the bundle cannot resolve `@triliumnext/core` paths where no
+ // workspace exists (Docker, a packaged app), so they are read from RESOURCE_DIR instead.
+ // See core_assets.ts.
+ this.copy("/packages/trilium-core/src/assets/schema.sql", "assets/schema.sql");
+ this.copy("/packages/trilium-core/src/assets/llm/skills", "assets/llm/skills/");
+ // PDFium's own loader resolves the wasm against `import.meta.url`, which in the split
+ // bundle names a file under chunks/. See pdf_renderer.ts.
+ this.copy("/node_modules/@hyzyla/pdfium/dist/pdfium.wasm", "assets/pdfium.wasm");
+ // The Codex ACP adapter runs as a script of its own in a worker thread. See
+ // codex_binary.ts.
+ this.copy(
+ "/node_modules/@agentclientprotocol/codex-acp/dist/index.js", "assets/codex-acp.mjs");
+ this.copy("/packages/share-theme/src/templates", "share-theme/templates/");
++ // The in-app help's images and attachments live with the User Guide; its pages travel as
++ // the content bundle in assets/help, so the Markdown and its meta stay out of the package.
++ this.copy("/docs/User Guide", "assets/help/", {
++ filter: (sourcePath) => !sourcePath.endsWith(".md") && !sourcePath.endsWith("!!!meta.json")
++ });
}
buildFrontend() {