diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Navigation/Bookmarks.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Navigation/Bookmarks.html index 7f0709d8b..07943c992 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Navigation/Bookmarks.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Navigation/Bookmarks.html @@ -1,10 +1,10 @@
Frequently used notes can be bookmarked, which will make them appear in - the Launch Bar for + the Launch Bar for easy access.
If bookmarks don't appear in the launch bar, then most likely the bookmark - section has been hidden. Go to the Launch Bar configuration - from the Global menu and + section has been hidden. Go to the Launch Bar configuration + from the Global menu and ensure Bookmarks is in the Visible Launchers section.
Space in the left panel is limited, and you might want to bookmark many diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Themes/Icon Packs.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Themes/Icon Packs.html index 371ca190b..5d41a2394 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Themes/Icon Packs.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Themes/Icon Packs.html @@ -1,73 +1,85 @@ -
+By default, Trilium comes with a set of icons called Boxicons v2. Since + v0.102.0, custom icon packs allow a wider selection of icons for notes.
Icon packs are specific to Trilium, so they must either be created from scratch (see below) or imported from a ZIP file from a third-party developer.
- +To import an icon pack:
+Since Safe import is disabled, make sure you trust the source as - it could contain dangerous third-party scripts. One good way to check if - the icon pack is safe is to manually extract the .zip and inspect the file - contents. Icon packs should only contain a font file and a JSON file. Other - files (especially scripts) are to be considered harmful.
-Creating an icon pack requires some scripting knowledge outside Trilium - in order to generate the list of icons. For information, see Creating an icon pack.
-After refreshing the application, the - icon pack should be enabled by default. To test this, simply select an - existing note or create a new one and try to change the note icon.
-There should be a Filter button to the right of the search bar - in the icon list. Clicking it allows filtering by icon pack and the newly - imported icon pack should be displayed there.
-If the icon pack is missing from that list, then most likely there's something - wrong with it.
-#iconPack
- labelwith a value assigned to it (a prefix).Custom icon packs are also supported by the Sharing feature, where they will be - shown in the note tree. However, in order for an icon pack to be visible - to the share function, the icon pack note must also be shared.
-If you are using a custom share theme, make sure it supports the
- iconPackCss, otherwise icons will not show up. Check the original
- share template source code for reference.
Custom icon packs will also be preserved when Exporting static HTML for web publishing. - In this case, there's no requirement to make the icon pack shared.
-If an icon pack is removed or disabled (by removing or altering its
- #iconPacklabel), all the notes that use this icon pack will show
- in the Note Tree with
- no icon. This won't cause any issues apart from looking strange.
The solution is to replace the icons with some else, try using
- Search which supports bulk actions, to identify the notes with
- the now deleted icon pack (by looking for the prefix) and changing or removing
- their iconClass.
Since Safe import is disabled, make sure you trust the source as + it could contain dangerous third-party scripts. One good way to check if + the icon pack is safe is to manually extract the .zip and inspect the file + contents. Icon packs should only contain a font file and a JSON file. Other + files (especially scripts) are to be considered harmful.
+Creating an icon pack requires some scripting knowledge outside Trilium + in order to generate the list of icons. For information, see Creating an icon pack.
+After refreshing the application, the + icon pack should be enabled by default. To test this, simply select an + existing note or create a new one and try to change the note icon.
+There should be a Filter button to the right of the search bar + in the icon list. Clicking it allows filtering by icon pack and the newly + imported icon pack should be displayed there.
+If the icon pack is missing from that list, then most likely there's something + wrong with it.
+#iconPack
+ labelwith a value assigned to it (a prefix).Custom icon packs are also supported by the Sharing feature, where they will be + shown in the note tree. However, in order for an icon pack to be visible + to the share function, the icon pack note must also be shared.
+If you are using a custom share theme, make sure it supports the
+ iconPackCss, otherwise icons will not show up. Check the original
+ share template source code for reference.
Custom icon packs will also be preserved when Exporting static HTML for web publishing. + In this case, there's no requirement to make the icon pack shared.
+If an icon pack is removed or disabled (by removing or altering its
+ #iconPacklabel), all the notes that use this icon pack will show
+ in the Note Tree with
+ no icon. This won't cause any issues apart from looking strange.
The solution is to replace the icons with some else, try using
+ Search which supports bulk actions, to identify the notes with
+ the now deleted icon pack (by looking for the prefix) and changing or removing
+ their iconClass.
On desktop, depending on the layout selected, the launcher bar will either be on the left side of the screen with buttons displayed vertically or - at the top of the screen. See Vertical and horizontal layout for + at the top of the screen. See Vertical and horizontal layout for more information.
On mobile, the launch bar will always be at the bottom.
If there are too many items in the launch bar to fit the screen, it will @@ -21,10 +21,10 @@
This will open a new tab with the Note Tree listing +
This will open a new tab with the Note Tree listing the launchers.
@@ -37,11 +37,10 @@
one. The reasoning is that not all desktop icons are available on mobile,
and fewer icons fit on a mobile screen.
To configure the launch bar on mobile, go to Global menu and - select Configure Launchbar.
+ href="#root/_help_x3i7MxGccDuM">Global menu and select Configure Launchbar.The configure the mobile launch bar while on the desktop (especially useful to configure more complicated launchers such as scripts or custom widgets), - go to Global menu → + go to Global menu → Advanced → Show Hidden Subtree and look for the Mobile Launch Bar section. While in the hidden subtree, it's also possible to drag launchers between the Mobile Launch Bar and (Desktop) Launch Bar sections.
@@ -52,13 +51,13 @@Similarly, to remove it from the launch bar, simply look for it in Visible Launchers then right click it and select Move to available launchers or use drag-and-drop.
Drag-and-drop the items in the tree in order to change their - order. See Note Tree for + order. See Note Tree for more interaction options, including using keyboard shortcuts.
Right click either the Available launchers or Visible launchers sections and select one of the options:
Note Launcher
+
A note launcher will simply navigate to a specified note.
target promoted attribute to the
note to navigate to.hoistedNote to hoist a particular
- note. See Note Hoisting for
+ note. See Note Hoisting for
more information.keyboardShortcut to trigger
the launcher.script to point to the desired script
- to run.keyboardShortcut to trigger
- the launcher.Script Launcher
+
An advanced launcher which will run a script upon pressing. See
+ Scripting for more information.
script to point to the desired script
+ to run.keyboardShortcut to trigger
+ the launcher.Custom Widget
Allows defining a custom widget to be rendered inside the launcher. See Widget Basics for more information.
+ class="reference-link" href="#root/_help_SynTBQiBsdYJ">Widget Basics for more information. +Spacers
+
Launchers that create some distance between other launchers for better
+ visual distinction.
Launchers are configured via predefined Promoted Attributes.
\ No newline at end of file + href="#root/_help_OFXdgB2nNk1F">Promoted Attributes. \ No newline at end of file diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Split View.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Split View.html index 78897057f..654913293 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Split View.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Split View.html @@ -4,7 +4,8 @@ class="image image-style-align-center">
-
button to the right of a note's title to open a new split to the right
@@ -50,12 +51,11 @@ class="image image-style-align-center">
Interaction:
Tabs are also supported on the Mobile Frontend.
+Tabs are also supported on the Mobile Frontend.
Since v0.102.0, the tabs are displayed by pressing the dedicated tab switcher - button in the Launch Bar. + button in the Launch Bar. In this view the tabs are laid out on a grid with a preview of the note content.
The context menu button at the top-right of the popup allows creating a new tab, reopening the last closed tab and closing all the tabs.
-Split Views - are also indicated in the tab switcher, with two titles displayed in a - tab.
-Split Views are + also indicated in the tab switcher, with two titles displayed in a tab.
+Versions prior to v0.102.0 also supported tabs, but they were displayed - directly above the Launch Bar. + directly above the Launch Bar. The decision to use a more mobile-like tab switcher was taken because the original tab bar could not support many tabs at once and the new design better aligns with how mobile applications handle tabs.
-The Note Tree is +
The Note Tree is displayed as a sidebar. To display the sidebar, press the button in the top-left of the screen.
There is also a swipe gesture that can be done from the left of the screen, - but the browser's navigation gesture interferes with it most of the time - (depending on the platform).
-Press and hold a note to display the Note tree contextual menu.
-The Launch Bar is +
The Quick search bar + is also displayed at the top of the note tree.
+The full Search function + can be triggered either from either the Global menu or from the Launch Bar, if configured.
+The Launch Bar is displayed at the bottom of the screen.
The launch bar uses a different configuration for icons than the desktop - version. See the dedicated page for more information on how to configure - it.
-The Tabs are - grouped under a tab switcher in the Launch Bar, +
The Tabs are + grouped under a tab switcher in the Launch Bar, where the tabs are displayed in a full-screen grid with preview for easy switching, as well as additional options such as reopening closed tabs.
Since v0.100.0, Split View can +
Since v0.100.0, Split View can also be used in mobile view, but with a maximum of two panes at once. The splits are displayed vertically instead of horizontally.
Starting with v0.102.0, the New Layout is +
Starting with v0.102.0, the New Layout is enforced on mobile. This brings features such as the note badges, note type switcher or collection properties which would otherwise not be available.
Press the […] button in the bottom-right of the screen and select Share.
-Scroll down to reveal the full list of items and choose “Add to Home Screen”.
-Press “Add” and the web app will be available.
-Press the three vertical dots icon in the top-right of the screen and - select Add to Home screen. -
-Select the Install option.
-Select an appropriate name.
-The web app will appear as an application, not on the home screen.
-Press the three vertical dots icon in the bottom-right of the screen and - select Add to Home screen.
-Press the Install option.
-The web app will appear as an application, not on the home screen.
-Press the hamburger menu in the bottom-right of the screen.
-Select Add to, followed by Home screen.
-Press Add and the web app will appear on the home page.
-If you are running Trilium without a dedicated server installation, @@ -159,10 +126,10 @@ spellcheck="false">?desktopquery param on login page (Note: you might need to log out).
Alternatively, simply select Switch to Mobile/Desktop Version in - the Global menu.
+ the Global menu.You can alter the behavior with Scripting, +
You can alter the behavior with Scripting,
just like for normal frontend. For script notes to be executed, they need
to have labeled #run=mobileStartup.
Custom Launch Bar widgets +
Custom Launch Bar widgets are also supported.
\ No newline at end of file diff --git a/docs/Developer Guide/Developer Guide/Documentation.md b/docs/Developer Guide/Developer Guide/Documentation.md index ff5177af2..8b43e75bd 100644 --- a/docs/Developer Guide/Developer Guide/Documentation.md +++ b/docs/Developer Guide/Developer Guide/Documentation.md @@ -1,5 +1,5 @@ # Documentation -There are multiple types of documentation for Trilium:
+There are multiple types of documentation for Trilium:
* The _User Guide_ represents the user-facing documentation. This documentation can be browsed by users directly from within Trilium, by pressing F1.
* The _Developer's Guide_ represents a set of Markdown documents that present the internals of Trilium, for developers.
diff --git a/docs/User Guide/!!!meta.json b/docs/User Guide/!!!meta.json
index 232a65b27..df7c61602 100644
--- a/docs/User Guide/!!!meta.json
+++ b/docs/User Guide/!!!meta.json
@@ -1480,17 +1480,87 @@
{
"type": "relation",
"name": "internalLink",
- "value": "WOcw2SLH6tbX",
+ "value": "oPVyFC7WL2Lp",
"isInheritable": false,
"position": 10
},
{
"type": "relation",
"name": "internalLink",
- "value": "nRqcgfTb97uV",
+ "value": "YtSN43OrfzaA",
"isInheritable": false,
"position": 20
},
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "Ms1nauBra7gq",
+ "isInheritable": false,
+ "position": 30
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "eIg8jdvaoNNd",
+ "isInheritable": false,
+ "position": 40
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "x3i7MxGccDuM",
+ "isInheritable": false,
+ "position": 50
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "xYmIYSP6wE3F",
+ "isInheritable": false,
+ "position": 60
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "3seOhtN8uLIY",
+ "isInheritable": false,
+ "position": 70
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "luNhaphA37EO",
+ "isInheritable": false,
+ "position": 80
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "IjZS7iK5EXtb",
+ "isInheritable": false,
+ "position": 90
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "WOcw2SLH6tbX",
+ "isInheritable": false,
+ "position": 100
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "nRqcgfTb97uV",
+ "isInheritable": false,
+ "position": 110
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "CdNpE2pqjmI6",
+ "isInheritable": false,
+ "position": 120
+ },
{
"type": "label",
"name": "shareAlias",
@@ -1504,76 +1574,6 @@
"value": "bx bx-mobile-alt",
"isInheritable": false,
"position": 60
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "x3i7MxGccDuM",
- "isInheritable": false,
- "position": 70
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "IjZS7iK5EXtb",
- "isInheritable": false,
- "position": 80
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "oPVyFC7WL2Lp",
- "isInheritable": false,
- "position": 90
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "YtSN43OrfzaA",
- "isInheritable": false,
- "position": 110
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "xYmIYSP6wE3F",
- "isInheritable": false,
- "position": 120
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "Ms1nauBra7gq",
- "isInheritable": false,
- "position": 130
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "eIg8jdvaoNNd",
- "isInheritable": false,
- "position": 140
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "3seOhtN8uLIY",
- "isInheritable": false,
- "position": 150
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "CdNpE2pqjmI6",
- "isInheritable": false,
- "position": 160
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "luNhaphA37EO",
- "isInheritable": false,
- "position": 170
}
],
"format": "markdown",
@@ -2845,6 +2845,20 @@
"isInheritable": false,
"position": 30
},
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "RDslemsQ6gCp",
+ "isInheritable": false,
+ "position": 40
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "xYmIYSP6wE3F",
+ "isInheritable": false,
+ "position": 50
+ },
{
"type": "label",
"name": "iconClass",
@@ -2858,20 +2872,6 @@
"value": "tabs",
"isInheritable": false,
"position": 40
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "RDslemsQ6gCp",
- "isInheritable": false,
- "position": 50
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "xYmIYSP6wE3F",
- "isInheritable": false,
- "position": 60
}
],
"format": "markdown",
@@ -2927,6 +2927,20 @@
"type": "text",
"mime": "text/html",
"attributes": [
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "x0JgW8UqGXvq",
+ "isInheritable": false,
+ "position": 10
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "x3i7MxGccDuM",
+ "isInheritable": false,
+ "position": 20
+ },
{
"type": "relation",
"name": "internalLink",
@@ -2934,6 +2948,41 @@
"isInheritable": false,
"position": 30
},
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "p9kXRFAkwN4o",
+ "isInheritable": false,
+ "position": 40
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "OR8WJ7Iz9K4U",
+ "isInheritable": false,
+ "position": 50
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "CdNpE2pqjmI6",
+ "isInheritable": false,
+ "position": 60
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "SynTBQiBsdYJ",
+ "isInheritable": false,
+ "position": 70
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "OFXdgB2nNk1F",
+ "isInheritable": false,
+ "position": 80
+ },
{
"type": "label",
"name": "iconClass",
@@ -2947,55 +2996,6 @@
"value": "launch-bar",
"isInheritable": false,
"position": 90
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "OFXdgB2nNk1F",
- "isInheritable": false,
- "position": 100
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "SynTBQiBsdYJ",
- "isInheritable": false,
- "position": 110
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "CdNpE2pqjmI6",
- "isInheritable": false,
- "position": 120
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "OR8WJ7Iz9K4U",
- "isInheritable": false,
- "position": 130
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "p9kXRFAkwN4o",
- "isInheritable": false,
- "position": 140
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "x3i7MxGccDuM",
- "isInheritable": false,
- "position": 150
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "x0JgW8UqGXvq",
- "isInheritable": false,
- "position": 160
}
],
"format": "markdown",
@@ -5330,6 +5330,20 @@
"type": "text",
"mime": "text/markdown",
"attributes": [
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "xYmIYSP6wE3F",
+ "isInheritable": false,
+ "position": 10
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "x3i7MxGccDuM",
+ "isInheritable": false,
+ "position": 20
+ },
{
"type": "label",
"name": "shareAlias",
@@ -5343,20 +5357,6 @@
"value": "bx bx-bookmarks",
"isInheritable": false,
"position": 30
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "xYmIYSP6wE3F",
- "isInheritable": false,
- "position": 40
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "x3i7MxGccDuM",
- "isInheritable": false,
- "position": 50
}
],
"format": "markdown",
@@ -6049,7 +6049,16 @@
],
"format": "markdown",
"dataFileName": "Icon Packs.md",
- "attachments": []
+ "attachments": [
+ {
+ "attachmentId": "CPieIjN3b77m",
+ "title": "image.png",
+ "role": "image",
+ "mime": "image/png",
+ "position": 10,
+ "dataFileName": "Icon Packs_image.png"
+ }
+ ]
}
]
},
diff --git a/docs/User Guide/User Guide/Basic Concepts and Features/Themes/Icon Packs.md b/docs/User Guide/User Guide/Basic Concepts and Features/Themes/Icon Packs.md
index 8b2f0a84e..c01fde9bf 100644
--- a/docs/User Guide/User Guide/Basic Concepts and Features/Themes/Icon Packs.md
+++ b/docs/User Guide/User Guide/Basic Concepts and Features/Themes/Icon Packs.md
@@ -1,12 +1,20 @@
# Icon Packs
-## Importing an existing icon pack
+