diff --git a/Dockerfile b/Dockerfile index 2436a8124..4aac3160f 100644 --- a/Dockerfile +++ b/Dockerfile @@ -10,8 +10,8 @@ COPY . . RUN npm ci && \ npm run build:prepare-dist && \ npm cache clean --force && \ - rm -rf dist/node_modules && \ - mv dist/* \ + rm -rf build/node_modules && \ + mv build/* \ start-docker.sh \ /usr/src/app/ && \ rm -rf \ diff --git a/Dockerfile.alpine b/Dockerfile.alpine index 9370bd6da..f83789399 100644 --- a/Dockerfile.alpine +++ b/Dockerfile.alpine @@ -10,8 +10,8 @@ COPY . . RUN npm ci && \ npm run build:prepare-dist && \ npm cache clean --force && \ - rm -rf dist/node_modules && \ - mv dist/* \ + rm -rf build/node_modules && \ + mv build/* \ start-docker.sh \ /usr/src/app/ && \ rm -rf \ diff --git a/bin/build-server.sh b/bin/build-server.sh index ff2912470..3af7ec9f5 100755 --- a/bin/build-server.sh +++ b/bin/build-server.sh @@ -22,53 +22,42 @@ echo "Selected Arch: $ARCH" # Set Node.js version and architecture-specific filename NODE_VERSION=20.15.1 -NODE_ARCH=$ARCH -# Debug output -echo "Node arch: $NODE_ARCH" +BUILD_DIR="./build" +DIST_DIR="./dist" -# Special case for x64 in Node.js downloads -if [ "$NODE_ARCH" = "x64" ]; then - NODE_FILENAME="x64" -elif [ "$NODE_ARCH" = "arm64" ]; then - NODE_FILENAME="arm64" -fi +./bin/copy-trilium.sh -# Debug output -echo "Node filename: $NODE_FILENAME" +NODE_FILENAME=node-v${NODE_VERSION}-linux-${ARCH} -PKG_DIR=dist/trilium-linux-${ARCH}-server -echo "Package directory: $PKG_DIR" - -if [ "$1" != "DONTCOPY" ] -then - # Need to modify copy-trilium.sh to accept the target directory - ./bin/copy-trilium.sh "$PKG_DIR" -fi - -cd dist -wget https://nodejs.org/dist/v${NODE_VERSION}/node-v${NODE_VERSION}-linux-${NODE_FILENAME}.tar.xz -tar xfJ node-v${NODE_VERSION}-linux-${NODE_FILENAME}.tar.xz -rm node-v${NODE_VERSION}-linux-${NODE_FILENAME}.tar.xz +echo "Downloading Node.js runtime $NODE_FILENAME..." +cd $BUILD_DIR +wget -qO- https://nodejs.org/dist/v${NODE_VERSION}/${NODE_FILENAME}.tar.xz | tar xfJ - +mv $NODE_FILENAME node cd .. -mv dist/node-v${NODE_VERSION}-linux-${NODE_FILENAME} $PKG_DIR/node -rm -r $PKG_DIR/node/lib/node_modules/npm -rm -r $PKG_DIR/node/include/node +rm -r $BUILD_DIR/node/lib/node_modules/npm \ + $BUILD_DIR/node/include/node \ + $BUILD_DIR/node_modules/electron* \ + $BUILD_DIR/electron*.{js,map} -rm -r $PKG_DIR/node_modules/electron* -rm -r $PKG_DIR/electron*.js +printf "#!/bin/sh\n./node/bin/node src/main" > $BUILD_DIR/trilium.sh +chmod 755 $BUILD_DIR/trilium.sh -printf "#!/bin/sh\n./node/bin/node src/main" > $PKG_DIR/trilium.sh -chmod 755 $PKG_DIR/trilium.sh - -cp bin/tpl/anonymize-database.sql $PKG_DIR/ - -cp -r translations $PKG_DIR/ +# TriliumNextTODO: is this still required? If yes → move to copy-dist/copy-trilium +cp bin/tpl/anonymize-database.sql $BUILD_DIR/ VERSION=`jq -r ".version" package.json` -cd dist -tar cJf trilium-linux-${ARCH}-server-${VERSION}.tar.xz trilium-linux-${ARCH}-server +ARCHIVE_NAME="TriliumNextNotes-Server-${VERSION}-linux-${ARCH}" +echo "Creating Archive $ARCHIVE_NAME..." + +mkdir $DIST_DIR +cp -r "$BUILD_DIR" "$DIST_DIR/$ARCHIVE_NAME" +cd $DIST_DIR +tar cJf "$ARCHIVE_NAME.tar.xz" "$ARCHIVE_NAME" +rm -rf "$ARCHIVE_NAME" + +echo "Server Build Completed!" \ No newline at end of file diff --git a/bin/build.sh b/bin/build.sh deleted file mode 100755 index 7fb41cfcb..000000000 --- a/bin/build.sh +++ /dev/null @@ -1,53 +0,0 @@ -#!/usr/bin/env bash - -set -e # Fail on any command error - -if ! command -v jq &> /dev/null; then - echo "Missing command: jq" - exit 1 -fi - -if ! command -v fakeroot &> /dev/null; then - echo "Missing command: fakeroot" - exit 1 -fi - -if ! command -v dpkg-deb &> /dev/null; then - echo "Missing command: dpkg-deb" - exit 1 -fi - -if dpkg-deb 2>&1 | grep BusyBox &> /dev/null; then - echo "The dpkg-deb binary provided by BusyBox is not compatible. The Debian tool needs to be used instead." - exit 1 -fi - -if ! command -v wine &> /dev/null; then - echo "Missing command: wine" - exit 1 -fi - -echo "Deleting existing builds" - -rm -rf dist/* - -SRC_DIR=dist/trilium-src - -bin/copy-trilium.sh $SRC_DIR - -# we'll just copy the same SRC dir to all the builds so we don't have to do npm install in each separately -cp -r $SRC_DIR ./dist/trilium-linux-x64-src -cp -r $SRC_DIR ./dist/trilium-linux-x64-server -cp -r $SRC_DIR ./dist/trilium-windows-x64-src -cp -r $SRC_DIR ./dist/trilium-mac-x64-src -cp -r $SRC_DIR ./dist/trilium-mac-arm64-src - -bin/build-win-x64.sh DONTCOPY - -bin/build-mac-x64.sh DONTCOPY - -bin/build-mac-arm64.sh DONTCOPY - -bin/build-linux-x64.sh DONTCOPY - -bin/build-server.sh DONTCOPY diff --git a/bin/copy-dist.ts b/bin/copy-dist.ts index 289334321..0f9e62c99 100644 --- a/bin/copy-dist.ts +++ b/bin/copy-dist.ts @@ -1,7 +1,7 @@ import fs from "fs-extra"; import path from "path"; -const DEST_DIR = "./dist"; +const DEST_DIR = "./build"; const VERBOSE = process.env.VERBOSE; @@ -28,6 +28,8 @@ try { "./config-sample.ini", "./package-lock.json", "./package.json", + "./LICENSE", + "./README.md", "./src/views/", "./src/etapi/etapi.openapi.yaml", "./src/routes/api/openapi.json", diff --git a/bin/copy-trilium.sh b/bin/copy-trilium.sh index f62b180a0..55c5cf6de 100755 --- a/bin/copy-trilium.sh +++ b/bin/copy-trilium.sh @@ -3,72 +3,42 @@ set -e # Fail on any command error shopt -s globstar -if [[ $# -eq 0 ]] ; then - echo "Missing argument of target directory" - exit 1 -fi +BUILD_DIR="./build" + if ! [[ $(which npm) ]]; then echo "Missing npm" exit 1 fi -# Trigger the TypeScript build -echo TypeScript build start -npm run build:ts -echo TypeScript build finished - -# Copy the TypeScript artifacts -DIR="$1" -rm -rf "$DIR" -mkdir -pv "$DIR" - -echo Webpack start -npm run build:webpack -echo Webpack finish - -echo "Copying Trilium to build directory $DIR" - -for d in 'images' 'libraries' 'src' 'db'; do - cp -r "$d" "$DIR"/ -done - -for f in 'package.json' 'package-lock.json' 'README.md' 'LICENSE' 'config-sample.ini'; do - cp "$f" "$DIR"/ -done +# Trigger the build +echo Build start +npm run build:prepare-dist +echo Build finished # Patch package.json main -sed -i 's/.\/dist\/electron-main.js/electron-main.js/g' "$DIR/package.json" - -script_dir=$(realpath $(dirname $0)) -cp -R "$script_dir/../build/src" "$DIR" -cp "$script_dir/../build/electron-main.js" "$DIR" +sed -i 's|./dist/electron-main.js|electron-main.js|g' "$BUILD_DIR/package.json" # run in subshell (so we return to original dir) -(cd $DIR && npm install --omit=dev --legacy-peer-deps) +(cd $BUILD_DIR && npm ci --omit=dev) -if [[ -d "$DIR"/node_modules ]]; then +if [[ -d "$BUILD_DIR"/node_modules ]]; then # cleanup of useless files in dependencies for d in 'image-q/demo' \ '@excalidraw/excalidraw/dist/excalidraw-assets-dev' '@excalidraw/excalidraw/dist/excalidraw.development.js' '@excalidraw/excalidraw/dist/excalidraw-with-preact.development.js' \ 'mermaid/dist/mermaid.js' \ 'boxicons/svg' 'boxicons/node_modules/react'/* \ '@jimp/plugin-print/fonts' 'jimp/browser' 'jimp/fonts'; do - [[ -e "$DIR"/node_modules/"$d" ]] && rm -r "$DIR"/node_modules/"$d" + [[ -e "$BUILD_DIR"/node_modules/"$d" ]] && rm -r "$BUILD_DIR"/node_modules/"$d" done # delete all tests (there are often large images as test file for jimp etc.) for d in 'test' 'docs' 'demo' 'example'; do - find "$DIR"/node_modules -name "$d" -exec rm -rf {} + + find "$BUILD_DIR"/node_modules -name "$d" -exec rm -rf {} + done fi -find $DIR/libraries -name "*.map" -type f -delete -find $DIR/node_modules -name "*.map" -type f -delete -find $DIR -name "*.ts" -type f -delete +find $BUILD_DIR/libraries -name "*.map" -type f -delete +find $BUILD_DIR/node_modules -name "*.map" -type f -delete +find $BUILD_DIR -name "*.ts" -type f -delete -d="$DIR"/src/public -[[ -d "$d"/app-dist ]] || mkdir -pv "$d"/app-dist -cp -r "$d"/app/doc_notes "$d"/app-dist/ - -rm -rf "$d"/app -unset f d DIR +unset f d BUILD_DIR diff --git a/data-docs/document.db b/data-docs/document.db index 7e96e6410..9ca8c1516 100644 Binary files a/data-docs/document.db and b/data-docs/document.db differ diff --git a/electron-docs-main.ts b/electron-docs-main.ts index 875748bc3..4c91b76d1 100644 --- a/electron-docs-main.ts +++ b/electron-docs-main.ts @@ -1,9 +1,151 @@ +import fs from "fs/promises"; +import fsExtra from "fs-extra"; +import path from "path"; +import type NoteMeta from "./src/services/meta/note_meta.js"; +import type { NoteMetaFile } from "./src/services/meta/note_meta.js"; +import cls from "./src/services/cls.js"; +import { initializeTranslations } from "./src/services/i18n.js"; +import archiver, { type Archiver } from "archiver"; +import type { WriteStream } from "fs"; +import debounce from "./src/public/app/services/debounce.js"; + +const NOTE_ID_USER_GUIDE = "pOsGYCXsbNQG"; +const destRootPath = path.join("src", "public", "app", "doc_notes", "en", "User Guide"); + async function startElectron() { await import("./electron-main.js"); } async function main() { + await initializeTranslations(); + const zipBuffer = await createImportZip(); + await initializeDatabase(); + cls.init(() => { + importData(zipBuffer); + }); + await startElectron(); + + + const events = (await import("./src/services/events.js")).default; + const debouncer = debounce(() => { + console.log("Exporting data"); + exportData(); + }, 10_000);; + events.subscribe(events.ENTITY_CHANGED, async () => { + console.log("Got entity changed"); + debouncer(); + }); +} + +async function initializeDatabase() { + const sqlInit = (await import("./src/services/sql_init.js")).default; + + cls.init(() => { + if (!sqlInit.isDbInitialized()) { + sqlInit.createInitialDatabase(); + } + }); +} + +async function importData(input: Buffer) { + const beccaLoader = ((await import("./src/becca/becca_loader.js")).default); + const notes = ((await import("./src/services/notes.js")).default); + beccaLoader.load(); + + const { note } = notes.createNewNoteWithTarget("into", "none_root", { + parentNoteId: "root", + noteId: NOTE_ID_USER_GUIDE, + title: "User Guide", + content: "The sub-children of this note are automatically synced.", + type: "text" + }); + + const TaskContext = (await import("./src/services/task_context.js")).default; + const { importZip } = ((await import("./src/services/import/zip.js")).default); + const context = new TaskContext("no-report"); + await importZip(context, input, note, { preserveIds: true }); +} + +async function createImportZip() { + const archive = archiver("zip", { + zlib: { level: 0 } + }); + + archive.directory(destRootPath, "/"); + + const outputStream = fsExtra.createWriteStream("input.zip"); + archive.pipe(outputStream); + await waitForEnd(archive, outputStream); + + return await fsExtra.readFile("input.zip"); +} + +function waitForEnd(archive: Archiver, stream: WriteStream) { + return new Promise(async (res, rej) => { + stream.on("finish", () => res()); + await archive.finalize(); + }); + +} + +async function exportData() { + const zipFilePath = "output.zip"; + + const deferred = (await import("./src/services/utils.js")).deferred; + + try { + await fsExtra.remove(destRootPath); + await fsExtra.mkdir(destRootPath); + + // First export as zip. + const { exportToZipFile } = (await import("./src/services/export/zip.js")).default; + await exportToZipFile(NOTE_ID_USER_GUIDE, "markdown", zipFilePath); + + const promise = deferred() + setTimeout(async () => { + // Then extract the zip. + const { readZipFile, readContent } = (await import("./src/services/import/zip.js")); + await readZipFile(await fs.readFile(zipFilePath), async (zip, entry) => { + // We ignore directories since they can appear out of order anyway. + if (!entry.fileName.endsWith("/")) { + const destPath = path.join(destRootPath, entry.fileName); + const fileContent = await readContent(zip, entry); + + await fsExtra.mkdirs(path.dirname(destPath)); + await fs.writeFile(destPath, fileContent); + } + + zip.readEntry(); + }); + promise.resolve(); + }, 1000); + await promise; + } finally { + if (await fsExtra.exists(zipFilePath)) { + await fsExtra.rm(zipFilePath); + } + } + + await cleanUpMeta(); +} + +async function cleanUpMeta() { + const metaPath = path.join(destRootPath, "!!!meta.json"); + const meta = JSON.parse(await fs.readFile(metaPath, "utf-8")) as NoteMetaFile; + for (const file of meta.files) { + traverse(file); + } + + function traverse(el: NoteMeta) { + for (const child of el.children || []) { + traverse(child); + } + + el.isExpanded = false; + } + + await fs.writeFile(metaPath, JSON.stringify(meta, null, 4)); } await main(); diff --git a/package.json b/package.json index a7bd36e77..c060a2420 100644 --- a/package.json +++ b/package.json @@ -36,7 +36,8 @@ "electron:start-prod-nix-no-dir": "electron-rebuild --version 33.3.1 && npm run build:prepare-dist && cross-env TRILIUM_ENV=dev nix-shell -p electron_33 --run \"electron ./dist/electron-main.js --inspect=5858 .\"", "electron:qstart": "npm run electron:switch && npm run electron:start", "electron:switch": "electron-rebuild", - "docs:edit": "cross-env NODE_OPTIONS=\"--import tsx\" TRILIUM_DATA_DIR=./data-docs TRILIUM_ENV=dev electron ./electron-docs-main.ts .", + "docs:edit": "cross-env NODE_OPTIONS=\"--import tsx\" TRILIUM_DATA_DIR=./data-docs TRILIUM_ENV=dev TRILIUM_PORT=37741 electron ./electron-docs-main.ts .", + "docs:edit-nix": "electron-rebuild --version 33.3.1 && cross-env NODE_OPTIONS=\"--import tsx\" TRILIUM_DATA_DIR=./data-docs TRILIUM_SYNC_SERVER_HOST=http://tsyncserver:4000 TRILIUM_PORT=37741 TRILIUM_ENV=dev nix-shell -p electron_33 --run \"electron ./electron-docs-main.ts .\"", "electron-forge:start": "npm run build:prepare-dist && electron-forge start", "electron-forge:make": "npm run build:prepare-dist && electron-forge make", "electron-forge:package": "npm run build:prepare-dist && electron-forge package", diff --git a/src/public/app/doc_notes/en/User Guide/!!!meta.json b/src/public/app/doc_notes/en/User Guide/!!!meta.json index d687c0628..d9158bedf 100644 --- a/src/public/app/doc_notes/en/User Guide/!!!meta.json +++ b/src/public/app/doc_notes/en/User Guide/!!!meta.json @@ -1,1355 +1,7789 @@ { - "formatVersion": 2, - "appVersion": "0.92.2-beta", - "files": [ - { - "isClone": false, - "noteId": "OkOZllzB3fqN", - "notePath": [ - "OkOZllzB3fqN" - ], - "title": "User Guide", - "notePosition": 20, - "prefix": null, - "isExpanded": true, - "type": "text", - "mime": "text/html", - "attributes": [ - { - "type": "label", - "name": "iconClass", - "value": "bx bx-help-circle", - "isInheritable": false, - "position": 10 - } - ], - "format": "html", - "attachments": [], - "dirFileName": "User Guide", - "children": [ - { - "isClone": false, - "noteId": "yoAe4jV2yzbd", - "notePath": [ - "OkOZllzB3fqN", - "yoAe4jV2yzbd" - ], - "title": "New 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 - }, - { - "type": "label", - "name": "sorted", - "value": "dateCreated", - "isInheritable": false, - "position": 20 - }, - { - "type": "label", - "name": "sortDirection", - "value": "desc", - "isInheritable": false, - "position": 30 - } - ], - "format": "html", - "attachments": [], - "dirFileName": "New Features", - "children": [ - { - "isClone": false, - "noteId": "3I277VKYxWDH", - "notePath": [ - "OkOZllzB3fqN", - "yoAe4jV2yzbd", - "3I277VKYxWDH" - ], - "title": "Right-to-left text notes", - "notePosition": 10, - "prefix": null, - "isExpanded": false, - "type": "text", - "mime": "text/html", - "attributes": [ - { - "type": "label", - "name": "iconClass", - "value": "bx bx-align-right", - "isInheritable": false, - "position": 10 - } - ], - "format": "html", - "dataFileName": "Right-to-left text notes.html", - "attachments": [ - { - "attachmentId": "PSBNAvDyj5Vy", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "Right-to-left text notes_i.png" - }, - { - "attachmentId": "YXYIJznak915", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "1_Right-to-left text notes_i.png" - }, - { - "attachmentId": "Do0S17lDl7uu", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "2_Right-to-left text notes_i.png" - }, - { - "attachmentId": "D3lyhPvPvocb", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "3_Right-to-left text notes_i.png" - }, - { - "attachmentId": "Tu7llk3GgRkA", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "4_Right-to-left text notes_i.png" - } - ] - }, - { - "isClone": false, - "noteId": "B3YLYM4erjnW", - "notePath": [ - "OkOZllzB3fqN", - "yoAe4jV2yzbd", - "B3YLYM4erjnW" - ], - "title": "Zen mode", - "notePosition": 20, - "prefix": null, - "isExpanded": false, - "type": "text", - "mime": "text/html", - "attributes": [ - { - "type": "label", - "name": "iconClass", - "value": "bx bxs-yin-yang", - "isInheritable": false, - "position": 10 - } - ], - "format": "html", - "dataFileName": "Zen mode.html", - "attachments": [ - { - "attachmentId": "cswryNtIFZHy", - "title": "image.png", - "role": "image", - "mime": "image/jpg", - "position": 10, - "dataFileName": "Zen mode_image.png" - }, - { - "attachmentId": "TS5MS8fQ8Rfr", - "title": "image.png", - "role": "image", - "mime": "image/jpg", - "position": 10, - "dataFileName": "1_Zen mode_image.png" - }, - { - "attachmentId": "UDk4M7uiTE7w", - "title": "image.png", - "role": "image", - "mime": "image/jpg", - "position": 10, - "dataFileName": "2_Zen mode_image.png" - }, - { - "attachmentId": "sQldbByAmE0k", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "3_Zen mode_image.png" - }, - { - "attachmentId": "DzrJD3hXJwXJ", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "4_Zen mode_image.png" - }, - { - "attachmentId": "HeGfp8wObFO5", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "5_Zen mode_image.png" - }, - { - "attachmentId": "uWsrFwgfypsS", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "6_Zen mode_image.png" - }, - { - "attachmentId": "hX8xmbxgSNFh", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "7_Zen mode_image.png" - } - ] - }, - { - "isClone": false, - "noteId": "13D1lOc9sqmZ", - "notePath": [ - "OkOZllzB3fqN", - "yoAe4jV2yzbd", - "13D1lOc9sqmZ" - ], - "title": "Export as PDF", - "notePosition": 30, - "prefix": null, - "isExpanded": false, - "type": "text", - "mime": "text/html", - "attributes": [ - { - "type": "label", - "name": "iconClass", - "value": "bx bxs-file-pdf", - "isInheritable": false, - "position": 30 - } - ], - "format": "html", - "dataFileName": "Export as PDF.html", - "attachments": [ - { - "attachmentId": "xsGM34t8ssKV", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "Export as PDF_image.png" - }, - { - "attachmentId": "b3v1pLE6TF1Y", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "1_Export as PDF_image.png" - } - ] - } - ] - }, - { - "isClone": false, - "noteId": "wmegHv51MJMd", - "notePath": [ - "OkOZllzB3fqN", - "wmegHv51MJMd" - ], - "title": "Note Types", - "notePosition": 70, - "prefix": null, - "isExpanded": false, - "type": "text", - "mime": "text/html", - "attributes": [ - { - "type": "label", - "name": "iconClass", - "value": "bx bx-edit", - "isInheritable": false, - "position": 10 - } - ], - "format": "html", - "attachments": [], - "dirFileName": "Note Types", - "children": [ - { - "isClone": false, - "noteId": "crJtzsol4olb", - "notePath": [ - "OkOZllzB3fqN", - "wmegHv51MJMd", - "crJtzsol4olb" - ], - "title": "Text", - "notePosition": 10, - "prefix": null, - "isExpanded": false, - "type": "text", - "mime": "text/html", - "attributes": [ - { - "type": "label", - "name": "iconClass", - "value": "bx bx-note", - "isInheritable": false, - "position": 10 - } - ], - "format": "html", - "attachments": [], - "dirFileName": "Text", - "children": [ - { - "isClone": false, - "noteId": "B0lcI9xz1r8K", - "notePath": [ - "OkOZllzB3fqN", - "wmegHv51MJMd", - "crJtzsol4olb", - "B0lcI9xz1r8K" - ], - "title": "Content language", - "notePosition": 10, - "prefix": null, - "isExpanded": false, - "type": "text", - "mime": "text/html", - "attributes": [ - { - "type": "relation", - "name": "internalLink", - "value": "3I277VKYxWDH", - "isInheritable": false, - "position": 10 - } - ], - "format": "html", - "dataFileName": "Content language.html", - "attachments": [ - { - "attachmentId": "OpIv6CnYCLVa", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "Content language_image.png" - } - ] - } - ] - }, - { - "isClone": false, - "noteId": "xtVDKff8qpTn", - "notePath": [ - "OkOZllzB3fqN", - "wmegHv51MJMd", - "xtVDKff8qpTn" - ], - "title": "Code", - "notePosition": 20, - "prefix": null, - "isExpanded": false, - "type": "text", - "mime": "text/html", - "attributes": [ - { - "type": "label", - "name": "iconClass", - "value": "bx bx-code", - "isInheritable": false, - "position": 10 - } - ], - "format": "html", - "dataFileName": "Code.html", - "attachments": [] - }, - { - "isClone": false, - "noteId": "hMtmqVKygCi3", - "notePath": [ - "OkOZllzB3fqN", - "wmegHv51MJMd", - "hMtmqVKygCi3" - ], - "title": "Saved Search", - "notePosition": 30, - "prefix": null, - "isExpanded": false, - "type": "text", - "mime": "text/html", - "attributes": [ - { - "type": "label", - "name": "iconClass", - "value": "bx bx-file-find", - "isInheritable": false, - "position": 10 - } - ], - "format": "html", - "dataFileName": "Saved Search.html", - "attachments": [] - }, - { - "isClone": false, - "noteId": "n9SQevPhMDAs", - "notePath": [ - "OkOZllzB3fqN", - "wmegHv51MJMd", - "n9SQevPhMDAs" - ], - "title": "Relation Map", - "notePosition": 40, - "prefix": null, - "isExpanded": false, - "type": "text", - "mime": "text/html", - "attributes": [ - { - "type": "label", - "name": "iconClass", - "value": "bx bxs-network-chart", - "isInheritable": false, - "position": 10 - } - ], - "format": "html", - "dataFileName": "Relation Map.html", - "attachments": [] - }, - { - "isClone": false, - "noteId": "3fbsp7IqZXtk", - "notePath": [ - "OkOZllzB3fqN", - "wmegHv51MJMd", - "3fbsp7IqZXtk" - ], - "title": "Note Map", - "notePosition": 50, - "prefix": null, - "isExpanded": false, - "type": "text", - "mime": "text/html", - "attributes": [ - { - "type": "label", - "name": "iconClass", - "value": "bx bxs-network-chart", - "isInheritable": false, - "position": 10 - } - ], - "format": "html", - "dataFileName": "Note Map.html", - "attachments": [] - }, - { - "isClone": false, - "noteId": "hcbVFFSyBbb3", - "notePath": [ - "OkOZllzB3fqN", - "wmegHv51MJMd", - "hcbVFFSyBbb3" - ], - "title": "Render Note", - "notePosition": 60, - "prefix": null, - "isExpanded": false, - "type": "text", - "mime": "text/html", - "attributes": [ - { - "type": "label", - "name": "iconClass", - "value": "bx bx-extension", - "isInheritable": false, - "position": 10 - } - ], - "format": "html", - "dataFileName": "Render Note.html", - "attachments": [] - }, - { - "isClone": false, - "noteId": "pSDzQIgLGswQ", - "notePath": [ - "OkOZllzB3fqN", - "wmegHv51MJMd", - "pSDzQIgLGswQ" - ], - "title": "Book", - "notePosition": 70, - "prefix": null, - "isExpanded": false, - "type": "text", - "mime": "text/html", - "attributes": [ - { - "type": "label", - "name": "iconClass", - "value": "bx bx-book", - "isInheritable": false, - "position": 10 - } - ], - "format": "html", - "attachments": [], - "dirFileName": "Book", - "children": [ - { - "isClone": false, - "noteId": "fDGg7QcJg3Xm", - "notePath": [ - "OkOZllzB3fqN", - "wmegHv51MJMd", - "pSDzQIgLGswQ", - "fDGg7QcJg3Xm" - ], - "title": "Calendar View", - "notePosition": 10, - "prefix": null, - "isExpanded": false, - "type": "text", - "mime": "text/html", - "attributes": [ - { - "type": "label", - "name": "iconClass", - "value": "bx bx-calendar", - "isInheritable": false, - "position": 10 - } - ], - "format": "html", - "dataFileName": "Calendar View.html", - "attachments": [ - { - "attachmentId": "j1NIQJvjsFrc", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "Calendar View_image.png" - }, - { - "attachmentId": "9FxGltAPWr9V", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "1_Calendar View_image.png" - }, - { - "attachmentId": "GaH4K6lKfcQe", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "2_Calendar View_image.png" - }, - { - "attachmentId": "xr4c0Mdf7gPm", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "3_Calendar View_image.png" - }, - { - "attachmentId": "K8NQktF9sCss", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "4_Calendar View_image.png" - }, - { - "attachmentId": "8kfaJPGjJ1t5", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "5_Calendar View_image.png" - }, - { - "attachmentId": "fFaq1mWTFlJA", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "6_Calendar View_image.png" - }, - { - "attachmentId": "2CExLYphNtCd", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "7_Calendar View_image.png" - }, - { - "attachmentId": "UaXBPb7fINm4", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "8_Calendar View_image.png" - }, - { - "attachmentId": "TIzqtnGIPlxu", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "9_Calendar View_image.png" - }, - { - "attachmentId": "p7eRe4TFFdIt", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "10_Calendar View_image.png" - }, - { - "attachmentId": "bnKESYv4Toa1", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "11_Calendar View_image.png" - }, - { - "attachmentId": "0J8MfQPq7E1H", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "12_Calendar View_image.png" - }, - { - "attachmentId": "0yGXmgB3yfGg", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "13_Calendar View_image.png" - }, - { - "attachmentId": "MwECr6EjQjEE", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "14_Calendar View_image.png" - }, - { - "attachmentId": "XBOyB2RH28OS", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "15_Calendar View_image.png" - }, - { - "attachmentId": "BsiAqW51VJOz", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "16_Calendar View_image.png" - }, - { - "attachmentId": "RTFdV19BHn28", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "17_Calendar View_image.png" - }, - { - "attachmentId": "ifhS1bKggh23", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "18_Calendar View_image.png" - }, - { - "attachmentId": "JM6AU8N4MIgB", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "19_Calendar View_image.png" - } - ] - } - ] - }, - { - "isClone": false, - "noteId": "TTWESa9YFyB4", - "notePath": [ - "OkOZllzB3fqN", - "wmegHv51MJMd", - "TTWESa9YFyB4" - ], - "title": "Mermaid Diagram", - "notePosition": 80, - "prefix": null, - "isExpanded": false, - "type": "text", - "mime": "text/html", - "attributes": [ - { - "type": "label", - "name": "iconClass", - "value": "bx bx-selection", - "isInheritable": false, - "position": 10 - } - ], - "format": "html", - "dataFileName": "Mermaid Diagram.html", - "attachments": [] - }, - { - "isClone": false, - "noteId": "Aw4yGrN6rxV5", - "notePath": [ - "OkOZllzB3fqN", - "wmegHv51MJMd", - "Aw4yGrN6rxV5" - ], - "title": "Canvas", - "notePosition": 90, - "prefix": null, - "isExpanded": false, - "type": "text", - "mime": "text/html", - "attributes": [ - { - "type": "label", - "name": "iconClass", - "value": "bx bx-pen", - "isInheritable": false, - "position": 10 - } - ], - "format": "html", - "dataFileName": "Canvas.html", - "attachments": [] - }, - { - "isClone": false, - "noteId": "dQ3FSQuJmaIR", - "notePath": [ - "OkOZllzB3fqN", - "wmegHv51MJMd", - "dQ3FSQuJmaIR" - ], - "title": "Web View", - "notePosition": 100, - "prefix": null, - "isExpanded": false, - "type": "text", - "mime": "text/html", - "attributes": [ - { - "type": "label", - "name": "iconClass", - "value": "bx bx-globe-alt", - "isInheritable": false, - "position": 10 - } - ], - "format": "html", - "dataFileName": "Web View.html", - "attachments": [] - }, - { - "isClone": false, - "noteId": "j2FPSUXO17lK", - "notePath": [ - "OkOZllzB3fqN", - "wmegHv51MJMd", - "j2FPSUXO17lK" - ], - "title": "Mind Map", - "notePosition": 110, - "prefix": null, - "isExpanded": false, - "type": "text", - "mime": "text/html", - "attributes": [ - { - "type": "label", - "name": "iconClass", - "value": "bx bx-sitemap", - "isInheritable": false, - "position": 10 - } - ], - "format": "html", - "dataFileName": "Mind Map.html", - "attachments": [] - }, - { - "isClone": false, - "noteId": "foPEtsL51pD2", - "notePath": [ - "OkOZllzB3fqN", - "wmegHv51MJMd", - "foPEtsL51pD2" - ], - "title": "Geo map", - "notePosition": 120, - "prefix": null, - "isExpanded": false, - "type": "text", - "mime": "text/html", - "attributes": [ - { - "type": "label", - "name": "iconClass", - "value": "bx bx-map-alt", - "isInheritable": false, - "position": 10 - } - ], - "format": "html", - "dataFileName": "Geo map.html", - "attachments": [ - { - "attachmentId": "kcYjOvJDFkbS", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "Geo map_image.png" - }, - { - "attachmentId": "FDP3JzIVSnuJ", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "1_Geo map_image.png" - }, - { - "attachmentId": "eUrcqc8RRuZG", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "2_Geo map_image.png" - }, - { - "attachmentId": "1quk4yxJpeHZ", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "3_Geo map_image.png" - }, - { - "attachmentId": "iSpyhQ5Ya6Nk", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "4_Geo map_image.png" - }, - { - "attachmentId": "ut6vm2aXVfXI", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "5_Geo map_image.png" - }, - { - "attachmentId": "uYdb9wWf5Nuv", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "6_Geo map_image.png" - }, - { - "attachmentId": "viN50n5G4kB0", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "7_Geo map_image.png" - }, - { - "attachmentId": "mgwGrtQZjxxb", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "8_Geo map_image.png" - }, - { - "attachmentId": "PMqmCbNLlZOG", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "9_Geo map_image.png" - }, - { - "attachmentId": "0AwaQMqt3FVA", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "10_Geo map_image.png" - }, - { - "attachmentId": "gR2c2Thmfy3I", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "11_Geo map_image.png" - }, - { - "attachmentId": "JULizn130rVI", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "12_Geo map_image.png" - }, - { - "attachmentId": "MdC0DpifJwu4", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "13_Geo map_image.png" - }, - { - "attachmentId": "gFR2Izzp18LQ", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "14_Geo map_image.png" - }, - { - "attachmentId": "42AncDs7SSAf", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "15_Geo map_image.png" - }, - { - "attachmentId": "FXRVvYpOxWyR", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "16_Geo map_image.png" - }, - { - "attachmentId": "qudP7UCtwIq3", - "title": "image.png", - "role": "image", - "mime": "image/jpg", - "position": 10, - "dataFileName": "17_Geo map_image.png" - }, - { - "attachmentId": "utecGxWk08QY", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "18_Geo map_image.png" - } - ] - } - ] - }, - { - "isClone": false, - "noteId": "BhLd0mxKn0gY", - "notePath": [ - "OkOZllzB3fqN", - "BhLd0mxKn0gY" - ], - "title": "Shared notes", - "notePosition": 100, - "prefix": null, - "isExpanded": false, - "type": "text", - "mime": "text/html", - "attributes": [ - { - "type": "label", - "name": "iconClass", - "value": "bx bx-share-alt", - "isInheritable": false, - "position": 10 - } - ], - "format": "html", - "attachments": [], - "dirFileName": "Shared notes", - "children": [ - { - "isClone": false, - "noteId": "1DtQ2mHreeOI", - "notePath": [ - "OkOZllzB3fqN", - "BhLd0mxKn0gY", - "1DtQ2mHreeOI" - ], - "title": "Serving directly the content of a note", - "notePosition": 10, - "prefix": null, - "isExpanded": false, - "type": "text", - "mime": "text/html", - "attributes": [], - "format": "html", - "dataFileName": "Serving directly the content o.html", - "attachments": [ - { - "attachmentId": "2zgbdi7zMieM", - "title": "image.png", - "role": "image", - "mime": "image/jpg", - "position": 10, - "dataFileName": "Serving directly the conte.png" - }, - { - "attachmentId": "DsKDaFOcumH6", - "title": "image.png", - "role": "image", - "mime": "image/jpg", - "position": 10, - "dataFileName": "1_Serving directly the conte.png" - } - ] - } - ] - }, - { - "isClone": false, - "noteId": "LTnkDnYmmZ7s", - "notePath": [ - "OkOZllzB3fqN", - "LTnkDnYmmZ7s" - ], - "title": "Scripting", - "notePosition": 140, - "prefix": null, - "isExpanded": false, - "type": "text", - "mime": "text/html", - "attributes": [ - { - "type": "label", - "name": "iconClass", - "value": "bx bx-package", - "isInheritable": false, - "position": 10 - } - ], - "format": "html", - "attachments": [], - "dirFileName": "Scripting", - "children": [ - { - "isClone": false, - "noteId": "cTWlUHkiv1fB", - "notePath": [ - "OkOZllzB3fqN", - "LTnkDnYmmZ7s", - "cTWlUHkiv1fB" - ], - "title": "Examples", - "notePosition": 10, - "prefix": null, - "isExpanded": false, - "type": "text", - "mime": "text/html", - "attributes": [], - "format": "html", - "attachments": [], - "dirFileName": "Examples", - "children": [ - { - "isClone": false, - "noteId": "g5Vta7jt3aq3", - "notePath": [ - "OkOZllzB3fqN", - "LTnkDnYmmZ7s", - "cTWlUHkiv1fB", - "g5Vta7jt3aq3" - ], - "title": "Downloading responses from Google Forms", - "notePosition": 10, - "prefix": null, - "isExpanded": false, - "type": "text", - "mime": "text/html", - "attributes": [], - "format": "html", - "dataFileName": "Downloading responses from Goo.html", - "attachments": [] - } - ] - }, - { - "isClone": false, - "noteId": "Yo16FgbwBvdM", - "notePath": [ - "OkOZllzB3fqN", - "LTnkDnYmmZ7s", - "Yo16FgbwBvdM" - ], - "title": "Using promoted attributes to configure scripts", - "notePosition": 20, - "prefix": null, - "isExpanded": false, - "type": "text", - "mime": "text/html", - "attributes": [], - "format": "html", - "dataFileName": "Using promoted attributes to c.html", - "attachments": [ - { - "attachmentId": "j8HQoFca79U2", - "title": "image.png", - "role": "image", - "mime": "image/png", - "position": 10, - "dataFileName": "Using promoted attributes .png" - } - ] - } - ] - }, - { - "isClone": false, - "noteId": "3wuignsm05k2", - "notePath": [ - "OkOZllzB3fqN", - "3wuignsm05k2" - ], - "title": "Advanced topics", - "notePosition": 150, - "prefix": null, - "isExpanded": false, - "type": "text", - "mime": "text/html", - "attributes": [ - { - "type": "label", - "name": "iconClass", - "value": "bx bx-rocket", - "isInheritable": false, - "position": 10 - } - ], - "format": "html", - "attachments": [], - "dirFileName": "Advanced topics", - "children": [ - { - "isClone": false, - "noteId": "po38jIc0LD2H", - "notePath": [ - "OkOZllzB3fqN", - "3wuignsm05k2", - "po38jIc0LD2H" - ], - "title": "Custom resource providers", - "notePosition": 10, - "prefix": null, - "isExpanded": false, - "type": "text", - "mime": "text/html", - "attributes": [], - "format": "html", - "dataFileName": "Custom resource providers.html", - "attachments": [] - }, - { - "isClone": false, - "noteId": "rGq9oI9hWwGf", - "notePath": [ - "OkOZllzB3fqN", - "3wuignsm05k2", - "rGq9oI9hWwGf" - ], - "title": "REST API", - "notePosition": 20, - "prefix": null, - "isExpanded": false, - "type": "text", - "mime": "text/html", - "attributes": [], - "format": "html", - "attachments": [], - "dirFileName": "REST API", - "children": [ - { - "isClone": false, - "noteId": "sztusxU10ADE", - "notePath": [ - "OkOZllzB3fqN", - "3wuignsm05k2", - "rGq9oI9hWwGf", - "sztusxU10ADE" - ], - "title": "ETAPI", - "notePosition": 10, - "prefix": null, - "isExpanded": false, - "type": "text", - "mime": "text/html", - "attributes": [], - "format": "html", - "attachments": [], - "dirFileName": "ETAPI", - "children": [ - { - "isClone": false, - "noteId": "f3xpgx6H01PW", - "notePath": [ - "OkOZllzB3fqN", - "3wuignsm05k2", - "rGq9oI9hWwGf", - "sztusxU10ADE", - "f3xpgx6H01PW" - ], - "title": "API Reference", - "notePosition": 10, - "prefix": null, - "isExpanded": false, - "type": "webView", - "mime": "", - "attributes": [ - { - "type": "label", - "name": "webViewSrc", - "value": "/etapi/docs", - "isInheritable": false, - "position": 10 - } - ], - "dataFileName": "API Reference.dat", - "attachments": [] - } - ] - }, - { - "isClone": false, - "noteId": "9OiEC6pf3Wfv", - "notePath": [ - "OkOZllzB3fqN", - "3wuignsm05k2", - "rGq9oI9hWwGf", - "9OiEC6pf3Wfv" - ], - "title": "Internal API", - "notePosition": 20, - "prefix": null, - "isExpanded": false, - "type": "text", - "mime": "text/html", - "attributes": [], - "format": "html", - "attachments": [], - "dirFileName": "Internal API", - "children": [ - { - "isClone": false, - "noteId": "7uB5k0iCmOtZ", - "notePath": [ - "OkOZllzB3fqN", - "3wuignsm05k2", - "rGq9oI9hWwGf", - "9OiEC6pf3Wfv", - "7uB5k0iCmOtZ" - ], - "title": "API Reference", - "notePosition": 10, - "prefix": null, - "isExpanded": false, - "type": "webView", - "mime": "", - "attributes": [ - { - "type": "label", - "name": "webViewSrc", - "value": "/api/docs", - "isInheritable": false, - "position": 10 - } - ], - "dataFileName": "API Reference.dat", - "attachments": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "noImport": true, - "dataFileName": "navigation.html" - }, - { - "noImport": true, - "dataFileName": "index.html" - }, - { - "noImport": true, - "dataFileName": "style.css" - } - ] + "formatVersion": 2, + "appVersion": "0.92.3-beta", + "files": [ + { + "isClone": false, + "noteId": "pOsGYCXsbNQG", + "notePath": [ + "pOsGYCXsbNQG" + ], + "title": "User Guide", + "notePosition": 10, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [], + "format": "markdown", + "dataFileName": "User Guide.md", + "attachments": [], + "dirFileName": "User Guide", + "children": [ + { + "isClone": false, + "noteId": "tC7s2alapj8V", + "notePath": [ + "pOsGYCXsbNQG", + "tC7s2alapj8V" + ], + "title": "Advanced Usage", + "notePosition": 10, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "label", + "name": "iconClass", + "value": "bx bx-rocket", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "attachments": [], + "dirFileName": "Advanced Usage", + "children": [ + { + "isClone": false, + "noteId": "zEY4DaJG4YT5", + "notePath": [ + "pOsGYCXsbNQG", + "tC7s2alapj8V", + "zEY4DaJG4YT5" + ], + "title": "Attributes", + "notePosition": 10, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "R7abl2fc6Mxi", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "l0tKav7yLHGF", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "p9kXRFAkwN4o", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "J5Ex1ZrMbyJ6", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "9sRHySam5fXb", + "isInheritable": false, + "position": 50 + }, + { + "type": "relation", + "name": "internalLink", + "value": "u3YFHC9tQlpm", + "isInheritable": false, + "position": 60 + }, + { + "type": "relation", + "name": "internalLink", + "value": "R9pX4DGra2Vt", + "isInheritable": false, + "position": 70 + }, + { + "type": "relation", + "name": "internalLink", + "value": "47ZrP6FNuoG8", + "isInheritable": false, + "position": 80 + }, + { + "type": "relation", + "name": "internalLink", + "value": "OFXdgB2nNk1F", + "isInheritable": false, + "position": 90 + }, + { + "type": "relation", + "name": "internalLink", + "value": "bwZpz2ajCEwO", + "isInheritable": false, + "position": 100 + }, + { + "type": "label", + "name": "shareAlias", + "value": "attributes", + "isInheritable": false, + "position": 30 + } + ], + "format": "markdown", + "dataFileName": "Attributes.md", + "attachments": [ + { + "attachmentId": "P4eRVtGFoHh2", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "Attributes_image.png" + }, + { + "attachmentId": "ZuUT0WgJVR2j", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "1_Attributes_image.png" + } + ], + "dirFileName": "Attributes", + "children": [ + { + "isClone": false, + "noteId": "bwZpz2ajCEwO", + "notePath": [ + "pOsGYCXsbNQG", + "tC7s2alapj8V", + "zEY4DaJG4YT5", + "bwZpz2ajCEwO" + ], + "title": "Attribute Inheritance", + "notePosition": 10, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "KC1HB96bqqHX", + "isInheritable": false, + "position": 10 + }, + { + "type": "label", + "name": "shareAlias", + "value": "attribute-inheritance", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Attribute Inheritance.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "OFXdgB2nNk1F", + "notePath": [ + "pOsGYCXsbNQG", + "tC7s2alapj8V", + "zEY4DaJG4YT5", + "OFXdgB2nNk1F" + ], + "title": "Promoted Attributes", + "notePosition": 20, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "zEY4DaJG4YT5", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "bwZpz2ajCEwO", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "imageLink", + "value": "rxH2Dm1jn6YT", + "isInheritable": false, + "position": 30 + }, + { + "type": "label", + "name": "shareAlias", + "value": "promoted-attributes", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Promoted Attributes.md", + "attachments": [ + { + "attachmentId": "4EcBRWF9iCk2", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "Promoted Attributes_image.png" + } + ] + }, + { + "isClone": false, + "noteId": "KC1HB96bqqHX", + "notePath": [ + "pOsGYCXsbNQG", + "tC7s2alapj8V", + "zEY4DaJG4YT5", + "KC1HB96bqqHX" + ], + "title": "Template", + "notePosition": 30, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "bwZpz2ajCEwO", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "OFXdgB2nNk1F", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "xYjQUYhpbUEW", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "l0tKav7yLHGF", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "imageLink", + "value": "Y8kzZ5MSZLCC", + "isInheritable": false, + "position": 50 + }, + { + "type": "relation", + "name": "imageLink", + "value": "uuGrYX41lWN0", + "isInheritable": false, + "position": 60 + }, + { + "type": "relation", + "name": "internalLink", + "value": "9sRHySam5fXb", + "isInheritable": false, + "position": 70 + }, + { + "type": "relation", + "name": "internalLink", + "value": "wX4HbRucYSDD", + "isInheritable": false, + "position": 80 + }, + { + "type": "relation", + "name": "internalLink", + "value": "iRwzGnHPzonm", + "isInheritable": false, + "position": 90 + }, + { + "type": "relation", + "name": "internalLink", + "value": "47ZrP6FNuoG8", + "isInheritable": false, + "position": 100 + }, + { + "type": "label", + "name": "shareAlias", + "value": "template", + "isInheritable": false, + "position": 30 + } + ], + "format": "markdown", + "dataFileName": "Template.md", + "attachments": [] + } + ] + }, + { + "isClone": false, + "noteId": "iRwzGnHPzonm", + "notePath": [ + "pOsGYCXsbNQG", + "tC7s2alapj8V", + "iRwzGnHPzonm" + ], + "title": "Relation Map", + "notePosition": 20, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "zEY4DaJG4YT5", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "OFXdgB2nNk1F", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "wX4HbRucYSDD", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "BCkXAVs63Ttv", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "imageLink", + "value": "EH6qNioOHeyT", + "isInheritable": false, + "position": 50 + }, + { + "type": "relation", + "name": "imageLink", + "value": "xeZPrfi77XPu", + "isInheritable": false, + "position": 60 + }, + { + "type": "relation", + "name": "imageLink", + "value": "N98UhifxrVpZ", + "isInheritable": false, + "position": 70 + }, + { + "type": "relation", + "name": "internalLink", + "value": "kBrnXNG3Hplm", + "isInheritable": false, + "position": 80 + }, + { + "type": "label", + "name": "shareAlias", + "value": "relation-map", + "isInheritable": false, + "position": 30 + } + ], + "format": "markdown", + "dataFileName": "Relation Map.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "BCkXAVs63Ttv", + "notePath": [ + "pOsGYCXsbNQG", + "tC7s2alapj8V", + "BCkXAVs63Ttv" + ], + "title": "Note Map", + "notePosition": 30, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "zEY4DaJG4YT5", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "iRwzGnHPzonm", + "isInheritable": false, + "position": 20 + }, + { + "type": "label", + "name": "shareAlias", + "value": "note-map", + "isInheritable": false, + "position": 30 + } + ], + "format": "markdown", + "dataFileName": "Note Map.md", + "attachments": [ + { + "attachmentId": "scmGuoLQPj8C", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "Note Map_image.png" + }, + { + "attachmentId": "F48iB3BbITHb", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "1_Note Map_image.png" + } + ] + }, + { + "isClone": false, + "noteId": "R9pX4DGra2Vt", + "notePath": [ + "pOsGYCXsbNQG", + "tC7s2alapj8V", + "R9pX4DGra2Vt" + ], + "title": "Sharing", + "notePosition": 50, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "imageLink", + "value": "5GcxcE9fP9xX", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "imageLink", + "value": "Ky3qOJJMZ731", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "imageLink", + "value": "lCtZz2Z59wPT", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "imageLink", + "value": "jEQNvpyaXIWE", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "WOcw2SLH6tbX", + "isInheritable": false, + "position": 50 + }, + { + "type": "relation", + "name": "internalLink", + "value": "bwZpz2ajCEwO", + "isInheritable": false, + "position": 60 + }, + { + "type": "relation", + "name": "internalLink", + "value": "6f9hih2hXXZk", + "isInheritable": false, + "position": 70 + }, + { + "type": "relation", + "name": "internalLink", + "value": "Wy267RK4M69c", + "isInheritable": false, + "position": 80 + }, + { + "type": "label", + "name": "shareAlias", + "value": "sharing", + "isInheritable": false, + "position": 10 + }, + { + "type": "label", + "name": "iconClass", + "value": "bx bx-share-alt", + "isInheritable": false, + "position": 30 + } + ], + "format": "markdown", + "dataFileName": "Sharing.md", + "attachments": [], + "dirFileName": "Sharing", + "children": [ + { + "isClone": false, + "noteId": "Qjt68inQ2bRj", + "notePath": [ + "pOsGYCXsbNQG", + "tC7s2alapj8V", + "R9pX4DGra2Vt", + "Qjt68inQ2bRj" + ], + "title": "Serving directly the content of a note", + "notePosition": 10, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [], + "format": "markdown", + "dataFileName": "Serving directly the content o.md", + "attachments": [ + { + "attachmentId": "eizmhhmocL6L", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "Serving directly the conte.png" + }, + { + "attachmentId": "xicVjsf2Kmaz", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "1_Serving directly the conte.png" + } + ] + } + ] + }, + { + "isClone": false, + "noteId": "6f9hih2hXXZk", + "notePath": [ + "pOsGYCXsbNQG", + "tC7s2alapj8V", + "6f9hih2hXXZk" + ], + "title": "Code Notes", + "notePosition": 60, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "CdNpE2pqjmI6", + "isInheritable": false, + "position": 10 + }, + { + "type": "label", + "name": "shareAlias", + "value": "code-notes", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Code Notes.md", + "attachments": [ + { + "attachmentId": "hajUVeLs3EOM", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "Code Notes_image.png" + }, + { + "attachmentId": "OTcapNOcNaBL", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "1_Code Notes_image.png" + } + ], + "dirFileName": "Code Notes", + "children": [ + { + "isClone": false, + "noteId": "CdNpE2pqjmI6", + "notePath": [ + "pOsGYCXsbNQG", + "tC7s2alapj8V", + "6f9hih2hXXZk", + "CdNpE2pqjmI6" + ], + "title": "Scripts", + "notePosition": 10, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "6f9hih2hXXZk", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "GLks18SNjxmC", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "zEY4DaJG4YT5", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "5668rwcirq1t", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "GPERMystNGTB", + "isInheritable": false, + "position": 50 + }, + { + "type": "relation", + "name": "imageLink", + "value": "DVJl4l3T8EG2", + "isInheritable": false, + "position": 60 + }, + { + "type": "relation", + "name": "internalLink", + "value": "wX4HbRucYSDD", + "isInheritable": false, + "position": 70 + }, + { + "type": "relation", + "name": "internalLink", + "value": "RDslemsQ6gCp", + "isInheritable": false, + "position": 80 + }, + { + "type": "label", + "name": "shareAlias", + "value": "scripts", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Scripts.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "GLks18SNjxmC", + "notePath": [ + "pOsGYCXsbNQG", + "tC7s2alapj8V", + "6f9hih2hXXZk", + "GLks18SNjxmC" + ], + "title": "Script API", + "notePosition": 20, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "label", + "name": "shareAlias", + "value": "script-api", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "Script API.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "GPERMystNGTB", + "notePath": [ + "pOsGYCXsbNQG", + "tC7s2alapj8V", + "6f9hih2hXXZk", + "GPERMystNGTB" + ], + "title": "Events", + "notePosition": 40, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "zEY4DaJG4YT5", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "CdNpE2pqjmI6", + "isInheritable": false, + "position": 20 + }, + { + "type": "label", + "name": "shareAlias", + "value": "events", + "isInheritable": false, + "position": 30 + } + ], + "format": "markdown", + "dataFileName": "Events.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "MgibgPcfeuGz", + "notePath": [ + "pOsGYCXsbNQG", + "tC7s2alapj8V", + "6f9hih2hXXZk", + "MgibgPcfeuGz" + ], + "title": "Custom Widgets", + "notePosition": 50, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "imageLink", + "value": "3sCPPL0LEC1S", + "isInheritable": false, + "position": 10 + }, + { + "type": "label", + "name": "shareAlias", + "value": "custom-widget", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Custom Widgets.md", + "attachments": [] + } + ] + }, + { + "isClone": false, + "noteId": "5668rwcirq1t", + "notePath": [ + "pOsGYCXsbNQG", + "tC7s2alapj8V", + "5668rwcirq1t" + ], + "title": "Advanced Showcases", + "notePosition": 70, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "CdNpE2pqjmI6", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "OFXdgB2nNk1F", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "wX4HbRucYSDD", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "iRwzGnHPzonm", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "l0tKav7yLHGF", + "isInheritable": false, + "position": 50 + }, + { + "type": "relation", + "name": "internalLink", + "value": "R7abl2fc6Mxi", + "isInheritable": false, + "position": 60 + }, + { + "type": "relation", + "name": "internalLink", + "value": "xYjQUYhpbUEW", + "isInheritable": false, + "position": 70 + }, + { + "type": "label", + "name": "shareAlias", + "value": "advanced-showcases", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "Advanced Showcases.md", + "attachments": [], + "dirFileName": "Advanced Showcases", + "children": [ + { + "isClone": false, + "noteId": "l0tKav7yLHGF", + "notePath": [ + "pOsGYCXsbNQG", + "tC7s2alapj8V", + "5668rwcirq1t", + "l0tKav7yLHGF" + ], + "title": "Day Notes", + "notePosition": 10, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "IakOLONlIfGI", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "xYjQUYhpbUEW", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "OFXdgB2nNk1F", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "R7abl2fc6Mxi", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "KC1HB96bqqHX", + "isInheritable": false, + "position": 50 + }, + { + "type": "label", + "name": "shareAlias", + "value": "day-notes", + "isInheritable": false, + "position": 10 + }, + { + "type": "label", + "name": "iconClass", + "value": "bx bx-calendar", + "isInheritable": false, + "position": 40 + } + ], + "format": "markdown", + "dataFileName": "Day Notes.md", + "attachments": [ + { + "attachmentId": "9wmaElfXYjWM", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "Day Notes_image.png" + }, + { + "attachmentId": "H3Iy9PpIDd0Z", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "1_Day Notes_image.png" + } + ] + }, + { + "isClone": false, + "noteId": "R7abl2fc6Mxi", + "notePath": [ + "pOsGYCXsbNQG", + "tC7s2alapj8V", + "5668rwcirq1t", + "R7abl2fc6Mxi" + ], + "title": "Weight Tracker", + "notePosition": 20, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "l0tKav7yLHGF", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "GLks18SNjxmC", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "wX4HbRucYSDD", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "OFXdgB2nNk1F", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "KC1HB96bqqHX", + "isInheritable": false, + "position": 50 + }, + { + "type": "relation", + "name": "internalLink", + "value": "CdNpE2pqjmI6", + "isInheritable": false, + "position": 60 + }, + { + "type": "relation", + "name": "internalLink", + "value": "zEY4DaJG4YT5", + "isInheritable": false, + "position": 70 + }, + { + "type": "relation", + "name": "internalLink", + "value": "6f9hih2hXXZk", + "isInheritable": false, + "position": 80 + }, + { + "type": "label", + "name": "shareAlias", + "value": "weight-tracker", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Weight Tracker.md", + "attachments": [ + { + "attachmentId": "Ah5QpwUUEGf8", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "Weight Tracker_image.png" + } + ] + }, + { + "isClone": false, + "noteId": "xYjQUYhpbUEW", + "notePath": [ + "pOsGYCXsbNQG", + "tC7s2alapj8V", + "5668rwcirq1t", + "xYjQUYhpbUEW" + ], + "title": "Task Manager", + "notePosition": 30, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "l0tKav7yLHGF", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "imageLink", + "value": "92KeXdKh3Ca1", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "OFXdgB2nNk1F", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "CdNpE2pqjmI6", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "wX4HbRucYSDD", + "isInheritable": false, + "position": 50 + }, + { + "type": "relation", + "name": "internalLink", + "value": "IakOLONlIfGI", + "isInheritable": false, + "position": 60 + }, + { + "type": "relation", + "name": "internalLink", + "value": "kBrnXNG3Hplm", + "isInheritable": false, + "position": 70 + }, + { + "type": "relation", + "name": "internalLink", + "value": "zEY4DaJG4YT5", + "isInheritable": false, + "position": 80 + }, + { + "type": "relation", + "name": "internalLink", + "value": "bwZpz2ajCEwO", + "isInheritable": false, + "position": 90 + }, + { + "type": "relation", + "name": "internalLink", + "value": "GPERMystNGTB", + "isInheritable": false, + "position": 100 + }, + { + "type": "relation", + "name": "internalLink", + "value": "6f9hih2hXXZk", + "isInheritable": false, + "position": 110 + }, + { + "type": "label", + "name": "shareAlias", + "value": "task-manager", + "isInheritable": false, + "position": 30 + } + ], + "format": "markdown", + "dataFileName": "Task Manager.md", + "attachments": [] + } + ] + }, + { + "isClone": false, + "noteId": "J5Ex1ZrMbyJ6", + "notePath": [ + "pOsGYCXsbNQG", + "tC7s2alapj8V", + "J5Ex1ZrMbyJ6" + ], + "title": "Custom Request Handler", + "notePosition": 80, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "CdNpE2pqjmI6", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "6f9hih2hXXZk", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "zEY4DaJG4YT5", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "GLks18SNjxmC", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "d3fAXQ2diepH", + "isInheritable": false, + "position": 50 + }, + { + "type": "label", + "name": "shareAlias", + "value": "custom-request-handler", + "isInheritable": false, + "position": 30 + } + ], + "format": "markdown", + "dataFileName": "Custom Request Handler.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "d3fAXQ2diepH", + "notePath": [ + "pOsGYCXsbNQG", + "tC7s2alapj8V", + "d3fAXQ2diepH" + ], + "title": "Custom Resource Providers", + "notePosition": 90, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [], + "format": "markdown", + "dataFileName": "Custom Resource Providers.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "pgxEVkzLl1OP", + "notePath": [ + "pOsGYCXsbNQG", + "tC7s2alapj8V", + "pgxEVkzLl1OP" + ], + "title": "ETAPI (REST API)", + "notePosition": 100, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "label", + "name": "shareAlias", + "value": "etapi", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "ETAPI (REST API).md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "47ZrP6FNuoG8", + "notePath": [ + "pOsGYCXsbNQG", + "tC7s2alapj8V", + "47ZrP6FNuoG8" + ], + "title": "Default Note Title", + "notePosition": 110, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "zEY4DaJG4YT5", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "KC1HB96bqqHX", + "isInheritable": false, + "position": 20 + }, + { + "type": "label", + "name": "shareAlias", + "value": "default-note-title", + "isInheritable": false, + "position": 30 + } + ], + "format": "markdown", + "dataFileName": "Default Note Title.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "wX4HbRucYSDD", + "notePath": [ + "pOsGYCXsbNQG", + "tC7s2alapj8V", + "wX4HbRucYSDD" + ], + "title": "Database", + "notePosition": 130, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "tAassRL4RSQL", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "iRwzGnHPzonm", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "l0tKav7yLHGF", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "R7abl2fc6Mxi", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "xYjQUYhpbUEW", + "isInheritable": false, + "position": 50 + }, + { + "type": "relation", + "name": "internalLink", + "value": "Wy267RK4M69c", + "isInheritable": false, + "position": 60 + }, + { + "type": "relation", + "name": "internalLink", + "value": "oyIAJ9PvvwHX", + "isInheritable": false, + "position": 70 + }, + { + "type": "relation", + "name": "internalLink", + "value": "Gzjqa934BdH4", + "isInheritable": false, + "position": 80 + }, + { + "type": "label", + "name": "shareAlias", + "value": "database", + "isInheritable": false, + "position": 30 + }, + { + "type": "label", + "name": "iconClass", + "value": "bx bx-data", + "isInheritable": false, + "position": 50 + } + ], + "format": "markdown", + "dataFileName": "Database.md", + "attachments": [], + "dirFileName": "Database", + "children": [ + { + "isClone": false, + "noteId": "oyIAJ9PvvwHX", + "notePath": [ + "pOsGYCXsbNQG", + "tC7s2alapj8V", + "wX4HbRucYSDD", + "oyIAJ9PvvwHX" + ], + "title": "Manually altering the database", + "notePosition": 10, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "YKWqdJhzi2VY", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "tAassRL4RSQL", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Manually altering the database.md", + "attachments": [ + { + "attachmentId": "uvaARhqiU4M5", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "Manually altering the data.png" + }, + { + "attachmentId": "W4710rPIeZjF", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "1_Manually altering the data.png" + }, + { + "attachmentId": "yC5HdtMbAaaF", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "2_Manually altering the data.png" + }, + { + "attachmentId": "wL249F7azfME", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "3_Manually altering the data.png" + }, + { + "attachmentId": "lAsR2tqMXurk", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "4_Manually altering the data.png" + }, + { + "attachmentId": "fJlFqdEOpLrF", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "5_Manually altering the data.png" + }, + { + "attachmentId": "0740ph4lJ4rv", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "6_Manually altering the data.png" + } + ], + "dirFileName": "Manually altering the database", + "children": [ + { + "isClone": false, + "noteId": "YKWqdJhzi2VY", + "notePath": [ + "pOsGYCXsbNQG", + "tC7s2alapj8V", + "wX4HbRucYSDD", + "oyIAJ9PvvwHX", + "YKWqdJhzi2VY" + ], + "title": "SQL Console", + "notePosition": 10, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "l0tKav7yLHGF", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "Vc8PjrjAGuOp", + "isInheritable": false, + "position": 20 + }, + { + "type": "label", + "name": "iconClass", + "value": "bx bx-data", + "isInheritable": false, + "position": 30 + } + ], + "format": "markdown", + "dataFileName": "SQL Console.md", + "attachments": [ + { + "attachmentId": "827EgLgWhZWF", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "SQL Console_image.png" + }, + { + "attachmentId": "pP87PB9ELjQn", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "1_SQL Console_image.png" + }, + { + "attachmentId": "gIbK7NNLu3iZ", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "2_SQL Console_image.png" + }, + { + "attachmentId": "1YS10Qg7S4YR", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "3_SQL Console_image.png" + } + ] + } + ] + } + ] + }, + { + "isClone": false, + "noteId": "Gzjqa934BdH4", + "notePath": [ + "pOsGYCXsbNQG", + "tC7s2alapj8V", + "Gzjqa934BdH4" + ], + "title": "Configuration (config.ini or environment variables)", + "notePosition": 140, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "label", + "name": "shareAlias", + "value": "configuration", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "Configuration (config.ini or e.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "ivYnonVFBxbQ", + "notePath": [ + "pOsGYCXsbNQG", + "tC7s2alapj8V", + "ivYnonVFBxbQ" + ], + "title": "Bulk actions", + "notePosition": 150, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [], + "format": "markdown", + "dataFileName": "Bulk actions.md", + "attachments": [] + } + ] + }, + { + "isClone": false, + "noteId": "s3YCWHBfmYuM", + "notePath": [ + "pOsGYCXsbNQG", + "s3YCWHBfmYuM" + ], + "title": "Quick Start", + "notePosition": 20, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "imageLink", + "value": "JXFeNgU8Xnp1", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "poXkQfguuA0U", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "WOcw2SLH6tbX", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "RDslemsQ6gCp", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "cbkrhQjrkKrh", + "isInheritable": false, + "position": 50 + }, + { + "type": "relation", + "name": "internalLink", + "value": "BFs8mudNFgCS", + "isInheritable": false, + "position": 60 + }, + { + "type": "label", + "name": "shareAlias", + "value": "quick-start", + "isInheritable": false, + "position": 30 + }, + { + "type": "label", + "name": "iconClass", + "value": "bx bx-run", + "isInheritable": false, + "position": 40 + } + ], + "format": "markdown", + "dataFileName": "Quick Start.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "FJ4qLB6X4fyS", + "notePath": [ + "pOsGYCXsbNQG", + "FJ4qLB6X4fyS" + ], + "title": "What's new", + "notePosition": 30, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "81SGnPGMk7Xc", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "NRnIZmSMc5sj", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "rC3pL2aptaRE", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "xWbu3jpNWapp", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "BMf2nEbYlcUt", + "isInheritable": false, + "position": 50 + }, + { + "type": "label", + "name": "iconClass", + "value": "bx bx-star", + "isInheritable": false, + "position": 60 + } + ], + "format": "markdown", + "dataFileName": "What's new.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "gh7bpGYxajRS", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS" + ], + "title": "Basic Concepts", + "notePosition": 60, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "label", + "name": "iconClass", + "value": "bx bx-help-circle", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "attachments": [], + "dirFileName": "Basic Concepts", + "children": [ + { + "isClone": false, + "noteId": "Vc8PjrjAGuOp", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "Vc8PjrjAGuOp" + ], + "title": "UI Elements", + "notePosition": 10, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [], + "format": "markdown", + "attachments": [ + { + "attachmentId": "vbrDuqZjshed", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "UI Elements_image.png" + }, + { + "attachmentId": "0CaTtahPNa2i", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "1_UI Elements_image.png" + } + ], + "dirFileName": "UI Elements", + "children": [ + { + "isClone": false, + "noteId": "x3i7MxGccDuM", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "Vc8PjrjAGuOp", + "x3i7MxGccDuM" + ], + "title": "Global menu", + "notePosition": 10, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [], + "format": "markdown", + "dataFileName": "Global menu.md", + "attachments": [ + { + "attachmentId": "PhNb7G9OgPVt", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "Global menu_image.png" + }, + { + "attachmentId": "8fNGILWWQodv", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "1_Global menu_image.png" + } + ] + } + ] + }, + { + "isClone": false, + "noteId": "BFs8mudNFgCS", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "BFs8mudNFgCS" + ], + "title": "Note", + "notePosition": 20, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "iPIMuisry3hd", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "6f9hih2hXXZk", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "CdNpE2pqjmI6", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "m523cpzocqaD", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "iRwzGnHPzonm", + "isInheritable": false, + "position": 50 + }, + { + "type": "relation", + "name": "internalLink", + "value": "GTwFsgaA0lCt", + "isInheritable": false, + "position": 60 + }, + { + "type": "relation", + "name": "internalLink", + "value": "IakOLONlIfGI", + "isInheritable": false, + "position": 70 + }, + { + "type": "relation", + "name": "internalLink", + "value": "ODY7qQn5m2FT", + "isInheritable": false, + "position": 80 + }, + { + "type": "relation", + "name": "internalLink", + "value": "CoFPLs3dRlXc", + "isInheritable": false, + "position": 90 + }, + { + "type": "label", + "name": "shareAlias", + "value": "note", + "isInheritable": false, + "position": 30 + } + ], + "format": "markdown", + "dataFileName": "Note.md", + "attachments": [], + "dirFileName": "Note", + "children": [ + { + "isClone": false, + "noteId": "p9kXRFAkwN4o", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "BFs8mudNFgCS", + "p9kXRFAkwN4o" + ], + "title": "Note Icons", + "notePosition": 10, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "imageLink", + "value": "iuAfnapzpRCB", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "imageLink", + "value": "R1L2vUshJD82", + "isInheritable": false, + "position": 20 + }, + { + "type": "label", + "name": "shareAlias", + "value": "note-icons", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Note Icons.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "QEAPj01N5f7w", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "BFs8mudNFgCS", + "QEAPj01N5f7w" + ], + "title": "Links", + "notePosition": 30, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "imageLink", + "value": "N6O1qfBGcbFH", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "imageLink", + "value": "dPcRcDZwyGAO", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "BCkXAVs63Ttv", + "isInheritable": false, + "position": 30 + }, + { + "type": "label", + "name": "shareAlias", + "value": "links", + "isInheritable": false, + "position": 30 + } + ], + "format": "markdown", + "dataFileName": "Links.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "mT0HEkOsz6i1", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "BFs8mudNFgCS", + "mT0HEkOsz6i1" + ], + "title": "Images", + "notePosition": 40, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "0vhv7lsOLy82", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "kBrnXNG3Hplm", + "isInheritable": false, + "position": 20 + }, + { + "type": "label", + "name": "shareAlias", + "value": "images", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "Images.md", + "attachments": [ + { + "attachmentId": "PUjxzv10IJkx", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "Images_image.png" + }, + { + "attachmentId": "MTsRB4C0yvKX", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "1_Images_image.png" + } + ] + }, + { + "isClone": false, + "noteId": "0vhv7lsOLy82", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "BFs8mudNFgCS", + "0vhv7lsOLy82" + ], + "title": "Attachments", + "notePosition": 50, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "BFs8mudNFgCS", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "CdNpE2pqjmI6", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "R7abl2fc6Mxi", + "isInheritable": false, + "position": 30 + }, + { + "type": "label", + "name": "shareAlias", + "value": "attachments", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Attachments.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "IakOLONlIfGI", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "BFs8mudNFgCS", + "IakOLONlIfGI" + ], + "title": "Cloning Notes", + "notePosition": 60, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "imageLink", + "value": "BqvIJUHkWrvH", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "A9Oc6YKKc65v", + "isInheritable": false, + "position": 20 + }, + { + "type": "label", + "name": "shareAlias", + "value": "cloning-notes", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Cloning Notes.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "bwg0e8ewQMak", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "BFs8mudNFgCS", + "bwg0e8ewQMak" + ], + "title": "Protected Notes", + "notePosition": 70, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "imageLink", + "value": "zaUtPWl8NcCt", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "wX4HbRucYSDD", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "zEY4DaJG4YT5", + "isInheritable": false, + "position": 30 + }, + { + "type": "label", + "name": "shareAlias", + "value": "protected-notes", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Protected Notes.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "MKmLg5x6xkor", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "BFs8mudNFgCS", + "MKmLg5x6xkor" + ], + "title": "Archived Notes", + "notePosition": 80, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "imageLink", + "value": "1fkGrskxHx5u", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "zEY4DaJG4YT5", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "bwZpz2ajCEwO", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "eIg8jdvaoNNd", + "isInheritable": false, + "position": 40 + }, + { + "type": "label", + "name": "shareAlias", + "value": "archived-notes", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Archived Notes.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "vZWERwf8U3nx", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "BFs8mudNFgCS", + "vZWERwf8U3nx" + ], + "title": "Note Revisions", + "notePosition": 90, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "imageLink", + "value": "MA2uvkVloWXl", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "zEY4DaJG4YT5", + "isInheritable": false, + "position": 20 + }, + { + "type": "label", + "name": "shareAlias", + "value": "note-revisions", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Note Revisions.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "aGlEvb9hyDhS", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "BFs8mudNFgCS", + "aGlEvb9hyDhS" + ], + "title": "Sorting Notes", + "notePosition": 100, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "zEY4DaJG4YT5", + "isInheritable": false, + "position": 10 + }, + { + "type": "label", + "name": "shareAlias", + "value": "sorting", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Sorting Notes.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "BMf2nEbYlcUt", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "BFs8mudNFgCS", + "BMf2nEbYlcUt" + ], + "title": "Right-to-Left Support", + "notePosition": 110, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "iPIMuisry3hd", + "isInheritable": false, + "position": 10 + }, + { + "type": "label", + "name": "iconClass", + "value": "bx bx-align-right", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "Right-to-Left Support.md", + "attachments": [ + { + "attachmentId": "oW5LpuCUuq1z", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "Right-to-Left Support_imag.png" + }, + { + "attachmentId": "hLJbTJdMAAjW", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "1_Right-to-Left Support_imag.png" + }, + { + "attachmentId": "J25q0es2PQGJ", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "2_Right-to-Left Support_imag.png" + }, + { + "attachmentId": "V7U0KMPHxH2I", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "3_Right-to-Left Support_imag.png" + }, + { + "attachmentId": "ox7Zs0BvBGBD", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "4_Right-to-Left Support_imag.png" + } + ] + }, + { + "isClone": false, + "noteId": "NRnIZmSMc5sj", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "BFs8mudNFgCS", + "NRnIZmSMc5sj" + ], + "title": "Export as PDF", + "notePosition": 120, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "label", + "name": "iconClass", + "value": "bx bxs-file-pdf", + "isInheritable": false, + "position": 30 + } + ], + "format": "markdown", + "dataFileName": "Export as PDF.md", + "attachments": [ + { + "attachmentId": "Om2EmdZr54vy", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "Export as PDF_image.png" + }, + { + "attachmentId": "NfSjRsArIQHy", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "1_Export as PDF_image.png" + } + ] + }, + { + "isClone": false, + "noteId": "CoFPLs3dRlXc", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "BFs8mudNFgCS", + "CoFPLs3dRlXc" + ], + "title": "Read-Only Notes", + "notePosition": 130, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "6f9hih2hXXZk", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "zEY4DaJG4YT5", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "iPIMuisry3hd", + "isInheritable": false, + "position": 30 + }, + { + "type": "label", + "name": "shareAlias", + "value": "read-only-note", + "isInheritable": false, + "position": 30 + }, + { + "type": "label", + "name": "iconClass", + "value": "bx bx-edit-alt", + "isInheritable": false, + "position": 40 + } + ], + "format": "markdown", + "dataFileName": "Read-Only Notes.md", + "attachments": [] + } + ] + }, + { + "isClone": false, + "noteId": "wArbEsdSae6g", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "wArbEsdSae6g" + ], + "title": "Navigation", + "notePosition": 30, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [], + "format": "markdown", + "attachments": [], + "dirFileName": "Navigation", + "children": [ + { + "isClone": false, + "noteId": "kBrnXNG3Hplm", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "wArbEsdSae6g", + "kBrnXNG3Hplm" + ], + "title": "Tree Concepts", + "notePosition": 10, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "BFs8mudNFgCS", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "IakOLONlIfGI", + "isInheritable": false, + "position": 20 + }, + { + "type": "label", + "name": "shareAlias", + "value": "tree-concepts", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Tree Concepts.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "oPVyFC7WL2Lp", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "wArbEsdSae6g", + "oPVyFC7WL2Lp" + ], + "title": "Tree Manipulation", + "notePosition": 20, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "imageLink", + "value": "sLZ7Bcq9p8E9", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "imageLink", + "value": "qL7381ZG0lMK", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "A9Oc6YKKc65v", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "IakOLONlIfGI", + "isInheritable": false, + "position": 40 + }, + { + "type": "label", + "name": "shareAlias", + "value": "tree-manipulation", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Tree Manipulation.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "MMiBEQljMQh2", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "wArbEsdSae6g", + "MMiBEQljMQh2" + ], + "title": "Note Navigation", + "notePosition": 30, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "imageLink", + "value": "snfWRIih71MM", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "imageLink", + "value": "wpFu8PhUu7e7", + "isInheritable": false, + "position": 20 + }, + { + "type": "label", + "name": "shareAlias", + "value": "note-navigation", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Note Navigation.md", + "attachments": [ + { + "attachmentId": "jDuwVaU8bNtG", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "Note Navigation_image.png" + }, + { + "attachmentId": "Pae5L9DXlzQW", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "1_Note Navigation_image.png" + } + ] + }, + { + "isClone": false, + "noteId": "eIg8jdvaoNNd", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "wArbEsdSae6g", + "eIg8jdvaoNNd" + ], + "title": "Search", + "notePosition": 40, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "zEY4DaJG4YT5", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "A9Oc6YKKc65v", + "isInheritable": false, + "position": 20 + }, + { + "type": "label", + "name": "shareAlias", + "value": "search", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Search.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "u3YFHC9tQlpm", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "wArbEsdSae6g", + "u3YFHC9tQlpm" + ], + "title": "Bookmarks", + "notePosition": 50, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "imageLink", + "value": "sag6ww9q4pgW", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "imageLink", + "value": "HEtnpiQrEvjl", + "isInheritable": false, + "position": 20 + }, + { + "type": "label", + "name": "shareAlias", + "value": "bookmarks", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Bookmarks.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "OR8WJ7Iz9K4U", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "wArbEsdSae6g", + "OR8WJ7Iz9K4U" + ], + "title": "Note Hoisting", + "notePosition": 60, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "imageLink", + "value": "AiBOf1LIykMC", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "MMiBEQljMQh2", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "9sRHySam5fXb", + "isInheritable": false, + "position": 30 + }, + { + "type": "label", + "name": "shareAlias", + "value": "note-hoisting", + "isInheritable": false, + "position": 30 + } + ], + "format": "markdown", + "dataFileName": "Note Hoisting.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "9sRHySam5fXb", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "wArbEsdSae6g", + "9sRHySam5fXb" + ], + "title": "Workspace", + "notePosition": 70, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "OR8WJ7Iz9K4U", + "isInheritable": false, + "position": 10 + }, + { + "type": "label", + "name": "shareAlias", + "value": "workspace", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Workspace.md", + "attachments": [ + { + "attachmentId": "V4TIsmtBh8P7", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "Workspace_image.png" + }, + { + "attachmentId": "vZSH2mOKzWBx", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "1_Workspace_image.png" + } + ] + } + ] + }, + { + "isClone": false, + "noteId": "A9Oc6YKKc65v", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "A9Oc6YKKc65v" + ], + "title": "Keyboard Shortcuts", + "notePosition": 40, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "zEY4DaJG4YT5", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "6f9hih2hXXZk", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "MMiBEQljMQh2", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "IakOLONlIfGI", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "iPIMuisry3hd", + "isInheritable": false, + "position": 50 + }, + { + "type": "relation", + "name": "internalLink", + "value": "QEAPj01N5f7w", + "isInheritable": false, + "position": 60 + }, + { + "type": "relation", + "name": "internalLink", + "value": "eIg8jdvaoNNd", + "isInheritable": false, + "position": 70 + }, + { + "type": "label", + "name": "shareAlias", + "value": "keyboard-shortcuts", + "isInheritable": false, + "position": 30 + } + ], + "format": "markdown", + "dataFileName": "Keyboard Shortcuts.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "Wy267RK4M69c", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "Wy267RK4M69c" + ], + "title": "Themes", + "notePosition": 60, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "imageLink", + "value": "zaQnUsJTbvjr", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "imageLink", + "value": "uVF9DAmAmEWC", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "6f9hih2hXXZk", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "zEY4DaJG4YT5", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "VbjZvtUek0Ln", + "isInheritable": false, + "position": 50 + }, + { + "type": "label", + "name": "shareAlias", + "value": "themes", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Themes.md", + "attachments": [ + { + "attachmentId": "rwK3vuBgh7sY", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "Themes_image.png" + } + ], + "dirFileName": "Themes", + "children": [ + { + "isClone": false, + "noteId": "VbjZvtUek0Ln", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "Wy267RK4M69c", + "VbjZvtUek0Ln" + ], + "title": "Theme Gallery", + "notePosition": 10, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "label", + "name": "shareAlias", + "value": "theme-gallery", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "Theme Gallery.md", + "attachments": [ + { + "attachmentId": "wob20Q0zLkMq", + "title": "preview.jpg", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "Theme Gallery_preview.jpg" + } + ] + } + ] + }, + { + "isClone": false, + "noteId": "mHbBMPDPkVV5", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "mHbBMPDPkVV5" + ], + "title": "Import & Export", + "notePosition": 70, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [], + "format": "markdown", + "attachments": [], + "dirFileName": "Import & Export", + "children": [ + { + "isClone": false, + "noteId": "Oau6X9rCuegd", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "mHbBMPDPkVV5", + "Oau6X9rCuegd" + ], + "title": "Markdown", + "notePosition": 10, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "imageLink", + "value": "Y9mwMwSGAaSb", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "imageLink", + "value": "xMQSqWySvWBZ", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "imageLink", + "value": "QUqKzK4LHMVA", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "imageLink", + "value": "e3qPZSsTbUZP", + "isInheritable": false, + "position": 40 + }, + { + "type": "label", + "name": "shareAlias", + "value": "markdown", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Markdown.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "syuSEKf2rUGr", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "mHbBMPDPkVV5", + "syuSEKf2rUGr" + ], + "title": "Evernote", + "notePosition": 20, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "label", + "name": "shareAlias", + "value": "evernote-import", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "Evernote.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "GnhlmrATVqcH", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "mHbBMPDPkVV5", + "GnhlmrATVqcH" + ], + "title": "OneNote", + "notePosition": 30, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "label", + "name": "shareAlias", + "value": "onenote", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "OneNote.md", + "attachments": [] + } + ] + }, + { + "isClone": false, + "noteId": "rC3pL2aptaRE", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "rC3pL2aptaRE" + ], + "title": "Zen mode", + "notePosition": 80, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "label", + "name": "iconClass", + "value": "bx bxs-yin-yang", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "Zen mode.md", + "attachments": [ + { + "attachmentId": "NVSyQubZNFy7", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "Zen mode_image.png" + }, + { + "attachmentId": "ghjyT4LkrZrU", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "1_Zen mode_image.png" + }, + { + "attachmentId": "lqQtSNb8loOS", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "2_Zen mode_image.png" + }, + { + "attachmentId": "cOMcKGJQYs8Y", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "3_Zen mode_image.png" + }, + { + "attachmentId": "LX31yc6Jnksw", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "4_Zen mode_image.png" + }, + { + "attachmentId": "Asn6uBNwt6JI", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "5_Zen mode_image.png" + }, + { + "attachmentId": "HGcQUOEXJ3Sp", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "6_Zen mode_image.png" + }, + { + "attachmentId": "jtzLZ0J0GMub", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "7_Zen mode_image.png" + } + ] + } + ] + }, + { + "isClone": false, + "noteId": "KSZ04uQ2D1St", + "notePath": [ + "pOsGYCXsbNQG", + "KSZ04uQ2D1St" + ], + "title": "Note Types", + "notePosition": 70, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "label", + "name": "iconClass", + "value": "bx bx-edit", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "attachments": [], + "dirFileName": "Note Types", + "children": [ + { + "isClone": false, + "noteId": "iPIMuisry3hd", + "notePath": [ + "pOsGYCXsbNQG", + "KSZ04uQ2D1St", + "iPIMuisry3hd" + ], + "title": "Text", + "notePosition": 10, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "imageLink", + "value": "FtmPLgGmgZVC", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "imageLink", + "value": "oRWfJLUbb7j7", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "zEY4DaJG4YT5", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "CoFPLs3dRlXc", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "S6Xx8QIWTV66", + "isInheritable": false, + "position": 50 + }, + { + "type": "label", + "name": "shareAlias", + "value": "text-notes", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Text.md", + "attachments": [ + { + "attachmentId": "yGknq3nsWpef", + "title": "bx-edit-alt.svg", + "role": "image", + "mime": "image/svg+xml", + "position": 10, + "dataFileName": "Text_bx-edit-alt.svg" + }, + { + "attachmentId": "lHWL7KkEhmM3", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "Text_image.png" + } + ], + "dirFileName": "Text", + "children": [ + { + "isClone": false, + "noteId": "veGu4faJErEM", + "notePath": [ + "pOsGYCXsbNQG", + "KSZ04uQ2D1St", + "iPIMuisry3hd", + "veGu4faJErEM" + ], + "title": "Content language", + "notePosition": 10, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "BMf2nEbYlcUt", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "Content language.md", + "attachments": [ + { + "attachmentId": "TlBagKsAj5ax", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "Content language_image.png" + } + ] + }, + { + "isClone": false, + "noteId": "S6Xx8QIWTV66", + "notePath": [ + "pOsGYCXsbNQG", + "KSZ04uQ2D1St", + "iPIMuisry3hd", + "S6Xx8QIWTV66" + ], + "title": "Lists", + "notePosition": 20, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "label", + "name": "iconClass", + "value": "bx bx-list-ul", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "Lists.md", + "attachments": [ + { + "attachmentId": "eL11eZMPwpmH", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "Lists_image.png" + }, + { + "attachmentId": "EnkTpdeLJ6Ft", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "1_Lists_image.png" + }, + { + "attachmentId": "6jl7tboJfutt", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "2_Lists_image.png" + }, + { + "attachmentId": "5cmICTYfg13g", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "3_Lists_image.png" + }, + { + "attachmentId": "d4XfLoK5srYZ", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "4_Lists_image.png" + }, + { + "attachmentId": "If3k6Tt5cPBt", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "5_Lists_image.png" + } + ] + } + ] + }, + { + "isClone": false, + "noteId": "FVuX89AJuFSw", + "notePath": [ + "pOsGYCXsbNQG", + "KSZ04uQ2D1St", + "FVuX89AJuFSw" + ], + "title": "Code", + "notePosition": 30, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "label", + "name": "iconClass", + "value": "bx bx-code", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "Code.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "m523cpzocqaD", + "notePath": [ + "pOsGYCXsbNQG", + "KSZ04uQ2D1St", + "m523cpzocqaD" + ], + "title": "Saved Search", + "notePosition": 50, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "imageLink", + "value": "rVtYANyVhE9U", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "9sRHySam5fXb", + "isInheritable": false, + "position": 20 + }, + { + "type": "label", + "name": "shareAlias", + "value": "saved-search", + "isInheritable": false, + "position": 10 + }, + { + "type": "label", + "name": "iconClass", + "value": "bx bx-file-find", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Saved Search.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "joqzSrDccPKf", + "notePath": [ + "pOsGYCXsbNQG", + "KSZ04uQ2D1St", + "joqzSrDccPKf" + ], + "title": "Relation Map", + "notePosition": 60, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "label", + "name": "iconClass", + "value": "bx bxs-network-chart", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "Relation Map.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "bdUJEHsAPYQR", + "notePath": [ + "pOsGYCXsbNQG", + "KSZ04uQ2D1St", + "bdUJEHsAPYQR" + ], + "title": "Note Map", + "notePosition": 70, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "label", + "name": "iconClass", + "value": "bx bxs-network-chart", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "Note Map.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "HcABDtFCkbFN", + "notePath": [ + "pOsGYCXsbNQG", + "KSZ04uQ2D1St", + "HcABDtFCkbFN" + ], + "title": "Render Note", + "notePosition": 90, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "label", + "name": "iconClass", + "value": "bx bx-extension", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "Render Note.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "GTwFsgaA0lCt", + "notePath": [ + "pOsGYCXsbNQG", + "KSZ04uQ2D1St", + "GTwFsgaA0lCt" + ], + "title": "Book", + "notePosition": 110, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "BFs8mudNFgCS", + "isInheritable": false, + "position": 10 + }, + { + "type": "label", + "name": "shareAlias", + "value": "book-note", + "isInheritable": false, + "position": 10 + }, + { + "type": "label", + "name": "iconClass", + "value": "bx bx-book", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Book.md", + "attachments": [ + { + "attachmentId": "lpq3QC1C5LWg", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "Book_image.png" + }, + { + "attachmentId": "BmpgL4ol4jJo", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "1_Book_image.png" + } + ], + "dirFileName": "Book", + "children": [ + { + "isClone": false, + "noteId": "xWbu3jpNWapp", + "notePath": [ + "pOsGYCXsbNQG", + "KSZ04uQ2D1St", + "GTwFsgaA0lCt", + "xWbu3jpNWapp" + ], + "title": "Calendar View", + "notePosition": 10, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "label", + "name": "iconClass", + "value": "bx bx-calendar", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "Calendar View.md", + "attachments": [ + { + "attachmentId": "GeEGbbeQ1qy9", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "Calendar View_image.png" + }, + { + "attachmentId": "HfBu0m3WXtn2", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "1_Calendar View_image.png" + }, + { + "attachmentId": "rYaJQN8tjfsG", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "2_Calendar View_image.png" + }, + { + "attachmentId": "ho00OJTNrxVI", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "3_Calendar View_image.png" + }, + { + "attachmentId": "xqgGyeWWqLyg", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "4_Calendar View_image.png" + }, + { + "attachmentId": "gQvwJGB5a4c1", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "5_Calendar View_image.png" + }, + { + "attachmentId": "PYHfGSBQpr0y", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "6_Calendar View_image.png" + }, + { + "attachmentId": "akAHcIEcGnWR", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "7_Calendar View_image.png" + }, + { + "attachmentId": "KF56rdNuOwWd", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "8_Calendar View_image.png" + }, + { + "attachmentId": "oBWr5GL6cUAZ", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "9_Calendar View_image.png" + }, + { + "attachmentId": "COiR1tnE86i1", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "10_Calendar View_image.png" + }, + { + "attachmentId": "AzRAe3io7LxA", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "11_Calendar View_image.png" + }, + { + "attachmentId": "37CfbqKYcOtd", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "12_Calendar View_image.png" + }, + { + "attachmentId": "irfNX8n4159U", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "13_Calendar View_image.png" + }, + { + "attachmentId": "6w8hjC47rS2H", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "14_Calendar View_image.png" + }, + { + "attachmentId": "fOdCNTs2BuI0", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "15_Calendar View_image.png" + }, + { + "attachmentId": "u2c09UpZghff", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "16_Calendar View_image.png" + }, + { + "attachmentId": "UCQb1diHfd02", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "17_Calendar View_image.png" + }, + { + "attachmentId": "oS6yUoQtfhpg", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "18_Calendar View_image.png" + }, + { + "attachmentId": "AU7dnIevWPrz", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "19_Calendar View_image.png" + } + ] + } + ] + }, + { + "isClone": false, + "noteId": "s1aBHPd79XYj", + "notePath": [ + "pOsGYCXsbNQG", + "KSZ04uQ2D1St", + "s1aBHPd79XYj" + ], + "title": "Mermaid Diagrams", + "notePosition": 120, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "relation", + "name": "imageLink", + "value": "r44dpvA1xFu8", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "imageLink", + "value": "opAFABmyb3CU", + "isInheritable": false, + "position": 20 + }, + { + "type": "label", + "name": "shareAlias", + "value": "mermaid-diagrams", + "isInheritable": false, + "position": 10 + }, + { + "type": "label", + "name": "iconClass", + "value": "bx bx-selection", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Mermaid Diagrams.md", + "attachments": [], + "dirFileName": "Mermaid Diagrams", + "children": [ + { + "isClone": false, + "noteId": "opAFABmyb3CU", + "notePath": [ + "pOsGYCXsbNQG", + "KSZ04uQ2D1St", + "s1aBHPd79XYj", + "opAFABmyb3CU" + ], + "title": "ELK on", + "notePosition": 10, + "prefix": null, + "isExpanded": false, + "type": "mermaid", + "mime": "text/plain", + "attributes": [], + "dataFileName": "ELK on.txt", + "attachments": [ + { + "attachmentId": "biyznKlYQ7my", + "title": "mermaid-export.svg", + "role": "image", + "mime": "image/svg+xml", + "position": 10, + "dataFileName": "ELK on_mermaid-export.svg" + } + ] + }, + { + "isClone": false, + "noteId": "r44dpvA1xFu8", + "notePath": [ + "pOsGYCXsbNQG", + "KSZ04uQ2D1St", + "s1aBHPd79XYj", + "r44dpvA1xFu8" + ], + "title": "ELK off", + "notePosition": 20, + "prefix": null, + "isExpanded": false, + "type": "mermaid", + "mime": "text/plain", + "attributes": [], + "dataFileName": "ELK off.txt", + "attachments": [ + { + "attachmentId": "rQI7SXljnpJM", + "title": "mermaid-export.svg", + "role": "image", + "mime": "image/svg+xml", + "position": 10, + "dataFileName": "ELK off_mermaid-export.svg" + } + ] + } + ] + }, + { + "isClone": false, + "noteId": "grjYqerjn243", + "notePath": [ + "pOsGYCXsbNQG", + "KSZ04uQ2D1St", + "grjYqerjn243" + ], + "title": "Canvas", + "notePosition": 140, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "label", + "name": "iconClass", + "value": "bx bx-pen", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "Canvas.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "1vHRoWCEjj0L", + "notePath": [ + "pOsGYCXsbNQG", + "KSZ04uQ2D1St", + "1vHRoWCEjj0L" + ], + "title": "Web View", + "notePosition": 150, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "label", + "name": "iconClass", + "value": "bx bx-globe-alt", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "Web View.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "gBbsAeiuUxI5", + "notePath": [ + "pOsGYCXsbNQG", + "KSZ04uQ2D1St", + "gBbsAeiuUxI5" + ], + "title": "Mind Map", + "notePosition": 160, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "label", + "name": "iconClass", + "value": "bx bx-sitemap", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "Mind Map.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "81SGnPGMk7Xc", + "notePath": [ + "pOsGYCXsbNQG", + "KSZ04uQ2D1St", + "81SGnPGMk7Xc" + ], + "title": "Geo map", + "notePosition": 170, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "label", + "name": "iconClass", + "value": "bx bx-map-alt", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "Geo map.md", + "attachments": [ + { + "attachmentId": "ZvTlu9WMd37z", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "Geo map_image.png" + }, + { + "attachmentId": "1f07O0Z25ZRr", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "1_Geo map_image.png" + }, + { + "attachmentId": "aCSNn9QlgHFi", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "2_Geo map_image.png" + }, + { + "attachmentId": "CcjWLhE3KKfv", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "3_Geo map_image.png" + }, + { + "attachmentId": "oaahbsMRbqd2", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "4_Geo map_image.png" + }, + { + "attachmentId": "3oh61qhNLu7D", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "5_Geo map_image.png" + }, + { + "attachmentId": "agH6yREFgsoU", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "6_Geo map_image.png" + }, + { + "attachmentId": "pGf1p74KKGU4", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "7_Geo map_image.png" + }, + { + "attachmentId": "tDWsliJj9ncm", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "8_Geo map_image.png" + }, + { + "attachmentId": "AHyDUM6R5HeG", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "9_Geo map_image.png" + }, + { + "attachmentId": "gJ4Yz80jxcbn", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "10_Geo map_image.png" + }, + { + "attachmentId": "USbvJ38T4AKA", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "11_Geo map_image.png" + }, + { + "attachmentId": "tfa1TRUatWEh", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "12_Geo map_image.png" + }, + { + "attachmentId": "x6yBLIsY2LSv", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "13_Geo map_image.png" + }, + { + "attachmentId": "aCuXZY7WV4li", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "14_Geo map_image.png" + }, + { + "attachmentId": "DapDey8gMiFc", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "15_Geo map_image.png" + }, + { + "attachmentId": "6wUkw5RWE39e", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "16_Geo map_image.png" + }, + { + "attachmentId": "Mx2xwNIk76ZS", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "17_Geo map_image.png" + }, + { + "attachmentId": "fQy8R1vxKhwN", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "18_Geo map_image.png" + } + ] + } + ] + }, + { + "isClone": false, + "noteId": "pKK96zzmvBGf", + "notePath": [ + "pOsGYCXsbNQG", + "pKK96zzmvBGf" + ], + "title": "Theme development", + "notePosition": 100, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "label", + "name": "iconClass", + "value": "bx bx-palette", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "attachments": [], + "dirFileName": "Theme development", + "children": [ + { + "isClone": false, + "noteId": "7NfNr5pZpVKV", + "notePath": [ + "pOsGYCXsbNQG", + "pKK96zzmvBGf", + "7NfNr5pZpVKV" + ], + "title": "Creating a custom theme", + "notePosition": 10, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "WFGzWeUK6arS", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "Creating a custom theme.md", + "attachments": [ + { + "attachmentId": "14xpFnX5GIkZ", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "Creating a custom theme_im.png" + }, + { + "attachmentId": "QkaP2Ge0lagI", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "1_Creating a custom theme_im.png" + }, + { + "attachmentId": "PY4a4fueTRUZ", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "2_Creating a custom theme_im.png" + }, + { + "attachmentId": "yJVfT7rjp4tI", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "3_Creating a custom theme_im.png" + }, + { + "attachmentId": "EzM9s8bCnJ85", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "4_Creating a custom theme_im.png" + }, + { + "attachmentId": "M3C6oYYIakiS", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "5_Creating a custom theme_im.png" + } + ] + }, + { + "isClone": false, + "noteId": "WFGzWeUK6arS", + "notePath": [ + "pOsGYCXsbNQG", + "pKK96zzmvBGf", + "WFGzWeUK6arS" + ], + "title": "Customize the Next theme", + "notePosition": 20, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [], + "format": "markdown", + "dataFileName": "Customize the Next theme.md", + "attachments": [ + { + "attachmentId": "3fAj97aV2noG", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "Customize the Next theme_i.png" + } + ] + }, + { + "isClone": false, + "noteId": "WN5z4M8ASACJ", + "notePath": [ + "pOsGYCXsbNQG", + "pKK96zzmvBGf", + "WN5z4M8ASACJ" + ], + "title": "Reference", + "notePosition": 30, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "d3fAXQ2diepH", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "Reference.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "AlhDUqhENtH7", + "notePath": [ + "pOsGYCXsbNQG", + "pKK96zzmvBGf", + "AlhDUqhENtH7" + ], + "title": "Custom app-wide CSS", + "notePosition": 40, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [], + "format": "markdown", + "dataFileName": "Custom app-wide CSS.md", + "attachments": [ + { + "attachmentId": "fkMLaf6reA6I", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "Custom app-wide CSS_image.png" + }, + { + "attachmentId": "TIerrMjmeich", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "1_Custom app-wide CSS_image.png" + }, + { + "attachmentId": "YUrNq5vsCwHe", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "2_Custom app-wide CSS_image.png" + } + ] + } + ] + }, + { + "isClone": false, + "noteId": "k2Gc17NbaAwb", + "notePath": [ + "pOsGYCXsbNQG", + "k2Gc17NbaAwb" + ], + "title": "Developer Guides", + "notePosition": 120, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "label", + "name": "iconClass", + "value": "bx bxl-javascript", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "attachments": [], + "dirFileName": "Developer Guides", + "children": [ + { + "isClone": false, + "noteId": "yIhgI5H7A2Sm", + "notePath": [ + "pOsGYCXsbNQG", + "k2Gc17NbaAwb", + "yIhgI5H7A2Sm" + ], + "title": "Frontend Basics", + "notePosition": 10, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "GLks18SNjxmC", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "zEY4DaJG4YT5", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "SynTBQiBsdYJ", + "isInheritable": false, + "position": 30 + }, + { + "type": "label", + "name": "shareAlias", + "value": "frontend-basics", + "isInheritable": false, + "position": 30 + } + ], + "format": "markdown", + "dataFileName": "Frontend Basics.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "SynTBQiBsdYJ", + "notePath": [ + "pOsGYCXsbNQG", + "k2Gc17NbaAwb", + "SynTBQiBsdYJ" + ], + "title": "Widget Basics", + "notePosition": 20, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "zEY4DaJG4YT5", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "BFs8mudNFgCS", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "GLks18SNjxmC", + "isInheritable": false, + "position": 30 + }, + { + "type": "label", + "name": "shareAlias", + "value": "widget-basics", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Widget Basics.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "es8OU2GuguFU", + "notePath": [ + "pOsGYCXsbNQG", + "k2Gc17NbaAwb", + "es8OU2GuguFU" + ], + "title": "Examples", + "notePosition": 30, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [], + "format": "markdown", + "attachments": [], + "dirFileName": "Examples", + "children": [ + { + "isClone": false, + "noteId": "7kZPMD0uFwkH", + "notePath": [ + "pOsGYCXsbNQG", + "k2Gc17NbaAwb", + "es8OU2GuguFU", + "7kZPMD0uFwkH" + ], + "title": "Downloading responses from Google Forms", + "notePosition": 10, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [], + "format": "markdown", + "dataFileName": "Downloading responses from Goo.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "DL92EjAaXT26", + "notePath": [ + "pOsGYCXsbNQG", + "k2Gc17NbaAwb", + "es8OU2GuguFU", + "DL92EjAaXT26" + ], + "title": "Using promoted attributes to configure scripts", + "notePosition": 20, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [], + "format": "markdown", + "dataFileName": "Using promoted attributes to c.md", + "attachments": [ + { + "attachmentId": "7P3jzVEa1mk7", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "Using promoted attributes .png" + } + ] + } + ] + }, + { + "isClone": false, + "noteId": "CXny4YWKsD7z", + "notePath": [ + "pOsGYCXsbNQG", + "k2Gc17NbaAwb", + "CXny4YWKsD7z" + ], + "title": "REST API", + "notePosition": 40, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [], + "format": "markdown", + "attachments": [], + "dirFileName": "REST API", + "children": [ + { + "isClone": false, + "noteId": "cqCjxpN8NhbH", + "notePath": [ + "pOsGYCXsbNQG", + "k2Gc17NbaAwb", + "CXny4YWKsD7z", + "cqCjxpN8NhbH" + ], + "title": "ETAPI", + "notePosition": 10, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [], + "format": "markdown", + "attachments": [], + "dirFileName": "ETAPI", + "children": [ + { + "isClone": false, + "noteId": "9qPsTWBorUhQ", + "notePath": [ + "pOsGYCXsbNQG", + "k2Gc17NbaAwb", + "CXny4YWKsD7z", + "cqCjxpN8NhbH", + "9qPsTWBorUhQ" + ], + "title": "API Reference", + "notePosition": 10, + "prefix": null, + "isExpanded": false, + "type": "webView", + "mime": "", + "attributes": [ + { + "type": "label", + "name": "webViewSrc", + "value": "/etapi/docs", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "API Reference.dat", + "attachments": [] + } + ] + }, + { + "isClone": false, + "noteId": "0vTSyvhPTAOz", + "notePath": [ + "pOsGYCXsbNQG", + "k2Gc17NbaAwb", + "CXny4YWKsD7z", + "0vTSyvhPTAOz" + ], + "title": "Internal API", + "notePosition": 20, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [], + "format": "markdown", + "attachments": [], + "dirFileName": "Internal API", + "children": [ + { + "isClone": false, + "noteId": "z8O2VG4ZZJD7", + "notePath": [ + "pOsGYCXsbNQG", + "k2Gc17NbaAwb", + "CXny4YWKsD7z", + "0vTSyvhPTAOz", + "z8O2VG4ZZJD7" + ], + "title": "API Reference", + "notePosition": 10, + "prefix": null, + "isExpanded": false, + "type": "webView", + "mime": "", + "attributes": [ + { + "type": "label", + "name": "webViewSrc", + "value": "/api/docs", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "API Reference.dat", + "attachments": [] + } + ] + } + ] + } + ] + }, + { + "isClone": false, + "noteId": "Otzi9La2YAUX", + "notePath": [ + "pOsGYCXsbNQG", + "Otzi9La2YAUX" + ], + "title": "Installation & Setup", + "notePosition": 160, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "label", + "name": "iconClass", + "value": "bx bx-cog", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "attachments": [], + "dirFileName": "Installation & Setup", + "children": [ + { + "isClone": false, + "noteId": "poXkQfguuA0U", + "notePath": [ + "pOsGYCXsbNQG", + "Otzi9La2YAUX", + "poXkQfguuA0U" + ], + "title": "Desktop Installation", + "notePosition": 10, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "tAassRL4RSQL", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "l2VkvOwUNfZj", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "cbkrhQjrkKrh", + "isInheritable": false, + "position": 30 + }, + { + "type": "label", + "name": "shareAlias", + "value": "desktop-installation", + "isInheritable": false, + "position": 30 + } + ], + "format": "markdown", + "dataFileName": "Desktop Installation.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "WOcw2SLH6tbX", + "notePath": [ + "pOsGYCXsbNQG", + "Otzi9La2YAUX", + "WOcw2SLH6tbX" + ], + "title": "Server Installation", + "notePosition": 20, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "cbkrhQjrkKrh", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "rWX5eY045zbE", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "3tW6mORuTHnB", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "J1Bb6lVlwU5T", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "DCmT6e7clMoP", + "isInheritable": false, + "position": 50 + }, + { + "type": "relation", + "name": "internalLink", + "value": "moVgBcoxE3EK", + "isInheritable": false, + "position": 60 + }, + { + "type": "relation", + "name": "internalLink", + "value": "RDslemsQ6gCp", + "isInheritable": false, + "position": 70 + }, + { + "type": "relation", + "name": "internalLink", + "value": "l2VkvOwUNfZj", + "isInheritable": false, + "position": 80 + }, + { + "type": "relation", + "name": "internalLink", + "value": "tAassRL4RSQL", + "isInheritable": false, + "position": 90 + }, + { + "type": "relation", + "name": "internalLink", + "value": "Gzjqa934BdH4", + "isInheritable": false, + "position": 100 + }, + { + "type": "relation", + "name": "internalLink", + "value": "wX4HbRucYSDD", + "isInheritable": false, + "position": 110 + }, + { + "type": "relation", + "name": "internalLink", + "value": "fDLvzOx29Pfg", + "isInheritable": false, + "position": 120 + }, + { + "type": "label", + "name": "shareAlias", + "value": "server-installation", + "isInheritable": false, + "position": 30 + } + ], + "format": "markdown", + "dataFileName": "Server Installation.md", + "attachments": [], + "dirFileName": "Server Installation", + "children": [ + { + "isClone": false, + "noteId": "Dgg7bR3b6K9j", + "notePath": [ + "pOsGYCXsbNQG", + "Otzi9La2YAUX", + "WOcw2SLH6tbX", + "Dgg7bR3b6K9j" + ], + "title": "1. Installing the server", + "notePosition": 10, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [], + "format": "markdown", + "attachments": [], + "dirFileName": "1. Installing the server", + "children": [ + { + "isClone": false, + "noteId": "3tW6mORuTHnB", + "notePath": [ + "pOsGYCXsbNQG", + "Otzi9La2YAUX", + "WOcw2SLH6tbX", + "Dgg7bR3b6K9j", + "3tW6mORuTHnB" + ], + "title": "Packaged server installation", + "notePosition": 10, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "WOcw2SLH6tbX", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "l2VkvOwUNfZj", + "isInheritable": false, + "position": 20 + }, + { + "type": "label", + "name": "shareAlias", + "value": "packaged-server-installation", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Packaged server installation.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "rWX5eY045zbE", + "notePath": [ + "pOsGYCXsbNQG", + "Otzi9La2YAUX", + "WOcw2SLH6tbX", + "Dgg7bR3b6K9j", + "rWX5eY045zbE" + ], + "title": "Docker Server Installation", + "notePosition": 20, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "ud6MShXL4WpO", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "fDLvzOx29Pfg", + "isInheritable": false, + "position": 20 + }, + { + "type": "label", + "name": "shareAlias", + "value": "docker-server-installation", + "isInheritable": false, + "position": 30 + } + ], + "format": "markdown", + "dataFileName": "Docker Server Installation.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "moVgBcoxE3EK", + "notePath": [ + "pOsGYCXsbNQG", + "Otzi9La2YAUX", + "WOcw2SLH6tbX", + "Dgg7bR3b6K9j", + "moVgBcoxE3EK" + ], + "title": "NixOS server installation", + "notePosition": 30, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "label", + "name": "shareAlias", + "value": "nixos-server-installation", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "NixOS server installation.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "J1Bb6lVlwU5T", + "notePath": [ + "pOsGYCXsbNQG", + "Otzi9La2YAUX", + "WOcw2SLH6tbX", + "Dgg7bR3b6K9j", + "J1Bb6lVlwU5T" + ], + "title": "Manual server installation", + "notePosition": 40, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "l2VkvOwUNfZj", + "isInheritable": false, + "position": 10 + }, + { + "type": "label", + "name": "shareAlias", + "value": "manual-server-installation", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Manual server installation.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "DCmT6e7clMoP", + "notePath": [ + "pOsGYCXsbNQG", + "Otzi9La2YAUX", + "WOcw2SLH6tbX", + "Dgg7bR3b6K9j", + "DCmT6e7clMoP" + ], + "title": "Kubernetes server installation", + "notePosition": 50, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "label", + "name": "shareAlias", + "value": "kubernetes-server-installation", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "Kubernetes server installation.md", + "attachments": [] + } + ] + }, + { + "isClone": false, + "noteId": "vcjrb3VVYPZI", + "notePath": [ + "pOsGYCXsbNQG", + "Otzi9La2YAUX", + "WOcw2SLH6tbX", + "vcjrb3VVYPZI" + ], + "title": "2. Reverse proxy", + "notePosition": 20, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [], + "format": "markdown", + "attachments": [], + "dirFileName": "2. Reverse proxy", + "children": [ + { + "isClone": false, + "noteId": "ud6MShXL4WpO", + "notePath": [ + "pOsGYCXsbNQG", + "Otzi9La2YAUX", + "WOcw2SLH6tbX", + "vcjrb3VVYPZI", + "ud6MShXL4WpO" + ], + "title": "Nginx", + "notePosition": 10, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "label", + "name": "shareAlias", + "value": "nginx-proxy-setup", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "Nginx.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "fDLvzOx29Pfg", + "notePath": [ + "pOsGYCXsbNQG", + "Otzi9La2YAUX", + "WOcw2SLH6tbX", + "vcjrb3VVYPZI", + "fDLvzOx29Pfg" + ], + "title": "Apache", + "notePosition": 20, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "label", + "name": "shareAlias", + "value": "apache-proxy-setup", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "Apache.md", + "attachments": [] + } + ] + }, + { + "isClone": false, + "noteId": "l2VkvOwUNfZj", + "notePath": [ + "pOsGYCXsbNQG", + "Otzi9La2YAUX", + "WOcw2SLH6tbX", + "l2VkvOwUNfZj" + ], + "title": "TLS Configuration", + "notePosition": 100, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "WOcw2SLH6tbX", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "tAassRL4RSQL", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "Gzjqa934BdH4", + "isInheritable": false, + "position": 30 + }, + { + "type": "label", + "name": "shareAlias", + "value": "tls-configuration", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "TLS Configuration.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "7DAiwaf8Z7Rz", + "notePath": [ + "pOsGYCXsbNQG", + "Otzi9La2YAUX", + "WOcw2SLH6tbX", + "7DAiwaf8Z7Rz" + ], + "title": "Multi-Factor Authentication", + "notePosition": 110, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "label", + "name": "shareAlias", + "value": "multi-factor-authentication", + "isInheritable": false, + "position": 10 + }, + { + "type": "label", + "name": "shareHiddenFromTree", + "value": "", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Multi-Factor Authentication.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "KaM3TfD7mP78", + "notePath": [ + "pOsGYCXsbNQG", + "Otzi9La2YAUX", + "WOcw2SLH6tbX", + "KaM3TfD7mP78" + ], + "title": "Reverse proxy setup", + "notePosition": 120, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [], + "format": "markdown", + "dataFileName": "Reverse proxy setup.md", + "attachments": [] + } + ] + }, + { + "isClone": false, + "noteId": "cbkrhQjrkKrh", + "notePath": [ + "pOsGYCXsbNQG", + "Otzi9La2YAUX", + "cbkrhQjrkKrh" + ], + "title": "Synchronization", + "notePosition": 30, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "imageLink", + "value": "676Ekdv73T7I", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "imageLink", + "value": "SDHWNDsB68aJ", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "imageLink", + "value": "qGTyyKX4TceE", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "l2VkvOwUNfZj", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "poXkQfguuA0U", + "isInheritable": false, + "position": 50 + }, + { + "type": "relation", + "name": "internalLink", + "value": "vZWERwf8U3nx", + "isInheritable": false, + "position": 60 + }, + { + "type": "label", + "name": "shareAlias", + "value": "synchronization", + "isInheritable": false, + "position": 30 + } + ], + "format": "markdown", + "dataFileName": "Synchronization.md", + "attachments": [ + { + "attachmentId": "s3fKDqHslToK", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "Synchronization_image.png" + } + ] + }, + { + "isClone": false, + "noteId": "RDslemsQ6gCp", + "notePath": [ + "pOsGYCXsbNQG", + "Otzi9La2YAUX", + "RDslemsQ6gCp" + ], + "title": "Mobile Frontend", + "notePosition": 40, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "imageLink", + "value": "TFAiJIXJFfqv", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "imageLink", + "value": "fi37V32TNyzm", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "bwg0e8ewQMak", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "CdNpE2pqjmI6", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "WOcw2SLH6tbX", + "isInheritable": false, + "position": 50 + }, + { + "type": "label", + "name": "shareAlias", + "value": "mobile-frontend", + "isInheritable": false, + "position": 30 + } + ], + "format": "markdown", + "dataFileName": "Mobile Frontend.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "MtPxeAWVAzMg", + "notePath": [ + "pOsGYCXsbNQG", + "Otzi9La2YAUX", + "MtPxeAWVAzMg" + ], + "title": "Web Clipper", + "notePosition": 50, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "l0tKav7yLHGF", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "zEY4DaJG4YT5", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "WOcw2SLH6tbX", + "isInheritable": false, + "position": 30 + }, + { + "type": "label", + "name": "shareAlias", + "value": "web-clipper", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Web Clipper.md", + "attachments": [ + { + "attachmentId": "fhKf5Otv0M5Y", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "Web Clipper_image.png" + } + ] + }, + { + "isClone": false, + "noteId": "n1lujUxCwipy", + "notePath": [ + "pOsGYCXsbNQG", + "Otzi9La2YAUX", + "n1lujUxCwipy" + ], + "title": "Upgrading TriliumNext", + "notePosition": 60, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "rWX5eY045zbE", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "wX4HbRucYSDD", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "ODY7qQn5m2FT", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "cbkrhQjrkKrh", + "isInheritable": false, + "position": 40 + }, + { + "type": "label", + "name": "shareAlias", + "value": "upgrading-trilium", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Upgrading TriliumNext.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "ODY7qQn5m2FT", + "notePath": [ + "pOsGYCXsbNQG", + "Otzi9La2YAUX", + "ODY7qQn5m2FT" + ], + "title": "Backup", + "notePosition": 70, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "Gzjqa934BdH4", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "tAassRL4RSQL", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "cbkrhQjrkKrh", + "isInheritable": false, + "position": 30 + }, + { + "type": "label", + "name": "shareAlias", + "value": "backup", + "isInheritable": false, + "position": 20 + } + ], + "format": "markdown", + "dataFileName": "Backup.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "tAassRL4RSQL", + "notePath": [ + "pOsGYCXsbNQG", + "Otzi9La2YAUX", + "tAassRL4RSQL" + ], + "title": "Data directory", + "notePosition": 80, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "wX4HbRucYSDD", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "ODY7qQn5m2FT", + "isInheritable": false, + "position": 20 + }, + { + "type": "label", + "name": "shareAlias", + "value": "data-directory", + "isInheritable": false, + "position": 30 + }, + { + "type": "label", + "name": "iconClass", + "value": "bx bx-folder-open", + "isInheritable": false, + "position": 40 + } + ], + "format": "markdown", + "dataFileName": "Data directory.md", + "attachments": [ + { + "attachmentId": "NONZTci1YkNe", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "Data directory_image.png" + } + ] + } + ] + }, + { + "isClone": false, + "noteId": "i6dbnitykE5D", + "notePath": [ + "pOsGYCXsbNQG", + "i6dbnitykE5D" + ], + "title": "FAQ", + "notePosition": 170, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "CdNpE2pqjmI6", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "wX4HbRucYSDD", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "IakOLONlIfGI", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "zEY4DaJG4YT5", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "BCkXAVs63Ttv", + "isInheritable": false, + "position": 50 + }, + { + "type": "relation", + "name": "internalLink", + "value": "tAassRL4RSQL", + "isInheritable": false, + "position": 60 + }, + { + "type": "relation", + "name": "internalLink", + "value": "cbkrhQjrkKrh", + "isInheritable": false, + "position": 70 + }, + { + "type": "label", + "name": "shareAlias", + "value": "faq", + "isInheritable": false, + "position": 30 + }, + { + "type": "label", + "name": "iconClass", + "value": "bx bx-question-mark", + "isInheritable": false, + "position": 40 + } + ], + "format": "markdown", + "dataFileName": "FAQ.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "BgmBlOIl72jZ", + "notePath": [ + "pOsGYCXsbNQG", + "BgmBlOIl72jZ" + ], + "title": "Troubleshooting", + "notePosition": 180, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "MgibgPcfeuGz", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "x59R8J8KV5Bp", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "ODY7qQn5m2FT", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "wX4HbRucYSDD", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "tAassRL4RSQL", + "isInheritable": false, + "position": 50 + }, + { + "type": "relation", + "name": "internalLink", + "value": "qzNzp9LYQyPT", + "isInheritable": false, + "position": 60 + }, + { + "type": "label", + "name": "shareAlias", + "value": "troubleshooting", + "isInheritable": false, + "position": 20 + }, + { + "type": "label", + "name": "iconClass", + "value": "bx bx-bug", + "isInheritable": false, + "position": 30 + } + ], + "format": "markdown", + "dataFileName": "Troubleshooting.md", + "attachments": [], + "dirFileName": "Troubleshooting", + "children": [ + { + "isClone": false, + "noteId": "wy8So3yZZlH9", + "notePath": [ + "pOsGYCXsbNQG", + "BgmBlOIl72jZ", + "wy8So3yZZlH9" + ], + "title": "Reporting issues", + "notePosition": 10, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [], + "format": "markdown", + "dataFileName": "Reporting issues.md", + "attachments": [] + }, + { + "isClone": false, + "noteId": "x59R8J8KV5Bp", + "notePath": [ + "pOsGYCXsbNQG", + "BgmBlOIl72jZ", + "x59R8J8KV5Bp" + ], + "title": "Anonymized Database", + "notePosition": 20, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "wX4HbRucYSDD", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "tAassRL4RSQL", + "isInheritable": false, + "position": 20 + }, + { + "type": "label", + "name": "shareAlias", + "value": "anonymized-database", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "Anonymized Database.md", + "attachments": [ + { + "attachmentId": "xh9biKiOnMJv", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "Anonymized Database_image.png" + } + ] + }, + { + "isClone": false, + "noteId": "qzNzp9LYQyPT", + "notePath": [ + "pOsGYCXsbNQG", + "BgmBlOIl72jZ", + "qzNzp9LYQyPT" + ], + "title": "Error logs", + "notePosition": 30, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/markdown", + "attributes": [ + { + "type": "relation", + "name": "imageLink", + "value": "zIQ1XGaUbB7i", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "imageLink", + "value": "v8H3fXMFPki0", + "isInheritable": false, + "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "tAassRL4RSQL", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "x59R8J8KV5Bp", + "isInheritable": false, + "position": 40 + }, + { + "type": "label", + "name": "shareAlias", + "value": "error-logs", + "isInheritable": false, + "position": 30 + } + ], + "format": "markdown", + "dataFileName": "Error logs.md", + "attachments": [ + { + "attachmentId": "8b6d0LUU1aMl", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "Error logs_image.png" + }, + { + "attachmentId": "w2hNrUKhJXot", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "1_Error logs_image.png" + } + ] + }, + { + "isClone": false, + "noteId": "AFHqgh9XkIMO", + "notePath": [ + "pOsGYCXsbNQG", + "BgmBlOIl72jZ", + "AFHqgh9XkIMO" + ], + "title": "\"TriliumNext Notes\" Not Opened", + "notePosition": 40, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [], + "format": "markdown", + "dataFileName": "TriliumNext Notes Not Opened.md", + "attachments": [ + { + "attachmentId": "sC4ORfLsTFhF", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "TriliumNext Notes Not Open.png" + }, + { + "attachmentId": "sSEXTY7mQ3Cx", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "1_TriliumNext Notes Not Open.png" + }, + { + "attachmentId": "QuuFBSQMTz05", + "title": "image.png", + "role": "image", + "mime": "image/png", + "position": 10, + "dataFileName": "2_TriliumNext Notes Not Open.png" + } + ] + }, + { + "isClone": false, + "noteId": "vdlYGAcpXAgc", + "notePath": [ + "pOsGYCXsbNQG", + "BgmBlOIl72jZ", + "vdlYGAcpXAgc" + ], + "title": "Synchronization fails with 504 Gateway Timeout", + "notePosition": 50, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "ud6MShXL4WpO", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "Synchronization fails with 504.md", + "attachments": [] + } + ] + }, + { + "isClone": false, + "noteId": "Wxt3vVlxlYLi", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi" + ], + "title": "Attachments", + "notePosition": 190, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "label", + "name": "shareHiddenFromTree", + "value": "", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "attachments": [], + "dirFileName": "Attachments", + "children": [ + { + "isClone": false, + "noteId": "HEtnpiQrEvjl", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "HEtnpiQrEvjl" + ], + "title": "bookmark-folder.png", + "notePosition": 160, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "bookmark-folder.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "bookmark-folder.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "sag6ww9q4pgW", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "sag6ww9q4pgW" + ], + "title": "bookmarks.gif", + "notePosition": 170, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/gif", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "bookmarks.gif", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "bookmarks.gif", + "attachments": [] + }, + { + "isClone": false, + "noteId": "W9yOvDvpsEtR", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "W9yOvDvpsEtR" + ], + "title": "bookmarks.png", + "notePosition": 180, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "bookmarks.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "bookmarks.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "DVJl4l3T8EG2", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "DVJl4l3T8EG2" + ], + "title": "button-script.png", + "notePosition": 190, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "button-script.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "button-script.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "oZfQufNxgrZ9", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "oZfQufNxgrZ9" + ], + "title": "canvas-note-image.png", + "notePosition": 200, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "canvas-note-image.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "canvas-note-image.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "BJpEsPXDjVLh", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "BJpEsPXDjVLh" + ], + "title": "chrome-trilium-web-clipper.png", + "notePosition": 210, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "chrome-trilium-web-clipper.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "chrome-trilium-web-clipper.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "8jgXl1RUGL4H", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "8jgXl1RUGL4H" + ], + "title": "code-note.png", + "notePosition": 230, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "code-note.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "code-note.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "BqvIJUHkWrvH", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "BqvIJUHkWrvH" + ], + "title": "create-clone.gif", + "notePosition": 240, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/gif", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "create-clone.gif", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "create-clone.gif", + "attachments": [] + }, + { + "isClone": false, + "noteId": "N6O1qfBGcbFH", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "N6O1qfBGcbFH" + ], + "title": "create-external-link.gif", + "notePosition": 250, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/gif", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "create-external-link.gif", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "create-external-link.gif", + "attachments": [] + }, + { + "isClone": false, + "noteId": "dPcRcDZwyGAO", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "dPcRcDZwyGAO" + ], + "title": "create-link-to-note.gif", + "notePosition": 260, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/gif", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "create-link-to-note.gif", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "create-link-to-note.gif", + "attachments": [] + }, + { + "isClone": false, + "noteId": "3sCPPL0LEC1S", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "3sCPPL0LEC1S" + ], + "title": "Custom-widget image.png", + "notePosition": 270, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "Custom-widget image.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "Custom-widget image.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "ruEpqTPbi0CT", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "ruEpqTPbi0CT" + ], + "title": "custom-widget-image.png", + "notePosition": 280, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "custom-widget-image.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "custom-widget-image.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "aa84l6zJyAVH", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "aa84l6zJyAVH" + ], + "title": "cut-to-subnote.gif", + "notePosition": 290, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/gif", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "cut-to-subnote.gif", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "cut-to-subnote.gif", + "attachments": [] + }, + { + "isClone": false, + "noteId": "zaQnUsJTbvjr", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "zaQnUsJTbvjr" + ], + "title": "dark-theme.png", + "notePosition": 300, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "dark-theme.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "dark-theme.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "sLZ7Bcq9p8E9", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "sLZ7Bcq9p8E9" + ], + "title": "drag-and-drop.gif", + "notePosition": 330, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/gif", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "drag-and-drop.gif", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "drag-and-drop.gif", + "attachments": [] + }, + { + "isClone": false, + "noteId": "v8H3fXMFPki0", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "v8H3fXMFPki0" + ], + "title": "error-logs-export-subtree.png", + "notePosition": 350, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "error-logs-export-subtree.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "error-logs-export-subtree.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "zIQ1XGaUbB7i", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "zIQ1XGaUbB7i" + ], + "title": "error-logs-firefox-context-men.png", + "notePosition": 360, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "error-logs-firefox-context-men.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "error-logs-firefox-context.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "1fkGrskxHx5u", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "1fkGrskxHx5u" + ], + "title": "hide-archived.png", + "notePosition": 370, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "hide-archived.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "hide-archived.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "JXFeNgU8Xnp1", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "JXFeNgU8Xnp1" + ], + "title": "home-button.svg", + "notePosition": 380, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/svg+xml", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "home-button.svg", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "home-button.svg", + "attachments": [] + }, + { + "isClone": false, + "noteId": "snfWRIih71MM", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "snfWRIih71MM" + ], + "title": "jump-to.gif", + "notePosition": 390, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/gif", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "jump-to.gif", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "jump-to.gif", + "attachments": [] + }, + { + "isClone": false, + "noteId": "e3qPZSsTbUZP", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "e3qPZSsTbUZP" + ], + "title": "markdown-export-note.gif", + "notePosition": 410, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/gif", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "markdown-export-note.gif", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "markdown-export-note.gif", + "attachments": [] + }, + { + "isClone": false, + "noteId": "QUqKzK4LHMVA", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "QUqKzK4LHMVA" + ], + "title": "markdown-export-subtree.gif", + "notePosition": 420, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/gif", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "markdown-export-subtree.gif", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "markdown-export-subtree.gif", + "attachments": [] + }, + { + "isClone": false, + "noteId": "xMQSqWySvWBZ", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "xMQSqWySvWBZ" + ], + "title": "markdown-file-import.gif", + "notePosition": 430, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/gif", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "markdown-file-import.gif", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "markdown-file-import.gif", + "attachments": [] + }, + { + "isClone": false, + "noteId": "Y9mwMwSGAaSb", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "Y9mwMwSGAaSb" + ], + "title": "markdown-inline-import.gif", + "notePosition": 440, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/gif", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "markdown-inline-import.gif", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "markdown-inline-import.gif", + "attachments": [] + }, + { + "isClone": false, + "noteId": "1YUO9Ij4XIwE", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "1YUO9Ij4XIwE" + ], + "title": "math.gif", + "notePosition": 450, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/gif", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "math.gif", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "math.gif", + "attachments": [] + }, + { + "isClone": false, + "noteId": "fJ7nbsprnKr7", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "fJ7nbsprnKr7" + ], + "title": "mermaid.png", + "notePosition": 460, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "mermaid.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "mermaid.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "TFAiJIXJFfqv", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "TFAiJIXJFfqv" + ], + "title": "mobile-smartphone.png", + "notePosition": 470, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "mobile-smartphone.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "mobile-smartphone.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "fi37V32TNyzm", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "fi37V32TNyzm" + ], + "title": "mobile-tablet.png", + "notePosition": 480, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "mobile-tablet.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "mobile-tablet.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "qL7381ZG0lMK", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "qL7381ZG0lMK" + ], + "title": "move-note-with-keyboard.gif", + "notePosition": 490, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/gif", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "move-note-with-keyboard.gif", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "move-note-with-keyboard.gif", + "attachments": [] + }, + { + "isClone": false, + "noteId": "AiBOf1LIykMC", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "AiBOf1LIykMC" + ], + "title": "note-hoisting.gif", + "notePosition": 500, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/gif", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "note-hoisting.gif", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "note-hoisting.gif", + "attachments": [] + }, + { + "isClone": false, + "noteId": "iuAfnapzpRCB", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "iuAfnapzpRCB" + ], + "title": "note-icon-change.png", + "notePosition": 510, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "note-icon-change.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "note-icon-change.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "R1L2vUshJD82", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "R1L2vUshJD82" + ], + "title": "note-icon-gallery.png", + "notePosition": 520, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "note-icon-gallery.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "note-icon-gallery.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "mWxLjZrNAoV7", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "mWxLjZrNAoV7" + ], + "title": "note-map.png", + "notePosition": 530, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "note-map.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "note-map.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "MA2uvkVloWXl", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "MA2uvkVloWXl" + ], + "title": "note-revisions.png", + "notePosition": 540, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "note-revisions.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "note-revisions.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "umjOUcnZi4z2", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "umjOUcnZi4z2" + ], + "title": "promoted-attributes-queen.png", + "notePosition": 550, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "promoted-attributes-queen.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "promoted-attributes-queen.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "rxH2Dm1jn6YT", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "rxH2Dm1jn6YT" + ], + "title": "promoted-attributes.png", + "notePosition": 560, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "promoted-attributes.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "promoted-attributes.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "zaUtPWl8NcCt", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "zaUtPWl8NcCt" + ], + "title": "protecting-note.gif", + "notePosition": 570, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/gif", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "protecting-note.gif", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "protecting-note.gif", + "attachments": [] + }, + { + "isClone": false, + "noteId": "wpFu8PhUu7e7", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "wpFu8PhUu7e7" + ], + "title": "recent-notes.gif", + "notePosition": 580, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/gif", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "recent-notes.gif", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "recent-notes.gif", + "attachments": [] + }, + { + "isClone": false, + "noteId": "EH6qNioOHeyT", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "EH6qNioOHeyT" + ], + "title": "relation-map-dev-process.png", + "notePosition": 590, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "relation-map-dev-process.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "relation-map-dev-process.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "N98UhifxrVpZ", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "N98UhifxrVpZ" + ], + "title": "relation-map-family-demo.gif", + "notePosition": 600, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/gif", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "relation-map-family-demo.gif", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "relation-map-family-demo.gif", + "attachments": [] + }, + { + "isClone": false, + "noteId": "xeZPrfi77XPu", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "xeZPrfi77XPu" + ], + "title": "relation-map-family.png", + "notePosition": 610, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "relation-map-family.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "relation-map-family.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "rVtYANyVhE9U", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "rVtYANyVhE9U" + ], + "title": "saved-search-image.gif", + "notePosition": 620, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/gif", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "saved-search-image.gif", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "saved-search-image.gif", + "attachments": [] + }, + { + "isClone": false, + "noteId": "VvQ2QZOyZhZZ", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "VvQ2QZOyZhZZ" + ], + "title": "saved-search.gif", + "notePosition": 630, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/gif", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "saved-search.gif", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "saved-search.gif", + "attachments": [] + }, + { + "isClone": false, + "noteId": "V01a3OdC9O06", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "V01a3OdC9O06" + ], + "title": "screenshot.png", + "notePosition": 640, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "screenshot.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "screenshot.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "lCtZz2Z59wPT", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "lCtZz2Z59wPT" + ], + "title": "share-multiple-notes-web.png", + "notePosition": 650, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "share-multiple-notes-web.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "share-multiple-notes-web.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "Ky3qOJJMZ731", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "Ky3qOJJMZ731" + ], + "title": "share-single-note-web.png", + "notePosition": 660, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "share-single-note-web.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "share-single-note-web.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "5GcxcE9fP9xX", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "5GcxcE9fP9xX" + ], + "title": "share-single-note.png", + "notePosition": 670, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "share-single-note.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "share-single-note.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "jEQNvpyaXIWE", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "jEQNvpyaXIWE" + ], + "title": "shared-list.png", + "notePosition": 680, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "shared-list.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "shared-list.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "OFHiQYnGo2rr", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "OFHiQYnGo2rr" + ], + "title": "split.png", + "notePosition": 690, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "split.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "split.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "uVF9DAmAmEWC", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "uVF9DAmAmEWC" + ], + "title": "steel-blue.png", + "notePosition": 710, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "steel-blue.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "steel-blue.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "676Ekdv73T7I", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "676Ekdv73T7I" + ], + "title": "sync-config.png", + "notePosition": 720, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "sync-config.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "sync-config.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "qGTyyKX4TceE", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "qGTyyKX4TceE" + ], + "title": "sync-in-progress.png", + "notePosition": 730, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "sync-in-progress.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "sync-in-progress.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "SDHWNDsB68aJ", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "SDHWNDsB68aJ" + ], + "title": "sync-init.png", + "notePosition": 740, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "sync-init.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "sync-init.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "92KeXdKh3Ca1", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "92KeXdKh3Ca1" + ], + "title": "task-manager.png", + "notePosition": 750, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "task-manager.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "task-manager.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "uuGrYX41lWN0", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "uuGrYX41lWN0" + ], + "title": "template-create-instance-note.png", + "notePosition": 760, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "template-create-instance-note.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "template-create-instance-n.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "Y8kzZ5MSZLCC", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "Y8kzZ5MSZLCC" + ], + "title": "template.png", + "notePosition": 770, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "template.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "template.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "oRWfJLUbb7j7", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "oRWfJLUbb7j7" + ], + "title": "text-notes-formatting-block.png", + "notePosition": 780, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "text-notes-formatting-block.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "text-notes-formatting-bloc.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "FtmPLgGmgZVC", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "FtmPLgGmgZVC" + ], + "title": "text-notes-formatting-inline.png", + "notePosition": 790, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "text-notes-formatting-inline.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "text-notes-formatting-inli.png", + "attachments": [] + }, + { + "isClone": false, + "noteId": "skY4DIE2Iks5", + "notePath": [ + "pOsGYCXsbNQG", + "Wxt3vVlxlYLi", + "skY4DIE2Iks5" + ], + "title": "text-notes-image.png", + "notePosition": 800, + "prefix": null, + "isExpanded": false, + "type": "image", + "mime": "image/png", + "attributes": [ + { + "type": "label", + "name": "originalFileName", + "value": "text-notes-image.png", + "isInheritable": false, + "position": 10 + } + ], + "dataFileName": "text-notes-image.png", + "attachments": [] + } + ] + } + ] + } + ] } \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide.md b/src/public/app/doc_notes/en/User Guide/User Guide.md new file mode 100644 index 000000000..a33fe6983 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide.md @@ -0,0 +1,2 @@ +# User Guide +The sub-children of this note are automatically synced. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/1_Attributes_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/1_Attributes_image.png new file mode 100644 index 000000000..ecb5f2d6d Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/1_Attributes_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/1_Code Notes_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/1_Code Notes_image.png new file mode 100644 index 000000000..21216c101 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/1_Code Notes_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/1_Note Map_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/1_Note Map_image.png new file mode 100644 index 000000000..2d41fd6c6 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/1_Note Map_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases.md b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases.md new file mode 100644 index 000000000..29b50da68 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases.md @@ -0,0 +1,9 @@ +# Advanced Showcases +Trilium offers advanced functionality through [Scripts](Code%20Notes/Scripts.md) and [Promoted Attributes](Attributes/Promoted%20Attributes.md). To illustrate these features, we've prepared several showcases available in the [demo notes](Database.md): + +* [Relation Map](Relation%20Map.md) +* [Day Notes](Advanced%20Showcases/Day%20Notes.md) +* [Weight Tracker](Advanced%20Showcases/Weight%20Tracker.md) +* [Task Manager](Advanced%20Showcases/Task%20Manager.md) + +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. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/1_Day Notes_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/1_Day Notes_image.png new file mode 100644 index 000000000..7623131d6 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/1_Day Notes_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Day Notes.md b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Day Notes.md new file mode 100644 index 000000000..f1afeea7c --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Day Notes.md @@ -0,0 +1,59 @@ +# Day Notes +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. + +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. + +Select an existing day note, and the menubar contains a calendar widget. Select any day to create a note for that day.  + +![](1_Day Notes_image.png) + +This pattern works well also because of [Cloning Notes](../../Basic%20Concepts/Note/Cloning%20Notes.md) 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. + +## Demo + +![](Day Notes_image.png) + +You can see the structure of day notes appearing under "Journal" note - there's a note for the whole year 2017, under it, you have "12 - December" which then contains "18 - Monday". This is our "day note" which contains some text in its content and also has some child notes (some of them are from [Task manager](Task%20Manager.md)). + +You can also notice how this day note has [promoted attribute](../Attributes/Promoted%20Attributes.md) "weight" where you can track your daily weight. This data is then used in [Weight tracker](Weight%20Tracker.md). + +## Templates + +Trilium provides [template](../Attributes/Template.md) functionality, and it could be used together with day notes. + +You can define one of the following relations on the root of the journal (identified by `#calendarRoot` label): + +* yearTemplate +* monthTemplate +* dateTemplate + +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 `~template` relation to the newly created role. Using this, you can e.g. create your daily template with e.g. checkboxes for daily routine etc. + +## Date pattern + +It's possible to customize the title of generated date notes by defining a `#datePattern` label on a root calendar note (identified by `#calendarRoot` label). Following are possible values: + +* `{dayInMonthPadded} - {weekDay}` day notes are named e.g. "24 - Monday" +* `{dayInMonthPadded}: {weekDay3}` day notes are named e.g. "24: Mon" +* `{dayInMonthPadded}: {weekDay2}` day notes are named e.g. "24: Mo" +* `{isoDate} - {weekDay}` day notes are named e.g. "2020-12-24 - Monday" +* `{ordinal}` is replaced with the ordinal date (e.g. 1st, 2nd, 3rd) etc. + +## Month pattern + +It is also possible to customize the title of generated month notes through the `#monthPattern` attribute, much like `#datePattern`. The options are: + +* `{monthNumberPadded}` results in a number like `09` for September, and `11` for November +* `{month}` results in the full month name (e.g. `September` or `October`) +* `{shortMonth3}` is replaced with the first 3 letters of the month, e.g. Jan, Feb, etc. +* `{shortMonth4}` is replaced with the first 4 letters of the month, e.g. Sept, Octo, etc. + +The default is `{monthNumberPadded} - {month}` + +## Implementation + +Trilium has some special support for day notes in the form of [backend Script API](https://triliumnext.github.io/Notes/backend_api/BackendScriptApi.html) - see e.g. getDayNote() function. + +Day (and year, month) notes are created with a label - e.g. `#dateNote="2018-08-16"` this can then be used by other scripts to add new notes to day note etc. + +Journal also has relation `child:child:child:template=Day template` (see \[\[attribute inheritance\]\]) which effectively adds \[\[template\]\] to day notes (grand-grand-grand children of Journal). \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Day Notes_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Day Notes_image.png new file mode 100644 index 000000000..328e630a2 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Day Notes_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Task Manager.md b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Task Manager.md new file mode 100644 index 000000000..0611fdcd6 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Task Manager.md @@ -0,0 +1,63 @@ +# Task Manager +Task Manager is a [promoted attributes](../Attributes/Promoted%20Attributes.md) and [scripts](../Code%20Notes/Scripts.md)showcase present in the [demo notes](../Database.md). + +## Demo + +![](../../Attachments/task-manager.png) + +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. + +Task Manager also integrates with [day notes](Day%20Notes.md) - notes are [cloned](../../Basic%20Concepts/Note/Cloning%20Notes.md) into day note to both todoDate note and doneDate note (with [prefix](../../Basic%20Concepts/Navigation/Tree%20Concepts.md) of either "TODO" or "DONE"). + +## Implementation + +New tasks are created in the TODO note which has `~child:template` [relation](../Attributes.md)(see [attribute inheritance](../Attributes/Attribute%20Inheritance.md)) pointing to the task template. + +### Attributes + +Task template defines several [promoted attributes](../Attributes/Promoted%20Attributes.md) - todoDate, doneDate, tags, location. Importantly it also defines `~runOnAttributeChange` relation - [event](../Code%20Notes/Events.md) handler which is run on attribute change. This [script](../Code%20Notes/Scripts.md) 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. + +### New task button + +There's also "button" note which contains simple script which adds a button to create new note (task) in the TODO note. + +``` +api.addButtonToToolbar({ + title: 'New task', + icon: 'check', + shortcut: 'alt+n', + action: async () => { + // creating notes is backend (server) responsibility so we need to pass + // the control there + const taskNoteId = await api.runOnBackend(async () => { + const todoRootNote = await api.getNoteWithLabel('taskTodoRoot'); + const {note} = await api.createNote(todoRootNote.noteId, 'new task', ''); + + return note.noteId; + }); + + // we got an ID of newly created note and we want to immediatelly display it + await api.activateNewNote(taskNoteId); + } +}); +``` + +### CSS + +In the demo screenshot above you may notice that TODO tasks are in red color and DONE tasks are green. + +This is done by having this CSS [code note](../Code%20Notes.md) which defines extra CSS classes: + +``` +span.fancytree-node.todo .fancytree-title { + color: red !important; +} + +span.fancytree-node.done .fancytree-title { + color: green !important; +} +``` + +This [code note](../Code%20Notes.md) has `#appCss` [label](../Attributes.md)which is recognized by Trilium on startup and loaded as CSS into the application. + +Second part of this functionality is based in event handler described above which assigns `#cssClass` label to the task to either "done" or "todo" based on the task status. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Weight Tracker.md b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Weight Tracker.md new file mode 100644 index 000000000..038c8e6b7 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Weight Tracker.md @@ -0,0 +1,70 @@ +# Weight Tracker +![](Weight Tracker_image.png) + +The `Weight Tracker` is a [Script API](../Code%20Notes/Script%20API.md) showcase present in the [demo notes](../Database.md). + +By adding `weight` as a [promoted attribute](../Attributes/Promoted%20Attributes.md) in the [template](../Attributes/Template.md) from which [day notes](Day%20Notes.md) are created, you can aggregate the data and plot weight change over time. + +## Implementation + +The `Weight Tracker` note in the screenshot above is of the type `Render Note`. That type of note doesn't have any useful content itself. Instead it is a placeholder where a [script](../Code%20Notes/Scripts.md) can render its output. + +Scripts for `Render Notes` are defined in a [relation](../Attributes.md) called `~renderNote`. In this example, it's the `Weight Tracker`'s child `Implementation`. The Implementation consists of two [code notes](../Code%20Notes.md) that contain some HTML and JavaScript respectively, which load all the notes with a `weight` attribute and display their values in a chart. + +To actually render the chart, we're using a third party library called [chart.js](https://www.chartjs.org/)which is imported as an attachment, since it's not built into Trilium. + +### Code + +Here's the content of the script which is placed in a [code note](../Code%20Notes.md) of type `JS Frontend`: + +``` +async function getChartData() { + const days = await api.runOnBackend(async () => { + const notes = api.getNotesWithLabel('weight'); + const days = []; + + for (const note of notes) { + const date = note.getLabelValue('dateNote'); + const weight = parseFloat(note.getLabelValue('weight')); + + if (date && weight) { + days.push({ date, weight }); + } + } + + days.sort((a, b) => a.date > b.date ? 1 : -1); + + return days; + }); + + const datasets = [ + { + label: "Weight (kg)", + backgroundColor: 'red', + borderColor: 'red', + data: days.map(day => day.weight), + fill: false, + spanGaps: true, + datalabels: { + display: false + } + } + ]; + + return { + datasets: datasets, + labels: days.map(day => day.date) + }; +} + +const ctx = $("#canvas")[0].getContext("2d"); + +new chartjs.Chart(ctx, { + type: 'line', + data: await getChartData() +}); +``` + +## How to remove the Weight Tracker button from the top bar + +In the link map of the `Weight Tracker`, there is a note called `Button`. Open it and delete or comment out its contents. The `Weight Tracker` button will disappear after you restart Trilium. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Weight Tracker_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Weight Tracker_image.png new file mode 100644 index 000000000..0167e759b Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Advanced Showcases/Weight Tracker_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes.md b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes.md new file mode 100644 index 000000000..6a60cbab3 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes.md @@ -0,0 +1,82 @@ +# Attributes +In Trilium, attributes are key-value pairs assigned to notes, providing additional metadata or functionality. There are two primary types of attributes: + +1. **Labels**: Simple key-value text records +2. **Relations**: Named links to other notes + +These attributes play a crucial role in organizing, categorising, and enhancing the functionality of notes. + +![](Attributes_image.png) + +## Labels + +Labels in Trilium can be used for a variety of purposes: + +* **Metadata**: Assign labels with optional values for categorization, such as `#year=1999`, `#genre="sci-fi"`, or `#author="Neal Stephenson"` +* **Configuration**: Labels can configure advanced features or settings +* **Scripts and Plugins**: Used to tag notes with special metadata, such as the "weight" attribute in the [Weight Tracker](Advanced%20Showcases/Weight%20Tracker.md) + +Labels are also searchable, enhancing note retrieval. + +### Common Labels for Advanced Configuration + +* `**disableVersioning**`: Disables automatic versioning, ideal for large, unimportant notes like script libraries +* `**versioningLimit**`: Used to limit the number of revisions for a single note +* `**calendarRoot**`: Marks the note as the root for [day notes](Advanced%20Showcases/Day%20Notes.md). Only one note should carry this label +* `**archived**`: Hides notes from default search results and dialogs +* `**excludeFromExport**`: Excludes notes and their subtrees from export operations +* `**run**`: Specifies events to trigger scripts (e.g., `frontendStartup`, `hourly`) +* `**runAtHour**`: Defines specific hours for scripts to run, used with `#run=hourly` +* `**disableInclusion**`: Prevents a script from being included in parent script executions +* `**sorted**`: Automatically sorts child notes alphabetically by title +* `**top**`: Keeps the note at the top of its parent's list, useful with `sorted` +* `**hidePromotedAttributes**`: Hides certain attributes in the note's display +* `**readOnly**`: Sets the note to read-only mode, applicable to text and code notes +* `**autoReadOnlyDisabled**`: Disables automatic read-only mode for large notes +* `**appCss**`: Marks CSS notes used to modify Trilium’s appearance +* `**appTheme**`: Marks full CSS themes available in Trilium's options +* `**cssClass**`: Adds a CSS class to the note's representation in the tree +* `**iconClass**`: Adds a CSS class to the note's icon, useful for distinguishing notes visually. See [note icons](../Basic%20Concepts/Note/Note%20Icons.md) +* `**pageSize**`: Specifies the number of items per page in note listings +* `**customRequestHandler**` **and** `**customResourceProvider**`: Refer to [Custom request handler](Custom%20Request%20Handler.md) +* `**widget**`: Marks a note as a custom widget, added to Trilium's component tree +* `**workspace**` **and related attributes**: See [Workspace](../Basic%20Concepts/Navigation/Workspace.md) for more details +* `**searchHome**`: Specifies the parent for new search notes +* `**inbox**`: Designates a default location for new notes created via the sidebar +* `**sqlConsoleHome**`: Default location for SQL console notes +* `**bookmarked**` **and** `**bookmarkFolder**`: See [Bookmarks](../Basic%20Concepts/Navigation/Bookmarks.md) +* `**shareXXX**`: See [Sharing](Sharing.md) +* `**keyboardShortcut**`: Assigns a keyboard shortcut to open the note +* `**displayRelations**` **and** `**hideRelations**`: Manages the display of note relations +* `**titleTemplate**`: See [Default note title](Default%20Note%20Title.md) +* `**template**`: Makes the note available as a template +* `**toc**`: Controls the visibility of the table of contents +* `**color**`: Defines the color of the note in the tree and links +* `**hideChildrenOverview**`: Hides child notes in the parent note's editor +* `**viewType**`: Sets the view of child notes (grid or list) + +## Relations + +Relations define connections between notes, similar to links. + +### Uses + +* **Metadata Relationships**: For example, linking a book note to an author note +* **Scripting**: Attaching scripts to events or conditions related to the note + +### Common Relations + +* **Event-based Relations**: Such as `runOnNoteCreation` or `runOnNoteChange`, which trigger scripts on specific actions +* **Other Relations**: Include `template`, `renderNote`, `widget`, and sharing-related relations + +## Multiplicity + +Attributes in Trilium can be "multivalued", meaning multiple attributes with the same name can coexist. + +## Attribute Definitions and Promoted Attributes + +Special labels create "label/attribute" definitions, enhancing the organization and management of attributes. For more details, see [Promoted attributes](Attributes/Promoted%20Attributes.md). + +## Attribute Inheritance + +Trilium supports attribute inheritance, allowing child notes to inherit attributes from their parents. For more information, see [Attribute inheritance](Attributes/Attribute%20Inheritance.md). \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Attribute Inheritance.md b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Attribute Inheritance.md new file mode 100644 index 000000000..7c2040ec3 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Attribute Inheritance.md @@ -0,0 +1,25 @@ +# Attribute Inheritance +## 1\. Standard Inheritance + +In Trilium, attributes can be automatically inherited by child notes if they have the `isInheritable` flag set to `true`. This means the attribute (a key-value pair) is applied to the note and all its descendants. + +### Example Use Case + +The `archived` 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. + +## 2\. Copying Inheritance + +Copying inheritance differs from standard inheritance by using a `child:` 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. + +### How to Use + +* **Syntax:** `#child:attributeName` +* **Chained Inheritance:** You can chain this inheritance, such as `#child:child:attributeName`, where each child down the hierarchy receives the appropriate attribute. + +### Example + +If a parent note has the label `#child:exampleAttribute`, all newly created child notes will inherit the `#exampleAttribute` label. This can be useful for setting default properties for notes in a specific section. + +## 3\. Template Inheritance + +Attributes can also be inherited from [templates](Template.md). 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. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes.md b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes.md new file mode 100644 index 000000000..02896ad22 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes.md @@ -0,0 +1,32 @@ +# Promoted Attributes +Promoted attributes are [attributes](../Attributes.md) which are considered important and thus are "promoted" onto the main note UI. See example below: + +![](../../Attachments/promoted-attributes.png) + +You can see the note having kind of form with several fields. Each of these is just regular attribute, the only difference is that they appear on the note itself. + +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. + +Now, how do we make attribute to appear on the UI? + +## Attribute definition + +Attribute is always name-value pair where both name and value are strings. + +_Attribute definition_ specifies how should this value be interpreted - is it just string, or is it a date? Should we allow multiple values or note? And importantly, should we _promote_ the attribute or not? + +![](Promoted Attributes_image.png) + +You can notice tag attribute definition. These "definition" attributes define how the "value" attributes should behave. + +So there's one attribute for value and one for definition. But notice how definition attribute is [Inheritable](Attribute%20Inheritance.md), meaning that it's also applied to all descendant note. So in a way, this definition is used for the whole subtree while "value" attributes are applied only for this note. + +### Inverse relation + +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 `isPartnerOf`. 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. + +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 `isParentOf` and the other one going from child to parent might be called `isChildOf`. + +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 `isParentOf` which defines `isChildOf` as inverse relation and then second relation definition for `isChildOf` which defines `isParentOf` as inverse relation. + +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. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes_image.png new file mode 100644 index 000000000..ecb5f2d6d Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Template.md b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Template.md new file mode 100644 index 000000000..dbd152f03 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Template.md @@ -0,0 +1,36 @@ +# Template +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: + +1. **Attribute Inheritance**: All attributes from the template note are [inherited](Attribute%20Inheritance.md) by the instance notes. Even attributes with `#isInheritable=false` are inherited by the instance notes, although only inheritable attributes are further inherited by the children of the instance notes. +2. **Content Duplication**: The content of the template note is copied to the instance note, provided the instance note is empty at the time of template assignment. +3. **Child Note Duplication**: All child notes of the template are deep-duplicated to the instance note. + +## Example + +A typical example would be a "Book" template note, which might include: + +* **Promoted Attributes**: Such as publication year, author, etc. (see [promoted attributes](Promoted%20Attributes.md)). +* **Outline**: An outline for a book review, including sections like themes, conclusion, etc. +* **Child Notes**: Additional notes for highlights, summary, etc. + +![Template Example](../../Attachments/template.png) + +## Instance Note + +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. + +To create an instance note through the UI: + +![show child note templates](../../Attachments/template-create-instance-n.png) + +For the template to appear in the menu, the template note must have the `#template` label. Do not confuse this with the `~template` relation, which links the instance note to the template note. If you use [workspaces](../../Basic%20Concepts/Navigation/Workspace.md), you can also mark templates with `#workspaceTemplate` to display them only in the workspace. + +Templates can also be added or changed after note creation by creating a `~template` relation pointing to the desired template note. + +## Additional Notes + +From a visual perspective, templates can define `#iconClass` and `#cssClass` attributes, allowing all instance notes (e.g., books) to display a specific icon and CSS style. + +Explore the concept further in the [demo notes](../Database.md), including examples like the [Relation Map](../Relation%20Map.md), [Task Manager](../Advanced%20Showcases/Task%20Manager.md), and [Day Notes](../Advanced%20Showcases/Day%20Notes.md). + +Additionally, see [default note title](../Default%20Note%20Title.md) for creating title templates. Note templates and title templates can be combined by creating a `#titleTemplate` for a template note. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes_image.png new file mode 100644 index 000000000..2ea269012 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Bulk actions.md b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Bulk actions.md new file mode 100644 index 000000000..c87a42e5f --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Bulk actions.md @@ -0,0 +1,16 @@ +# Bulk actions +### Execute script + +For more complex scenarios, it is possible to type in a JavaScript expression in order to apply the necessary changes. + +To apply a suffix (`- suffix` in this example), to the note title: + +```javascript +note.title = note.title + " - suffix"; +``` + +To alter attributes of a note in a bulk action, such as setting the `#shareAlias` label to the title of the note: + +```javascript +note.setLabel("shareAlias", note.title) +``` \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes.md b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes.md new file mode 100644 index 000000000..1f52a7484 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes.md @@ -0,0 +1,21 @@ +# Code Notes +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.). + +This can be useful for a few things: + +* computer programmers can store code snippets as notes with syntax highlighting +* JavaScript code notes can be executed inside Trilium for some extra functionality + * we call such JavaScript code notes "scripts" - see [Scripts](Code%20Notes/Scripts.md) +* JSON, XML etc. can be used as storage for structured data (typically used in conjunction with scripting) + +![](Code Notes_image.png) + +## Extra languages + +Trilium supports syntax highlighting for many languages, but by default displays only some of them (to reduce the number of items). You can add extra languages in Options -> Code notes. + +## Code blocks + +An alternative to the code note is a "code block" - feature of a text note which can add short snippets of code to the text editor. Starting with TriliumNext v0.90.12, the code blocks also support syntax highlighting. + +![](1_Code Notes_image.png) \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes/Custom Widgets.md b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes/Custom Widgets.md new file mode 100644 index 000000000..3dbea2e7c --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes/Custom Widgets.md @@ -0,0 +1,96 @@ +# Custom Widgets +It's possible to create custom widget in three possible locations where you can display your custom content. + +Positions are: + +* `left-pane` +* `center-pane` +* `note-detail-pane` - located within `center-pane`, but specific to note (split) +* `right-pane` + +## Example - word count widget + +Create a code note of type JS frontend and **give it a** `**#widget**` **label**. + +``` +/* + * This defines a custom widget which displays number of words and characters in a current text note. + * 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. + * + * See it in action in "Books" and its subtree. + */ +const TPL = ` + Word count: + + +   + + Character count: + +`; + +class WordCountWidget extends api.NoteContextAwareWidget { + static get parentWidget() { return 'center-pane'; } + + get position() { return 100; } // higher value means position towards the bottom/right + + isEnabled() { + return super.isEnabled() + && this.note.type === 'text' + && this.note.hasLabel('wordCount'); + } + + doRender() { + this.$widget = $(TPL); + this.$wordCount = this.$widget.find('.word-count'); + this.$characterCount = this.$widget.find('.character-count'); + return this.$widget; + } + + async refreshWithNote(note) { + const {content} = await note.getNoteComplement(); + + const text = $(content).text(); // get plain text only + + const counts = this.getCounts(text); + + this.$wordCount.text(counts.words); + this.$characterCount.text(counts.characters); + } + + getCounts(text) { + const chunks = text + .split(/[\s-+:,/\\]+/) + .filter(chunk => chunk !== ''); + + let words; + + if (chunks.length === 1 && chunks[0] === '') { + words = 0; + } + else { + words = chunks.length; + } + + const characters = chunks.join('').length; + + return {words, characters}; + } + + async entitiesReloadedEvent({loadResults}) { + if (loadResults.isNoteContentReloaded(this.noteId)) { + this.refresh(); + } + } +} + +module.exports = WordCountWidget; +``` + +After you make changes it is necessary to restart Trilium so that the layout can be rebuilt. + +### Example screenshot + +On the bottom you can see the resulting widget: + +![](../../Attachments/Custom-widget%20image.png) \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes/Events.md b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes/Events.md new file mode 100644 index 000000000..add2fa5a2 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes/Events.md @@ -0,0 +1,29 @@ +# Events +[Script](Scripts.md) notes can be triggered by events. Note that these are backend events and thus relation need to point to the "JS backend" code note. + +## Global events + +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. + +* `run` + * `frontendStartup` - executes on frontend upon startup + * `mobileStartup` - executes on mobile frontend upon startup + * `backendStartup` - executes on backend upon startup + * `hourly` - executes once an hour on backend + * `daily` - executes once a day on backend + +## Entity events + +Other events are bound to some entity, these are defined as [relations](../Attributes.md) - meaning that script is triggered only if note has this script attached to it through relations (or it can inherit it). + +* `runOnNoteCreation` - executes when note is created on backend +* `runOnNoteTitleChange` - executes when note title is changed (includes note creation as well) +* `runOnNoteContentChange` - executes when note content is changed (includes note creation as well). +* `runOnNoteChange` - executes when note is changed (includes note creation as well) +* `runOnNoteDeletion` - executes when note is being deleted +* `runOnBranchCreation` - 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. +* `runOnBranchChange` (since v0.62) - executes when a branch is changed - either expanded status or prefix are changed. +* `runOnBranchDeletion` - executes when a branch is delete. Branch is a link between parent note and child note and is deleted e.g. when moving note (old branch/link is deleted). +* `runOnChildNoteCreation` - executes when new note is created under _this_ note +* `runOnAttributeCreation` - executes when new attribute is created under _this_ note +* `runOnAttributeChange` - executes when attribute is changed under _this_ note \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes/Script API.md b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes/Script API.md new file mode 100644 index 000000000..26bd81929 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes/Script API.md @@ -0,0 +1,7 @@ +# Script API +Trilium offers a "Script API" that enables scripts to perform various useful functions. There are two main APIs available: + +* [Frontend API](https://triliumnext.github.io/Notes/frontend_api/FrontendScriptApi.html) +* [Backend API](https://triliumnext.github.io/Notes/backend_api/BackendScriptApi.html) + +Please note that the Script API is currently experimental and may undergo changes in future updates. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes/Scripts.md b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes/Scripts.md new file mode 100644 index 000000000..0be851d73 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes/Scripts.md @@ -0,0 +1,54 @@ +# Scripts +Trilium supports creating [code notes](../Code%20Notes.md), 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 [Script API](Script%20API.md) provide extra functionality. + +## Scripting + +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: + +* frontend running in the browser (using HTML, CSS, JavaScript) - this is mainly used to interact with the user, display notes etc. +* backend running JavaScript code in node.js runtime - this is responsible for e.g. storing notes, encrypting them etc. + +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 \[\[code notes\]\] and we're onto something. + +## Button use case + +Let's take a look at our demo script (shipped with default Trilium [database](../Database.md)) - Task manager. One of the things this script does is adding a button to the Trilium interface which will allow user to easily add new Task (TODO item). + +![](../../Attachments/button-script.png) + +First take a look at the red circle all the way on the top - this what we want to achieve - new button in UI which will create new note representing a task/todo item. + +Red point below the first one marks the note type we have created for this script - it's "JavaScript frontend". It's frontend because adding button to UI is clearly frontend responsibility. + +In the note content you can see the code which calls one of the API methods, this one is specifically meant to add new buttons. Code needs to set few button properties: + +* button title +* icon which should appear on the button +* optional shortcut under which you can trigger the button +* most importantly "action" - what must happen when button is clicked + +### Action handler + +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. + +### Script execution + +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. + +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. + +The solution is marked by red circle at the bottom - this note has [label](../Attributes.md) `#run=frontendStartup` - 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. + +(`#run=frontendStartup` does not work for [Mobile frontend](../../Installation%20%26%20Setup/Mobile%20Frontend.md) - if you want to have scripts running there, give the script `#run=mobileStartup` label) + +### More showcases + +You can see more scripting with explanation in [Advanced showcases](../Advanced%20Showcases.md) + +## Events + +See [Events](Events.md). + +## Script API + +See [Script API](Script%20API.md). \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes_image.png new file mode 100644 index 000000000..f3ebaf673 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Code Notes_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Configuration (config.ini or e.md b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Configuration (config.ini or e.md new file mode 100644 index 000000000..d5b8e4a12 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Configuration (config.ini or e.md @@ -0,0 +1,30 @@ +# Configuration (config.ini or environment variables) +Trilium supports configuration via a file named `config.ini` and environment variables. Please review the file named [config-sample.ini](https://github.com/TriliumNext/Notes/blob/develop/config-sample.ini) in the [Notes](https://github.com/TriliumNext/Notes) repository to see what values are supported. + +You can provide the same values via environment variables instead of the `config.ini` file, and these environment variables use the following format: + +1. Environment variables should be prefixed with `TRILIUM_` and use underscores to represent the INI section structure. +2. The format is: `TRILIUM_
_=` +3. The environment variables will override any matching values from config.ini + +For example, if you have this in your config.ini: + +``` +[Network] +host=localhost +port=8080 +``` + +You can override these values using environment variables: + +```sh +TRILIUM_NETWORK_HOST=0.0.0.0 +TRILIUM_NETWORK_PORT=9000 +``` + +The code will: + +1. First load the `config.ini` file as before +2. Then scan all environment variables for ones starting with `TRILIUM_` +3. Parse these variables into section/key pairs +4. Merge them with the config from the file, with environment variables taking precedence \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Custom Request Handler.md b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Custom Request Handler.md new file mode 100644 index 000000000..00963321d --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Custom Request Handler.md @@ -0,0 +1,88 @@ +# Custom Request Handler +Trilium provides a mechanism for [scripts](Code%20Notes/Scripts.md) 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. `/trilium buy milk`). + +## Create note from outside Trilium + +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. + +We'll start with creating a JavaScript backend [code note](Code%20Notes.md) containing: + +``` +const {req, res} = api; +const {secret, title, content} = req.body; + +if (req.method == 'POST' && secret === 'secret-password') { + // notes must be saved somewhere in the tree hierarchy specified by a parent note. + // This is defined by a relation from this code note to the "target" parent note + // alternetively you can just use constant noteId for simplicity (get that from "Note Info" dialog of the desired parent note) + const targetParentNoteId = api.currentNote.getRelationValue('targetNote'); + + const {note} = api.createTextNote(targetParentNoteId, title, content); + const notePojo = note.getPojo(); + + res.status(201).json(notePojo); +} +else { + res.send(400); +} +``` + +This script note has also following two attributes: + +* label `#customRequestHandler` with value `create-note` +* relation `~targetNote` pointing to a note where new notes should be saved + +### Explanation + +Let's test this by using an HTTP client to send a request: + +``` +POST http://my.trilium.org/custom/create-note +Content-Type: application/json + +{ + "secret": "secret-password", + "title": "hello", + "content": "world" +}+++++++++++++++++++++++++++++++++++++++++++++++ +``` + +Notice the `/custom` 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 `customRequestHandler` [label](Attributes.md). Value of this label then contains a regular expression which will match the request path (in our case trivial regex "create-note"). + +Trilium will then find our code note created above and execute it. `api.req`, `api.res` are set to [request](https://expressjs.com/en/api.html#req) and [response](https://expressjs.com/en/api.html#res)objects from which we can get details of the request and also respond. + +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. + +Once we pass these checks we will just create the desired note using [Script API](Code%20Notes/Script%20API.md). + +## Custom resource provider + +Another common use case is that you want to just expose a file note - in such case you create label `customResourceProvider` (value is again path regex). + +For more information, see [Custom Resource Providers](Custom%20Resource%20Providers.md). + +## Advanced concepts + +`api.req` and `api.res` are Express.js objects - you can always look into its [documentation](https://expressjs.com/en/api.html) for details. + +### Parameters + +REST request paths often contain parameters in the URL, e.g.: + +``` +http://my.trilium.org/custom/notes/123 +``` + +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 `customRequestHandler` value would match it: + +``` +notes/([0-9]+) +``` + +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 `api.pathParams`: + +``` +const noteId = api.pathParams[0]; +``` + +Often you also need query params (as in e.g. `http://my.trilium.org/custom/notes?noteId=123`), you can get those with standard express `req.query.noteId`. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Custom Resource Providers.md b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Custom Resource Providers.md new file mode 100644 index 000000000..4df8fd768 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Custom Resource Providers.md @@ -0,0 +1,34 @@ +# Custom Resource Providers +A custom resource provider allows any file imported into Trilium (images, fonts, stylesheets) to be publicly accessible via a URL. + +A potential use case for this is to add embed a custom font alongside a theme. + +## Steps for creating a custom resource provider + +1. Import a file such as an image or a font into Trilium by drag & drop. +2. Select the file and go to the _Owned Attributes_ section. +3. Add the label `#customResourceProvider=hello`. +4. To test if it is working, use a browser to navigate to `:///custom/hello` (where `` is either `http` or `https` based on your setup, and `` is the host or IP to your Trilium server instance). If you are running the TriliumNext application without a server, use `http://localhost:37840` as the base URL. +5. If everything went well, at the previous step the browser should have downloaded the file uploaded in the first step. + +Instead of `hello`, the name can be: + +* A path, such as `fonts/Roboto.ttf`, which would be accessible via `/custom/fonts/Roboto.ttf`. +* As a more advanced use case, a regular expression to match multiple routes, such as `hello/.*` which will be accessible via `/custom/hello/1`, `/custom/hello/2`, `/custom/hello/world`, etc. + +## Using it in a theme + +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 `#customResourceProvider=fonts/myfont.ttf` attribute. + +Then modify the theme CSS to point to: + +```css +@font-face { + font-family: customFont; + src: url("/custom/fonts/myfont.ttf"); +} + +div { + font-family: customFont; +} +``` \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database.md b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database.md new file mode 100644 index 000000000..10a4fe415 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database.md @@ -0,0 +1,37 @@ +# Database +Your Trilium data is stored in a [SQLite](https://www.sqlite.org) database which contains all notes, tree structure, metadata, and most of the configuration. The database file is named `document.db` and is stored in the application's default [Data directory](../Installation%20%26%20Setup/Data%20directory.md). + +## Demo Notes + +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: + +* [Relation Map](Relation%20Map.md) +* [Day Notes](Advanced%20Showcases/Day%20Notes.md) +* [Weight Tracker](Advanced%20Showcases/Weight%20Tracker.md) +* [Task Manager](Advanced%20Showcases/Task%20Manager.md) +* [Custom CSS Themes](../Basic%20Concepts/Themes.md) + +### Restoring Demo Notes + +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. + +You can easily restore the demo notes by using Trilium's built-in import feature by importing them: + +* Download [this .zip archive](https://github.com/TriliumNext/Notes/raw/develop/db/demo.zip) with the latest version of the demo notes +* Right click on any note in your tree under which you would like the demo notes to be imported +* Click "Import into note" +* Select the .zip archive to import it + +## Manually Modifying the Database + +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 [SQLite Browser](https://sqlitebrowser.org/) to work directly on the database file. + +See [Manually altering the database](Database/Manually%20altering%20the%20database.md) for more information. + +## How to Reset the Database + +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. + +To delete the database, simply go to the [data directory](../Installation%20%26%20Setup/Data%20directory.md) and delete the `document.db` file (and any other files starting with `document.db`). + +If you do not need to preserve any configurations that might be stored in the `config.ini` file, you can just delete all of the [data directory's](../Installation%20%26%20Setup/Data%20directory.md) contents to fully restore the application to its original state. You can also review the [configuration](Configuration%20\(config.ini%20or%20e.md) file to provide all `config.ini` values as environment variables instead. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/1_Manually altering the data.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/1_Manually altering the data.png new file mode 100644 index 000000000..973cc4d6c Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/1_Manually altering the data.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/2_Manually altering the data.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/2_Manually altering the data.png new file mode 100644 index 000000000..0ef3cef45 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/2_Manually altering the data.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/3_Manually altering the data.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/3_Manually altering the data.png new file mode 100644 index 000000000..6f32f76ec Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/3_Manually altering the data.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/4_Manually altering the data.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/4_Manually altering the data.png new file mode 100644 index 000000000..a6bbeaaf9 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/4_Manually altering the data.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/5_Manually altering the data.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/5_Manually altering the data.png new file mode 100644 index 000000000..c6681695a Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/5_Manually altering the data.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/6_Manually altering the data.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/6_Manually altering the data.png new file mode 100644 index 000000000..469899ebc Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/6_Manually altering the data.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the data.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the data.png new file mode 100644 index 000000000..32a91fc2f Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the data.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database.md b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database.md new file mode 100644 index 000000000..2b71fe143 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database.md @@ -0,0 +1,42 @@ +# Manually altering the database +There are some situations where modifying the SQLite database that Trilium uses is desirable. + +If you are doing any advanced development or troubleshooting where you manually modify the database, you might want to consider creating backups of your `document.db` file. + +## Modifying it internally using the SQL Console + +The SQL Console is Trilium's built-in database editor. + +See [SQL Console](Manually%20altering%20the%20database/SQL%20Console.md). + +## Externally modifying the database + +Sometimes the SQL Console cannot be used (for example if the application cannot start). + +When making external modifications, consider closing the desktop application. If modifying the server database, then stop the service or Docker container. + +### Using DB Browser for SQLite + +DB Browser for SQLite is a cross-platform editor that can be used to alter the database using a graphical user interface. + +To do so: + +1. In the main menu, select File → Open database… and navigate to the database in the [Data directory](../../Installation%20%26%20Setup/Data%20directory.md). +2. Select the _Execute SQL_ tab. +3. Type in the desired SQL statement. +4. Press the "Play" button in the toolbar underneath the "Execute SQL" tab (or F5 key). +5. Press "Write Changes" in the main toolbar. +6. Close the application or close the database. + +![](6_Manually altering the data.png) + +### Using the SQLite CLI + +First, start the SQLite 3 CLI by specifying the path to the database: + +```sh +sqlite3 ~/.local/share/trilium-data/document.db +``` + +* In the prompt simply type the statement and make sure it ends with a `;` character. +* To exit, simply type `.quit` and enter. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/1_SQL Console_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/1_SQL Console_image.png new file mode 100644 index 000000000..0ef3cef45 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/1_SQL Console_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/2_SQL Console_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/2_SQL Console_image.png new file mode 100644 index 000000000..c6681695a Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/2_SQL Console_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/3_SQL Console_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/3_SQL Console_image.png new file mode 100644 index 000000000..32a91fc2f Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/3_SQL Console_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/SQL Console.md b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/SQL Console.md new file mode 100644 index 000000000..aadc3e726 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/SQL Console.md @@ -0,0 +1,25 @@ +# SQL Console +The SQL Console is Trilium's built-in database editor. + +It can be accessed by going to the [global menu](../../../Basic%20Concepts/UI%20Elements) → Advanced → Open SQL Console. + +![](3_SQL Console_image.png) + +### Interaction + +* Hovering the mouse over one of the tables listed at the top of the document will show the columns and their data type. +* Only one SQL statement can be run at once. +* To run the statement, press the ![](1_SQL Console_image.png)icon. +* For queries that return a result, the data will displayed in a table. + + ![](SQL Console_image.png) + + +### Saved SQL console + +SQL queries or commands can be saved into a dedicated note. + +To do so, simply write the query and press the ![](2_SQL Console_image.png)button. Once saved, the note will appear in [Day Notes](../../Advanced%20Showcases/Day%20Notes.md). + +* The SQL expression will not be displayed by default, but it can still be viewed by going to the note context menu and selecting _Note source_. +* The expression cannot be modified. If needed, recreate it by copying the statement back into the SQL console and then saving it again. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/SQL Console_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/SQL Console_image.png new file mode 100644 index 000000000..6f32f76ec Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/SQL Console_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Default Note Title.md b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Default Note Title.md new file mode 100644 index 000000000..1f1a17ded --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Default Note Title.md @@ -0,0 +1,30 @@ +# Default Note Title +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. + +For this use case, Trilium (since v0.52) supports `#titleTemplate` [label](Attributes.md). 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. + +As an example use case, imagine you collect books you've read in a given year like this: + +* 2022 Books + * Neal Stephenson: Anathem, 2008 + * Franz Kafka: Die Verwandlung, 1915 + +Now, to the parent note "2022 Books" you can assign label `#titleTemplate="[Author name]: [Book title], [Publication year]"`. + +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. + +## Dynamic value + +The value of `#titleTemplate` 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. + +As an example, imagine you collect server outage incidents and write some notes. It looks like this: + +* Incidents + * 2022-05-09: System crash + * 2022-05-15: Backup delay + +You can automatize the date assignment by assigning a label `#titleTemplate="${now.format('YYYY-MM-DD')}: "` to the parent note "Incidents". Whenever a new child note is created, the title template is evaluated with the injected [now](https://day.js.org/docs/en/display/format) object. + +Second variable injected is [parentNote](https://triliumnext.github.io/Notes/backend_api/BNote.html), an example could be `#titleTemplate="${parentNote.getLabelValue('authorName')}'s literary works"`. + +See also \[\[[template](Attributes/Template.md)\]\] which provides similar capabilities, including default note's content. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/ETAPI (REST API).md b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/ETAPI (REST API).md new file mode 100644 index 000000000..d7795455e --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/ETAPI (REST API).md @@ -0,0 +1,28 @@ +# ETAPI (REST API) +ETAPI is Trilium's public/external REST API. It is available since Trilium v0.50. + +The documentation is in OpenAPI format, available [here](https://github.com/TriliumNext/Notes/blob/master/src/etapi/etapi.openapi.yaml). + +[trilium-py](https://github.com/Nriver/trilium-py) is a third-party Python implementation for ETAPI client, you can use Python to communicate with Trilium. + +## Authentication + +All operations have to be authenticated using a token. You can get this token either from Options -> ETAPI or programmatically using the `/auth/login` REST call (see the [spec](https://github.com/TriliumNext/Notes/blob/master/src/etapi/etapi.openapi.yaml)): + +``` +GET https://myserver.com/etapi/app-info +Authorization: ETAPITOKEN +``` + +Alternatively, since 0.56 you can also use basic auth format: + +``` +GET https://myserver.com/etapi/app-info +Authorization: Basic BATOKEN +``` + +* Where `BATOKEN = BASE64(username + ':' + password)` - this is a standard Basic Auth serialization +* Where `username` is "etapi" +* And `password` is the generated ETAPI token described above. + +Basic Auth is meant to be used with tools which support only basic auth. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Note Map.md b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Note Map.md new file mode 100644 index 000000000..d50af1a5e --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Note Map.md @@ -0,0 +1,25 @@ +# Note Map +Note map is a visualisation of connections between notes. + +This provides an insight into a structure ("web") of notes. + +There are two types of note map: + +## Link Map + +Shows [relations](Attributes.md) between notes: + +![](Note Map_image.png) + +## Tree Map + +Shows hierarchical map of notes: + +![](1_Note Map_image.png) + +## See also + +[Relation map](Relation%20Map.md) is a similar concept, with some differences: + +* note map is automatically generated while relation map must be created manually +* relation map is a type of note while a link map is just virtual visualization \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Note Map_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Note Map_image.png new file mode 100644 index 000000000..a16316f82 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Note Map_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Relation Map.md b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Relation Map.md new file mode 100644 index 000000000..95f0f6f23 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Relation Map.md @@ -0,0 +1,49 @@ +# Relation Map +Relation map is a type of [note](../Basic%20Concepts/Navigation/Tree%20Concepts.md) which visualizes notes and their [relations](Attributes.md). See an example: + +## Development process demo + +This is a basic example how you can create simple diagram using relation maps: + +![](../Attachments/relation-map-dev-process.png) + +And this is how you can create it: + +![](api/images/PDGOsZt0D5iu/relation-map-dev-process-demo.) + +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 [relations](Attributes.md)between notes and name them. That's all! + +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 "[relations](Attributes.md)". + +## Family demo + +This is more complicated demo using some advanced concepts. Resulting diagram is here: + +![](../Attachments/relation-map-family.png) + +This is how you get to it: + +![](../Attachments/relation-map-family-demo.gif) + +There are several steps here: + +* we start with empty relation map and two existing notes representing Prince Philip and Queen Elizabeth II. These two notes already have "isPartnerOf" [relations](Attributes.md)defined. + * There are actually two "inverse" relations (one from Philip to Elizabeth and one from Elizabeth to Philip) +* we drag both notes to relation map and place to suitable position. Notice how the existing "isPartnerOf" relations are displayed. +* 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). +* we create two new relations "isChildOf" targeting both Philip and Elizabeth + * now there's something unexpected - we can also see the relation to display another "hasChild" relation. This is because there's a [relation definition](Attributes/Promoted%20Attributes.md) which puts "isChildOf" as an "[inverse](Attributes/Promoted%20Attributes.md)" relation of "hasChildOf" (and vice versa) and thus it is created automatically. +* we create another note for Princess Diana and create "isPartnerOf" relation from Charles. Again notice how the relation has arrows both ways - this is because "isPartnerOf" definition specifies its inverse relation as again "isPartnerOf" so the opposite relation is created automatically. +* as the last step we pan & zoom the map to fit better to window dimensions. + +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 [demo notes](Database.md). + +## Details + +You can specify which relations should be displayed with comma delimited names of relations in `displayRelations` label. + +Alternatively, you can specify comma delimited list of relation names in `hideRelations` which will display all relations, except for the ones defined in the label. + +## See also + +* [Note map](Note%20Map.md) is a similar concept \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing.md b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing.md new file mode 100644 index 000000000..e0666e301 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing.md @@ -0,0 +1,101 @@ +# Sharing +Trilium allows you to share selected notes as **publicly accessible** read-only documents. This feature is particularly useful for publishing content directly from your Trilium notes, making it accessible to others online. + +## Prerequisites + +To use the sharing feature, you must have a [server installation](../Installation%20%26%20Setup/Server%20Installation.md) of Trilium. This is necessary because the notes will be hosted from the server. + +## How to Share a Note + +1. **Enable Sharing**: To share a note, toggle the `Shared` switch within the note's interface. Once sharing is enabled, an URL will appear, which you can click to access the shared note. + + ![Share Note](../Attachments/share-single-note.png) + +2. **Access the Shared Note**: 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 `localhost (127.0.0.1)`. + + ![Shared Note Example](../Attachments/share-single-note-web.png) + + +## Sharing a Note Subtree + +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. + +![Shared Subtree Example](../Attachments/share-multiple-notes-web.png) + +## Viewing All Shared Notes + +You can view a list of all shared notes by clicking on "Show Shared Notes Subtree." This allows you to manage and navigate through all the notes you have made public. + +## Security Considerations + +Shared notes are published on the open internet and can be accessed by anyone with the URL. The URL's randomness does not provide security, so it is crucial not to share sensitive information through this feature. + +### Password Protection + +To protect shared notes with a username and password, you can use the `#shareCredentials` attribute. Add this label to the note with the format `#shareCredentials="username:password"`. To protect an entire subtree, make sure the label is [inheritable](Attributes/Attribute%20Inheritance.md). + +## Advanced Sharing Options + +### Customizing the Appearance of Shared Notes + +The default shared page is basic in design, but you can customize it using your own CSS: + +* **Custom CSS**: Link a CSS [code note](Code%20Notes.md) to the shared page by adding a `~shareCss` 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 `#shareHiddenFromTree` label. +* **Omitting Default CSS**: For extensive styling changes, use the `#shareOmitDefaultCss` label to avoid conflicts with Trilium's [default stylesheet](../Basic%20Concepts/Themes.md). + +### Adding JavaScript + +You can inject custom JavaScript into the shared note using the `~shareJs` relation. This allows you to access note attributes or traverse the note tree using the `fetchNote()` API, which retrieves note data based on its ID. + +Example: + +```javascript +const currentNote = await fetchNote(); +const parentNote = await fetchNote(currentNote.parentNoteIds[0]); + +for (const attr of parentNote.attributes) { + console.log(attr.type, attr.name, attr.value); +} +``` + +### Creating Human-Readable URL Aliases + +Shared notes typically have URLs like `http://domain.tld/share/knvU8aJy4dJ7`, where the last part is the note's ID. You can make these URLs more user-friendly by adding the `#shareAlias` label to individual notes (e.g., `#shareAlias=highlighting`). This will change the URL to `http://domain.tld/share/highlighting`. + +**Important**: + +1. Ensure that aliases are unique. +2. Using slashes (`/`) within aliases to create subpaths is not supported. + +### Viewing and Managing Shared Notes + +All shared notes are grouped under an automatically managed "Shared Notes" section. From here, you can view, share, or unshare notes by moving or cloning them within this section. + +![Shared Notes List](../Attachments/shared-list.png) + +### Setting a Custom Favicon + +To customize the favicon for your shared pages, create a relation `~shareFavicon` pointing to a file note containing the favicon (e.g., in `.ico` format). + +### Sharing a Note as the Root + +You can designate a specific note or folder as the root of your shared content by adding the `#shareRoot` label. This note will be linked when visiting `[http://domain.tld/share](http://domain/share)`, making it easier to use Trilium as a fully-fledged website. Consider combining this with the `#shareIndex` label, which will display a list of all shared notes. + +## Additional Options + +* **Raw Note Sharing**: Use the `#shareRaw` label to share a note without any HTML wrapper. +* **Disallow Robot Indexing**: Add the `#shareDisallowRobotIndexing` label to prevent search engines from indexing the shared page by including a `noindex, follow` meta tag and `X-Robots-Tag: noindex` header. +* **Shared Notes Index**: For text notes with the `#shareIndex` label, the content will display a list of all shared note roots. + +## Limitations + +While the sharing feature is powerful, it has some limitations: + +* **No Relation Map Support** +* **Book Notes**: Only show a list of child notes. +* **Code Notes**: No syntax highlighting. +* **Static Note Tree** +* **Protected Notes**: Cannot be shared. +* **Include Notes**: Not supported. + +Some of these limitations may be addressed in future updates. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Shared notes/Serving directly the conte.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/1_Serving directly the conte.png similarity index 100% rename from src/public/app/doc_notes/en/User Guide/User Guide/Shared notes/Serving directly the conte.png rename to src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/1_Serving directly the conte.png diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Shared notes/1_Serving directly the conte.png b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/Serving directly the conte.png similarity index 100% rename from src/public/app/doc_notes/en/User Guide/User Guide/Shared notes/1_Serving directly the conte.png rename to src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/Serving directly the conte.png diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/Serving directly the content o.md b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/Serving directly the content o.md new file mode 100644 index 000000000..50fa43c1c --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/Serving directly the content o.md @@ -0,0 +1,16 @@ +# Serving directly the content of a note +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. + +| | | +| --- | --- | +| ![](1_Serving directly the conte.png)

A note displayed as a web page (HTML) | ![](Serving directly the conte.png)

A note displayed as a raw format | + +## By adding an attribute to the note + +Simply add the `#shareRaw` attribute and the note will always be rendered _raw_ when accessed from the share URL. + +## By altering the URL + +Append `?raw` to the URL to display a note in its raw format regardless of whether the `#shareRaw` attribute is added on the note. + +![](Serving directly the conte.png) \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced topics/Custom resource providers.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced topics/Custom resource providers.html deleted file mode 100644 index e847d0808..000000000 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced topics/Custom resource providers.html +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - Custom resource providers - - - -
-

Custom resource providers

- -
-

A custom resource provider allows any file imported into Trilium (images, - fonts, stylesheets) to be publicly accessible via a URL.

-

A potential use case for this is to add embed a custom font alongside - a theme.

-

Steps for creating a custom resource provider

-
    -
  1. Import a file such as an image or a font into Trilium by drag & drop.
    2. -
  2. Select the file and go to the Owned Attributes section.
    3. -
  3. Add the label #customResourceProvider=hello.
    4. -
  4. To test if it is working, use a browser to navigate to <protocol>://<host>/custom/hello (where <protocol> is - either http or https based on your setup, and <host> is - the host or IP to your Trilium server instance). If you are running the - TriliumNext application without a server, use http://localhost:37840 as - the base URL.
    5. -
  5. If everything went well, at the previous step the browser should have - downloaded the file uploaded in the first step.
    6. -
-

Instead of hello, the name can be:

-
    -
  • A path, such as fonts/Roboto.ttf, which would be accessible - via <host>/custom/fonts/Roboto.ttf.
    • -
  • As a more advanced use case, a regular expression to match multiple routes, - such as hello/.* which will be accessible via /custom/hello/1, /custom/hello/2, /custom/hello/world, - etc.
    • -
-

Using it in a theme

-

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 #customResourceProvider=fonts/myfont.ttf attribute.

-

Then modify the theme CSS to point to:

@font-face {
-	font-family: customFont;
-	src: url("/custom/fonts/myfont.ttf");
-}
-
-div {
-	font-family: customFont;
-}
-
-
- - - \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/Custom-widget image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/Custom-widget image.png new file mode 100644 index 000000000..768dbdb6b Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/Custom-widget image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/bookmark-folder.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/bookmark-folder.png new file mode 100644 index 000000000..4cac45698 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/bookmark-folder.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/bookmarks.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/bookmarks.gif new file mode 100644 index 000000000..2fdba3f03 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/bookmarks.gif differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/bookmarks.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/bookmarks.png new file mode 100644 index 000000000..2d78ee1a1 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/bookmarks.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/button-script.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/button-script.png new file mode 100644 index 000000000..466ff32ec Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/button-script.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/canvas-note-image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/canvas-note-image.png new file mode 100644 index 000000000..4ad24adf4 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/canvas-note-image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/chrome-trilium-web-clipper.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/chrome-trilium-web-clipper.png new file mode 100644 index 000000000..f1ac0e4e0 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/chrome-trilium-web-clipper.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/code-note.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/code-note.png new file mode 100644 index 000000000..3e85223d3 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/code-note.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/create-clone.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/create-clone.gif new file mode 100644 index 000000000..88052f0ad Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/create-clone.gif differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/create-external-link.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/create-external-link.gif new file mode 100644 index 000000000..2990fdf61 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/create-external-link.gif differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/create-link-to-note.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/create-link-to-note.gif new file mode 100644 index 000000000..e2e2ab913 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/create-link-to-note.gif differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/custom-widget-image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/custom-widget-image.png new file mode 100644 index 000000000..768dbdb6b Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/custom-widget-image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/cut-to-subnote.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/cut-to-subnote.gif new file mode 100644 index 000000000..69c7ce4dc Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/cut-to-subnote.gif differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/dark-theme.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/dark-theme.png new file mode 100644 index 000000000..554fc628a Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/dark-theme.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/drag-and-drop.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/drag-and-drop.gif new file mode 100644 index 000000000..ba86530c0 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/drag-and-drop.gif differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/error-logs-export-subtree.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/error-logs-export-subtree.png new file mode 100644 index 000000000..3b9e7bf69 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/error-logs-export-subtree.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/error-logs-firefox-context.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/error-logs-firefox-context.png new file mode 100644 index 000000000..f1dc1861a Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/error-logs-firefox-context.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/hide-archived.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/hide-archived.png new file mode 100644 index 000000000..547891a6b Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/hide-archived.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/home-button.svg b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/home-button.svg new file mode 100644 index 000000000..2136cb48d --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/home-button.svg @@ -0,0 +1,18 @@ + + + + button + Created with Sketch. + + + + + + + + + + + + + \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/jump-to.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/jump-to.gif new file mode 100644 index 000000000..9521c9a8e Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/jump-to.gif differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/markdown-export-note.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/markdown-export-note.gif new file mode 100644 index 000000000..4162351fd Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/markdown-export-note.gif differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/markdown-export-subtree.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/markdown-export-subtree.gif new file mode 100644 index 000000000..a4cf33796 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/markdown-export-subtree.gif differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/markdown-file-import.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/markdown-file-import.gif new file mode 100644 index 000000000..1a3eba861 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/markdown-file-import.gif differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/markdown-inline-import.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/markdown-inline-import.gif new file mode 100644 index 000000000..b7265c6e9 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/markdown-inline-import.gif differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/math.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/math.gif new file mode 100644 index 000000000..810784d93 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/math.gif differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/mermaid.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/mermaid.png new file mode 100644 index 000000000..1c48d2aa6 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/mermaid.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/mobile-smartphone.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/mobile-smartphone.png new file mode 100644 index 000000000..43a04b896 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/mobile-smartphone.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/mobile-tablet.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/mobile-tablet.png new file mode 100644 index 000000000..aa18da05a Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/mobile-tablet.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/move-note-with-keyboard.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/move-note-with-keyboard.gif new file mode 100644 index 000000000..4f4227953 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/move-note-with-keyboard.gif differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/note-hoisting.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/note-hoisting.gif new file mode 100644 index 000000000..1bc019284 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/note-hoisting.gif differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/note-icon-change.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/note-icon-change.png new file mode 100644 index 000000000..b0133a689 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/note-icon-change.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/note-icon-gallery.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/note-icon-gallery.png new file mode 100644 index 000000000..c0cb7f031 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/note-icon-gallery.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/note-map.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/note-map.png new file mode 100644 index 000000000..ee7ef932a Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/note-map.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/note-revisions.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/note-revisions.png new file mode 100644 index 000000000..d2bfe1d4c Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/note-revisions.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/promoted-attributes-queen.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/promoted-attributes-queen.png new file mode 100644 index 000000000..3940c5239 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/promoted-attributes-queen.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/promoted-attributes.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/promoted-attributes.png new file mode 100644 index 000000000..2e40dcbb6 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/promoted-attributes.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/protecting-note.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/protecting-note.gif new file mode 100644 index 000000000..41f663532 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/protecting-note.gif differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/recent-notes.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/recent-notes.gif new file mode 100644 index 000000000..2914db2b7 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/recent-notes.gif differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/relation-map-dev-process.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/relation-map-dev-process.png new file mode 100644 index 000000000..20429151e Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/relation-map-dev-process.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/relation-map-family-demo.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/relation-map-family-demo.gif new file mode 100644 index 000000000..b66dc05f4 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/relation-map-family-demo.gif differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/relation-map-family.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/relation-map-family.png new file mode 100644 index 000000000..39788216a Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/relation-map-family.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/saved-search-image.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/saved-search-image.gif new file mode 100644 index 000000000..6f9433b9f Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/saved-search-image.gif differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/saved-search.gif b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/saved-search.gif new file mode 100644 index 000000000..051b1cd6e Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/saved-search.gif differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/screenshot.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/screenshot.png new file mode 100644 index 000000000..479906b1b Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/screenshot.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/share-multiple-notes-web.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/share-multiple-notes-web.png new file mode 100644 index 000000000..434d44ef0 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/share-multiple-notes-web.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/share-single-note-web.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/share-single-note-web.png new file mode 100644 index 000000000..c03697e67 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/share-single-note-web.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/share-single-note.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/share-single-note.png new file mode 100644 index 000000000..4c1ea4297 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/share-single-note.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/shared-list.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/shared-list.png new file mode 100644 index 000000000..1308b502c Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/shared-list.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/split.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/split.png new file mode 100644 index 000000000..bb58e1834 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/split.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/steel-blue.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/steel-blue.png new file mode 100644 index 000000000..9085c3d17 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/steel-blue.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/sync-config.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/sync-config.png new file mode 100644 index 000000000..1c16d3267 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/sync-config.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/sync-in-progress.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/sync-in-progress.png new file mode 100644 index 000000000..59dd79d29 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/sync-in-progress.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/sync-init.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/sync-init.png new file mode 100644 index 000000000..8f0d7aa81 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/sync-init.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/task-manager.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/task-manager.png new file mode 100644 index 000000000..e83574548 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/task-manager.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/template-create-instance-n.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/template-create-instance-n.png new file mode 100644 index 000000000..b89f28afc Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/template-create-instance-n.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/template.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/template.png new file mode 100644 index 000000000..be0a9f085 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/template.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/text-notes-formatting-bloc.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/text-notes-formatting-bloc.png new file mode 100644 index 000000000..5414b9bc7 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/text-notes-formatting-bloc.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/text-notes-formatting-inli.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/text-notes-formatting-inli.png new file mode 100644 index 000000000..5d18495f9 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/text-notes-formatting-inli.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/text-notes-image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/text-notes-image.png new file mode 100644 index 000000000..d88b6dacc Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Attachments/text-notes-image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/1_UI Elements_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/1_UI Elements_image.png new file mode 100644 index 000000000..37a565d3f Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/1_UI Elements_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/2_Zen mode_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/1_Zen mode_image.png similarity index 100% rename from src/public/app/doc_notes/en/User Guide/User Guide/New Features/2_Zen mode_image.png rename to src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/1_Zen mode_image.png diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/3_Zen mode_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/2_Zen mode_image.png similarity index 100% rename from src/public/app/doc_notes/en/User Guide/User Guide/New Features/3_Zen mode_image.png rename to src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/2_Zen mode_image.png diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/4_Zen mode_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/3_Zen mode_image.png similarity index 100% rename from src/public/app/doc_notes/en/User Guide/User Guide/New Features/4_Zen mode_image.png rename to src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/3_Zen mode_image.png diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/5_Zen mode_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/4_Zen mode_image.png similarity index 100% rename from src/public/app/doc_notes/en/User Guide/User Guide/New Features/5_Zen mode_image.png rename to src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/4_Zen mode_image.png diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/6_Zen mode_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/5_Zen mode_image.png similarity index 100% rename from src/public/app/doc_notes/en/User Guide/User Guide/New Features/6_Zen mode_image.png rename to src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/5_Zen mode_image.png diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/7_Zen mode_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/6_Zen mode_image.png similarity index 100% rename from src/public/app/doc_notes/en/User Guide/User Guide/New Features/7_Zen mode_image.png rename to src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/6_Zen mode_image.png diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/Zen mode_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/7_Zen mode_image.png similarity index 100% rename from src/public/app/doc_notes/en/User Guide/User Guide/New Features/Zen mode_image.png rename to src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/7_Zen mode_image.png diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Import & Export/Evernote.md b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Import & Export/Evernote.md new file mode 100644 index 000000000..26136cb78 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Import & Export/Evernote.md @@ -0,0 +1,18 @@ +# Evernote +Trilium can import ENEX files which are used by Evernote for backup/export. One ENEX file represents content (notes and resources) of one notebook. + +## Export ENEX from Evernote + +To export ENEX file, you need to have a _legacy_ desktop version of Evernote (i.e. not web/mobile). Right click on notebook and select export and follow the wizard. + +## Import ENEX in Trilium + +Once you have ENEX file, you can import it to Trilium. Right click on some note (to which you want to import the file), click on "Import" and select the ENEX file. + +After importing the ENEX file, go over the imported notes and resources to be sure the import went well, and you didn't lose any data. + +## Limitations + +All resources (except for images) are created as note's attachments. + +HTML inside ENEX files is not exactly valid so some formatting maybe broken or lost. You can report major problems into [Trilium issue tracker](https://github.com/TriliumNext/Notes/issues). %%{WARNING}%% \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Import & Export/Markdown.md b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Import & Export/Markdown.md new file mode 100644 index 000000000..0a7a96142 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Import & Export/Markdown.md @@ -0,0 +1,41 @@ +# Markdown +Trilium Notes supports importing Markdown restricted to the [CommonMark specification](https://spec.commonmark.org/current/) (where [tables are not supported](https://github.com/TriliumNext/Notes/issues/2026)) + +## Import + +### Clipboard import + +If you want to import just a chunk of markdown from clipboard, you can do it from editor block menu: + +![](../../Attachments/markdown-inline-import.gif) + +### File import + +You can also import Markdown files from files: + +* single markdown file (with .md extension) +* whole tree of markdown files (packaged into [.zip](https://en.wikipedia.org/wiki/Tar_\(computing\)) archive) + * Markdown files need to be packaged into ZIP archive because browser can't read directories, only single files. + * You can use e.g. [7-zip](https://www.7-zip.org) to package directory of markdown files into the ZIP file + +\[\[gifs/markdown-file-import.gif\]\] + +![](../../Attachments/markdown-file-import.gif) + +## Export + +### Subtree export + +You can export whole subtree to ZIP archive which will have directory structured modelled after subtree structure: + +![](../../Attachments/markdown-export-subtree.gif) + +### Single note export + +If you want to export just single note without its subtree, you can do it from Note actions menu: + +![](../../Attachments/markdown-export-note.gif) + +### Exporting protected notes + +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. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Import & Export/OneNote.md b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Import & Export/OneNote.md new file mode 100644 index 000000000..0ccc24cdf --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Import & Export/OneNote.md @@ -0,0 +1,51 @@ +# OneNote +**This page describes a method to migrate via EverNote Legacy, but this app is no longer available/working.** + +## Prep Onenote notes for best compatibility + +* Remove Onenote Tags and replace with Emoji if possible (Onenote Tags will get imported into trilium as an image which clutters the Trilium tree somewhat) +* Make sure to use Onenote headings where applicable (These will be carried over correctly into Trilium) +* Remove extra whitespace in Onenote (Whitespace seems to be more noticible in Trilium, so removing it now will make it look nicer in trilium) +* If possible, try to avoid very long Onenote pages. Trilium works best with shorter concise pages with any number of sub or (sub-sub...) pages. +* Make sure numbered lists don't have unusual spaces between items in the list (Sometimes the numbered list will start at 1 again in Trilum if there is an extra space in the list in OneNote). + +## Migration Procedure + +### Import into Evernote from OneNote: + +* Install [Evernote Legacy](https://web.archive.org/web/20230327110646/https://help.evernote.com/hc/en-us/articles/360052560314). Current versions of Evernote do not have this functionality. (Requires Evernote account, but import works without internet connection - be sure to NOT sync notes to Evernote!). +* In evernote navigate to File > Import > Onenote > Notebook > Section > OK + +If exporting all sections at a time, they will not be grouped in folders - they will all be added to a single folder, but the order will be kept, so you can re-group into folders after importing to Trilium + +### Export from Evernote + +* Right click on the created notebook in Evernote and choose "Export Notes…" +* Use the default export format of .enex + +### Cleanup enex file (optional) + +* If the Onenote header (that is at the top of each Onenote page) is not desired, you can use the following regex to remove them in a text editor like VsCode: + + Find (using regex): `. Keyboard shortcuts. Using `global:` prefix, you can assign a shortcut which will work even without Trilium being in focus (requires app restart to take effect). + +## Note navigation + +* `UP`, `DOWN` - go up/down in the list of notes, `CTRL-SHIFT-UP` and `CTRL-SHIFT-DOWN` work also from editor +* `LEFT`, `RIGHT` - collapse/expand node +* `ALT+LEFT`, `ALT+RIGHT` - go back / forwards in the history +* `CTRL+J` - show ["Jump to" dialog](Navigation/Note%20Navigation.md) +* `CTRL+.` - scroll to current note (useful when you scroll away from your note or your focus is currently in the editor) +* `BACKSPACE` - jumps to parent note +* `ALT+C` - collapse whole note tree +* `ALT+-` (alt with minus sign) - collapse subtree (if some subtree takes too much space on tree pane you can collapse it) +* you can define a [label](../Advanced%20Usage/Attributes.md) `#keyboardShortcut` with e.g. value `Ctrl+I`. Pressing this keyboard combination will then bring you to the note on which it is defined. Note that Trilium must be reloaded/restarted (Ctrl+R) for changes to be in effect. + +See demo of some of these features in [note navigation](Navigation/Note%20Navigation.md). + +## Tabs + +* `CTRL+click` - (or middle mouse click) on note link opens note in a new tab + +Only in desktop (electron build): + +* `CTRL+T` - opens empty tab +* `CTRL+W` - closes active tab +* `CTRL+Tab` - activates next tab +* `CTRL+Shift+Tab` - activates previous tab + +## Creating notes + +* `CTRL+O` - creates new note after the current note +* `CTRL+P` - creates new sub-note into current note +* `F2` - edit [prefix](Navigation/Note%20Navigation.md) of current note clone + +## Moving / cloning notes + +* `CTRL+UP`, `CTRL+DOWN` - move note up/down in the note list +* `CTRL+LEFT` - move note up in the note tree +* `CTRL+RIGHT` - move note down in the note tree +* `SHIFT+UP`, `SHIFT+DOWN` - multi-select note above/below +* `CTRL+A` - select all notes in the current level +* `SHIFT+click` - multi select note which you clicked on +* `CTRL+C` - copies current note (or current selection) into clipboard (used for [cloning](Note/Cloning%20Notes.md) +* `CTRL+X` - cuts current (or current selection) note into clipboard (used for moving notes) +* `CTRL+V` - pastes note(s) as sub-note into current note (which is either move or clone depending on whether it was copied or cut into clipboard) +* `DEL` - delete note / sub-tree + +## Editing notes + +Trilium uses CKEditor 5 for the [text notes](../Note%20Types/Text.md) and CodeMirror 5 for [code notes](../Advanced%20Usage/Code%20Notes.md). Check the documentation of these projects to see all their built-in keyboard shortcuts. + +* `ALT-F10` - bring up inline formatting toolbar (arrow keys `<-`,`->` to navigate, `ENTER` to apply) +* `ALT-F10` - again to bring up block formatting toolbar +* `ENTER` in tree pane switches from tree pane into note title. Enter from note title switches focus to text editor. `CTRL+.` switches back from editor to tree pane. +* `CTRL+K` - create / edit [external link](Note/Links.md) +* `CTRL+L` - create [internal (note) link](Note/Links.md) +* `ALT+T` - inserts current date and time at caret position +* `CTRL+.` - jump away from the editor to tree pane and scroll to current note + +## Runtime shortcuts + +These are hooked in Electron to be similar to native browser keyboard shortcuts. + +* `F5`, `CTRL-R` - reloads trilium frontend +* `CTRL+SHIFT+I` - show developer tools +* `CTRL+F` - show search dialog +* `CTRL+-` - zoom out +* `CTRL+=` - zoom in + +## Other + +* `ALT+O` - show SQL console (use only if you know what you're doing) +* `ALT+M` - distraction-free mode - display only note editor, everything else is hidden +* `F11` - toggle full screen +* `CTRL+S` - toggle [search](Navigation/Search.md) form in tree pane +* `ALT+A` - show note [attributes](../Advanced%20Usage/Attributes.md) dialog \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/1_Note Navigation_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/1_Note Navigation_image.png new file mode 100644 index 000000000..2ea269012 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/1_Note Navigation_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/1_Workspace_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/1_Workspace_image.png new file mode 100644 index 000000000..ae10ee7cb Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/1_Workspace_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Bookmarks.md b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Bookmarks.md new file mode 100644 index 000000000..659d031fc --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Bookmarks.md @@ -0,0 +1,12 @@ +# Bookmarks +To easily access selected notes, you can bookmark them. See demo: + +![](../../Attachments/bookmarks.gif) + +## Bookmark folder + +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: + +![](../../Attachments/bookmark-folder.png) + +To do this, you need to add a `#bookmarkFolder` label to the note. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Note Hoisting.md b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Note Hoisting.md new file mode 100644 index 000000000..40c7b1dbd --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Note Hoisting.md @@ -0,0 +1,8 @@ +# Note Hoisting +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: + +![](../../Attachments/note-hoisting.gif) + +In addition to showing only this subtree, this also narrows both full text search and [“jump to note”](Note%20Navigation.md) to just notes present in hoisted subtree. + +See also [Workspace](Workspace.md) which extends this feature. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Note Navigation.md b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Note Navigation.md new file mode 100644 index 000000000..16d4a9a7f --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Note Navigation.md @@ -0,0 +1,26 @@ +# Note Navigation +One of the Trilium's goals is to provide fast and comfortable navigation between notes. + +## Backwards and forward + +You can use alt-left and alt-right to move back and forward in history of viewed pages. + +This works identically to browser backwards / forwards, it's actually using built-in browser support for this. + +![](Note Navigation_image.png) + +## Jump to note + +This is useful to quickly find and view arbitrary note - click on `Jump to` button on the top or press `CTRL-J`. Then type part of the note name and autocomplete will help you pick the desired note. + +![](../../Attachments/jump-to.gif) + +### Recent notes + +Jump to note also has the ability to show the list of recently viewed / edited notes and quickly jump to it. + +To access this functionality, click on `Jump to` button on the top. By default, (when nothing is entered into autocomplete), this dialog will show the list of recent notes. + +Alternatively you can click on the "time" icon on the right. + +![](../../Attachments/recent-notes.gif) \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Note Navigation_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Note Navigation_image.png new file mode 100644 index 000000000..2ea269012 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Note Navigation_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Search.md b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Search.md new file mode 100644 index 000000000..a45ab9d5b --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Search.md @@ -0,0 +1,137 @@ +# Search +## Local Search + +Local search allows you to search within the currently displayed note. To initiate a local search, press CTRL-F. If using a web browser, this will be handled by the browser's native search functionality. In the desktop (electron) version, a separate dialog will apear. + +## Note Search + +Note search enables you to find notes by searching for text in the title, content, or [attributes](../../Advanced%20Usage/Attributes.md) 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. + +To search for notes, click on the magnifying glass icon on the toolbar or press the `CTRL-S` keyboard [shortcut](../Keyboard%20Shortcuts.md). + +### Simple Note Search Examples + +* `rings tolkien`: Full-text search to find notes containing both "rings" and "tolkien". +* `"The Lord of the Rings" Tolkien`: Full-text search where "The Lord of the Rings" must match exactly. +* `note.content *=* rings OR note.content *=* tolkien`: Find notes containing "rings" or "tolkien" in their content. +* `towers #book`: Combine full-text and attribute search to find notes containing "towers" and having the "book" label. +* `towers #book or #author`: Search for notes containing "towers" and having either the "book" or "author" label. +* `towers #!book`: Search for notes containing "towers" and not having the "book" label. +* `#book #publicationYear = 1954`: Find notes with the "book" label and "publicationYear" set to 1954. +* `#genre *=* fan`: Find notes with the "genre" label containing the substring "fan". Additional operators include `*=*` for "contains", `=*` for "starts with", `*=` for "ends with", and `!=` for "is not equal to". +* `#book #publicationYear >= 1950 #publicationYear < 1960`: Use numeric operators to find all books published in the 1950s. +* `#dateNote >= TODAY-30`: A "smart search" to find notes with the "dateNote" label within the last 30 days. Supported smart values include NOW +- seconds, TODAY +- days, MONTH +- months, YEAR +- years. +* `~author.title *=* Tolkien`: Find notes related to an author whose title contains "Tolkien". +* `#publicationYear %= '19[0-9]{2}'`: Use the '%=' operator to match a regular expression (regex). This feature has been available since Trilium 0.52. + +### Advanced Use Cases + +* `~author.relations.son.title = 'Christopher Tolkien'`: 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: + * Books + * Lord of the Rings + * label: “book” + * relation: “author” points to “J. R. R. Tolkien” note + * People + * J. R. R. Tolkien + * relation: “son” points to "Christopher Tolkien" note + * Christopher Tolkien +* `~author.title *= Tolkien OR (#publicationDate >= 1954 AND #publicationDate <= 1960)`: Use boolean expressions and parentheses to group expressions. Note that expressions starting with a parenthesis need an "expression separator sign" (# or ~) prepended. +* `note.parents.title = 'Books'`: Find notes with a parent named "Books". +* `note.parents.parents.title = 'Books'`: Find notes with a grandparent named "Books". +* `note.ancestors.title = 'Books'`: Find notes with an ancestor named "Books". +* `note.children.title = 'sub-note'`: Find notes with a child named "sub-note". + +### Search with Note Properties + +Notes have properties that can be used in searches, such as `noteId`, `dateModified`, `dateCreated`, `isProtected`, `type`, `title`, `text`, `content`, `rawContent`, `ownedLabelCount`, `labelCount`, `ownedRelationCount`, `relationCount`, `ownedRelationCountIncludingLinks`, `relationCountIncludingLinks`, `ownedAttributeCount`, `attributeCount`, `targetRelationCount`, `targetRelationCountIncludingLinks`, `parentCount`, `childrenCount`, `isArchived`, `contentSize`, `noteSize`, and `revisionCount`. + +These properties can be accessed via the `note.` prefix, e.g., `note.type = code AND note.mime = 'application/json'`. + +### Order by and Limit + +``` +#author=Tolkien orderBy #publicationDate desc, note.title limit 10 +``` + +This example will: + +1. Find notes with the author label "Tolkien". +2. Order the results by `publicationDate` in descending order. +3. Use `note.title` as a secondary ordering if publication dates are equal. +4. Limit the results to the first 10 notes. + +### Negation + +Some queries can only be expressed with negation: + +``` +#book AND not(note.ancestor.title = 'Tolkien') +``` + +This query finds all book notes not in the "Tolkien" subtree. + +## Under the Hood + +### Label and Relation Shortcuts + +The "full" syntax for searching by labels is: + +``` +note.labels.publicationYear = 1954 +``` + +For relations: + +``` +note.relations.author.title *=* Tolkien +``` + +However, common label and relation searches have shortcut syntax: + +``` +#publicationYear = 1954 +#author.title *=* Tolkien +``` + +### Separating Full-Text and Attribute Parts + +Search syntax allows combining full-text search with attribute-based search seamlessly. For example, `tolkien #book` contains: + +1. Full-text tokens - `tolkien` +2. Attribute expressions - `#book` + +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: + +``` +"note.txt" +\#hash +#myLabel = 'Say "Hello World"' +``` + +### Escaping Special Characters + +Special characters can be enclosed in quotes or escaped with a backslash to be used in full-text search: + +``` +"note.txt" +\#hash +#myLabel = 'Say "Hello World"' +``` + +Three types of quotes are supported: single, double, and backtick. + +### Type Coercion + +Label values are technically strings but can be coerced for numeric comparisons: + +``` +note.dateCreated =* '2019-05' +``` + +This finds notes created in May 2019. Numeric operators like `#publicationYear >= 1960` convert string values to numbers for comparison. + +## Auto-Trigger Search from URL + +You can open Trilium and automatically trigger a search by including the search [url encoded](https://meyerweb.com/eric/tools/dencoder/) string in the URL: + +`http://localhost:8080/#?searchString=abc` \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Tree Concepts.md b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Tree Concepts.md new file mode 100644 index 000000000..bbb241ec8 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Tree Concepts.md @@ -0,0 +1,24 @@ +# Tree Concepts +This page explains the basic concepts related to the tree structure of notes in TriliumNext. + +## Note + +A note is the central entity in TriliumNext. For more details, see [Note](../Note.md). + +## Branch + +A branch describes the placement of a note within the note tree. Essentially, it is a tuple of `parentNoteId` and `noteId`, indicating that the given note is placed as a child under the specified parent note. + +Each note can have multiple branches, meaning any note can be placed in multiple locations within the tree. This concept is referred to as " [cloning](../Note/Cloning%20Notes.md)." + +## Prefix + +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. + +To edit a prefix, right-click on the note in the tree pane and select "Edit branch prefix." + +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. + +## Subtree + +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. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Tree Manipulation.md b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Tree Manipulation.md new file mode 100644 index 000000000..b244dafa2 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Tree Manipulation.md @@ -0,0 +1,19 @@ +# Tree Manipulation +This page explains how to manipulate the note tree in TriliumNext, focusing on moving notes. + +## Drag and Drop + +![Drag and drop example](../../Attachments/drag-and-drop.gif)You can easily rearrange the note tree by dragging and dropping notes, as demonstrated in the example above. + +## Keyboard Manipulation + +![Example of using keyboard keys to move a note](../../Attachments/move-note-with-keyboard.gif)Trilium offers efficient keyboard-based manipulation using the following [shortcuts](../Keyboard%20Shortcuts.md): + +* `CTRL-UP` and `CTRL-DOWN`: Move the note up or down in the order. +* `CTRL-LEFT`: Move the note up in the hierarchy by changing its parent to the note's grandparent. +* `CTRL-RIGHT`: 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). +* `LEFT` and `RIGHT`: Expand and collapse a sub-tree. + +## Context Menu + +You can also move notes using the familiar cut and paste functions available in the context menu, or with the associated keyboard [shortcuts](../Keyboard%20Shortcuts.md): `CTRL-C` ( [copy](../Note/Cloning%20Notes.md)), `CTRL-X` (cut) and `CTRL-V` (paste). \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Workspace.md b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Workspace.md new file mode 100644 index 000000000..486913e8a --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Workspace.md @@ -0,0 +1,22 @@ +# Workspace +Workspace is a concept built up on top of [note hoisting](Note%20Hoisting.md). 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. + +So far workspace consists of these features: + +* [note hoisting](Note%20Hoisting.md) - you can "zoom" into a workspace subtree to focus only on the relevant notes +* easy entering of workspace:  + + ![](1_Workspace_image.png) + +* visual identification of workspace in tabs: + ![](Workspace_image.png) + +### How to use workspaces + +Let's say you have identified the workspaces and their subtrees. Define on the root of this subtree following labels: + +* `#workspace` - Marks this note as a workspace, button to enter the workspace is controlled by this +* `#workspaceIconClass` - controls the box icon to be displayed in the tree and tabs, example `bx bx-home`. See [https://boxicons.com/](https://boxicons.com/) +* `#workspaceTabBackgroundColor` - Background color of the tab, use any CSS color format, e.g. "lightblue" or "#ddd". See [https://www.w3schools.com/cssref/css\_colors.asp](https://www.w3schools.com/cssref/css_colors.asp). +* `#workspaceCalendarRoot` - marking a note with this label will define a new per-workspace calendar. If there's no such note, the global calendar will be used. +* `#workspaceTemplate` - This note will appear in the selection of available templates when creating a new note, but only when you are currently hoisted into a workspace containing this template. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Workspace_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Workspace_image.png new file mode 100644 index 000000000..2401cf083 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Workspace_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note.md b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note.md new file mode 100644 index 000000000..463614fb3 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note.md @@ -0,0 +1,43 @@ +# Note +Note is a central entity in Trilium. Main attributes of note are title and content. + +### Note types + +* [text note](../Note%20Types/Text.md) - this is default note type which allows you to put rich text, images etc. +* [code note](../Advanced%20Usage/Code%20Notes.md) - some kind of formal code, typically programming language (e.g. JavaScript) or data structure (e.g. JSON) +* [image note](https://github.com/TriliumNext/Notes/wiki/Images) - represents single image +* file note - represents uploaded file (e.g. docx MS Word document). +* render HTML note - this works as an output screen of attached [scripts](../Advanced%20Usage/Code%20Notes/Scripts.md) +* [saved search](../Note%20Types/Saved%20Search.md) note - contains saved search query and dynamically displays result of the search as its sub-notes +* [relation map](../Advanced%20Usage/Relation%20Map.md) note - visualizes notes and their relations +* [book note](../Note%20Types/Book.md) - displays its children notes, useful for reading many short notes +* mermaid - create diagrams and flowcharts using [mermaid.js ↗](https://github.com/mermaid-js/mermaid) +* [canvas note](#root/fKYGY3OOo5d1) - allows hand drawn notes and basic diagraming on an infinite canvas using [excalidraw ↗](https://github.com/excalidraw/excalidraw) + +In Trilium there's no specific "folder" note type. Any note can have children and thus be a folder. + +### Root note + +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. + +### Tree structure + +Importantly, note itself doesn't carry information on its placement in note tree. See [cloning](Note/Cloning%20Notes.md) for details. + +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. + +### Deleting / undeleting notes + +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. + +Within (by default) 7 days, it is possible to undelete these soft-deleted notes - open Recent Changes 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. + +Clicking an undelete will recover the note, it's 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. + +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. + +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 [backup](../Installation%20%26%20Setup/Backup.md)). + +## See also + +* [Read-only note](Note/Read-Only%20Notes.md) \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/Export as PDF_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/1_Export as PDF_image.png similarity index 100% rename from src/public/app/doc_notes/en/User Guide/User Guide/New Features/Export as PDF_image.png rename to src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/1_Export as PDF_image.png diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/1_Images_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/1_Images_image.png new file mode 100644 index 000000000..f8c5cf48f Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/1_Images_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/2_Right-to-left text notes_i.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/1_Right-to-Left Support_imag.png similarity index 100% rename from src/public/app/doc_notes/en/User Guide/User Guide/New Features/2_Right-to-left text notes_i.png rename to src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/1_Right-to-Left Support_imag.png diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/3_Right-to-left text notes_i.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/2_Right-to-Left Support_imag.png similarity index 100% rename from src/public/app/doc_notes/en/User Guide/User Guide/New Features/3_Right-to-left text notes_i.png rename to src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/2_Right-to-Left Support_imag.png diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/4_Right-to-left text notes_i.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/3_Right-to-Left Support_imag.png similarity index 100% rename from src/public/app/doc_notes/en/User Guide/User Guide/New Features/4_Right-to-left text notes_i.png rename to src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/3_Right-to-Left Support_imag.png diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/Right-to-left text notes_i.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/4_Right-to-Left Support_imag.png similarity index 100% rename from src/public/app/doc_notes/en/User Guide/User Guide/New Features/Right-to-left text notes_i.png rename to src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/4_Right-to-Left Support_imag.png diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Archived Notes.md b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Archived Notes.md new file mode 100644 index 000000000..da64e051a --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Archived Notes.md @@ -0,0 +1,10 @@ +# Archived Notes +Archived notes are notes which have `archived` [attribute](../../Advanced%20Usage/Attributes.md) - either directly or [inherited](../../Advanced%20Usage/Attributes/Attribute%20Inheritance.md). + +Such notes are then by default not shown in the autocomplete and in the full text [search](../Navigation/Search.md). + +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. + +You can control whether archived notes are displayed in the note tree with a setting: + +![](../../Attachments/hide-archived.png) \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Attachments.md b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Attachments.md new file mode 100644 index 000000000..20e75b8ed --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Attachments.md @@ -0,0 +1,8 @@ +# Attachments +A [note](../Note.md) in Trilium can _own_ one or more attachments, which can be either images or files. These attachments can be displayed or linked within the note that owns them. + +This can be especially useful to include dependencies for your [scripts](../../Advanced%20Usage/Code%20Notes/Scripts.md). The [Weight Tracker](../../Advanced%20Usage/Advanced%20Showcases/Weight%20Tracker.md) shows how to use [chartjs](https://chartjs.org/) which is attached to the [script note](#root/HcUYTojFohtb). + +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. + +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. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Cloning Notes.md b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Cloning Notes.md new file mode 100644 index 000000000..dde03a54c --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Cloning Notes.md @@ -0,0 +1,66 @@ +# Cloning Notes +## Motivation + +Trilium's core feature is the ability to structure your notes into hierarchical tree-like structure. + +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. + +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: + +* Technology + * Programming + * Kotlin + * JavaScript + * Operating systems + * Linux + * Windows + +Now, I'm starting to learn about [Bash](https://en.wikipedia.org/wiki/Bash_\(Unix_shell\)) 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. + +## Solution + +The solution to the problem shown above is to allow notes to have multiple parents. + +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. + +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. + +Here's the final structure with cloning: + +* Technology + * Programming + * Kotlin + * JavaScript + * Bash + * some sub-notes ... + * Operating systems + * Linux + * Bash + * some sub-notes ... + * Windows + +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. + +### Demo + +![](../../Attachments/create-clone.gif) + +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 CTRL+C and CTRL+V [keyboard shortcuts](../Keyboard%20Shortcuts.md). + +As seen in the demo, you can view the list of all available clones in the "Note Paths" tab in the Ribbon toolbar. + +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. + +## Prefix + +Since notes can be categorized into multiple places, it's recommended to choose a generalized name that fits into all locations instead of something more specific to avoid confusion. 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. The prefix is location specific, so it's displayed only in the tree pane. + +## Deleting notes/clones + +With clones, it might not be immediately obvious how deleting works. + +If you try to delete a note, it works like this: + +1. if the note has multiple clones, delete just this clone and leave the actual note (and its other clones) as it is. +2. if this note doesn't have any other clones, delete the note + * Run the whole process starting with 1. on all note's children notes \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Export as PDF.md b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Export as PDF.md new file mode 100644 index 000000000..5ecbe3e72 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Export as PDF.md @@ -0,0 +1,24 @@ +# Export as PDF +![](1_Export as PDF_image.png) + +Screenshot of the note contextual menu indicating the “Export as PDF” option. + +On the desktop application of Trilium it is possible to export a note as PDF. On the server or PWA (mobile), the option is not available due to technical constraints and it will be hidden. + +To print a note, select the ![](Export as PDF_image.png)button to the right of the note and select _Export as PDF_. + +Afterwards you will be prompted to select where to save the PDF file. Upon confirmation, the resulting PDF will be opened automatically using the default/system application configured for PDFs. + +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 [report the issue](#root/OeKBfN6JbMIq/jRV1MPt4mNSP/hrC6xn7hnDq5). In this case, it's best to offer a sample note (click on the ![](Export as PDF_image.png)button, select Export note → This note and all of its descendants → HTML in ZIP archive). Make sure not to accidentally leak any personal information. + +## Landscape mode + +When exporting to PDF, there are no customizable settings such as page orientation, size, etc. However, it is possible to specify a given note to be printed as a PDF in landscape mode by adding the `#printLandscape` attribute to it (see [\[missing note\]](#root/9QRytp0ZYFIf/PnO38wN0ffOA)). + +## Page size + +By default, the resulting PDF will be in Letter format. It is possible to adjust it to another page size via the `#printPageSize` attribute, with one of the following values: `A0`, `A1`, `A2`, `A3`, `A4`, `A5`, `A6`, `Legal`, `Letter`, `Tabloid`, `Ledger`. + +## Keyboard shortcut + +It's possible to trigger the export to PDF from the keyboard by going to _Keyboard shortcuts_ and assigning a key combination for the `exportAsPdf` action. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/1_Export as PDF_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Export as PDF_image.png similarity index 100% rename from src/public/app/doc_notes/en/User Guide/User Guide/New Features/1_Export as PDF_image.png rename to src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Export as PDF_image.png diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Images.md b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Images.md new file mode 100644 index 000000000..8ac093a70 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Images.md @@ -0,0 +1,22 @@ +# Images +Trilium supports storing and displaying images. Supported formats are JPEG, PNG and GIF. + +An image can be uploaded in the form of note's [attachment](Attachments.md) or as a standalone [note](../Navigation/Tree%20Concepts.md) placed into the [note tree](../Navigation/Tree%20Concepts.md). Its reference can be copied into a text note, in order to display it in the text itself. + +## Uploading images + +To add an image to the note, simply drag it from file explorer onto the note editor inside Trilium and the image will be uploaded. + +![](Images_image.png) + +Alternatively you can click on block toolbar and then on "Insert image": + +![](1_Images_image.png) + +You can also copy and paste an image from web - the image will be (asynchronously) downloaded and embedded. + +## Compression + +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 Options -> Other. + +If you want to save images in their original resolution, it is recommended to save them as attachment to note (top-right "Note actions -> Import files"). \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Images_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Images_image.png new file mode 100644 index 000000000..0167e759b Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Images_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Links.md b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Links.md new file mode 100644 index 000000000..522e3f161 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Links.md @@ -0,0 +1,33 @@ +# Links +## External links + +External link is general web link targeting some external web resource - e.g. [https://en.wikipedia.org/wiki/South\_China\_Sea](https://en.wikipedia.org/wiki/South_China_Sea) is an external link to one Wikipedia page. + +External links are done through CKEditor native links. To create an external link, select text and press `CTRL-K` or wait for the "balloon" to appear and click link icon there. + +![](../../Attachments/create-external-link.gif) + +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". + +## Internal links to notes + +Links to internal notes are created a bit differently. To create link to note at current cursor position, press `CTRL-L`. + +In the dialog you can see radio button to choose from different types of linking: + +* link title mirrors the note's current title - this is sometimes also called "reference link". Title of such links cannot be changed, instead it is always mirroring the title of linked note. This way the link title is never outdated +* link title can be changed arbitrarily - this is the traditional hyperlink - you link to a particular note and can choose the link title + +![](../../Attachments/create-link-to-note.gif) + +You can follow the note link by double clicking it. + +Alternatively if you only wish to quickly preview the content, you can hover over the link and will see read only preview. + +### In-place linking + +Trilium also provides "inline" linking - type `@` and you'll see an autocomplete, just type few characters from the desired note title, press enter and you have a link. + +## Note map + +Trilium provides a visualisation of incoming and outgoing links for a particular note. See [note map](../../Advanced%20Usage/Note%20Map.md) for details. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Note Icons.md b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Note Icons.md new file mode 100644 index 000000000..dd4e696d1 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Note Icons.md @@ -0,0 +1,6 @@ +# Note Icons +Icons are useful for distinguishing notes. At the technical level, they are set by the `**iconClass**` attribute which adds a CSS class to the note. For example `#iconClass="bx bx-calendar"` will show a calendar instead of the default page or folder icon. Looking up and remembering the css class names is not necessary. While editing a note, click on the icon next to the title to bring up a chooser gallery: + +![change note icon](../../Attachments/note-icon-change.png) + +![note icon gallery](../../Attachments/note-icon-gallery.png) \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Note Revisions.md b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Note Revisions.md new file mode 100644 index 000000000..6dbfb9673 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Note Revisions.md @@ -0,0 +1,20 @@ +# Note Revisions +Trilium supports seamless versioning of notes by storing snapshots ("revisions") of notes at regular intervals. + +## Note Revisions Snapshot Interval + +Time interval of taking note snapshot is configurable in the Options -> Other dialog. This provides a tradeoff between more revisions and more data to store. + +To turn off note versioning for a particular note (or subtree), add `disableVersioning` [label](../../Advanced%20Usage/Attributes.md)to the note. + +## Note Revision Snapshots Limit + +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 `versioningLimit=X` label. + +The note limit will not take effect immediately; it will only apply when the note is modified. + +You can click the **Erase excess revision snapshots now** button to apply the changes immediately. + +Note revisions can be accessed through the button on the right of ribbon toolbar. + +![](../../Attachments/note-revisions.png) \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Protected Notes.md b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Protected Notes.md new file mode 100644 index 000000000..2b74cdefb --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Protected Notes.md @@ -0,0 +1,48 @@ +# Protected Notes +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: + +* **Encryption:** 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 [database](../../Advanced%20Usage/Database.md), they won't be able to read your encrypted notes. +* **Time-limited access:** 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. + * 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. +* **Protection scope:** 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. + +## Using Protected Notes + +By default, notes are unprotected. To protect a note, simply click on the shield icon next to the note's title, as shown here: + +![example animation of unlocking protected notes](../../Attachments/protecting-note.gif) + +## What is Encrypted? + +Trilium encrypts the data within protected notes but not their metadata. Specifically: + +**Encrypted:** + +* Note title +* Note content +* Images +* File attachments + +**Not encrypted:** + +* Note structure (i.e., it remains visible that there are protected notes) +* Metadata, such as the last modified date +* [Attributes](../../Advanced%20Usage/Attributes.md) + +## Encryption Details + +The following steps outline how encryption and decryption work in Trilium: + +1. The user enters a password. +2. The password is passed through the [scrypt](https://en.wikipedia.org/wiki/Scrypt) algorithm along with a "password verification" [salt](https://en.wikipedia.org/wiki/Salt_\(cryptography\)) to confirm that the password is correct. +3. The password is then processed again through scrypt with an "encryption" salt, which generates a hash. + * Scrypt is used for [key stretching](https://en.wikipedia.org/wiki/Key_stretching) to make the password harder to guess. +4. The generated hash is used to decrypt the actual _data encryption key_. + * The data encryption key is encrypted using [AES-128](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard) with a random [IV](https://en.wikipedia.org/wiki/Initialization_vector). + * The data encryption key is randomly generated during the [database](../../Advanced%20Usage/Database.md) initialization and remains constant throughout the document’s lifetime. When the password is changed, only this key is re-encrypted. +5. The data encryption key is then used to decrypt the actual content of the note, including its title and body. + * The encryption algorithm used is AES-128 with [CBC mode](https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation), where a unique IV is generated for each encryption operation and stored with the cipher text. + +## Sharing Protected Notes + +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. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Read-Only Notes.md b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Read-Only Notes.md new file mode 100644 index 000000000..5feaa3387 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Read-Only Notes.md @@ -0,0 +1,12 @@ +# Read-Only Notes +Both [text](../../Note%20Types/Text.md) and [code](../../Advanced%20Usage/Code%20Notes.md) 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. + +## Setting Read-Only Mode with a Label + +To set a note as read-only, add the `readOnly` [label](../../Advanced%20Usage/Attributes.md) to the note. + +## Automatic Read-Only Mode + +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. + +If you want to ensure that a specific note remains editable regardless of its size, you can add the `autoReadOnlyDisabled` [label](../../Advanced%20Usage/Attributes.md) to the note. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Right-to-Left Support.md b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Right-to-Left Support.md new file mode 100644 index 000000000..214168033 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Right-to-Left Support.md @@ -0,0 +1,18 @@ +# Right-to-Left Support +Trilium now has basic support for right-to-left text, but only for  [Text](../../Note%20Types/Text.md) note types (both editable and read-only). + +| | | +| --- | --- | +| ![](2_Right-to-Left Support_imag.png) | ![](1_Right-to-Left Support_imag.png) | + +Note that only the Text note type supports this. + +The list of languages is configurable via the a new dedicated settings page: + +![](3_Right-to-Left Support_imag.png) + +To select the corresponding language of the text, go to “Basic Properties” and select your desired language. + +![](Right-to-Left Support_imag.png) + +Feel free to report any issues regarding right to left support. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/1_Right-to-left text notes_i.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Right-to-Left Support_imag.png similarity index 100% rename from src/public/app/doc_notes/en/User Guide/User Guide/New Features/1_Right-to-left text notes_i.png rename to src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Right-to-Left Support_imag.png diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Sorting Notes.md b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Sorting Notes.md new file mode 100644 index 000000000..a2a063e33 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Sorting Notes.md @@ -0,0 +1,24 @@ +# Sorting Notes +## Sorting Notes + +You can sort notes by right-clicking the parent note in the note tree and selecting Advanced -> Sort notes by ... This will sort existing notes, but will not automatically sort future notes added to this parent note + +## Automatic/Permanent Sorting + +Child notes can be automatically sorted by attaching specific [labels](../../Advanced%20Usage/Attributes.md) to the parent note: + +* `#sorted`: Enables sorting. Can optionally include the name of the note's property/label for sorting criteria (details below). +* `#sortDirection`: By default, sorting is ascending. Set this to `desc` to sort in descending order. +* `#sortFoldersFirst`: Notes with children will be sorted to the top. + +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. + +1. **Top Label Sorting**: Child notes with the `#top` label will appear at the top of the folder. +2. **Bottom Label Sorting**: (Introduced in Trilium 0.62) Child notes with the `#bottom` label will appear at the bottom of the folder. +3. **Property/Label-Based Sorting**: Sorting is based on the parent note's `#sorted` label: + * **Default Sorting**: If `#sorted` has no value, notes are sorted alphabetically. + * **Property Sorting**: If `#sorted` is set to `title`, `dateModified`, or `dateCreated`, notes are sorted based on the specified property. + * **Label Sorting**: If `#sorted` 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 `#sorted=myOrder` on the parent note and using `#myOrder=001`, `#myOrder=002`, etc., on child notes. +4. **Alphabetical Sorting**: Used as a last resort when other criteria result in equality. + +All comparisons are made string-wise (e.g., "1" < "2" or "2020-10-10" < "2021-01-15", but also "2" > "10"). \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Themes.md b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Themes.md new file mode 100644 index 000000000..84919433e --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Themes.md @@ -0,0 +1,132 @@ +# Themes +## Default Themes + +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. + +![Dark Theme](../Attachments/dark-theme.png) + +## Creating Custom CSS Themes + +Trilium supports custom user themes, allowing you to personalize the application's appearance. To create a custom theme, follow these steps: + +1. **Create a CSS Code Note**: Start by creating a new [code note](../Advanced%20Usage/Code%20Notes.md) with the `CSS` type. +2. **Annotate with** `**#appTheme**`: Add the [attribute](../Advanced%20Usage/Attributes.md) `#appTheme=my-theme-name` to your note, where `my-theme-name` is the name of your custom theme. +3. **Define Your Styles**: Write your custom CSS within the note. Below is an example of a custom theme: + +``` +@font-face { + font-family: 'Raleway'; + font-style: normal; + font-weight: 400; + src: url('/custom/fonts/raleway.woff2') format('woff2'); +} + +:root { + --main-font-family: 'Raleway' !important; + --main-font-size: normal; + --tree-font-family: inherit; + --tree-font-size: normal; + --detail-font-family: inherit; + --detail-font-size: normal; + --detail-text-font-family: 'Garamond' !important; + + --main-background-color: #404552; + --main-text-color: #AFB8C6; + --main-border-color: #AFB8C6; + --accented-background-color: #383C4A; + --more-accented-background-color: #2F343F; + --header-background-color: #383C4A; + --button-background-color: #2F343F; + --button-disabled-background-color: #404552; + --button-border-color: #333; + --button-text-color: #AFB8C6; + --button-border-radius: 2px; + --primary-button-background-color: #6c757d; + --primary-button-text-color: white; + --primary-button-border-color: #6c757d; + --muted-text-color: #86919F; + --input-text-color: #AFB8C6; + --input-background-color: #404552; + --hover-item-text-color: white; + --hover-item-background-color: #4877B1; + --active-item-text-color: white; + --active-item-background-color: #4877B1; + --menu-text-color: #AFB8C6; + --menu-background-color: #383C4A; + --tooltip-background-color: #383C4A; + --link-color: lightskyblue; + --modal-background-color: #404552; + --modal-backdrop-color: black; + --scrollbar-border-color: rgba(175, 184, 198, 0.5); +} + +body .note-detail-text { + font-size: 120%; +} + +body .CodeMirror { + filter: invert(100%) hue-rotate(180deg); +} +``` + +### Activating Your Custom Theme + +Once you've created your custom theme: + +1. Go to "Menu" -> "Options" -> "Appearance." +2. In the theme selection dropdown, you should see your custom theme listed under the name you provided with the `#appTheme` [label](../Advanced%20Usage/Attributes.md). +3. Select your custom theme to activate it. + +If you make changes to your theme, press `CTRL-R` to reload the frontend and apply your updates. + +### Sharing and Importing Themes + +Custom themes can be exported as `.tar` 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. + +An example user theme, _Steel Blue_, is available in the [demo document](#root/xjSsCcvVZf6H). + +![Steel Blue Theme](../Attachments/steel-blue.png) + +### Using Custom CSS for Specific Purposes + +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. + +### Applying Custom CSS + +To use custom CSS: + +1. **Create a CSS Code Note**: Create a new [code note](../Advanced%20Usage/Code%20Notes.md) with the `CSS` type. +2. **Add the** `**appCss**` **Label**: Annotate the note with the `#appCss` [label](../Advanced%20Usage/Attributes.md). +3. **Write Your CSS**: Add your custom CSS rules to the note. + +For example: + +``` +/* Custom CSS to style specific elements */ +.tree-item { + color: #ff6347; /* Change tree item color */ +} +``` + +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 `CTRL-R` to reload the frontend and apply your new styles. + +![](Themes_image.png) + +### Styling Specific Notes in the Tree + +To apply specific styles to certain notes in the tree: + +* **Use the** `**cssClass**` **Attribute**: Add the `cssClass` [attribute](../Advanced%20Usage/Attributes.md) to a note, and assign it a value representing the desired CSS class. +* **Define an** `**iconClass**`: You can also define a custom icon for a note using the `iconClass` attribute, selecting from [Box Icons](https://boxicons.com) or your own custom classes. + +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 `type-image mime-image-png`. + +### User-Provided Themes + +A gallery of user-created themes is available, showcasing the variety of customizations that the Trilium community has developed. For more information, visit the [Theme Gallery](Themes/Theme%20Gallery.md). + +### Asset Path Management + +When referencing built-in assets like images in your custom themes or CSS, you can avoid hardcoding version numbers by using the `vX` alias. For example, instead of specifying `/assets/v0.57.0-beta/images/icon-grey.png`, you can use `/assets/vX/images/icon-grey.png` to keep your theme compatible with future versions of Trilium. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Themes/Theme Gallery.md b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Themes/Theme Gallery.md new file mode 100644 index 000000000..f256cc6dd --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Themes/Theme Gallery.md @@ -0,0 +1,29 @@ +# Theme Gallery +These are user-created themes which were made publicly available: + +## Legacy Themes + +These themes may or may not be compatible with the latest versions of TriliumNext and are based on the original/legacy theme. + +| Theme | Author | +| --- | --- | +| [Midnight](https://github.com/tobealive/trilium-midnight-theme) | [tobealive](https://github.com/tobealive) | +| [EOTE](https://github.com/tobealive/trilum-eote-theme) | [tobealive](https://github.com/tobealive) | +| [Trilium Themes](https://github.com/Abourass/TriliumThemes) | [Abourass](https://github.com/Abourass) | +| [MaterialDark](https://github.com/ZMonk91/Material-Dark-Trilium) | [ZMonk91](https://github.com/ZMonk91) | +| [lightslategray](https://github.com/jaroet/trilium-theme-lightslategray) | [jaroet](https://github.com/jaroet) | +| [melon-4](https://github.com/raphwriter/trilium-theme-melon) | [raphwriter](https://github.com/raphwriter) | +| [Neon\_Dark](https://github.com/Engr-AllanG/trilium-themes) | [Engr-AllanG](https://github.com/Engr-AllanG) | +| [Coder\_Dark](https://github.com/Engr-AllanG/trilium-themes) | [Engr-AllanG](https://github.com/Engr-AllanG) | +| [velvet](https://github.com/idelem/trilium-theme-velvet) | [idelem](https://github.com/idelem) | +| [Dark Plus](https://github.com/SADAVA/trilium-notes-theme-dark-plus) | [SADAVA](https://github.com/SADAVA) | +| [Solarized](https://github.com/WKSu/trilium-solarized-theme) | [WKSu](https://github.com/WKSu) | +| [Nord](https://github.com/en3r0/Trilium-Nord-Theme) | [en3r0](https://github.com/en3r0) | +| [Bear Note Light](https://github.com/AllanZyne/trilium-bear-theme) | [AllanZyne](https://github.com/AllanZyne) | +| [Bear Note Dark](https://github.com/AllanZyne/trilium-bear-theme) | [AllanZyne](https://github.com/AllanZyne) | +| [Miku Hatsune](https://github.com/Sebiann/miku-hatsune-trilium-theme) | [Sebiann](https://github.com/Sebiann) | +| [Midnight](https://github.com/cwilliams5/Midnight-Trilium-Dark-Mode) | [cwilliams5](https://github.com/cwilliams5) | +| [Blue](https://github.com/SiriusXT/trilium-theme-blue) (light) | [SiriusXT](https://github.com/SiriusXT) | +| [Blue](https://github.com/SiriusXT/trilium-theme-blue) (dark) | [SiriusXT](https://github.com/SiriusXT) | + +If you would like to add your theme to this gallery, write a new post in [👐 Show and tell](https://github.com/TriliumNext/Notes/discussions/categories/show-and-tell). \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Themes/Theme Gallery_preview.jpg b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Themes/Theme Gallery_preview.jpg new file mode 100644 index 000000000..5b2eb96ff Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Themes/Theme Gallery_preview.jpg differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Themes_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Themes_image.png new file mode 100644 index 000000000..49df90730 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Themes_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/1_Global menu_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/1_Global menu_image.png new file mode 100644 index 000000000..37a565d3f Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/1_Global menu_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Global menu.md b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Global menu.md new file mode 100644 index 000000000..8893f2d3c --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Global menu.md @@ -0,0 +1,9 @@ +# Global menu +The position of the global menu differs based on which layout is selected in settings: + +* For the vertical layout, the icon is in the top-left of the screen, in the form of the Trilium icon. +* For the horizontal layout, the icon is in the top-right of the screen, in form of a hamburger menu icon. + +| | | +| --- | --- | +| ![](1_Global menu_image.png)

The global menu in the vertical layout. | ![](Global menu_image.png)

The global menu in the horizontal layout. | \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Global menu_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Global menu_image.png new file mode 100644 index 000000000..7a30a84df Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Global menu_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements_image.png new file mode 100644 index 000000000..7a30a84df Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Zen mode.md b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Zen mode.md new file mode 100644 index 000000000..cf3968930 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Zen mode.md @@ -0,0 +1,34 @@ +# Zen mode +![](4_Zen mode_image.png) + +Screenshot of Zen Mode activated on a Windows 11 system with native title bar off and background effects on. + +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. + +![](2_Zen mode_image.png) + +Screenshot of the Zen Mode option in the global menu. + +## Activating & deactivating + +The Zen Mode can be activated by accessing the global menu and selecting the “Zen Mode” option: + +Aside from the global menu, it's also possible to activate this mode by using a keyboard shortcut which is Alt+Z by default. Look for `toggleZenMode` in the shortcut configuration. + +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 ![](5_Zen mode_image.png)icon in the top-right corner of the window or by pressing the keyboard combination again. + +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. + +## Moving the window around + +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. + +![](6_Zen mode_image.png) + +Screenshot of two notes side-by-side while Zen Mode is active, on Windows 11 with background effects off. + +## Split windows and tabs + +Tabs are completely hidden, however it's still possible to use keyboard shortcuts such as `firstTab` (Ctrl+1 by default), `secondTab` (Ctrl+2 by default). There are also some newer shortcuts such as `activateNextTab` (Ctrl+Tab) or `activatePreviousTab` (Ctrl+Shift+Tab) that allow easy navigation, however make sure that they are configured properly in the settings. + +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. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/1_Zen mode_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Zen mode_image.png similarity index 100% rename from src/public/app/doc_notes/en/User Guide/User Guide/New Features/1_Zen mode_image.png rename to src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Zen mode_image.png diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/Examples/Downloading responses from Goo.md b/src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/Examples/Downloading responses from Goo.md new file mode 100644 index 000000000..5676092a0 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/Examples/Downloading responses from Goo.md @@ -0,0 +1,45 @@ +# Downloading responses from Google Forms +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. + +Note that the link will be publicly accessible to everyone (however the link is in a hard-to-guess format such as `https://docs.google.com/spreadsheets/d/e/2PACX-1vTA8NU2_eZFhc8TFadCZPreBfvP7un8IHd6J0SchrLLw3ueGmntNZjwRmsH2ZRcp1pJYDAzMz1FmFaj/pub?output=csv`). Make sure you are not accidentally publishing sensitive information. + +## Obtaining the CSV link + +1. Open the Google Forms in a browser. +2. Select the “Responses” tab and click on “Link to Sheets”. +3. Select “Create a new spreadsheet” and press “Create”. +4. In Google Sheets, select File → Share → Publish to web. +5. In the “Publish to the web” screen, make sure the “Link” tab is selected and instead of “Web page”, select “Comma-separated values (.csv)”. +6. Copy the given link which will be used for the upcoming script. + +## Creating the script + +Create a “JS Frontend” script: + +``` +const CSV_URL = "https://docs.google.com/spreadsheets/d/e/2PACX-1vTiwooLV2whjCSVa49dJ99p_G3_qhqHHRqttMjYCJVfLXVdTgUSNJu5K0rpqmaHYF2k7Vofi3o7gW82/pub?output=csv"; + +async function fetchData() { + try { + const response = await fetch(CSV_URL); + return await response.text(); + } catch (e) { + api.showError(e.message); + } +} + +const data = await fetchData(); +console.log(data); +// Do something with the data. +``` + +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: + +``` +const content = data + .split("\n") + .slice(1) + .map((row) => row.split(",")); +``` + +This will return the data as an array of arrays. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Scripting/Using promoted attributes .png b/src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/Examples/Using promoted attributes .png similarity index 100% rename from src/public/app/doc_notes/en/User Guide/User Guide/Scripting/Using promoted attributes .png rename to src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/Examples/Using promoted attributes .png diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/Examples/Using promoted attributes to c.md b/src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/Examples/Using promoted attributes to c.md new file mode 100644 index 000000000..215a0cce4 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/Examples/Using promoted attributes to c.md @@ -0,0 +1,61 @@ +# Using promoted attributes to configure scripts +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. + +![](Using promoted attributes .png) + +## Using check boxes to toggle flags + +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. + +To do so, first define the promoted attribute: + +``` +#label:groupByExtension="promoted,alias=Group by extension,single,boolean" +``` + +Then use it: + +```javascript +const byExtension = api.currentNote.getLabelValue("groupByExtension") === "true"; +if (byExtension) { + // Do something. +} +``` + +This will work equally well in both front-end and back-end scripts. + +## Using relations to select notes + +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: + +``` +#relation:input="promoted,alias=Input,single" #relation:output="promoted,alias=Output,single" +``` + +Once we have this, we can add some basic error handling to ensure that the fields are completed by the user: + +```javascript +const inputNoteId = api.currentNote.getRelationValue("input"); +if (!inputNoteId) { + api.showError("Missing input."); + return; +} + +const outputNoteId = api.currentNote.getRelationValue("output"); +if (!outputNoteId) { + api.showError("Missing output."); + return; +} +``` + +Note that here we are using `api.showError` which is only available for frontend notes. If you are writing a backend note, simply remove `api.showError` but the user will no feedback on why the script did not execute properly. + +Afterwards we can simply read the note and do something with it: + +```javascript +const note = api.getNote(inputNoteId); +if (!note) { + return; +} +const content = note.getContent().toString("utf-8"); +``` \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/Frontend Basics.md b/src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/Frontend Basics.md new file mode 100644 index 000000000..fdd9af407 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/Frontend Basics.md @@ -0,0 +1,57 @@ +# Frontend Basics +## Frontend API + +The frontend api supports two styles, regular scripts that are run with the current app and note context, and widgets that export an object to Trilium to be used in the UI. In both cases, the frontend api of Trilium is available to scripts running in the frontend context as global variable `api`. The members and methods of the api can be seen on the [Script API](../Advanced%20Usage/Code%20Notes/Script%20API.md) page. + +## Scripts + +Scripts don't have any special requirements. They can be run at will using the execute button in the UI or they can be configured to run at certain times using [Attributes](../Advanced%20Usage/Attributes.md) on the note containing the script. + +### Global Events + +This attribute is called `#run` and it can have any of the following values: + +* `frontendStartup` - executes on frontend upon startup. +* `mobileStartup` - executes on mobile frontend upon startup. +* `backendStartup` - executes on backend upon startup. +* `hourly` - executes once an hour on backend. +* `daily` - executes once a day on backend. + +### Entity Events + +These events are triggered by certain [relations](../Advanced%20Usage/Attributes.md) to other notes. Meaning that the script is triggered only if the note has this script attached to it through relations (or it can inherit it). + +* `runOnNoteCreation` - executes when note is created on backend. +* `runOnNoteTitleChange` - executes when note title is changed (includes note creation as well). +* `runOnNoteContentChange` - executes when note content is changed (includes note creation as well). +* `runOnNoteChange` - executes when note is changed (includes note creation as well). +* `runOnNoteDeletion` - executes when note is being deleted. +* `runOnBranchCreation` - 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. +* `runOnBranchDeletion` - executes when a branch is delete. Branch is a link between parent note and child note and is deleted e.g. when moving note (old branch/link is deleted). +* `runOnChildNoteCreation` - executes when new note is created under this note. +* `runOnAttributeCreation` - executes when new attribute is created under this note. +* `runOnAttributeChange` - executes when attribute is changed under this note. + +## Widgets + +Conversely to scripts, widgets do have some specific requirements in order to work. A widget must: + +* Extend [BasicWidget](https://triliumnext.github.io/Notes/frontend_api/BasicWidget.html) or one of it's subclasses. +* Create a new instance and assign it to `module.exports`. +* Define a `parentWidget` member to determine where it should be displayed. +* Define a `position` (integer) that determines the location via sort order. +* Have a `#widget` attribute on the containing note. +* Create, render, and return your element in the render function. + * For [BasicWidget](https://triliumnext.github.io/Notes/frontend_api/BasicWidget.html) and [NoteContextAwareWidget](https://triliumnext.github.io/Notes/frontend_api/NoteContextAwareWidget.html)you should create `this.$widget` and render it in `doRender()`. + * For [RightPanelWidget](https://triliumnext.github.io/Notes/frontend_api/RightPanelWidget.html) the `this.$widget` and `doRender()` are already handled and you should instead return the value in `doRenderBody()`. + +### parentWidget + +* `left-pane` - This renders the widget on the left side of the screen where the note tree lives. +* `center-pane` - This renders the widget in the center of the layout in the same location that notes and splits appear. +* `note-detail-pane` - This renders the widget _with_ the note in the center pane. This means it can appear multiple times with splits. +* `right-pane` - This renders the widget to the right of any opened notes. + +### Tutorial + +For more information on building widgets, take a look at [Widget Basics](Widget%20Basics.md). \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced topics/REST API/ETAPI/API Reference.dat b/src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/REST API/ETAPI/API Reference.dat similarity index 100% rename from src/public/app/doc_notes/en/User Guide/User Guide/Advanced topics/REST API/ETAPI/API Reference.dat rename to src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/REST API/ETAPI/API Reference.dat diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced topics/REST API/Internal API/API Reference.dat b/src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/REST API/Internal API/API Reference.dat similarity index 100% rename from src/public/app/doc_notes/en/User Guide/User Guide/Advanced topics/REST API/Internal API/API Reference.dat rename to src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/REST API/Internal API/API Reference.dat diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/Widget Basics.md b/src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/Widget Basics.md new file mode 100644 index 000000000..2eed9a097 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Developer Guides/Widget Basics.md @@ -0,0 +1,111 @@ +# Widget Basics +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. + +### Step 1: The Basic Widget Structure + +To start, we'll create the most basic widget possible. Here's a simple example: + +``` +class MyWidget extends api.BasicWidget { + get position() { return 1; } + get parentWidget() { return "left-pane"; } + + doRender() { + this.$widget = $(""); + return this.$widget; + } +} + +module.exports = new MyWidget(); +``` + +To implement this widget: + +1. Create a new `JS Frontend` note in Trilium and paste in the code above. +2. Assign the `#widget` [attribute](../Advanced%20Usage/Attributes.md) to the [note](../Basic%20Concepts/Note.md). +3. Restart Trilium or reload the window. + +To verify that the widget is working, open the developer tools (`Cmd` + `Shift` + `I`) and run `document.querySelector("#my-widget")`. If the element is found, the widget is functioning correctly. If `undefined` is returned, double-check that the [note](../Basic%20Concepts/Note.md) has the `#widget` [attribute](../Advanced%20Usage/Attributes.md). + +### Step 2: Adding an UI Element + +Next, let's improve the widget by adding a button to it. + +``` +const template = ``; + +class MyWidget extends api.BasicWidget { + get position() {return 1;} + get parentWidget() {return "left-pane"} + + doRender() { + this.$widget = $(template); + return this.$widget; + } +} + +module.exports = new MyWidget(); +``` + +After making this change, reload Trilium. You should now see a button in the top-left corner of the left pane. + +### Step 3: Styling the Widget + +To make the button more visually appealing and position it correctly, we'll apply some custom styling. Trilium includes [Box Icons](https://boxicons.com), which we'll use to replace the button text with an icon. For example the `bx bxs-magic-wand` icon. + +Here's the updated template: + +``` +const template = ``; +``` + +Next, we'll adjust the button's position using CSS: + +``` +class MyWidget extends api.BasicWidget { + get position() { return 1; } + get parentWidget() { return "left-pane"; } + + doRender() { + this.$widget = $(template); + this.cssBlock(`#my-widget { + position: absolute; + bottom: 40px; + left: 60px; + z-index: 1; + }`); + return this.$widget; + } +} + +module.exports = new MyWidget(); +``` + +After reloading Trilium, the button should now appear at the bottom left of the left pane, alongside other action buttons. + +### Step 4: Adding User Interaction + +Let’s make the button interactive by showing a message when it’s clicked. We'll use the `api.showMessage` method from the [Script API](../Advanced%20Usage/Code%20Notes/Script%20API.md). + +``` +class MyWidget extends api.BasicWidget { + get position() { return 1; } + get parentWidget() { return "left-pane"; } + + doRender() { + this.$widget = $(template); + this.cssBlock(`#my-widget { + position: absolute; + bottom: 40px; + left: 60px; + z-index: 1; + }`); + this.$widget.find("button").on("click", () => api.showMessage("Hello World!")); + return this.$widget; + } +} + +module.exports = new MyWidget(); +``` + +Reload the application one last time. When you click the button, a "Hello World!" message should appear, confirming that your widget is fully functional. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/FAQ.md b/src/public/app/doc_notes/en/User Guide/User Guide/FAQ.md new file mode 100644 index 000000000..8090f22d8 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/FAQ.md @@ -0,0 +1,61 @@ +# FAQ +## Mac OS support + +Originally, desktop builds of Trilium Notes has been available for Windows & Linux, but there has been a considerable demand for macOS build. + +So I made one, but I underestimated the differences and specifics of Mac platform which seems to require special handling in several places. My lack of knowledge and frankly willingness to learn & code Mac specific functionality resulted in a current state where [Trilium does not integrate well into the OS](https://github.com/TriliumNext/Notes/issues/511)  + +%%{WARNING}%%. + +macOS build is from now on considered "unsupported". I will strive to keep it fundamentally functional, but I won't work on Mac specific features or integrations. Note that this is more of an acknowledgment of an existing state rather than sudden change of direction. + +Of course, PRs are welcome. + +## Translation / localization support + +Trilium is currently available only in English. Translation to other languages is not planned in the near/medium term because it brings a significant maintenance overhead. This decision might be revisited once Trilium stabilizes into a more mature product. + +For Chinese, there's an unofficial fork [here](https://github.com/Nriver/trilium-translation). Use at your own risk. + +## Multi user support + +Common request is to allow multiple users collaborate, share notes etc. So far I'm resisting this because of these reasons: + +* 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. +* given its size it would probably pivot the attention away from my main focus which is a personal note-taking +* 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 [scripting](Advanced%20Usage/Code%20Notes/Scripts.md)support would be a XSS security hole, while with the single user assumption it's an endless customizable tool. + +## How to open multiple documents in one Trilium instance + +This is normally not supported - one Trilium process can open only a single instance of a [database](Advanced%20Usage/Database.md). 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 [data directory](Installation%20%26%20Setup/Data%20directory.md) in the `TRILIUM_DATA_DIR` environment variable and separate port on `TRILIUM_PORT` environment variable. How to do that depends on the platform, in Unix-based systems you can achieve that by running command such as this: + +``` +TRILIUM_DATA_DIR=/home/me/path/to/data/dir TRILIUM_PORT=12345 trilium +``` + +You can save this command into a `.sh` script file or make an alias. Do this similarly for a second instance with different data directory and port. + +## Can I use Dropbox / Google Drive / OneDrive to sync data across multiple computers. + +No. + +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: + +> SqliteError: database disk image is malformed + +The only supported way to sync Trilium's data across the network is to use a [sync/web server](Installation%20%26%20Setup/Synchronization.md). + +## Why database instead of flat files? + +Trilium stores notes in a [database](Advanced%20Usage/Database.md) 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. + +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. + +More detailed answer: + +* [clones](Basic%20Concepts/Note/Cloning%20Notes.md) are what you might call "hard directory link" in filesystem lingo, but this concept is not implemented in any filesystem +* filesystems make a distinction between directory and file while there's intentionally no such difference in Trilium +* files are stored in no particular order and user can't change this +* Trilium allows storing note [attributes](Advanced%20Usage/Attributes.md) which could be represented in extended user attributes but their support differs greatly among different filesystems / operating systems +* Trilium makes links / relations between different notes which can be quickly retrieved / navigated (e.g. for [note map](Advanced%20Usage/Note%20Map.md)). 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). +* 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. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Backup.md b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Backup.md new file mode 100644 index 000000000..0f42dd79a --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Backup.md @@ -0,0 +1,43 @@ +# Backup +Trilium supports simple backup scheme where it saves copy of the [document](#root/xjSsCcvVZf6H) on these events: + +* once a day +* once a week +* once a month +* before DB migration to newer version + +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 `backup` directory placed in the [data directory](Data%20directory.md). + +This is only very basic backup solution, and you're encouraged to add some better backup solution - e.g. backing up the [document](#root/xjSsCcvVZf6H) to cloud / different computer etc. + +Note that [synchronization](Synchronization.md) provides also some backup capabilities by its nature of distributing the data to other computers. + +## Restoring backup + +Let's assume you want to restore the weekly backup, here's how to do it: + +* find [data directory](Data%20directory.md) Trilium uses - easy way is to open "About Trilium Notes" from "Menu" in upper left corner and looking at "data directory" + * I'll refer to `~/trilium-data` as data directory from now on +* find `~/trilium-data/backup/backup-weekly.db` - this is the [document](#root/xjSsCcvVZf6H)backup +* at this point stop/kill Trilium +* delete `~/trilium-data/document.db`, `~/trilium-data/document.db-wal` and `~/trilium-data/document.db-shm` (latter two files are auto generated) +* copy and rename this `~/trilium-data/backup/backup-weekly.db` to `~/trilium-data/document.db` +* make sure that the file is writable, e.g. with `chmod 600 document.db` +* start Trilium again + +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. + +## Disabling backup + +Although this is not recommended, it is possible to disable backup in `config.ini` in the [data directory](Data%20directory.md): + +``` +[General] +... some other configs +# set to true to disable backups (e.g. because of limited space on server) +noBackup=true +``` + +You can also review the [configuration](../Advanced%20Usage/Configuration%20\(config.ini%20or%20e.md) file to provide all `config.ini` values as environment variables instead. + +See [sample config](https://github.com/TriliumNext/Notes/blob/master/config-sample.ini). %%{WARNING}%% \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Data directory.md b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Data directory.md new file mode 100644 index 000000000..df04a5e09 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Data directory.md @@ -0,0 +1,88 @@ +# Data directory +Data directory contains: + +* `document.db` - [database](../Advanced%20Usage/Database.md) +* `config.ini` - instance level settings like port on which the Trilium application runs +* `backup` - contains automatically [backup](Backup.md) of documents +* `log` - contains application log files + +## Location + +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): + +![](Data directory_image.png) + +Here's how the location is decided: + +Data directory is normally named `trilium-data` and it is stored in: + +* `/home/[user]/.local/share` for Linux +* `C:\Users\[user]\AppData\Roaming` for Windows Vista and up +* `/Users/[user]/Library/Application Support` for Mac OS +* user's home is a fallback if some of the paths above don't exist +* user's home is also a default setup for \[\[docker|Docker server installation\]\] + +If you want to back up your Trilium data, just backup this single directory - it contains everything you need. + +### Changing the location of data directory + +If you want to use some other location for the data directory than the default one, you may change it via TRILIUM\_DATA\_DIR environment variable to some other location: + +#### Linux + +``` +export TRILIUM_DATA_DIR=/home/myuser/data/my-trilium-data +``` + +#### Mac OS X + +You need to create a `.plist` file under `~/Library/LaunchAgents` to load it properly each login. + +To load it manually, you need to use `launchctl setenv TRILIUM_DATA_DIR ` + +Here is a pre-defined template, where you just need to add your path to: + +``` + + + + + + Label + set.trilium.env + RunAtLoad + + ProgramArguments + + launchctl + setenv + TRILIUM_DATA_DIR + /Users/YourUserName/Library/Application Support/trilium-data + + + +``` + +### Create a script to run with specific data directory + +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 [database](../Advanced%20Usage/Database.md) instances or "portable" installation. + +To do this in unix based systems simply run trilium like this: + +``` +TRILIUM_DATA_DIR=/home/myuser/data/my-trilium-data trilium +``` + +You can then save the above command as a shell script on your path for convenience. + +### Fine-grained directory/path location + +It's possible to configure e.g. backup and log directories separately, with following environment variables: + +* `TRILIUM_DOCUMENT_PATH` +* `TRILIUM_BACKUP_DIR` +* `TRILIUM_LOG_DIR` +* `TRILIUM_ANONYMIZED_DB_DIR` +* `TRILIUM_CONFIG_INI_PATH` + +If these are not set, default paths within the data directory will be used. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Data directory_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Data directory_image.png new file mode 100644 index 000000000..823c6ceac Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Data directory_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Desktop Installation.md b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Desktop Installation.md new file mode 100644 index 000000000..93cf43e5b --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Desktop Installation.md @@ -0,0 +1,19 @@ +# Desktop Installation +To install Trilium on your desktop, follow these steps: + +1. **Download the Latest Release**: Obtain the appropriate binary release for your operating system from the [latest release page](https://github.com/TriliumNext/Notes/releases/latest) on GitHub. +2. **Extract the Package**: Unzip the downloaded package to a location of your choice. +3. **Run the Application**: Launch Trilium by executing the `trilium` executable found within the unzipped folder. + +## Startup Scripts + +Trilium offers various startup scripts to customize your experience: + +* `**trilium-no-cert-check**`: Starts Trilium without validating [TLS certificates](Server%20Installation/TLS%20Configuration.md), useful if connecting to a server with a self-signed certificate. + * Alternatively, set the `NODE_TLS_REJECT_UNAUTHORIZED=0` environment variable before starting Trilium. +* `**trilium-portable**`: Launches Trilium in portable mode, where the [data directory](Data%20directory.md) is created within the application's directory, making it easy to move the entire setup. +* `**trilium-safe-mode**`: Boots Trilium in "safe mode," disabling any startup scripts that might cause the application to crash. + +## Synchronization + +For Trilium desktp users who wish to synchronize their data with a server instance, refer to the [Synchronization Guide](Synchronization.md) for detailed instructions. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Mobile Frontend.md b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Mobile Frontend.md new file mode 100644 index 000000000..f64b214e8 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Mobile Frontend.md @@ -0,0 +1,34 @@ +# Mobile Frontend +Trilium ([server edition](Server%20Installation.md)) 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. + +Mobile frontend is limited in features compared to full desktop frontend. See below for more details on this. + +Note that this is not an Android/iOS app, this is just mobile friendly web page served on the [server edition](Server%20Installation.md). + +## Screenshots + +### Mobile phone + +![](../Attachments/mobile-smartphone.png) + +### Tablet + +![](../Attachments/mobile-tablet.png) + +## Limitations + +Mobile frontend provides only some of the features of the full desktop frontend: + +* it is possible to browse the whole note tree, read and edit all types of notes, but you can create only text notes +* reading and editing [protected notes](../Basic%20Concepts/Note/Protected%20Notes.md) is possible, but creating them is not supported +* editing options is not supported +* cloning notes is not supported +* uploading file attachments is not supported + +## Forcing mobile/desktop frontend + +Trilium decides automatically whether to use mobile or desktop frontend. If this is not appropriate, you can use `?mobile` or `?desktop` query param on **login** page (Note: you might need to log out). + +## Scripting + +You can alter the behavior with [scripts](../Advanced%20Usage/Code%20Notes/Scripts.md) just like for normal frontend. For script notes to be executed, they need to have labeled `#run=mobileStartup`. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation.md b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation.md new file mode 100644 index 000000000..566517656 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation.md @@ -0,0 +1,70 @@ +# Server Installation +This guide outlines the steps to install Trilium on your own server. You might consider this option if you want to set up [synchronization](Synchronization.md) or use Trilium in a browser - accessible from anywhere. + +## Installation Options + +There are several ways to install Trilium on a server, each with its own advantages: + +* **Recommended**: [Docker Installation](Server%20Installation/1.%20Installing%20the%20server/Docker%20Server%20Installation.md) - Available for **AMD64** and **ARM** architectures. +* [Packaged Server Installation](Server%20Installation/1.%20Installing%20the%20server/Packaged%20server%20installation.md) +* [PikaPods managed hosting](https://www.pikapods.com/pods?run=trilium-next) +* [Manual Installation](Server%20Installation/1.%20Installing%20the%20server/Manual%20server%20installation.md) +* [Kubernetes](Server%20Installation/1.%20Installing%20the%20server/Kubernetes%20server%20installation.md) +* [Cloudron](https://www.cloudron.io/store/com.github.trilium.cloudronapp.html) +* [HomelabOS](https://homelabos.com/docs/software/trilium/) +* [NixOS Module](Server%20Installation/1.%20Installing%20the%20server/NixOS%20server%20installation.md) + +The server installation includes both web and [mobile frontends](Mobile%20Frontend.md). + +## Configuration + +After setting up your server installation, you may want to configure settings such as the port or enable [TLS](Server%20Installation/TLS%20Configuration.md). Configuration is managed via the Trilium `config.ini` file, which is located in the [data directory](Data%20directory.md) by default. To begin customizing your setup, copy the provided `config-sample.ini` file with default values to `config.ini`. + +You can also review the [configuration](../Advanced%20Usage/Configuration%20\(config.ini%20or%20e.md) file to provide all `config.ini` values as environment variables instead. + +### Config Location + +By default, `config.ini`, the [database](../Advanced%20Usage/Database.md), and other important Trilium data files are stored in the [data directory](Data%20directory.md). If you prefer a different location, you can change it by setting the `TRILIUM_DATA_DIR` environment variable: + +``` +export TRILIUM_DATA_DIR=/home/myuser/data/my-trilium-data +``` + +### Disabling Authentication + +If you are running Trilium on localhost only or if authentication is handled by another component, you can disable Trilium’s authentication by adding the following to `config.ini`: + +``` +[General] +noAuthentication=true +``` + +## Reverse Proxy Setup + +To configure a reverse proxy for Trilium, you can use either **nginx** or **Apache**. + +### nginx + +Add the following configuration to your `nginx` setup to proxy requests to Trilium: + +``` +location /trilium/ { + proxy_pass http://127.0.0.1:8080/; + proxy_http_version 1.1; + proxy_set_header Upgrade $http_upgrade; + proxy_set_header Connection 'upgrade'; + proxy_set_header Host $host; + proxy_cache_bypass $http_upgrade; +} +``` + +To avoid limiting the size of payloads, include this in the `server {}` block: + +``` +# Set to 0 for unlimited. Default is 1M. +client_max_body_size 0; +``` + +### Apache + +For an Apache setup, refer to the [Apache proxy setup](Server%20Installation/2.%20Reverse%20proxy/Apache.md) guide. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Docker Server Installation.md b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Docker Server Installation.md new file mode 100644 index 000000000..1663494df --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Docker Server Installation.md @@ -0,0 +1,119 @@ +# Docker Server Installation +Official docker images are published on docker hub for **AMD64**, **ARMv7** and **ARM64/v8**: [https://hub.docker.com/r/triliumnext/notes/](https://hub.docker.com/r/triliumnext/notes/) + +## Prerequisites + +Ensure Docker is installed on your system. + +If you need help installing Docker, reference the [Docker Installation Docs](https://docs.docker.com/engine/install/) + +**Note:** Trilium's Docker container requires root privileges to operate correctly. + +> \[!WARNING\] If you're using a SMB/CIFS share or folder as your Trilium data directory, [you'll need](https://github.com/TriliumNext/Notes/issues/415#issuecomment-2344824400) to add the mount options of `nobrl` and `noperm` when mounting your SMB share. + +## Running with Docker Compose + +### Grab the latest docker-compose.yml: + +``` +wget https://raw.githubusercontent.com/TriliumNext/Notes/master/docker-compose.yml +``` + +Optionally, edit the `docker-compose.yml` file to configure the container settings prior to starting it. Unless configured otherwise, the data directory will be `~/trilium-data` and the container will be accessible at port 8080. + +### Start the container: + +Run the following command to start the container in the background: + +``` +docker compose up -d +``` + +## Running without Docker Compose / Further Configuration + +### Pulling the Docker Image + +To pull the image, use the following command, replacing `[VERSION]` with the desired version or tag, such as `v0.91.6` or just `latest`. (See published tag names at [https://hub.docker.com/r/triliumnext/notes/tags](https://hub.docker.com/r/triliumnext/notes/tags).): + +``` +docker pull triliumnext/notes:v0.91.6 +``` + +**Warning:** 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. + +### Preparing the Data Directory + +Trilium requires a directory on the host system to store its data. This directory must be mounted into the Docker container with write permissions. + +### Running the Docker Container + +#### Local Access Only + +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. + +``` +sudo docker run -t -i -p 127.0.0.1:8080:8080 -v ~/trilium-data:/home/node/trilium-data triliumnext/notes:[VERSION] +``` + +1. Verify the container is running using `docker ps`. +2. Access Trilium via a web browser at `127.0.0.1:8080`. + +#### Local Network Access + +To make the container accessible only on your local network, first create a new Docker network: + +``` +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 +``` + +Then, run the container with the network settings: + +``` +docker run --net=mynet -d -p 127.0.0.1:8080:8080 -v ~/trilium-data:/home/node/trilium-data triliumnext/notes:-latest +``` + +To set a different user ID (UID) and group ID (GID) for the saved data, use the `USER_UID` and `USER_GID` environment variables: + +``` +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/notes:-latest +``` + +Find the local IP address using `docker inspect [container_name]` and access the service from devices on the local network. + +``` +docker ps +docker inspect [container_name] +``` + +#### Global Access + +To allow access from any IP address, run the container as follows: + +``` +docker run -d -p 0.0.0.0:8080:8080 -v ~/trilium-data:/home/node/trilium-data triliumnext/notes:[VERSION] +``` + +Stop the container with `docker stop `, where the container ID is obtained from `docker ps`. + +### Custom Data Directory + +For a custom data directory, use: + +``` +-v ~/YourOwnDirectory:/home/node/trilium-data triliumnext/notes:[VERSION] +``` + +If you want to run your instance in a non-default way, please use the volume switch as follows: `-v ~/YourOwnDirectory:/home/node/trilium-data triliumnext/notes:`. 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. [https://docs.docker.com/storage/volumes/](https://docs.docker.com/storage/volumes/) 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 [Docker Volumes Documentation](https://docs.docker.com/storage/volumes/). + +## Reverse Proxy + +1. [Nginx](../2.%20Reverse%20proxy/Nginx.md) +2. [Apache](../2.%20Reverse%20proxy/Apache.md) + +### Note on --user Directive + +The `--user` directive is unsupported. Instead, use the `USER_UID` and `USER_GID` environment variables to set the appropriate user and group IDs. + +### Note on timezones + +If you are having timezone issues and you are not using docker-compose, you may need to add a `TZ` environment variable with the [TZ identifier](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of your local timezone. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Kubernetes server installation.md b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Kubernetes server installation.md new file mode 100644 index 000000000..e78ea9ae5 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Kubernetes server installation.md @@ -0,0 +1,36 @@ +# Kubernetes server installation +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. + +The recommended way is to use a Helm chart. + +## Root privileges + +> \[!NOTE\] +> The Trilium container at this time needs to be run with root privileges. It will swap to UID and GID `1000:1000` to run the `node` process after execution though, so the main process doesn't run with root privileges. + +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 `USER_UID` & `USER_GID` environment variables. + +The docker image will also fix the permissions of `/home/node` so you don't have to use an init container. + +## Helm Charts + +[Official Helm chart](https://github.com/TriliumNext/helm-charts) from TriliumNext Unofficial helm chart by [ohdearaugustin](https://github.com/ohdearaugustin): [https://github.com/ohdearaugustin/charts](https://github.com/ohdearaugustin/charts) + +## Adding a Helm repository + +Below is an example of how + +``` +helm repo add trilium https://triliumnext.github.io/helm-charts +"trilium" has been added to your repositories +``` + +## How to install a chart + +After reviewing the [`values.yaml`](https://github.com/TriliumNext/helm-charts/blob/main/charts/trilium/values.yaml) from the Helm chart, modifying as required and then creating your own: + +``` +helm install --create-namespace --namespace trilium trilium trilium/trilium -f values.yaml +``` + +For more information on using Helm, please refer to the Helm documentation, or create a Discussion in the TriliumNext GitHub Organization. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Manual server installation.md b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Manual server installation.md new file mode 100644 index 000000000..95f178c29 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Manual server installation.md @@ -0,0 +1,62 @@ +# Manual server installation +This page describes manually installing Trilium on your server. **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 Docker or packaged build installation.** + +## Requirements + +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. + +You can check your node version with this command (node.js needs to be installed): + +``` +node --version +``` + +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. + +### Dependencies + +There are some dependencies required. You can see command for Debian and its derivatives (like Ubuntu) below: + +``` +sudo apt install libpng16-16 libpng-dev pkg-config autoconf libtool build-essential nasm libx11-dev libxkbfile-dev +``` + +## Installation + +### Download + +You can either download source code zip/tar from [https://github.com/TriliumNext/Notes/releases/latest\]\]](https://github.com/TriliumNext/Notes/releases/latest%5D%5D) %%{WARNING}%%or clone git repository **from stable branch** with + +``` +git clone -b stable https://github.com/triliumnext/notes.git %%{WARNING}%% +``` + +## Installation + +``` +cd trilium + +# download all node dependencies +npm install + +# make sure the better-sqlite3 binary is there +npm rebuild + +# bundles & minifies frontend JavaScript +npm run webpack +``` + +## Run + +``` +cd trilium + +# using nohup to make sure trilium keeps running after user logs out +nohup TRILIUM_ENV=dev node src/www & +``` + +The application by default starts up on port 8080, so you can open your browser and navigate to [http://localhost:8080](http://localhost:8080) to access Trilium (replace "localhost" with your hostname). + +## TLS + +Don't forget to [configure TLS](../TLS%20Configuration.md) which is required for secure usage! \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/NixOS server installation.md b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/NixOS server installation.md new file mode 100644 index 000000000..e6d739851 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/NixOS server installation.md @@ -0,0 +1,25 @@ +# NixOS server installation +This page describes configuring the Trilium module included in NixOS. + +## Requirements + +[NixOS](https://nixos.org/) installation. + +## Configuration + +Add this to your `configuration.nix`: + +``` +services.trilium-server.enable = true; + +# default data directory: /var/lib/trilium +#services.trilium-server.dataDir = "/var/lib/trilium-sync-server"; + +# default bind address: 127.0.0.1, port 8080 +#services.trilium-server.host = "0.0.0.0"; +#services.trilium-server.port = 12783; +``` + +Uncomment any option you would like to change. + +See the [NixOS options list](https://search.nixos.org/options?channel=unstable&from=0&size=50&sort=relevance&type=packages&query=trilium-server) for more options (including nginx reverse proxy configuration). \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Packaged server installation.md b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Packaged server installation.md new file mode 100644 index 000000000..20cb22e03 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Packaged server installation.md @@ -0,0 +1,79 @@ +# Packaged server installation +This is essentially Trilium sources + node modules + node.js runtime packaged into one 7z file. + +## Steps + +* ssh into your server +* use `wget` (or `curl` or whatever) to download latest [trilium-linux-x64-server-\[VERSION\].xz](https://github.com/TriliumNext/Notes/releases/latest)%%{WARNING}%% (notice -server suffix) on your server +* unpack the archive, e.g. using `tar -xf -d trilium-linux-x64-server-[VERSION].tar.xz` +* `cd trilium-linux-x64-server` +* `./trilium.sh` +* you can open the browser and open http://\[your-server-hostname\]:8080 and you should see Trilium initialization page + +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: + +* Kill it (with e.g. `CTRL-C`) and run again like this: `nohup ./trilium &`. +* Configure systemd to automatically run Trilium in the background on every boot + +## Configure Trilium to auto-run on boot with systemd + +* After downloading, extract and move Trilium: + +``` +tar -xvf trilium-linux-x64-server-[VERSION].tar.xz +sudo mv trilium-linux-x64-server /opt/trilium +``` + +* Create the service: + +``` +sudo nano /etc/systemd/system/trilium.service +``` + +* Paste this into the file (replace the user and group as needed): + +``` +[Unit] +Description=Trilium Daemon +After=syslog.target network.target + +[Service] +User=xxx +Group=xxx +Type=simple +ExecStart=/opt/trilium/trilium.sh +WorkingDirectory=/opt/trilium/ + +TimeoutStopSec=20 +# KillMode=process leads to error, according to https://www.freedesktop.org/software/systemd/man/systemd.kill.html +Restart=always + +[Install] +WantedBy=multi-user.target +``` + +* Save the file (CTRL-S) and exit (CTRL-X) +* Enable and launch the service: + +``` +sudo systemctl enable --now -q trilium +``` + +* You can now open a browser to http://\[your-server-hostname\]:8080 and you should see the Trilium initialization page. + +## Common issues + +### Outdated glibc + +``` +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) + at Object.Module._extensions..node (module.js:681:18) + at Module.load (module.js:565:32) + at tryModuleLoad (module.js:505:12) +``` + +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 [server installation](../../Server%20Installation.md) method. + +## TLS + +Don't forget to [configure TLS](../TLS%20Configuration.md), which is required for secure usage! \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/2. Reverse proxy/Apache.md b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/2. Reverse proxy/Apache.md new file mode 100644 index 000000000..1ed6b873e --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/2. Reverse proxy/Apache.md @@ -0,0 +1,84 @@ +# Apache +I've assumed you have created a DNS A record for `trilium.yourdomain.com` that you want to use for your Trilium server. + +1. Download docker image and create container + + ``` + docker pull triliumnext/notes:[VERSION] + docker create --name trilium -t -p 127.0.0.1:8080:8080 -v ~/trilium-data:/home/node/trilium-data triliumnext/notes:[VERSION] + ``` + +2. Configure Apache proxy and websocket proxy + 1. Enable apache proxy modules + + ``` + a2enmod ssl + a2enmod proxy + a2enmod proxy_http + a2enmod proxy_wstunnel + ``` + + 2. Create a new let's encrypt certificate + + ``` + sudo certbot certonly -d trilium.mydomain.com + ``` + + Choose standalone (2) and note the location of the created certificates (typically /etc/letsencrypt/live/...) + + 3. Create a new virtual host file for apache (you may want to use `apachectl -S` to determine the server root location, mine is /etc/apache2) + + ``` + sudo nano /etc/apache2/sites-available/trilium.yourdomain.com.conf + ``` + + Paste (and customize) the following text into the configuration file + + ``` + + ServerName http://trilium.yourdomain.com + RewriteEngine on + RewriteRule ^ https://%{SERVER_NAME}%{REQUEST_URI} [END,QSA,R=permanent] + + + ServerName https://trilium.yourdomain.com + RewriteEngine On + RewriteCond %{HTTP:Connection} Upgrade [NC] + RewriteCond %{HTTP:Upgrade} websocket [NC] + RewriteRule /(.*) ws://localhost:8080/$1 [P,L] + AllowEncodedSlashes NoDecode + ProxyPass / http://localhost:8080/ nocanon + ProxyPassReverse / http://localhost:8080/ + SSLCertificateFile /etc/letsencrypt/live/trilium.yourdomain.com/fullchain.pem + SSLCertificateKeyFile /etc/letsencrypt/live/trilium.yourdomain.com/privkey.pem + Include /etc/letsencrypt/options-ssl-apache.conf + + ``` + + 4. Enable the virtual host with `sudo a2ensite trilium.yourdomain.com.conf` + 5. Reload apache2 with `sudo systemctl reload apache2` +3. Create and enable a systemd service to start the docker container on boot + 1. Create a new empty file called `/lib/systemd/system/trilium.service` with the contents + + ``` + [Unit] + Description=Trilium Server + Requires=docker.service + After=docker.service + + [Service] + Restart=always + ExecStart=/usr/bin/docker start -a trilium + ExecStop=/usr/bin/docker stop -t 2 trilium + + [Install] + WantedBy=local.target + ``` + + 2. Install, enable and start service + + ``` + sudo systemctl daemon-reload + sudo systemctl enable trilium.service + sudo systemctl start trilium.service + ``` \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/2. Reverse proxy/Nginx.md b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/2. Reverse proxy/Nginx.md new file mode 100644 index 000000000..af8157f75 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/2. Reverse proxy/Nginx.md @@ -0,0 +1,51 @@ +# Nginx +Configure Nginx proxy and HTTPS. The operating system here is Ubuntu 18.04. + +1. Download Nginx and remove Apache2 + +```sh +sudo apt-get install nginx +sudo apt-get remove apache2 +``` + +2. Create configure file + +```sh +cd /etc/nginx/conf.d +vim default.conf +``` + +3. 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. + +```conf +# This part is for proxy and HTTPS configure +server { + listen 443 ssl; + server_name trilium.example.net; #change trilium.example.net to your domain without HTTPS or HTTP. + ssl_certificate /etc/ssl/note/example.crt; #change /etc/ssl/note/example.crt to your path of crt file. + ssl_certificate_key /etc/ssl/note/example.net.key; #change /etc/ssl/note/example.net.key to your path of key file. + ssl_session_cache builtin:1000 shared:SSL:10m; + ssl_protocols TLSv1 TLSv1.1 TLSv1.2; + ssl_ciphers HIGH:!aNULL:!eNULL:!EXPORT:!CAMELLIA:!DES:!MD5:!PSK:!RC4; + ssl_prefer_server_ciphers on; + access_log /var/log/nginx/access.log; #check the path of access.log, if it doesn't fit your file, change it + + location / { + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Proto $scheme; + proxy_set_header Upgrade $http_upgrade; + proxy_set_header Connection "upgrade"; + proxy_pass http://127.0.0.1:8080; # change it to a different port if non-default is used + proxy_read_timeout 90; + proxy_redirect http://127.0.0.1:8080 https://trilium.example.net; # change them based on your IP, port and domain + } +} +# This part is for HTTPS forced +server { + listen 80; + server_name trilium.example.net; # change to your domain + return 301 https://$server_name$request_uri; +} +``` \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/Multi-Factor Authentication.md b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/Multi-Factor Authentication.md new file mode 100644 index 000000000..2b3a5edec --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/Multi-Factor Authentication.md @@ -0,0 +1,86 @@ +# Multi-Factor Authentication +**Note: This feature has not been merged yet, so it is not available.** + +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. + +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. + +Warning! OpenID and TOTP cannot be both used at the same time! + +## Log in with your Google Account with OpenID! + +OpenID is a standardized way to let you log into websites using an account from another service, like Google, to verify your identity. + +## Why Time-based One Time Passwords? + +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. + +## Setup + +### TOTP + +1. Start Trilium Notes normally. +2. Go to "Menu" -> "Options" -> "MFA" +3. Click the "Generate TOTP Secret" button +4. Copy the generated secret to your authentication app/extension +5. Set an environment variable "TOTP\_SECRET" as the generated secret. Environment variables can be set with a .env file in the root directory, by defining them in the command line, or with a docker container. + + ``` + # .env in the project root directory + TOTP_ENABLED="true" + TOTP_SECRET="secret" + ``` + + ``` + # Terminal/CLI + export TOTP_ENABLED="true" + export TOTP_SECRET="secret" + ``` + + ``` + # Docker + docker run -p 8080:8080 -v ~/trilium-data:/home/node/trilium-data -e TOTP_ENABLED="true" -e TOTP_SECRET="secret" triliumnext/notes:[VERSION] + ``` + +6. Restart Trilium +7. Go to "Options" -> "MFA" +8. Click the "Generate Recovery Codes" button +9. Save the recovery codes. Recovery codes can be used once in place of the TOTP if you loose access to your authenticator. After a rerecovery code is used, it will show the unix timestamp when it was used in the MFA options tab. +10. Load the secret into an authentication app like google authenticator + +### OpenID + +_Currently only compatible with Google. Other services like Authentik and Auth0 are planned on being added._ + +In order to setup OpenID, you will need to setup a authentication provider. This requires a bit of extra setup. Follow [these instructions](https://developers.google.com/identity/openid-connect/openid-connect) to setup an OpenID service through google. + +Set an environment variable "SSO\_ENABLED" to true and add the client ID and secret you obtained from google. Environment variables can be set with a .env file in the root directory, by defining them in the command line, or with a docker container. + +#### .env File + +``` +# .env in the project root directory +SSO_ENABLED="true" +BASE_URL="http://localhost:8080" +CLIENT_ID= +SECRET= +``` + +#### Environment variable (linux) + +``` +export SSO_ENABLED="true" +export BASE_URL="http://localhost:8080" +export CLIENT_ID= +export SECRET= +``` + +#### Docker + +``` +docker run -d -p 8080:8080 -v ~/trilium-data:/home/node/trilium-data -e SSO_ENABLED="true" -e BASE_URL="http://localhost:8080" -e CLIENT_ID= -e SECRET= triliumnext/notes:[VERSION] +``` + +After you restart Trilium Notes, you will be redirected to Google's account selection page. Login to an account and Trilium Next will bind to that account, allowing you to login with it. + +You can now login using your google account. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/Reverse proxy setup.md b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/Reverse proxy setup.md new file mode 100644 index 000000000..e69de29bb diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/TLS Configuration.md b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/TLS Configuration.md new file mode 100644 index 000000000..93815ab8e --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/TLS Configuration.md @@ -0,0 +1,47 @@ +# TLS Configuration +Configuring TLS is essential for [server installation](../Server%20Installation.md) in Trilium. This guide details the steps to set up TLS within Trilium itself. + +For a more robust solution, consider using TLS termination with a reverse proxy (recommended, e.g., Nginx). You can follow a [guide like this](https://www.digitalocean.com/community/tutorials/how-to-secure-nginx-with-let-s-encrypt-on-ubuntu-20-04) for such setups. + +## Obtaining a TLS Certificate + +You have two options for obtaining a TLS certificate: + +* **Recommended**: Obtain a TLS certificate signed by a root certificate authority. For personal use, [Let's Encrypt](https://letsencrypt.org) is an excellent choice. It is free, automated, and straightforward. Certbot can facilitate automatic TLS setup. +* 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. + +## Modifying `config.ini` + +Once you have your certificate, modify the `config.ini` file in the [data directory](../Data%20directory.md) to configure Trilium to use it: + +``` +[Network] +port=8080 +# Set to true for TLS/SSL/HTTPS (secure), false for HTTP (insecure). +https=true +# Path to the certificate (run "bash bin/generate-cert.sh" to generate a self-signed certificate). +# Relevant only if https=true +certPath=/[username]/.acme.sh/[hostname]/fullchain.cer +keyPath=/[username]/.acme.sh/[hostname]/example.com.key +``` + +You can also review the [configuration](../../Advanced%20Usage/Configuration%20\(config.ini%20or%20e.md) file to provide all `config.ini` values as environment variables instead. + +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 `/home/node/trilium-data/[DIR IN DATA DIRECTORY]`. + +After configuring `config.ini`, restart Trilium and access the hostname using "https". + +## Self-Signed Certificate + +If you opt to use a self-signed certificate for your server instance, note that the desktop instance will not trust it by default. + +To bypass this, disable certificate validation by setting the following environment variable (for Linux): + +``` +export NODE_TLS_REJECT_UNAUTHORIZED=0 +trilium +``` + +Trilium provides scripts to start in this mode, such as `trilium-no-cert-check.bat` for Windows. + +**Warning**: Disabling TLS certificate validation is insecure. Proceed only if you fully understand the implications. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Synchronization.md b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Synchronization.md new file mode 100644 index 000000000..6909b7bf0 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Synchronization.md @@ -0,0 +1,70 @@ +# Synchronization +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: + +![](Synchronization_image.png) + +In this setup, a central server (referred to as the _sync server_) and multiple _client_ (or _desktop_) instances synchronize with the sync server. Once configured, synchronization is automatic and ongoing, requiring no manual intervention. + +## Setting Up Synchronization + +### Security Considerations + +Setting up the server securely is critical and can be complex. It is crucial to use a valid [TLS certificate](Server%20Installation/TLS%20Configuration.md) (HTTPS) rather than an unencrypted HTTP connection to ensure security and avoid potential vulnerabilities. + +### Synchronizing a Desktop Instance with a Sync Server + +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. + +1. **Server Deployment**: Ensure your server instance is deployed but uninitialized. +2. **Desktop Configuration**: Open your desktop instance, navigate to Options -> Sync tab -> Sync configuration, and set the "Server instance address" to your sync server's address. Click Save. + +![screenshot of the sync settings options modal](../Attachments/sync-config.png) + +1. **Testing Sync**: 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. + +### Synchronizing a Desktop Instance from a Sync Server + +This method is used when you already have a sync server and want to configure a new desktop instance to sync with it. + +1. **Desktop Setup**: Follow the [desktop installation page](Desktop%20Installation.md). +2. **Initial Configuration**: When prompted, choose the option to set up sync with a sync server. + +![screenshot of the sync from server setup page](../Attachments/sync-init.png) + +1. **Server Details**: Configure the Trilium server address and enter the correct username and password for authentication. +2. **Finish Setup**: Click the "Finish setup" button. If successful, you will see the following screen: + +![screenshot of the sync page](../Attachments/sync-in-progress.png) + +Once synchronization is complete, you will be automatically redirected to the Trilium application. + +## Proxy Configuration + +Two proxy setups are supported: + +* **Explicit Proxy Configuration**: Set the proxy server in Options / Sync. Only unauthenticated proxy servers are supported. +* **System Proxy Settings**: If no proxy server is explicitly configured, Trilium will use the system proxy settings. + +## Troubleshooting + +### Date/Time Synchronization + +For successful synchronization, both client and server must have the same date and time, with a tolerance of up to five minutes. + +### Certificate Issues + +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 `NODE_TLS_REJECT_UNAUTHORIZED` environment variable set to `0`: + +``` +export NODE_TLS_REJECT_UNAUTHORIZED=0 +``` + +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 `trilium-no-cert-check.sh` for this purpose. + +### Conflict Resolution + +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 [note revisions](../Basic%20Concepts/Note/Note%20Revisions.md), allowing data recovery if needed. + +### Hash Check + +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. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Synchronization_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Synchronization_image.png new file mode 100644 index 000000000..344262a9a Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Synchronization_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Upgrading TriliumNext.md b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Upgrading TriliumNext.md new file mode 100644 index 000000000..32509cd7c --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Upgrading TriliumNext.md @@ -0,0 +1,17 @@ +# Upgrading TriliumNext +This document outlines the steps required to upgrade Trilium to a new release version. + +## How to Upgrade + +Trilium does not support built-in automatic upgrades; all updates must be performed manually. The upgrade process varies depending on the installation method: + +* [**Docker Server Installation**](Server%20Installation/1.%20Installing%20the%20server/Docker%20Server%20Installation.md): Pull the new image and restart the container. +* **Other Installations**: Download the latest version from the [release page](https://github.com/TriliumNext/Notes/releases/latest) and replace the existing application files. + +## Database Compatibility and Migration + +Upon startup, Trilium will automatically migrate the [database](../Advanced%20Usage/Database.md) 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 [backup](Backup.md) that is created prior to migration. + +## Sync Compatibility + +The [synchronization](Synchronization.md) 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. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Web Clipper.md b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Web Clipper.md new file mode 100644 index 000000000..b0221fbaf --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Web Clipper.md @@ -0,0 +1,37 @@ +# Web Clipper +![](Web Clipper_image.png) + +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. + +Project is hosted [here](https://github.com/TriliumNext/web-clipper). + +Firefox and Chrome are supported browsers, but the chrome build should work on other chromium based browsers as well. + +## Functionality + +* select text and clip it with the right-click context menu +* click on an image or link and save it through context menu +* save whole page from the popup or context menu +* save screenshot (with crop tool) from either popup or context menu +* create short text note from popup + +Trilium will save these clippings as a new child note under a "clipper inbox" note. + +By default, that's the [day note](../Advanced%20Usage/Advanced%20Showcases/Day%20Notes.md) but you can override that by setting the [label](../Advanced%20Usage/Attributes.md) `clipperInbox`, on any other note. + +If there's multiple clippings from the same page (and on the same day), then they will be added to the same note. + +**Extension is available from:** + +* [Project release page](https://github.com/TriliumNext/web-clipper/releases) - .xpi for Firefox and .zip for Chromium based browsers. +* %%{WARNING}%% [Chrome Web Store](https://chromewebstore.google.com/detail/trilium-web-clipper/dfhgmnfclbebfobmblelddiejjcijbjm) + +## Configuration + +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. + +It's also possible to configure the [server](Server%20Installation.md) address if you don't run the desktop application, or want it to work without the desktop application running. + +## Username + +Older versions of Trilium (before 0.50) required username & password to authenticate, but this is no longer the case. You may enter anything in that field, it will not have any effect. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Web Clipper_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Web Clipper_image.png new file mode 100644 index 000000000..96d6ead20 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Web Clipper_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/Export as PDF.html b/src/public/app/doc_notes/en/User Guide/User Guide/New Features/Export as PDF.html deleted file mode 100644 index f6d2e62c3..000000000 --- a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/Export as PDF.html +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - - Export as PDF - - - -
-

Export as PDF

- -
-
- -
Screenshot of the note contextual menu indicating the “Export as PDF” - option.
-
-

On the desktop application of Trilium it is possible to export a note - as PDF. On the server or PWA (mobile), the option is not available due - to technical constraints and it will be hidden.

-

To print a note, select the - button to the right of the note and select Export as PDF.

-

Afterwards you will be prompted to select where to save the PDF file. - Upon confirmation, the resulting PDF will be opened automatically using - the default/system application configured for PDFs.

-

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 - report the issue. In this case, it's best to offer a sample note (click - on the - button, select Export note → This note and all of its descendants → HTML - in ZIP archive). Make sure not to accidentally leak any personal information.

-

Landscape mode

-

When exporting to PDF, there are no customizable settings such as page - orientation, size, etc. However, it is possible to specify a given note - to be printed as a PDF in landscape mode by adding the #printLandscape attribute - to it (see Adding an attribute to a note).

-

Page size

-

By default, the resulting PDF will be in Letter format. It is possible - to adjust it to another page size via the #printPageSize attribute, - with one of the following values: A0, A1, A2, A3, A4, A5, A6, Legal, Letter, Tabloid, Ledger.

-

Keyboard shortcut

-

It's possible to trigger the export to PDF from the keyboard by going - to Keyboard shortcuts and assigning a key combination - for the exportAsPdf action.

-
-
- - - \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/Right-to-left text notes.html b/src/public/app/doc_notes/en/User Guide/User Guide/New Features/Right-to-left text notes.html deleted file mode 100644 index 58ec7cb03..000000000 --- a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/Right-to-left text notes.html +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - Right-to-left text notes - - - -
-

Right-to-left text notes

- -
-

Trilium now has basic support for right-to-left text, at note level.

-
- - - - - - - -
-
- -
- 		-
- -
-
-
-

Note that only the Text note type supports this.

-

The list of languages is configurable via the a new dedicated settings - page:

-
- -
-

To select the corresponding language of the text, go to “Basic Properties” - and select your desired language.

-

- -

-

Feel free to report any issues regarding right to left support.

-

 

-
-
- - - \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/Zen mode.html b/src/public/app/doc_notes/en/User Guide/User Guide/New Features/Zen mode.html deleted file mode 100644 index 9792a7d32..000000000 --- a/src/public/app/doc_notes/en/User Guide/User Guide/New Features/Zen mode.html +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - Zen mode - - - -
-

Zen mode

- -
-
- -
Screenshot of Zen Mode activated on a Windows 11 system with native title - bar off and background effects on.
-
-

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.

-
- -
Screenshot of the Zen Mode option in the global menu.
-
-

Activating & deactivating

-

The Zen Mode can be activated by accessing the global menu and selecting - the “Zen Mode” option:

-

Aside from the global menu, it's also possible to activate this mode by - using a keyboard shortcut which is Alt+Z by default. Look for toggleZenMode in - the shortcut configuration.

-

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 - icon in the top-right corner of the window or by pressing the keyboard - combination again.

-

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.

-

Moving the window around

-

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.

-
- -
Screenshot of two notes side-by-side while Zen Mode is active, on Windows - 11 with background effects off.
-
-

Split windows and tabs

-

Tabs are completely hidden, however it's still possible to use keyboard - shortcuts such as firstTab (Ctrl+1 by default), secondTab (Ctrl+2 - by default). There are also some newer shortcuts such as activateNextTab (Ctrl+Tab) - or activatePreviousTab (Ctrl+Shift+Tab) that allow easy navigation, - however make sure that they are configured properly in the settings.

-

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.

-

 

-

 

-
-
- - - \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/10_Geo map_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/10_Geo map_image.png index 4e32110f8..f76abe4a4 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/10_Geo map_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/10_Geo map_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/11_Geo map_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/11_Geo map_image.png index 5639d80ae..23209e0ad 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/11_Geo map_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/11_Geo map_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/12_Geo map_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/12_Geo map_image.png index 1b88e14e6..debb47ce3 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/12_Geo map_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/12_Geo map_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/13_Geo map_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/13_Geo map_image.png index adec6e898..9bb397516 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/13_Geo map_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/13_Geo map_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/14_Geo map_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/14_Geo map_image.png index 9292d9bb9..59d0cbbac 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/14_Geo map_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/14_Geo map_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/15_Geo map_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/15_Geo map_image.png index 50401dd2a..c7bb7f704 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/15_Geo map_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/15_Geo map_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/16_Geo map_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/16_Geo map_image.png index 128e1df79..97879b76a 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/16_Geo map_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/16_Geo map_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/17_Geo map_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/17_Geo map_image.png index 0c1519f2c..5982cc31c 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/17_Geo map_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/17_Geo map_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/18_Geo map_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/18_Geo map_image.png index 099642560..4552aaf59 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/18_Geo map_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/18_Geo map_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/1_Book_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/1_Book_image.png new file mode 100644 index 000000000..3e057b562 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/1_Book_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/1_Geo map_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/1_Geo map_image.png index e97de57e4..5639d80ae 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/1_Geo map_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/1_Geo map_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/2_Geo map_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/2_Geo map_image.png index f76abe4a4..1b88e14e6 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/2_Geo map_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/2_Geo map_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/3_Geo map_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/3_Geo map_image.png index 23209e0ad..adec6e898 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/3_Geo map_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/3_Geo map_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/4_Geo map_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/4_Geo map_image.png index debb47ce3..9292d9bb9 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/4_Geo map_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/4_Geo map_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/5_Geo map_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/5_Geo map_image.png index 9bb397516..50401dd2a 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/5_Geo map_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/5_Geo map_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/6_Geo map_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/6_Geo map_image.png index 59d0cbbac..128e1df79 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/6_Geo map_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/6_Geo map_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/7_Geo map_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/7_Geo map_image.png index c7bb7f704..0c1519f2c 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/7_Geo map_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/7_Geo map_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/8_Geo map_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/8_Geo map_image.png index 97879b76a..099642560 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/8_Geo map_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/8_Geo map_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/9_Geo map_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/9_Geo map_image.png index 5982cc31c..e97de57e4 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/9_Geo map_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/9_Geo map_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book.md b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book.md new file mode 100644 index 000000000..aee319f52 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book.md @@ -0,0 +1,20 @@ +# Book +A **Book Note** in Trilium is a special type of [note](../Basic%20Concepts/Note.md) designed to display the contents of its child notes sequentially, creating a linear, book-like reading experience. This format is particularly useful for viewing multiple smaller notes in a cohesive, continuous manner. + +![](Book_image.png) + +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. + +## Features + +### Linear Display + +The Book Note format compiles the contents of all child notes into one continuous view. This makes it ideal for reading extensive information broken into smaller, manageable segments. + +### Grid View Option + +Trilium also offers a "Grid View" option within the Book Note properties. This view presents the child notes in a grid format, allowing for a more visual navigation experience. + +![](1_Book_image.png) + +Switching between these views can be easily managed through the Book Note's settings (or `viewType` attribute), allowing users to choose the format that best suits their reading or navigation preferences. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/10_Calendar View_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/10_Calendar View_image.png index f60aa0acc..71d6c38f1 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/10_Calendar View_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/10_Calendar View_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/11_Calendar View_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/11_Calendar View_image.png index 7e97245a6..052cddb18 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/11_Calendar View_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/11_Calendar View_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/12_Calendar View_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/12_Calendar View_image.png index d3d64f75c..bec9d93e1 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/12_Calendar View_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/12_Calendar View_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/13_Calendar View_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/13_Calendar View_image.png index d588ed568..acf382206 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/13_Calendar View_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/13_Calendar View_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/14_Calendar View_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/14_Calendar View_image.png index b594af6a6..d8d8f87c1 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/14_Calendar View_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/14_Calendar View_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/15_Calendar View_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/15_Calendar View_image.png index 71f7d2dc3..57964953a 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/15_Calendar View_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/15_Calendar View_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/16_Calendar View_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/16_Calendar View_image.png index 46698faac..53ac5632f 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/16_Calendar View_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/16_Calendar View_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/17_Calendar View_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/17_Calendar View_image.png index fceb0563c..aa9e445ad 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/17_Calendar View_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/17_Calendar View_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/18_Calendar View_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/18_Calendar View_image.png index 23a383270..e050184a7 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/18_Calendar View_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/18_Calendar View_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/19_Calendar View_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/19_Calendar View_image.png index 2dea53b64..d46f327a2 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/19_Calendar View_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/19_Calendar View_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/1_Calendar View_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/1_Calendar View_image.png index 71d6c38f1..7e97245a6 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/1_Calendar View_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/1_Calendar View_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/2_Calendar View_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/2_Calendar View_image.png index 052cddb18..d3d64f75c 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/2_Calendar View_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/2_Calendar View_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/3_Calendar View_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/3_Calendar View_image.png index bec9d93e1..d588ed568 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/3_Calendar View_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/3_Calendar View_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/4_Calendar View_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/4_Calendar View_image.png index acf382206..b594af6a6 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/4_Calendar View_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/4_Calendar View_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/5_Calendar View_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/5_Calendar View_image.png index d8d8f87c1..71f7d2dc3 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/5_Calendar View_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/5_Calendar View_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/6_Calendar View_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/6_Calendar View_image.png index 57964953a..46698faac 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/6_Calendar View_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/6_Calendar View_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/7_Calendar View_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/7_Calendar View_image.png index 53ac5632f..fceb0563c 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/7_Calendar View_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/7_Calendar View_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/8_Calendar View_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/8_Calendar View_image.png index aa9e445ad..23a383270 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/8_Calendar View_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/8_Calendar View_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/9_Calendar View_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/9_Calendar View_image.png index e050184a7..2dea53b64 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/9_Calendar View_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/9_Calendar View_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/Calendar View.html b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/Calendar View.html deleted file mode 100644 index d64ff6f88..000000000 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/Calendar View.html +++ /dev/null @@ -1,338 +0,0 @@ - - - - - - - - Calendar View - - - -
-

Calendar View

- -
-
- -
-

The Calendar view of Book notes will display each child note in a calendar - that has a start date and optionally an end date, as an event.

-

Unlike other Book view types, the Calendar view also allows some kind - of interaction, such as moving events around as well as creating new ones.

-

Creating a calendar

-
- - - - - - - - - - - - - - - - - - -
1 -
- -
-

 

- 		-

The Calendar View works only for Book note types. To create a new note, - right click on the note tree on the left and select Insert note after, - or Insert child note and then select Book.

-

 

-
2 -
- -
- 		Once created, the “View type” of the Book needs changed to “Calendar”, - by selecting the “Book Properties” tab in the ribbon.
-
-

Creating a new event/note

-
    -
  • Clicking on a day will create a new child note and assign it to that particular - day. -
      -
    • You will be asked for the name of the new note. If the popup is dismissed - by pressing the close button or escape, then the note will not be created.
      • -
    -
    • -
  • It's possible to drag across multiple days to set both the start and end - date of a particular note. -
    - -
    • -
  • Creating new notes from the calendar will respect the ~child:template relation - if set on the book note.
    • -
-

Interacting with events

-
    -
  • Hovering the mouse over an event will display information about the note. -
    - -
    • -
  • Left clicking the event will go to that note. Middle clicking will open - the note in a new tab and right click will offer more options including - opening the note in a new split or window.
    • -
  • Drag and drop an event on the calendar to move it to another day.
    • -
  • The length of an event can be changed by placing the mouse to the right - edge of the event and dragging the mouse around.
    • -
-

Configuring the calendar

-

The following attributes can be added to the book type:

-
- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
#calendar:hideWeekends - When present (regardless of value), it will hide Saturday and Sundays - from the calendar.
#calendar:weekNumbers - When present (regardless of value), it will show the number of the week - on the calendar.
~child:template - Defines the template for newly created notes in the calendar (via dragging - or clicking).
-
-

In addition, the first day of the week can be either Sunday or Monday - and can be adjusted from the application settings.

-

Configuring the calendar events

-

For each note of the calendar, the following attributes can be used:

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
#startDate - The date the event starts, which will display it in the calendar. The - format is YYYY-MM-DD (year, month and day separated by a minus - sign).
#endDate - Similar to startDate, 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.
#color - Displays the event with a specified color (named such as red, gray or - hex such as #FF0000). This will also change the color of the - note in other places such as the note tree.
#calendar:color - Similar to #color, but applies the color only for the event - in the calendar and not for other places such as the note tree.
#iconClass - If present, the icon of the note will be displayed to the left of the - event title.
#calendar:title - Changes the title of an event to point to an attribute of the note other - than the title, either a label (e.g. #assignee) or a relation - (e.g. ~for). See Advanced use-cases for more information.
#calendar:promotedAttributes - -

Allows displaying the value of one or more promoted attributes in the - calendar like this: - - 

#label:weight="promoted,number,single,precision=1"
-#label:mood="promoted,alias=Mood,single,text"
-#calendar:promotedAttributes="label:weight,label:mood"
-

It can also be used with relations, case in which it will display the - title of the target note:

#relation:assignee="promoted,alias=Assignee,single,text"
-#calendar:promotedAttributes="relation:assignee" 
-~assignee=@My assignee 
-
#calendar:startDate - Allows using a different label to represent the start date, other than #startDate (e.g. #expiryDate). - The label name must be prefixed with #. If the label is not - defined for a note, the default will be used instead.
#calendar:endDate - Allows using a different label to represent the start date, other than #endDate. - The label name must be prefixed with #. If the label is not - defined for a note, the default will be used instead.
-
-

How the calendar works

-

- The calendar displays all the child notes of the book that have a #startDate. - An #endDate can optionally be added.

-

If editing the start date and end date from the note itself is desirable, - the following attributes can be added to the book note:

#viewType=calendar #label:startDate(inheritable)="promoted,alias=Start Date,single,date" #label:endDate(inheritable)="promoted,alias=End Date,single,date" #hidePromotedAttributes
-

This will result in:

-

- -

-

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.

-

Use-cases

-

Using with the Journal / calendar

-

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 Book and then select the Calendar View.

-

Based on the #calendarRoot (or #workspaceCalendarRoot) - attribute, the calendar will know that it's in a calendar and apply the - following:

-
    -
  • The calendar events are now rendered based on their dateNote attribute - rather than startDate.
    • -
  • Interactive editing such as dragging over an empty era or resizing an - event is no longer possible.
    • -
  • Clicking on the empty space on a date will automatically open that day's - note or create it if it does not exist.
    • -
  • Direct children of a day note will be displayed on the calendar despite - not having a dateNote attribute. Children of the child notes - will not be displayed.
    • -
-
- -
-

Using a different attribute as event title

-

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.

-

To do so, assign #calendar:title to the child note (not the - calendar/book note), with the value being #name where name can - be any label. 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.

-
- - - - - - - -
-
- -
- 		-
- -
-
-
-

Using a relation attribute as event title

-

Similarly to using an attribute, use #calendar:title and set - it to ~name where name is the name of the relation - to use.

-

Moreover, if there are more relations of the same name, they will be displayed - as multiple events coming from the same note.

-
- - - - - - - -
-
- -
- 		-
- -
-
-
-

Note that it's even possible to have a #calendar:title on the - target note (e.g. “John Smith”) which will try to render an attribute of - it. Note that it's not possible to use a relation here as well for safety - reasons (an accidental recursion  of attributes could cause the application - to loop infinitely).

-
- - - - - - - -
-
- -
- 		-
- -
-
-
-
-
- - - \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/Calendar View.md b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/Calendar View.md new file mode 100644 index 000000000..b61b4b71c --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/Calendar View.md @@ -0,0 +1,114 @@ +# Calendar View +![](15_Calendar View_image.png) + +The Calendar view of Book notes will display each child note in a calendar that has a start date and optionally an end date, as an event. + +Unlike other Book view types, the Calendar view also allows some kind of interaction, such as moving events around as well as creating new ones. + +## Creating a calendar + +| | | | +| --- | --- | --- | +| 1 | ![](19_Calendar View_image.png) | The Calendar View works only for Book note types. To create a new note, right click on the note tree on the left and select Insert note after, or Insert child note and then select _Book_. | +| 2 | ![](10_Calendar View_image.png) | Once created, the “View type” of the Book needs changed to “Calendar”, by selecting the “Book Properties” tab in the ribbon. | + +## Creating a new event/note + +* Clicking on a day will create a new child note and assign it to that particular day. + * You will be asked for the name of the new note. If the popup is dismissed by pressing the close button or escape, then the note will not be created. +* It's possible to drag across multiple days to set both the start and end date of a particular note. + ![](12_Calendar View_image.png) +* Creating new notes from the calendar will respect the `~child:template` relation if set on the book note. + +## Interacting with events + +* Hovering the mouse over an event will display information about the note. + ![](13_Calendar View_image.png) +* Left clicking the event will go to that note. Middle clicking will open the note in a new tab and right click will offer more options including opening the note in a new split or window. +* Drag and drop an event on the calendar to move it to another day. +* The length of an event can be changed by placing the mouse to the right edge of the event and dragging the mouse around. + +## Configuring the calendar + +The following attributes can be added to the book type: + +| Name | Description | +| --- | --- | +| `#calendar:hideWeekends` | When present (regardless of value), it will hide Saturday and Sundays from the calendar. | +| `#calendar:weekNumbers` | When present (regardless of value), it will show the number of the week on the calendar. | +| `~child:template` | Defines the template for newly created notes in the calendar (via dragging or clicking). | + +In addition, the first day of the week can be either Sunday or Monday and can be adjusted from the application settings. + +## Configuring the calendar events + +For each note of the calendar, the following attributes can be used: + +| Name | Description | +| --- | --- | +| `#startDate` | The date the event starts, which will display it in the calendar. The format is `YYYY-MM-DD` (year, month and day separated by a minus sign). | +| `#endDate` | Similar to `startDate`, 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. | +| `#color` | Displays the event with a specified color (named such as `red`, `gray` or hex such as `#FF0000`). This will also change the color of the note in other places such as the note tree. | +| `#calendar:color` | Similar to `#color`, but applies the color only for the event in the calendar and not for other places such as the note tree. | +| `#iconClass` | If present, the icon of the note will be displayed to the left of the event title. | +| `#calendar:title` | Changes the title of an event to point to an attribute of the note other than the title, either a label (e.g. `#assignee`) or a relation (e.g. `~for`). See _Advanced use-cases_ for more information. | +| `#calendar:promotedAttributes` | Allows displaying the value of one or more promoted attributes in the calendar like this: ![](9_Calendar View_image.png)

```
#label:weight="promoted,number,single,precision=1"
#label:mood="promoted,alias=Mood,single,text"
#calendar:promotedAttributes="label:weight,label:mood"
```

It can also be used with relations, case in which it will display the title of the target note:

```
#relation:assignee="promoted,alias=Assignee,single,text"
#calendar:promotedAttributes="relation:assignee"
~assignee=@My assignee 
``` | +| `#calendar:startDate` | Allows using a different label to represent the start date, other than `#startDate` (e.g. `#expiryDate`). The label name must be prefixed with `#`. If the label is not defined for a note, the default will be used instead. | +| `#calendar:endDate` | Allows using a different label to represent the start date, other than `#endDate`. The label name must be prefixed with `#`. If the label is not defined for a note, the default will be used instead. | + +## How the calendar works + +![](16_Calendar View_image.png)The calendar displays all the child notes of the book that have a `#startDate`. An `#endDate` can optionally be added. + +If editing the start date and end date from the note itself is desirable, the following attributes can be added to the book note: + +``` +#viewType=calendar #label:startDate(inheritable)="promoted,alias=Start Date,single,date" #label:endDate(inheritable)="promoted,alias=End Date,single,date" #hidePromotedAttributes +``` + +This will result in: + +![](18_Calendar View_image.png) + +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. + +## Use-cases + +### Using with the Journal / calendar + +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 Book and then select the Calendar View. + +Based on the `#calendarRoot` (or `#workspaceCalendarRoot`) attribute, the calendar will know that it's in a calendar and apply the following: + +* The calendar events are now rendered based on their `dateNote` attribute rather than `startDate`. +* Interactive editing such as dragging over an empty era or resizing an event is no longer possible. +* Clicking on the empty space on a date will automatically open that day's note or create it if it does not exist. +* Direct children of a day note will be displayed on the calendar despite not having a `dateNote` attribute. Children of the child notes will not be displayed. + +![](8_Calendar View_image.png) + +### Using a different attribute as event title + +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. + +To do so, assign `#calendar:title` to the child note (not the calendar/book note), with the value being `#name` where `name` can be any label. 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. + +| | | +| --- | --- | +| ![](Calendar View_image.png) | ![](1_Calendar View_image.png) | + +### Using a relation attribute as event title + +Similarly to using an attribute, use `#calendar:title` and set it to `~name` where `name` is the name of the relation to use. + +Moreover, if there are more relations of the same name, they will be displayed as multiple events coming from the same note. + +| | | +| --- | --- | +| ![](5_Calendar View_image.png) | ![](3_Calendar View_image.png) | + +Note that it's even possible to have a `#calendar:title` on the target note (e.g. “John Smith”) which will try to render an attribute of it. Note that it's not possible to use a relation here as well for safety reasons (an accidental recursion  of attributes could cause the application to loop infinitely). + +| | | +| --- | --- | +| ![](6_Calendar View_image.png) | ![](7_Calendar View_image.png) | \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/Calendar View_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/Calendar View_image.png index d46f327a2..f60aa0acc 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/Calendar View_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/Calendar View_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book_image.png new file mode 100644 index 000000000..ba4e1dd7a Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Canvas.html b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Canvas.html deleted file mode 100644 index e6e298e75..000000000 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Canvas.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - - - - Canvas - - - -
-

Canvas

- -
-
- - - \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Canvas.md b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Canvas.md new file mode 100644 index 000000000..e69de29bb diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Code.html b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Code.html deleted file mode 100644 index b1b6dc876..000000000 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Code.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - - - - Code - - - -
-

Code

- -
-
- - - \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Code.md b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Code.md new file mode 100644 index 000000000..e69de29bb diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Geo map.html b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Geo map.html deleted file mode 100644 index 9f3b83809..000000000 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Geo map.html +++ /dev/null @@ -1,335 +0,0 @@ - - - - - - - - Geo map - - - -
-

Geo map

- -
-

Creating a new geo map

-
- - - - - - - - - - - - - - - - - - -
1 -
- -
- 		Right click on any note on the note tree and select Insert child note → Geo Map (beta).
2 -
- -
- 		By default the map will be empty and will show the entire world.
-
-

Repositioning the map

-
    -
  • Click and drag the map in order to move across the map.
    • -
  • Use the mouse wheel, two-finger gesture on a touchpad or the +/- buttons - on the top-left to adjust the zoom.
    • -
-

The position on the map and the zoom are saved inside the map note and - restored when visiting again the note.

-

Adding a marker using the map

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1  -

To create a marker, first navigate to the desired point on the map. Then - press the - button on the top-right of the map.

-

If the button is not visible, make sure the button section is visible - by pressing the chevron button ( - ) in the top-right of the map.

-
2 -
- -
-

 

- 		-

Once pressed, the map will enter in the insert mode, as illustrated by - the notification.

-

Simply click the point on the map where to place the marker, or the Escape - key to cancel.

-
3 -
- -
-

 

- 		Enter the name of the marker/note to be created. 
4 -
- -
-

 

- 		Once confirmed, the marker will show up on the map and it will also be - displayed as a child note of the map.
-
-

How the location of the markers is stored

-

The location of a marker is stored in the #geolocation attribute - of the child notes:

-
- -
-

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.

-

Repositioning markers

-

It's possible to reposition existing markers by simply drag and dropping - them to the new destination.

-

As soon as the mouse is released, the new position is saved.

-

If moved by mistake, there is currently no way to undo the change. If - the mouse was not yet released, it's possible to force a refresh of the - page (Ctrl+R or Meta+R) to cancel it.

-

Interaction with the markers

-
    -
  • Hovering over a marker will display the content of the note it belongs - to. -
      -
    • Clicking on the note title in the tooltip will navigate to the note in - the current view.
      • -
    -
    • -
  • Middle-clicking the marker will open the note in a new tab.
    • -
  • Right-clicking the marker will open a contextual menu allowing: -
      -
    • Opening the note in a new tab, split or window.
      • -
    • Opening the location using an external application (if the operating system - supports it).
      • -
    • Removing the marker from the map, which will remove the #geolocation attribute - of the note. To add it back again, the coordinates have to be manually - added back in.
      • -
    -
    • -
-

Icon and color of the markers

-

- image -

-

The markers will have the same icon as the note.

-

It's possible to add a custom color to a marker by assigning them a #color attribute - such as #color=green.

-

Adding the coordinates manually

-

In a nutshell, create a child note and set the #geolocation attribute - to the coordinates.

-

The value of the attribute is made up of the latitude and longitude separated - by a comma.

-

Adding from Google Maps

-
- - - - - - - - - - - - - - - - - - -
1 -
- -
- 		-

Go to Google Maps on the web and look for a desired location, right click - on it and a context menu will show up.

-

Simply click on the first item displaying the coordinates and they will - be copied to clipboard.

-

Then paste the value inside the text box into the #geolocation attribute - of a child note of the map (don't forget to surround the value with a " character).

-
2 -
- -
- 		-

In Trilium, create a child note under the map.

-

 

-

 

-
3 -
- -
- 		And then go to Owned Attributes and type #geolocation=", then - paste from the clipboard as-is and then add the ending " character. - Press Enter to confirm and the map should now be updated to contain the - new note.
-
-

Adding from OpenStreetMap

-

Similarly to the Google Maps approach:

-
- - - - - - - - - - - - - - - - - - - - - - - -
1 -
- -
- 		Go to any location on openstreetmap.org and right click to bring up the - context menu. Select the “Show address” item.
2 -
- -
- 		-

The address will be visible in the top-left of the screen, in the place - of the search bar.

-

Select the coordinates and copy them into the clipboard.

-
3 -
- -
- 		Simply paste the value inside the text box into the #geolocation attribute - of a child note of the map and then it should be displayed on the map.
-
-

Adding GPS tracks (.gpx)

-

Trilium has basic support for displaying GPS tracks on the geo map.

-
- - - - - - - - - - - - - - - - - - - - - - - -
1 -
- -
- 		To add a track, simply drag & drop a .gpx file inside the geo map - in the note tree.
2 -
- -
- 		In order for the file to be recognized as a GPS track, it needs to show - up as application/gpx+xml in the File type field.
3 -
- -
- 		-

When going back to the map, the track should now be visible.

-

The start and end points of the track are indicated by the two blue markers.

-

 

-
-
-

Troubleshooting

-

Grid-like artifacts on the map

-

- -

-

This occurs if the application is not at 100% zoom which causes the pixels - of the map to not render correctly due to fractional scaling. The only - possible solution i to set the UI zoom at 100% (default keyboard shortcut - is Ctrl+0).

-

 

-
-
- - - \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Geo map.md b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Geo map.md new file mode 100644 index 000000000..8db568c99 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Geo map.md @@ -0,0 +1,99 @@ +# Geo map +## Creating a new geo map + +| | | | +| --- | --- | --- | +| 1 | ![](15_Geo map_image.png) | Right click on any note on the note tree and select _Insert child note_ → _Geo Map (beta)_. | +| 2 | ![](10_Geo map_image.png) | By default the map will be empty and will show the entire world. | + +## Repositioning the map + +* Click and drag the map in order to move across the map. +* Use the mouse wheel, two-finger gesture on a touchpad or the +/- buttons on the top-left to adjust the zoom. + +The position on the map and the zoom are saved inside the map note and restored when visiting again the note. + +## Adding a marker using the map + +| | | | +| --- | --- | --- | +| 1 | | To create a marker, first navigate to the desired point on the map. Then press the ![](11_Geo map_image.png)button on the top-right of the map.

If the button is not visible, make sure the button section is visible by pressing the chevron button ( ![](16_Geo map_image.png)) in the top-right of the map. | +| 2 | ![](2_Geo map_image.png) | Once pressed, the map will enter in the insert mode, as illustrated by the notification.

Simply click the point on the map where to place the marker, or the Escape key to cancel. | +| 3 | ![](18_Geo map_image.png) | Enter the name of the marker/note to be created. | +| 4 | ![](13_Geo map_image.png) | Once confirmed, the marker will show up on the map and it will also be displayed as a child note of the map. | + +## How the location of the markers is stored + +The location of a marker is stored in the `#geolocation` attribute of the child notes: + +![](Geo map_image.png) + +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. + +## Repositioning markers + +It's possible to reposition existing markers by simply drag and dropping them to the new destination. + +As soon as the mouse is released, the new position is saved. + +If moved by mistake, there is currently no way to undo the change. If the mouse was not yet released, it's possible to force a refresh of the page (Ctrl+R or Meta+R) to cancel it. + +## Interaction with the markers + +* Hovering over a marker will display the content of the note it belongs to. + * Clicking on the note title in the tooltip will navigate to the note in the current view. +* Middle-clicking the marker will open the note in a new tab. +* Right-clicking the marker will open a contextual menu allowing: + * Opening the note in a new tab, split or window. + * Opening the location using an external application (if the operating system supports it). + * Removing the marker from the map, which will remove the `#geolocation` attribute of the note. To add it back again, the coordinates have to be manually added back in. + +## Icon and color of the markers + +![image](8_Geo map_image.png) + +The markers will have the same icon as the note. + +It's possible to add a custom color to a marker by assigning them a `#color` attribute such as `#color=green`. + +## Adding the coordinates manually + +In a nutshell, create a child note and set the `#geolocation` attribute to the coordinates. + +The value of the attribute is made up of the latitude and longitude separated by a comma. + +### Adding from Google Maps + +| | | | +| --- | --- | --- | +| 1 | ![](4_Geo map_image.png) | Go to Google Maps on the web and look for a desired location, right click on it and a context menu will show up.

Simply click on the first item displaying the coordinates and they will be copied to clipboard.

Then paste the value inside the text box into the `#geolocation` attribute of a child note of the map (don't forget to surround the value with a `"` character). | +| 2 | ![](6_Geo map_image.png) | In Trilium, create a child note under the map. | +| 3 | ![](17_Geo map_image.png) | And then go to Owned Attributes and type `#geolocation="`, then paste from the clipboard as-is and then add the ending `"` character. Press Enter to confirm and the map should now be updated to contain the new note. | + +### Adding from OpenStreetMap + +Similarly to the Google Maps approach: + +| | | | +| --- | --- | --- | +| 1 | ![](5_Geo map_image.png) | Go to any location on openstreetmap.org and right click to bring up the context menu. Select the “Show address” item. | +| 2 | ![](1_Geo map_image.png) | The address will be visible in the top-left of the screen, in the place of the search bar.

Select the coordinates and copy them into the clipboard. | +| 3 | ![](9_Geo map_image.png) | Simply paste the value inside the text box into the `#geolocation` attribute of a child note of the map and then it should be displayed on the map. | + +## Adding GPS tracks (.gpx) + +Trilium has basic support for displaying GPS tracks on the geo map. + +| | | | +| --- | --- | --- | +| 1 | ![](14_Geo map_image.png) | To add a track, simply drag & drop a .gpx file inside the geo map in the note tree. | +| 2 | ![](12_Geo map_image.png) | In order for the file to be recognized as a GPS track, it needs to show up as `application/gpx+xml` in the _File type_ field. | +| 3 | ![](3_Geo map_image.png) | When going back to the map, the track should now be visible.

The start and end points of the track are indicated by the two blue markers. | + +## Troubleshooting + +![](7_Geo map_image.png) + +### Grid-like artifacts on the map + +This occurs if the application is not at 100% zoom which causes the pixels of the map to not render correctly due to fractional scaling. The only possible solution is to set the UI zoom at 100% (default keyboard shortcut is Ctrl+0). \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Geo map_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Geo map_image.png index 4552aaf59..4e32110f8 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Geo map_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Geo map_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagram.html b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagram.html deleted file mode 100644 index bbe5d76cc..000000000 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagram.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - - - - Mermaid Diagram - - - -
-

Mermaid Diagram

- -
-
- - - \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams.md b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams.md new file mode 100644 index 000000000..4e0f399b5 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams.md @@ -0,0 +1,21 @@ +# Mermaid Diagrams +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. + +For the official documentation of Mermaid.js see [mermaid.js.org/intro/](https://mermaid.js.org/intro/). + +## ELK layout engine + +Mermaid supports a different layout engine which supports slightly more complex diagrams, called the [Eclipse Layout Kernel (ELK)](https://eclipse.dev/elk/). Trilium has support for these as well, but it's not enabled by default. + +In order to activate ELK for any diagram, insert the following YAML frontmatter right at the beginning of the diagram: + +```yaml +--- +config: + layout: elk +--- +``` + +| With ELK off | With ELK on | +| --- | --- | +| ![](Mermaid%20Diagrams/ELK%20off.txt) | ![](Mermaid%20Diagrams/ELK%20on.txt) | \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams/ELK off.txt b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams/ELK off.txt new file mode 100644 index 000000000..353f1ded4 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams/ELK off.txt @@ -0,0 +1,14 @@ +--- +title: Interfaces for B +--- +flowchart LR +A-->|"Guarantee"|B +C-->|"User attributes"|B +C-.->|"Master data"|B +C-->|"Exchange Rate"|B +C-->|"Profit Centers"|B +C-->|"Vendor Partners"|B +C-->|"Work Situation"|B +C-->|"Customer"|B +C-->|"Profit Centers"|B +B-->|"Guarantee"|C \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams/ELK off_mermaid-export.svg b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams/ELK off_mermaid-export.svg new file mode 100644 index 000000000..2934db9da --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams/ELK off_mermaid-export.svg @@ -0,0 +1 @@ +

Guarantee

User attributes

Master data

Exchange Rate

Profit Centers

Vendor Partners

Work Situation

Customer

Profit Centers

Guarantee

A

B

C

Interfaces for B \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams/ELK on.txt b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams/ELK on.txt new file mode 100644 index 000000000..4298215d0 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams/ELK on.txt @@ -0,0 +1,16 @@ +--- +title: Interfaces for B +config: + layout: elk +--- +flowchart LR +A-->|"Guarantee"|B +C-->|"User attributes"|B +C-.->|"Master data"|B +C-->|"Exchange Rate"|B +C-->|"Profit Centers"|B +C-->|"Vendor Partners"|B +C-->|"Work Situation"|B +C-->|"Customer"|B +C-->|"Profit Centers"|B +B-->|"Guarantee"|C \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams/ELK on_mermaid-export.svg b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams/ELK on_mermaid-export.svg new file mode 100644 index 000000000..d63356ec4 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Mermaid Diagrams/ELK on_mermaid-export.svg @@ -0,0 +1 @@ +

A

B

C

Guarantee

User attributes

Master data

Exchange Rate

Profit Centers

Vendor Partners

Work Situation

Customer

Profit Centers

Guarantee

Interfaces for B \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Mind Map.html b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Mind Map.html deleted file mode 100644 index ce5b0a2ff..000000000 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Mind Map.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - - - - Mind Map - - - -
-

Mind Map

- -
-
- - - \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Mind Map.md b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Mind Map.md new file mode 100644 index 000000000..e69de29bb diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Note Map.html b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Note Map.html deleted file mode 100644 index 3fe7b46f0..000000000 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Note Map.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - - - - Note Map - - - -
-

Note Map

- -
-
- - - \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Note Map.md b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Note Map.md new file mode 100644 index 000000000..e69de29bb diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Relation Map.html b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Relation Map.html deleted file mode 100644 index 609c125bb..000000000 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Relation Map.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - - - - Relation Map - - - -
-

Relation Map

- -
-
- - - \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Relation Map.md b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Relation Map.md new file mode 100644 index 000000000..e69de29bb diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Render Note.html b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Render Note.html deleted file mode 100644 index fcebc8389..000000000 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Render Note.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - - - - Render Note - - - -
-

Render Note

- -
-
- - - \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Render Note.md b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Render Note.md new file mode 100644 index 000000000..e69de29bb diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Saved Search.html b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Saved Search.html deleted file mode 100644 index 50fd25d9a..000000000 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Saved Search.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - - - - Saved Search - - - -
-

Saved Search

- -
-
- - - \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Saved Search.md b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Saved Search.md new file mode 100644 index 000000000..99e89c6fd --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Saved Search.md @@ -0,0 +1,8 @@ +# Saved Search +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: + +![save-search](../Attachments/saved-search-image.gif) + +## Location + +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 `#searchHome` label. Additionally, for [workspaces](../Basic%20Concepts/Navigation/Workspace.md), you can use the `#workspaceSearchHome` label to specify a storage location for saved searches within that workspace. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text.md b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text.md new file mode 100644 index 000000000..2699d0f22 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text.md @@ -0,0 +1,90 @@ +# Text +Trilium utilizes the powerful [CKEditor 5](https://ckeditor.com/ckeditor-5/) as its text editing component. + +## Formatting Options + +The Trilium text note interface does not display toolbars or formatting options by default. These can be accessed by: + +![inline note formatting](../Attachments/text-notes-formatting-inli.png) + +1. Selecting text to bring up an inline toolbar. + +![formating note block](../Attachments/text-notes-formatting-bloc.png)2\. Clicking on the block toolbar. + +## Read-Only vs. Editing Mode + +Text notes are usually opened in edit mode. However, they may open in read-only mode under the following circumstances: + +* The note is long and would take time to load, so it is opened in read-only mode by default for quicker access. +* The note has a `readOnly` [label](../Advanced%20Usage/Attributes.md). + +In both cases, it is possible to switch back to editable mode using the ![](Text_bx-edit-alt.svg)button at top right of page. + +For more information, see [Read-Only Notes](../Basic%20Concepts/Note/Read-Only%20Notes.md). + +## General Formatting + +Since Trilium uses CKEditor, all of its formatting options are available here. You may use the graphical toolbar shown above, or enter formatting such as markdown markdown directly in the text. Examples include: + +* **Bold**: Type `**text**` or `__text__` +* _Italic_: Type `*text*` or `_text_` +* `Code`: Type \`text\` +* ~~Strikethrough~~: Type `~~text~~` + +### Lists + +See [Lists](Text/Lists.md). + +### Blocks + +* Block quote: Start a line with `>` followed by a space + +### Multi-Line Code Blocks + +To create a multi-line code block, start a line with "\`\`\`\[lang\]", for example: + +``` +if (1 > 2) { + console.log("Error in the matrix"); +} +``` + +### Headings + +Create headings by starting a line with `##` for heading 2, `###` for heading 3, and so on up to heading 6. Note that `#` is reserved for the title. + +### Horizontal Line + +Insert a horizontal line by starting a line with `---`. + +## Markdown & Autoformat + +CKEditor supports a markdown-like editing experience, recognising syntax and automatically converting it to rich text. + +![](Text_image.png) + +Complete documentation for this feature is available in the [CKEditor documentation](https://ckeditor.com/docs/ckeditor5/latest/features/autoformat.html). + +If autoformatting is not desirable, press `CTRL-Z` to revert the text to its original form. + +Note: The use of `#` for Heading 1 is not supported because it is reserved for the title. Start with `##` for Heading 2. More information is available [here](https://ckeditor.com/docs/ckeditor5/latest/features/headings.html#heading-levels). + +## Math Support + +Trilium provides math support through [KaTeX](https://katex.org/). + +## Cutting Selection to Sub-Note + +When editing a document that becomes too large, you can split it into sub-notes: + +1. Select the desired text and cut it to the clipboard. +2. Create a new sub-note and name it. +3. Paste the content from the clipboard into the sub-note. + +Trilium can automate this process. Select some text within the note, and in the selection toolbar, click the scissors icon for the "cut & pasted selection to sub-note" action. The heading is automatically detected and the new sub-note is named accordingly. You can also assign a keyboard shortcut for this action. This functionality is available through the block toolbar icon. + +## Including a Note + +Text notes can "include" another note as a read only widget. This can be useful for e.g. including a dynamically generated chart (from scripts & "render HTML" note) or other more advanced use cases. + +This functionality is available in the block toolbar icon. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Lists_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Lists_image.png new file mode 100644 index 000000000..ed6f4c37c Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/1_Lists_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/2_Lists_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/2_Lists_image.png new file mode 100644 index 000000000..fba0cc85c Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/2_Lists_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/3_Lists_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/3_Lists_image.png new file mode 100644 index 000000000..30a9511b0 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/3_Lists_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/4_Lists_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/4_Lists_image.png new file mode 100644 index 000000000..32992762a Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/4_Lists_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/5_Lists_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/5_Lists_image.png new file mode 100644 index 000000000..0ab30524b Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/5_Lists_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Content language.html b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Content language.html deleted file mode 100644 index b6313e6c7..000000000 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Content language.html +++ /dev/null @@ -1,34 +0,0 @@ - - - - - - - - Content language - - - -
-

Content language

- -
-

A language hint can be provided for text notes. This option informs the - browser or the desktop application about the language the note is written - in (for example this might help with spellchecking), and it also determines - whether the text is displayed from right-to-left for languages such as - Arabic, Hebrew, etc.

-

For more information about right-to-left support, see Right-to-left text notes.

-

To set the language of the content, go to “Basic Properties” and look - for the “Language” field. By default there will be no content languages - set, they can be configured by going to settings or by selecting the “Configure - languages” item in the list.

-

- -

-
-
- - - \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Content language.md b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Content language.md new file mode 100644 index 000000000..12922f162 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Content language.md @@ -0,0 +1,8 @@ +# Content language +A language hint can be provided for text notes. This option informs the browser or the desktop application about the language the note is written in (for example this might help with spellchecking), and it also determines whether the text is displayed from right-to-left for languages such as Arabic, Hebrew, etc. + +For more information about right-to-left support, see [Right-to-left text notes](../../Basic%20Concepts/Note/Right-to-Left%20Support.md). + +To set the language of the content, go to “Basic Properties” and look for the “Language” field. By default there will be no content languages set, they can be configured by going to settings or by selecting the “Configure languages” item in the list. + +![](Content language_image.png) \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Lists.md b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Lists.md new file mode 100644 index 000000000..7b289ba94 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Lists.md @@ -0,0 +1,27 @@ +# Lists +There are three types of lists supported by text notes: + +* Bulleted lists (also known as unordered lists). +* Numbered lists (or ordered lists). +* To-do lists + +## Keyboard shortcuts + +* Bulleted list: Start a line with `*` or `-` followed by a space; +* Numbered list: Start a line with `1.` or `1)` followed by a space; +* To-do list: Start a line with `[ ]` for an unchecked item or `[x]` for a checked item. + +## Headings, code blocks within lists + +It possible to add content-level blocks such as headings, code blocks, tables within lists, as follows: + +| | | +| --- | --- | +| ![](5_Lists_image.png) | First, create a list. | +| ![](Lists_image.png) | Press Enter to create a new list item. | +| ![](1_Lists_image.png) | Press Backspace to get rid of the bullet point. Notice the cursor position. | +| ![](2_Lists_image.png) | At this point, insert any desired block-level item such as a code block. | +| ![](3_Lists_image.png) | To continue with a new bullet point, press Enter until the cursor moves to a new blank position. | +| ![](4_Lists_image.png) | Press Enter once more to create the new bullet. | + +The same principle applies to all three list types (bullet, numbered and to-do). \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Lists_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Lists_image.png new file mode 100644 index 000000000..8369a03c6 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Lists_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text_bx-edit-alt.svg b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text_bx-edit-alt.svg new file mode 100644 index 000000000..69dbf5040 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text_bx-edit-alt.svg @@ -0,0 +1 @@ + diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text_image.png new file mode 100644 index 000000000..2ea269012 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Web View.html b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Web View.html deleted file mode 100644 index c9fd6a190..000000000 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Web View.html +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - - - Web View - - - -
-

Web View

- -
-

Configuration

-

A webview needs to know which URL to render, and it can be provided by - setting the webViewSrc attribute, such as:

#webViewSrc="https://www.wikipedia.org"
-

Web view on the server vs. Electron

-

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.

-

More specifically, quite a few websites oppose being embedded in another - website (technically they have a non-permisive X-Frame-Options header). - This is not bypassable by Trilium so the page will simply fail to render.

-

You can diagnose this by right clicking the Trilium web page → Inspect - (element) and looking in the “Console” tab for errors such as:

-
    -
  • Refused to display 'https://www.google.com/' in a frame because it set 'X-Frame-Options' to 'sameorigin'. -
    • -
  • Refused to frame 'https://duckduckgo.com/' because an ancestor violates the following Content Security Policy directive: "frame-ancestors 'self' https://html.duckduckgo.com". -
    • -
-

There are a few websites that do render such as wikipedia.org.

-

Do note that we are also applying some sandboxing constraints on the server - side, so if you have any issues other than the unresolvable X-Frame-Options described - above, feel free to report them.

-

On the desktop side, a different technology is used which bypasses the - constraints of an iframe (webview).

-
-
- - - \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Web View.md b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Web View.md new file mode 100644 index 000000000..680fb653f --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Web View.md @@ -0,0 +1,25 @@ +# Web View +## Configuration + +A webview needs to know which URL to render, and it can be provided by setting the `webViewSrc` attribute, such as: + +``` +#webViewSrc="https://www.wikipedia.org" +``` + +## Web view on the server vs. Electron + +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. + +More specifically, quite a few websites oppose being embedded in another website (technically they have a non-permisive `X-Frame-Options` header). This is not bypassable by Trilium so the page will simply fail to render. + +You can diagnose this by right clicking the Trilium web page → Inspect (element) and looking in the “Console” tab for errors such as: + +* `Refused to display 'https://www.google.com/' in a frame because it set 'X-Frame-Options' to 'sameorigin'.` +* `Refused to frame 'https://duckduckgo.com/' because an ancestor violates the following Content Security Policy directive: "frame-ancestors 'self' https://html.duckduckgo.com".` + +There are a few websites that do render such as `wikipedia.org`. + +Do note that we are also applying some sandboxing constraints on the server side, so if you have any issues other than the unresolvable `X-Frame-Options` described above, feel free to report them. + +On the desktop side, a different technology is used which bypasses the constraints of an `iframe` (`webview`). \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Quick Start.md b/src/public/app/doc_notes/en/User Guide/User Guide/Quick Start.md new file mode 100644 index 000000000..0cad4b291 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Quick Start.md @@ -0,0 +1,24 @@ +# Quick Start +## Choose the setup + +**Local only desktop/laptop** - Allows a single instance on a desktop and will save the notes locally on that desktop. + +1. [Desktop installation](Installation%20%26%20Setup/Desktop%20Installation.md) + +**Server with web only access** - Installs the application on the server and allows access from any web browser on any device, including mobile. + +1. [Server installation](Installation%20%26%20Setup/Server%20Installation.md) +2. [Mobile frontend](Installation%20%26%20Setup/Mobile%20Frontend.md) (optional) +3. [![Deploy](Attachments/home-button.svg)](https://heroku.com/deploy?template=https://github.com/feilongfl/trilium-heroku) %%{WARNING}%% +4. [PikaPods managed hosting](https://www.pikapods.com/pods?run=trilium-next) + +**Combination of server and desktop/laptop** - Install the application on both a server, for web access and data synchronization, 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. + +1. [Server installation](Installation%20%26%20Setup/Server%20Installation.md) +2. [Mobile frontend](Installation%20%26%20Setup/Mobile%20Frontend.md) (optional) +3. [Desktop installation](Installation%20%26%20Setup/Desktop%20Installation.md) +4. [Synchronization](Installation%20%26%20Setup/Synchronization.md) + +## Basic concepts + +1. Understand [Note](Basic%20Concepts/Note.md) \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Scripting/Examples/Downloading responses from Goo.html b/src/public/app/doc_notes/en/User Guide/User Guide/Scripting/Examples/Downloading responses from Goo.html deleted file mode 100644 index fdffa270d..000000000 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Scripting/Examples/Downloading responses from Goo.html +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - - Downloading responses from Google Forms - - - -
-

Downloading responses from Google Forms

- -
-

This tutorials showcases a basic integration with Google Forms, where - we are able to download the responses of a form using the “Link to Sheets" - functionality.

-

Note that the link will be publicly accessible to everyone (however the - link is in a hard-to-guess format such as https://docs.google.com/spreadsheets/d/e/2PACX-1vTA8NU2_eZFhc8TFadCZPreBfvP7un8IHd6J0SchrLLw3ueGmntNZjwRmsH2ZRcp1pJYDAzMz1FmFaj/pub?output=csv). - Make sure you are not accidentally publishing sensitive information.

-

Obtaining the CSV link

-
    -
  1. Open the Google Forms in a browser.
    2. -
  2. Select the “Responses” tab and click on “Link to Sheets”.
    3. -
  3. Select “Create a new spreadsheet” and press “Create”.
    4. -
  4. In Google Sheets, select File → Share → Publish to web.
    5. -
  5. In the “Publish to the web” screen, make sure the “Link” tab is selected - and instead of “Web page”, select “Comma-separated values (.csv)”.
    6. -
  6. Copy the given link which will be used for the upcoming script.
    7. -
-

Creating the script

-

Create a “JS Frontend” script:

const CSV_URL = "https://docs.google.com/spreadsheets/d/e/2PACX-1vTiwooLV2whjCSVa49dJ99p_G3_qhqHHRqttMjYCJVfLXVdTgUSNJu5K0rpqmaHYF2k7Vofi3o7gW82/pub?output=csv";
-
-
-async function fetchData() {
-
-    try {
-
-        const response = await fetch(CSV_URL);
-
-        return await response.text();
-
-    } catch (e) {
-
-        api.showError(e.message);
-
-    }
-
-}
-
-const data = await fetchData();
-console.log(data);
-// Do something with the data.
-

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:

const content = data
-	.split("\n")
-	.slice(1)
-	.map((row) => row.split(","));
-

This will return the data as an array of arrays.

-
-
- - - \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Scripting/Using promoted attributes to c.html b/src/public/app/doc_notes/en/User Guide/User Guide/Scripting/Using promoted attributes to c.html deleted file mode 100644 index ed985a1b0..000000000 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Scripting/Using promoted attributes to c.html +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - Using promoted attributes to configure scripts - - - -
-

Using promoted attributes to configure scripts

- -
-

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.

-

- -

-

Using check boxes to toggle flags

-

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.

-

To do so, first define the promoted attribute:

#label:groupByExtension="promoted,alias=Group by extension,single,boolean"
-

Then use it:

const byExtension = api.currentNote.getLabelValue("groupByExtension") === "true";
-if (byExtension) {
-	// Do something.
-}
-

This will work equally well in both front-end and back-end scripts.

-

Using relations to select notes

-

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:

#relation:input="promoted,alias=Input,single" #relation:output="promoted,alias=Output,single"
-

Once we have this, we can add some basic error handling to ensure that - the fields are completed by the user:

const inputNoteId = api.currentNote.getRelationValue("input");   
-if (!inputNoteId) {
-	api.showError("Missing input.");
-    return;
-}
-
-const outputNoteId = api.currentNote.getRelationValue("output");
-if (!outputNoteId) {
-    api.showError("Missing output.");
-    return;
-}
-

Note that here we are using api.showError which is only available - for frontend notes. If you are writing a backend note, simply remove api.showError but - the user will no feedback on why the script did not execute properly.

-

Afterwards we can simply read the note and do something with it:

const note = api.getNote(inputNoteId);
-if (!note) {
-	return;
-}
-const content = note.getContent().toString("utf-8");
-
-
- - - \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Shared notes/Serving directly the content o.html b/src/public/app/doc_notes/en/User Guide/User Guide/Shared notes/Serving directly the content o.html deleted file mode 100644 index d64d24e2e..000000000 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Shared notes/Serving directly the content o.html +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - Serving directly the content of a note - - - -
-

Serving directly the content of a note

- -
-

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.

-
- - - - - - - - - - - -
-
- -
A note displayed as a web page (HTML)
-
- 		-
- -
A note displayed as a raw format
-
-
-
-

By adding an attribute to the note

-

Simply add the #shareRaw attribute and the note will always - be rendered raw when accessed from the share URL.

-

By altering the URL

-

Append ?raw to the URL to display a note in its raw format - regardless of whether the #shareRaw attribute is added on the - note.

-

- -

-

 

-
-
- - - \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/1_Creating a custom theme_im.png b/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/1_Creating a custom theme_im.png new file mode 100644 index 000000000..a88f2379e Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/1_Creating a custom theme_im.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/1_Custom app-wide CSS_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/1_Custom app-wide CSS_image.png new file mode 100644 index 000000000..99bb043e2 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/1_Custom app-wide CSS_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/2_Creating a custom theme_im.png b/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/2_Creating a custom theme_im.png new file mode 100644 index 000000000..733ac21d1 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/2_Creating a custom theme_im.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/2_Custom app-wide CSS_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/2_Custom app-wide CSS_image.png new file mode 100644 index 000000000..57d357a17 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/2_Custom app-wide CSS_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/3_Creating a custom theme_im.png b/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/3_Creating a custom theme_im.png new file mode 100644 index 000000000..ab66f9ecf Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/3_Creating a custom theme_im.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/4_Creating a custom theme_im.png b/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/4_Creating a custom theme_im.png new file mode 100644 index 000000000..60ed508e2 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/4_Creating a custom theme_im.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/5_Creating a custom theme_im.png b/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/5_Creating a custom theme_im.png new file mode 100644 index 000000000..59dccde8c Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/5_Creating a custom theme_im.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme.md b/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme.md new file mode 100644 index 000000000..941d6cc3e --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme.md @@ -0,0 +1,46 @@ +# Creating a custom theme +## Step 1. Find a place to place the themes + +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. + +As such, the first step is to create a new note to gather all the themes. + +![](4_Creating a custom theme_im.png) + +## Step 2. Create the theme + +| | | +| --- | --- | +| ![](2_Creating a custom theme_im.png) | Themes are code notes with a special attribute. Start by creating a new code note. | +| ![](Creating a custom theme_im.png) | Then change the note type to a CSS code. | +| ![](5_Creating a custom theme_im.png) | 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. | + +## Step 3. Define the theme's CSS + +As a very simple example we will change the background color of the launcher pane to a shade of blue. + +To alter the different variables of the theme: + +```css +:root { + --launcher-pane-background-color: #0d6efd; +} +``` + +## Step 4. Activating the theme + +Refresh the application (Ctrl+Shift+R is a good way to do so) and go to settings. You should see the newly created theme: + +![](1_Creating a custom theme_im.png) + +Afterwards the application will refresh itself with the new theme: + +![](3_Creating a custom theme_im.png) + +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) + +## Step 5. Making changes + +Simply go back to the note and change according to needs. To apply the changes to the current window, press Ctrl+Shift+R to refresh. + +It's a good idea to keep two windows, one for editing and the other one for previewing the changes. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme_im.png b/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme_im.png new file mode 100644 index 000000000..f90ec6f54 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme_im.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/Custom app-wide CSS.md b/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/Custom app-wide CSS.md new file mode 100644 index 000000000..5f90daeef --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/Custom app-wide CSS.md @@ -0,0 +1,32 @@ +# Custom app-wide CSS +It is possible to provide a CSS file to be used regardless of the theme set by the user. + +| | | +| --- | --- | +| ![](Custom app-wide CSS_image.png) | Start by creating a new note and changing the note type to CSS | +| ![](1_Custom app-wide CSS_image.png) | In the ribbon, press the “Owned Attributes” section and type `#appCss`. | +| ![](2_Custom app-wide CSS_image.png) | Type the desired CSS.

Generally it's a good idea to append `!important` for the styles that are being changed, in order to prevent other | + +## Seeing the changes + +Adding a new _app CSS note_ or modifying an existing one does not immediately apply changes. To see the changes, press Ctrl+Shift+R to refresh the page first. + +## Example use-case: customizing the printing stylesheet + +When printing a document or exporting as PDF, it is possible to adjust the style by creating a CSS note that uses the `@media` selector. + +For example, to change the font of the document from the one defined by the theme or the user to a serif one: + +``` +@media print { + + body { + + --main-font-family: serif !important; + + --detail-font-family: var(--main-font-family) !important; + + } + +} +``` \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/Custom app-wide CSS_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/Custom app-wide CSS_image.png new file mode 100644 index 000000000..24f08ad6a Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/Custom app-wide CSS_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/Customize the Next theme.md b/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/Customize the Next theme.md new file mode 100644 index 000000000..00aceeb53 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/Customize the Next theme.md @@ -0,0 +1,21 @@ +# Customize the Next theme +By default, any custom theme will be based on the legacy light theme. To use the TriliumNext theme instead, add the `#appThemeBase=next` attribute onto the existing theme. The `appTheme` attribute must also be present. + +![](Customize the Next theme_i.png) + +The `appThemeBase` label can be set to one of the following values: + +* `next`, for the TriliumNext (auto light or dark mode). +* `next-light`, for the always light mode of the TriliumNext. +* `next-dark`, for the always dark mode of the TriliumNext. +* Any other value is ignored and will use the legacy white theme instead. + +## Overrides + +Do note that the TriliumNext theme has a few more overrides than the legacy theme, so you might need to suffix `!important` if the style changes are not applied. + +```css +:root { + --launcher-pane-background-color: #0d6efd !important; +} +``` \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/Customize the Next theme_i.png b/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/Customize the Next theme_i.png new file mode 100644 index 000000000..83b9d7d10 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/Customize the Next theme_i.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/Reference.md b/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/Reference.md new file mode 100644 index 000000000..1e8e968ca --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/Reference.md @@ -0,0 +1,198 @@ +# Reference +## Detecting mobile vs. desktop + +The mobile layout is different than the one on the desktop. Use `body.mobile` and `body.desktop` to differentiate between them. + +```css +body.mobile #root-widget { + /* Do something on mobile */ +} + +body.desktop #root-widget { + /* Do something on desktop */ +} +``` + +Do note that there is also a “tablet mode” in the mobile layout. For that particular case media queries are required: + +```css +@media (max-width: 991px) { + + #launcher-pane { + + /* Do something on mobile layout */ + + } + +} + + + +@media (min-width: 992px) { + + #launcher-pane { + + /* Do something on mobile tablet + desktop layout */ + + } + +} +``` + +## Detecting horizontal vs. vertical layout + +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). + +Different styles can be applied by using classes at `body` level: + +``` +body.layout-vertical #left-pane { + /* Do something */ +} + +body.layout-horizontal #center-pane { + /* Do something else */ +} +``` + +The two different layouts use different containers (but they are present in the DOM regardless of the user's choice), for example `#horizontal-main-container` and `#vertical-main-container` can be used to customize the background of the content section. + +## Detecting platform (Windows, macOS) or Electron + +It is possible to add particular styles that only apply to a given platform by using the classes in `body`: + +| Windows | macOS | +| --- | --- | +| ```
body.platform-win32 {
background: red;
}
``` | ```
body.platform-darwin {
background: red;
}
``` | + +It is also possible to only apply a style if running under Electron (desktop application): + +``` +body.electron { + background: blue; +} +``` + +### Native title bar + +It's possible to detect if the user has selected the native title bar or the custom title bar by querying against `body`: + +``` +body.electron.native-titlebar { + /* Do something */ +} + +body.electron:not(.native-titlebar) { + /* Do something else */ +} +``` + +### Native window buttons + +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. + +See [Native title bar buttons by eliandoran · Pull Request #702 · TriliumNext/Notes](https://github.com/TriliumNext/Notes/pull/702) for the original implementation of this feature, including screenshots. + +#### On Windows + +The colors of the native window button area can be adjusted using a RGB hex color: + +``` +body { + --native-titlebar-foreground: #ffffff; + --native-titlebar-background: #ff0000; +} +``` + +It is also possible to use transparency at the cost of reduced hover colors using a RGBA hex color: + +``` +body { + --native-titlebar-background: #ff0000aa; +} +``` + +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. + +#### On macOS + +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: + +```css +body { + --native-titlebar-darwin-x-offset: 12; + --native-titlebar-darwin-y-offset: 14 !important; +} +``` + +### Background/transparency effects on Windows (Mica) + +Windows 11 offers a special background/transparency effect called Mica, which can be enabled by themes by setting the `--background-material` variable at `body` level: + +```css +body.electron.platform-win32 { + --background-material: tabbed; +} +``` + +The value can be either `tabbed` (especially useful for the horizontal layout) or `mica` (ideal for the vertical layout). + +Do note that the Mica effect is applied at `body` 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. + +## Note icons, tab workspace accent color + +Theme capabilities are small adjustments done through CSS variables that can affect the layout or the visual aspect of the application. + +In the tab bar, to display the icons of notes instead of the icon of the workspace: + +```css +:root { + --tab-note-icons: true; +} +``` + +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: + +```css +.note-tab .note-tab-wrapper { + --tab-background-color: initial !important; +} + +.note-tab .note-tab-wrapper::after { + content: ""; + position: absolute; + top: 0; + left: 0; + right: 0; + height: 3px; + background-color: var(--workspace-tab-background-color); +} +``` + +## Custom fonts + +Currently the only way to include a custom font is to use [Custom resource providers](../Advanced%20Usage/Custom%20Resource%20Providers.md). Basically import a font into Trilium and assign it `#customResourceProvider=fonts/myfont.ttf` and then import the font in CSS via `/custom/fonts/myfont.ttf`. + +## Dark and light themes + +A light theme needs to have the following CSS: + +```css +:root { + --theme-style: light; +} +``` + +if the theme is dark, then `--theme-style` needs to be `dark`. + +If the theme is auto (e.g. supports both light or dark based on `prefers-color-scheme`) it must also declare (in addition to setting `--theme-style` to either `light` or `dark`): + +```css +:root { + + --theme-style-auto: true; + +} +``` + +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). \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting.md b/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting.md new file mode 100644 index 000000000..f7d4210b1 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting.md @@ -0,0 +1,71 @@ +# Troubleshooting +As Trilium is currently in beta, encountering bugs is to be expected. + +## General Quick Fix + +The first step in troubleshooting is often a restart. + +If you experience an UI issue, the frontend may have entered an inconsistent state. Reload the application by pressing `CTRL-R`. This will reload the frontend. + +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. + +## Broken Note Crashes Trilium + +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. + +To resolve this, use the `TRILIUM_START_NOTE_ID` environment variable to reset the open tabs to a single specified note ID (e.g., `root`). In Linux, you can set it as follows: + +``` +TRILIUM_START_NOTE_ID=root ./trilium +``` + +## Broken Script Prevents Application Startup + +If a custom script causes Triliumto crash, and it is set as a startup script or in an active [custom widget](Advanced%20Usage/Code%20Notes/Custom%20Widgets.md), start Triliumin "safe mode" to prevent any custom scripts from executing: + +``` +TRILIUM_SAFE_MODE=true ./trilium +``` + +Depending on your Trilium distribution, you may have pre-made scripts available: `trilium-safe-mode.bat` and `trilium-safe-mode.sh`. + +Once Trilium starts, locate and fix or delete the problematic note. + +## Sync and Consistency Checks + +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. + +In such cases, file a bug report and attach an [anonymized database](Troubleshooting/Anonymized%20Database.md) if necessary. + +## Restoring Backup + +Trilium makes regular automatic backups. If issues become severe, you can [restore from a backup](Installation%20%26%20Setup/Backup.md). + +## Forgotten Password + +If you forget your password: + +* Protected notes are irretrievable without the password. +* Unprotected notes can be recovered. Follow these steps: + +Access the [database](Advanced%20Usage/Database.md) file in the [data directory](Installation%20%26%20Setup/Data%20directory.md). Open the `document.db` file with an SQLite client (e.g., [DB Browser](https://sqlitebrowser.org/)) and execute the following queries: + +``` +UPDATE options SET value = '77/twC5O00cuQgNC63VK32qOKKYwj21ev3jZDXoytVU=' WHERE name = 'passwordVerificationSalt'; +UPDATE options SET value = '710BMasZCAgibzIc07X4P9Q4TeBd4ONnqJOho+pWcBM=' WHERE name = 'passwordDerivedKeySalt'; +UPDATE options SET value = 'Eb8af1/T57b89lCRuS97tPEl4CwxsAWAU7YNJ77oY+s=' WHERE name = 'passwordVerificationHash'; +UPDATE options SET value = 'QpC8XoiYYeqHPtHKRtbNxfTHsk+pEBqVBODYp0FkPBa22tlBBKBMigdLu5GNX8Uu' WHERE name = 'encryptedDataKey'; +``` + +After executing the changes, commit/write the changes. **This sets the password to "password," allowing you to log in again.** + +For pre-existing protected notes (now unrecoverable), consider deleting them or exporting the unprotected notes. Then, delete `document.db` and start fresh. + +If you continue using the existing document file, change your password (Options -> Change Password). + +## Reporting Bugs + +Reporting bugs is highly valuable. Here are some tips: + +* Use GitHub issues for reporting: [https://github.com/TriliumNext/Notes/issues](https://github.com/TriliumNext/Notes/issues) +* Refer to the [error logs](Troubleshooting/Error%20logs.md) page for information on providing necessary details. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/1_Error logs_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/1_Error logs_image.png new file mode 100644 index 000000000..fb640c0c9 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/1_Error logs_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/1_TriliumNext Notes Not Open.png b/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/1_TriliumNext Notes Not Open.png new file mode 100644 index 000000000..5281529d5 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/1_TriliumNext Notes Not Open.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/2_TriliumNext Notes Not Open.png b/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/2_TriliumNext Notes Not Open.png new file mode 100644 index 000000000..7167570ec Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/2_TriliumNext Notes Not Open.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/Anonymized Database.md b/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/Anonymized Database.md new file mode 100644 index 000000000..7fe670248 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/Anonymized Database.md @@ -0,0 +1,18 @@ +# Anonymized Database +![](Anonymized Database_image.png) + +In certain scenarios, understanding the structure of a database is crucial for troubleshooting issues. However, sharing your actual [database](../Advanced%20Usage/Database.md) file with personal notes is not advisable. To address this, Trilium offers a feature to anonymize the database. This feature can be accessed via Menu -> Options -> Advanced tab. + +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 [vacuuming process](https://sqlite.org/lang_vacuum.html) to ensure no sensitive data remnants remain in the file. The anonymized database is saved in the `anonymized` directory within the [data directory](../Installation%20%26%20Setup/Data%20directory.md), making it safe to share with bug reports. + +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 [VACUUMed](https://sqlite.org/lang_vacuum.html) to make sure there's no stale sensitive data in the document file. The resulting file is stored in `anonymized` directory (placed in the [data directory](../Installation%20%26%20Setup/Data%20directory.md)). You can safely attach it to a bug report. + +## Command Line Anonymization + +If your [database](../Advanced%20Usage/Database.md) is corrupted to the point where Trilium cannot start, the anonymization process can still be executed via the command line: + +``` +node src/anonymize.js +``` + +Run this command from the directory containing Trilium's source files, typically found in the `resources/app` directory for desktop builds. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/Anonymized Database_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/Anonymized Database_image.png new file mode 100644 index 000000000..fb640c0c9 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/Anonymized Database_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/Error logs.md b/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/Error logs.md new file mode 100644 index 000000000..dabb9d2ee --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/Error logs.md @@ -0,0 +1,39 @@ +# Error logs +It's important to provide all available error logs together with bug reports. This page will show you how to do it. + +## Backend logs + +Open [data directory](../Installation%20%26%20Setup/Data%20directory.md), go to `log` subdirectory and find the latest log file, e.g. `trilium-2022-12-14.log`. 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. + +If you have trouble finding it the log files, there's also an in-app option in top-left menu button -> Advanced -> Show backend log. + +## Frontend logs + +To provide frontend logs, we need to open the Developer Console. Often the easiest way is to press `CTRL-SHIFT-I` which should work in most browsers (and desktop app). Make sure that the error producing action happened right before you copy&paste the errors, the console is cleared on app restart. + +If that doesn't work, then: + +* in Trilium desktop app, go to top-left menu button -> Advanced -> Open Dev Tools +* In Firefox/Chrome right-click anywhere in the page and click Inspect: + +![](../Attachments/error-logs-firefox-context.png) + +Once you have Dev Tools open, click on "Console" tab: + +![](Error logs_image.png) + +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. + +## Providing sensitive data + +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 [support channel](https://github.com/TriliumNext/Notes#-discuss-with-us). + +Use this email to also provide anything which could assist in analysing the bug - e.g. files/images/ZIPs being imported or [anonymized database](Anonymized%20Database.md). + +### Exporting note subtree for reproduction + +Often times, bugs manifest themselves in specific notes and having them would greatly ease reproduction and fixing. + +In such case, please export the relevant note subtree by right-clicking it on the left tree, choosing Export - HTML as ZIP: + +![](../Attachments/error-logs-export-subtree.png) \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/Error logs_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/Error logs_image.png new file mode 100644 index 000000000..62a034e3f Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/Error logs_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/Reporting issues.md b/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/Reporting issues.md new file mode 100644 index 000000000..6f1cd0de8 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/Reporting issues.md @@ -0,0 +1,4 @@ +# Reporting issues +Go to [Issues · TriliumNext/Notes](https://github.com/TriliumNext/Notes/issues) and press “New issue”. + +If you are reporting a bug, select “Bug Report” and fill in the details. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/Synchronization fails with 504.md b/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/Synchronization fails with 504.md new file mode 100644 index 000000000..20ee8a74e --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/Synchronization fails with 504.md @@ -0,0 +1,21 @@ +# Synchronization fails with 504 Gateway Timeout +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. + +The solution is to increase the timeout at proxy level. + +## Nginx + +Add the following to the configuration file: + +```conf +proxy_connect_timeout 300; +proxy_send_timeout 300; +proxy_read_timeout 300; +send_timeout 300; +``` + +And restart the server. + +See [Nginx Proxy Setup](../Installation%20%26%20Setup/Server%20Installation/2.%20Reverse%20proxy/Nginx.md) for more information about the Nginx setup. + +If it still doesn't work, try increasing the timeout. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/TriliumNext Notes Not Open.png b/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/TriliumNext Notes Not Open.png new file mode 100644 index 000000000..be9a5f0fa Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/TriliumNext Notes Not Open.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/TriliumNext Notes Not Opened.md b/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/TriliumNext Notes Not Opened.md new file mode 100644 index 000000000..26088f5ce --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/TriliumNext Notes Not Opened.md @@ -0,0 +1,16 @@ +# "TriliumNext Notes" Not Opened +![](2_TriliumNext Notes Not Open.png) + +When running TriliumNext for the first time or updating to a newer version, macOS will prevent its execution. + +On older versions of macOS it was possible to bypass this step simply by right clicking and selecting Open, which would show a button to run anyway. This got removed since macOS 15.0. + +To bypass this issue, follow these steps: + +1. Go to System Settings → Privacy & Security and look for the “Security” section. +2. There should be a “TriliumNext Notes was blocked to protect your Mac” item. Simply click “Open Anyway”. +3. Select “Open Anyway” and proceed with the authentication. Afterwards the application should start on its own. + +| | | +| --- | --- | +| ![](1_TriliumNext Notes Not Open.png)

The privacy settings in “System Settings”, showing the alert that TriliumNext was blocked. | ![](TriliumNext Notes Not Open.png)

The confirmation screen to bypass the run restrictions. | \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/What's new.md b/src/public/app/doc_notes/en/User Guide/User Guide/What's new.md new file mode 100644 index 000000000..cf93a839d --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/What's new.md @@ -0,0 +1,6 @@ +# What's new +1. [Geo map](Note%20Types/Geo%20map.md) +2. [Export as PDF](Basic%20Concepts/Note/Export%20as%20PDF.md) +3. [Zen mode](Basic%20Concepts/Zen%20mode.md) +4. [Calendar View](Note%20Types/Book/Calendar%20View.md) +5. [Right-to-Left Support](Basic%20Concepts/Note/Right-to-Left%20Support.md) \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/index.html b/src/public/app/doc_notes/en/User Guide/index.html deleted file mode 100644 index a0520a973..000000000 --- a/src/public/app/doc_notes/en/User Guide/index.html +++ /dev/null @@ -1,11 +0,0 @@ - - - - - - - - - - - \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/navigation.html b/src/public/app/doc_notes/en/User Guide/navigation.html deleted file mode 100644 index c9ac560d2..000000000 --- a/src/public/app/doc_notes/en/User Guide/navigation.html +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - - - - - - \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/style.css b/src/public/app/doc_notes/en/User Guide/style.css deleted file mode 100644 index 4243d146a..000000000 --- a/src/public/app/doc_notes/en/User Guide/style.css +++ /dev/null @@ -1,567 +0,0 @@ -/* !!!!!! TRILIUM CUSTOM CHANGES !!!!!! */ - -.printed-content .ck-widget__selection-handle, .printed-content .ck-widget__type-around { /* gets rid of triangles: https://github.com/zadam/trilium/issues/1129 */ - display: none; -} - -.page-break { - page-break-after: always; -} - -.printed-content .page-break:after, -.printed-content .page-break > * { - display: none !important; -} - -.ck-content li p { - margin: 0 !important; -} - -/* - * CKEditor 5 (v41.0.0) content styles. - * Generated on Fri, 26 Jan 2024 10:23:49 GMT. - * For more information, check out https://ckeditor.com/docs/ckeditor5/latest/installation/advanced/content-styles.html - */ - -:root { - --ck-color-image-caption-background: hsl(0, 0%, 97%); - --ck-color-image-caption-text: hsl(0, 0%, 20%); - --ck-color-mention-background: hsla(341, 100%, 30%, 0.1); - --ck-color-mention-text: hsl(341, 100%, 30%); - --ck-color-selector-caption-background: hsl(0, 0%, 97%); - --ck-color-selector-caption-text: hsl(0, 0%, 20%); - --ck-highlight-marker-blue: hsl(201, 97%, 72%); - --ck-highlight-marker-green: hsl(120, 93%, 68%); - --ck-highlight-marker-pink: hsl(345, 96%, 73%); - --ck-highlight-marker-yellow: hsl(60, 97%, 73%); - --ck-highlight-pen-green: hsl(112, 100%, 27%); - --ck-highlight-pen-red: hsl(0, 85%, 49%); - --ck-image-style-spacing: 1.5em; - --ck-inline-image-style-spacing: calc(var(--ck-image-style-spacing) / 2); - --ck-todo-list-checkmark-size: 16px; -} - -/* @ckeditor/ckeditor5-table/theme/tablecolumnresize.css */ -.ck-content .table .ck-table-resized { - table-layout: fixed; -} -/* @ckeditor/ckeditor5-table/theme/tablecolumnresize.css */ -.ck-content .table table { - overflow: hidden; -} -/* @ckeditor/ckeditor5-table/theme/tablecolumnresize.css */ -.ck-content .table td, -.ck-content .table th { - overflow-wrap: break-word; - position: relative; -} -/* @ckeditor/ckeditor5-table/theme/table.css */ -.ck-content .table { - margin: 0.9em auto; - display: table; -} -/* @ckeditor/ckeditor5-table/theme/table.css */ -.ck-content .table table { - border-collapse: collapse; - border-spacing: 0; - width: 100%; - height: 100%; - border: 1px double hsl(0, 0%, 70%); -} -/* @ckeditor/ckeditor5-table/theme/table.css */ -.ck-content .table table td, -.ck-content .table table th { - min-width: 2em; - padding: .4em; - border: 1px solid hsl(0, 0%, 75%); -} -/* @ckeditor/ckeditor5-table/theme/table.css */ -.ck-content .table table th { - font-weight: bold; - background: hsla(0, 0%, 0%, 5%); -} -/* @ckeditor/ckeditor5-table/theme/table.css */ -.ck-content[dir="rtl"] .table th { - text-align: right; -} -/* @ckeditor/ckeditor5-table/theme/table.css */ -.ck-content[dir="ltr"] .table th { - text-align: left; -} -/* @ckeditor/ckeditor5-table/theme/tablecaption.css */ -.ck-content .table > figcaption { - display: table-caption; - caption-side: top; - word-break: break-word; - text-align: center; - color: var(--ck-color-selector-caption-text); - background-color: var(--ck-color-selector-caption-background); - padding: .6em; - font-size: .75em; - outline-offset: -1px; -} -/* @ckeditor/ckeditor5-page-break/theme/pagebreak.css */ -.ck-content .page-break { - position: relative; - clear: both; - padding: 5px 0; - display: flex; - align-items: center; - justify-content: center; -} -/* @ckeditor/ckeditor5-page-break/theme/pagebreak.css */ -.ck-content .page-break::after { - content: ''; - position: absolute; - border-bottom: 2px dashed hsl(0, 0%, 77%); - width: 100%; -} -/* @ckeditor/ckeditor5-page-break/theme/pagebreak.css */ -.ck-content .page-break__label { - position: relative; - z-index: 1; - padding: .3em .6em; - display: block; - text-transform: uppercase; - border: 1px solid hsl(0, 0%, 77%); - border-radius: 2px; - font-family: Helvetica, Arial, Tahoma, Verdana, Sans-Serif; - font-size: 0.75em; - font-weight: bold; - color: hsl(0, 0%, 20%); - background: hsl(0, 0%, 100%); - box-shadow: 2px 2px 1px hsla(0, 0%, 0%, 0.15); - -webkit-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - user-select: none; -} -/* @ckeditor/ckeditor5-media-embed/theme/mediaembed.css */ -.ck-content .media { - clear: both; - margin: 0.9em 0; - display: block; - min-width: 15em; -} -/* @ckeditor/ckeditor5-list/theme/todolist.css */ -.ck-content .todo-list { - list-style: none; -} -/* @ckeditor/ckeditor5-list/theme/todolist.css */ -.ck-content .todo-list li { - position: relative; - margin-bottom: 5px; -} -/* @ckeditor/ckeditor5-list/theme/todolist.css */ -.ck-content .todo-list li .todo-list { - margin-top: 5px; -} -/* @ckeditor/ckeditor5-list/theme/todolist.css */ -.ck-content .todo-list .todo-list__label > input { - -webkit-appearance: none; - display: inline-block; - position: relative; - width: var(--ck-todo-list-checkmark-size); - height: var(--ck-todo-list-checkmark-size); - vertical-align: middle; - border: 0; - left: -25px; - margin-right: -15px; - right: 0; - margin-left: 0; -} -/* @ckeditor/ckeditor5-list/theme/todolist.css */ -.ck-content[dir=rtl] .todo-list .todo-list__label > input { - left: 0; - margin-right: 0; - right: -25px; - margin-left: -15px; -} -/* @ckeditor/ckeditor5-list/theme/todolist.css */ -.ck-content .todo-list .todo-list__label > input::before { - display: block; - position: absolute; - box-sizing: border-box; - content: ''; - width: 100%; - height: 100%; - border: 1px solid hsl(0, 0%, 20%); - border-radius: 2px; - transition: 250ms ease-in-out box-shadow; -} -/* @ckeditor/ckeditor5-list/theme/todolist.css */ -.ck-content .todo-list .todo-list__label > input::after { - display: block; - position: absolute; - box-sizing: content-box; - pointer-events: none; - content: ''; - left: calc( var(--ck-todo-list-checkmark-size) / 3 ); - top: calc( var(--ck-todo-list-checkmark-size) / 5.3 ); - width: calc( var(--ck-todo-list-checkmark-size) / 5.3 ); - height: calc( var(--ck-todo-list-checkmark-size) / 2.6 ); - border-style: solid; - border-color: transparent; - border-width: 0 calc( var(--ck-todo-list-checkmark-size) / 8 ) calc( var(--ck-todo-list-checkmark-size) / 8 ) 0; - transform: rotate(45deg); -} -/* @ckeditor/ckeditor5-list/theme/todolist.css */ -.ck-content .todo-list .todo-list__label > input[checked]::before { - background: hsl(126, 64%, 41%); - border-color: hsl(126, 64%, 41%); -} -/* @ckeditor/ckeditor5-list/theme/todolist.css */ -.ck-content .todo-list .todo-list__label > input[checked]::after { - border-color: hsl(0, 0%, 100%); -} -/* @ckeditor/ckeditor5-list/theme/todolist.css */ -.ck-content .todo-list .todo-list__label .todo-list__label__description { - vertical-align: middle; -} -/* @ckeditor/ckeditor5-list/theme/todolist.css */ -.ck-content .todo-list .todo-list__label.todo-list__label_without-description input[type=checkbox] { - position: absolute; -} -/* @ckeditor/ckeditor5-list/theme/todolist.css */ -.ck-editor__editable.ck-content .todo-list .todo-list__label > input, -.ck-editor__editable.ck-content .todo-list .todo-list__label > span[contenteditable=false] > input { - cursor: pointer; -} -/* @ckeditor/ckeditor5-list/theme/todolist.css */ -.ck-editor__editable.ck-content .todo-list .todo-list__label > input:hover::before, .ck-editor__editable.ck-content .todo-list .todo-list__label > span[contenteditable=false] > input:hover::before { - box-shadow: 0 0 0 5px hsla(0, 0%, 0%, 0.1); -} -/* @ckeditor/ckeditor5-list/theme/todolist.css */ -.ck-editor__editable.ck-content .todo-list .todo-list__label > span[contenteditable=false] > input { - -webkit-appearance: none; - display: inline-block; - position: relative; - width: var(--ck-todo-list-checkmark-size); - height: var(--ck-todo-list-checkmark-size); - vertical-align: middle; - border: 0; - left: -25px; - margin-right: -15px; - right: 0; - margin-left: 0; -} -/* @ckeditor/ckeditor5-list/theme/todolist.css */ -.ck-editor__editable.ck-content[dir=rtl] .todo-list .todo-list__label > span[contenteditable=false] > input { - left: 0; - margin-right: 0; - right: -25px; - margin-left: -15px; -} -/* @ckeditor/ckeditor5-list/theme/todolist.css */ -.ck-editor__editable.ck-content .todo-list .todo-list__label > span[contenteditable=false] > input::before { - display: block; - position: absolute; - box-sizing: border-box; - content: ''; - width: 100%; - height: 100%; - border: 1px solid hsl(0, 0%, 20%); - border-radius: 2px; - transition: 250ms ease-in-out box-shadow; -} -/* @ckeditor/ckeditor5-list/theme/todolist.css */ -.ck-editor__editable.ck-content .todo-list .todo-list__label > span[contenteditable=false] > input::after { - display: block; - position: absolute; - box-sizing: content-box; - pointer-events: none; - content: ''; - left: calc( var(--ck-todo-list-checkmark-size) / 3 ); - top: calc( var(--ck-todo-list-checkmark-size) / 5.3 ); - width: calc( var(--ck-todo-list-checkmark-size) / 5.3 ); - height: calc( var(--ck-todo-list-checkmark-size) / 2.6 ); - border-style: solid; - border-color: transparent; - border-width: 0 calc( var(--ck-todo-list-checkmark-size) / 8 ) calc( var(--ck-todo-list-checkmark-size) / 8 ) 0; - transform: rotate(45deg); -} -/* @ckeditor/ckeditor5-list/theme/todolist.css */ -.ck-editor__editable.ck-content .todo-list .todo-list__label > span[contenteditable=false] > input[checked]::before { - background: hsl(126, 64%, 41%); - border-color: hsl(126, 64%, 41%); -} -/* @ckeditor/ckeditor5-list/theme/todolist.css */ -.ck-editor__editable.ck-content .todo-list .todo-list__label > span[contenteditable=false] > input[checked]::after { - border-color: hsl(0, 0%, 100%); -} -/* @ckeditor/ckeditor5-list/theme/todolist.css */ -.ck-editor__editable.ck-content .todo-list .todo-list__label.todo-list__label_without-description input[type=checkbox] { - position: absolute; -} -/* @ckeditor/ckeditor5-list/theme/list.css */ -.ck-content ol { - list-style-type: decimal; -} -/* @ckeditor/ckeditor5-list/theme/list.css */ -.ck-content ol ol { - list-style-type: lower-latin; -} -/* @ckeditor/ckeditor5-list/theme/list.css */ -.ck-content ol ol ol { - list-style-type: lower-roman; -} -/* @ckeditor/ckeditor5-list/theme/list.css */ -.ck-content ol ol ol ol { - list-style-type: upper-latin; -} -/* @ckeditor/ckeditor5-list/theme/list.css */ -.ck-content ol ol ol ol ol { - list-style-type: upper-roman; -} -/* @ckeditor/ckeditor5-list/theme/list.css */ -.ck-content ul { - list-style-type: disc; -} -/* @ckeditor/ckeditor5-list/theme/list.css */ -.ck-content ul ul { - list-style-type: circle; -} -/* @ckeditor/ckeditor5-list/theme/list.css */ -.ck-content ul ul ul { - list-style-type: square; -} -/* @ckeditor/ckeditor5-list/theme/list.css */ -.ck-content ul ul ul ul { - list-style-type: square; -} -/* @ckeditor/ckeditor5-image/theme/image.css */ -.ck-content .image { - display: table; - clear: both; - text-align: center; - margin: 0.9em auto; - min-width: 50px; -} -/* @ckeditor/ckeditor5-image/theme/image.css */ -.ck-content .image img { - display: block; - margin: 0 auto; - max-width: 100%; - min-width: 100%; - height: auto; -} -/* @ckeditor/ckeditor5-image/theme/image.css */ -.ck-content .image-inline { - /* - * Normally, the .image-inline would have "display: inline-block" and "img { width: 100% }" (to follow the wrapper while resizing).; - * Unfortunately, together with "srcset", it gets automatically stretched up to the width of the editing root. - * This strange behavior does not happen with inline-flex. - */ - display: inline-flex; - max-width: 100%; - align-items: flex-start; -} -/* @ckeditor/ckeditor5-image/theme/image.css */ -.ck-content .image-inline picture { - display: flex; -} -/* @ckeditor/ckeditor5-image/theme/image.css */ -.ck-content .image-inline picture, -.ck-content .image-inline img { - flex-grow: 1; - flex-shrink: 1; - max-width: 100%; -} -/* @ckeditor/ckeditor5-image/theme/imageresize.css */ -.ck-content img.image_resized { - height: auto; -} -/* @ckeditor/ckeditor5-image/theme/imageresize.css */ -.ck-content .image.image_resized { - max-width: 100%; - display: block; - box-sizing: border-box; -} -/* @ckeditor/ckeditor5-image/theme/imageresize.css */ -.ck-content .image.image_resized img { - width: 100%; -} -/* @ckeditor/ckeditor5-image/theme/imageresize.css */ -.ck-content .image.image_resized > figcaption { - display: block; -} -/* @ckeditor/ckeditor5-image/theme/imagecaption.css */ -.ck-content .image > figcaption { - display: table-caption; - caption-side: bottom; - word-break: break-word; - color: var(--ck-color-image-caption-text); - background-color: var(--ck-color-image-caption-background); - padding: .6em; - font-size: .75em; - outline-offset: -1px; -} -/* @ckeditor/ckeditor5-image/theme/imagestyle.css */ -.ck-content .image-style-block-align-left, -.ck-content .image-style-block-align-right { - max-width: calc(100% - var(--ck-image-style-spacing)); -} -/* @ckeditor/ckeditor5-image/theme/imagestyle.css */ -.ck-content .image-style-align-left, -.ck-content .image-style-align-right { - clear: none; -} -/* @ckeditor/ckeditor5-image/theme/imagestyle.css */ -.ck-content .image-style-side { - float: right; - margin-left: var(--ck-image-style-spacing); - max-width: 50%; -} -/* @ckeditor/ckeditor5-image/theme/imagestyle.css */ -.ck-content .image-style-align-left { - float: left; - margin-right: var(--ck-image-style-spacing); -} -/* @ckeditor/ckeditor5-image/theme/imagestyle.css */ -.ck-content .image-style-align-center { - margin-left: auto; - margin-right: auto; -} -/* @ckeditor/ckeditor5-image/theme/imagestyle.css */ -.ck-content .image-style-align-right { - float: right; - margin-left: var(--ck-image-style-spacing); -} -/* @ckeditor/ckeditor5-image/theme/imagestyle.css */ -.ck-content .image-style-block-align-right { - margin-right: 0; - margin-left: auto; -} -/* @ckeditor/ckeditor5-image/theme/imagestyle.css */ -.ck-content .image-style-block-align-left { - margin-left: 0; - margin-right: auto; -} -/* @ckeditor/ckeditor5-image/theme/imagestyle.css */ -.ck-content p + .image-style-align-left, -.ck-content p + .image-style-align-right, -.ck-content p + .image-style-side { - margin-top: 0; -} -/* @ckeditor/ckeditor5-image/theme/imagestyle.css */ -.ck-content .image-inline.image-style-align-left, -.ck-content .image-inline.image-style-align-right { - margin-top: var(--ck-inline-image-style-spacing); - margin-bottom: var(--ck-inline-image-style-spacing); -} -/* @ckeditor/ckeditor5-image/theme/imagestyle.css */ -.ck-content .image-inline.image-style-align-left { - margin-right: var(--ck-inline-image-style-spacing); -} -/* @ckeditor/ckeditor5-image/theme/imagestyle.css */ -.ck-content .image-inline.image-style-align-right { - margin-left: var(--ck-inline-image-style-spacing); -} -/* @ckeditor/ckeditor5-highlight/theme/highlight.css */ -.ck-content .marker-yellow { - background-color: var(--ck-highlight-marker-yellow); -} -/* @ckeditor/ckeditor5-highlight/theme/highlight.css */ -.ck-content .marker-green { - background-color: var(--ck-highlight-marker-green); -} -/* @ckeditor/ckeditor5-highlight/theme/highlight.css */ -.ck-content .marker-pink { - background-color: var(--ck-highlight-marker-pink); -} -/* @ckeditor/ckeditor5-highlight/theme/highlight.css */ -.ck-content .marker-blue { - background-color: var(--ck-highlight-marker-blue); -} -/* @ckeditor/ckeditor5-highlight/theme/highlight.css */ -.ck-content .pen-red { - color: var(--ck-highlight-pen-red); - background-color: transparent; -} -/* @ckeditor/ckeditor5-highlight/theme/highlight.css */ -.ck-content .pen-green { - color: var(--ck-highlight-pen-green); - background-color: transparent; -} -/* @ckeditor/ckeditor5-block-quote/theme/blockquote.css */ -.ck-content blockquote { - overflow: hidden; - padding-right: 1.5em; - padding-left: 1.5em; - margin-left: 0; - margin-right: 0; - font-style: italic; - border-left: solid 5px hsl(0, 0%, 80%); -} -/* @ckeditor/ckeditor5-block-quote/theme/blockquote.css */ -.ck-content[dir="rtl"] blockquote { - border-left: 0; - border-right: solid 5px hsl(0, 0%, 80%); -} -/* @ckeditor/ckeditor5-basic-styles/theme/code.css */ -.ck-content code { - background-color: hsla(0, 0%, 78%, 0.3); - padding: .15em; - border-radius: 2px; -} -/* @ckeditor/ckeditor5-font/theme/fontsize.css */ -.ck-content .text-tiny { - font-size: .7em; -} -/* @ckeditor/ckeditor5-font/theme/fontsize.css */ -.ck-content .text-small { - font-size: .85em; -} -/* @ckeditor/ckeditor5-font/theme/fontsize.css */ -.ck-content .text-big { - font-size: 1.4em; -} -/* @ckeditor/ckeditor5-font/theme/fontsize.css */ -.ck-content .text-huge { - font-size: 1.8em; -} -/* @ckeditor/ckeditor5-mention/theme/mention.css */ -.ck-content .mention { - background: var(--ck-color-mention-background); - color: var(--ck-color-mention-text); -} -/* @ckeditor/ckeditor5-horizontal-line/theme/horizontalline.css */ -.ck-content hr { - margin: 15px 0; - height: 4px; - background: hsl(0, 0%, 87%); - border: 0; -} -/* @ckeditor/ckeditor5-code-block/theme/codeblock.css */ -.ck-content pre { - padding: 1em; - text-align: left; - direction: ltr; - tab-size: 4; - white-space: pre-wrap; - font-style: normal; - min-width: 200px; - border: 0px; - border-radius: 6px; - box-shadow: 1px 1px 6px rgba(0, 0, 0, 0.2); -} -.ck-content pre:not(.hljs) { - color: hsl(0, 0%, 20.8%); - background: hsla(0, 0%, 78%, 0.3); -} -/* @ckeditor/ckeditor5-code-block/theme/codeblock.css */ -.ck-content pre code { - background: unset; - padding: 0; - border-radius: 0; -} -@media print { - /* @ckeditor/ckeditor5-page-break/theme/pagebreak.css */ - .ck-content .page-break { - padding: 0; - } - /* @ckeditor/ckeditor5-page-break/theme/pagebreak.css */ - .ck-content .page-break::after { - display: none; - } -} diff --git a/src/public/app/services/eslint.spec.ts b/src/public/app/services/eslint.spec.ts index 1dc271d89..c6b87162a 100644 --- a/src/public/app/services/eslint.spec.ts +++ b/src/public/app/services/eslint.spec.ts @@ -7,7 +7,7 @@ describe("Linter", () => { const result = await lint(trimIndentation` for (const i = 0; i<10; i++) { } - `); + `, "application/javascript;env=frontend"); expect(result).toMatchObject([ { message: "'i' is constant.", }, { message: "Empty block statement." } @@ -23,7 +23,7 @@ describe("Linter", () => { } api.showMessage("Hi"); - `); + `, "application/javascript;env=frontend"); expect(result.length).toBe(0); }); @@ -33,7 +33,7 @@ describe("Linter", () => { function world() { } console.log("Hello world"); - `); + `, "application/javascript;env=frontend"); expect(result).toMatchObject([ { message: "'hello' is defined but never used.", diff --git a/src/services/import/zip.ts b/src/services/import/zip.ts index 5251b9546..3f7d1ef8e 100644 --- a/src/services/import/zip.ts +++ b/src/services/import/zip.ts @@ -26,7 +26,11 @@ interface MetaFile { files: NoteMeta[]; } -async function importZip(taskContext: TaskContext, fileBuffer: Buffer, importRootNote: BNote): Promise { +interface ImportZipOpts { + preserveIds?: boolean; +} + +async function importZip(taskContext: TaskContext, fileBuffer: Buffer, importRootNote: BNote, opts?: ImportZipOpts): Promise { /** maps from original noteId (in ZIP file) to newly generated noteId */ const noteIdMap: Record = {}; /** type maps from original attachmentId (in ZIP file) to newly generated attachmentId */ @@ -45,7 +49,7 @@ async function importZip(taskContext: TaskContext, fileBuffer: Buffer, importRoo return "empty_note_id"; } - if (origNoteId === "root" || origNoteId.startsWith("_")) { + if (origNoteId === "root" || origNoteId.startsWith("_") || opts?.preserveIds) { // these "named" noteIds don't differ between Trilium instances return origNoteId; } @@ -58,6 +62,10 @@ async function importZip(taskContext: TaskContext, fileBuffer: Buffer, importRoo } function getNewAttachmentId(origAttachmentId: string) { + if (opts?.preserveIds) { + return origAttachmentId; + } + if (!origAttachmentId.trim()) { // this probably shouldn't happen, but still good to have this precaution return "empty_attachment_id"; @@ -490,6 +498,10 @@ async function importZip(taskContext: TaskContext, fileBuffer: Buffer, importRoo notePosition: noteMeta?.notePosition }).save(); } + + if (opts?.preserveIds) { + firstNote = firstNote || note; + } } else { ({ note } = noteService.createNewNote({ parentNoteId: parentNoteId, @@ -605,7 +617,7 @@ function streamToBuffer(stream: Stream): Promise { return new Promise((res, rej) => stream.on("end", () => res(Buffer.concat(chunks)))); } -function readContent(zipfile: yauzl.ZipFile, entry: yauzl.Entry): Promise { +export function readContent(zipfile: yauzl.ZipFile, entry: yauzl.Entry): Promise { return new Promise((res, rej) => { zipfile.openReadStream(entry, function (err, readStream) { if (err) rej(err); @@ -616,8 +628,8 @@ function readContent(zipfile: yauzl.ZipFile, entry: yauzl.Entry): Promise void) { - return new Promise((res, rej) => { +export function readZipFile(buffer: Buffer, processEntryCallback: (zipfile: yauzl.ZipFile, entry: yauzl.Entry) => Promise) { + return new Promise((res, rej) => { yauzl.fromBuffer(buffer, { lazyEntries: true, validateEntrySizes: false }, function (err, zipfile) { if (err) rej(err); if (!zipfile) throw new Error("Unable to read zip file."); @@ -636,7 +648,7 @@ function readZipFile(buffer: Buffer, processEntryCallback: (zipfile: yauzl.ZipFi } function resolveNoteType(type: string | undefined): NoteType { - // BC for ZIPs created in Triliun 0.57 and older + // BC for ZIPs created in Trilium 0.57 and older if (type === "relation-map") { return "relationMap"; } else if (type === "note-map") { diff --git a/src/services/options_init.ts b/src/services/options_init.ts index 979459eec..a3bb95c76 100644 --- a/src/services/options_init.ts +++ b/src/services/options_init.ts @@ -6,6 +6,7 @@ import log from "./log.js"; import dateUtils from "./date_utils.js"; import keyboardActions from "./keyboard_actions.js"; import type { KeyboardShortcutWithRequiredActionName } from "./keyboard_actions_interface.js"; +import { DEFAULT_ALLOWED_TAGS } from "./html_sanitizer.js"; function initDocumentOptions() { optionService.createOption("documentId", randomSecureToken(16), false); @@ -159,102 +160,7 @@ const defaultOptions: DefaultOption[] = [ { name: "backgroundEffects", value: "false", isSynced: false }, { name: "allowedHtmlTags", - value: JSON.stringify([ - "h1", - "h2", - "h3", - "h4", - "h5", - "h6", - "blockquote", - "p", - "a", - "ul", - "ol", - "li", - "b", - "i", - "strong", - "em", - "strike", - "s", - "del", - "abbr", - "code", - "hr", - "br", - "div", - "table", - "thead", - "caption", - "tbody", - "tfoot", - "tr", - "th", - "td", - "pre", - "section", - "img", - "figure", - "figcaption", - "span", - "label", - "input", - "details", - "summary", - "address", - "aside", - "footer", - "header", - "hgroup", - "main", - "nav", - "dl", - "dt", - "menu", - "bdi", - "bdo", - "dfn", - "kbd", - "mark", - "q", - "time", - "var", - "wbr", - "area", - "map", - "track", - "video", - "audio", - "picture", - "del", - "ins", - "en-media", - "acronym", - "article", - "big", - "button", - "cite", - "col", - "colgroup", - "data", - "dd", - "fieldset", - "form", - "legend", - "meter", - "noscript", - "option", - "progress", - "rp", - "samp", - "small", - "sub", - "sup", - "template", - "textarea", - "tt" - ]), + value: JSON.stringify(DEFAULT_ALLOWED_TAGS), isSynced: true }, diff --git a/src/services/sql.ts b/src/services/sql.ts index b39cbe1ad..16771b5e6 100644 --- a/src/services/sql.ts +++ b/src/services/sql.ts @@ -278,6 +278,7 @@ function transactional(func: (statement: Statement) => T) { return ret; } catch (e) { + console.warn("Got error ", e); const entityChangeIds = cls.getAndClearEntityChangeIds(); if (entityChangeIds.length > 0) { diff --git a/src/services/ws.ts b/src/services/ws.ts index e163e25d7..f2674dd20 100644 --- a/src/services/ws.ts +++ b/src/services/ws.ts @@ -17,7 +17,9 @@ if (isDev) { const debounce = (await import("debounce")).default; const debouncedReloadFrontend = debounce(() => reloadFrontend("source code change"), 200); chokidar - .watch("src/public") + .watch("src/public", { + ignored: "src/public/app/doc_notes/en/User Guide" + }) .on("add", debouncedReloadFrontend) .on("change", debouncedReloadFrontend) .on("unlink", debouncedReloadFrontend); diff --git a/tsconfig.build.json b/tsconfig.build.json index 4d4ffd342..1987c96c0 100644 --- a/tsconfig.build.json +++ b/tsconfig.build.json @@ -3,7 +3,7 @@ "module": "NodeNext", "declaration": false, "sourceMap": true, - "outDir": "./dist", + "outDir": "./build", "strict": true, "noImplicitAny": true, "resolveJsonModule": true, diff --git a/tsconfig.json b/tsconfig.json index d94fcef82..c1f3ef48b 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -3,7 +3,7 @@ "module": "NodeNext", "declaration": false, "sourceMap": true, - "outDir": "./dist", + "outDir": "./build", "strict": true, "noImplicitAny": true, "resolveJsonModule": true, diff --git a/tsconfig.webpack.json b/tsconfig.webpack.json index cbfe8cbdb..ed622818b 100644 --- a/tsconfig.webpack.json +++ b/tsconfig.webpack.json @@ -3,7 +3,7 @@ "module": "NodeNext", "declaration": false, "sourceMap": true, - "outDir": "./dist", + "outDir": "./build", "strict": true, "noImplicitAny": true, "resolveJsonModule": true, diff --git a/webpack.config.ts b/webpack.config.ts index 207ff2fcf..82439ea6d 100644 --- a/webpack.config.ts +++ b/webpack.config.ts @@ -19,7 +19,7 @@ const config: Configuration = { }, output: { publicPath: `${assetPath}/app-dist/`, - path: path.resolve(rootDir, "dist/src/public/app-dist"), + path: path.resolve(rootDir, "build/src/public/app-dist"), filename: "[name].js" }, plugins: [