mirror of https://github.com/TriliumNext/Notes
Merge remote-tracking branch 'origin/develop' into calendar
Elian Doran
commit
32a6aed93b
@ -1,4 +1,4 @@
|
|||||||
# These are supported funding model platforms
|
# These are supported funding model platforms
|
||||||
|
|
||||||
github: [zadam]
|
github: [eliandoran]
|
||||||
custom: ["https://paypal.me/za4am"]
|
custom: ["https://paypal.me/eliandoran"]
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because one or more lines are too long
Binary file not shown.
|
Before Width: | Height: | Size: 36 KiB After Width: | Height: | Size: 32 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 82 KiB |
@ -1,16 +0,0 @@
|
|||||||
# Bulk actions
|
|
||||||
### Execute script
|
|
||||||
|
|
||||||
For more complex scenarios, it is possible to type in a JavaScript expression in order to apply the necessary changes.
|
|
||||||
|
|
||||||
To apply a suffix (`- suffix` in this example), to the note title:
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
note.title = note.title + " - suffix";
|
|
||||||
```
|
|
||||||
|
|
||||||
To alter attributes of a note in a bulk action, such as setting the `#shareAlias` label to the title of the note:
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
note.setLabel("shareAlias", note.title)
|
|
||||||
```
|
|
||||||
File diff suppressed because one or more lines are too long
Binary file not shown.
|
After Width: | Height: | Size: 30 KiB |
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 13 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 92 KiB |
|
Before Width: | Height: | Size: 9.0 KiB After Width: | Height: | Size: 9.0 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 17 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 80 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 94 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 7.3 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 32 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 7.3 KiB After Width: | Height: | Size: 17 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 1.4 KiB |
@ -1,29 +0,0 @@
|
|||||||
# Events
|
|
||||||
[Script](../../Scripting.md) notes can be triggered by events. Note that these are backend events and thus relation need to point to the "JS backend" code note.
|
|
||||||
|
|
||||||
## Global events
|
|
||||||
|
|
||||||
Global events are attached to the script note via label. Simply create e.g. "run" label with some of these values and script note will be executed once the event occurs.
|
|
||||||
|
|
||||||
* `run`
|
|
||||||
* `frontendStartup` - executes on frontend upon startup
|
|
||||||
* `mobileStartup` - executes on mobile frontend upon startup
|
|
||||||
* `backendStartup` - executes on backend upon startup
|
|
||||||
* `hourly` - executes once an hour on backend
|
|
||||||
* `daily` - executes once a day on backend
|
|
||||||
|
|
||||||
## Entity events
|
|
||||||
|
|
||||||
Other events are bound to some entity, these are defined as [relations](../../Advanced%20Usage/Attributes.md) - meaning that script is triggered only if note has this script attached to it through relations (or it can inherit it).
|
|
||||||
|
|
||||||
* `runOnNoteCreation` - executes when note is created on backend
|
|
||||||
* `runOnNoteTitleChange` - executes when note title is changed (includes note creation as well)
|
|
||||||
* `runOnNoteContentChange` - executes when note content is changed (includes note creation as well).
|
|
||||||
* `runOnNoteChange` - executes when note is changed (includes note creation as well)
|
|
||||||
* `runOnNoteDeletion` - executes when note is being deleted
|
|
||||||
* `runOnBranchCreation` - executes when a branch is created. Branch is a link between parent note and child note and is created e.g. when cloning or moving note.
|
|
||||||
* `runOnBranchChange` (since v0.62) - executes when a branch is changed - either expanded status or prefix are changed.
|
|
||||||
* `runOnBranchDeletion` - executes when a branch is delete. Branch is a link between parent note and child note and is deleted e.g. when moving note (old branch/link is deleted).
|
|
||||||
* `runOnChildNoteCreation` - executes when new note is created under _this_ note
|
|
||||||
* `runOnAttributeCreation` - executes when new attribute is created under _this_ note
|
|
||||||
* `runOnAttributeChange` - executes when attribute is changed under _this_ note
|
|
||||||
|
Before Width: | Height: | Size: 108 KiB After Width: | Height: | Size: 108 KiB |
@ -0,0 +1,14 @@
|
|||||||
|
# Events
|
||||||
|
[Script](../Scripting.md) notes can be triggered by events. Note that these are backend events and thus relation need to point to the "JS backend" code note.
|
||||||
|
|
||||||
|
## Global events
|
||||||
|
|
||||||
|
Global events are attached to the script note via label. Simply create e.g. "run" label with some of these values and script note will be executed once the event occurs.
|
||||||
|
|
||||||
|
<figure class="table"><table><thead><tr><th>Label</th><th>Description</th></tr></thead><tbody><tr><td><code>run</code></td><td><p>Defines on which events script should run. Possible values are:</p><ul><li><code>frontendStartup</code> - when Trilium frontend starts up (or is refreshed), but not on mobile.</li><li><code>mobileStartup</code> - when Trilium frontend starts up (or is refreshed), on mobile.</li><li><code>backendStartup</code> - when Trilium backend starts up</li><li><code>hourly</code> - run once an hour. You can use additional label <code>runAtHour</code> to specify at which hour, on the back-end.</li><li><code>daily</code> - run once a day, on the back-end</li></ul></td></tr><tr><td><code>runOnInstance</code></td><td>Specifies that the script should only run on a particular <a class="reference-link" href="../Advanced%20Usage/Configuration%20(config.ini%20or%20environment%20variables)/Trilium%20instance.md">Trilium instance</a>.</td></tr><tr><td><code>runAtHour</code></td><td>On which hour should this run. Should be used together with <code>#run=hourly</code>. Can be defined multiple times for more runs during the day.</td></tr></tbody></table></figure>
|
||||||
|
|
||||||
|
## Entity events
|
||||||
|
|
||||||
|
Other events are bound to some entity, these are defined as [relations](../Advanced%20Usage/Attributes.md) - meaning that script is triggered only if note has this script attached to it through relations (or it can inherit it).
|
||||||
|
|
||||||
|
<figure class="table"><table><thead><tr><th>Relation</th><th>Description</th></tr></thead><tbody><tr><td><code>runOnNoteCreation</code></td><td>executes when note is created on backend. Use this relation if you want to run the script for all notes created under a specific subtree. In that case, create it on the subtree root note and make it inheritable. A new note created within the subtree (any depth) will trigger the script.</td></tr><tr><td><code>runOnChildNoteCreation</code></td><td>executes when new note is created under the note where this relation is defined</td></tr><tr><td><code>runOnNoteTitleChange</code></td><td>executes when note title is changed (includes note creation as well)</td></tr><tr><td><code>runOnNoteContentChange</code></td><td>executes when note content is changed (includes note creation as well).</td></tr><tr><td><code>runOnNoteChange</code></td><td>executes when note is changed (includes note creation as well). Does not include content changes</td></tr><tr><td><code>runOnNoteDeletion</code></td><td>executes when note is being deleted</td></tr><tr><td><code>runOnBranchCreation</code></td><td>executes when a branch is created. Branch is a link between parent note and child note and is created e.g. when cloning or moving note.</td></tr><tr><td><code>runOnBranchChange</code></td><td>executes when a branch is updated. (since v0.62)</td></tr><tr><td><code>runOnBranchDeletion</code></td><td>executes when a branch is deleted. Branch is a link between parent note and child note and is deleted e.g. when moving note (old branch/link is deleted).</td></tr><tr><td><code>runOnAttributeCreation</code></td><td>executes when new attribute is created for the note which defines this relation</td></tr><tr><td><code>runOnAttributeChange</code></td><td>executes when the attribute is changed of a note which defines this relation. This is triggered also when the attribute is deleted</td></tr></tbody></table></figure>
|
||||||
Binary file not shown.
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,405 @@
|
|||||||
|
<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>Labels</title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div class="content">
|
||||||
|
<h1 data-trilium-h1>Labels</h1>
|
||||||
|
|
||||||
|
<div class="ck-content">
|
||||||
|
<p>A label is an <a href="#root/_help_zEY4DaJG4YT5">attribute</a> of a note
|
||||||
|
which has a name and optionally a value.</p>
|
||||||
|
<h2>Common use cases</h2>
|
||||||
|
<ul>
|
||||||
|
<li><strong>Metadata for personal use</strong>: Assign labels with optional
|
||||||
|
values for categorization, such as <code>#year=1999</code>, <code>#genre="sci-fi"</code>,
|
||||||
|
or <code>#author="Neal Stephenson"</code>. This can be combined with
|
||||||
|
<a
|
||||||
|
class="reference-link" href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a> to make their display more user-friendly.</li>
|
||||||
|
<li><strong>Configuration</strong>: Labels can configure advanced features
|
||||||
|
or settings (see reference below).</li>
|
||||||
|
<li><strong>Scripts and Plugins</strong>: Used to tag notes with special metadata,
|
||||||
|
such as the "weight" attribute in the <a class="reference-link" href="#root/_help_R7abl2fc6Mxi">Weight Tracker</a>.</li>
|
||||||
|
</ul>
|
||||||
|
<h2>Creating a label using the visual editor</h2>
|
||||||
|
<ol>
|
||||||
|
<li>Go to the <em>Owned Attributes</em> section in the <a class="reference-link"
|
||||||
|
href="#root/_help_BlN9DFI679QC">Ribbon</a>.</li>
|
||||||
|
<li>Press the + button (<em>Add new attribute</em>) to the right.</li>
|
||||||
|
<li>Select <em>Add new label</em> for the relation.</li>
|
||||||
|
</ol>
|
||||||
|
<aside class="admonition tip">
|
||||||
|
<p>If you prefer keyboard shortcuts, press <kbd>Alt</kbd>+<kbd>L</kbd> while
|
||||||
|
focused on a note or in the <em>Owned Attributes</em> section to display
|
||||||
|
the visual editor.</p>
|
||||||
|
</aside>
|
||||||
|
<p>While in the visual editor:</p>
|
||||||
|
<ul>
|
||||||
|
<li>Set the desired name</li>
|
||||||
|
<li>Optionally, set the value of the label. Labels can exist without a value.</li>
|
||||||
|
<li>Check <em>Inheritable</em> if the label should be inherited by the child
|
||||||
|
notes as well. See <a class="reference-link" href="#root/_help_bwZpz2ajCEwO">Attribute Inheritance</a> for
|
||||||
|
more information.</li>
|
||||||
|
</ul>
|
||||||
|
<h2>Creating a label manually</h2>
|
||||||
|
<p>In the <em>Owned Attributes</em> section in the <a class="reference-link"
|
||||||
|
href="#root/_help_BlN9DFI679QC">Ribbon</a>:</p>
|
||||||
|
<ul>
|
||||||
|
<li>To create a label called <code>myLabel</code> with no value, simply type <code>#myLabel</code>.</li>
|
||||||
|
<li>To create a label called <code>myLabel</code> with a value <code>value</code>,
|
||||||
|
simply type <code>#myLabel=value</code>.</li>
|
||||||
|
<li>If the value contains spaces, then the text must be quoted: <code>#myLabel="Hello world"</code>.</li>
|
||||||
|
<li>If the string contains quotes (regardless of whether it has spaces), then
|
||||||
|
the text must be quoted with apostrophes instead: <code>#myLabel='Hello "world"'</code>.</li>
|
||||||
|
<li>To create an inheritable label called <code>myLabel</code>, simply write <code>#myLabel(inheritable)</code> for
|
||||||
|
no value or <code>#myLabel(inheritable)=value</code> if there is a value.</li>
|
||||||
|
</ul>
|
||||||
|
<h2>Predefined labels</h2>
|
||||||
|
<p>This is a list of labels that Trilium natively supports.</p>
|
||||||
|
<aside class="admonition tip">
|
||||||
|
<p>Some labels presented here end with a <code>*</code>. That means that there
|
||||||
|
are multiple labels with the same prefix, consult the specific page linked
|
||||||
|
in the description of that label for more information.</p>
|
||||||
|
</aside>
|
||||||
|
<figure class="table" style="width:100%;">
|
||||||
|
<table class="ck-table-resized">
|
||||||
|
<colgroup>
|
||||||
|
<col style="width:33.82%;">
|
||||||
|
<col style="width:66.18%;">
|
||||||
|
</colgroup>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>Label</th>
|
||||||
|
<th>Description</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td><code>disableVersioning</code>
|
||||||
|
</td>
|
||||||
|
<td>Disables automatic creation of <a class="reference-link" href="#root/_help_vZWERwf8U3nx">Note Revisions</a> for
|
||||||
|
a particular note. Useful for e.g. large, but unimportant notes - e.g.
|
||||||
|
large JS libraries used for scripting.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>versioningLimit</code>
|
||||||
|
</td>
|
||||||
|
<td>Limits the maximum number of <a class="reference-link" href="#root/_help_vZWERwf8U3nx">Note Revisions</a> for
|
||||||
|
a particular note, overriding the global settings.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>calendarRoot</code>
|
||||||
|
</td>
|
||||||
|
<td>Marks the note which should be used as root for <a class="reference-link"
|
||||||
|
href="#root/_help_l0tKav7yLHGF">Day Notes</a>. Only one should be marked
|
||||||
|
as such.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>archived</code>
|
||||||
|
</td>
|
||||||
|
<td>Hides notes from default search results and dialogs. Archived notes can
|
||||||
|
optionally be hidden in the <a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>excludeFromExport</code>
|
||||||
|
</td>
|
||||||
|
<td>Excludes this note and its children when exporting.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>run</code>, <code>runOnInstance</code>, <code>runAtHour</code>
|
||||||
|
</td>
|
||||||
|
<td>See <a class="reference-link" href="#root/_help_GPERMystNGTB">Events</a>.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>disableInclusion</code>
|
||||||
|
</td>
|
||||||
|
<td>Scripts with this label won't be included into parent script execution.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>sorted</code>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<p>Keeps child notes sorted by title alphabetically.</p>
|
||||||
|
<p>When given a value, it will sort by the value of another label instead.
|
||||||
|
If one of the child notes doesn't have the specified label, the title will
|
||||||
|
be used for them instead.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>sortDirection</code>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<p>If <code>sorted</code> is applied, specifies the direction of the sort:</p>
|
||||||
|
<ul>
|
||||||
|
<li><code>ASC</code>, ascending (default)</li>
|
||||||
|
<li><code>DESC</code>, descending</li>
|
||||||
|
</ul>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>sortFoldersFirst</code>
|
||||||
|
</td>
|
||||||
|
<td>If <code>sorted</code> is applied, folders (notes with children) will be
|
||||||
|
sorted as a group at the top, and the rest will be sorted.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>top</code>
|
||||||
|
</td>
|
||||||
|
<td>If <code>sorted</code> is applied to the parent note, keeps given note on
|
||||||
|
top in its parent.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>hidePromotedAttributes</code>
|
||||||
|
</td>
|
||||||
|
<td>Hide <a class="reference-link" href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a> on
|
||||||
|
this note. Generally useful when defining inherited attributes, but the
|
||||||
|
parent note doesn't need them.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>readOnly</code>
|
||||||
|
</td>
|
||||||
|
<td>Marks a note to be always be <a href="#root/_help_CoFPLs3dRlXc">read-only</a>,
|
||||||
|
if it's a supported note (text, code, mermaid).</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>autoReadOnlyDisabled</code>
|
||||||
|
</td>
|
||||||
|
<td>Disables automatic <a href="#root/_help_CoFPLs3dRlXc">read-only mode</a> for
|
||||||
|
the given note.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>appCss</code>
|
||||||
|
</td>
|
||||||
|
<td>Marks CSS notes which are loaded into the Trilium application and can
|
||||||
|
thus be used to modify Trilium's looks. See <a class="reference-link"
|
||||||
|
href="#root/_help_AlhDUqhENtH7">Custom app-wide CSS</a> for more info.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>appTheme</code>
|
||||||
|
</td>
|
||||||
|
<td>Marks CSS notes which are full Trilium themes and are thus available in
|
||||||
|
Trilium options. See <a class="reference-link" href="#root/_help_pKK96zzmvBGf">Theme development</a> for
|
||||||
|
more information.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>appThemeBase</code>
|
||||||
|
</td>
|
||||||
|
<td>Set to <code>next</code>, <code>next-light</code>, or <code>next-dark</code> to
|
||||||
|
use the corresponding TriliumNext theme (auto, light or dark) as the base
|
||||||
|
for a custom theme, instead of the legacy one. See <a class="reference-link"
|
||||||
|
href="#root/_help_WFGzWeUK6arS">Customize the Next theme</a> for more
|
||||||
|
information.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>cssClass</code>
|
||||||
|
</td>
|
||||||
|
<td>Value of this label is then added as CSS class to the node representing
|
||||||
|
given note in the <a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.
|
||||||
|
This can be useful for advanced theming. Can be used in template notes.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>iconClass</code>
|
||||||
|
</td>
|
||||||
|
<td>value of this label is added as a CSS class to the icon on the tree which
|
||||||
|
can help visually distinguish the notes in the tree. Example might be bx
|
||||||
|
bx-home - icons are taken from boxicons. Can be used in template notes.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>pageSize</code>
|
||||||
|
</td>
|
||||||
|
<td>Specifies the number of items per page in <a class="reference-link"
|
||||||
|
href="#root/_help_0ESUbbAxVnoK">Note List</a>.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>customRequestHandler</code>
|
||||||
|
</td>
|
||||||
|
<td>See <a class="reference-link" href="#root/_help_J5Ex1ZrMbyJ6">Custom Request Handler</a>.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>customResourceProvider</code>
|
||||||
|
</td>
|
||||||
|
<td>See <a class="reference-link" href="#root/_help_d3fAXQ2diepH">Custom Resource Providers</a>.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>widget</code>
|
||||||
|
</td>
|
||||||
|
<td>Marks this note as a custom widget which will be added to the Trilium
|
||||||
|
component tree. See <a class="reference-link" href="#root/_help_MgibgPcfeuGz">Custom Widgets</a> for
|
||||||
|
more information.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>searchHome</code>
|
||||||
|
</td>
|
||||||
|
<td>New search notes will be created as children of this note (see
|
||||||
|
<a
|
||||||
|
class="reference-link" href="#root/_help_m523cpzocqaD">Saved Search</a>).</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>workspace</code> and related attributes</td>
|
||||||
|
<td>See <a class="reference-link" href="#root/_help_9sRHySam5fXb">Workspaces</a>.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>inbox</code>
|
||||||
|
</td>
|
||||||
|
<td>default inbox location for new notes - when you create a note using <em>new note</em> button
|
||||||
|
in the sidebar, notes will be created as child notes in the note marked
|
||||||
|
as with <code>#inbox</code> label.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>sqlConsoleHome</code>
|
||||||
|
</td>
|
||||||
|
<td>Default location of <a class="reference-link" href="#root/_hidden/_help/_help_tC7s2alapj8V/_help_wX4HbRucYSDD/_help_oyIAJ9PvvwHX/_help__help_YKWqdJhzi2VY">SQL Console</a> notes</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>bookmarked</code>
|
||||||
|
</td>
|
||||||
|
<td>Indicates this note is a <a href="#root/_help_u3YFHC9tQlpm">bookmark</a>.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>bookmarkFolder</code>
|
||||||
|
</td>
|
||||||
|
<td>Note with this label will appear in bookmarks as folder (allowing access
|
||||||
|
to its children). See <a class="reference-link" href="#root/_help_u3YFHC9tQlpm">Bookmarks</a> for
|
||||||
|
more information.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>share*</code>
|
||||||
|
</td>
|
||||||
|
<td>See the attribute reference in <a class="reference-link" href="#root/_help_R9pX4DGra2Vt">Sharing</a>.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>displayRelations</code>, <code>hideRelations</code>
|
||||||
|
</td>
|
||||||
|
<td>Comma delimited names of relations which should be displayed/hidden in
|
||||||
|
a <a class="reference-link" href="#root/_help_iRwzGnHPzonm">Relation Map</a> (both
|
||||||
|
the note type and the <a class="reference-link" href="#root/_help_BCkXAVs63Ttv">Note Map (Link map, Tree map)</a> general
|
||||||
|
functionality).</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>titleTemplate</code>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<p>Default title of notes created as children of this note. This value is
|
||||||
|
evaluated as a JavaScript string and thus can be enriched with dynamic
|
||||||
|
content via the injected <code>now</code> and <code>parentNote</code> variables.</p>
|
||||||
|
<p>Examples:</p>
|
||||||
|
<ul>
|
||||||
|
<li><code>${parentNote.getLabel('authorName')}'s literary works</code>
|
||||||
|
</li>
|
||||||
|
<li><code>Log for ${now.format('YYYY-MM-DD HH:mm:ss')}</code>
|
||||||
|
</li>
|
||||||
|
<li>to mirror the parent's template.</li>
|
||||||
|
</ul>
|
||||||
|
<p>See <a class="reference-link" href="#root/_help_47ZrP6FNuoG8">Default Note Title</a> for
|
||||||
|
more info.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>template</code>
|
||||||
|
</td>
|
||||||
|
<td>This note will appear in the selection of available template when creating
|
||||||
|
new note. See <a class="reference-link" href="#root/_help_KC1HB96bqqHX">Templates</a> for
|
||||||
|
more information.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>toc</code>
|
||||||
|
</td>
|
||||||
|
<td>Controls the display of the <a class="reference-link" href="#root/_help_BFvAtE74rbP6">Table of contents</a> for
|
||||||
|
a given note. <code>#toc</code> or <code>#toc=show</code> to always display
|
||||||
|
the table of contents, <code>#toc=false</code> to always hide it.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>color</code>
|
||||||
|
</td>
|
||||||
|
<td>defines color of the note in note tree, links etc. Use any valid CSS color
|
||||||
|
value like 'red' or #a13d5f</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>keyboardShortcut</code>
|
||||||
|
</td>
|
||||||
|
<td>Defines a keyboard shortcut which will immediately jump to this note.
|
||||||
|
Example: 'ctrl+alt+e'. Requires frontend reload for the change to take
|
||||||
|
effect.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>keepCurrentHoisting</code>
|
||||||
|
</td>
|
||||||
|
<td>Opening this link won't change hoisting even if the note is not displayable
|
||||||
|
in the current hoisted subtree.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>executeButton</code>
|
||||||
|
</td>
|
||||||
|
<td>Title of the button which will execute the current code note</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>executeDescription</code>
|
||||||
|
</td>
|
||||||
|
<td>Longer description of the current code note displayed together with the
|
||||||
|
execute button</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>excludeFromNoteMap</code>
|
||||||
|
</td>
|
||||||
|
<td>Notes with this label will be hidden from the <a class="reference-link"
|
||||||
|
href="#root/_help_bdUJEHsAPYQR">Note Map</a>.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>newNotesOnTop</code>
|
||||||
|
</td>
|
||||||
|
<td>New notes will be created at the top of the parent note, not on the bottom.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>hideHighlightWidget</code>
|
||||||
|
</td>
|
||||||
|
<td>Hides the <a class="reference-link" href="#root/_help_AxshuNRegLAv">Highlights list</a> widget</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>hideChildrenOverview</code>
|
||||||
|
</td>
|
||||||
|
<td>Hides the <a class="reference-link" href="#root/_help_0ESUbbAxVnoK">Note List</a> for
|
||||||
|
that particular note.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>printLandscape</code>
|
||||||
|
</td>
|
||||||
|
<td>When exporting to PDF, changes the orientation of the page to landscape
|
||||||
|
instead of portrait.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>printPageSize</code>
|
||||||
|
</td>
|
||||||
|
<td>When exporting to PDF, changes the size of the page. Supported values: <code>A0</code>, <code>A1</code>, <code>A2</code>, <code>A3</code>, <code>A4</code>, <code>A5</code>, <code>A6</code>, <code>Legal</code>, <code>Letter</code>, <code>Tabloid</code>, <code>Ledger</code>.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>geolocation</code>
|
||||||
|
</td>
|
||||||
|
<td>Indicates the latitude and longitude of a note, to be displayed in a
|
||||||
|
<a
|
||||||
|
class="reference-link" href="#root/_help_81SGnPGMk7Xc">Geo Map</a>.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>calendar:*</code>
|
||||||
|
</td>
|
||||||
|
<td>Defines specific options for the <a class="reference-link" href="#root/_help_xWbu3jpNWapp">Calendar View</a>.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>viewType</code>
|
||||||
|
</td>
|
||||||
|
<td>Sets the view of child notes (e.g. grid or list). See <a class="reference-link"
|
||||||
|
href="#root/_help_0ESUbbAxVnoK">Note List</a> for more information.</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</figure>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
|
||||||
|
</html>
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 36 KiB After Width: | Height: | Size: 32 KiB |
@ -0,0 +1,189 @@
|
|||||||
|
<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>Bulk Actions</title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div class="content">
|
||||||
|
<h1 data-trilium-h1>Bulk Actions</h1>
|
||||||
|
|
||||||
|
<div class="ck-content">
|
||||||
|
<figure class="image">
|
||||||
|
<img style="aspect-ratio:1425/654;" src="Bulk Actions_image.png" width="1425"
|
||||||
|
height="654">
|
||||||
|
</figure>
|
||||||
|
<p>The <em>Bulk Actions</em> dialog makes it easy to apply changes to multiple
|
||||||
|
notes at once, ranging from simple actions such as adding or removing a
|
||||||
|
label to being executing custom scripts.</p>
|
||||||
|
<h2>Interaction</h2>
|
||||||
|
<ul>
|
||||||
|
<li>The first step is to select the notes in the <a class="reference-link"
|
||||||
|
href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>. It's possible to apply bulk
|
||||||
|
actions to:
|
||||||
|
<ul>
|
||||||
|
<li>A single note (and potentially its child notes) simply by clicking on
|
||||||
|
it (with a left click or a right click).</li>
|
||||||
|
<li>Multiple notes. See <a class="reference-link" href="#root/_help_yTjUdsOi4CIE">Multiple selection</a> on
|
||||||
|
how to do so.</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>Right click in the <a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a> and
|
||||||
|
select <em>Advanced</em> → <em>Apply bulk actions</em>.</li>
|
||||||
|
<li>By default, only the selected notes will be affected. To also include
|
||||||
|
all the descendants of the notes, check <em>Include descendants of the selected notes</em>.
|
||||||
|
The number of affected notes at the top of the dialog will update to reflect
|
||||||
|
the change.</li>
|
||||||
|
<li>Click on which action to apply from the <em>Available actions</em> section.
|
||||||
|
A detailed description of each is available in the next section.
|
||||||
|
<ul>
|
||||||
|
<li>For each action selected, the <em>Chosen actions</em> section will update
|
||||||
|
to reveal the entry. Each action will have its own configuration.</li>
|
||||||
|
<li>To remove an action, simply press the X button to the right of it.</li>
|
||||||
|
<li>It is possible to apply multiple actions of the same type, such as adding
|
||||||
|
multiple types.</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>When all the actions are defined, press <em>Execute bulk actions</em> to
|
||||||
|
trigger all of them at once.</li>
|
||||||
|
<li>For convenience, the last bulk action configuration is saved for further
|
||||||
|
use and will be restored when entering the dialog again.</li>
|
||||||
|
</ul>
|
||||||
|
<h2>Actions</h2>
|
||||||
|
<h3>Labels</h3>
|
||||||
|
<p>These actions operate the <a class="reference-link" href="#root/_help_HI6GBBIduIgv">Labels</a> of
|
||||||
|
a note:</p>
|
||||||
|
<ul>
|
||||||
|
<li><strong>Add label</strong>
|
||||||
|
<ul>
|
||||||
|
<li>For each note, if it doesn't already have a <a href="#root/_help_HI6GBBIduIgv">label</a> of
|
||||||
|
the given name, it will create it. Keep the <em>New value</em> field empty
|
||||||
|
to create a label without a value, or complete it to assign a value.</li>
|
||||||
|
<li>If a note already has this label, its value will be updated.</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li><strong>Update label value</strong>
|
||||||
|
<ul>
|
||||||
|
<li>For each note, if it has a <a href="#root/_help_HI6GBBIduIgv">label</a> of
|
||||||
|
the given name, it will change its value to the specified one. Leave <em>New value</em> field
|
||||||
|
empty to create a label without a value.</li>
|
||||||
|
<li>Notes without the label will not be affected.</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li><em><strong>Rename label</strong></em>
|
||||||
|
<ul>
|
||||||
|
<li>For each note, if it has a <a href="#root/_help_HI6GBBIduIgv">label</a> of
|
||||||
|
the given name, it will be renamed/replaced with a label of the new name.
|
||||||
|
The value of the label (if present) will be kept intact.</li>
|
||||||
|
<li>Notes without the label will not be affected.</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li><strong>Delete label</strong>
|
||||||
|
<ul>
|
||||||
|
<li>For each note, if it has a label of a given name, it will be deleted (regardless
|
||||||
|
of whether it has a value or not).</li>
|
||||||
|
<li>Notes without the label will not be affected.</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h3>Relations</h3>
|
||||||
|
<p>These actions operate the <a class="reference-link" href="#root/_help_Cq5X6iKQop6R">Relations</a> of
|
||||||
|
a note:</p>
|
||||||
|
<ul>
|
||||||
|
<li><strong>Add relation</strong>
|
||||||
|
<ul>
|
||||||
|
<li>For each note, it will create a relation pointing to the given note.</li>
|
||||||
|
<li>Notes without this relation will not be affected.</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li><strong>Update relation target</strong>
|
||||||
|
<ul>
|
||||||
|
<li>For each note, it will modify a relation to point to the newly given note.</li>
|
||||||
|
<li>Notes without this relation will not be affected.</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li><strong>Rename relation</strong>
|
||||||
|
<ul>
|
||||||
|
<li>For each note, if it has a relation of the given name, it will be renamed/replaced
|
||||||
|
with a relation of the new name. The target note of the relation will be
|
||||||
|
kept intact.</li>
|
||||||
|
<li>Notes without this relation will not be affected.</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li><strong>Delete relation</strong>
|
||||||
|
<ul>
|
||||||
|
<li>For each note, if it has a relation of the given name, it will be deleted.</li>
|
||||||
|
<li>Notes without this relation will not be affected.</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h3>Notes</h3>
|
||||||
|
<ul>
|
||||||
|
<li><strong>Rename note</strong>
|
||||||
|
<ul>
|
||||||
|
<li>For each note, it will change the title of the note to the given one.</li>
|
||||||
|
<li>As a more advanced use case, the note can be a “template string” which
|
||||||
|
allows for dynamic values with access to the note information via
|
||||||
|
<a
|
||||||
|
class="reference-link" href="#root/_help_habiZ3HU8Kw8">FNote</a>, for example:
|
||||||
|
<ul>
|
||||||
|
<li><code>NEW: ${note.title}</code> will prefix all notes with <code>NEW:</code> .</li>
|
||||||
|
<li><code>${note.dateCreatedObj.format('MM-DD:')}: ${note.title}</code> will
|
||||||
|
prefix the note titles with each note's creation date (in month-day format).</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li><strong>Move note</strong>
|
||||||
|
<ul>
|
||||||
|
<li>For each note, it will be moved to the specified parent note.</li>
|
||||||
|
<li>As an alternative for less complex situations, the notes can be moved
|
||||||
|
directly from within the <a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a> via
|
||||||
|
cut → paste or via the contextual menu.</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li><strong>Delete note</strong>
|
||||||
|
<ul>
|
||||||
|
<li>For each note, it will be deleted.</li>
|
||||||
|
<li>As an alternative for less complex situations, the notes can be removed
|
||||||
|
directly from within the <a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a> by
|
||||||
|
selecting them and pressing <kbd>Delete</kbd>.</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li><strong>Delete note revisions</strong>
|
||||||
|
<ul>
|
||||||
|
<li>This will delete all the <a class="reference-link" href="#root/_help_vZWERwf8U3nx">Note Revisions</a> of
|
||||||
|
the notes.</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h3>Others</h3>
|
||||||
|
<ul>
|
||||||
|
<li><strong>Execute script</strong>
|
||||||
|
<ul>
|
||||||
|
<li>For more complex scenarios, it is possible to type in a JavaScript expression
|
||||||
|
in order to apply the necessary changes.</li>
|
||||||
|
<li>Examples:
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
<p>To apply a suffix (<code>- suffix</code> in this example), to the note
|
||||||
|
title:</p><pre><code class="language-application-javascript-env-backend">note.title = note.title + " - suffix";</code></pre>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<p>To alter attributes of a note based on another attribute, such as setting
|
||||||
|
the <code>#shareAlias</code> label to the title of the note:</p><pre><code class="language-application-javascript-env-backend">note.setLabel("shareAlias", note.title)</code></pre>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
|
||||||
|
</html>
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 82 KiB |
@ -1,27 +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>Bulk actions</title>
|
|
||||||
</head>
|
|
||||||
|
|
||||||
<body>
|
|
||||||
<div class="content">
|
|
||||||
<h1 data-trilium-h1>Bulk actions</h1>
|
|
||||||
|
|
||||||
<div class="ck-content">
|
|
||||||
<h3>Execute script</h3>
|
|
||||||
<p>For more complex scenarios, it is possible to type in a JavaScript expression
|
|
||||||
in order to apply the necessary changes.</p>
|
|
||||||
<p>To apply a suffix (<code>- suffix</code> in this example), to the note
|
|
||||||
title:</p><pre><code class="language-application-javascript-env-backend">note.title = note.title + " - suffix";</code></pre>
|
|
||||||
<p>To alter attributes of a note in a bulk action, such as setting the <code>#shareAlias</code> label
|
|
||||||
to the title of the note:</p><pre><code class="language-application-javascript-env-backend">note.setLabel("shareAlias", note.title)</code></pre>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
|
|
||||||
</html>
|
|
||||||
@ -0,0 +1,37 @@
|
|||||||
|
<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>Trilium instance</title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div class="content">
|
||||||
|
<h1 data-trilium-h1>Trilium instance</h1>
|
||||||
|
|
||||||
|
<div class="ck-content">
|
||||||
|
<p>A Trilium instance represents a server. If <a class="reference-link"
|
||||||
|
href="#root/_help_cbkrhQjrkKrh">Synchronization</a> is set up, since
|
||||||
|
multiple servers are involved (the one from the desktop client and the
|
||||||
|
one the synchronisation is set up with), sometimes it can be useful to
|
||||||
|
distinguish the instance you are running on.</p>
|
||||||
|
<h2>Setting the instance name</h2>
|
||||||
|
<p>To set up a name for the instance, modify the <code>config.ini</code>:</p><pre><code class="language-text-x-trilium-auto">[General]
|
||||||
|
instanceName=Hello</code></pre>
|
||||||
|
<h2>Distinguishing the instance on back-end</h2>
|
||||||
|
<p>Use <code>api.getInstanceName()</code> to obtain the instance name of the
|
||||||
|
current server, as specified in the config file or in environment variables.</p>
|
||||||
|
<h2>Limiting script runs based on instance</h2>
|
||||||
|
<p>For a script that is run periodically or on a certain event, it's possible
|
||||||
|
to limit it to certain instances without having to change the code. Just
|
||||||
|
add <code>runOnInstance</code> and set as the value the instance name where
|
||||||
|
the script should run. To run on multiple named instances, simply add the
|
||||||
|
label multiple times.</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
|
||||||
|
</html>
|
||||||
@ -0,0 +1,202 @@
|
|||||||
|
<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>Hidden Notes</title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div class="content">
|
||||||
|
<h1 data-trilium-h1>Hidden Notes</h1>
|
||||||
|
|
||||||
|
<div class="ck-content">
|
||||||
|
<figure class="image image-style-align-right">
|
||||||
|
<img style="aspect-ratio:263/445;" src="Hidden Notes_image.png" width="263"
|
||||||
|
height="445">
|
||||||
|
</figure>
|
||||||
|
<p>For easy extensibility, a lot of features in Trilium make use of actual
|
||||||
|
notes to store information as opposed to having them stored in a separate
|
||||||
|
location in the database. This allows some functions such as <a class="reference-link"
|
||||||
|
href="#root/_help_zEY4DaJG4YT5">Attributes</a>, <a class="reference-link"
|
||||||
|
href="#root/_help_Cq5X6iKQop6R">Relations</a> or even <a class="reference-link"
|
||||||
|
href="#root/_help_eIg8jdvaoNNd">Search</a> and <a class="reference-link"
|
||||||
|
href="#root/_help_QEAPj01N5f7w">Links</a> to be able to operate on
|
||||||
|
them.</p>
|
||||||
|
<p>As the name suggests, these notes are hidden to the user by default to
|
||||||
|
prevent cluttering the note tree and to prevent them from being accidentally
|
||||||
|
deleted.</p>
|
||||||
|
<p>The hidden notes are stored in the user's <a class="reference-link"
|
||||||
|
href="#root/_help_wX4HbRucYSDD">Database</a> just like normal notes,
|
||||||
|
but they have a unique <a class="reference-link" href="#root/_help_m1lbrzyKDaRB">Note ID</a> which
|
||||||
|
allows them to be distinguished from the normal ones.</p>
|
||||||
|
<h2>Accessing the hidden note tree</h2>
|
||||||
|
<p>From the <a class="reference-link" href="#root/_help_x3i7MxGccDuM">Global menu</a>,
|
||||||
|
select <em>Advanced</em> → <em>Show Hidden Subtree</em>.</p>
|
||||||
|
<h2>Contents of the hidden note tree</h2>
|
||||||
|
<p>Here is a brief summary of all the notes within the hidden tree:</p>
|
||||||
|
<figure
|
||||||
|
class="table" style="width:100%;">
|
||||||
|
<table class="ck-table-resized">
|
||||||
|
<colgroup>
|
||||||
|
<col style="width:19.93%;">
|
||||||
|
<col style="width:80.07%;">
|
||||||
|
</colgroup>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>Note</th>
|
||||||
|
<th>Description</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td><a class="reference-link" href="#root/_hidden/_help__globalNoteMap">Note Map</a>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<p>This note is actually opened when the <a class="reference-link" href="#root/_help_bdUJEHsAPYQR">Note Map</a> feature
|
||||||
|
that is accessed from the <a class="reference-link" href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>.</p>
|
||||||
|
<p>It is possible to create any child notes in it without any additional
|
||||||
|
meaning. For example, it can be used to store a list of note maps which
|
||||||
|
can be linked to from other notes or <a href="#root/_help_u3YFHC9tQlpm">bookmarked</a>.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><a class="reference-link" href="#root/_hidden/_help__sqlConsole">SQL Console History</a>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<p>When SQL queries or commands are executed in the <a class="reference-link"
|
||||||
|
href="#root/_help_YKWqdJhzi2VY">SQL Console</a>, they are stored here,
|
||||||
|
grouped by month. Only the query is stored and not the results.</p>
|
||||||
|
<p>This section can be accessed without going to the hidden tree by simply
|
||||||
|
going to the <a class="reference-link" href="#root/_help_x3i7MxGccDuM">Global menu</a> and
|
||||||
|
selecting Advanced → Open SQL Console History.</p>
|
||||||
|
<p>Notes can be added as children of this tree, but it's generally not recommended
|
||||||
|
to do so to not interfere with the normal history process.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><a class="reference-link" href="#root/_hidden/_help__search">Search History</a>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<p>Whenever a search is executed from the full <a class="reference-link"
|
||||||
|
href="#root/_help_eIg8jdvaoNNd">Search</a>, the query will be stored here,
|
||||||
|
grouped by month. Only the search parameters are stored and not the results
|
||||||
|
themselves.</p>
|
||||||
|
<p>This section can be accessed without going to the hidden tree by simply
|
||||||
|
going to the <a class="reference-link" href="#root/_help_x3i7MxGccDuM">Global menu</a> and
|
||||||
|
selecting Advanced → Open Search History.</p>
|
||||||
|
<p>Notes can be added as children of this tree, but it's generally not recommended
|
||||||
|
to do so to not interfere with the normal history process.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><a class="reference-link" href="#root/_hidden/_help__bulkAction">Bulk Action</a>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<p>This section is used for <a class="reference-link" href="#root/_help_ivYnonVFBxbQ">Bulk Actions</a>.
|
||||||
|
The last configuration for bulk actions will be stored as part of this
|
||||||
|
note, each action in its own <code>action</code> label.</p>
|
||||||
|
<p>Notes can be added as children of this tree, but there won't be any benefit
|
||||||
|
in doing so.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><a class="reference-link" href="#root/_hidden/_help__backendLog">Backend Log</a>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<p>This note corresponds to the backend log feature (see <a class="reference-link"
|
||||||
|
href="#root/_help_qzNzp9LYQyPT">Error logs</a>).</p>
|
||||||
|
<p>This item can be accessed without going to the hidden try by going to
|
||||||
|
the <a class="reference-link" href="#root/_help_x3i7MxGccDuM">Global menu</a> and
|
||||||
|
selecting Advanced → Show backend log.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><a class="reference-link" href="#root/_hidden/_help__userHidden">User Hidden</a>
|
||||||
|
</td>
|
||||||
|
<td>This section can be used by <a href="#root/_help_CdNpE2pqjmI6">scripts</a> to
|
||||||
|
create their own notes that should not be directly visible to the user.
|
||||||
|
The note can be identified by scripts by its unique ID: <code>_userHidden</code>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><a class="reference-link" href="#root/_hidden/_help__lbTplRoot">Launch Bar Templates</a>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<p>This section contains the templates for the creation of launchers in the
|
||||||
|
<a
|
||||||
|
class="reference-link" href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>. It is not possible to create child notes here.</p>
|
||||||
|
<p>Theoretically some of the notes here can be customized, but there's not
|
||||||
|
much benefit to be had in doing so.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><a class="reference-link" href="#root/_hidden/_help__share">Shared Notes</a>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<p>This tree lists all of the notes that are <a href="#root/_help_R9pX4DGra2Vt">shared</a> publicly.
|
||||||
|
It can be useful to track down which notes are shared regardless of their
|
||||||
|
position in the note tree.</p>
|
||||||
|
<p>This section can be accessed without going to the hidden tree simply by
|
||||||
|
going to the <a class="reference-link" href="#root/_help_x3i7MxGccDuM">Global menu</a> and
|
||||||
|
selecting <em>Show Shared Notes Subtree</em>.</p>
|
||||||
|
<p>Sub-notes cannot be created here.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><a class="reference-link" href="#root/_hidden/_help__lbRoot">Launch Bar</a>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<p>The tree contains both available and displayed items of the <a class="reference-link"
|
||||||
|
href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>.</p>
|
||||||
|
<p>This section can be accessed without going to the hidden tree by:</p>
|
||||||
|
<ul>
|
||||||
|
<li>Going to the <a class="reference-link" href="#root/_help_x3i7MxGccDuM">Global menu</a> and
|
||||||
|
selecting <em>Configure Launchbar</em>.</li>
|
||||||
|
<li>Right-clicking an empty space on the <a class="reference-link" href="#root/_help_xYmIYSP6wE3F">Launch Bar</a> and
|
||||||
|
selecting <em>Configure Launchbar</em>.</li>
|
||||||
|
</ul>
|
||||||
|
<p>Sub-notes cannot be created here.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><a class="reference-link" href="#root/_hidden/_help__options">Options</a>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<p>This section stores the list of <a class="reference-link" href="#root/_help_4TIF1oA4VQRO">Options</a>.</p>
|
||||||
|
<p>This section can be accessed without going to the hidden tree by:</p>
|
||||||
|
<ul>
|
||||||
|
<li>Going to the <a class="reference-link" href="#root/_help_x3i7MxGccDuM">Global menu</a> and
|
||||||
|
selecting <em>Options</em>.</li>
|
||||||
|
<li>Pressing the dedicated Options icon in the <a class="reference-link"
|
||||||
|
href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>.</li>
|
||||||
|
</ul>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><a class="reference-link" href="#root/_hidden/_help__lbMobileRoot">Mobile Launch Bar</a>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<p>This is very similar to the <em>Launch Bar</em>, but is dedicated for the
|
||||||
|
mobile UI only.</p>
|
||||||
|
<p>Accessing it outside the <em>Launch Bar</em> is the same as the Launch Bar,
|
||||||
|
but needs to be done so from the mobile interface.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><a class="reference-link" href="#root/_hidden/_help__help">User Guide</a>
|
||||||
|
</td>
|
||||||
|
<td>This is where the note structure for the User Guide is actually stored.
|
||||||
|
Only the metadata is stored, as the help itself is present as actual files
|
||||||
|
in the application directory.</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</figure>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
|
||||||
|
</html>
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 30 KiB |
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue