docs(guide): document new features for geomap

This commit is contained in:
Elian Doran
2025-07-24 23:39:25 +03:00
parent 051fe67176
commit 7055f77c91
21 changed files with 2386 additions and 2398 deletions

View File

@@ -52,334 +52,332 @@
are multiple labels with the same prefix, consult the specific page linked are multiple labels with the same prefix, consult the specific page linked
in the description of that label for more information.</p> in the description of that label for more information.</p>
</aside> </aside>
<figure class="table" style="width:100%;"> <table class="ck-table-resized">
<table class="ck-table-resized"> <colgroup>
<colgroup> <col style="width:33.82%;">
<col style="width:33.82%;"> <col style="width:66.18%;">
<col style="width:66.18%;"> </colgroup>
</colgroup> <thead>
<thead> <tr>
<tr> <th>Label</th>
<th>Label</th> <th>Description</th>
<th>Description</th> </tr>
</tr> </thead>
</thead> <tbody>
<tbody> <tr>
<tr> <td><code>disableVersioning</code>
<td><code>disableVersioning</code> </td>
</td> <td>Disables automatic creation of&nbsp;<a class="reference-link" href="#root/_help_vZWERwf8U3nx">Note Revisions</a>&nbsp;for
<td>Disables automatic creation of&nbsp;<a class="reference-link" href="#root/_help_vZWERwf8U3nx">Note Revisions</a>&nbsp;for a particular note. Useful for e.g. large, but unimportant notes - e.g.
a particular note. Useful for e.g. large, but unimportant notes - e.g. large JS libraries used for scripting.</td>
large JS libraries used for scripting.</td> </tr>
</tr> <tr>
<tr> <td><code>versioningLimit</code>
<td><code>versioningLimit</code> </td>
</td> <td>Limits the maximum number of&nbsp;<a class="reference-link" href="#root/_help_vZWERwf8U3nx">Note Revisions</a>&nbsp;for
<td>Limits the maximum number of&nbsp;<a class="reference-link" href="#root/_help_vZWERwf8U3nx">Note Revisions</a>&nbsp;for a particular note, overriding the global settings.</td>
a particular note, overriding the global settings.</td> </tr>
</tr> <tr>
<tr> <td><code>calendarRoot</code>
<td><code>calendarRoot</code> </td>
</td> <td>Marks the note which should be used as root for&nbsp;<a class="reference-link"
<td>Marks the note which should be used as root for&nbsp;<a class="reference-link" href="#root/_help_l0tKav7yLHGF">Day Notes</a>. Only one should be marked
href="#root/_help_l0tKav7yLHGF">Day Notes</a>. Only one should be marked as such.</td>
as such.</td> </tr>
</tr> <tr>
<tr> <td><code>archived</code>
<td><code>archived</code> </td>
</td> <td>Hides notes from default search results and dialogs. Archived notes can
<td>Hides notes from default search results and dialogs. Archived notes can optionally be hidden in the&nbsp;<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</td>
optionally be hidden in the&nbsp;<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</td> </tr>
</tr> <tr>
<tr> <td><code>excludeFromExport</code>
<td><code>excludeFromExport</code> </td>
</td> <td>Excludes this note and its children when exporting.</td>
<td>Excludes this note and its children when exporting.</td> </tr>
</tr> <tr>
<tr> <td><code>run</code>, <code>runOnInstance</code>, <code>runAtHour</code>
<td><code>run</code>, <code>runOnInstance</code>, <code>runAtHour</code> </td>
</td> <td>See&nbsp;<a class="reference-link" href="#root/_help_GPERMystNGTB">Events</a>.</td>
<td>See&nbsp;<a class="reference-link" href="#root/_help_GPERMystNGTB">Events</a>.</td> </tr>
</tr> <tr>
<tr> <td><code>disableInclusion</code>
<td><code>disableInclusion</code> </td>
</td> <td>Scripts with this label won't be included into parent script execution.</td>
<td>Scripts with this label won't be included into parent script execution.</td> </tr>
</tr> <tr>
<tr> <td><code>sorted</code>
<td><code>sorted</code> </td>
</td> <td>
<td> <p>Keeps child notes sorted by title alphabetically.</p>
<p>Keeps child notes sorted by title alphabetically.</p> <p>When given a value, it will sort by the value of another label instead.
<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
If one of the child notes doesn't have the specified label, the title will be used for them instead.</p>
be used for them instead.</p> </td>
</td> </tr>
</tr> <tr>
<tr> <td><code>sortDirection</code>
<td><code>sortDirection</code> </td>
</td> <td>
<td> <p>If <code>sorted</code> is applied, specifies the direction of the sort:</p>
<p>If <code>sorted</code> is applied, specifies the direction of the sort:</p> <ul>
<ul> <li><code>ASC</code>, ascending (default)</li>
<li><code>ASC</code>, ascending (default)</li> <li><code>DESC</code>, descending</li>
<li><code>DESC</code>, descending</li> </ul>
</ul> </td>
</td> </tr>
</tr> <tr>
<tr> <td><code>sortFoldersFirst</code>
<td><code>sortFoldersFirst</code> </td>
</td> <td>If <code>sorted</code> is applied, folders (notes with children) will be
<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>
sorted as a group at the top, and the rest will be sorted.</td> </tr>
</tr> <tr>
<tr> <td><code>top</code>
<td><code>top</code> </td>
</td> <td>If <code>sorted</code> is applied to the parent note, keeps given note on
<td>If <code>sorted</code> is applied to the parent note, keeps given note on top in its parent.</td>
top in its parent.</td> </tr>
</tr> <tr>
<tr> <td><code>hidePromotedAttributes</code>
<td><code>hidePromotedAttributes</code> </td>
</td> <td>Hide&nbsp;<a class="reference-link" href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;on
<td>Hide&nbsp;<a class="reference-link" href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;on this note. Generally useful when defining inherited attributes, but the
this note. Generally useful when defining inherited attributes, but the parent note doesn't need them.</td>
parent note doesn't need them.</td> </tr>
</tr> <tr>
<tr> <td><code>readOnly</code>
<td><code>readOnly</code> </td>
</td> <td>Marks a note to be always be <a href="#root/_help_CoFPLs3dRlXc">read-only</a>,
<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>
if it's a supported note (text, code, mermaid).</td> </tr>
</tr> <tr>
<tr> <td><code>autoReadOnlyDisabled</code>
<td><code>autoReadOnlyDisabled</code> </td>
</td> <td>Disables automatic <a href="#root/_help_CoFPLs3dRlXc">read-only mode</a> for
<td>Disables automatic <a href="#root/_help_CoFPLs3dRlXc">read-only mode</a> for the given note.</td>
the given note.</td> </tr>
</tr> <tr>
<tr> <td><code>appCss</code>
<td><code>appCss</code> </td>
</td> <td>Marks CSS notes which are loaded into the Trilium application and can
<td>Marks CSS notes which are loaded into the Trilium application and can thus be used to modify Trilium's looks. See&nbsp;<a class="reference-link"
thus be used to modify Trilium's looks. See&nbsp;<a class="reference-link" href="#root/_help_AlhDUqhENtH7">Custom app-wide CSS</a>&nbsp;for more info.</td>
href="#root/_help_AlhDUqhENtH7">Custom app-wide CSS</a>&nbsp;for more info.</td> </tr>
</tr> <tr>
<tr> <td><code>appTheme</code>
<td><code>appTheme</code> </td>
</td> <td>Marks CSS notes which are full Trilium themes and are thus available in
<td>Marks CSS notes which are full Trilium themes and are thus available in Trilium options. See&nbsp;<a class="reference-link" href="#root/_help_pKK96zzmvBGf">Theme development</a>&nbsp;for
Trilium options. See&nbsp;<a class="reference-link" href="#root/_help_pKK96zzmvBGf">Theme development</a>&nbsp;for more information.</td>
more information.</td> </tr>
</tr> <tr>
<tr> <td><code>appThemeBase</code>
<td><code>appThemeBase</code> </td>
</td> <td>Set to <code>next</code>, <code>next-light</code>, or <code>next-dark</code> to
<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
use the corresponding TriliumNext theme (auto, light or dark) as the base for a custom theme, instead of the legacy one. See&nbsp;<a class="reference-link"
for a custom theme, instead of the legacy one. See&nbsp;<a class="reference-link" href="#root/_help_WFGzWeUK6arS">Customize the Next theme</a>&nbsp;for more
href="#root/_help_WFGzWeUK6arS">Customize the Next theme</a>&nbsp;for more information.</td>
information.</td> </tr>
</tr> <tr>
<tr> <td><code>cssClass</code>
<td><code>cssClass</code> </td>
</td> <td>Value of this label is then added as CSS class to the node representing
<td>Value of this label is then added as CSS class to the node representing given note in the&nbsp;<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.
given note in the&nbsp;<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>
This can be useful for advanced theming. Can be used in template notes.</td> </tr>
</tr> <tr>
<tr> <td><code>iconClass</code>
<td><code>iconClass</code> </td>
</td> <td>value of this label is added as a CSS class to the icon on the tree which
<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
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>
bx-home - icons are taken from boxicons. Can be used in template notes.</td> </tr>
</tr> <tr>
<tr> <td><code>pageSize</code>
<td><code>pageSize</code> </td>
</td> <td>Specifies the number of items per page in&nbsp;<a class="reference-link"
<td>Specifies the number of items per page in&nbsp;<a class="reference-link" href="#root/_help_0ESUbbAxVnoK">Note List</a>.</td>
href="#root/_help_0ESUbbAxVnoK">Note List</a>.</td> </tr>
</tr> <tr>
<tr> <td><code>customRequestHandler</code>
<td><code>customRequestHandler</code> </td>
</td> <td>See&nbsp;<a class="reference-link" href="#root/_help_J5Ex1ZrMbyJ6">Custom Request Handler</a>.</td>
<td>See&nbsp;<a class="reference-link" href="#root/_help_J5Ex1ZrMbyJ6">Custom Request Handler</a>.</td> </tr>
</tr> <tr>
<tr> <td><code>customResourceProvider</code>
<td><code>customResourceProvider</code> </td>
</td> <td>See&nbsp;<a class="reference-link" href="#root/_help_d3fAXQ2diepH">Custom Resource Providers</a>.</td>
<td>See&nbsp;<a class="reference-link" href="#root/_help_d3fAXQ2diepH">Custom Resource Providers</a>.</td> </tr>
</tr> <tr>
<tr> <td><code>widget</code>
<td><code>widget</code> </td>
</td> <td>Marks this note as a custom widget which will be added to the Trilium
<td>Marks this note as a custom widget which will be added to the Trilium component tree. See&nbsp;<a class="reference-link" href="#root/_help_MgibgPcfeuGz">Custom Widgets</a>&nbsp;for
component tree. See&nbsp;<a class="reference-link" href="#root/_help_MgibgPcfeuGz">Custom Widgets</a>&nbsp;for more information.</td>
more information.</td> </tr>
</tr> <tr>
<tr> <td><code>searchHome</code>
<td><code>searchHome</code> </td>
</td> <td>New search notes will be created as children of this note (see&nbsp;
<td>New search notes will be created as children of this note (see&nbsp; <a
<a class="reference-link" href="#root/_help_m523cpzocqaD">Saved Search</a>).</td>
class="reference-link" href="#root/_help_m523cpzocqaD">Saved Search</a>).</td> </tr>
</tr> <tr>
<tr> <td><code>workspace</code> and related attributes</td>
<td><code>workspace</code> and related attributes</td> <td>See&nbsp;<a class="reference-link" href="#root/_help_9sRHySam5fXb">Workspaces</a>.</td>
<td>See&nbsp;<a class="reference-link" href="#root/_help_9sRHySam5fXb">Workspaces</a>.</td> </tr>
</tr> <tr>
<tr> <td><code>inbox</code>
<td><code>inbox</code> </td>
</td> <td>default inbox location for new notes - when you create a note using <em>new note</em> button
<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
in the sidebar, notes will be created as child notes in the note marked as with <code>#inbox</code> label.</td>
as with <code>#inbox</code> label.</td> </tr>
</tr> <tr>
<tr> <td><code>sqlConsoleHome</code>
<td><code>sqlConsoleHome</code> </td>
</td> <td>Default location of&nbsp;<a class="reference-link" href="#root/_hidden/_help/_help_tC7s2alapj8V/_help_wX4HbRucYSDD/_help_oyIAJ9PvvwHX/_help__help_YKWqdJhzi2VY">SQL Console</a>&nbsp;notes</td>
<td>Default location of&nbsp;<a class="reference-link" href="#root/_hidden/_help/_help_tC7s2alapj8V/_help_wX4HbRucYSDD/_help_oyIAJ9PvvwHX/_help__help_YKWqdJhzi2VY">SQL Console</a>&nbsp;notes</td> </tr>
</tr> <tr>
<tr> <td><code>bookmarked</code>
<td><code>bookmarked</code> </td>
</td> <td>Indicates this note is a <a href="#root/_help_u3YFHC9tQlpm">bookmark</a>.</td>
<td>Indicates this note is a <a href="#root/_help_u3YFHC9tQlpm">bookmark</a>.</td> </tr>
</tr> <tr>
<tr> <td><code>bookmarkFolder</code>
<td><code>bookmarkFolder</code> </td>
</td> <td>Note with this label will appear in bookmarks as folder (allowing access
<td>Note with this label will appear in bookmarks as folder (allowing access to its children). See&nbsp;<a class="reference-link" href="#root/_help_u3YFHC9tQlpm">Bookmarks</a>&nbsp;for
to its children). See&nbsp;<a class="reference-link" href="#root/_help_u3YFHC9tQlpm">Bookmarks</a>&nbsp;for more information.</td>
more information.</td> </tr>
</tr> <tr>
<tr> <td><code>share*</code>
<td><code>share*</code> </td>
</td> <td>See the attribute reference in&nbsp;<a class="reference-link" href="#root/_help_R9pX4DGra2Vt">Sharing</a>.</td>
<td>See the attribute reference in&nbsp;<a class="reference-link" href="#root/_help_R9pX4DGra2Vt">Sharing</a>.</td> </tr>
</tr> <tr>
<tr> <td><code>displayRelations</code>, <code>hideRelations</code>
<td><code>displayRelations</code>, <code>hideRelations</code> </td>
</td> <td>Comma delimited names of relations which should be displayed/hidden in
<td>Comma delimited names of relations which should be displayed/hidden in a&nbsp;<a class="reference-link" href="#root/_help_iRwzGnHPzonm">Relation Map</a>&nbsp;(both
a&nbsp;<a class="reference-link" href="#root/_help_iRwzGnHPzonm">Relation Map</a>&nbsp;(both the note type and the&nbsp;<a class="reference-link" href="#root/_help_BCkXAVs63Ttv">Note Map (Link map, Tree map)</a>&nbsp;general
the note type and the&nbsp;<a class="reference-link" href="#root/_help_BCkXAVs63Ttv">Note Map (Link map, Tree map)</a>&nbsp;general functionality).</td>
functionality).</td> </tr>
</tr> <tr>
<tr> <td><code>titleTemplate</code>
<td><code>titleTemplate</code> </td>
</td> <td>
<td> <p>Default title of notes created as children of this note. This value is
<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
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>
content via the injected <code>now</code> and <code>parentNote</code> variables.</p> <p>Examples:</p>
<p>Examples:</p> <ul>
<ul> <li><code><span class="math-tex">\({parentNote.getLabel('authorName')}'s literary works</span></code>
<li><code><span class="math-tex">\({parentNote.getLabel('authorName')}'s literary works</span></code> </li>
</li> <li><code>Log for \){now.format('YYYY-MM-DD HH:mm:ss')}</code>
<li><code>Log for \){now.format('YYYY-MM-DD HH:mm:ss')}</code> </li>
</li> <li>to mirror the parent's template.</li>
<li>to mirror the parent's template.</li> </ul>
</ul> <p>See&nbsp;<a class="reference-link" href="#root/_help_47ZrP6FNuoG8">Default Note Title</a>&nbsp;for
<p>See&nbsp;<a class="reference-link" href="#root/_help_47ZrP6FNuoG8">Default Note Title</a>&nbsp;for more info.</p>
more info.</p> </td>
</td> </tr>
</tr> <tr>
<tr> <td><code>template</code>
<td><code>template</code> </td>
</td> <td>This note will appear in the selection of available template when creating
<td>This note will appear in the selection of available template when creating new note. See&nbsp;<a class="reference-link" href="#root/_help_KC1HB96bqqHX">Templates</a>&nbsp;for
new note. See&nbsp;<a class="reference-link" href="#root/_help_KC1HB96bqqHX">Templates</a>&nbsp;for more information.</td>
more information.</td> </tr>
</tr> <tr>
<tr> <td><code>toc</code>
<td><code>toc</code> </td>
</td> <td>Controls the display of the&nbsp;<a class="reference-link" href="#root/_help_BFvAtE74rbP6">Table of contents</a>&nbsp;for
<td>Controls the display of the&nbsp;<a class="reference-link" href="#root/_help_BFvAtE74rbP6">Table of contents</a>&nbsp;for a given note. <code>#toc</code> or <code>#toc=show</code> to always display
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>
the table of contents, <code>#toc=false</code> to always hide it.</td> </tr>
</tr> <tr>
<tr> <td><code>color</code>
<td><code>color</code> </td>
</td> <td>defines color of the note in note tree, links etc. Use any valid CSS color
<td>defines color of the note in note tree, links etc. Use any valid CSS color value like 'red' or #a13d5f</td>
value like 'red' or #a13d5f</td> </tr>
</tr> <tr>
<tr> <td><code>keyboardShortcut</code>
<td><code>keyboardShortcut</code> </td>
</td> <td>Defines a keyboard shortcut which will immediately jump to this note.
<td>Defines a keyboard shortcut which will immediately jump to this note. Example: 'ctrl+alt+e'. Requires frontend reload for the change to take
Example: 'ctrl+alt+e'. Requires frontend reload for the change to take effect.</td>
effect.</td> </tr>
</tr> <tr>
<tr> <td><code>keepCurrentHoisting</code>
<td><code>keepCurrentHoisting</code> </td>
</td> <td>Opening this link won't change hoisting even if the note is not displayable
<td>Opening this link won't change hoisting even if the note is not displayable in the current hoisted subtree.</td>
in the current hoisted subtree.</td> </tr>
</tr> <tr>
<tr> <td><code>executeButton</code>
<td><code>executeButton</code> </td>
</td> <td>Title of the button which will execute the current code note</td>
<td>Title of the button which will execute the current code note</td> </tr>
</tr> <tr>
<tr> <td><code>executeDescription</code>
<td><code>executeDescription</code> </td>
</td> <td>Longer description of the current code note displayed together with the
<td>Longer description of the current code note displayed together with the execute button</td>
execute button</td> </tr>
</tr> <tr>
<tr> <td><code>excludeFromNoteMap</code>
<td><code>excludeFromNoteMap</code> </td>
</td> <td>Notes with this label will be hidden from the&nbsp;<a class="reference-link"
<td>Notes with this label will be hidden from the&nbsp;<a class="reference-link" href="#root/_help_bdUJEHsAPYQR">Note Map</a>.</td>
href="#root/_help_bdUJEHsAPYQR">Note Map</a>.</td> </tr>
</tr> <tr>
<tr> <td><code>newNotesOnTop</code>
<td><code>newNotesOnTop</code> </td>
</td> <td>New notes will be created at the top of the parent note, not on the bottom.</td>
<td>New notes will be created at the top of the parent note, not on the bottom.</td> </tr>
</tr> <tr>
<tr> <td><code>hideHighlightWidget</code>
<td><code>hideHighlightWidget</code> </td>
</td> <td>Hides the&nbsp;<a class="reference-link" href="#root/_help_AxshuNRegLAv">Highlights list</a>&nbsp;widget</td>
<td>Hides the&nbsp;<a class="reference-link" href="#root/_help_AxshuNRegLAv">Highlights list</a>&nbsp;widget</td> </tr>
</tr> <tr>
<tr> <td><code>hideChildrenOverview</code>
<td><code>hideChildrenOverview</code> </td>
</td> <td>Hides the&nbsp;<a class="reference-link" href="#root/_help_0ESUbbAxVnoK">Note List</a>&nbsp;for
<td>Hides the&nbsp;<a class="reference-link" href="#root/_help_0ESUbbAxVnoK">Note List</a>&nbsp;for that particular note.</td>
that particular note.</td> </tr>
</tr> <tr>
<tr> <td><code>printLandscape</code>
<td><code>printLandscape</code> </td>
</td> <td>When exporting to PDF, changes the orientation of the page to landscape
<td>When exporting to PDF, changes the orientation of the page to landscape instead of portrait.</td>
instead of portrait.</td> </tr>
</tr> <tr>
<tr> <td><code>printPageSize</code>
<td><code>printPageSize</code> </td>
</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>
<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> <tr>
<tr> <td><code>geolocation</code>
<td><code>geolocation</code> </td>
</td> <td>Indicates the latitude and longitude of a note, to be displayed in a&nbsp;
<td>Indicates the latitude and longitude of a note, to be displayed in a&nbsp; <a
<a class="reference-link" href="#root/_help_81SGnPGMk7Xc">Geo Map</a>.</td>
class="reference-link" href="#root/_help_81SGnPGMk7Xc">Geo Map</a>.</td> </tr>
</tr> <tr>
<tr> <td><code>calendar:*</code>
<td><code>calendar:*</code> </td>
</td> <td>Defines specific options for the&nbsp;<a class="reference-link" href="#root/_help_xWbu3jpNWapp">Calendar View</a>.</td>
<td>Defines specific options for the&nbsp;<a class="reference-link" href="#root/_help_xWbu3jpNWapp">Calendar View</a>.</td> </tr>
</tr> <tr>
<tr> <td><code>viewType</code>
<td><code>viewType</code> </td>
</td> <td>Sets the view of child notes (e.g. grid or list). See&nbsp;<a class="reference-link"
<td>Sets the view of child notes (e.g. grid or list). See&nbsp;<a class="reference-link" href="#root/_help_0ESUbbAxVnoK">Note List</a>&nbsp;for more information.</td>
href="#root/_help_0ESUbbAxVnoK">Note List</a>&nbsp;for more information.</td> </tr>
</tr> </tbody>
</tbody> </table>
</table>
</figure>

View File

@@ -61,79 +61,73 @@ class="admonition tip">
there are multiple relations with the same prefix, consult the specific there are multiple relations with the same prefix, consult the specific
page linked in the description of that relation for more information.</p> page linked in the description of that relation for more information.</p>
</aside> </aside>
<figure class="table" style="width:100%;"> <table>
<table class="ck-table-resized"> <thead>
<colgroup> <tr>
<col style="width:33.95%;"> <th>Label</th>
<col style="width:66.05%;"> <th>Description</th>
</colgroup> </tr>
<thead> </thead>
<tr> <tbody>
<th>Label</th> <tr>
<th>Description</th> <td><code>runOn*</code>
</tr> </td>
</thead> <td>See&nbsp;<a class="reference-link" href="#root/_help_GPERMystNGTB">Events</a>
<tbody> </td>
<tr> </tr>
<td><code>runOn*</code> <tr>
</td> <td><code>template</code>
<td>See&nbsp;<a class="reference-link" href="#root/_help_GPERMystNGTB">Events</a> </td>
</td> <td>note's attributes will be inherited even without a parent-child relationship,
</tr> note's content and subtree will be added to instance notes if empty. See
<tr> documentation for details.</td>
<td><code>template</code> </tr>
</td> <tr>
<td>note's attributes will be inherited even without a parent-child relationship, <td><code>inherit</code>
note's content and subtree will be added to instance notes if empty. See </td>
documentation for details.</td> <td>note's attributes will be inherited even without a parent-child relationship.
</tr> See&nbsp;<a class="reference-link" href="#root/_help_KC1HB96bqqHX">Templates</a>&nbsp;for
<tr> a similar concept. See&nbsp;<a class="reference-link" href="#root/_help_bwZpz2ajCEwO">Attribute Inheritance</a>&nbsp;in
<td><code>inherit</code> the documentation.</td>
</td> </tr>
<td>note's attributes will be inherited even without a parent-child relationship. <tr>
See&nbsp;<a class="reference-link" href="#root/_help_KC1HB96bqqHX">Templates</a>&nbsp;for <td><code>renderNote</code>
a similar concept. See&nbsp;<a class="reference-link" href="#root/_help_bwZpz2ajCEwO">Attribute Inheritance</a>&nbsp;in </td>
the documentation.</td> <td>notes of type&nbsp;<a class="reference-link" href="#root/_help_HcABDtFCkbFN">Render Note</a>&nbsp;will
</tr> be rendered using a code note (HTML or script) and it is necessary to point
<tr> using this relation to which note should be rendered</td>
<td><code>renderNote</code> </tr>
</td> <tr>
<td>notes of type&nbsp;<a class="reference-link" href="#root/_help_HcABDtFCkbFN">Render Note</a>&nbsp;will <td><code>widget_relation</code>
be rendered using a code note (HTML or script) and it is necessary to point </td>
using this relation to which note should be rendered</td> <td>target of this relation will be executed and rendered as a widget in the
</tr> sidebar</td>
<tr> </tr>
<td><code>widget_relation</code> <tr>
</td> <td><code>shareCss</code>
<td>target of this relation will be executed and rendered as a widget in the </td>
sidebar</td> <td>CSS note which will be injected into the share page. CSS note must be
</tr> in the shared sub-tree as well. Consider using <code>share_hidden_from_tree</code> and <code>share_omit_default_css</code> as
<tr> well.</td>
<td><code>shareCss</code> </tr>
</td> <tr>
<td>CSS note which will be injected into the share page. CSS note must be <td><code>shareJs</code>
in the shared sub-tree as well. Consider using <code>share_hidden_from_tree</code> and <code>share_omit_default_css</code> as </td>
well.</td> <td>JavaScript note which will be injected into the share page. JS note must
</tr> be in the shared sub-tree as well. Consider using <code>share_hidden_from_tree</code>.</td>
<tr> </tr>
<td><code>shareJs</code> <tr>
</td> <td><code>shareTemplate</code>
<td>JavaScript note which will be injected into the share page. JS note must </td>
be in the shared sub-tree as well. Consider using <code>share_hidden_from_tree</code>.</td> <td>Embedded JavaScript note that will be used as the template for displaying
</tr> the shared note. Falls back to the default template. Consider using <code>share_hidden_from_tree</code>.</td>
<tr> </tr>
<td><code>shareTemplate</code> <tr>
</td> <td><code>shareFavicon</code>
<td>Embedded JavaScript note that will be used as the template for displaying </td>
the shared note. Falls back to the default template. Consider using <code>share_hidden_from_tree</code>.</td> <td>Favicon note to be set in the shared page. Typically you want to set it
</tr> to share root and make it inheritable. Favicon note must be in the shared
<tr> sub-tree as well. Consider using <code>share_hidden_from_tree</code>.</td>
<td><code>shareFavicon</code> </tr>
</td> </tbody>
<td>Favicon note to be set in the shared page. Typically you want to set it </table>
to share root and make it inheritable. Favicon note must be in the shared
sub-tree as well. Consider using <code>share_hidden_from_tree</code>.</td>
</tr>
</tbody>
</table>
</figure>

View File

@@ -3,44 +3,39 @@
<p>However, it is possible to manually configure <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/CORS">Cross-Origin Resource Sharing (CORS)</a> since <p>However, it is possible to manually configure <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/CORS">Cross-Origin Resource Sharing (CORS)</a> since
Trilium v0.93.0 using environment variables or <code>config.ini</code>, Trilium v0.93.0 using environment variables or <code>config.ini</code>,
as follows:</p> as follows:</p>
<figure class="table" style="width:100%;"> <table>
<table class="ck-table-resized"> <thead>
<colgroup> <tr>
<col style="width:26.93%;"> <th>CORS Header</th>
<col style="width:32.46%;"> <th>Corresponding option in <code>config.ini</code>
<col style="width:40.61%;"> </th>
</colgroup> <th>Corresponding option in environment variables in the <code>Network</code> section</th>
<thead> </tr>
<tr> </thead>
<th>CORS Header</th> <tbody>
<th>Corresponding option in <code>config.ini</code> <tr>
</th> <td><code>Access-Control-Allow-Origin</code>
<th>Corresponding option in environment variables in the <code>Network</code> section</th> </td>
</tr> <td><code>TRILIUM_NETWORK_CORS_ALLOW_ORIGIN</code>
</thead> </td>
<tbody> <td><code>corsAllowOrigin</code>
<tr> </td>
<td><code>Access-Control-Allow-Origin</code> </tr>
</td> <tr>
<td><code>TRILIUM_NETWORK_CORS_ALLOW_ORIGIN</code> <td><code>Access-Control-Allow-Methods</code>
</td> </td>
<td><code>corsAllowOrigin</code>&nbsp;</td> <td><code>TRILIUM_NETWORK_CORS_ALLOW_METHODS</code>
</tr> </td>
<tr> <td><code>corsAllowMethods</code>
<td><code>Access-Control-Allow-Methods</code> </td>
</td> </tr>
<td><code>TRILIUM_NETWORK_CORS_ALLOW_METHODS</code> <tr>
</td> <td><code>Access-Control-Allow-Headers</code>
<td><code>corsAllowMethods</code>&nbsp;</td> </td>
</tr> <td><code>TRILIUM_NETWORK_CORS_ALLOW_HEADERS</code>
<tr> </td>
<td><code>Access-Control-Allow-Headers</code> <td><code>corsAllowHeaders</code>
</td> </td>
<td><code>TRILIUM_NETWORK_CORS_ALLOW_HEADERS</code> </tr>
</td> </tbody>
<td><code>corsAllowHeaders</code> </table>
</td>
</tr>
</tbody>
</table>
</figure>

View File

@@ -22,161 +22,159 @@
select <em>Advanced</em><em>Show Hidden Subtree</em>.</p> select <em>Advanced</em><em>Show Hidden Subtree</em>.</p>
<h2>Contents of the hidden note tree</h2> <h2>Contents of the hidden note tree</h2>
<p>Here is a brief summary of all the notes within the hidden tree:</p> <p>Here is a brief summary of all the notes within the hidden tree:</p>
<figure <table
class="table" style="width:100%;"> class="ck-table-resized">
<table class="ck-table-resized"> <colgroup>
<colgroup> <col style="width:19.93%;">
<col style="width:19.93%;"> <col style="width:80.07%;">
<col style="width:80.07%;"> </colgroup>
</colgroup> <thead>
<thead> <tr>
<tr> <th>Note</th>
<th>Note</th> <th>Description</th>
<th>Description</th> </tr>
</tr> </thead>
</thead> <tbody>
<tbody> <tr>
<tr> <td><a class="reference-link" href="#root/_hidden/_help__globalNoteMap">Note Map</a>
<td><a class="reference-link" href="#root/_hidden/_help__globalNoteMap">Note Map</a> </td>
</td> <td>
<td> <p>This note is actually opened when the&nbsp;<a class="reference-link" href="#root/_help_bdUJEHsAPYQR">Note Map</a>&nbsp;feature
<p>This note is actually opened when the&nbsp;<a class="reference-link" href="#root/_help_bdUJEHsAPYQR">Note Map</a>&nbsp;feature that is accessed from the&nbsp;<a class="reference-link" href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>.</p>
that is accessed from the&nbsp;<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
<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
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>
can be linked to from other notes or <a href="#root/_help_u3YFHC9tQlpm">bookmarked</a>.</p> </td>
</td> </tr>
</tr> <tr>
<tr> <td><a class="reference-link" href="#root/_hidden/_help__sqlConsole">SQL Console History</a>
<td><a class="reference-link" href="#root/_hidden/_help__sqlConsole">SQL Console History</a> </td>
</td> <td>
<td> <p>When SQL queries or commands are executed in the&nbsp;<a class="reference-link"
<p>When SQL queries or commands are executed in the&nbsp;<a class="reference-link" href="#root/_help_YKWqdJhzi2VY">SQL Console</a>, they are stored here,
href="#root/_help_YKWqdJhzi2VY">SQL Console</a>, they are stored here, grouped by month. Only the query is stored and not the results.</p>
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
<p>This section can be accessed without going to the hidden tree by simply going to the&nbsp;<a class="reference-link" href="#root/_help_x3i7MxGccDuM">Global menu</a>&nbsp;and
going to the&nbsp;<a class="reference-link" href="#root/_help_x3i7MxGccDuM">Global menu</a>&nbsp;and selecting Advanced → Open SQL Console History.</p>
selecting Advanced → Open SQL Console History.</p> <p>Notes can be added as children of this tree, but it's generally not recommended
<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>
to do so to not interfere with the normal history process.</p> </td>
</td> </tr>
</tr> <tr>
<tr> <td><a class="reference-link" href="#root/_hidden/_help__search">Search History</a>
<td><a class="reference-link" href="#root/_hidden/_help__search">Search History</a> </td>
</td> <td>
<td> <p>Whenever a search is executed from the full&nbsp;<a class="reference-link"
<p>Whenever a search is executed from the full&nbsp;<a class="reference-link" href="#root/_help_eIg8jdvaoNNd">Search</a>, the query will be stored here,
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
grouped by month. Only the search parameters are stored and not the results themselves.</p>
themselves.</p> <p>This section can be accessed without going to the hidden tree by simply
<p>This section can be accessed without going to the hidden tree by simply going to the&nbsp;<a class="reference-link" href="#root/_help_x3i7MxGccDuM">Global menu</a>&nbsp;and
going to the&nbsp;<a class="reference-link" href="#root/_help_x3i7MxGccDuM">Global menu</a>&nbsp;and selecting Advanced → Open Search History.</p>
selecting Advanced → Open Search History.</p> <p>Notes can be added as children of this tree, but it's generally not recommended
<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>
to do so to not interfere with the normal history process.</p> </td>
</td> </tr>
</tr> <tr>
<tr> <td><a class="reference-link" href="#root/_hidden/_help__bulkAction">Bulk Action</a>
<td><a class="reference-link" href="#root/_hidden/_help__bulkAction">Bulk Action</a> </td>
</td> <td>
<td> <p>This section is used for&nbsp;<a class="reference-link" href="#root/_help_ivYnonVFBxbQ">Bulk Actions</a>.
<p>This section is used for&nbsp;<a class="reference-link" href="#root/_help_ivYnonVFBxbQ">Bulk Actions</a>. The last configuration for bulk actions will be stored as part of this
The last configuration for bulk actions will be stored as part of this note, each action in its own <code>action</code> label.</p>
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
<p>Notes can be added as children of this tree, but there won't be any benefit in doing so.</p>
in doing so.</p> </td>
</td> </tr>
</tr> <tr>
<tr> <td><a class="reference-link" href="#root/_hidden/_help__backendLog">Backend Log</a>
<td><a class="reference-link" href="#root/_hidden/_help__backendLog">Backend Log</a> </td>
</td> <td>
<td> <p>This note corresponds to the backend log feature (see&nbsp;<a class="reference-link"
<p>This note corresponds to the backend log feature (see&nbsp;<a class="reference-link" href="#root/_help_qzNzp9LYQyPT">Error logs</a>).</p>
href="#root/_help_qzNzp9LYQyPT">Error logs</a>).</p> <p>This item can be accessed without going to the hidden try by going to
<p>This item can be accessed without going to the hidden try by going to the&nbsp;<a class="reference-link" href="#root/_help_x3i7MxGccDuM">Global menu</a>&nbsp;and
the&nbsp;<a class="reference-link" href="#root/_help_x3i7MxGccDuM">Global menu</a>&nbsp;and selecting Advanced → Show backend log.</p>
selecting Advanced → Show backend log.</p> </td>
</td> </tr>
</tr> <tr>
<tr> <td><a class="reference-link" href="#root/_hidden/_help__userHidden">User Hidden</a>
<td><a class="reference-link" href="#root/_hidden/_help__userHidden">User Hidden</a> </td>
</td> <td>This section can be used by <a href="#root/_help_CdNpE2pqjmI6">scripts</a> to
<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.
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>
The note can be identified by scripts by its unique ID: <code>_userHidden</code> </td>
</td> </tr>
</tr> <tr>
<tr> <td><a class="reference-link" href="#root/_hidden/_help__lbTplRoot">Launch Bar Templates</a>
<td><a class="reference-link" href="#root/_hidden/_help__lbTplRoot">Launch Bar Templates</a> </td>
</td> <td>
<td> <p>This section contains the templates for the creation of launchers in the&nbsp;
<p>This section contains the templates for the creation of launchers in the&nbsp; <a
<a class="reference-link" href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>. It is not possible to create child notes here.</p>
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
<p>Theoretically some of the notes here can be customized, but there's not much benefit to be had in doing so.</p>
much benefit to be had in doing so.</p> </td>
</td> </tr>
</tr> <tr>
<tr> <td><a class="reference-link" href="#root/_hidden/_help__share">Shared Notes</a>
<td><a class="reference-link" href="#root/_hidden/_help__share">Shared Notes</a> </td>
</td> <td>
<td> <p>This tree lists all of the notes that are <a href="#root/_help_R9pX4DGra2Vt">shared</a> publicly.
<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
It can be useful to track down which notes are shared regardless of their position in the note tree.</p>
position in the note tree.</p> <p>This section can be accessed without going to the hidden tree simply by
<p>This section can be accessed without going to the hidden tree simply by going to the&nbsp;<a class="reference-link" href="#root/_help_x3i7MxGccDuM">Global menu</a>&nbsp;and
going to the&nbsp;<a class="reference-link" href="#root/_help_x3i7MxGccDuM">Global menu</a>&nbsp;and selecting <em>Show Shared Notes Subtree</em>.</p>
selecting <em>Show Shared Notes Subtree</em>.</p> <p>Sub-notes cannot be created here.</p>
<p>Sub-notes cannot be created here.</p> </td>
</td> </tr>
</tr> <tr>
<tr> <td><a class="reference-link" href="#root/_hidden/_help__lbRoot">Launch Bar</a>
<td><a class="reference-link" href="#root/_hidden/_help__lbRoot">Launch Bar</a> </td>
</td> <td>
<td> <p>The tree contains both available and displayed items of the&nbsp;<a class="reference-link"
<p>The tree contains both available and displayed items of the&nbsp;<a class="reference-link" href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>.</p>
href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>.</p> <p>This section can be accessed without going to the hidden tree by:</p>
<p>This section can be accessed without going to the hidden tree by:</p> <ul>
<ul> <li>Going to the&nbsp;<a class="reference-link" href="#root/_help_x3i7MxGccDuM">Global menu</a>&nbsp;and
<li>Going to the&nbsp;<a class="reference-link" href="#root/_help_x3i7MxGccDuM">Global menu</a>&nbsp;and selecting <em>Configure Launchbar</em>.</li>
selecting <em>Configure Launchbar</em>.</li> <li>Right-clicking an empty space on the&nbsp;<a class="reference-link" href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>&nbsp;and
<li>Right-clicking an empty space on the&nbsp;<a class="reference-link" href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>&nbsp;and selecting <em>Configure Launchbar</em>.</li>
selecting <em>Configure Launchbar</em>.</li> </ul>
</ul> <p>Sub-notes cannot be created here.</p>
<p>Sub-notes cannot be created here.</p> </td>
</td> </tr>
</tr> <tr>
<tr> <td><a class="reference-link" href="#root/_hidden/_help__options">Options</a>
<td><a class="reference-link" href="#root/_hidden/_help__options">Options</a> </td>
</td> <td>
<td> <p>This section stores the list of&nbsp;<a class="reference-link" href="#root/_help_4TIF1oA4VQRO">Options</a>.</p>
<p>This section stores the list of&nbsp;<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>
<p>This section can be accessed without going to the hidden tree by:</p> <ul>
<ul> <li>Going to the&nbsp;<a class="reference-link" href="#root/_help_x3i7MxGccDuM">Global menu</a>&nbsp;and
<li>Going to the&nbsp;<a class="reference-link" href="#root/_help_x3i7MxGccDuM">Global menu</a>&nbsp;and selecting <em>Options</em>.</li>
selecting <em>Options</em>.</li> <li>Pressing the dedicated Options icon in the&nbsp;<a class="reference-link"
<li>Pressing the dedicated Options icon in the&nbsp;<a class="reference-link" href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>.</li>
href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>.</li> </ul>
</ul> </td>
</td> </tr>
</tr> <tr>
<tr> <td><a class="reference-link" href="#root/_hidden/_help__lbMobileRoot">Mobile Launch Bar</a>
<td><a class="reference-link" href="#root/_hidden/_help__lbMobileRoot">Mobile Launch Bar</a> </td>
</td> <td>
<td> <p>This is very similar to the <em>Launch Bar</em>, but is dedicated for the
<p>This is very similar to the <em>Launch Bar</em>, but is dedicated for the mobile UI only.</p>
mobile UI only.</p> <p>Accessing it outside the <em>Launch Bar</em> is the same as the Launch Bar,
<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>
but needs to be done so from the mobile interface.</p> </td>
</td> </tr>
</tr> <tr>
<tr> <td><a class="reference-link" href="#root/_hidden/_help__help">User Guide</a>
<td><a class="reference-link" href="#root/_hidden/_help__help">User Guide</a> </td>
</td> <td>This is where the note structure for the User Guide is actually stored.
<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
Only the metadata is stored, as the help itself is present as actual files in the application directory.</td>
in the application directory.</td> </tr>
</tr> </tbody>
</tbody> </table>
</table>
</figure>

View File

@@ -19,154 +19,152 @@ class="image">
<li>Displaying the date of the last update of the note.</li> <li>Displaying the date of the last update of the note.</li>
</ul> </ul>
<h3>By note type</h3> <h3>By note type</h3>
<figure class="table" style="width:100%;"> <table class="ck-table-resized">
<table class="ck-table-resized"> <colgroup>
<colgroup> <col style="width:19.92%;">
<col style="width:19.92%;"> <col style="width:41.66%;">
<col style="width:41.66%;"> <col style="width:38.42%;">
<col style="width:38.42%;"> </colgroup>
</colgroup> <thead>
<thead> <tr>
<tr> <th>&nbsp;</th>
<th>&nbsp;</th> <th>Supported features</th>
<th>Supported features</th> <th>Limitations</th>
<th>Limitations</th> </tr>
</tr> </thead>
</thead> <tbody>
<tbody> <tr>
<tr> <th><a class="reference-link" href="#root/_help_iPIMuisry3hd">Text</a>
<th><a class="reference-link" href="#root/_help_iPIMuisry3hd">Text</a> </th>
</th> <td>
<td> <ul>
<ul> <li>Table of contents.</li>
<li>Table of contents.</li> <li>Syntax highlight of code blocks, provided a language is selected (does
<li>Syntax highlight of code blocks, provided a language is selected (does not work if “Auto-detected” is enabled).</li>
not work if “Auto-detected” is enabled).</li> <li>Rendering for math equations.</li>
<li>Rendering for math equations.</li> </ul>
</ul> </td>
</td> <td>
<td> <ul>
<ul> <li>Including notes is not supported.</li>
<li>Including notes is not supported.</li> <li>Inline Mermaid diagrams are not rendered.</li>
<li>Inline Mermaid diagrams are not rendered.</li> </ul>
</ul> </td>
</td> </tr>
</tr> <tr>
<tr> <th><a class="reference-link" href="#root/_help_6f9hih2hXXZk">Code</a>
<th><a class="reference-link" href="#root/_help_6f9hih2hXXZk">Code</a> </th>
</th> <td>
<td> <ul>
<ul> <li>Basic support (displaying the contents of the note in a monospace font).</li>
<li>Basic support (displaying the contents of the note in a monospace font).</li> </ul>
</ul> </td>
</td> <td>
<td> <ul>
<ul> <li>No syntax highlight.</li>
<li>No syntax highlight.</li> </ul>
</ul> </td>
</td> </tr>
</tr> <tr>
<tr> <th><a class="reference-link" href="#root/_help_m523cpzocqaD">Saved Search</a>
<th><a class="reference-link" href="#root/_help_m523cpzocqaD">Saved Search</a> </th>
</th> <td>Not supported.</td>
<td>Not supported.</td> <td>&nbsp;</td>
<td>&nbsp;</td> </tr>
</tr> <tr>
<tr> <th><a class="reference-link" href="#root/_help_iRwzGnHPzonm">Relation Map</a>
<th><a class="reference-link" href="#root/_help_iRwzGnHPzonm">Relation Map</a> </th>
</th> <td>Not supported.</td>
<td>Not supported.</td> <td>&nbsp;</td>
<td>&nbsp;</td> </tr>
</tr> <tr>
<tr> <th><a class="reference-link" href="#root/_help_bdUJEHsAPYQR">Note Map</a>
<th><a class="reference-link" href="#root/_help_bdUJEHsAPYQR">Note Map</a> </th>
</th> <td>Not supported.</td>
<td>Not supported.</td> <td>&nbsp;</td>
<td>&nbsp;</td> </tr>
</tr> <tr>
<tr> <th><a class="reference-link" href="#root/_help_HcABDtFCkbFN">Render Note</a>
<th><a class="reference-link" href="#root/_help_HcABDtFCkbFN">Render Note</a> </th>
</th> <td>Not supported.</td>
<td>Not supported.</td> <td>&nbsp;</td>
<td>&nbsp;</td> </tr>
</tr> <tr>
<tr> <th><a class="reference-link" href="#root/_help_GTwFsgaA0lCt">Collections</a>
<th><a class="reference-link" href="#root/_help_GTwFsgaA0lCt">Collections</a> </th>
</th> <td>
<td> <ul>
<ul> <li>The child notes are displayed in a fixed format.&nbsp;</li>
<li>The child notes are displayed in a fixed format.&nbsp;</li> </ul>
</ul> </td>
</td> <td>
<td> <ul>
<ul> <li>More advanced view types such as the calendar view are not supported.</li>
<li>More advanced view types such as the calendar view are not supported.</li> </ul>
</ul> </td>
</td> </tr>
</tr> <tr>
<tr> <th><a class="reference-link" href="#root/_help_s1aBHPd79XYj">Mermaid Diagrams</a>
<th><a class="reference-link" href="#root/_help_s1aBHPd79XYj">Mermaid Diagrams</a> </th>
</th> <td>
<td> <ul>
<ul> <li>The diagram is displayed as a vector image.</li>
<li>The diagram is displayed as a vector image.</li> </ul>
</ul> </td>
</td> <td>
<td> <ul>
<ul> <li>No further interaction supported.</li>
<li>No further interaction supported.</li> </ul>
</ul> </td>
</td> </tr>
</tr> <tr>
<tr> <th><a class="reference-link" href="#root/_help_grjYqerjn243">Canvas</a>
<th><a class="reference-link" href="#root/_help_grjYqerjn243">Canvas</a> </th>
</th> <td>
<td> <ul>
<ul> <li>The diagram is displayed as a vector image.</li>
<li>The diagram is displayed as a vector image.</li> </ul>
</ul> </td>
</td> <td>
<td> <ul>
<ul> <li>No further interaction supported.</li>
<li>No further interaction supported.</li> </ul>
</ul> </td>
</td> </tr>
</tr> <tr>
<tr> <th><a class="reference-link" href="#root/_help_1vHRoWCEjj0L">Web View</a>
<th><a class="reference-link" href="#root/_help_1vHRoWCEjj0L">Web View</a> </th>
</th> <td>Not supported.</td>
<td>Not supported.</td> <td>&nbsp;</td>
<td>&nbsp;</td> </tr>
</tr> <tr>
<tr> <th><a class="reference-link" href="#root/_help_gBbsAeiuUxI5">Mind Map</a>
<th><a class="reference-link" href="#root/_help_gBbsAeiuUxI5">Mind Map</a> </th>
</th> <td>The diagram is displayed as a vector image.</td>
<td>The diagram is displayed as a vector image.</td> <td>
<td> <ul>
<ul> <li>No further interaction supported.</li>
<li>No further interaction supported.</li> </ul>
</ul> </td>
</td> </tr>
</tr> <tr>
<tr> <th><a class="reference-link" href="#root/_help_81SGnPGMk7Xc">Geo Map View</a>
<th><a class="reference-link" href="#root/_help_81SGnPGMk7Xc">Geo Map View</a> </th>
</th> <td>Not supported.</td>
<td>Not supported.</td> <td>&nbsp;</td>
<td>&nbsp;</td> </tr>
</tr> <tr>
<tr> <th><a class="reference-link" href="#root/_help_W8vYD3Q1zjCR">File</a>
<th><a class="reference-link" href="#root/_help_W8vYD3Q1zjCR">File</a> </th>
</th> <td>Basic interaction (downloading the file).</td>
<td>Basic interaction (downloading the file).</td> <td>
<td> <ul>
<ul> <li>No further interaction supported.</li>
<li>No further interaction supported.</li> </ul>
</ul> </td>
</td> </tr>
</tr> </tbody>
</tbody> </table>
</table>
</figure>
<p>While the sharing feature is powerful, it has some limitations:</p> <p>While the sharing feature is powerful, it has some limitations:</p>
<ul> <ul>
<li><strong>Code Notes</strong>: No syntax highlighting.</li> <li><strong>Code Notes</strong>: No syntax highlighting.</li>
@@ -269,83 +267,81 @@ for (const attr of parentNote.attributes) {
this with the <code>#shareIndex</code> label, which will display a list of this with the <code>#shareIndex</code> label, which will display a list of
all shared notes.</p> all shared notes.</p>
<h2>Attribute reference</h2> <h2>Attribute reference</h2>
<figure class="table"> <table>
<table> <thead>
<thead> <tr>
<tr> <th>Attribute</th>
<th>Attribute</th> <th>Description</th>
<th>Description</th> </tr>
</tr> </thead>
</thead> <tbody>
<tbody> <tr>
<tr> <td><code>shareHiddenFromTree</code>
<td><code>shareHiddenFromTree</code> </td>
</td> <td>this note is hidden from left navigation tree, but still accessible with
<td>this note is hidden from left navigation tree, but still accessible with its URL</td>
its URL</td> </tr>
</tr> <tr>
<tr> <td><code>shareExternalLink</code>
<td><code>shareExternalLink</code> </td>
</td> <td>note will act as a link to an external website in the share tree</td>
<td>note will act as a link to an external website in the share tree</td> </tr>
</tr> <tr>
<tr> <td><code>shareAlias</code>
<td><code>shareAlias</code> </td>
</td> <td>define an alias using which the note will be available under <code>https://your_trilium_host/share/[your_alias]</code>
<td>define an alias using which the note will be available under <code>https://your_trilium_host/share/[your_alias]</code> </td>
</td> </tr>
</tr> <tr>
<tr> <td><code>shareOmitDefaultCss</code>
<td><code>shareOmitDefaultCss</code> </td>
</td> <td>default share page CSS will be omitted. Use when you make extensive styling
<td>default share page CSS will be omitted. Use when you make extensive styling changes.</td>
changes.</td> </tr>
</tr> <tr>
<tr> <td><code>shareRoot</code>
<td><code>shareRoot</code> </td>
</td> <td>marks note which is served on /share root.</td>
<td>marks note which is served on /share root.</td> </tr>
</tr> <tr>
<tr> <td><code>shareDescription</code>
<td><code>shareDescription</code> </td>
</td> <td>define text to be added to the HTML meta tag for description</td>
<td>define text to be added to the HTML meta tag for description</td> </tr>
</tr> <tr>
<tr> <td><code>shareRaw</code>
<td><code>shareRaw</code> </td>
</td> <td>Note will be served in its raw format, without HTML wrapper. See also&nbsp;
<td>Note will be served in its raw format, without HTML wrapper. See also&nbsp; <a
<a class="reference-link" href="#root/_help_Qjt68inQ2bRj">Serving directly the content of a note</a>&nbsp;for an alternative method
class="reference-link" href="#root/_help_Qjt68inQ2bRj">Serving directly the content of a note</a>&nbsp;for an alternative method without setting an attribute.</td>
without setting an attribute.</td> </tr>
</tr> <tr>
<tr> <td><code>shareDisallowRobotIndexing</code>
<td><code>shareDisallowRobotIndexing</code> </td>
</td> <td>
<td> <p>Indicates to web crawlers that the page should not be indexed of this
<p>Indicates to web crawlers that the page should not be indexed of this note by:</p>
note by:</p> <ul>
<ul> <li>Setting the <code>X-Robots-Tag: noindex</code> HTTP header.</li>
<li>Setting the <code>X-Robots-Tag: noindex</code> HTTP header.</li> <li>Setting the <code>noindex, follow</code> meta tag.</li>
<li>Setting the <code>noindex, follow</code> meta tag.</li> </ul>
</ul> </td>
</td> </tr>
</tr> <tr>
<tr> <td><code>shareCredentials</code>
<td><code>shareCredentials</code> </td>
</td> <td>require credentials to access this shared note. Value is expected to be
<td>require credentials to access this shared note. Value is expected to be in format <code>username:password</code>. Don't forget to make this inheritable
in format <code>username:password</code>. Don't forget to make this inheritable to apply to child-notes/images.</td>
to apply to child-notes/images.</td> </tr>
</tr> <tr>
<tr> <td><code>shareIndex</code>
<td><code>shareIndex</code> </td>
</td> <td>Note with this label will list all roots of shared notes.</td>
<td>Note with this label will list all roots of shared notes.</td> </tr>
</tr> </tbody>
</tbody> </table>
</table>
</figure>
<h2>Credits</h2> <h2>Credits</h2>
<p>Since v0.95.0, a new theme was introduced (and enabled by default) which <p>Since v0.95.0, a new theme was introduced (and enabled by default) which

View File

@@ -1,29 +1,27 @@
<p>When accessing a shared note, Trilium will render it as a web page. Sometimes <p>When accessing a shared note, Trilium will render it as a web page. Sometimes
it's desirable to serve the content directly so that it can be used in it's desirable to serve the content directly so that it can be used in
a script or downloaded by the user.</p> a script or downloaded by the user.</p>
<figure class="table"> <table>
<table> <thead>
<thead> <tr>
<tr> <th>A note displayed as a web page (HTML)</th>
<th>A note displayed as a web page (HTML)</th> <th>A note displayed as a raw format</th>
<th>A note displayed as a raw format</th> </tr>
</tr> </thead>
</thead> <tbody>
<tbody> <tr>
<tr> <td>
<td> <figure class="image">
<figure class="image"> <img style="aspect-ratio:738/275;" src="1_Serving directly the conte.png"
<img style="aspect-ratio:738/275;" src="1_Serving directly the conte.png" width="738" height="275">
width="738" height="275"> </figure>
</figure> </td>
</td> <td>
<td> <img src="Serving directly the conte.png">
<img src="Serving directly the conte.png"> </td>
</td> </tr>
</tr> </tbody>
</tbody> </table>
</table>
</figure>
<h2>By adding an attribute to the note</h2> <h2>By adding an attribute to the note</h2>
<p>Simply add the <code>#shareRaw</code> attribute and the note will always <p>Simply add the <code>#shareRaw</code> attribute and the note will always

View File

@@ -23,58 +23,56 @@
</li> </li>
</ul> </ul>
<h3>Configuration</h3> <h3>Configuration</h3>
<figure class="table"> <table>
<table> <thead>
<thead> <tr>
<tr> <th>Label</th>
<th>Label</th> <th>Description</th>
<th>Description</th> </tr>
</tr> </thead>
</thead> <tbody>
<tbody> <tr>
<tr> <td><code>workspace</code>
<td><code>workspace</code> </td>
</td> <td>Marks this note as a workspace, button to enter the workspace is controlled
<td>Marks this note as a workspace, button to enter the workspace is controlled by this</td>
by this</td> </tr>
</tr> <tr>
<tr> <td><code>workspaceIconClass</code>
<td><code>workspaceIconClass</code> </td>
</td> <td>defines box icon CSS class which will be used in tab when hoisted to this
<td>defines box icon CSS class which will be used in tab when hoisted to this note</td>
note</td> </tr>
</tr> <tr>
<tr> <td><code>workspaceTabBackgroundColor</code>
<td><code>workspaceTabBackgroundColor</code> </td>
</td> <td>CSS color used in the note tab when hoisted to this note, use any CSS
<td>CSS color used in the note tab when hoisted to this note, use any CSS color format, e.g. "lightblue" or "#ddd". See <a href="https://www.w3schools.com/cssref/css_colors.asp">https://www.w3schools.com/cssref/css_colors.asp</a>.</td>
color format, e.g. "lightblue" or "#ddd". See <a href="https://www.w3schools.com/cssref/css_colors.asp">https://www.w3schools.com/cssref/css_colors.asp</a>.</td> </tr>
</tr> <tr>
<tr> <td><code>workspaceCalendarRoot</code>
<td><code>workspaceCalendarRoot</code> </td>
</td> <td>Marking a note with this label will define a new per-workspace calendar
<td>Marking a note with this label will define a new per-workspace calendar for&nbsp;<a class="reference-link" href="#root/_help_l0tKav7yLHGF">Day Notes</a>.
for&nbsp;<a class="reference-link" href="#root/_help_l0tKav7yLHGF">Day Notes</a>. If there's no such note, the global calendar will be used.</td>
If there's no such note, the global calendar will be used.</td> </tr>
</tr> <tr>
<tr> <td><code>workspaceTemplate</code>
<td><code>workspaceTemplate</code> </td>
</td> <td>This note will appear in the selection of available template when creating
<td>This note will appear in the selection of available template when creating new note, but only when hoisted into a workspace containing this template</td>
new note, but only when hoisted into a workspace containing this template</td> </tr>
</tr> <tr>
<tr> <td><code>workspaceSearchHome</code>
<td><code>workspaceSearchHome</code> </td>
</td> <td>new search notes will be created as children of this note when hoisted
<td>new search notes will be created as children of this note when hoisted to some ancestor of this workspace note</td>
to some ancestor of this workspace note</td> </tr>
</tr> <tr>
<tr> <td><code>workspaceInbox</code>
<td><code>workspaceInbox</code> </td>
</td> <td>default inbox location for new notes when hoisted to some ancestor of
<td>default inbox location for new notes when hoisted to some ancestor of this workspace note</td>
this workspace note</td> </tr>
</tr> </tbody>
</tbody> </table>
</table>
</figure>

View File

@@ -6,10 +6,10 @@
of the note for easy navigation.</p> of the note for easy navigation.</p>
<h2>Configuration</h2> <h2>Configuration</h2>
<ul> <ul>
<li data-list-item-id="eb5063d3ae8e7f0da6afcdd9c3250c426">To hide the note list for a particular note, simply apply the <code>hideChildrenOverview</code> <li>To hide the note list for a particular note, simply apply the <code>hideChildrenOverview</code>
<a <a
href="#root/_help_zEY4DaJG4YT5">label</a>.</li> href="#root/_help_zEY4DaJG4YT5">label</a>.</li>
<li data-list-item-id="e50e31d45fae6051c1ff7fab14387aff7">For some view types, such as Grid view, only a subset of notes will be <li>For some view types, such as Grid view, only a subset of notes will be
displayed and pagination can be used to navigate through all of them for displayed and pagination can be used to navigate through all of them for
performance reasons. To adjust the number of notes per page, set <code>pageSize</code> to performance reasons. To adjust the number of notes per page, set <code>pageSize</code> to
the desired number.</li> the desired number.</li>

View File

@@ -2,124 +2,122 @@
<h2>Legacy Themes</h2> <h2>Legacy Themes</h2>
<p>These themes may or may not be compatible with the latest versions of <p>These themes may or may not be compatible with the latest versions of
TriliumNext and are based on the original/legacy theme.</p> TriliumNext and are based on the original/legacy theme.</p>
<figure class="table"> <table>
<table> <thead>
<thead> <tr>
<tr> <th>Theme</th>
<th>Theme</th> <th>Author</th>
<th>Author</th> </tr>
</tr> </thead>
</thead> <tbody>
<tbody> <tr>
<tr> <td><a href="https://github.com/tobealive/trilium-midnight-theme">Midnight</a>
<td><a href="https://github.com/tobealive/trilium-midnight-theme">Midnight</a> </td>
</td> <td><a href="https://github.com/tobealive">tobealive</a>
<td><a href="https://github.com/tobealive">tobealive</a> </td>
</td> </tr>
</tr> <tr>
<tr> <td><a href="https://github.com/tobealive/trilum-eote-theme">EOTE</a>
<td><a href="https://github.com/tobealive/trilum-eote-theme">EOTE</a> </td>
</td> <td><a href="https://github.com/tobealive">tobealive</a>
<td><a href="https://github.com/tobealive">tobealive</a> </td>
</td> </tr>
</tr> <tr>
<tr> <td><a href="https://github.com/Abourass/TriliumThemes">Trilium Themes</a>
<td><a href="https://github.com/Abourass/TriliumThemes">Trilium Themes</a> </td>
</td> <td><a href="https://github.com/Abourass">Abourass</a>
<td><a href="https://github.com/Abourass">Abourass</a> </td>
</td> </tr>
</tr> <tr>
<tr> <td><a href="https://github.com/ZMonk91/Material-Dark-Trilium">MaterialDark</a>
<td><a href="https://github.com/ZMonk91/Material-Dark-Trilium">MaterialDark</a> </td>
</td> <td><a href="https://github.com/ZMonk91">ZMonk91</a>
<td><a href="https://github.com/ZMonk91">ZMonk91</a> </td>
</td> </tr>
</tr> <tr>
<tr> <td><a href="https://github.com/jaroet/trilium-theme-lightslategray">lightslategray</a>
<td><a href="https://github.com/jaroet/trilium-theme-lightslategray">lightslategray</a> </td>
</td> <td><a href="https://github.com/jaroet">jaroet</a>
<td><a href="https://github.com/jaroet">jaroet</a> </td>
</td> </tr>
</tr> <tr>
<tr> <td><a href="https://github.com/raphwriter/trilium-theme-melon">melon-4</a>
<td><a href="https://github.com/raphwriter/trilium-theme-melon">melon-4</a> </td>
</td> <td><a href="https://github.com/raphwriter">raphwriter</a>
<td><a href="https://github.com/raphwriter">raphwriter</a> </td>
</td> </tr>
</tr> <tr>
<tr> <td><a href="https://github.com/Engr-AllanG/trilium-themes">Neon_Dark</a>
<td><a href="https://github.com/Engr-AllanG/trilium-themes">Neon_Dark</a> </td>
</td> <td><a href="https://github.com/Engr-AllanG">Engr-AllanG</a>
<td><a href="https://github.com/Engr-AllanG">Engr-AllanG</a> </td>
</td> </tr>
</tr> <tr>
<tr> <td><a href="https://github.com/Engr-AllanG/trilium-themes">Coder_Dark</a>
<td><a href="https://github.com/Engr-AllanG/trilium-themes">Coder_Dark</a> </td>
</td> <td><a href="https://github.com/Engr-AllanG">Engr-AllanG</a>
<td><a href="https://github.com/Engr-AllanG">Engr-AllanG</a> </td>
</td> </tr>
</tr> <tr>
<tr> <td><a href="https://github.com/idelem/trilium-theme-velvet">velvet</a>
<td><a href="https://github.com/idelem/trilium-theme-velvet">velvet</a> </td>
</td> <td><a href="https://github.com/idelem">idelem</a>
<td><a href="https://github.com/idelem">idelem</a> </td>
</td> </tr>
</tr> <tr>
<tr> <td><a href="https://github.com/SADAVA/trilium-notes-theme-dark-plus">Dark Plus</a>
<td><a href="https://github.com/SADAVA/trilium-notes-theme-dark-plus">Dark Plus</a> </td>
</td> <td><a href="https://github.com/SADAVA">SADAVA</a>
<td><a href="https://github.com/SADAVA">SADAVA</a> </td>
</td> </tr>
</tr> <tr>
<tr> <td><a href="https://github.com/WKSu/trilium-solarized-theme">Solarized</a>
<td><a href="https://github.com/WKSu/trilium-solarized-theme">Solarized</a> </td>
</td> <td><a href="https://github.com/WKSu">WKSu</a>
<td><a href="https://github.com/WKSu">WKSu</a> </td>
</td> </tr>
</tr> <tr>
<tr> <td><a href="https://github.com/en3r0/Trilium-Nord-Theme">Nord</a>
<td><a href="https://github.com/en3r0/Trilium-Nord-Theme">Nord</a> </td>
</td> <td><a href="https://github.com/en3r0">en3r0</a>
<td><a href="https://github.com/en3r0">en3r0</a> </td>
</td> </tr>
</tr> <tr>
<tr> <td><a href="https://github.com/AllanZyne/trilium-bear-theme">Bear Note Light</a>
<td><a href="https://github.com/AllanZyne/trilium-bear-theme">Bear Note Light</a> </td>
</td> <td><a href="https://github.com/AllanZyne">AllanZyne</a>
<td><a href="https://github.com/AllanZyne">AllanZyne</a> </td>
</td> </tr>
</tr> <tr>
<tr> <td><a href="https://github.com/AllanZyne/trilium-bear-theme">Bear Note Dark</a>
<td><a href="https://github.com/AllanZyne/trilium-bear-theme">Bear Note Dark</a> </td>
</td> <td><a href="https://github.com/AllanZyne">AllanZyne</a>
<td><a href="https://github.com/AllanZyne">AllanZyne</a> </td>
</td> </tr>
</tr> <tr>
<tr> <td><a href="https://github.com/Sebiann/miku-hatsune-trilium-theme">Miku Hatsune</a>
<td><a href="https://github.com/Sebiann/miku-hatsune-trilium-theme">Miku Hatsune</a> </td>
</td> <td><a href="https://github.com/Sebiann">Sebiann</a>
<td><a href="https://github.com/Sebiann">Sebiann</a> </td>
</td> </tr>
</tr> <tr>
<tr> <td><a href="https://github.com/cwilliams5/Midnight-Trilium-Dark-Mode">Midnight</a>
<td><a href="https://github.com/cwilliams5/Midnight-Trilium-Dark-Mode">Midnight</a> </td>
</td> <td><a href="https://github.com/cwilliams5">cwilliams5</a>
<td><a href="https://github.com/cwilliams5">cwilliams5</a> </td>
</td> </tr>
</tr> <tr>
<tr> <td><a href="https://github.com/SiriusXT/trilium-theme-blue">Blue</a> (light)</td>
<td><a href="https://github.com/SiriusXT/trilium-theme-blue">Blue</a> (light)</td> <td><a href="https://github.com/SiriusXT">SiriusXT</a>
<td><a href="https://github.com/SiriusXT">SiriusXT</a> </td>
</td> </tr>
</tr> <tr>
<tr> <td><a href="https://github.com/SiriusXT/trilium-theme-blue">Blue</a> (dark)</td>
<td><a href="https://github.com/SiriusXT/trilium-theme-blue">Blue</a> (dark)</td> <td><a href="https://github.com/SiriusXT">SiriusXT</a>
<td><a href="https://github.com/SiriusXT">SiriusXT</a> </td>
</td> </tr>
</tr> </tbody>
</tbody> </table>
</table>
</figure>
<aside class="admonition tip"> <aside class="admonition tip">
<p>If you would like to add your theme to this gallery, write a new post <p>If you would like to add your theme to this gallery, write a new post
in <a href="https://github.com/TriliumNext/Notes/discussions/categories/show-and-tell">👐 Show and tell</a>.</p> in <a href="https://github.com/TriliumNext/Notes/discussions/categories/show-and-tell">👐 Show and tell</a>.</p>

View File

@@ -31,102 +31,94 @@
used to edit the <a href="#root/_help_4FahAwuGTAwC">source of a note</a>.</p> used to edit the <a href="#root/_help_4FahAwuGTAwC">source of a note</a>.</p>
<h2>Supported note types</h2> <h2>Supported note types</h2>
<p>The following note types are supported by Trilium:</p> <p>The following note types are supported by Trilium:</p>
<figure class="table" <table>
style="width:100%;"> <thead>
<table class="ck-table-resized"> <tr>
<colgroup> <th>Note Type</th>
<col style="width:29.42%;"> <th>Description</th>
<col style="width:70.58%;"> </tr>
</colgroup> </thead>
<thead> <tbody>
<tr> <tr>
<th>Note Type</th> <td><a class="reference-link" href="#root/_help_iPIMuisry3hd">Text</a>
<th>Description</th> </td>
</tr> <td>The default note type, which allows for rich text formatting, images,
</thead> admonitions and right-to-left support.</td>
<tbody> </tr>
<tr> <tr>
<td><a class="reference-link" href="#root/_help_iPIMuisry3hd">Text</a> <td><a class="reference-link" href="#root/_help_6f9hih2hXXZk">Code</a>
</td> </td>
<td>The default note type, which allows for rich text formatting, images, <td>Uses a mono-space font and can be used to store larger chunks of code
admonitions and right-to-left support.</td> or plain text than a text note, and has better syntax highlighting.</td>
</tr> </tr>
<tr> <tr>
<td><a class="reference-link" href="#root/_help_6f9hih2hXXZk">Code</a> <td><a class="reference-link" href="#root/_help_m523cpzocqaD">Saved Search</a>
</td> </td>
<td>Uses a mono-space font and can be used to store larger chunks of code <td>Stores the information about a search (the search text, criteria, etc.)
or plain text than a text note, and has better syntax highlighting.</td> for later use. Can be used for quick filtering of a large amount of notes,
</tr> for example. The search can easily be triggered.</td>
<tr> </tr>
<td><a class="reference-link" href="#root/_help_m523cpzocqaD">Saved Search</a> <tr>
</td> <td><a class="reference-link" href="#root/_help_iRwzGnHPzonm">Relation Map</a>
<td>Stores the information about a search (the search text, criteria, etc.) </td>
for later use. Can be used for quick filtering of a large amount of notes, <td>Allows easy creation of notes and relations between them. Can be used
for example. The search can easily be triggered.</td> for mainly relational data such as a family tree.</td>
</tr> </tr>
<tr> <tr>
<td><a class="reference-link" href="#root/_help_iRwzGnHPzonm">Relation Map</a> <td><a class="reference-link" href="#root/_help_bdUJEHsAPYQR">Note Map</a>
</td> </td>
<td>Allows easy creation of notes and relations between them. Can be used <td>Displays the relationships between the notes, whether via relations or
for mainly relational data such as a family tree.</td> their hierarchical structure.</td>
</tr> </tr>
<tr> <tr>
<td><a class="reference-link" href="#root/_help_bdUJEHsAPYQR">Note Map</a> <td><a class="reference-link" href="#root/_help_HcABDtFCkbFN">Render Note</a>
</td> </td>
<td>Displays the relationships between the notes, whether via relations or <td>Used in&nbsp;<a class="reference-link" href="#root/_help_CdNpE2pqjmI6">Scripting</a>,
their hierarchical structure.</td> it displays the HTML content of another note. This allows displaying any
</tr> kind of content, provided there is a script behind it to generate it.</td>
<tr> </tr>
<td><a class="reference-link" href="#root/_help_HcABDtFCkbFN">Render Note</a> <tr>
</td> <td><a class="reference-link" href="#root/_help_GTwFsgaA0lCt">Collections</a>
<td>Used in&nbsp;<a class="reference-link" href="#root/_help_CdNpE2pqjmI6">Scripting</a>, </td>
it displays the HTML content of another note. This allows displaying any <td>Displays the children of the note either as a grid, a list, or for a more
kind of content, provided there is a script behind it to generate it.</td> specialized case: a calendar.
</tr> <br>
<tr> <br>Generally useful for easy reading of short notes.</td>
<td><a class="reference-link" href="#root/_help_GTwFsgaA0lCt">Collections</a> </tr>
</td> <tr>
<td> <td><a class="reference-link" href="#root/_help_s1aBHPd79XYj">Mermaid Diagrams</a>
<p>Displays the children of the note either as a grid, a list, or for a more </td>
specialized case: a calendar.</p> <td>Displays diagrams such as bar charts, flow charts, state diagrams, etc.
<p>Generally useful for easy reading of short notes.</p> Requires a bit of technical knowledge since the diagrams are written in
</td> a specialized format.</td>
</tr> </tr>
<tr> <tr>
<td><a class="reference-link" href="#root/_help_s1aBHPd79XYj">Mermaid Diagrams</a> <td><a class="reference-link" href="#root/_help_grjYqerjn243">Canvas</a>
</td> </td>
<td>Displays diagrams such as bar charts, flow charts, state diagrams, etc. <td>Allows easy drawing of sketches, diagrams, handwritten content. Uses the
Requires a bit of technical knowledge since the diagrams are written in same technology behind <a href="https://excalidraw.com">excalidraw.com</a>.</td>
a specialized format.</td> </tr>
</tr> <tr>
<tr> <td><a class="reference-link" href="#root/_help_1vHRoWCEjj0L">Web View</a>
<td><a class="reference-link" href="#root/_help_grjYqerjn243">Canvas</a> </td>
</td> <td>Displays the content of an external web page, similar to a browser.</td>
<td>Allows easy drawing of sketches, diagrams, handwritten content. Uses the </tr>
same technology behind <a href="https://excalidraw.com">excalidraw.com</a>.</td> <tr>
</tr> <td><a class="reference-link" href="#root/_help_gBbsAeiuUxI5">Mind Map</a>
<tr> </td>
<td><a class="reference-link" href="#root/_help_1vHRoWCEjj0L">Web View</a> <td>Easy for brainstorming ideas, by placing them in a hierarchical layout.</td>
</td> </tr>
<td>Displays the content of an external web page, similar to a browser.</td> <tr>
</tr> <td><a class="reference-link" href="#root/_help_81SGnPGMk7Xc">Geo Map View</a>
<tr> </td>
<td><a class="reference-link" href="#root/_help_gBbsAeiuUxI5">Mind Map</a> <td>Displays the children of the note as a geographical map, one use-case
</td> would be to plan vacations. It even has basic support for tracks. Notes
<td>Easy for brainstorming ideas, by placing them in a hierarchical layout.</td> can also be created from it.</td>
</tr> </tr>
<tr> <tr>
<td><a class="reference-link" href="#root/_help_81SGnPGMk7Xc">Geo Map View</a> <td><a class="reference-link" href="#root/_help_W8vYD3Q1zjCR">File</a>
</td> </td>
<td>Displays the children of the note as a geographical map, one use-case <td>Represents an uploaded file such as PDFs, images, video or audio files.</td>
would be to plan vacations. It even has basic support for tracks. Notes </tr>
can also be created from it.</td> </tbody>
</tr> </table>
<tr>
<td><a class="reference-link" href="#root/_help_W8vYD3Q1zjCR">File</a>
</td>
<td>Represents an uploaded file such as PDFs, images, video or audio files.</td>
</tr>
</tbody>
</table>
</figure>

View File

@@ -18,36 +18,34 @@
kind of interaction, such as moving events around as well as creating new kind of interaction, such as moving events around as well as creating new
ones.</p> ones.</p>
<h2>Creating a calendar</h2> <h2>Creating a calendar</h2>
<figure class="table"> <table>
<table> <thead>
<thead> <tr>
<tr> <th></th>
<th>&nbsp;</th> <th></th>
<th>&nbsp;</th> <th></th>
<th>&nbsp;</th> </tr>
</tr> </thead>
</thead> <tbody>
<tbody> <tr>
<tr> <td>1</td>
<td>1</td> <td>
<td> <img src="2_Calendar View_image.png">
<img src="2_Calendar View_image.png"> </td>
</td> <td>The Calendar View works only for Collection note types. To create a new
<td>The Calendar View works only for Collection note types. To create a new note, right click on the note tree on the left and select Insert note after,
note, right click on the note tree on the left and select Insert note after, or Insert child note and then select <em>Collection</em>.</td>
or Insert child note and then select <em>Collection</em>.</td> </tr>
</tr> <tr>
<tr> <td>2</td>
<td>2</td> <td>
<td> <img src="3_Calendar View_image.png">
<img src="3_Calendar View_image.png"> </td>
</td> <td>Once created, the “View type” of the Collection needs changed to “Calendar”,
<td>Once created, the “View type” of the Collection needs changed to “Calendar”, by selecting the Collection Properties” tab in the ribbon.</td>
by selecting the “Collection Properties” tab in the ribbon.</td> </tr>
</tr> </tbody>
</tbody> </table>
</table>
</figure>
<h2>Creating a new event/note</h2> <h2>Creating a new event/note</h2>
<ul> <ul>
@@ -94,289 +92,275 @@
</ul> </ul>
<h2>Configuring the calendar using attributes</h2> <h2>Configuring the calendar using attributes</h2>
<p>The following attributes can be added to the Collection type:</p> <p>The following attributes can be added to the Collection type:</p>
<figure <table>
class="table"> <thead>
<table> <tr>
<thead> <th>Name</th>
<tr> <th>Description</th>
<th>Name</th> </tr>
<th>Description</th> </thead>
</tr> <tbody>
</thead> <tr>
<tbody> <td><code>#calendar:hideWeekends</code>
<tr> </td>
<td><code>#calendar:hideWeekends</code> <td>When present (regardless of value), it will hide Saturday and Sundays
</td> from the calendar.</td>
<td>When present (regardless of value), it will hide Saturday and Sundays </tr>
from the calendar.</td> <tr>
</tr> <td><code>#calendar:weekNumbers</code>
<tr> </td>
<td><code>#calendar:weekNumbers</code> <td>When present (regardless of value), it will show the number of the week
</td> on the calendar.</td>
<td>When present (regardless of value), it will show the number of the week </tr>
on the calendar.</td> <tr>
</tr> <td><code>#calendar:view</code>
<tr> </td>
<td><code>#calendar:view</code> <td>
</td> <p>Which view to display in the calendar:</p>
<td> <ul>
<p>Which view to display in the calendar:</p> <li><code>timeGridWeek</code> for the <em>week</em> view;</li>
<ul> <li><code>dayGridMonth</code> for the <em>month</em> view;</li>
<li><code>timeGridWeek</code> for the <em>week</em> view;</li> <li><code>multiMonthYear</code> for the <em>year</em> view;</li>
<li><code>dayGridMonth</code> for the <em>month</em> view;</li> <li><code>listMonth</code> for the <em>list</em> view.</li>
<li><code>multiMonthYear</code> for the <em>year</em> view;</li> </ul>
<li><code>listMonth</code> for the <em>list</em> view.</li> <p>Any other value will be dismissed and the default view (month) will be
</ul> used instead.</p>
<p>Any other value will be dismissed and the default view (month) will be <p>The value of this label is automatically updated when changing the view
used instead.</p> using the UI buttons.</p>
<p>The value of this label is automatically updated when changing the view </td>
using the UI buttons.</p> </tr>
</td> <tr>
</tr> <td><code>~child:template</code>
<tr> </td>
<td><code>~child:template</code> <td>Defines the template for newly created notes in the calendar (via dragging
</td> or clicking).</td>
<td>Defines the template for newly created notes in the calendar (via dragging </tr>
or clicking).</td> </tbody>
</tr> </table>
</tbody> <p>In addition, the first day of the week can be either Sunday or Monday
</table> and can be adjusted from the application settings.</p>
</figure> <h2>Configuring the calendar events using attributes</h2>
<p>In addition, the first day of the week can be either Sunday or Monday <p>For each note of the calendar, the following attributes can be used:</p>
and can be adjusted from the application settings.</p> <table>
<h2>Configuring the calendar events using attributes</h2> <thead>
<p>For each note of the calendar, the following attributes can be used:</p> <tr>
<figure <th>Name</th>
class="table"> <th>Description</th>
<table> </tr>
<thead> </thead>
<tr> <tbody>
<th>Name</th> <tr>
<th>Description</th> <td><code>#startDate</code>
</tr> </td>
</thead> <td>The date the event starts, which will display it in the calendar. The
<tbody> format is <code>YYYY-MM-DD</code> (year, month and day separated by a minus
<tr> sign).</td>
<td><code>#startDate</code> </tr>
</td> <tr>
<td>The date the event starts, which will display it in the calendar. The <td><code>#endDate</code>
format is <code>YYYY-MM-DD</code> (year, month and day separated by a minus </td>
sign).</td> <td>Similar to <code>startDate</code>, mentions the end date if the event spans
</tr> across multiple days. The date is inclusive, so the end day is also considered.
<tr> The attribute can be missing for single-day events.</td>
<td><code>#endDate</code> </tr>
</td> <tr>
<td>Similar to <code>startDate</code>, mentions the end date if the event spans <td><code>#startTime</code>
across multiple days. The date is inclusive, so the end day is also considered. </td>
The attribute can be missing for single-day events.</td> <td>The time the event starts at. If this value is missing, then the event
</tr> is considered a full-day event. The format is <code>HH:MM</code> (hours in
<tr> 24-hour format and minutes).</td>
<td><code>#startTime</code> </tr>
</td> <tr>
<td>The time the event starts at. If this value is missing, then the event <td><code>#endTime</code>
is considered a full-day event. The format is <code>HH:MM</code> (hours in </td>
24-hour format and minutes).</td> <td>Similar to <code>startTime</code>, it mentions the time at which the event
</tr> ends (in relation with <code>endDate</code> if present, or <code>startDate</code>).</td>
<tr> </tr>
<td><code>#endTime</code> <tr>
</td> <td><code>#color</code>
<td>Similar to <code>startTime</code>, it mentions the time at which the event </td>
ends (in relation with <code>endDate</code> if present, or <code>startDate</code>).</td> <td>Displays the event with a specified color (named such as <code>red</code>, <code>gray</code> or
</tr> hex such as <code>#FF0000</code>). This will also change the color of the
<tr> note in other places such as the note tree.</td>
<td><code>#color</code> </tr>
</td> <tr>
<td>Displays the event with a specified color (named such as <code>red</code>, <code>gray</code> or <td><code>#calendar:color</code>
hex such as <code>#FF0000</code>). This will also change the color of the </td>
note in other places such as the note tree.</td> <td>Similar to <code>#color</code>, but applies the color only for the event
</tr> in the calendar and not for other places such as the note tree.</td>
<tr> </tr>
<td><code>#calendar:color</code> <tr>
</td> <td><code>#iconClass</code>
<td>Similar to <code>#color</code>, but applies the color only for the event </td>
in the calendar and not for other places such as the note tree.</td> <td>If present, the icon of the note will be displayed to the left of the
</tr> event title.</td>
<tr> </tr>
<td><code>#iconClass</code> <tr>
</td> <td><code>#calendar:title</code>
<td>If present, the icon of the note will be displayed to the left of the </td>
event title.</td> <td>Changes the title of an event to point to an attribute of the note other
</tr> than the title, can either a label or a relation (without the <code>#</code> or <code>~</code> symbol).
<tr> See <em>Use-cases</em> for more information.</td>
<td><code>#calendar:title</code> </tr>
</td> <tr>
<td>Changes the title of an event to point to an attribute of the note other <td><code>#calendar:displayedAttributes</code>
than the title, can either a label or a relation (without the <code>#</code> or <code>~</code> symbol). </td>
See <em>Use-cases</em> for more information.</td> <td>Allows displaying the value of one or more attributes in the calendar
</tr> like this:&nbsp;&nbsp;&nbsp;&nbsp;
<tr> <br>
<td><code>#calendar:displayedAttributes</code> <br>
</td> <img src="9_Calendar View_image.png">&nbsp;&nbsp;
<td>Allows displaying the value of one or more attributes in the calendar <br>
like this:&nbsp;&nbsp;&nbsp;&nbsp; <br><code>#weight="70" #Mood="Good" #calendar:displayedAttributes="weight,Mood"</code>&nbsp;&nbsp;
<br> <br>
<br> <br>It can also be used with relations, case in which it will display the
<img src="9_Calendar View_image.png">&nbsp;&nbsp; title of the target note:&nbsp;&nbsp;&nbsp;
<br> <br>
<br><code>#weight="70" #Mood="Good" #calendar:displayedAttributes="weight,Mood"</code>&nbsp;&nbsp; <br><code>~assignee=@My assignee #calendar:displayedAttributes="assignee"</code>
<br> </td>
<br>It can also be used with relations, case in which it will display the </tr>
title of the target note:&nbsp;&nbsp;&nbsp; <tr>
<br> <td><code>#calendar:startDate</code>
<br><code>~assignee=@My assignee #calendar:displayedAttributes="assignee"</code> </td>
</td> <td>Allows using a different label to represent the start date, other than <code>startDate</code> (e.g. <code>expiryDate</code>).
</tr> The label name <strong>must not be</strong> prefixed with <code>#</code>.
<tr> If the label is not defined for a note, the default will be used instead.</td>
<td><code>#calendar:startDate</code> </tr>
</td> <tr>
<td>Allows using a different label to represent the start date, other than <code>startDate</code> (e.g. <code>expiryDate</code>). <td><code>#calendar:endDate</code>
The label name <strong>must not be</strong> prefixed with <code>#</code>. </td>
If the label is not defined for a note, the default will be used instead.</td> <td>Similar to <code>#calendar:startDate</code>, allows changing the attribute
</tr> which is being used to read the end date.</td>
<tr> </tr>
<td><code>#calendar:endDate</code> <tr>
</td> <td><code>#calendar:startTime</code>
<td>Similar to <code>#calendar:startDate</code>, allows changing the attribute </td>
which is being used to read the end date.</td> <td>Similar to <code>#calendar:startDate</code>, allows changing the attribute
</tr> which is being used to read the start time.</td>
<tr> </tr>
<td><code>#calendar:startTime</code> <tr>
</td> <td><code>#calendar:endTime</code>
<td>Similar to <code>#calendar:startDate</code>, allows changing the attribute </td>
which is being used to read the start time.</td> <td>Similar to <code>#calendar:startDate</code>, allows changing the attribute
</tr> which is being used to read the end time.</td>
<tr> </tr>
<td><code>#calendar:endTime</code> </tbody>
</td> </table>
<td>Similar to <code>#calendar:startDate</code>, allows changing the attribute
which is being used to read the end time.</td>
</tr>
</tbody>
</table>
</figure>
<h2>How the calendar works</h2> <h2>How the calendar works</h2>
<p> <p>
<img src="11_Calendar View_image.png"> <img src="11_Calendar View_image.png">
</p> </p>
<p>The calendar displays all the child notes of the Collection that have <p>The calendar displays all the child notes of the Collection that have
a <code>#startDate</code>. An <code>#endDate</code> can optionally be added.</p> a <code>#startDate</code>. An <code>#endDate</code> can optionally be added.</p>
<p>If editing the start date and end date from the note itself is desirable, <p>If editing the start date and end date from the note itself is desirable,
the following attributes can be added to the Collection note:</p><pre><code class="language-text-x-trilium-auto">#viewType=calendar #label:startDate(inheritable)="promoted,alias=Start Date,single,date" the following attributes can be added to the Collection note:</p><pre><code class="language-text-x-trilium-auto">#viewType=calendar #label:startDate(inheritable)="promoted,alias=Start Date,single,date"
#label:endDate(inheritable)="promoted,alias=End Date,single,date" #label:endDate(inheritable)="promoted,alias=End Date,single,date"
#hidePromotedAttributes </code></pre> #hidePromotedAttributes </code></pre>
<p>This will result in:</p> <p>This will result in:</p>
<p> <p>
<img src="10_Calendar View_image.png"> <img src="10_Calendar View_image.png">
</p> </p>
<p>When not used in a Journal, the calendar is recursive. That is, it will <p>When not used in a Journal, the calendar is recursive. That is, it will
look for events not just in its child notes but also in the children of look for events not just in its child notes but also in the children of
these child notes.</p> these child notes.</p>
<h2>Use-cases</h2> <h2>Use-cases</h2>
<h3>Using with the Journal / calendar</h3> <h3>Using with the Journal / calendar</h3>
<p>It is possible to integrate the calendar view into the Journal with day <p>It is possible to integrate the calendar view into the Journal with day
notes. In order to do so change the note type of the Journal note (calendar notes. In order to do so change the note type of the Journal note (calendar
root) to Collection and then select the Calendar View.</p> root) to Collection and then select the Calendar View.</p>
<p>Based on the <code>#calendarRoot</code> (or <code>#workspaceCalendarRoot</code>) <p>Based on the <code>#calendarRoot</code> (or <code>#workspaceCalendarRoot</code>)
attribute, the calendar will know that it's in a calendar and apply the attribute, the calendar will know that it's in a calendar and apply the
following:</p> following:</p>
<ul> <ul>
<li>The calendar events are now rendered based on their <code>dateNote</code> attribute <li>The calendar events are now rendered based on their <code>dateNote</code> attribute
rather than <code>startDate</code>.</li> rather than <code>startDate</code>.</li>
<li>Interactive editing such as dragging over an empty era or resizing an <li>Interactive editing such as dragging over an empty era or resizing an
event is no longer possible.</li> event is no longer possible.</li>
<li>Clicking on the empty space on a date will automatically open that day's <li>Clicking on the empty space on a date will automatically open that day's
note or create it if it does not exist.</li> note or create it if it does not exist.</li>
<li>Direct children of a day note will be displayed on the calendar despite <li>Direct children of a day note will be displayed on the calendar despite
not having a <code>dateNote</code> attribute. Children of the child notes not having a <code>dateNote</code> attribute. Children of the child notes
will not be displayed.</li> will not be displayed.</li>
</ul> </ul>
<img src="8_Calendar View_image.png" width="1217" height="724"> <img src="8_Calendar View_image.png" width="1217" height="724">
<h3>Using a different attribute as event title</h3> <h3>Using a different attribute as event title</h3>
<p>By default, events are displayed on the calendar by their note title. <p>By default, events are displayed on the calendar by their note title.
However, it is possible to configure a different attribute to be displayed However, it is possible to configure a different attribute to be displayed
instead.</p> instead.</p>
<p>To do so, assign <code>#calendar:title</code> to the child note (not the <p>To do so, assign <code>#calendar:title</code> to the child note (not the
calendar/Collection note), with the value being <code>name</code> where <code>name</code> can calendar/Collection note), with the value being <code>name</code> where <code>name</code> can
be any label (make not to add the <code>#</code> prefix). The attribute can be any label (make not to add the <code>#</code> prefix). The attribute can
also come through inheritance such as a template attribute. If the note also come through inheritance such as a template attribute. If the note
does not have the requested label, the title of the note will be used instead.</p> does not have the requested label, the title of the note will be used instead.</p>
<figure <table>
class="table" style="width:100%;"> <thead>
<table> <tr>
<thead> <th>&nbsp;</th>
<tr> <th>&nbsp;</th>
<th>&nbsp;</th> </tr>
<th>&nbsp;</th> </thead>
</tr> <tbody>
</thead> <tr>
<tbody> <td><pre><code class="language-text-x-trilium-auto">#startDate=2025-02-11 #endDate=2025-02-13 #name="My vacation" #calendar:title="name"</code></pre>
<tr> </td>
<td><pre><code class="language-text-x-trilium-auto">#startDate=2025-02-11 #endDate=2025-02-13 #name="My vacation" #calendar:title="name"</code></pre> <td>
</td> <p>&nbsp;</p>
<td> <figure class="image image-style-align-center">
<p>&nbsp;</p> <img style="aspect-ratio:445/124;" src="5_Calendar View_image.png" width="445"
<figure class="image image-style-align-center"> height="124">
<img style="aspect-ratio:445/124;" src="5_Calendar View_image.png" width="445" </figure>
height="124"> </td>
</figure> </tr>
</td> </tbody>
</tr> </table>
</tbody>
</table>
</figure>
<h3>Using a relation attribute as event title</h3> <h3>Using a relation attribute as event title</h3>
<p>Similarly to using an attribute, use <code>#calendar:title</code> and set <p>Similarly to using an attribute, use <code>#calendar:title</code> and set
it to <code>name</code> where <code>name</code> is the name of the relation it to <code>name</code> where <code>name</code> is the name of the relation
to use.</p> to use.</p>
<p>Moreover, if there are more relations of the same name, they will be displayed <p>Moreover, if there are more relations of the same name, they will be displayed
as multiple events coming from the same note.</p> as multiple events coming from the same note.</p>
<figure class="table" <table>
style="width:100%;"> <thead>
<table> <tr>
<thead> <th>&nbsp;</th>
<tr> <th>&nbsp;</th>
<th>&nbsp;</th> </tr>
<th>&nbsp;</th> </thead>
</tr> <tbody>
</thead> <tr>
<tbody> <td><pre><code class="language-text-x-trilium-auto">#startDate=2025-02-14 #endDate=2025-02-15 ~for=@John Smith ~for=@Jane Doe #calendar:title="for"</code></pre>
<tr> </td>
<td><pre><code class="language-text-x-trilium-auto">#startDate=2025-02-14 #endDate=2025-02-15 ~for=@John Smith ~for=@Jane Doe #calendar:title="for"</code></pre> <td>
</td> <img src="6_Calendar View_image.png" width="294" height="151">
<td> </td>
<img src="6_Calendar View_image.png" width="294" height="151"> </tr>
</td> </tbody>
</tr> </table>
</tbody> <p>Note that it's even possible to have a <code>#calendar:title</code> on the
</table> target note (e.g. “John Smith”) which will try to render an attribute of
</figure> it. Note that it's not possible to use a relation here as well for safety
<p>Note that it's even possible to have a <code>#calendar:title</code> on the reasons (an accidental recursion &nbsp;of attributes could cause the application
target note (e.g. “John Smith”) which will try to render an attribute of to loop infinitely).</p>
it. Note that it's not possible to use a relation here as well for safety <table>
reasons (an accidental recursion &nbsp;of attributes could cause the application <thead>
to loop infinitely).</p> <tr>
<figure class="table" style="width:100%;"> <th>&nbsp;</th>
<table> <th>&nbsp;</th>
<thead> </tr>
<tr> </thead>
<th>&nbsp;</th> <tbody>
<th>&nbsp;</th> <tr>
</tr> <td><pre><code class="language-text-x-trilium-auto">#calendar:title="shortName" #shortName="John S."</code></pre>
</thead> </td>
<tbody> <td>
<tr> <figure class="image image-style-align-center">
<td><pre><code class="language-text-x-trilium-auto">#calendar:title="shortName" #shortName="John S."</code></pre> <img style="aspect-ratio:296/150;" src="1_Calendar View_image.png" width="296"
</td> height="150">
<td> </figure>
<figure class="image image-style-align-center"> </td>
<img style="aspect-ratio:296/150;" src="1_Calendar View_image.png" width="296" </tr>
height="150"> </tbody>
</figure> </table>
</td>
</tr>
</tbody>
</table>
</figure>

View File

@@ -45,11 +45,10 @@
</tbody> </tbody>
</table> </table>
</figure> </figure>
<h2>Repositioning the map</h2> <h2>Repositioning the map</h2>
<ul> <ul>
<li>Click and drag the map in order to move across the map.</li> <li data-list-item-id="eae523b73dba005f71d5f01802606f2e3">Click and drag the map in order to move across the map.</li>
<li>Use the mouse wheel, two-finger gesture on a touchpad or the +/- buttons <li data-list-item-id="e0c1c00d4d2bc4457e552677e7f4a5548">Use the mouse wheel, two-finger gesture on a touchpad or the +/- buttons
on the top-left to adjust the zoom.</li> on the top-left to adjust the zoom.</li>
</ul> </ul>
<p>The position on the map and the zoom are saved inside the map note and <p>The position on the map and the zoom are saved inside the map note and
@@ -71,7 +70,7 @@
<td>To create a marker, first navigate to the desired point on the map. Then <td>To create a marker, first navigate to the desired point on the map. Then
press the press the
<img src="10_Geo Map View_image.png">button in the&nbsp;<a href="#root/_help_XpOYSgsLkTJy">Floating buttons</a>&nbsp;(top-right) <img src="10_Geo Map View_image.png">button in the&nbsp;<a href="#root/_help_XpOYSgsLkTJy">Floating buttons</a>&nbsp;(top-right)
area.&nbsp; area.&nbsp;&nbsp;
<br> <br>
<br>If the button is not visible, make sure the button section is visible <br>If the button is not visible, make sure the button section is visible
by pressing the chevron button ( by pressing the chevron button (
@@ -85,7 +84,7 @@
width="1730" height="416"> width="1730" height="416">
</td> </td>
<td>Once pressed, the map will enter in the insert mode, as illustrated by <td>Once pressed, the map will enter in the insert mode, as illustrated by
the notification.&nbsp;&nbsp;&nbsp;&nbsp; the notification.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<br> <br>
<br>Simply click the point on the map where to place the marker, or the Escape <br>Simply click the point on the map where to place the marker, or the Escape
key to cancel.</td> key to cancel.</td>
@@ -110,34 +109,37 @@
</tbody> </tbody>
</table> </table>
</figure> </figure>
<h3>Adding a new note using the contextual menu</h3> <h3>Adding a new note using the contextual menu</h3>
<ol> <ol>
<li>Right click anywhere on the map, where to place the newly created marker <li data-list-item-id="e28f1a2fee5b0ecc42bfe35b472bf6e9d">Right click anywhere on the map, where to place the newly created marker
(and corresponding note).</li> (and corresponding note).</li>
<li>Select <em>Add a marker at this location</em>.</li> <li data-list-item-id="e12f1d02eab30eff35d80d30881242432">Select <em>Add a marker at this location</em>.</li>
<li>Enter the name of the newly created note.</li> <li data-list-item-id="e81f2c0a3e9385c326b222e95bbfb3fcf">Enter the name of the newly created note.</li>
<li>The map should be updated with the new marker.</li> <li data-list-item-id="e1965e61f563e3e73a88cba0c0a9882ea">The map should be updated with the new marker.</li>
</ol> </ol>
<h3>Adding an existing note on note from the note tree</h3> <h3>Adding an existing note on note from the note tree</h3>
<ol> <ol>
<li>Select the desired note in the&nbsp;<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</li> <li data-list-item-id="eec9c431281172d5e8459f6bdacd38b9f">Select the desired note in the&nbsp;<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</li>
<li>Hold the mouse on the note and drag it to the map to the desired location.</li> <li
<li>The map should be updated with the new marker.</li> data-list-item-id="ef5e95092daa5b6e5f6f09301a4a6f775">Hold the mouse on the note and drag it to the map to the desired location.</li>
<li
data-list-item-id="e5bec34d97bab10d0171a3bf086887066">The map should be updated with the new marker.</li>
</ol> </ol>
<p>This works for:</p> <p>This works for:</p>
<ul> <ul>
<li>Notes that are not part of the geo map, case in which a <a href="#root/_help_IakOLONlIfGI">clone</a> will <li data-list-item-id="e711a557c1554195062d8d3757b22a3af">Notes that are not part of the geo map, case in which a <a href="#root/_help_IakOLONlIfGI">clone</a> will
be created.</li> be created.</li>
<li>Notes that are a child of the geo map but not yet positioned on the map.</li> <li data-list-item-id="e4ea55f941135a2cccc00bf5238ff17f3">Notes that are a child of the geo map but not yet positioned on the map.</li>
<li>Notes that are a child of the geo map and also positioned, case in which <li
data-list-item-id="ebb44a6eb75da8c01f66967bacba6c44b">Notes that are a child of the geo map and also positioned, case in which
the marker will be relocated to the new position.</li> the marker will be relocated to the new position.</li>
</ul> </ul>
<h2>How the location of the markers is stored</h2> <h2>How the location of the markers is stored</h2>
<p>The location of a marker is stored in the <code>#geolocation</code> attribute <p>The location of a marker is stored in the <code>#geolocation</code> attribute
of the child notes:</p> of the child notes:</p>
<img src="18_Geo Map View_image.png" width="1288" <p>
height="278"> <img src="18_Geo Map View_image.png" width="1288" height="278">
</p>
<p>This value can be added manually if needed. The value of the attribute <p>This value can be added manually if needed. The value of the attribute
is made up of the latitude and longitude separated by a comma.</p> is made up of the latitude and longitude separated by a comma.</p>
<h2>Repositioning markers</h2> <h2>Repositioning markers</h2>
@@ -149,16 +151,17 @@ height="278">
page (<kbd>Ctrl</kbd>+<kbd>R</kbd> ) to cancel it.</p> page (<kbd>Ctrl</kbd>+<kbd>R</kbd> ) to cancel it.</p>
<h2>Interaction with the markers</h2> <h2>Interaction with the markers</h2>
<ul> <ul>
<li>Hovering over a marker will display a&nbsp;<a class="reference-link" href="#root/_help_lgKX7r3aL30x">Note Tooltip</a>&nbsp;with <li data-list-item-id="e2c684ec660b82d51e613eb2259503f24">Hovering over a marker will display a&nbsp;<a class="reference-link" href="#root/_help_lgKX7r3aL30x">Note Tooltip</a>&nbsp;with
the content of the note it belongs to. the content of the note it belongs to.
<ul> <ul>
<li>Clicking on the note title in the tooltip will navigate to the note in <li data-list-item-id="e7d2862e8cc2f9c0abfc7a787c2d592e5">Clicking on the note title in the tooltip will navigate to the note in
the current view.</li> the current view.</li>
</ul> </ul>
</li> </li>
<li>Middle-clicking the marker will open the note in a new tab.</li> <li data-list-item-id="e128abb7b7e86bab6a078bbcc036cf18e">Middle-clicking the marker will open the note in a new tab.</li>
<li>Right-clicking the marker will open a contextual menu (as described below).</li> <li data-list-item-id="e4ab8d71d03964d1d6f78176b8c52ba55">Right-clicking the marker will open a contextual menu (as described below).</li>
<li>If the map is in read-only mode, clicking on a marker will open a&nbsp; <li
data-list-item-id="e7b9935143dde811ab1a815390b74dc6c">If the map is in read-only mode, clicking on a marker will open a&nbsp;
<a <a
class="reference-link" href="#root/_help_ZjLYv08Rp3qC">Quick edit</a>&nbsp;popup for the corresponding note.</li> class="reference-link" href="#root/_help_ZjLYv08Rp3qC">Quick edit</a>&nbsp;popup for the corresponding note.</li>
</ul> </ul>
@@ -166,24 +169,24 @@ height="278">
<p>It's possible to press the right mouse button to display a contextual <p>It's possible to press the right mouse button to display a contextual
menu.</p> menu.</p>
<ol> <ol>
<li>If right-clicking an empty section of the map (not on a marker), it allows <li data-list-item-id="e3d9089e1842a44c6c4350e2302ae4c44">If right-clicking an empty section of the map (not on a marker), it allows
to: to:
<ol> <ol>
<li>Displays the latitude and longitude. Clicking this option will copy them <li data-list-item-id="ed2632173c9e684258ad6695f90c34b52">Displays the latitude and longitude. Clicking this option will copy them
to the clipboard.</li> to the clipboard.</li>
<li>Open the location using an external application (if the operating system <li data-list-item-id="e5c8b63fcebf2d89ca789ca2412cb45f6">Open the location using an external application (if the operating system
supports it).</li> supports it).</li>
<li>Adding a new marker at that location.</li> <li data-list-item-id="ee3db8aec5bce0c696fd9110599b35356">Adding a new marker at that location.</li>
</ol> </ol>
</li> </li>
<li>If right-clicking on a marker, it allows to: <li data-list-item-id="ea9dce579893bc84079ea809e943a60da">If right-clicking on a marker, it allows to:
<ol> <ol>
<li>Displays the latitude and longitude. Clicking this option will copy them <li data-list-item-id="ecf1bd157850305904f6aa173667c8d7e">Displays the latitude and longitude. Clicking this option will copy them
to the clipboard.</li> to the clipboard.</li>
<li>Open the location using an external application (if the operating system <li data-list-item-id="ead7e348313cfad21d3555d997c349f3e">Open the location using an external application (if the operating system
supports it).</li> supports it).</li>
<li>Open the note in a new tab, split or window.</li> <li data-list-item-id="e9d0282d185ea5672a81722ece761050f">Open the note in a new tab, split or window.</li>
<li>Remove the marker from the map, which will remove the <code>#geolocation</code> attribute <li data-list-item-id="ed589d9e12ebb69788430f3fda290cc6a">Remove the marker from the map, which will remove the <code>#geolocation</code> attribute
of the note. To add it back again, the coordinates have to be manually of the note. To add it back again, the coordinates have to be manually
added back in.</li> added back in.</li>
</ol> </ol>
@@ -203,13 +206,8 @@ height="278">
<p>The value of the attribute is made up of the latitude and longitude separated <p>The value of the attribute is made up of the latitude and longitude separated
by a comma.</p> by a comma.</p>
<h3>Adding from Google Maps</h3> <h3>Adding from Google Maps</h3>
<figure class="table" style="width:100%;"> <figure class="table">
<table class="ck-table-resized"> <table>
<colgroup>
<col style="width:2.77%;">
<col style="width:33.24%;">
<col style="width:63.99%;">
</colgroup>
<thead> <thead>
<tr> <tr>
<th>&nbsp;</th> <th>&nbsp;</th>
@@ -227,10 +225,10 @@ height="278">
</figure> </figure>
</td> </td>
<td>Go to Google Maps on the web and look for a desired location, right click <td>Go to Google Maps on the web and look for a desired location, right click
on it and a context menu will show up.&nbsp;&nbsp;&nbsp;&nbsp; on it and a context menu will show up.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<br> <br>
<br>Simply click on the first item displaying the coordinates and they will <br>Simply click on the first item displaying the coordinates and they will
be copied to clipboard.&nbsp;&nbsp;&nbsp;&nbsp; be copied to clipboard.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<br> <br>
<br>Then paste the value inside the text box into the <code>#geolocation</code> attribute <br>Then paste the value inside the text box into the <code>#geolocation</code> attribute
of a child note of the map (don't forget to surround the value with a <code>"</code> character).</td> of a child note of the map (don't forget to surround the value with a <code>"</code> character).</td>
@@ -261,16 +259,10 @@ height="278">
</tbody> </tbody>
</table> </table>
</figure> </figure>
<h3>Adding from OpenStreetMap</h3> <h3>Adding from OpenStreetMap</h3>
<p>Similarly to the Google Maps approach:</p> <p>Similarly to the Google Maps approach:</p>
<figure class="table" style="width:100%;"> <figure class="table">
<table class="ck-table-resized"> <table>
<colgroup>
<col style="width:2.77%;">
<col style="width:33.42%;">
<col style="width:63.81%;">
</colgroup>
<thead> <thead>
<tr> <tr>
<th>&nbsp;</th> <th>&nbsp;</th>
@@ -295,7 +287,7 @@ height="278">
width="696" height="480"> width="696" height="480">
</td> </td>
<td>The address will be visible in the top-left of the screen, in the place <td>The address will be visible in the top-left of the screen, in the place
of the search bar.&nbsp;&nbsp;&nbsp;&nbsp; of the search bar.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<br> <br>
<br>Select the coordinates and copy them into the clipboard.</td> <br>Select the coordinates and copy them into the clipboard.</td>
</tr> </tr>
@@ -311,17 +303,11 @@ height="278">
</tbody> </tbody>
</table> </table>
</figure> </figure>
<h2>Adding GPS tracks (.gpx)</h2> <h2>Adding GPS tracks (.gpx)</h2>
<p>Trilium has basic support for displaying GPS tracks on the geo map.</p> <p>Trilium has basic support for displaying GPS tracks on the geo map.</p>
<figure <figure
class="table" style="width:100%;"> class="table">
<table class="ck-table-resized"> <table>
<colgroup>
<col style="width:2.77%;">
<col style="width:30.22%;">
<col style="width:67.01%;">
</colgroup>
<thead> <thead>
<tr> <tr>
<th>&nbsp;</th> <th>&nbsp;</th>
@@ -360,7 +346,7 @@ class="table" style="width:100%;">
height="530"> height="530">
</figure> </figure>
</td> </td>
<td>When going back to the map, the track should now be visible.&nbsp;&nbsp;&nbsp;&nbsp; <td>When going back to the map, the track should now be visible.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<br> <br>
<br>The start and end points of the track are indicated by the two blue markers.</td> <br>The start and end points of the track are indicated by the two blue markers.</td>
</tr> </tr>
@@ -379,20 +365,55 @@ class="table" style="width:100%;">
<p>When a map is in read-only all editing features will be disabled such <p>When a map is in read-only all editing features will be disabled such
as:</p> as:</p>
<ul> <ul>
<li>The add button in the&nbsp;<a class="reference-link" href="#root/_help_XpOYSgsLkTJy">Floating buttons</a>.</li> <li data-list-item-id="e259bf29df58132f4068a0123b405560b">The add button in the&nbsp;<a class="reference-link" href="#root/_help_XpOYSgsLkTJy">Floating buttons</a>.</li>
<li>Dragging markers.</li> <li
<li>Editing from the contextual menu (removing locations or adding new items).</li> data-list-item-id="e476b0dc0202a017bcae0696997253965">Dragging markers.</li>
<li data-list-item-id="e617fa22b5a9f273586c20a6aec6f3661">Editing from the contextual menu (removing locations or adding new items).</li>
</ul> </ul>
<p>To enable read-only mode simply press the <em>Lock</em> icon from the&nbsp; <p>To enable read-only mode simply press the <em>Lock</em> icon from the&nbsp;
<a <a
class="reference-link" href="#root/_help_XpOYSgsLkTJy">Floating buttons</a>. To disable it, press the button again.</p> class="reference-link" href="#root/_help_XpOYSgsLkTJy">Floating buttons</a>. To disable it, press the button again.</p>
<h2>Configuration</h2>
<h3>Map Style</h3>
<p>The styling of the map can be adjusted in the <em>Collection Properties</em> tab
in the&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_BlN9DFI679QC">Ribbon</a>&nbsp;or
manually via the <code>#map:style</code> attribute.</p>
<p>The geo map comes with two different types of styles:</p>
<ul>
<li data-list-item-id="e9906c5e3a729a3640f5e287feab31b72">Raster styles
<ul>
<li data-list-item-id="e97f71804efddd3853b507512ea4a40af">For these styles the map is represented as a grid of images at different
zoom levels. This is the traditional way OpenStreetMap used to work.</li>
<li
data-list-item-id="e00813cf013a220a699bb6b23567db695">Zoom is slightly restricted.</li>
<li data-list-item-id="ef1855c52e9c051a5cb6f4fff26d5f618">Currently, the only raster theme is the original OpenStreetMap style.</li>
</ul>
</li>
<li data-list-item-id="e725de962ba0d3f2e76ee990288862433">Vector styles
<ul>
<li data-list-item-id="ed3092e999b7bf7123c8b7b0bbc30277a">Vector styles are not represented as images, but as geometrical shapes.
This makes the rendering much smoother, especially when zooming and looking
at the building edges, for example.</li>
<li data-list-item-id="eefa12c0b39d004da202f5ec1ab03fc9d">The map can be zoomed in much further.</li>
<li data-list-item-id="e5c257789123aa1c9b934bcfdbef60931">These come both in a light and a dark version.</li>
<li data-list-item-id="e6669e513e76501556470599f09c43f4a">The vector styles come from <a href="https://versatiles.org/">VersaTiles</a>,
a free and open-source project providing map tiles based on OpenStreetMap.</li>
</ul>
</li>
</ul>
<aside class="admonition note">
<p>Currently it is not possible to use a custom map style.</p>
</aside>
<h3>Scale</h3>
<p>Activating this option via the&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_BlN9DFI679QC">Ribbon</a>&nbsp;or
manually via <code>#map:scale</code> will display an indicator in the bottom-left
of the scale of the map.</p>
<h2>Troubleshooting</h2> <h2>Troubleshooting</h2>
<figure class="image image-style-align-right image_resized" style="width:34.06%;"> <figure class="image image-style-align-right image_resized" style="width:34.06%;">
<img style="aspect-ratio:678/499;" src="13_Geo Map View_image.png" width="678" <img style="aspect-ratio:678/499;" src="13_Geo Map View_image.png" width="678"
height="499"> height="499">
</figure> </figure>
<h3>Grid-like artifacts on the map</h3>
<h3>Grid-like artifacts on the map</h3>
<p>This occurs if the application is not at 100% zoom which causes the pixels <p>This occurs if the application is not at 100% zoom which causes the pixels
of the map to not render correctly due to fractional scaling. The only of the map to not render correctly due to fractional scaling. The only
possible solution is to set the UI zoom at 100% (default keyboard shortcut possible solution is to set the UI zoom at 100% (default keyboard shortcut

View File

@@ -18,170 +18,167 @@
<p>Fore more information see&nbsp;<a class="reference-link" href="#root/_help_nRhnJkTT8cPs">Formatting toolbar</a>.</p> <p>Fore more information see&nbsp;<a class="reference-link" href="#root/_help_nRhnJkTT8cPs">Formatting toolbar</a>.</p>
<h2>Features and formatting</h2> <h2>Features and formatting</h2>
<p>Here's a list of various features supported by text notes:</p> <p>Here's a list of various features supported by text notes:</p>
<figure <table>
class="table"> <thead>
<table> <tr>
<thead> <th>Dedicated article</th>
<tr> <th>Feature</th>
<th>Dedicated article</th> </tr>
<th>Feature</th> </thead>
</tr> <tbody>
</thead> <tr>
<tbody> <td><a class="reference-link" href="#root/_help_Gr6xFaF6ioJ5">General formatting</a>
<tr> </td>
<td><a class="reference-link" href="#root/_help_Gr6xFaF6ioJ5">General formatting</a> <td>
</td> <ul>
<td> <li>Headings (section titles, paragraph)</li>
<ul> <li>Font size</li>
<li>Headings (section titles, paragraph)</li> <li>Bold, italic, underline, strike-through</li>
<li>Font size</li> <li>Superscript, subscript</li>
<li>Bold, italic, underline, strike-through</li> <li>Font color &amp; background color</li>
<li>Superscript, subscript</li> <li>Remove formatting</li>
<li>Font color &amp; background color</li> </ul>
<li>Remove formatting</li> </td>
</ul> </tr>
</td> <tr>
</tr> <td><a class="reference-link" href="#root/_help_S6Xx8QIWTV66">Lists</a>
<tr> </td>
<td><a class="reference-link" href="#root/_help_S6Xx8QIWTV66">Lists</a> <td>
</td> <ul>
<td> <li>Bulleted lists</li>
<ul> <li>Numbered lists</li>
<li>Bulleted lists</li> <li>To-do lists</li>
<li>Numbered lists</li> </ul>
<li>To-do lists</li> </td>
</ul> </tr>
</td> <tr>
</tr> <td><a class="reference-link" href="#root/_help_NwBbFdNZ9h7O">Block quotes &amp; admonitions</a>
<tr> </td>
<td><a class="reference-link" href="#root/_help_NwBbFdNZ9h7O">Block quotes &amp; admonitions</a> <td>
</td> <ul>
<td> <li>Block quotes</li>
<ul> <li>Admonitions</li>
<li>Block quotes</li> </ul>
<li>Admonitions</li> </td>
</ul> </tr>
</td> <tr>
</tr> <td><a class="reference-link" href="#root/_help_NdowYOC1GFKS">Tables</a>
<tr> </td>
<td><a class="reference-link" href="#root/_help_NdowYOC1GFKS">Tables</a> <td>
</td> <ul>
<td> <li>Basic tables</li>
<ul> <li>Merging cells</li>
<li>Basic tables</li> <li>Styling tables and cells.</li>
<li>Merging cells</li> <li>Table captions</li>
<li>Styling tables and cells.</li> </ul>
<li>Table captions</li> </td>
</ul> </tr>
</td> <tr>
</tr> <td><a class="reference-link" href="#root/_help_UYuUB1ZekNQU">Developer-specific formatting</a>
<tr> </td>
<td><a class="reference-link" href="#root/_help_UYuUB1ZekNQU">Developer-specific formatting</a> <td>
</td> <ul>
<td> <li>Inline code</li>
<ul> <li>Code blocks</li>
<li>Inline code</li> <li>Keyboard shortcuts</li>
<li>Code blocks</li> </ul>
<li>Keyboard shortcuts</li> </td>
</ul> </tr>
</td> <tr>
</tr> <td><a class="reference-link" href="#root/_help_AgjCISero73a">Footnotes</a>
<tr> </td>
<td><a class="reference-link" href="#root/_help_AgjCISero73a">Footnotes</a> <td>
</td> <ul>
<td> <li>Footnotes</li>
<ul> </ul>
<li>Footnotes</li> </td>
</ul> </tr>
</td> <tr>
</tr> <td><a class="reference-link" href="#root/_help_mT0HEkOsz6i1">Images</a>
<tr> </td>
<td><a class="reference-link" href="#root/_help_mT0HEkOsz6i1">Images</a> <td>
</td> <ul>
<td> <li>Images</li>
<ul> </ul>
<li>Images</li> </td>
</ul> </tr>
</td> <tr>
</tr> <td><a class="reference-link" href="#root/_help_QEAPj01N5f7w">Links</a>
<tr> </td>
<td><a class="reference-link" href="#root/_help_QEAPj01N5f7w">Links</a> <td>
</td> <ul>
<td> <li>External links</li>
<ul> <li>Internal Trilium links</li>
<li>External links</li> </ul>
<li>Internal Trilium links</li> </td>
</ul> </tr>
</td> <tr>
</tr> <td><a class="reference-link" href="#root/_help_nBAXQFj20hS1">Include Note</a>
<tr> </td>
<td><a class="reference-link" href="#root/_help_nBAXQFj20hS1">Include Note</a> <td>
</td> <ul>
<td> <li>Include note</li>
<ul> </ul>
<li>Include note</li> </td>
</ul> </tr>
</td> <tr>
</tr> <td><a class="reference-link" href="#root/_help_CohkqWQC1iBv">Insert buttons</a>
<tr> </td>
<td><a class="reference-link" href="#root/_help_CohkqWQC1iBv">Insert buttons</a> <td>
</td> <ul>
<td> <li>Symbols</li>
<ul> <li><a class="reference-link" href="#root/_help_YfYAtQBcfo5V">Math Equations</a>
<li>Symbols</li> </li>
<li><a class="reference-link" href="#root/_help_YfYAtQBcfo5V">Math Equations</a> <li>Mermaid diagrams</li>
</li> <li>Horizontal ruler</li>
<li>Mermaid diagrams</li> <li>Page break</li>
<li>Horizontal ruler</li> </ul>
<li>Page break</li> </td>
</ul> </tr>
</td> <tr>
</tr> <td><a class="reference-link" href="#root/_help_dEHYtoWWi8ct">Other features</a>
<tr> </td>
<td><a class="reference-link" href="#root/_help_dEHYtoWWi8ct">Other features</a> <td>
</td> <ul>
<td> <li>Indentation
<ul> <ul>
<li>Indentation <li>Markdown import</li>
<ul> </ul>
<li>Markdown import</li> </li>
</ul> <li><a class="reference-link" href="#root/_help_2x0ZAX9ePtzV">Cut to subnote</a>
</li> </li>
<li><a class="reference-link" href="#root/_help_2x0ZAX9ePtzV">Cut to subnote</a> </ul>
</li> </td>
</ul> </tr>
</td> <tr>
</tr> <td><a class="reference-link" href="#root/_help_gLt3vA97tMcp">Premium features</a>
<tr> </td>
<td><a class="reference-link" href="#root/_help_gLt3vA97tMcp">Premium features</a> <td>
</td> <ul>
<td> <li><a class="reference-link" href="#root/_help_ZlN4nump6EbW">Slash Commands</a>
<ul> </li>
<li><a class="reference-link" href="#root/_help_ZlN4nump6EbW">Slash Commands</a> <li><a class="reference-link" href="#root/_help_KC1HB96bqqHX">Templates</a>
</li> </li>
<li><a class="reference-link" href="#root/_help_KC1HB96bqqHX">Templates</a> </ul>
</li> </td>
</ul> </tr>
</td> </tbody>
</tr> </table>
</tbody>
</table>
</figure>
<h2>Read-Only vs. Editing Mode</h2> <h2>Read-Only vs. Editing Mode</h2>
<p>Text notes are usually opened in edit mode. However, they may open in <p>Text notes are usually opened in edit mode. However, they may open in
read-only mode if the note is too big or the note is explicitly marked read-only mode if the note is too big or the note is explicitly marked
as read-only. For more information, see&nbsp;<a class="reference-link" as read-only. For more information, see&nbsp;<a class="reference-link"
href="#root/_help_CoFPLs3dRlXc">Read-Only Notes</a>.</p> href="#root/_help_CoFPLs3dRlXc">Read-Only Notes</a>.</p>
<h2>Keyboard shortcuts</h2> <h2>Keyboard shortcuts</h2>
<p>There are numerous keyboard shortcuts to format the text without having <p>There are numerous keyboard shortcuts to format the text without having
to use the mouse. For a reference of all the key combinations, see&nbsp; to use the mouse. For a reference of all the key combinations, see&nbsp;
<a <a
class="reference-link" href="#root/_help_A9Oc6YKKc65v">Keyboard Shortcuts</a>. In addition, see&nbsp;<a class="reference-link" class="reference-link" href="#root/_help_A9Oc6YKKc65v">Keyboard Shortcuts</a>. In addition, see&nbsp;<a class="reference-link"
href="#root/_help_QrtTYPmdd1qq">Markdown-like formatting</a>&nbsp;as an href="#root/_help_QrtTYPmdd1qq">Markdown-like formatting</a>&nbsp;as an
alternative to the keyboard shortcuts.</p> alternative to the keyboard shortcuts.</p>
<h2>Technical details</h2> <h2>Technical details</h2>
<p>For the text editing functionality, Trilium uses a commercial product <p>For the text editing functionality, Trilium uses a commercial product
(with an open-source base) called&nbsp;<a class="reference-link" href="#root/_help_MI26XDLSAlCD">CKEditor</a>. (with an open-source base) called&nbsp;<a class="reference-link" href="#root/_help_MI26XDLSAlCD">CKEditor</a>.
This brings the benefit of having a powerful WYSIWYG (What You See Is What This brings the benefit of having a powerful WYSIWYG (What You See Is What
You Get) editor.</p> You Get) editor.</p>

View File

@@ -24,83 +24,80 @@
</p> </p>
<h3>Alignment</h3> <h3>Alignment</h3>
<p>The first set of options configure the alignment are, in order:</p> <p>The first set of options configure the alignment are, in order:</p>
<figure <table>
class="table"> <thead>
<table> <tr>
<thead> <th>Icon</th>
<tr> <th>Option</th>
<th>Icon</th> <th>Preview</th>
<th>Option</th> <th>Description</th>
<th>Preview</th> </tr>
<th>Description</th> </thead>
</tr> <tbody>
</thead> <tr>
<tbody> <td>
<tr> <img src="5_Images_image.png">
<td> </td>
<img src="5_Images_image.png"> <td>Inline</td>
</td> <td>
<td>Inline</td> <img src="1_Images_image.png">
<td> </td>
<img src="1_Images_image.png"> <td>As the name suggests, the name can be put inside a paragraph and moved
</td> around similarly as if it was a block of text. Use drag &amp; drop or cut-paste
<td>As the name suggests, the name can be put inside a paragraph and moved to move it around.</td>
around similarly as if it was a block of text. Use drag &amp; drop or cut-paste </tr>
to move it around.</td> <tr>
</tr> <td>
<tr> <img src="10_Images_image.png">
<td> </td>
<img src="10_Images_image.png"> <td>Centered image</td>
</td> <td>
<td>Centered image</td> <img src="2_Images_image.png">
<td> </td>
<img src="2_Images_image.png"> <td>The image will be displayed as a block and centered, not allowing text
</td> in either the left or right of it.</td>
<td>The image will be displayed as a block and centered, not allowing text </tr>
in either the left or right of it.</td> <tr>
</tr> <td>
<tr> <img src="4_Images_image.png">
<td> </td>
<img src="4_Images_image.png"> <td>Wrap text</td>
</td> <td>
<td>Wrap text</td> <img src="7_Images_image.png">
<td> </td>
<img src="7_Images_image.png"> <td>The image will be displayed to the left or the right of the text.</td>
</td> </tr>
<td>The image will be displayed to the left or the right of the text.</td> <tr>
</tr> <td>
<tr> <img src="Images_image.png">
<td> </td>
<img src="Images_image.png"> <td>Block align</td>
</td> <td>
<td>Block align</td> <img src="3_Images_image.png">
<td> </td>
<img src="3_Images_image.png"> <td>Similarly to <em>Centered image</em>, the image will be displayed as a
</td> block and aligned either to the left or to the right, but not allowing
<td>Similarly to <em>Centered image</em>, the image will be displayed as a text to flow on either of its sides.</td>
block and aligned either to the left or to the right, but not allowing </tr>
text to flow on either of its sides.</td> </tbody>
</tr> </table>
</tbody>
</table>
</figure>
<h2>Compression</h2> <h2>Compression</h2>
<p>Since Trilium isn't really meant to be primary storage for image data, <p>Since Trilium isn't really meant to be primary storage for image data,
it attempts to compress and resize (with pretty aggressive settings) uploaded it attempts to compress and resize (with pretty aggressive settings) uploaded
images before storing them to the database. You may then notice some quality images before storing them to the database. You may then notice some quality
degradation. Basic quality settings is available in&nbsp;<a class="reference-link" degradation. Basic quality settings is available in&nbsp;<a class="reference-link"
href="#root/_help_4TIF1oA4VQRO">Options</a>&nbsp;→ Other.</p> href="#root/_help_4TIF1oA4VQRO">Options</a>&nbsp;→ Other.</p>
<p>If you want to save images in their original resolution, it is recommended <p>If you want to save images in their original resolution, it is recommended
to save them as attachment to note (look for the contextual menu in&nbsp; to save them as attachment to note (look for the contextual menu in&nbsp;
<a <a
class="reference-link" href="#root/_help_8YBEPzcpUgxw">Note buttons</a>&nbsp;<em>Import files</em>).</p> class="reference-link" href="#root/_help_8YBEPzcpUgxw">Note buttons</a>&nbsp;<em>Import files</em>).</p>
<h2>Aligning images side-by-side</h2> <h2>Aligning images side-by-side</h2>
<p>There are generally two ways to display images side by side:</p> <p>There are generally two ways to display images side by side:</p>
<ul> <ul>
<li>If they are roughly the same size, simply make the two images in-line, <li>If they are roughly the same size, simply make the two images in-line,
according to the alignment section above. The images can be dragged &amp; according to the alignment section above. The images can be dragged &amp;
dropped onto the same line.</li> dropped onto the same line.</li>
<li>If they are on different size, create a <a href="#root/_help_NdowYOC1GFKS">table</a> with <li>If they are on different size, create a <a href="#root/_help_NdowYOC1GFKS">table</a> with
invisible borders.</li> invisible borders.</li>
</ul> </ul>

View File

@@ -1,107 +1,111 @@
<h2>Trilium-specific shortcuts</h2> <h2>Trilium-specific shortcuts</h2>
<figure class="table"> <table>
<table> <thead>
<thead> <tr>
<tr> <th>Action</th>
<th>Action</th> <th>PC</th>
<th>PC</th> <th>Mac</th>
<th>Mac</th> </tr>
</tr> </thead>
</thead> <tbody>
<tbody> <tr>
<tr> <td>Bring up inline formatting toolbar (arrow keys <kbd><span></span></kbd>,<kbd><span></span></kbd> to
<td>Bring up inline formatting toolbar (arrow keys <kbd><span></span></kbd>,<kbd><span></span></kbd> to navigate, <kbd>Enter</kbd> to apply)</td>
navigate, <kbd>Enter</kbd> to apply)</td> <td><kbd>Alt</kbd>+<kbd>F10</kbd>
<td><kbd>Alt</kbd>+<kbd>F10</kbd> </td>
</td> <td><kbd></kbd>+<kbd>F10</kbd>
<td><kbd></kbd>+<kbd>F10</kbd> </td>
</td> </tr>
</tr> <tr>
<tr> <td>Bring up block formatting toolbar</td>
<td>Bring up block formatting toolbar</td> <td><kbd>Alt</kbd>+<kbd>F10</kbd>
<td><kbd>Alt</kbd>+<kbd>F10</kbd> </td>
</td> <td><kbd></kbd>+<kbd>F10</kbd>
<td><kbd></kbd>+<kbd>F10</kbd> </td>
</td> </tr>
</tr> <tr>
<tr> <td>Create <a href="#root/_help_QEAPj01N5f7w">external link</a>
<td>Create <a href="#root/_help_QEAPj01N5f7w">external link</a> </td>
</td> <td><kbd>Ctrl</kbd>+<kbd>K</kbd>
<td><kbd>Ctrl</kbd>+<kbd>K</kbd> </td>
</td> <td><kbd></kbd>+<kbd>K</kbd>
<td><kbd></kbd>+<kbd>K</kbd> </td>
</td> </tr>
</tr> <tr>
<tr> <td>Create <a href="#root/_help_QEAPj01N5f7w">internal (note) link</a>
<td>Create <a href="#root/_help_QEAPj01N5f7w">internal (note) link</a> </td>
</td> <td><kbd>Ctrl</kbd>+<kbd>L</kbd>
<td><kbd>Ctrl</kbd>+<kbd>L</kbd> </td>
</td> <td><kbd></kbd>+<kbd>L</kbd>
<td><kbd></kbd>+<kbd>L</kbd> </td>
</td> </tr>
</tr> <tr>
<tr> <td>Inserts current date and time at caret position</td>
<td>Inserts current date and time at caret position</td> <td><kbd>Alt</kbd>+<kbd>T</kbd>
<td><kbd>Alt</kbd>+<kbd>T</kbd>&nbsp;</td> </td>
<td><kbd></kbd>+<kbd>T</kbd>&nbsp;</td> <td><kbd></kbd>+<kbd>T</kbd>
</tr> </td>
<tr> </tr>
<td>Increase paragraph indentation</td> <tr>
<td><kbd>Tab</kbd> <td>Increase paragraph indentation</td>
</td> <td><kbd>Tab</kbd>
<td><kbd></kbd> </td>
</td> <td><kbd></kbd>
</tr> </td>
<tr> </tr>
<td>Decrease paragraph indentation</td> <tr>
<td><kbd>Shift</kbd> + <kbd>Tab</kbd> <td>Decrease paragraph indentation</td>
</td> <td><kbd>Shift</kbd> + <kbd>Tab</kbd>
<td><kbd></kbd> + <kbd></kbd> </td>
</td> <td><kbd></kbd> + <kbd></kbd>
</tr> </td>
<tr> </tr>
<td>Mark selected text as <a href="#root/_help_UYuUB1ZekNQU">keyboard shortcut</a> <tr>
</td> <td>Mark selected text as <a href="#root/_help_UYuUB1ZekNQU">keyboard shortcut</a>
<td><kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>K</kbd> </td>
</td> <td><kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>K</kbd>
<td><kbd></kbd>+ <kbd></kbd>+ <kbd>K</kbd> </td>
</td> <td><kbd></kbd>+ <kbd></kbd>+ <kbd>K</kbd>
</tr> </td>
<tr> </tr>
<td>Insert&nbsp;<a class="reference-link" href="#root/_help_YfYAtQBcfo5V">Math Equations</a> <tr>
</td> <td>Insert&nbsp;<a class="reference-link" href="#root/_help_YfYAtQBcfo5V">Math Equations</a>
<td><kbd>Ctrl</kbd> + <kbd>M</kbd> </td>
</td> <td><kbd>Ctrl</kbd> + <kbd>M</kbd>
<td><kbd></kbd>+ <kbd>M</kbd> </td>
</td> <td><kbd></kbd>+ <kbd>M</kbd>
</tr> </td>
<tr> </tr>
<td>Move blocks (lists, paragraphs, etc.) up</td> <tr>
<td><kbd>Ctrl</kbd>+<kbd></kbd>&nbsp;</td> <td>Move blocks (lists, paragraphs, etc.) up</td>
<td><kbd></kbd>+<kbd></kbd>&nbsp;</td> <td><kbd>Ctrl</kbd>+<kbd></kbd>
</tr> </td>
<tr> <td><kbd></kbd>+<kbd></kbd>
<td><kbd>Alt</kbd>+<kbd></kbd> </td>
</td> </tr>
<td><kbd></kbd>+<kbd></kbd> <tr>
</td> <td><kbd>Alt</kbd>+<kbd></kbd>
</tr> </td>
<tr> <td><kbd></kbd>+<kbd></kbd>
<td>Move blocks (lists, paragraphs, etc.) down</td> </td>
<td><kbd>Ctrl</kbd>+<kbd></kbd> <td></td>
</td> </tr>
<td><kbd></kbd>+<kbd></kbd> <tr>
</td> <td>Move blocks (lists, paragraphs, etc.) down</td>
</tr> <td><kbd>Ctrl</kbd>+<kbd></kbd>
<tr> </td>
<td><kbd>Alt</kbd>+<kbd></kbd> <td><kbd></kbd>+<kbd></kbd>
</td> </td>
<td><kbd></kbd>+<kbd></kbd> </tr>
</td> <tr>
</tr> <td><kbd>Alt</kbd>+<kbd></kbd>
</tbody> </td>
</table> <td><kbd></kbd>+<kbd></kbd>
</figure> </td>
<td></td>
</tr>
</tbody>
</table>
<h2>Common shortcuts</h2> <h2>Common shortcuts</h2>
<aside class="admonition tip"> <aside class="admonition tip">
@@ -113,331 +117,321 @@
(due to using a different configuration).</p> (due to using a different configuration).</p>
</aside> </aside>
<h3>Content editing</h3> <h3>Content editing</h3>
<figure class="table"> <table>
<table> <thead>
<thead> <tr>
<tr> <th>Action</th>
<th>Action</th> <th>PC</th>
<th>PC</th> <th>Mac</th>
<th>Mac</th> </tr>
</tr> </thead>
</thead> <tbody>
<tbody> <tr>
<tr> <td>Insert a hard break (a new paragraph)</td>
<td>Insert a hard break (a new paragraph)</td> <td><kbd>Enter</kbd>
<td><kbd>Enter</kbd> </td>
</td> <td></td>
<td>&nbsp;</td> </tr>
</tr> <tr>
<tr> <td>Insert a soft break (a <code>&lt;br&gt;</code> element)</td>
<td>Insert a soft break (a <code>&lt;br&gt;</code> element)</td> <td><kbd>Shift</kbd>+<kbd>Enter</kbd>
<td><kbd>Shift</kbd>+<kbd>Enter</kbd> </td>
</td> <td><kbd>⇧Enter</kbd>
<td><kbd>⇧Enter</kbd> </td>
</td> </tr>
</tr> <tr>
<tr> <td>Copy selected content</td>
<td>Copy selected content</td> <td><kbd>Ctrl</kbd>+<kbd>C</kbd>
<td><kbd>Ctrl</kbd>+<kbd>C</kbd> </td>
</td> <td><kbd>⌘C</kbd>
<td><kbd>⌘C</kbd> </td>
</td> </tr>
</tr> <tr>
<tr> <td>Paste content</td>
<td>Paste content</td> <td><kbd>Ctrl</kbd>+<kbd>V</kbd>
<td><kbd>Ctrl</kbd>+<kbd>V</kbd> </td>
</td> <td><kbd>⌘V</kbd>
<td><kbd>⌘V</kbd> </td>
</td> </tr>
</tr> <tr>
<tr> <td>Paste content as plain text</td>
<td>Paste content as plain text</td> <td><kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>V</kbd>
<td><kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>V</kbd> </td>
</td> <td><kbd>⌘⇧V</kbd>
<td><kbd>⌘⇧V</kbd> </td>
</td> </tr>
</tr> <tr>
<tr> <td>Undo</td>
<td>Undo</td> <td><kbd>Ctrl</kbd>+<kbd>Z</kbd>
<td><kbd>Ctrl</kbd>+<kbd>Z</kbd> </td>
</td> <td><kbd>⌘Z</kbd>
<td><kbd>⌘Z</kbd> </td>
</td> </tr>
</tr> <tr>
<tr> <td>Redo</td>
<td>Redo</td> <td><kbd>Ctrl</kbd>+<kbd>Y</kbd>, <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Z</kbd>
<td><kbd>Ctrl</kbd>+<kbd>Y</kbd>, <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Z</kbd> </td>
</td> <td><kbd>⌘Y</kbd>, <kbd>⌘⇧Z</kbd>
<td><kbd>⌘Y</kbd>, <kbd>⌘⇧Z</kbd> </td>
</td> </tr>
</tr> <tr>
<tr> <td>Bold text</td>
<td>Bold text</td> <td><kbd>Ctrl</kbd>+<kbd>B</kbd>
<td><kbd>Ctrl</kbd>+<kbd>B</kbd> </td>
</td> <td><kbd>⌘B</kbd>
<td><kbd>⌘B</kbd> </td>
</td> </tr>
</tr> <tr>
<tr> <td>Change text case</td>
<td>Change text case</td> <td><kbd>Shift</kbd>+<kbd>F3</kbd>
<td><kbd>Shift</kbd>+<kbd>F3</kbd> </td>
</td> <td><kbd>⇧F3</kbd> (may require <kbd>Fn</kbd>)</td>
<td><kbd>⇧F3</kbd> (may require <kbd>Fn</kbd>)</td> </tr>
</tr> <tr>
<tr> <td>Create link</td>
<td>Create link</td> <td><kbd>Ctrl</kbd>+<kbd>K</kbd>
<td><kbd>Ctrl</kbd>+<kbd>K</kbd> </td>
</td> <td><kbd>⌘K</kbd>
<td><kbd>⌘K</kbd> </td>
</td> </tr>
</tr> <tr>
<tr> <td>Move out of a link</td>
<td>Move out of a link</td> <td><kbd>←←</kbd>, <kbd>→→</kbd>
<td><kbd>←←</kbd>, <kbd>→→</kbd> </td>
</td> <td></td>
<td>&nbsp;</td> </tr>
</tr> <tr>
<tr> <td>Move out of an inline code style</td>
<td>Move out of an inline code style</td> <td><kbd>←←</kbd>, <kbd>→→</kbd>
<td><kbd>←←</kbd>, <kbd>→→</kbd> </td>
</td> <td></td>
<td>&nbsp;</td> </tr>
</tr> <tr>
<tr> <td>Select all</td>
<td>Select all</td> <td><kbd>Ctrl</kbd>+<kbd>A</kbd>
<td><kbd>Ctrl</kbd>+<kbd>A</kbd> </td>
</td> <td><kbd>⌘A</kbd>
<td><kbd>⌘A</kbd> </td>
</td> </tr>
</tr> <tr>
<tr> <td>Find in the document</td>
<td>Find in the document</td> <td><kbd>Ctrl</kbd>+<kbd>F</kbd>
<td><kbd>Ctrl</kbd>+<kbd>F</kbd> </td>
</td> <td><kbd>⌘F</kbd>
<td><kbd>⌘F</kbd> </td>
</td> </tr>
</tr> <tr>
<tr> <td>Copy text formatting</td>
<td>Copy text formatting</td> <td><kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>C</kbd>
<td><kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>C</kbd> </td>
</td> <td><kbd>⌘⇧C</kbd>
<td><kbd>⌘⇧C</kbd> </td>
</td> </tr>
</tr> <tr>
<tr> <td>Paste text formatting</td>
<td>Paste text formatting</td> <td><kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>V</kbd>
<td><kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>V</kbd> </td>
</td> <td><kbd>⌘⇧V</kbd>
<td><kbd>⌘⇧V</kbd> </td>
</td> </tr>
</tr> <tr>
<tr> <td>Italic text</td>
<td>Italic text</td> <td><kbd>Ctrl</kbd>+<kbd>I</kbd>
<td><kbd>Ctrl</kbd>+<kbd>I</kbd> </td>
</td> <td><kbd>⌘I</kbd>
<td><kbd>⌘I</kbd> </td>
</td> </tr>
</tr> <tr>
<tr> <td>Strikethrough text</td>
<td>Strikethrough text</td> <td><kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>X</kbd>
<td><kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>X</kbd> </td>
</td> <td><kbd>⌘⇧X</kbd>
<td><kbd>⌘⇧X</kbd> </td>
</td> </tr>
</tr> <tr>
<tr> <td>Underline text</td>
<td>Underline text</td> <td><kbd>Ctrl</kbd>+<kbd>U</kbd>
<td><kbd>Ctrl</kbd>+<kbd>U</kbd> </td>
</td> <td><kbd>⌘U</kbd>
<td><kbd>⌘U</kbd> </td>
</td> </tr>
</tr> <tr>
<tr> <td>Revert autoformatting action</td>
<td>Revert autoformatting action</td> <td><kbd>Backspace</kbd>
<td><kbd>Backspace</kbd> </td>
</td> <td></td>
<td>&nbsp;</td> </tr>
</tr> </tbody>
</tbody> </table>
</table>
</figure>
<h3>Interacting with blocks</h3> <h3>Interacting with blocks</h3>
<p>Blocks are images, tables, blockquotes, annotations.</p> <p>Blocks are images, tables, blockquotes, annotations.</p>
<figure class="table"> <table>
<table> <thead>
<thead> <tr>
<tr> <th>Action</th>
<th>Action</th> <th>PC</th>
<th>PC</th> <th>Mac</th>
<th>Mac</th> </tr>
</tr> </thead>
</thead> <tbody>
<tbody> <tr>
<tr> <td>Insert a new paragraph directly after a widget</td>
<td>Insert a new paragraph directly after a widget</td> <td><kbd>Enter</kbd>
<td><kbd>Enter</kbd> </td>
</td> <td></td>
<td>&nbsp;</td> </tr>
</tr> <tr>
<tr> <td>Insert a new paragraph directly before a widget</td>
<td>Insert a new paragraph directly before a widget</td> <td><kbd>Shift</kbd>+<kbd>Enter</kbd>
<td><kbd>Shift</kbd>+<kbd>Enter</kbd> </td>
</td> <td><kbd>⇧Enter</kbd>
<td><kbd>⇧Enter</kbd> </td>
</td> </tr>
</tr> <tr>
<tr> <td>Move the caret to allow typing directly before a widget</td>
<td>Move the caret to allow typing directly before a widget</td> <td><kbd></kbd>, <kbd></kbd>
<td><kbd></kbd>, <kbd></kbd> </td>
</td> <td></td>
<td>&nbsp;</td> </tr>
</tr> <tr>
<tr> <td>Move the caret to allow typing directly after a widget</td>
<td>Move the caret to allow typing directly after a widget</td> <td><kbd></kbd>, <kbd></kbd>
<td><kbd></kbd>, <kbd></kbd> </td>
</td> <td></td>
<td>&nbsp;</td> </tr>
</tr> <tr>
<tr> <td>After entering a nested editable, move the selection to the closest ancestor
<td>After entering a nested editable, move the selection to the closest ancestor widget. For example: move from an image caption to the whole image widget.</td>
widget. For example: move from an image caption to the whole image widget.</td> <td><kbd>Tab</kbd> then <kbd>Esc</kbd>
<td><kbd>Tab</kbd> then <kbd>Esc</kbd> </td>
</td> <td></td>
<td>&nbsp;</td> </tr>
</tr> </tbody>
</tbody> </table>
</table>
</figure>
<p>Specifically for lists:</p> <p>Specifically for lists:</p>
<figure class="table"> <table>
<table> <thead>
<thead> <tr>
<tr> <th>Action</th>
<th>Action</th> <th>PC</th>
<th>PC</th> <th>Mac</th>
<th>Mac</th> </tr>
</tr> </thead>
</thead> <tbody>
<tbody> <tr>
<tr> <td>Increase list item indent</td>
<td>Increase list item indent</td> <td><kbd></kbd>
<td><kbd></kbd> </td>
</td> <td></td>
<td>&nbsp;</td> </tr>
</tr> <tr>
<tr> <td>Decrease list item indent</td>
<td>Decrease list item indent</td> <td><kbd>Shift</kbd>+<kbd></kbd>
<td><kbd>Shift</kbd>+<kbd></kbd> </td>
</td> <td><kbd>⇧⇥</kbd>
<td><kbd>⇧⇥</kbd> </td>
</td> </tr>
</tr> </tbody>
</tbody> </table>
</table>
</figure>
<p>In tables:</p> <p>In tables:</p>
<figure class="table"> <table>
<table> <thead>
<thead> <tr>
<tr> <th>Action</th>
<th>Action</th> <th>PC</th>
<th>PC</th> <th>Mac</th>
<th>Mac</th> </tr>
</tr> </thead>
</thead> <tbody>
<tbody> <tr>
<tr> <td>Move the selection to the next cell</td>
<td>Move the selection to the next cell</td> <td><kbd></kbd>
<td><kbd></kbd> </td>
</td> <td></td>
<td>&nbsp;</td> </tr>
</tr> <tr>
<tr> <td>Move the selection to the previous cell</td>
<td>Move the selection to the previous cell</td> <td><kbd>Shift</kbd>+<kbd></kbd>
<td><kbd>Shift</kbd>+<kbd></kbd> </td>
</td> <td><kbd>⇧⇥</kbd>
<td><kbd>⇧⇥</kbd> </td>
</td> </tr>
</tr> <tr>
<tr> <td>Insert a new table row (when in the last cell of a table)</td>
<td>Insert a new table row (when in the last cell of a table)</td> <td><kbd></kbd>
<td><kbd></kbd> </td>
</td> <td></td>
<td>&nbsp;</td> </tr>
</tr> <tr>
<tr> <td>Navigate through the table</td>
<td>Navigate through the table</td> <td><kbd></kbd>, <kbd></kbd>, <kbd></kbd>, <kbd></kbd>
<td><kbd></kbd>, <kbd></kbd>, <kbd></kbd>, <kbd></kbd> </td>
</td> <td></td>
<td>&nbsp;</td> </tr>
</tr> </tbody>
</tbody> </table>
</table>
</figure>
<h3>General UI shortcuts</h3> <h3>General UI shortcuts</h3>
<figure class="table"> <table>
<table> <thead>
<thead> <tr>
<tr> <th>Action</th>
<th>Action</th> <th>PC</th>
<th>PC</th> <th>Mac</th>
<th>Mac</th> </tr>
</tr> </thead>
</thead> <tbody>
<tbody> <tr>
<tr> <td>Close contextual balloons, dropdowns, and dialogs</td>
<td>Close contextual balloons, dropdowns, and dialogs</td> <td><kbd>Esc</kbd>
<td><kbd>Esc</kbd> </td>
</td> <td></td>
<td>&nbsp;</td> </tr>
</tr> <tr>
<tr> <td>Open the accessibility help dialog</td>
<td>Open the accessibility help dialog</td> <td><kbd>Alt</kbd>+<kbd>0</kbd>
<td><kbd>Alt</kbd>+<kbd>0</kbd> </td>
</td> <td><kbd>⌥0</kbd>
<td><kbd>⌥0</kbd> </td>
</td> </tr>
</tr> <tr>
<tr> <td>Move focus between form fields (inputs, buttons, etc.)</td>
<td>Move focus between form fields (inputs, buttons, etc.)</td> <td><kbd></kbd>, <kbd>Shift</kbd>+<kbd></kbd>
<td><kbd></kbd>, <kbd>Shift</kbd>+<kbd></kbd> </td>
</td> <td><kbd></kbd>, <kbd>⇧⇥</kbd>
<td><kbd></kbd>, <kbd>⇧⇥</kbd> </td>
</td> </tr>
</tr> <tr>
<tr> <td>Move focus to the toolbar, navigate between toolbars</td>
<td>Move focus to the toolbar, navigate between toolbars</td> <td><kbd>Alt</kbd>+<kbd>F10</kbd>
<td><kbd>Alt</kbd>+<kbd>F10</kbd> </td>
</td> <td><kbd>⌥F10</kbd> (may require <kbd>Fn</kbd>)</td>
<td><kbd>⌥F10</kbd> (may require <kbd>Fn</kbd>)</td> </tr>
</tr> <tr>
<tr> <td>Navigate through the toolbar or menu bar</td>
<td>Navigate through the toolbar or menu bar</td> <td><kbd></kbd>, <kbd></kbd>, <kbd></kbd>, <kbd></kbd>
<td><kbd></kbd>, <kbd></kbd>, <kbd></kbd>, <kbd></kbd> </td>
</td> <td></td>
<td>&nbsp;</td> </tr>
</tr> <tr>
<tr> <td>Navigate to the next focusable field or an element outside the editor</td>
<td>Navigate to the next focusable field or an element outside the editor</td> <td><kbd>Tab</kbd>, <kbd>Shift</kbd>+<kbd>Tab</kbd>
<td><kbd>Tab</kbd>, <kbd>Shift</kbd>+<kbd>Tab</kbd> </td>
</td> <td></td>
<td>&nbsp;</td> </tr>
</tr> <tr>
<tr> <td>Execute the currently focused button. Executing buttons that interact
<td>Execute the currently focused button. Executing buttons that interact with the editor content moves the focus back to the content.</td>
with the editor content moves the focus back to the content.</td> <td><kbd>Enter</kbd>, <kbd>Space</kbd>
<td><kbd>Enter</kbd>, <kbd>Space</kbd> </td>
</td> <td></td>
<td>&nbsp;</td> </tr>
</tr> <tr>
<tr> <td>Move focus in and out of an active dialog window</td>
<td>Move focus in and out of an active dialog window</td> <td><kbd>Ctrl</kbd>+<kbd>F6</kbd>
<td><kbd>Ctrl</kbd>+<kbd>F6</kbd> </td>
</td> <td><kbd>⌘F6</kbd> (may require <kbd>Fn</kbd>)</td>
<td><kbd>⌘F6</kbd> (may require <kbd>Fn</kbd>)</td> </tr>
</tr> </tbody>
</tbody> </table>
</table>
</figure>

View File

@@ -37,62 +37,62 @@
<h2>Headings, code blocks within lists</h2> <h2>Headings, code blocks within lists</h2>
<p>It possible to add content-level blocks such as headings, code blocks, <p>It possible to add content-level blocks such as headings, code blocks,
tables within lists, as follows:</p> tables within lists, as follows:</p>
<figure class="table" style="width:100%;"> <table>
<table class="ck-table-resized"> <thead>
<colgroup> <tr>
<col style="width:4.79%;"> <th></th>
<col style="width:57.19%;"> <th></th>
<col style="width:38.02%;"> <th></th>
</colgroup> </tr>
<tbody> </thead>
<tr> <tbody>
<th>1</th> <tr>
<td> <td>1</td>
<img src="6_Lists_image.png"> <td>
</td> <img src="6_Lists_image.png">
<td>First, create a list.</td> </td>
</tr> <td>First, create a list.</td>
<tr> </tr>
<th>2</th> <tr>
<td> <td>2</td>
<img src="4_Lists_image.png"> <td>
</td> <img src="4_Lists_image.png">
<td>Press Enter to create a new list item.</td> </td>
</tr> <td>Press Enter to create a new list item.</td>
<tr> </tr>
<th>3</th> <tr>
<td> <td>3</td>
<img src="5_Lists_image.png"> <td>
</td> <img src="5_Lists_image.png">
<td>Press Backspace to get rid of the bullet point. Notice the cursor position.</td> </td>
</tr> <td>Press Backspace to get rid of the bullet point. Notice the cursor position.</td>
<tr> </tr>
<th>4</th> <tr>
<td> <td>4</td>
<img class="image_resized" style="aspect-ratio:676/112;width:98.29%;" <td>
src="1_Lists_image.png" width="676" height="112"> <img class="image_resized" style="aspect-ratio:676/112;width:98.29%;"
</td> src="1_Lists_image.png" width="676" height="112">
<td>At this point, insert any desired block-level item such as a code block.</td> </td>
</tr> <td>At this point, insert any desired block-level item such as a code block.</td>
<tr> </tr>
<th>5</th> <tr>
<td> <td>5</td>
<img class="image_resized" style="aspect-ratio:675/129;width:94.22%;" <td>
src="Lists_image.png" width="675" height="129"> <img class="image_resized" style="aspect-ratio:675/129;width:94.22%;"
</td> src="Lists_image.png" width="675" height="129">
<td>To continue with a new bullet point, press Enter until the cursor moves </td>
to a new blank position.</td> <td>To continue with a new bullet point, press Enter until the cursor moves
</tr> to a new blank position.</td>
<tr> </tr>
<th>6</th> <tr>
<td> <td>6</td>
<img class="image_resized" style="aspect-ratio:675/129;width:100%;" src="3_Lists_image.png" <td>
width="675" height="129"> <img class="image_resized" style="aspect-ratio:675/129;width:100%;" src="3_Lists_image.png"
</td> width="675" height="129">
<td>Press Enter once more to create the new bullet.</td> </td>
</tr> <td>Press Enter once more to create the new bullet.</td>
</tbody> </tr>
</table> </tbody>
</figure> </table>
<p>The same principle applies to all three list types (bullet, numbered and <p>The same principle applies to all three list types (bullet, numbered and
to-do).</p> to-do).</p>

View File

@@ -5,126 +5,122 @@
<p>Global events are attached to the script note via label. Simply create <p>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 e.g. "run" label with some of these values and script note will be executed
once the event occurs.</p> once the event occurs.</p>
<figure class="table"> <table>
<table> <thead>
<thead> <tr>
<tr> <th>Label</th>
<th>Label</th> <th>Description</th>
<th>Description</th> </tr>
</tr> </thead>
</thead> <tbody>
<tbody> <tr>
<tr> <td><code>run</code>
<td><code>run</code> </td>
</td> <td>
<td> <p>Defines on which events script should run. Possible values are:</p>
<p>Defines on which events script should run. Possible values are:</p> <ul>
<ul> <li><code>frontendStartup</code> - when Trilium frontend starts up (or is refreshed),
<li><code>frontendStartup</code> - when Trilium frontend starts up (or is refreshed), but not on mobile.</li>
but not on mobile.</li> <li><code>mobileStartup</code> - when Trilium frontend starts up (or is refreshed),
<li><code>mobileStartup</code> - when Trilium frontend starts up (or is refreshed), on mobile.</li>
on mobile.</li> <li><code>backendStartup</code> - when Trilium backend starts up</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
<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>
specify at which hour, on the back-end.</li> <li><code>daily</code> - run once a day, on the back-end</li>
<li><code>daily</code> - run once a day, on the back-end</li> </ul>
</ul> </td>
</td> </tr>
</tr> <tr>
<tr> <td><code>runOnInstance</code>
<td><code>runOnInstance</code> </td>
</td> <td>Specifies that the script should only run on a particular&nbsp;<a class="reference-link"
<td>Specifies that the script should only run on a particular&nbsp;<a class="reference-link" href="#root/_help_c5xB8m4g2IY6">Trilium instance</a>.</td>
href="#root/_help_c5xB8m4g2IY6">Trilium instance</a>.</td> </tr>
</tr> <tr>
<tr> <td><code>runAtHour</code>
<td><code>runAtHour</code> </td>
</td> <td>On which hour should this run. Should be used together with <code>#run=hourly</code>.
<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>
Can be defined multiple times for more runs during the day.</td> </tr>
</tr> </tbody>
</tbody> </table>
</table>
</figure>
<h2>Entity events</h2> <h2>Entity events</h2>
<p>Other events are bound to some entity, these are defined as <a href="#root/_help_zEY4DaJG4YT5">relations</a> - <p>Other events are bound to some entity, these are defined as <a href="#root/_help_zEY4DaJG4YT5">relations</a> -
meaning that script is triggered only if note has this script attached meaning that script is triggered only if note has this script attached
to it through relations (or it can inherit it).</p> to it through relations (or it can inherit it).</p>
<figure class="table"> <table>
<table> <thead>
<thead> <tr>
<tr> <th>Relation</th>
<th>Relation</th> <th>Description</th>
<th>Description</th> </tr>
</tr> </thead>
</thead> <tbody>
<tbody> <tr>
<tr> <td><code>runOnNoteCreation</code>
<td><code>runOnNoteCreation</code> </td>
</td> <td>executes when note is created on backend. Use this relation if you want
<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
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
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>
note created within the subtree (any depth) will trigger the script.</td> </tr>
</tr> <tr>
<tr> <td><code>runOnChildNoteCreation</code>
<td><code>runOnChildNoteCreation</code> </td>
</td> <td>executes when new note is created under the note where this relation is
<td>executes when new note is created under the note where this relation is defined</td>
defined</td> </tr>
</tr> <tr>
<tr> <td><code>runOnNoteTitleChange</code>
<td><code>runOnNoteTitleChange</code> </td>
</td> <td>executes when note title is changed (includes note creation as well)</td>
<td>executes when note title is changed (includes note creation as well)</td> </tr>
</tr> <tr>
<tr> <td><code>runOnNoteContentChange</code>
<td><code>runOnNoteContentChange</code> </td>
</td> <td>executes when note content is changed (includes note creation as well).</td>
<td>executes when note content is changed (includes note creation as well).</td> </tr>
</tr> <tr>
<tr> <td><code>runOnNoteChange</code>
<td><code>runOnNoteChange</code> </td>
</td> <td>executes when note is changed (includes note creation as well). Does not
<td>executes when note is changed (includes note creation as well). Does not include content changes</td>
include content changes</td> </tr>
</tr> <tr>
<tr> <td><code>runOnNoteDeletion</code>
<td><code>runOnNoteDeletion</code> </td>
</td> <td>executes when note is being deleted</td>
<td>executes when note is being deleted</td> </tr>
</tr> <tr>
<tr> <td><code>runOnBranchCreation</code>
<td><code>runOnBranchCreation</code> </td>
</td> <td>executes when a branch is created. Branch is a link between parent note
<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>
and child note and is created e.g. when cloning or moving note.</td> </tr>
</tr> <tr>
<tr> <td><code>runOnBranchChange</code>
<td><code>runOnBranchChange</code> </td>
</td> <td>executes when a branch is updated. (since v0.62)</td>
<td>executes when a branch is updated. (since v0.62)</td> </tr>
</tr> <tr>
<tr> <td><code>runOnBranchDeletion</code>
<td><code>runOnBranchDeletion</code> </td>
</td> <td>executes when a branch is deleted. Branch is a link between parent note
<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
and child note and is deleted e.g. when moving note (old branch/link is deleted).</td>
deleted).</td> </tr>
</tr> <tr>
<tr> <td><code>runOnAttributeCreation</code>
<td><code>runOnAttributeCreation</code> </td>
</td> <td>executes when new attribute is created for the note which defines this
<td>executes when new attribute is created for the note which defines this relation</td>
relation</td> </tr>
</tr> <tr>
<tr> <td><code>runOnAttributeChange</code>
<td><code>runOnAttributeChange</code> </td>
</td> <td>executes when the attribute is changed of a note which defines this relation.
<td>executes when the attribute is changed of a note which defines this relation. This is triggered also when the attribute is deleted</td>
This is triggered also when the attribute is deleted</td> </tr>
</tr> </tbody>
</tbody> </table>
</table>
</figure>

View File

@@ -37,105 +37,105 @@
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "2FvYrpmOXm29", "value": "ZjLYv08Rp3qC",
"isInheritable": false, "isInheritable": false,
"position": 10 "position": 10
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "ZjLYv08Rp3qC", "value": "R9pX4DGra2Vt",
"isInheritable": false, "isInheritable": false,
"position": 20 "position": 20
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "R9pX4DGra2Vt", "value": "LMAv4Uy3Wk6J",
"isInheritable": false, "isInheritable": false,
"position": 30 "position": 30
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "LMAv4Uy3Wk6J", "value": "NRnIZmSMc5sj",
"isInheritable": false, "isInheritable": false,
"position": 40 "position": 40
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "NRnIZmSMc5sj", "value": "rC3pL2aptaRE",
"isInheritable": false, "isInheritable": false,
"position": 50 "position": 50
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "rC3pL2aptaRE", "value": "GTwFsgaA0lCt",
"isInheritable": false, "isInheritable": false,
"position": 60 "position": 60
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "xWbu3jpNWapp", "value": "2FvYrpmOXm29",
"isInheritable": false, "isInheritable": false,
"position": 70 "position": 70
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "81SGnPGMk7Xc", "value": "iPIMuisry3hd",
"isInheritable": false, "isInheritable": false,
"position": 80 "position": 80
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "GTwFsgaA0lCt", "value": "ZlN4nump6EbW",
"isInheritable": false, "isInheritable": false,
"position": 90 "position": 90
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "iPIMuisry3hd", "value": "pwc194wlRzcH",
"isInheritable": false, "isInheritable": false,
"position": 100 "position": 100
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "ZlN4nump6EbW", "value": "7DAiwaf8Z7Rz",
"isInheritable": false, "isInheritable": false,
"position": 110 "position": 110
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "pwc194wlRzcH", "value": "veGu4faJErEM",
"isInheritable": false, "isInheritable": false,
"position": 120 "position": 120
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "7DAiwaf8Z7Rz", "value": "xWbu3jpNWapp",
"isInheritable": false, "isInheritable": false,
"position": 130 "position": 130
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "veGu4faJErEM", "value": "AgjCISero73a",
"isInheritable": false, "isInheritable": false,
"position": 140 "position": 140
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "AgjCISero73a", "value": "81SGnPGMk7Xc",
"isInheritable": false, "isInheritable": false,
"position": 150 "position": 150
}, },
@@ -2727,49 +2727,49 @@
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "81SGnPGMk7Xc", "value": "Cq5X6iKQop6R",
"isInheritable": false, "isInheritable": false,
"position": 20 "position": 20
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "xWbu3jpNWapp", "value": "hrZ1D00cLbal",
"isInheritable": false, "isInheritable": false,
"position": 30 "position": 30
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "2FvYrpmOXm29", "value": "iPIMuisry3hd",
"isInheritable": false, "isInheritable": false,
"position": 40 "position": 40
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "Cq5X6iKQop6R", "value": "GTwFsgaA0lCt",
"isInheritable": false, "isInheritable": false,
"position": 50 "position": 50
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "hrZ1D00cLbal", "value": "81SGnPGMk7Xc",
"isInheritable": false, "isInheritable": false,
"position": 60 "position": 60
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "iPIMuisry3hd", "value": "xWbu3jpNWapp",
"isInheritable": false, "isInheritable": false,
"position": 70 "position": 70
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "GTwFsgaA0lCt", "value": "2FvYrpmOXm29",
"isInheritable": false, "isInheritable": false,
"position": 80 "position": 80
}, },
@@ -3442,49 +3442,49 @@
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "81SGnPGMk7Xc", "value": "iPIMuisry3hd",
"isInheritable": false, "isInheritable": false,
"position": 20 "position": 20
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "iPIMuisry3hd", "value": "6f9hih2hXXZk",
"isInheritable": false, "isInheritable": false,
"position": 30 "position": 30
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "6f9hih2hXXZk", "value": "4TIF1oA4VQRO",
"isInheritable": false, "isInheritable": false,
"position": 40 "position": 40
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "4TIF1oA4VQRO", "value": "BlN9DFI679QC",
"isInheritable": false, "isInheritable": false,
"position": 50 "position": 50
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "BlN9DFI679QC", "value": "XpOYSgsLkTJy",
"isInheritable": false, "isInheritable": false,
"position": 60 "position": 60
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "XpOYSgsLkTJy", "value": "s1aBHPd79XYj",
"isInheritable": false, "isInheritable": false,
"position": 70 "position": 70
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "s1aBHPd79XYj", "value": "81SGnPGMk7Xc",
"isInheritable": false, "isInheritable": false,
"position": 80 "position": 80
}, },
@@ -8072,49 +8072,49 @@
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "0ESUbbAxVnoK", "value": "KSZ04uQ2D1St",
"isInheritable": false, "isInheritable": false,
"position": 10 "position": 10
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "IakOLONlIfGI", "value": "0ESUbbAxVnoK",
"isInheritable": false, "isInheritable": false,
"position": 20 "position": 20
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "ZjLYv08Rp3qC", "value": "XpOYSgsLkTJy",
"isInheritable": false, "isInheritable": false,
"position": 30 "position": 30
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "KSZ04uQ2D1St", "value": "oPVyFC7WL2Lp",
"isInheritable": false, "isInheritable": false,
"position": 40 "position": 40
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "XpOYSgsLkTJy", "value": "IakOLONlIfGI",
"isInheritable": false, "isInheritable": false,
"position": 50 "position": 50
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "oPVyFC7WL2Lp", "value": "lgKX7r3aL30x",
"isInheritable": false, "isInheritable": false,
"position": 60 "position": 60
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "lgKX7r3aL30x", "value": "ZjLYv08Rp3qC",
"isInheritable": false, "isInheritable": false,
"position": 70 "position": 70
}, },
@@ -8124,6 +8124,13 @@
"value": "bx bx-map-alt", "value": "bx bx-map-alt",
"isInheritable": false, "isInheritable": false,
"position": 10 "position": 10
},
{
"type": "relation",
"name": "internalLink",
"value": "BlN9DFI679QC",
"isInheritable": false,
"position": 80
} }
], ],
"format": "markdown", "format": "markdown",
@@ -8310,21 +8317,21 @@
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "0ESUbbAxVnoK", "value": "6f9hih2hXXZk",
"isInheritable": false, "isInheritable": false,
"position": 10 "position": 10
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "iPIMuisry3hd", "value": "0ESUbbAxVnoK",
"isInheritable": false, "isInheritable": false,
"position": 20 "position": 20
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "6f9hih2hXXZk", "value": "iPIMuisry3hd",
"isInheritable": false, "isInheritable": false,
"position": 30 "position": 30
}, },
@@ -8440,28 +8447,28 @@
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "eIg8jdvaoNNd", "value": "oPVyFC7WL2Lp",
"isInheritable": false, "isInheritable": false,
"position": 30 "position": 30
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "oPVyFC7WL2Lp", "value": "BlN9DFI679QC",
"isInheritable": false, "isInheritable": false,
"position": 40 "position": 40
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "CdNpE2pqjmI6", "value": "eIg8jdvaoNNd",
"isInheritable": false, "isInheritable": false,
"position": 50 "position": 50
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "BlN9DFI679QC", "value": "CdNpE2pqjmI6",
"isInheritable": false, "isInheritable": false,
"position": 60 "position": 60
}, },

View File

@@ -33,7 +33,7 @@ The following note types are supported by Trilium:
| <a class="reference-link" href="Note%20Types/Relation%20Map.md">Relation Map</a> | Allows easy creation of notes and relations between them. Can be used for mainly relational data such as a family tree. | | <a class="reference-link" href="Note%20Types/Relation%20Map.md">Relation Map</a> | Allows easy creation of notes and relations between them. Can be used for mainly relational data such as a family tree. |
| <a class="reference-link" href="Note%20Types/Note%20Map.md">Note Map</a> | Displays the relationships between the notes, whether via relations or their hierarchical structure. | | <a class="reference-link" href="Note%20Types/Note%20Map.md">Note Map</a> | Displays the relationships between the notes, whether via relations or their hierarchical structure. |
| <a class="reference-link" href="Note%20Types/Render%20Note.md">Render Note</a> | Used in <a class="reference-link" href="Scripting.md">Scripting</a>, it displays the HTML content of another note. This allows displaying any kind of content, provided there is a script behind it to generate it. | | <a class="reference-link" href="Note%20Types/Render%20Note.md">Render Note</a> | Used in <a class="reference-link" href="Scripting.md">Scripting</a>, it displays the HTML content of another note. This allows displaying any kind of content, provided there is a script behind it to generate it. |
| <a class="reference-link" href="Note%20Types/Collections.md">Collections</a> | Displays the children of the note either as a grid, a list, or for a more specialized case: a calendar.<br><br>Generally useful for easy reading of short notes. | | <a class="reference-link" href="Note%20Types/Collections.md">Collections</a> | Displays the children of the note either as a grid, a list, or for a more specialized case: a calendar. <br> <br>Generally useful for easy reading of short notes. |
| <a class="reference-link" href="Note%20Types/Mermaid%20Diagrams.md">Mermaid Diagrams</a> | Displays diagrams such as bar charts, flow charts, state diagrams, etc. Requires a bit of technical knowledge since the diagrams are written in a specialized format. | | <a class="reference-link" href="Note%20Types/Mermaid%20Diagrams.md">Mermaid Diagrams</a> | Displays diagrams such as bar charts, flow charts, state diagrams, etc. Requires a bit of technical knowledge since the diagrams are written in a specialized format. |
| <a class="reference-link" href="Note%20Types/Canvas.md">Canvas</a> | Allows easy drawing of sketches, diagrams, handwritten content. Uses the same technology behind [excalidraw.com](https://excalidraw.com). | | <a class="reference-link" href="Note%20Types/Canvas.md">Canvas</a> | Allows easy drawing of sketches, diagrams, handwritten content. Uses the same technology behind [excalidraw.com](https://excalidraw.com). |
| <a class="reference-link" href="Note%20Types/Web%20View.md">Web View</a> | Displays the content of an external web page, similar to a browser. | | <a class="reference-link" href="Note%20Types/Web%20View.md">Web View</a> | Displays the content of an external web page, similar to a browser. |

View File

@@ -26,8 +26,8 @@ The position on the map and the zoom are saved inside the map note and restored
| | | | | | | |
| --- | --- | --- | | --- | --- | --- |
| 1 | To create a marker, first navigate to the desired point on the map. Then press the ![](10_Geo%20Map%20View_image.png) button in the [Floating buttons](../../Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons.md) (top-right) area.  <br> <br>If the button is not visible, make sure the button section is visible by pressing the chevron button (![](17_Geo%20Map%20View_image.png)) in the top-right of the map. | | | 1 | To create a marker, first navigate to the desired point on the map. Then press the ![](10_Geo%20Map%20View_image.png) button in the [Floating buttons](../../Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons.md) (top-right) area.   <br> <br>If the button is not visible, make sure the button section is visible by pressing the chevron button (![](17_Geo%20Map%20View_image.png)) in the top-right of the map. | |
| 2 | <img class="image_resized" style="aspect-ratio:1730/416;width:100%;" src="2_Geo Map View_image.png" width="1730" height="416"> | Once pressed, the map will enter in the insert mode, as illustrated by the notification.     <br> <br>Simply click the point on the map where to place the marker, or the Escape key to cancel. | | 2 | <img class="image_resized" style="aspect-ratio:1730/416;width:100%;" src="2_Geo Map View_image.png" width="1730" height="416"> | Once pressed, the map will enter in the insert mode, as illustrated by the notification.      <br> <br>Simply click the point on the map where to place the marker, or the Escape key to cancel. |
| 3 | <img class="image_resized" style="aspect-ratio:1586/404;width:100%;" src="7_Geo Map View_image.png" width="1586" height="404"> | Enter the name of the marker/note to be created. | | 3 | <img class="image_resized" style="aspect-ratio:1586/404;width:100%;" src="7_Geo Map View_image.png" width="1586" height="404"> | Enter the name of the marker/note to be created. |
| 4 | <img class="image_resized" style="aspect-ratio:1696/608;width:100%;" src="16_Geo Map View_image.png" width="1696" height="608"> | Once confirmed, the marker will show up on the map and it will also be displayed as a child note of the map. | | 4 | <img class="image_resized" style="aspect-ratio:1696/608;width:100%;" src="16_Geo Map View_image.png" width="1696" height="608"> | Once confirmed, the marker will show up on the map and it will also be displayed as a child note of the map. |
@@ -106,7 +106,7 @@ The value of the attribute is made up of the latitude and longitude separated by
| | | | | | | |
| --- | --- | --- | | --- | --- | --- |
| 1 | <figure class="image image-style-align-center image_resized" style="width:56.84%;"><img style="aspect-ratio:732/918;" src="12_Geo Map View_image.png" width="732" height="918"></figure> | Go to Google Maps on the web and look for a desired location, right click on it and a context menu will show up.     <br> <br>Simply click on the first item displaying the coordinates and they will be copied to clipboard.     <br> <br>Then paste the value inside the text box into the `#geolocation` attribute of a child note of the map (don't forget to surround the value with a `"` character). | | 1 | <figure class="image image-style-align-center image_resized" style="width:56.84%;"><img style="aspect-ratio:732/918;" src="12_Geo Map View_image.png" width="732" height="918"></figure> | Go to Google Maps on the web and look for a desired location, right click on it and a context menu will show up.      <br> <br>Simply click on the first item displaying the coordinates and they will be copied to clipboard.      <br> <br>Then paste the value inside the text box into the `#geolocation` attribute of a child note of the map (don't forget to surround the value with a `"` character). |
| 2 | <figure class="image image-style-align-center image_resized" style="width:100%;"><img style="aspect-ratio:518/84;" src="4_Geo Map View_image.png" width="518" height="84"></figure> | In Trilium, create a child note under the map. | | 2 | <figure class="image image-style-align-center image_resized" style="width:100%;"><img style="aspect-ratio:518/84;" src="4_Geo Map View_image.png" width="518" height="84"></figure> | In Trilium, create a child note under the map. |
| 3 | <figure class="image image-style-align-center image_resized" style="width:100%;"><img style="aspect-ratio:1074/276;" src="11_Geo Map View_image.png" width="1074" height="276"></figure> | And then go to Owned Attributes and type `#geolocation="`, then paste from the clipboard as-is and then add the ending `"` character. Press Enter to confirm and the map should now be updated to contain the new note. | | 3 | <figure class="image image-style-align-center image_resized" style="width:100%;"><img style="aspect-ratio:1074/276;" src="11_Geo Map View_image.png" width="1074" height="276"></figure> | And then go to Owned Attributes and type `#geolocation="`, then paste from the clipboard as-is and then add the ending `"` character. Press Enter to confirm and the map should now be updated to contain the new note. |
@@ -117,7 +117,7 @@ Similarly to the Google Maps approach:
| | | | | | | |
| --- | --- | --- | | --- | --- | --- |
| 1 | <img class="image_resized" style="aspect-ratio:562/454;width:100%;" src="1_Geo Map View_image.png" width="562" height="454"> | Go to any location on openstreetmap.org and right click to bring up the context menu. Select the “Show address” item. | | 1 | <img class="image_resized" style="aspect-ratio:562/454;width:100%;" src="1_Geo Map View_image.png" width="562" height="454"> | Go to any location on openstreetmap.org and right click to bring up the context menu. Select the “Show address” item. |
| 2 | <img class="image_resized" style="aspect-ratio:696/480;width:100%;" src="Geo Map View_image.png" width="696" height="480"> | The address will be visible in the top-left of the screen, in the place of the search bar.     <br> <br>Select the coordinates and copy them into the clipboard. | | 2 | <img class="image_resized" style="aspect-ratio:696/480;width:100%;" src="Geo Map View_image.png" width="696" height="480"> | The address will be visible in the top-left of the screen, in the place of the search bar.      <br> <br>Select the coordinates and copy them into the clipboard. |
| 3 | <img class="image_resized" style="aspect-ratio:640/276;width:100%;" src="5_Geo Map View_image.png" width="640" height="276"> | Simply paste the value inside the text box into the `#geolocation` attribute of a child note of the map and then it should be displayed on the map. | | 3 | <img class="image_resized" style="aspect-ratio:640/276;width:100%;" src="5_Geo Map View_image.png" width="640" height="276"> | Simply paste the value inside the text box into the `#geolocation` attribute of a child note of the map and then it should be displayed on the map. |
## Adding GPS tracks (.gpx) ## Adding GPS tracks (.gpx)
@@ -128,7 +128,7 @@ Trilium has basic support for displaying GPS tracks on the geo map.
| --- | --- | --- | | --- | --- | --- |
| 1 | <figure class="image image-style-align-center"><img style="aspect-ratio:226/74;" src="3_Geo Map View_image.png" width="226" height="74"></figure> | To add a track, simply drag & drop a .gpx file inside the geo map in the note tree. | | 1 | <figure class="image image-style-align-center"><img style="aspect-ratio:226/74;" src="3_Geo Map View_image.png" width="226" height="74"></figure> | To add a track, simply drag & drop a .gpx file inside the geo map in the note tree. |
| 2 | <figure class="image image-style-align-center"><img style="aspect-ratio:322/222;" src="14_Geo Map View_image.png" width="322" height="222"></figure> | In order for the file to be recognized as a GPS track, it needs to show up as `application/gpx+xml` in the _File type_ field. | | 2 | <figure class="image image-style-align-center"><img style="aspect-ratio:322/222;" src="14_Geo Map View_image.png" width="322" height="222"></figure> | In order for the file to be recognized as a GPS track, it needs to show up as `application/gpx+xml` in the _File type_ field. |
| 3 | <figure class="image image-style-align-center"><img style="aspect-ratio:620/530;" src="6_Geo Map View_image.png" width="620" height="530"></figure> | When going back to the map, the track should now be visible.     <br> <br>The start and end points of the track are indicated by the two blue markers. | | 3 | <figure class="image image-style-align-center"><img style="aspect-ratio:620/530;" src="6_Geo Map View_image.png" width="620" height="530"></figure> | When going back to the map, the track should now be visible.      <br> <br>The start and end points of the track are indicated by the two blue markers. |
> [!NOTE] > [!NOTE]
> The starting point of the track will be displayed as a marker, with the name of the note underneath. The start marker will also respect the icon and the `color` of the note. The end marker is displayed with a distinct icon. > The starting point of the track will be displayed as a marker, with the name of the note underneath. The start marker will also respect the icon and the `color` of the note. The end marker is displayed with a distinct icon.
@@ -145,6 +145,31 @@ When a map is in read-only all editing features will be disabled such as:
To enable read-only mode simply press the _Lock_ icon from the <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons.md">Floating buttons</a>. To disable it, press the button again. To enable read-only mode simply press the _Lock_ icon from the <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons.md">Floating buttons</a>. To disable it, press the button again.
## Configuration
### Map Style
The styling of the map can be adjusted in the _Collection Properties_ tab in the <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">Ribbon</a> or manually via the `#map:style` attribute.
The geo map comes with two different types of styles:
* Raster styles
* For these styles the map is represented as a grid of images at different zoom levels. This is the traditional way OpenStreetMap used to work.
* Zoom is slightly restricted.
* Currently, the only raster theme is the original OpenStreetMap style.
* Vector styles
* Vector styles are not represented as images, but as geometrical shapes. This makes the rendering much smoother, especially when zooming and looking at the building edges, for example.
* The map can be zoomed in much further.
* These come both in a light and a dark version.
* The vector styles come from [VersaTiles](https://versatiles.org/), a free and open-source project providing map tiles based on OpenStreetMap.
> [!NOTE]
> Currently it is not possible to use a custom map style.
### Scale
Activating this option via the <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">Ribbon</a> or manually via `#map:scale` will display an indicator in the bottom-left of the scale of the map.
## Troubleshooting ## Troubleshooting
<figure class="image image-style-align-right image_resized" style="width:34.06%;"><img style="aspect-ratio:678/499;" src="13_Geo Map View_image.png" width="678" height="499"></figure> <figure class="image image-style-align-right image_resized" style="width:34.06%;"><img style="aspect-ratio:678/499;" src="13_Geo Map View_image.png" width="678" height="499"></figure>

View File

@@ -13,9 +13,9 @@
| Mark selected text as [keyboard shortcut](Developer-specific%20formatting.md) | <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>K</kbd> | <kbd>⌘</kbd>\+ <kbd>⌥</kbd>\+ <kbd>K</kbd> | | Mark selected text as [keyboard shortcut](Developer-specific%20formatting.md) | <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>K</kbd> | <kbd>⌘</kbd>\+ <kbd>⌥</kbd>\+ <kbd>K</kbd> |
| Insert <a class="reference-link" href="Math%20Equations.md">Math Equations</a> | <kbd>Ctrl</kbd> + <kbd>M</kbd> | <kbd>⌘</kbd>\+ <kbd>M</kbd> | | Insert <a class="reference-link" href="Math%20Equations.md">Math Equations</a> | <kbd>Ctrl</kbd> + <kbd>M</kbd> | <kbd>⌘</kbd>\+ <kbd>M</kbd> |
| Move blocks (lists, paragraphs, etc.) up | <kbd>Ctrl</kbd>+<kbd>↑</kbd> | <kbd>⌘</kbd>+<kbd>↑</kbd> | | Move blocks (lists, paragraphs, etc.) up | <kbd>Ctrl</kbd>+<kbd>↑</kbd> | <kbd>⌘</kbd>+<kbd>↑</kbd> |
| <kbd>Alt</kbd>+<kbd>↑</kbd> | <kbd>⌥</kbd>+<kbd>↑</kbd> | | <kbd>Alt</kbd>+<kbd>↑</kbd> | <kbd>⌥</kbd>+<kbd>↑</kbd> | |
| Move blocks (lists, paragraphs, etc.) down | <kbd>Ctrl</kbd>+<kbd>↑</kbd> | <kbd>⌘</kbd>+<kbd>↑</kbd> | | Move blocks (lists, paragraphs, etc.) down | <kbd>Ctrl</kbd>+<kbd>↑</kbd> | <kbd>⌘</kbd>+<kbd>↑</kbd> |
| <kbd>Alt</kbd>+<kbd>↓</kbd> | <kbd>⌥</kbd>+<kbd>↓</kbd> | | <kbd>Alt</kbd>+<kbd>↓</kbd> | <kbd>⌥</kbd>+<kbd>↓</kbd> | |
## Common shortcuts ## Common shortcuts