diff --git a/docs/User Guide/!!!meta.json b/docs/User Guide/!!!meta.json index d318f89e4..5e52dec25 100644 --- a/docs/User Guide/!!!meta.json +++ b/docs/User Guide/!!!meta.json @@ -1999,7 +1999,7 @@ "Vc8PjrjAGuOp", "xYmIYSP6wE3F" ], - "title": "Launcher Bar", + "title": "Launch Bar", "notePosition": 70, "prefix": null, "isExpanded": false, @@ -2012,11 +2012,69 @@ "value": "bx bx-sidebar", "isInheritable": false, "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "x3i7MxGccDuM", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "oPVyFC7WL2Lp", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "x0JgW8UqGXvq", + "isInheritable": false, + "position": 50 + }, + { + "type": "relation", + "name": "internalLink", + "value": "OR8WJ7Iz9K4U", + "isInheritable": false, + "position": 70 + }, + { + "type": "relation", + "name": "internalLink", + "value": "CdNpE2pqjmI6", + "isInheritable": false, + "position": 80 + }, + { + "type": "relation", + "name": "internalLink", + "value": "SynTBQiBsdYJ", + "isInheritable": false, + "position": 90 + }, + { + "type": "relation", + "name": "internalLink", + "value": "OFXdgB2nNk1F", + "isInheritable": false, + "position": 100 } ], "format": "markdown", - "dataFileName": "Launcher Bar.md", - "attachments": [] + "dataFileName": "Launch Bar.md", + "attachments": [ + { + "attachmentId": "YsBMjK1g3jd1", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "Launch Bar_image.png" + } + ] }, { "isClone": false, @@ -2988,6 +3046,13 @@ "value": "note-hoisting", "isInheritable": false, "position": 30 + }, + { + "type": "label", + "name": "iconClass", + "value": "bx bxs-chevrons-up", + "isInheritable": false, + "position": 40 } ], "format": "markdown", diff --git a/docs/User Guide/User Guide/Basic Concepts/UI Elements/Launch Bar.md b/docs/User Guide/User Guide/Basic Concepts/UI Elements/Launch Bar.md new file mode 100644 index 000000000..c218faec8 --- /dev/null +++ b/docs/User Guide/User Guide/Basic Concepts/UI Elements/Launch Bar.md @@ -0,0 +1,61 @@ +# Launch Bar +## Position of the Launch bar + +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](Vertical%20and%20horizontal%20layout.md) for more information. + +## Terminology + +* **Launcher**: a button that can be (or is) displayed on the launch bar. +* **Available Launcher**: a launcher that is not displayed on the launch bar, but can be added. +* **Visible Launcher**: a launcher that is currently displayed on the launch bar. + +## Configuring the Launch bar + +There are two ways to configure the launch bar: + +* Right click in the empty space between launchers on the launch bar and select _Configure Launchbar._ +* Click on the [Global menu](Global%20menu.md) and select _Configure Launchbar_. + +This will open a new tab with the [Note Tree](Note%20Tree.md) listing the launchers. + +![](Launch%20Bar_image.png) + +Expanding _Available Launchers_ section will show the list of launchers that are not displayed on the launch bar. The _Visible Launchers_ will show the ones that are currently displayed. + +### Adding/removing and reordering launchers + +To display a new launcher in the launch bar, first look for it in the _Available Launchers_ section. Then right click it and select _Move to visible launchers_. It is also possible to drag and drop the item manually. + +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](Note%20Tree.md) for more interaction options, including using keyboard shortcuts. + +### Resetting + +Resetting allows restoring the original configuration of Trilium for the launcher bar, or for a portion of it. Simply right click a launcher (or even the entire _Launch Bar_ section) and select _Reset_ to bring it back to the original state. + +### Creating new launchers / types of launchers + +Right click either the _Available launchers_ or _Visible launchers_ sections and select one of the options: + +1. **Note Launcher** + A note launcher will simply navigate to a specified note. + + 1. Set the `target` promoted attribute to the note to navigate to. + 2. Optionally, set `hoistedNote` to hoist a particular note. See [Note Hoisting](../Navigation/Note%20Hoisting.md) for more information. + 3. Optionally, set a `keyboardShortcut` to trigger the launcher. + +2. **Script Launcher** + An advanced launcher which will run a script upon pressing. See [Scripts](../../Note%20Types/Code/Scripts.md) for more information. + + 1. Set `script` to point to the desired script to run. + 2. Optionally, set a `keyboardShortcut` to trigger the launcher. + +3. **Custom Widget** + + Allows defining a custom widget to be rendered inside the launcher. See [Widget Basics](../../Developer%20Guides/Widget%20Basics.md) for more information. + +4. **Spacers** + Launchers that create some distance between other launchers for better visual distinction. + +Launchers are configured via predefined [Promoted Attributes](../../Advanced%20Usage/Attributes/Promoted%20Attributes.md). \ No newline at end of file diff --git a/docs/User Guide/User Guide/Basic Concepts/UI Elements/Launch Bar_image.png b/docs/User Guide/User Guide/Basic Concepts/UI Elements/Launch Bar_image.png new file mode 100644 index 000000000..6e8c37480 Binary files /dev/null and b/docs/User Guide/User Guide/Basic Concepts/UI Elements/Launch Bar_image.png differ diff --git a/docs/User Guide/User Guide/Basic Concepts/UI Elements/Launcher Bar.md b/docs/User Guide/User Guide/Basic Concepts/UI Elements/Launcher Bar.md deleted file mode 100644 index 7d1fa50b2..000000000 --- a/docs/User Guide/User Guide/Basic Concepts/UI Elements/Launcher Bar.md +++ /dev/null @@ -1,4 +0,0 @@ -# Launcher Bar -## Position of the launcher bar - -It's possible to display the launcher bar either vertically, on the left side of the screen, or horizontally on the top \ No newline at end of file diff --git a/docs/User Guide/User Guide/Basic Concepts/UI Elements/Vertical and horizontal layout.md b/docs/User Guide/User Guide/Basic Concepts/UI Elements/Vertical and horizontal layout.md index b203cde37..58354ec53 100644 --- a/docs/User Guide/User Guide/Basic Concepts/UI Elements/Vertical and horizontal layout.md +++ b/docs/User Guide/User Guide/Basic Concepts/UI Elements/Vertical and horizontal layout.md @@ -7,11 +7,11 @@ Trilium supports two different layouts, based on your preference. The vertical layout is Trilium's original layout: -* The [Launcher Bar](Launcher%20Bar.md) is positioned on the left side of the screen, with buttons being laid out vertically. +* The [Launcher Bar](Launch%20Bar.md) is positioned on the left side of the screen, with buttons being laid out vertically. * The tab bar is at the top, but to the right of the [Note Tree](Note%20Tree.md). * The [Quick search](Quick%20search.md) is at the top of the [Note Tree](Note%20Tree.md). -* The [Note Tree](Note%20Tree.md) can be collapsed by pressing the ![](6_Vertical%20and%20horizontal%20la.png) button at the bottom of the [Launcher Bar](Launcher%20Bar.md). -* The [Global menu](Global%20menu.md) can be accessed via the ![](5_Vertical%20and%20horizontal%20la.png) icon at the top of the [Launcher Bar](Launcher%20Bar.md). +* The [Note Tree](Note%20Tree.md) can be collapsed by pressing the ![](6_Vertical%20and%20horizontal%20la.png) button at the bottom of the [Launcher Bar](Launch%20Bar.md). +* The [Global menu](Global%20menu.md) can be accessed via the ![](5_Vertical%20and%20horizontal%20la.png) icon at the top of the [Launcher Bar](Launch%20Bar.md). ![](4_Vertical%20and%20horizontal%20la.png) @@ -19,11 +19,11 @@ The vertical layout is Trilium's original layout: The horizontal layout is a more traditional layout, since it bears similarity with other applications. In this mode: -* The [Launcher Bar](Launcher%20Bar.md) is at the top of the screen, with the buttons laid horizontally. +* The [Launcher Bar](Launch%20Bar.md) is at the top of the screen, with the buttons laid horizontally. * The tab bar is at the top of the screen, but now covers the entirety of the width, allowing for more tabs to be displayed at once. -* The [Quick search](Quick%20search.md) is now part of the [Launcher Bar](Launcher%20Bar.md). It can be moved around according to preference and even removed if needed. +* The [Quick search](Quick%20search.md) is now part of the [Launcher Bar](Launch%20Bar.md). It can be moved around according to preference and even removed if needed. * The [Note Tree](Note%20Tree.md) can be collapsed by pressing the small ![](2_Vertical%20and%20horizontal%20la.png) button to the left of the first tab. -* The [Global menu](Global%20menu.md) can be accessed via the ![](1_Vertical%20and%20horizontal%20la.png) button at the end of the [Launcher Bar](Launcher%20Bar.md). +* The [Global menu](Global%20menu.md) can be accessed via the ![](1_Vertical%20and%20horizontal%20la.png) button at the end of the [Launcher Bar](Launch%20Bar.md). ![](3_Vertical%20and%20horizontal%20la.png) 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 39e28f388..6598222f9 100644 --- a/src/public/app/doc_notes/en/User Guide/!!!meta.json +++ b/src/public/app/doc_notes/en/User Guide/!!!meta.json @@ -1999,7 +1999,7 @@ "Vc8PjrjAGuOp", "xYmIYSP6wE3F" ], - "title": "Launcher Bar", + "title": "Launch Bar", "notePosition": 70, "prefix": null, "isExpanded": false, @@ -2012,11 +2012,69 @@ "value": "bx bx-sidebar", "isInheritable": false, "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "x3i7MxGccDuM", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "oPVyFC7WL2Lp", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "x0JgW8UqGXvq", + "isInheritable": false, + "position": 50 + }, + { + "type": "relation", + "name": "internalLink", + "value": "OR8WJ7Iz9K4U", + "isInheritable": false, + "position": 70 + }, + { + "type": "relation", + "name": "internalLink", + "value": "CdNpE2pqjmI6", + "isInheritable": false, + "position": 80 + }, + { + "type": "relation", + "name": "internalLink", + "value": "SynTBQiBsdYJ", + "isInheritable": false, + "position": 90 + }, + { + "type": "relation", + "name": "internalLink", + "value": "OFXdgB2nNk1F", + "isInheritable": false, + "position": 100 } ], "format": "html", - "dataFileName": "Launcher Bar.html", - "attachments": [] + "dataFileName": "Launch Bar.html", + "attachments": [ + { + "attachmentId": "YsBMjK1g3jd1", + "title": "image.png", + "role": "image", + "mime": "image/jpg", + "position": 10, + "dataFileName": "Launch Bar_image.png" + } + ] }, { "isClone": false, @@ -2988,6 +3046,13 @@ "value": "note-hoisting", "isInheritable": false, "position": 30 + }, + { + "type": "label", + "name": "iconClass", + "value": "bx bxs-chevrons-up", + "isInheritable": false, + "position": 40 } ], "format": "html", diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Launch Bar.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Launch Bar.html new file mode 100644 index 000000000..df45531fa --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Launch Bar.html @@ -0,0 +1,106 @@ + + + + + + + + Launch Bar + + + +
+

Launch Bar

+ +
+

Position of the Launch bar

+

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

+

Terminology

+ +

Configuring the Launch bar

+

There are two ways to configure the launch bar:

+ +

This will open a new tab with the Note Tree listing + the launchers.

+

+ +

+

Expanding Available Launchers section will show the list of launchers + that are not displayed on the launch bar. The Visible Launchers will + show the ones that are currently displayed.

+

Adding/removing and reordering launchers

+

To display a new launcher in the launch bar, first look for it in the Available Launchers section. + Then right click it and select Move to visible launchers. It is also + possible to drag and drop the item manually.

+

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 + more interaction options, including using keyboard shortcuts.

+

Resetting

+

Resetting allows restoring the original configuration of Trilium for the + launcher bar, or for a portion of it. Simply right click a launcher (or + even the entire Launch Bar section) and select Reset to bring + it back to the original state.

+

Creating new launchers / types of launchers

+

Right click either the Available launchers or Visible launchers sections + and select one of the options:

+
    +
  1. +

    Note Launcher +
    A note launcher will simply navigate to a specified note.

    +
      +
    1. Set the target promoted attribute to the note to navigate to.
      2. +
    2. Optionally, set hoistedNote to hoist a particular note. See  + Note Hoisting for more information.
      3. +
    3. Optionally, set a keyboardShortcut to trigger the launcher.
      4. +
    +

     

    +
    2. +
  2. +

    Script Launcher +
    An advanced launcher which will run a script upon pressing. See  + Scripts for more information.

    +
      +
    1. Set script to point to the desired script to run.
      2. +
    2. Optionally, set a keyboardShortcut to trigger the launcher.
      3. +
    +

     

    +
    3. +
  3. +

    Custom Widget +

    +

    Allows defining a custom widget to be rendered inside the launcher. See  + Widget Basics for more information.

    +

     

    +
    4. +
  4. Spacers +
    Launchers that create some distance between other launchers for better + visual distinction.
    5. +
+

Launchers are configured via predefined Promoted Attributes.

+
+
+ + + \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Launch Bar_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Launch Bar_image.png new file mode 100644 index 000000000..6e8c37480 Binary files /dev/null and b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Launch Bar_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Launcher Bar.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Launcher Bar.html deleted file mode 100644 index 0af669ada..000000000 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Launcher Bar.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - - - - Launcher Bar - - - -
-

Launcher Bar

- -
-

Position of the launcher bar

-

It's possible to display the launcher bar either vertically, on the left - side of the screen, or horizontally on the top

-
-
- - - \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Vertical and horizontal layout.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Vertical and horizontal layout.html index ebec37a44..befb205ee 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Vertical and horizontal layout.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Vertical and horizontal layout.html @@ -18,7 +18,7 @@

Vertical layout

The vertical layout is Trilium's original layout:

@@ -41,12 +41,12 @@

The horizontal layout is a more traditional layout, since it bears similarity with other applications. In this mode:

Note Tree -
  • Launcher Bar +
  • Launch Bar
  • Quick search