mirror of
https://github.com/zadam/trilium.git
synced 2025-11-03 20:06:08 +01:00
feat(docs): document the launch bar
This commit is contained in:
Elian Doran
@@ -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",
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
|
||||
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).
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 5.4 KiB |
@@ -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
|
||||
@@ -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  button at the bottom of the [Launcher Bar](Launcher%20Bar.md).
|
||||
* The [Global menu](Global%20menu.md) can be accessed via the  icon at the top of the [Launcher Bar](Launcher%20Bar.md).
|
||||
* The [Note Tree](Note%20Tree.md) can be collapsed by pressing the  button at the bottom of the [Launcher Bar](Launch%20Bar.md).
|
||||
* The [Global menu](Global%20menu.md) can be accessed via the  icon at the top of the [Launcher Bar](Launch%20Bar.md).
|
||||
|
||||
|
||||
|
||||
@@ -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  button to the left of the first tab.
|
||||
* The [Global menu](Global%20menu.md) can be accessed via the  button at the end of the [Launcher Bar](Launcher%20Bar.md).
|
||||
* The [Global menu](Global%20menu.md) can be accessed via the  button at the end of the [Launcher Bar](Launch%20Bar.md).
|
||||
|
||||
|
||||
|
||||
|
||||
71
src/public/app/doc_notes/en/User Guide/!!!meta.json
generated
71
src/public/app/doc_notes/en/User Guide/!!!meta.json
generated
@@ -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",
|
||||
|
||||
106
src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Launch Bar.html
generated
Normal file
106
src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Launch Bar.html
generated
Normal file
@@ -0,0 +1,106 @@
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
<base target="_parent">
|
||||
<title data-trilium-title>Launch Bar</title>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<div class="content">
|
||||
<h1 data-trilium-h1>Launch Bar</h1>
|
||||
|
||||
<div class="ck-content">
|
||||
<h2>Position of the Launch bar</h2>
|
||||
<p>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 <a class="reference-link" href="Vertical%20and%20horizontal%20layout.html">Vertical and horizontal layout</a> for
|
||||
more information.</p>
|
||||
<h2>Terminology</h2>
|
||||
<ul>
|
||||
<li><strong>Launcher</strong>: a button that can be (or is) displayed on the
|
||||
launch bar.</li>
|
||||
<li><strong>Available Launcher</strong>: a launcher that is not displayed
|
||||
on the launch bar, but can be added.</li>
|
||||
<li><strong>Visible Launcher</strong>: a launcher that is currently displayed
|
||||
on the launch bar.</li>
|
||||
</ul>
|
||||
<h2>Configuring the Launch bar</h2>
|
||||
<p>There are two ways to configure the launch bar:</p>
|
||||
<ul>
|
||||
<li>Right click in the empty space between launchers on the launch bar and
|
||||
select <i>Configure Launchbar.</i>
|
||||
</li>
|
||||
<li>Click on the <a class="reference-link" href="Global%20menu.html">Global menu</a> and
|
||||
select <i>Configure Launchbar</i>.</li>
|
||||
</ul>
|
||||
<p>This will open a new tab with the <a class="reference-link" href="Note%20Tree.html">Note Tree</a> listing
|
||||
the launchers.</p>
|
||||
<p>
|
||||
<img src="Launch Bar_image.png" width="355" height="104">
|
||||
</p>
|
||||
<p>Expanding <i>Available Launchers</i> section will show the list of launchers
|
||||
that are not displayed on the launch bar. The <i>Visible Launchers</i> will
|
||||
show the ones that are currently displayed.</p>
|
||||
<h3>Adding/removing and reordering launchers</h3>
|
||||
<p>To display a new launcher in the launch bar, first look for it in the <i>Available Launchers</i> section.
|
||||
Then right click it and select <i>Move to visible launchers</i>. It is also
|
||||
possible to drag and drop the item manually.</p>
|
||||
<p>Similarly, to remove it from the launch bar, simply look for it in <i>Visible Launchers</i> then
|
||||
right click it and select <i>Move to available launchers </i>or use drag-and-drop.</p>
|
||||
<p>Drag-and-drop the items in the tree in order to change their
|
||||
order. See <a class="reference-link" href="Note%20Tree.html">Note Tree</a> for
|
||||
more interaction options, including using keyboard shortcuts.</p>
|
||||
<h3>Resetting</h3>
|
||||
<p>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 <i>Launch Bar</i> section) and select <i>Reset</i> to bring
|
||||
it back to the original state.</p>
|
||||
<h3>Creating new launchers / types of launchers</h3>
|
||||
<p>Right click either the <i>Available launchers</i> or <i>Visible launchers</i> sections
|
||||
and select one of the options:</p>
|
||||
<ol>
|
||||
<li>
|
||||
<p><strong>Note Launcher</strong>
|
||||
<br>A note launcher will simply navigate to a specified note.</p>
|
||||
<ol>
|
||||
<li>Set the <code>target</code> promoted attribute to the note to navigate to.</li>
|
||||
<li>Optionally, set <code>hoistedNote</code> to hoist a particular note. See
|
||||
<a
|
||||
class="reference-link" href="../Navigation/Note%20Hoisting.html">Note Hoisting</a> for more information.</li>
|
||||
<li>Optionally, set a <code>keyboardShortcut</code> to trigger the launcher.</li>
|
||||
</ol>
|
||||
<p> </p>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>Script Launcher</strong>
|
||||
<br>An advanced launcher which will run a script upon pressing. See
|
||||
<a
|
||||
class="reference-link" href="../../Note%20Types/Code/Scripts.html">Scripts</a> for more information.</p>
|
||||
<ol>
|
||||
<li>Set <code>script</code> to point to the desired script to run.</li>
|
||||
<li>Optionally, set a <code>keyboardShortcut</code> to trigger the launcher.</li>
|
||||
</ol>
|
||||
<p> </p>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>Custom Widget</strong>
|
||||
</p>
|
||||
<p>Allows defining a custom widget to be rendered inside the launcher. See
|
||||
<a
|
||||
class="reference-link" href="../../Developer%20Guides/Widget%20Basics.html">Widget Basics</a> for more information.</p>
|
||||
<p> </p>
|
||||
</li>
|
||||
<li><strong>Spacers</strong>
|
||||
<br>Launchers that create some distance between other launchers for better
|
||||
visual distinction.</li>
|
||||
</ol>
|
||||
<p>Launchers are configured via predefined <a class="reference-link"
|
||||
href="../../Advanced%20Usage/Attributes/Promoted%20Attributes.html">Promoted Attributes</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
</html>
|
||||
BIN
src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Launch Bar_image.png
generated
Normal file
BIN
src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts/UI Elements/Launch Bar_image.png
generated
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 5.4 KiB |
@@ -1,23 +0,0 @@
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../../../style.css">
|
||||
<base target="_parent">
|
||||
<title data-trilium-title>Launcher Bar</title>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<div class="content">
|
||||
<h1 data-trilium-h1>Launcher Bar</h1>
|
||||
|
||||
<div class="ck-content">
|
||||
<h2>Position of the launcher bar</h2>
|
||||
<p>It's possible to display the launcher bar either vertically, on the left
|
||||
side of the screen, or horizontally on the top</p>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
</html>
|
||||
@@ -18,7 +18,7 @@
|
||||
<h3>Vertical layout</h3>
|
||||
<p>The vertical layout is Trilium's original layout:</p>
|
||||
<ul>
|
||||
<li>The <a class="reference-link" href="Launcher%20Bar.html">Launcher Bar</a> is
|
||||
<li>The <a class="reference-link" href="Launch%20Bar.html">Launcher Bar</a> is
|
||||
positioned on the left side of the screen, with buttons being laid out
|
||||
vertically.</li>
|
||||
<li>The tab bar is at the top, but to the right of the <a class="reference-link"
|
||||
@@ -28,11 +28,11 @@
|
||||
<li>The <a class="reference-link" href="Note%20Tree.html">Note Tree</a> can
|
||||
be collapsed by pressing the
|
||||
<img src="6_Vertical and horizontal la.png"
|
||||
width="11" height="11">button at the bottom of the <a class="reference-link" href="Launcher%20Bar.html">Launcher Bar</a>.</li>
|
||||
width="11" height="11">button at the bottom of the <a class="reference-link" href="Launch%20Bar.html">Launcher Bar</a>.</li>
|
||||
<li>The <a class="reference-link" href="Global%20menu.html">Global menu</a> can
|
||||
be accessed via the
|
||||
<img src="5_Vertical and horizontal la.png" width="26"
|
||||
height="23">icon at the top of the <a class="reference-link" href="Launcher%20Bar.html">Launcher Bar</a>.</li>
|
||||
height="23">icon at the top of the <a class="reference-link" href="Launch%20Bar.html">Launcher Bar</a>.</li>
|
||||
</ul>
|
||||
<p>
|
||||
<img src="4_Vertical and horizontal la.png" width="1043" height="684">
|
||||
@@ -41,12 +41,12 @@
|
||||
<p>The horizontal layout is a more traditional layout, since it bears similarity
|
||||
with other applications. In this mode:</p>
|
||||
<ul>
|
||||
<li>The <a class="reference-link" href="Launcher%20Bar.html">Launcher Bar</a> is
|
||||
<li>The <a class="reference-link" href="Launch%20Bar.html">Launcher Bar</a> is
|
||||
at the top of the screen, with the buttons laid horizontally.</li>
|
||||
<li>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.</li>
|
||||
<li>The <a class="reference-link" href="Quick%20search.html">Quick search</a> is
|
||||
now part of the <a class="reference-link" href="Launcher%20Bar.html">Launcher Bar</a>.
|
||||
now part of the <a class="reference-link" href="Launch%20Bar.html">Launcher Bar</a>.
|
||||
It can be moved around according to preference and even removed if needed.</li>
|
||||
<li>The <a class="reference-link" href="Note%20Tree.html">Note Tree</a> can
|
||||
be collapsed by pressing the small
|
||||
@@ -55,7 +55,7 @@
|
||||
<li>The <a class="reference-link" href="Global%20menu.html">Global menu</a> can
|
||||
be accessed via the
|
||||
<img src="1_Vertical and horizontal la.png" width="15"
|
||||
height="11">button at the end of the <a class="reference-link" href="Launcher%20Bar.html">Launcher Bar</a>.</li>
|
||||
height="11">button at the end of the <a class="reference-link" href="Launch%20Bar.html">Launcher Bar</a>.</li>
|
||||
</ul>
|
||||
<figure class="image">
|
||||
<img style="aspect-ratio:1043/684;" src="3_Vertical and horizontal la.png"
|
||||
|
||||
@@ -97,8 +97,8 @@
|
||||
<li><a href="User%20Guide/Basic%20Concepts/UI%20Elements/Note%20Tree.html"
|
||||
target="detail">Note Tree</a>
|
||||
</li>
|
||||
<li><a href="User%20Guide/Basic%20Concepts/UI%20Elements/Launcher%20Bar.html"
|
||||
target="detail">Launcher Bar</a>
|
||||
<li><a href="User%20Guide/Basic%20Concepts/UI%20Elements/Launch%20Bar.html"
|
||||
target="detail">Launch Bar</a>
|
||||
</li>
|
||||
<li><a href="User%20Guide/Basic%20Concepts/UI%20Elements/Quick%20search.html"
|
||||
target="detail">Quick search</a>
|
||||
|
||||
Reference in New Issue
Block a user