diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Keyboard Shortcuts.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Keyboard Shortcuts.html index 2a7818d9b..6c3f8b5c2 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Keyboard Shortcuts.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Keyboard Shortcuts.html @@ -20,119 +20,111 @@ 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

- +

Note navigation

See demo of some of these features in note navigation.

- -

Tabs

- +

Tabs

Only in desktop (electron build):

- -

Creating notes

- +

Creating notes

- -

Moving / cloning notes

- +

Moving / cloning notes

- -

Editing notes

- +

Editing notes

Trilium uses CKEditor 5 for the text notes and CodeMirror 5 for code notes. Check the documentation of these projects to see all their built-in keyboard shortcuts.

- -

Runtime shortcuts

- +

Runtime shortcuts

These are hooked in Electron to be similar to native browser keyboard shortcuts.

- -

Other

- +

Other

diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Note Navigation.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Note Navigation.html index c191b89ca..8e49f7fc8 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Note Navigation.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Note Navigation.html @@ -15,28 +15,22 @@

One of the Trilium's goals is to provide fast and comfortable navigation between notes.

- -

Backwards and forward

- +

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.

- +

- -

Jump to note

- +

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.

+ on the top or press Ctrl + J . Then type part of the + note name and autocomplete will help you pick the desired note.

- +

- -

Recent notes

- +

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 @@ -44,7 +38,7 @@ will show the list of recent notes.

Alternatively you can click on the "time" icon on the right.

- +

diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Search.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Search.html index da084d03f..de4cfd4a0 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Search.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Navigation/Search.html @@ -14,24 +14,19 @@

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

- + 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 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.

- -

Simple Note Search Examples

- + or press the Ctrl + S keyboard shortcut.

+

Simple Note Search Examples

- -

Advanced Use Cases

- +

Advanced Use Cases

- -

Search with Note Properties

- +

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
+

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. @@ -123,27 +111,16 @@ are equal.
  3. Limit the results to the first 10 notes.
- -

Negation

- -

Some queries can only be expressed with negation:

-
#book AND not(note.ancestor.title = 'Tolkien')
+

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
+        

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:

    @@ -155,28 +132,21 @@

    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" 
    +          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"
    +          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'
    +

    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

    - +

    Auto-Trigger Search from URL

    You can open Trilium and automatically trigger a search by including the search url encoded string in the URL:

    diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Cloning Notes.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Cloning Notes.html index a874ff21b..4870aa748 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Cloning Notes.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Note/Cloning Notes.html @@ -14,7 +14,6 @@

    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 @@ -47,9 +46,7 @@ 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

    - +

    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 @@ -94,31 +91,26 @@

    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

    - +

    Demo

    - +

    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.

    + menu. It's possible to do this also using the Add Link dialog or with Ctrl+C and Ctrl+V + keyboard shortcuts.

    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

    - +

    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

    - +

    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:

      diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Themes.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Themes.html index 3bc46571d..e73feed21 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Themes.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Themes.html @@ -14,17 +14,14 @@

      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 + Dark Theme

      - -

      Creating Custom CSS Themes

      - +

      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:

        @@ -34,8 +31,7 @@ your note, where my-theme-name is the name of your custom theme.
      1. Define Your Styles: Write your custom CSS within the note. Below is an example of a custom theme:
      2. -
      -
      @font-face {
      +        
    @font-face {
       font-family: 'Raleway';
       font-style: normal;
       font-weight: 400;
    @@ -89,7 +85,6 @@ 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. @@ -97,29 +92,23 @@ body .CodeMirror { under the name you provided with the #appTheme label.
    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

    - +

    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.

    - Steel Blue Theme + Steel Blue Theme

    - -

    Using Custom CSS for Specific Purposes

    - +

    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

    - +

    Applying Custom CSS

    To use custom CSS:

    1. Create a CSS Code Note: Create a new code note with @@ -128,21 +117,18 @@ body .CodeMirror { Annotate the note with the #appCss label.
    2. Write Your CSS: Add your custom CSS rules to the note.
    -

    For example:

    -
    /* Custom CSS to style specific elements */
    +        

    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.

    +

    After making changes, press Ctrl + R to reload the frontend + and apply your new styles.

    - +

    - -

    Styling Specific Notes in the Tree

    - +

    Styling Specific Notes in the Tree

    To apply specific styles to certain notes in the tree:

    • Use the **cssClass** Attribute: @@ -154,15 +140,11 @@ body .CodeMirror {

    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

    - +

    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.

    - -

    Asset Path Management

    - +

    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, diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Note Tree.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Note Tree.html index 2be3e37ad..34936287b 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Note Tree.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Note Tree.html @@ -16,55 +16,46 @@

    This page explains how to manipulate the note tree in TriliumNext, focusing on moving notes.

    - +

    - -

    Drag and Drop

    - +

    Drag and Drop

    - Drag and drop example + Drag and drop example

    You can easily rearrange the note tree by dragging and dropping notes, as demonstrated in the example above.

    - -

    Keyboard Manipulation

    - +

    Keyboard Manipulation

    - Example of using keyboard keys to move a noteTrilium offers efficient keyboard-based manipulation using the following + Example of using keyboard keys to move a noteTrilium offers efficient keyboard-based manipulation using the following shortcuts:

      -
    • 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.
    • +
    • Ctrl + and Ctrl +: + Move the note up or down in the order.
    • +
    • Ctrl+: Move the note up in the hierarchy + by changing its parent to the note's grandparent.
    • +
    • Ctrl+: 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).
    • +
    • and : Expand and collapse + a sub-tree.
    - -

    Context Menu

    - +

    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: CTRL-C ( copy), CTRL-X (cut) and CTRL-V (paste).

    - -

    Multiple selection

    - + href="../Note/Cloning%20Notes.html">copy), Ctrl + X (cut) and Ctrl + V (paste).

    +

    Multiple selection

    It is possible to select multiple notes at one time.

    To do so, first select the note to start the selection with. Then hold Shift and click on the note to end the selection with. All the notes between the start and the end note will be selected as well.

    - +

    In the right-click menu, operations such as Cut, Copy, Move to, Clone to or Delete will apply to all the selected notes. It is also possible - to apply Bulk actions to + to apply Bulk actions to them. The rest of the options will not be available and will appear disabled in the menu.

    diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Zen mode.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Zen mode.html index 9b173d56f..7f1b9210b 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Zen mode.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/Zen mode.html @@ -14,7 +14,7 @@

    - +

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

    @@ -22,46 +22,40 @@ 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

    - +

    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.

    + 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 + 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

    - +

    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

    - +

    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.

    + 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.

    diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Packaged server installation.html b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Packaged server installation.html index f1a269180..57c94f685 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Packaged server installation.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Packaged server installation.html @@ -15,9 +15,7 @@

    This is essentially Trilium sources + node modules + node.js runtime packaged into one 7z file.

    - -

    Steps

    - +

    Steps

    • ssh into your server
    • use wget (or curl or whatever) to download latest @@ -36,26 +34,21 @@

      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 &.
      • +
      • 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

      - +

      Configure Trilium to auto-run on boot with systemd

      • After downloading, extract and move Trilium:
      • -
      -
      tar -xvf trilium-linux-x64-server-[VERSION].tar.xz
      +        
    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
    +
    sudo nano /etc/systemd/system/trilium.service
    • Paste this into the file (replace the user and group as needed):
    • -
    -
    [Unit]
    +        
    [Unit]
     Description=Trilium Daemon
     After=syslog.target network.target
     
    @@ -75,27 +68,19 @@ WantedBy=multi-user.target
    • Save the file (CTRL-S) and exit (CTRL-X)
    • Enable and launch the service:
    • -
    -
    sudo systemctl enable --now -q trilium
    +
    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)
    +        

    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 method.

    - -

    TLS

    - +

    TLS

    Don't forget to configure TLS, which is required for secure usage!

    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 index 959bcb9ee..8b02c822f 100644 --- 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 @@ -14,35 +14,36 @@

    Creating a new geo map

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

    Repositioning the map

    - +
    + + + + + + + + + + + + + + + + + + + + +
       
    1 + + Right click on any note on the note tree and select Insert child noteGeo 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 @@ -50,79 +51,76 @@

    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

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    1To 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

    - +

    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

    - +

    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

    - + page (Ctrl+R ) to cancel it.

    +

    Interaction with the markers

    • Hovering over a marker will display the content of the note it belongs to. @@ -143,159 +141,154 @@
    - -

    Icon and color of the markers

    - +

    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

    - +

    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

    - +

    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)

    - +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
       
    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 is to set the UI zoom at 100% (default keyboard shortcut - is Ctrl+0).

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
       
    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 is to set the UI zoom at 100% (default keyboard shortcut + is Ctrl+0).

    diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text.html b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text.html index 385ba3a3c..9c7be1a84 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text.html @@ -15,24 +15,18 @@

    Trilium utilizes the powerful CKEditor 5 as its text editing component.

    - -

    Formatting Options

    - +

    Formatting Options

    The Trilium text note interface does not display toolbars or formatting options by default. These can be accessed by:

    - inline note formatting + inline note formatting

    1. Selecting text to bring up an inline toolbar.

    - formating note block2. Clicking on the block toolbar.

    - -

    Read-Only vs. Editing Mode

    - + formating note block2. 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:

      @@ -42,11 +36,9 @@

    In both cases, it is possible to switch back to editable mode using the button at top right of page.

    -

    For more information, see Read-Only Notes.

    - -

    General Formatting

    - + src="Text_bx-edit-alt.svg" alt="">button at top right of page.

    +

    For more information, see Read-Only Notes.

    +

    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:

    @@ -56,57 +48,41 @@
  1. Italic: Type *text* or _text_
  2. Code: Type `text`
  3. -
  4. Strikethrough: Type ~~text~~ +
  5. Strikethrough: Type ~~text~~
  6. - -

    Lists

    - -

    See Lists.

    - -

    Blocks

    - +

    Lists

    +

    See Lists.

    +

    Blocks

    • Block quote: Start a line with > followed by a space
    - -

    Multi-Line Code Blocks

    - +

    Multi-Line Code Blocks

    To create a multi-line code block, start a line with "```[lang]", for - example:

    -
    if (1 > 2) {
    +          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

    - +

    Horizontal Line

    Insert a horizontal line by starting a line with ---.

    - -

    Markdown & Autoformat

    - +

    Markdown & Autoformat

    CKEditor supports a markdown-like editing experience, recognising syntax and automatically converting it to rich text.

    - +

    Complete documentation for this feature is available in the CKEditor documentation.

    -

    If autoformatting is not desirable, press CTRL-Z to revert - the text to its original form.

    +

    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.

    - -

    Math Support

    - +

    Math Support

    Trilium provides math support through KaTeX.

    - -

    Cutting Selection to Sub-Note

    - +

    Cutting Selection to Sub-Note

    When editing a document that becomes too large, you can split it into sub-notes:

      @@ -120,9 +96,7 @@ 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

      - +

      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.

      diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Content language & Right-to-le.html b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Content language & Right-to-le.html index bab0d0ef5..0c3f545b4 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Content language & Right-to-le.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Content language & Right-to-le.html @@ -13,19 +13,23 @@

      Content language & Right-to-left support

      -
      - -
      +

      + +

      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.

      -

      Setting the language

      + +

      Setting the language

      +

      To set the language of the content, go to “Basic Properties” and look for the “Language” field.

      -

      Adjusting the list of languages

      + +

      Adjusting the list of languages

      +

      By default there will be no language configured, they can be configured by going to settings or by selecting the “Configure languages” item when setting the language.

      diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Links.html b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Links.html index bc76e5329..22c75065d 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Links.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Links.html @@ -14,23 +14,20 @@

      External links

      -

      External link is general web link targeting some external web resource - e.g. 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.

      + link, select text and press Ctrl + K or wait for the + "balloon" to appear and click link icon there.

      - +

      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

      - +

      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.

      + to note at current cursor position, press Ctrl + L.

      In the dialog you can see radio button to choose from different types of linking:

        @@ -42,20 +39,16 @@ - you link to a particular note and can choose the link title

      - +

      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

      - +

      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

      - +

      Note map

      Trilium provides a visualisation of incoming and outgoing links for a particular note. See note map for details.

      diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting.html b/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting.html index 86908cbb6..8b7b264d0 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting.html @@ -14,51 +14,38 @@

      As Trilium is currently in beta, encountering bugs is to be expected.

      - -

      General Quick Fix

      - +

      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.

      + 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

      - +

      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
      + 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, - start Triliumin "safe mode" to prevent any custom scripts from executing:

      -
      TRILIUM_SAFE_MODE=true ./trilium
      + 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

      - +

      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 if necessary.

      - -

      Restoring Backup

      - +

      Restoring Backup

      Trilium makes regular automatic backups. If issues become severe, you can restore from a backup.

      - -

      Forgotten Password

      - +

      Forgotten Password

      If you forget your password:

      • Protected notes are irretrievable without the password.
      • @@ -67,8 +54,7 @@

        Access the database file in the data directory. Open the document.db file with an SQLite client (e.g., DB Browser) - and execute the following queries:

        -
        UPDATE options SET value = '77/twC5O00cuQgNC63VK32qOKKYwj21ev3jZDXoytVU=' WHERE name = 'passwordVerificationSalt';
        +          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';
        @@ -79,9 +65,7 @@ UPDATE options SET value = 'QpC8XoiYYeqHPtHKRtbNxfTHsk+pEBqVBODYp0FkPBa22tlBBKBM start fresh.

        If you continue using the existing document file, change your password (Options -> Change Password).

        - -

        Reporting Bugs

        - +

        Reporting Bugs

        Reporting bugs is highly valuable. Here are some tips:

        • Use GitHub issues for reporting: https://github.com/TriliumNext/Notes/issues diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/Error logs.html b/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/Error logs.html index 49afb4d6e..a8e228aab 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/Error logs.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/Error logs.html @@ -15,23 +15,19 @@

          It's important to provide all available error logs together with bug reports. This page will show you how to do it.

          - -

          Backend logs

          - +

          Backend logs

          Open data directory, 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

          - +

          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.

          + 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 -> @@ -39,32 +35,28 @@
          • In Firefox/Chrome right-click anywhere in the page and click Inspect:

          - +

          Once you have Dev Tools open, click on "Console" tab:

          - +

          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

          - +

          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.

          Use this email to also provide anything which could assist in analysing the bug - e.g. files/images/ZIPs being imported or anonymized database.

          - -

          Exporting note subtree for reproduction

          - +

          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:

          - +

      diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/Refreshing the application.html b/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/Refreshing the application.html index 37e34fa9d..2bf313557 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/Refreshing the application.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Troubleshooting/Refreshing the application.html @@ -15,7 +15,7 @@

      Some changes to the application will not take effect immediately and as such it might require to manually reload or refresh the application.

      -

      To do so, simply press Ctrl+Shift+R.

      +

      To do so, simply press Ctrl+Shift+R.