Skip to content

Build your personal knowledge base with Trilium Notes

docs: show inline icons on Search, Themes, Backup, Notion and OIDC pages

Claudee7949f688a91
diff --git a/docs/User Guide/User Guide/Basic Concepts and Features/Import & Export/Importing data from other applications/Notion.md b/docs/User Guide/User Guide/Basic Concepts and Features/Import & Export/Importing data from other applications/Notion.md
index 87a42bfab1..ce86814365 100644
--- a/docs/User Guide/User Guide/Basic Concepts and Features/Import & Export/Importing data from other applications/Notion.md
+++ b/docs/User Guide/User Guide/Basic Concepts and Features/Import & Export/Importing data from other applications/Notion.md
@@ -28,7 +28,7 @@ In Notion, there are two ways to export data:
In Trilium Notes:
-1. In the <a class="reference-link" href="../../UI%20Elements/Note%20Tree.md">Note Tree</a>, right click and select _Import into note_.
+1. In the <a class="reference-link" href="../../UI%20Elements/Note%20Tree.md">Note Tree</a>, right click and select _Import into note_ (<span class="tn-icon bx bx-import"></span>).
2. In the _Import from_ section, select _Notion_.
3. Upload the ZIP obtained in the previous step.
diff --git a/docs/User Guide/User Guide/Basic Concepts and Features/Navigation/Search.md b/docs/User Guide/User Guide/Basic Concepts and Features/Navigation/Search.md
index c90289c0d3..df581ab0fa 100644
--- a/docs/User Guide/User Guide/Basic Concepts and Features/Navigation/Search.md
+++ b/docs/User Guide/User Guide/Basic Concepts and Features/Navigation/Search.md
@@ -21,13 +21,13 @@ There are multiple types of searches, all using the same search mechanism and qu
## Accessing the search
-* From the <a class="reference-link" href="../UI%20Elements/Launch%20Bar.md">Launch Bar</a>, look for the dedicated search button.
-* To limit the search to a note and its children, select _Search from subtree_ from the <a class="reference-link" href="../UI%20Elements/Note%20Tree/Note%20tree%20contextual%20menu.md">Note tree contextual menu</a> or press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>S</kbd>.
+* From the <a class="reference-link" href="../UI%20Elements/Launch%20Bar.md">Launch Bar</a>, look for the dedicated <span class="tn-icon bx bx-search"></span> search button.
+* To limit the search to a note and its children, select _Search in subtree_ (<span class="tn-icon bx bx-search"></span>) from the <a class="reference-link" href="../UI%20Elements/Note%20Tree/Note%20tree%20contextual%20menu.md">Note tree contextual menu</a> or press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>S</kbd>.
* Go to <a class="reference-link" href="Jump%20to%20%26%20command%20palette.md">Jump to &amp; command palette</a>, look for something then press _Show in full search_ below the results (or <kbd>Ctrl</kbd>+<kbd>Enter</kbd>).
## Interaction
-To search for notes, click on the magnifying glass icon on the toolbar or press the keyboard [shortcut](../Keyboard%20Shortcuts.md).
+To search for notes, click on the <span class="tn-icon bx bx-search"></span> icon in the Launch Bar or press the keyboard [shortcut](../Keyboard%20Shortcuts.md).
1. Set the text to search for in the _Search string_ field.
1. Apart from searching for words literally, there is also the possibility to search for attributes or properties of notes.
@@ -36,10 +36,10 @@ To search for notes, click on the magnifying glass icon on the toolbar or press
1. This value is also pre-filled if the search is triggered from a [hoisted note](Note%20Hoisting.md) or a [workspace](Workspaces.md).
2. To search the entire database, keep the value empty.
3. To limit the search to only a few levels of hierarchy (e.g. look in sub-children but not in sub-sub-children of a note), set the _depth_ field to one of the provided values.
-4. In addition to that, the search can be configured via the _Add search options_ buttons, as described in the follow-up section.
-5. Press _Search_ to trigger the search. The results are displayed below the search configuration pane.
-6. The _Search & Execute actions_ button is only relevant if at least one action has been added (as described in the section below).
-7. The _Save to note_ will create a new note with the search configuration. For more information, see <a class="reference-link" href="../../Note%20Types/Saved%20Search.md">Saved Search</a>.
+4. In addition to that, the search can be configured via the _Add search option_ buttons, as described in the follow-up section.
+5. Press _Search_ (<span class="tn-icon bx bx-search"></span>) to trigger the search. The results are displayed below the search configuration pane.
+6. The _Search & Execute actions_ (<span class="tn-icon bx bxs-zap"></span>) button is only relevant if at least one action has been added (as described in the section below).
+7. The _Save to note_ (<span class="tn-icon bx bx-save"></span>) button will create a new note with the search configuration. For more information, see <a class="reference-link" href="../../Note%20Types/Saved%20Search.md">Saved Search</a>.
## Features
@@ -88,30 +88,30 @@ To add a new line, press <kbd>Shift</kbd>+<kbd>Enter</kbd>.
## Search options
-Click on which search option to apply from the Add search option section.
+Click on which search option to apply from the _Add search option_ section.
* For each search option selected, the search configuration will update to reveal the entry. Each search option will have its own configuration.
-* To remove a search option, simply press the X button to the right of it.
+* To remove a search option, simply press the <span class="tn-icon bx bx-x"></span> button to the right of it.
The options available are:
-1. Search script
+1. <span class="tn-icon bx bx-code"></span> Search script
1. This feature allows writing a <a class="reference-link" href="../../Note%20Types/Code.md">Code</a> note that will handle the search on its own.
-2. Fast search
+2. <span class="tn-icon bx bx-run"></span> Fast search
1. The search will not look into the content of the notes, but it will still look into note titles and attributes, relations (based on the search query).
2. This method can speed up the search considerably for large [databases](../../Advanced%20Usage/Database.md).
-3. Include archived
+3. <span class="tn-icon bx bx-archive"></span> Include archived
1. <a class="reference-link" href="../Notes/Archived%20Notes.md">Archived Notes</a> will also be included in the results, whereas otherwise they would be ignored.
-4. Order by
+4. <span class="tn-icon bx bx-arrow-from-top"></span> Order by
1. Allows changing the criteria for ordering the results, for example to order by creation date or alphabetically instead of by relevancy (default).
2. It's also possible to change the order (ascending or descending) of the results.
-5. Limit
+5. <span class="tn-icon bx bx-stop"></span> Limit
1. Limits the results to a given maximum.
2. This can help if the number of results would otherwise be high, at the cost of not being able to view all the results.
-6. Debug
+6. <span class="tn-icon bx bx-bug"></span> Debug
1. This will print additional information in the server log (see <a class="reference-link" href="../../Troubleshooting/Error%20logs.md">Error logs</a>), regarding how the search expression was parsed.
2. This function is especially useful after understanding the search functionality in detail, in order to determine why a complex search query is not working as expected.
-7. Action
+7. <span class="tn-icon bx bxs-zap"></span> Action
1. Apart from just searching, it is also possible to apply actions such as to add a label or a relation to the notes that have been matched by the search.
2. Unlike other search configurations, here it's possible to apply the same action multiple times (i.e. in order to be able to apply multiple labels to notes).
3. The actions given are the same as the ones in <a class="reference-link" href="../../Advanced%20Usage/Bulk%20Actions.md">Bulk Actions</a>, which is an alternative for operating directly with notes within the <a class="reference-link" href="../UI%20Elements/Note%20Tree.md">Note Tree</a>.
@@ -131,7 +131,7 @@ In addition: 
* The **total number of results** is always shown, so you can immediately tell how broad a query is.
* A **page-size selector** lets you choose how many results to display per page. Your choice is remembered and synced across your devices (stored in the `searchResultsPageSize` option), so you do not have to reset it on every device.
* **Clicking a result** opens the note and jumps straight to the first match. The in-note find bar opens pre-filled with the first word of your search, so you can step through its matches with the find controls. To have the find bar look for a whole phrase instead, put the phrase in quotes in the search, e.g. `"The Lord of the Rings"`. In read-only notes, the other words of the search are highlighted as well.
-* _Open all results in new tabs_ (the button above the results) opens every result in a tab of its own, up to 50. Each tab opens on its first match with the find bar pre-filled, as when clicking a result.
+* _Open all results in new tabs_ (<span class="tn-icon bx bx-window-open"></span>, the button above the results) opens every result in a tab of its own, up to 50. Each tab opens on its first match with the find bar pre-filled, as when clicking a result.
* If a match is inside a **collapsed section** (for example a folded heading), that section is expanded automatically so the match is visible.
## Simple Note Search Examples
diff --git a/docs/User Guide/User Guide/Basic Concepts and Features/Themes.md b/docs/User Guide/User Guide/Basic Concepts and Features/Themes.md
index c83f6c7136..9620b3b34c 100644
--- a/docs/User Guide/User Guide/Basic Concepts and Features/Themes.md
+++ b/docs/User Guide/User Guide/Basic Concepts and Features/Themes.md
@@ -1,7 +1,7 @@
# 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.
+Trilium comes with a couple pre-installed color themes, with the default being a light theme. To switch to a dark theme or any other available theme, navigate to the <span class="tn-icon bx bx-cog"></span> Options menu (accessible via the app icon in the top-left corner), select the Appearance tab, and choose your preferred theme.
![Dark Theme](Themes_dark-theme.png)
@@ -75,7 +75,7 @@ body .CodeMirror {
Once you've created your custom theme:
-1. Go to "Menu" -> "Options" -> "Appearance."
+1. Go to "Menu" -> "Options" (<span class="tn-icon bx bx-cog"></span>) -> "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.
diff --git a/docs/User Guide/User Guide/Installation & Setup/Backup.md b/docs/User Guide/User Guide/Installation & Setup/Backup.md
index 4e2d929571..03bb723124 100644
--- a/docs/User Guide/User Guide/Installation & Setup/Backup.md
+++ b/docs/User Guide/User Guide/Installation & Setup/Backup.md
@@ -30,13 +30,13 @@ Note that <a class="reference-link" href="Synchronization.md">Synchronization</
## Downloading a backup
-* **Desktop and web client**: to download an existing backup, navigate to <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Options.md">Options</a> → _Backup_ → _Existing backups_ and select _Download_.
+* **Desktop and web client**: to download an existing backup, navigate to <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Options.md">Options</a> → _Backup_ → _Existing backups_ and select _Download_ (<span class="tn-icon bx bx-download"></span>).
* **Standalone client**: automatic backups are not supported in this version. You can manually create and download a backup by going to <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Options.md">Options</a> → _Backup_ → _Download backup_.
## Restoring a backup
* **For a new Trilium instance**: When setting up a new Trilium instance, use the _Restore from backup_ option in the setup menu to guide you through restoring your existing backup.
-* **For an existing Trilium instance**: To restore a backup and replace your current database, go to <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Options.md">Options</a> → _Backup_ and click _Restore a backup_. You will be prompted to restart the app for the restoration process to begin. After restarting, you can choose to back up the existing database before overwriting it. Note: For the web client, use the Start Over feature ( <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Options.md">Options</a> → _Database_ → _Start over_) to switch to the setup screen and restore a backup.
+* **For an existing Trilium instance**: To restore a backup and replace your current database, go to <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Options.md">Options</a> → _Backup_ and click _Restore a backup_. You will be prompted to restart the app for the restoration process to begin. After restarting, you can choose to back up the existing database before overwriting it. Note: For the web client, use the Start Over feature ( <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Options.md">Options</a> → _Database_ → _Start over_ (<span class="tn-icon bx bx-reset"></span>)) to switch to the setup screen and restore a backup.
Next, select the backup file (.db or .tnbackup) from your device. The web client is optimized for handling large backups and is resilient to unstable network conditions, similar to the desktop application.
@@ -48,7 +48,7 @@ Restoring a backup may take some time, depending on its size. Once it completes,
Let's assume you want to restore the weekly backup (only in .db format, .tnbackup files are not supported by this method), here's how to do it:
-* 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"
+* find [data directory](Data%20directory.md) Trilium uses - easy way is to open "About Trilium Notes" (<span class="tn-icon bx bx-info-circle"></span>) from "Menu" in upper left corner and looking at "data directory"
* I'll refer to `~/trilium-data` as data directory from now on
* find `~/trilium-data/backup/backup-weekly.db` - this is the <a class="reference-link" href="../Advanced%20Usage/Database.md">Database</a> backup.
* at this point stop/kill Trilium
diff --git a/docs/User Guide/User Guide/Installation & Setup/Server Installation/Signing in with OpenID Connect.md b/docs/User Guide/User Guide/Installation & Setup/Server Installation/Signing in with OpenID Connect.md
index adb17d75f8..225d94f30b 100644
--- a/docs/User Guide/User Guide/Installation & Setup/Server Installation/Signing in with OpenID Connect.md
+++ b/docs/User Guide/User Guide/Installation & Setup/Server Installation/Signing in with OpenID Connect.md
@@ -57,7 +57,7 @@ To do so:
1. Go to <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Options.md">Options</a> → _Password & Auth._
2. In the _Sign-in with_ field, choose _OpenID Connect provider._
-3. In the _OpenID Connect_ section, look for the _Connect account_ button.
+3. In the _OpenID Connect_ section, look for the _Connect account_ (<span class="tn-icon bx bx-log-in"></span>) button.
4. This will redirect you to your authentication provider, where you can sign in or confirm the action if needed.
5. Once you are authenticated you will be redirected back to the Trilium application.
@@ -70,7 +70,7 @@ When logging out of Trilium, a request is made to the authentication provider to
When switching providers (e.g. going from Google to Authelia), it's important to take the following steps:
1. Go to <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Options.md">Options</a> → _Password & Auth_.
-2. In the _OpenID Connect_ section, press the _Disconnect_ button.
+2. In the _OpenID Connect_ section, press the _Disconnect_ (<span class="tn-icon bx bx-trash"></span>) button.
3. Wait for the section to indicate that you are disconnected.
4. Change the configuration pointing to the new provider.
5. Restart your server.