gaschz/trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-11-17 14:04:30 +01:00
Code Issues Actions 11 Packages Projects Releases Wiki Activity

docs(dev): document adding a new locale

Browse Source
This commit is contained in:
Elian Doran 2025-11-16 21:24:34 +02:00
parent cc0e30e3f5
commit 5281e8e5b4
No known key found for this signature in database
9 changed files with 601 additions and 584 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes.html generated vendored
View File

@ -5,14 +5,14 @@
<p>In Trilium, attributes are key-value pairs assigned to notes, providing <p>In Trilium, attributes are key-value pairs assigned to notes, providing
additional metadata or functionality. There are two primary types of attributes:</p> additional metadata or functionality. There are two primary types of attributes:</p>
<ol> <ol>
<li data-list-item-id="ef9c097e5af906754a4056ace4d16dbee"> <li>
<p><a class="reference-link" href="#root/_help_HI6GBBIduIgv">Labels</a>&nbsp;can <p><a class="reference-link" href="#root/_help_HI6GBBIduIgv">Labels</a>&nbsp;can
be used for a variety of purposes, such as storing metadata or configuring be used for a variety of purposes, such as storing metadata or configuring
the behavior of notes. Labels are also searchable, enhancing note retrieval.</p> the behavior of notes. Labels are also searchable, enhancing note retrieval.</p>
<p>For more information, including predefined labels, see&nbsp;<a class="reference-link" <p>For more information, including predefined labels, see&nbsp;<a class="reference-link"
href="#root/_help_HI6GBBIduIgv">Labels</a>.</p> href="#root/_help_HI6GBBIduIgv">Labels</a>.</p>
</li> </li>
<li data-list-item-id="e8416f6f5188a4d8a25917c610a1482c0"> <li>
<p><a class="reference-link" href="#root/_help_Cq5X6iKQop6R">Relations</a>&nbsp;define <p><a class="reference-link" href="#root/_help_Cq5X6iKQop6R">Relations</a>&nbsp;define
connections between notes, similar to links. These can be used for metadata connections between notes, similar to links. These can be used for metadata
and scripting purposes.</p> and scripting purposes.</p>
@ -27,25 +27,24 @@
<p>Conceptually there are two types of attributes (applying to both labels <p>Conceptually there are two types of attributes (applying to both labels
and relations):</p> and relations):</p>
<ol> <ol>
<li data-list-item-id="e778cee42c209e30e41f7d2c99895495d"><strong>System attributes</strong> <li><strong>System attributes</strong>
<br>As the name suggest, these attributes have a special meaning since they <br>As the name suggest, these attributes have a special meaning since they
are interpreted by Trilium. For example the <code>color</code> attribute are interpreted by Trilium. For example the <code>color</code> attribute
will change the color of the note as displayed in the&nbsp;<a class="reference-link" will change the color of the note as displayed in the&nbsp;<a class="reference-link"
href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_oPVyFC7WL2Lp">Note Tree</a>&nbsp;and href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>&nbsp;and links, and <code>iconClass</code> will
links, and <code>iconClass</code> will change the icon of a note. change the icon of a note.</li>
<br>&nbsp;</li> <li><strong>User-defined attributes</strong>
<li data-list-item-id="e0ca0ab889b471e7c18e3d4f6ae6a61e0"><strong>User-defined attributes</strong>
<br>These are free-form labels or relations that can be used by the user. <br>These are free-form labels or relations that can be used by the user.
They can be used purely for categorization purposes (especially if combined They can be used purely for categorization purposes (especially if combined
with&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/wArbEsdSae6g/_help_eIg8jdvaoNNd">Search</a>), with&nbsp;<a class="reference-link" href="#root/_help_eIg8jdvaoNNd">Search</a>),
or they can be given meaning through the use of&nbsp;<a class="reference-link" or they can be given meaning through the use of&nbsp;<a class="reference-link"
href="#root/pOsGYCXsbNQG/_help_CdNpE2pqjmI6">Scripting</a>.</li> href="#root/_help_CdNpE2pqjmI6">Scripting</a>.</li>
</ol> </ol>
<p>In practice, Trilium makes no direct distinction of whether an attribute <p>In practice, Trilium makes no direct distinction of whether an attribute
is a system one or a user-defined one. A label or relation is considered is a system one or a user-defined one. A label or relation is considered
a system attribute if it matches one of the built-in names (e.g. like the a system attribute if it matches one of the built-in names (e.g. like the
aforementioned <code>iconClass</code>). Keep this in mind when creating aforementioned <code>iconClass</code>). Keep this in mind when creating
&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/zEY4DaJG4YT5/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;in &nbsp;<a class="reference-link" href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;in
order not to accidentally alter a system attribute (unless intended).</p> order not to accidentally alter a system attribute (unless intended).</p>
<h2>Viewing the list of attributes</h2> <h2>Viewing the list of attributes</h2>
<p>Both the labels and relations for the current note are displayed in the <em>Owned Attributes</em> section <p>Both the labels and relations for the current note are displayed in the <em>Owned Attributes</em> section
@ -56,14 +55,13 @@
<p>In the list of attributes, labels are prefixed with the <code>#</code> character <p>In the list of attributes, labels are prefixed with the <code>#</code> character
whereas relations are prefixed with the <code>~</code> character.</p> whereas relations are prefixed with the <code>~</code> character.</p>
<h2>Attribute Definitions and Promoted Attributes</h2> <h2>Attribute Definitions and Promoted Attributes</h2>
<p><a class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/zEY4DaJG4YT5/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;create <p><a class="reference-link" href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;create
a form-like editing experience for attributes, which makes it easy to enhancing a form-like editing experience for attributes, which makes it easy to enhancing
the organization and management of attributes</p> the organization and management of attributes</p>
<h2>Multiplicity</h2> <h2>Multiplicity</h2>
<p>Attributes in Trilium can be "multi-valued", meaning multiple attributes <p>Attributes in Trilium can be "multi-valued", meaning multiple attributes
with the same name can co-exist. This can be combined with&nbsp;<a class="reference-link" with the same name can co-exist. This can be combined with&nbsp;<a class="reference-link"
href="#root/pOsGYCXsbNQG/tC7s2alapj8V/zEY4DaJG4YT5/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;to href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;to easily add them.</p>
easily add them.</p>
<h2>Attribute Inheritance</h2> <h2>Attribute Inheritance</h2>
<p>Trilium supports attribute inheritance, allowing child notes to inherit <p>Trilium supports attribute inheritance, allowing child notes to inherit
attributes from their parents. For more information, see&nbsp;<a class="reference-link" attributes from their parents. For more information, see&nbsp;<a class="reference-link"

54
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Attributes/Promoted Attributes.html generated vendored
View File

@ -22,30 +22,28 @@
value are strings.</p> value are strings.</p>
<p>The <em>Attribute definition</em> specifies how should this value be interpreted:</p> <p>The <em>Attribute definition</em> specifies how should this value be interpreted:</p>
<ul> <ul>
<li data-list-item-id="e73e2d8dffca4fe59d009bfc5a245da88">Is it just string, or is it a date?</li> <li>Is it just string, or is it a date?</li>
<li data-list-item-id="e115a58c2d81149f481c385479cf06965">Should we allow multiple values or note?</li> <li>Should we allow multiple values or note?</li>
<li data-list-item-id="eb8cab0b2fdcefb7af9128f63b3b9f4ee">Should we <em>promote</em> the attribute or not?</li> <li>Should we <em>promote</em> the attribute or not?</li>
</ul> </ul>
<h2>Creating a new promoted attribute definition</h2> <h2>Creating a new promoted attribute definition</h2>
<p>To create a new promoted attribute:</p> <p>To create a new promoted attribute:</p>
<ol> <ol>
<li data-list-item-id="e118d34c98d285e3a7492876f73a49ed5">Go to a note.</li> <li>Go to a note.</li>
<li data-list-item-id="e480cc90d938f7f728011679df29f6ce0">Go to <em>Owned Attributes</em> in the&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_BlN9DFI679QC">Ribbon</a>.</li> <li>Go to <em>Owned Attributes</em> in the&nbsp;<a class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>.</li>
<li <li>Press the + button.</li>
data-list-item-id="e40a26a8a32714572e670d8c7c18d1355">Press the + button.</li> <li>Select either <em>Add new label definition</em> or <em>Add new relation definition</em>.</li>
<li data-list-item-id="e5ba4dcc8ae48c7f043de2c8fc5ec1c2c">Select either <em>Add new label definition</em> or <em>Add new relation definition</em>.</li> <li>Select the name which will be name of the label or relation that will
<li
data-list-item-id="e14e894cf6d207a410adbe87c56143799">Select the name which will be name of the label or relation that will
be created when the promoted attribute is edited.</li> be created when the promoted attribute is edited.</li>
<li data-list-item-id="e5d803cd5a37a7169a5aa770d769f2dd4">Ensure <em>Promoted</em> is checked in order to display it at the top of <li>Ensure <em>Promoted</em> is checked in order to display it at the top of
notes.</li> notes.</li>
<li data-list-item-id="e50c81da6343840b2a06b46a20e21181e">Optionally, choose an <em>Alias</em> which will be displayed next to the <li>Optionally, choose an <em>Alias</em> which will be displayed next to the
promoted attribute instead of the attribute name. Generally it's best to promoted attribute instead of the attribute name. Generally it's best to
choose a “user-friendly” name since it can contain spaces and other characters choose a “user-friendly” name since it can contain spaces and other characters
which are not supported as attribute names.</li> which are not supported as attribute names.</li>
<li data-list-item-id="e0e08c63296b88ea8ec8ae17104eed366">Check <em>Inheritable</em> to apply it to this note and all its descendants. <li>Check <em>Inheritable</em> to apply it to this note and all its descendants.
To keep it only for the current note, un-check it.</li> To keep it only for the current note, un-check it.</li>
<li data-list-item-id="ededc09be314b651d919aebd026cc5b86">Press “Save &amp; Close” to apply the changes.</li> <li>Press “Save &amp; Close” to apply the changes.</li>
</ol> </ol>
<h2>How attribute definitions actually work</h2> <h2>How attribute definitions actually work</h2>
<p>When a new promoted attribute definition is created, it creates a corresponding <p>When a new promoted attribute definition is created, it creates a corresponding
@ -54,12 +52,13 @@
<p>The only purpose of the attribute definition is to set up a template. <p>The only purpose of the attribute definition is to set up a template.
If the attribute was marked as promoted, then it's also displayed to the If the attribute was marked as promoted, then it's also displayed to the
user for easy editing.</p> user for easy editing.</p>
<figure class="table" style="width:100%;"> <table>
<table class="ck-table-resized"> <thead>
<colgroup> <tr>
<col style="width:47.64%;"> <th></th>
<col style="width:52.36%;"> <th></th>
</colgroup> </tr>
</thead>
<tbody> <tbody>
<tr> <tr>
<td> <td>
@ -83,8 +82,7 @@
the promoted attribute.</td> the promoted attribute.</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
</figure>
<p>So there's one attribute for value and one for definition. But notice <p>So there's one attribute for value and one for definition. But notice
how an definition attribute can be made <a href="#root/_help_bwZpz2ajCEwO">Inheritable</a>, how an definition attribute can be made <a href="#root/_help_bwZpz2ajCEwO">Inheritable</a>,
meaning that it's also applied to all descendant notes. In this case, the meaning that it's also applied to all descendant notes. In this case, the
@ -95,22 +93,22 @@
to be able to easily alter them.</p> to be able to easily alter them.</p>
<p>Here are a few practical examples:</p> <p>Here are a few practical examples:</p>
<ul> <ul>
<li data-list-item-id="eb7e4e362b582d6bf480375d1e5648ac3"><a class="reference-link" href="#root/pOsGYCXsbNQG/_help_GTwFsgaA0lCt">Collections</a>&nbsp;already <li><a class="reference-link" href="#root/_help_GTwFsgaA0lCt">Collections</a>&nbsp;already
make use of this practice, for example: make use of this practice, for example:
<ul> <ul>
<li data-list-item-id="e0831925d935c7a90f90bd5fed94d089e">Calendars add “Start Date”, “End Date”, “Start Time” and “End Time” as <li>Calendars add “Start Date”, “End Date”, “Start Time” and “End Time” as
promoted attributes. These map to system attributes such as <code>startDate</code> which promoted attributes. These map to system attributes such as <code>startDate</code> which
are then interpreted by the calendar view.</li> are then interpreted by the calendar view.</li>
<li data-list-item-id="e4a235f12a7934803ba7706e309511c82"><a class="reference-link" href="#root/pOsGYCXsbNQG/GTwFsgaA0lCt/_help_zP3PMqaG71Ct">Presentation</a>&nbsp;adds <li><a class="reference-link" href="#root/_help_zP3PMqaG71Ct">Presentation</a>&nbsp;adds
a “Background” promoted attribute for each of the slide to easily be able a “Background” promoted attribute for each of the slide to easily be able
to customize.</li> to customize.</li>
</ul> </ul>
</li> </li>
<li data-list-item-id="e9069ad779c177b7ed0d3ece786e73cd3">The Trilium documentation (which is edited in Trilium) uses a promoted <li>The Trilium documentation (which is edited in Trilium) uses a promoted
attribute to be able to easily edit the <code>#shareAlias</code> (see&nbsp; attribute to be able to easily edit the <code>#shareAlias</code> (see&nbsp;
<a <a
class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/_help_R9pX4DGra2Vt">Sharing</a>) in order to form clean URLs.</li> class="reference-link" href="#root/_help_R9pX4DGra2Vt">Sharing</a>) in order to form clean URLs.</li>
<li data-list-item-id="ed14685a7279b42a1769be97ffe7f5e8f">If you always edit a particular system attribute such as <code>#color</code>, <li>If you always edit a particular system attribute such as <code>#color</code>,
simply create a promoted attribute for it to make it easier.</li> simply create a promoted attribute for it to make it easier.</li>
</ul> </ul>
<h3>Inverse relation</h3> <h3>Inverse relation</h3>

212
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Geo Map.html generated vendored
View File

@ -1,11 +1,9 @@
<aside class="admonition important"> <aside class="admonition important">
<p><a class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/_help_zEY4DaJG4YT5">Attributes</a> <p><a class="reference-link" href="#root/_help_zEY4DaJG4YT5">Attributes</a><a class="reference-link"
<a href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a><a class="reference-link"
class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/zEY4DaJG4YT5/_help_OFXdgB2nNk1F">Promoted Attributes</a><a class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/_help_zEY4DaJG4YT5">Attributes</a>Starting href="#root/_help_zEY4DaJG4YT5">Attributes</a>Starting with Trilium v0.97.0,
with Trilium v0.97.0, the geo map has been converted from a standalone the geo map has been converted from a standalone <a href="#root/_help_KSZ04uQ2D1St">note type</a> to
<a a type of view for the&nbsp;<a class="reference-link" href="#root/_help_0ESUbbAxVnoK">Note List</a>.&nbsp;</p>
href="#root/_help_KSZ04uQ2D1St">note type</a>to a type of view for the&nbsp;<a class="reference-link"
href="#root/_help_0ESUbbAxVnoK">Note List</a>.&nbsp;</p>
</aside> </aside>
<figure class="image image-style-align-center"> <figure class="image image-style-align-center">
<img style="aspect-ratio:892/675;" src="9_Geo Map_image.png" <img style="aspect-ratio:892/675;" src="9_Geo Map_image.png"
@ -15,13 +13,12 @@
on an attribute. It is also possible to add new notes at a specific location on an attribute. It is also possible to add new notes at a specific location
using the built-in interface.</p> using the built-in interface.</p>
<h2>Creating a new geo map</h2> <h2>Creating a new geo map</h2>
<figure class="table"> <table>
<table>
<thead> <thead>
<tr> <tr>
<th>&nbsp;</th> <th></th>
<th>&nbsp;</th> <th></th>
<th>&nbsp;</th> <th></th>
</tr> </tr>
</thead> </thead>
<tbody> <tbody>
@ -46,25 +43,24 @@
<td>By default the map will be empty and will show the entire world.</td> <td>By default the map will be empty and will show the entire world.</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
</figure>
<h2>Repositioning the map</h2> <h2>Repositioning the map</h2>
<ul> <ul>
<li data-list-item-id="ec3df228f80922b4531e2dd1a977d81b8">Click and drag the map in order to move across the map.</li> <li>Click and drag the map in order to move across the map.</li>
<li data-list-item-id="ee505c643c5bacffffc42119cc2f19c60">Use the mouse wheel, two-finger gesture on a touchpad or the +/- buttons <li>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
restored when visiting again the note.</p> restored when visiting again the note.</p>
<h2>Adding a marker using the map</h2> <h2>Adding a marker using the map</h2>
<h3>Adding a new note using the plus button</h3> <h3>Adding a new note using the plus button</h3>
<figure class="table"> <table>
<table>
<thead> <thead>
<tr> <tr>
<th>&nbsp;</th> <th></th>
<th>&nbsp;</th> <th></th>
<th>&nbsp;</th> <th></th>
</tr> </tr>
</thead> </thead>
<tbody> <tbody>
@ -78,7 +74,7 @@
<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 (
<img src="17_Geo Map_image.png">) in the top-right of the map.</td> <img src="17_Geo Map_image.png">) in the top-right of the map.</td>
<td>&nbsp;</td> <td></td>
</tr> </tr>
<tr> <tr>
<td>2</td> <td>2</td>
@ -110,32 +106,29 @@
displayed as a child note of the map.</td> displayed as a child note of the map.</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
</figure>
<h3>Adding a new note using the contextual menu</h3> <h3>Adding a new note using the contextual menu</h3>
<ol> <ol>
<li data-list-item-id="ea014287557d9fbca07dd30b32405f92a">Right click anywhere on the map, where to place the newly created marker <li>Right click anywhere on the map, where to place the newly created marker
(and corresponding note).</li> (and corresponding note).</li>
<li data-list-item-id="ef758bd1a52c2ced75e402fd68e3d1e67">Select <em>Add a marker at this location</em>.</li> <li>Select <em>Add a marker at this location</em>.</li>
<li data-list-item-id="e6f1d66e9d872ac4908a7c11b401a9d80">Enter the name of the ne<a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_oPVyFC7WL2Lp">Note Tree</a>wly <li>Enter the name of the ne<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>wly
created note.</li> created note.</li>
<li data-list-item-id="eed9a3fbe500d61c76729f6147ceed925">The map should be updated with the new marker.</li> <li>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 data-list-item-id="ecba60e77600a1660e947ce54c633df04">Select the desired note in the&nbsp;<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</li> <li>Select the desired note in the&nbsp;<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</li>
<li <li>Hold the mouse on the note and drag it to the map to the desired location.</li>
data-list-item-id="e00bb8f41cf79fef2b5ce215bc678f808">Hold the mouse on the note and drag it to the map to the desired location.</li> <li>The map should be updated with the new marker.</li>
<li
data-list-item-id="e3fc69dc9e44db125872274e68223cd4e">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 data-list-item-id="e0821dbcf20fa4a83a9cfada4bea95521">Notes that are not part of the geo map, case in which a <a href="#root/_help_IakOLONlIfGI">clone</a> will <li>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 data-list-item-id="e859aa76bcb592afd7414cccb60cdd3ed">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 but not yet positioned on the map.</li>
<li <li>Notes that are a child of the geo map and also positioned, case in which
data-list-item-id="e74fb2b74919aba44e1a457a5f8aec6b8">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>
<aside class="admonition note"> <aside class="admonition note">
@ -145,10 +138,8 @@
<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>
<p> <img src="18_Geo Map_image.png"
<img src="18_Geo Map_image.png" width="1288" width="1288" height="278">
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>
@ -160,17 +151,16 @@
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 data-list-item-id="e953e0022167e10d476bbf438b71029ee">Hovering over a marker will display a&nbsp;<a class="reference-link" href="#root/_help_lgKX7r3aL30x">Note Tooltip</a>&nbsp;with <li>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 data-list-item-id="e24f6ec1307f470fc8a9c0681282dd424">Clicking on the note title in the tooltip will navigate to the note in <li>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 data-list-item-id="ea6f9b375776db475c00f3d308f170cb1">Middle-clicking the marker will open the note in a new tab.</li> <li>Middle-clicking the marker will open the note in a new tab.</li>
<li data-list-item-id="e26942774d668ca9d49e1cfc797801516">Right-clicking the marker will open a contextual menu (as described below).</li> <li>Right-clicking the marker will open a contextual menu (as described below).</li>
<li <li>If the map is in read-only mode, clicking on a marker will open a&nbsp;
data-list-item-id="edcf8a4a4e252ae3757303fc28c6e549e">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>
@ -178,24 +168,24 @@
<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 data-list-item-id="e529cc53e555215e949135d9998ac4d06">If right-clicking an empty section of the map (not on a marker), it allows <li>If right-clicking an empty section of the map (not on a marker), it allows
to: to:
<ol> <ol>
<li data-list-item-id="e18b27ec2d655ca2e29328c6cc899cccf">Displays the latitude and longitude. Clicking this option will copy them <li>Displays the latitude and longitude. Clicking this option will copy them
to the clipboard.</li> to the clipboard.</li>
<li data-list-item-id="ebecfc3495ce94589ebdaa3479e70a8ea">Open the location using an external application (if the operating system <li>Open the location using an external application (if the operating system
supports it).</li> supports it).</li>
<li data-list-item-id="e1e1e816904064ed2457553dbcf58f373">Adding a new marker at that location.</li> <li>Adding a new marker at that location.</li>
</ol> </ol>
</li> </li>
<li data-list-item-id="eadf4de9e1e967bfcbf7274b8e7613c8e">If right-clicking on a marker, it allows to: <li>If right-clicking on a marker, it allows to:
<ol> <ol>
<li data-list-item-id="ebd32992e411b3a755008b1036448f7e9">Displays the latitude and longitude. Clicking this option will copy them <li>Displays the latitude and longitude. Clicking this option will copy them
to the clipboard.</li> to the clipboard.</li>
<li data-list-item-id="e5e8bf64b872e1bf32a53459b05d05263">Open the location using an external application (if the operating system <li>Open the location using an external application (if the operating system
supports it).</li> supports it).</li>
<li data-list-item-id="ec83b4469031db305a1d3f9a4d36b395d">Open the note in a new tab, split or window.</li> <li>Open the note in a new tab, split or window.</li>
<li data-list-item-id="e49f6d549515bec0d6bd8bccf3d34d269">Remove the marker from the map, which will remove the <code>#geolocation</code> attribute <li>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>
@ -215,13 +205,12 @@
<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"> <table>
<table>
<thead> <thead>
<tr> <tr>
<th>&nbsp;</th> <th></th>
<th>&nbsp;</th> <th></th>
<th>&nbsp;</th> <th></th>
</tr> </tr>
</thead> </thead>
<tbody> <tbody>
@ -266,17 +255,16 @@
new note.</td> new note.</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
</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"> <table>
<table>
<thead> <thead>
<tr> <tr>
<th>&nbsp;</th> <th></th>
<th>&nbsp;</th> <th></th>
<th>&nbsp;</th> <th></th>
</tr> </tr>
</thead> </thead>
<tbody> <tbody>
@ -310,18 +298,16 @@
of a child note of the map and then it should be displayed on the map.</td> of a child note of the map and then it should be displayed on the map.</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
</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 <table>
class="table">
<table>
<thead> <thead>
<tr> <tr>
<th>&nbsp;</th> <th></th>
<th>&nbsp;</th> <th></th>
<th>&nbsp;</th> <th></th>
</tr> </tr>
</thead> </thead>
<tbody> <tbody>
@ -360,70 +346,68 @@ class="table">
<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>
</tbody> </tbody>
</table> </table>
</figure> <aside class="admonition note">
<aside class="admonition note">
<p>The starting point of the track will be displayed as a marker, with the <p>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 name of the note underneath. The start marker will also respect the icon
and the <code>color</code> of the note. The end marker is displayed with and the <code>color</code> of the note. The end marker is displayed with
a distinct icon.</p> a distinct icon.</p>
<p>If the GPX contains waypoints, they will also be displayed. If they have <p>If the GPX contains waypoints, they will also be displayed. If they have
a name, it is displayed when hovering over it with the mouse.</p> a name, it is displayed when hovering over it with the mouse.</p>
</aside> </aside>
<h2>Read-only mode</h2> <h2>Read-only mode</h2>
<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 data-list-item-id="e78bca8f945a953c13efaf287001d0edb">The add button in the&nbsp;<a class="reference-link" href="#root/_help_XpOYSgsLkTJy">Floating buttons</a>.</li> <li>The add button in the&nbsp;<a class="reference-link" href="#root/_help_XpOYSgsLkTJy">Floating buttons</a>.</li>
<li <li>Dragging markers.</li>
data-list-item-id="e022d4fc44c13cf5f529ea18729df3897">Dragging markers.</li> <li>Editing from the contextual menu (removing locations or adding new items).</li>
<li data-list-item-id="e0d024b930867c0253e98c322d3bea021">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> <h2>Configuration</h2>
<h3>Map Style</h3> <h3>Map Style</h3>
<p>The styling of the map can be adjusted in the <em>Collection Properties</em> tab <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/_help_BlN9DFI679QC">Ribbon</a>&nbsp;or in the&nbsp;<a class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>&nbsp;or
manually via the <code>#map:style</code> attribute.</p> manually via the <code>#map:style</code> attribute.</p>
<p>The geo map comes with two different types of styles:</p> <p>The geo map comes with two different types of styles:</p>
<ul>
<li>Raster styles
<ul> <ul>
<li data-list-item-id="ee111daf471290ce8f16adb8ff6255e78">Raster styles <li>For these styles the map is represented as a grid of images at different
<ul>
<li data-list-item-id="ebecb845ceda41068a106693c5a1244e3">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> zoom levels. This is the traditional way OpenStreetMap used to work.</li>
<li <li>Zoom is slightly restricted.</li>
data-list-item-id="e60a827a1f29105ea8321184d4fb4f0a2">Zoom is slightly restricted.</li> <li>Currently, the only raster theme is the original OpenStreetMap style.</li>
<li data-list-item-id="e2eb8282db9496f32beeddd53a72fea2a">Currently, the only raster theme is the original OpenStreetMap style.</li>
</ul> </ul>
</li> </li>
<li data-list-item-id="e01494841aec47f71245855fe95ad4adb">Vector styles <li>Vector styles
<ul> <ul>
<li data-list-item-id="e87e7f879a4c7475769e73f1cfa1bc1b8">Vector styles are not represented as images, but as geometrical shapes. <li>Vector styles are not represented as images, but as geometrical shapes.
This makes the rendering much smoother, especially when zooming and looking This makes the rendering much smoother, especially when zooming and looking
at the building edges, for example.</li> at the building edges, for example.</li>
<li data-list-item-id="ef95260bc6fcb49e63ff708077929b263">The map can be zoomed in much further.</li> <li>The map can be zoomed in much further.</li>
<li data-list-item-id="e339157e4fdacc1b59f6c44cf29711032">These come both in a light and a dark version.</li> <li>These come both in a light and a dark version.</li>
<li data-list-item-id="e9be34d3c44b5dc1ecaa8c856642fc610">The vector styles come from <a href="https://versatiles.org/">VersaTiles</a>, <li>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> a free and open-source project providing map tiles based on OpenStreetMap.</li>
</ul> </ul>
</li> </li>
</ul> </ul>
<aside class="admonition note"> <aside class="admonition note">
<p>Currently it is not possible to use a custom map style.</p> <p>Currently it is not possible to use a custom map style.</p>
</aside> </aside>
<h3>Scale</h3> <h3>Scale</h3>
<p>Activating this option via the&nbsp;<a class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>&nbsp;or <p>Activating this option via the&nbsp;<a class="reference-link" href="#root/_help_BlN9DFI679QC">Ribbon</a>&nbsp;or
manually via <code>#map:scale</code> will display an indicator in the bottom-left manually via <code>#map:scale</code> will display an indicator in the bottom-left
of the scale of the map.</p> 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_image.png" <img style="aspect-ratio:678/499;" src="13_Geo Map_image.png"
width="678" height="499"> width="678" height="499">
</figure> </figure>
<h3>Grid-like artifacts on the map</h3>
<p>This occurs if the application is not at 100% zoom which causes the pixels <h3>Grid-like artifacts on the map</h3>
<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
is <kbd>Ctrl</kbd>+<kbd>0</kbd>).</p> is <kbd>Ctrl</kbd>+<kbd>0</kbd>).</p>

137
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Kanban Board.html generated vendored
View File

@ -15,90 +15,86 @@
<h2>Interaction</h2> <h2>Interaction</h2>
<h3>Working with columns</h3> <h3>Working with columns</h3>
<ul> <ul>
<li data-list-item-id="ed78b9e2ac3200e097ae29e2d528c5e89">Create a new column by pressing <em>Add Column</em> near the last column. <li>Create a new column by pressing <em>Add Column</em> near the last column.
<ul> <ul>
<li data-list-item-id="ed5ddfffe11d0b328a8072e52be9c7492">Once pressed, a text box will be displayed to set the name of the column. <li>Once pressed, a text box will be displayed to set the name of the column.
Press <kbd>Enter</kbd> to confirm, or <kbd>Escape</kbd> to dismiss.</li> Press <kbd>Enter</kbd> to confirm, or <kbd>Escape</kbd> to dismiss.</li>
</ul> </ul>
</li> </li>
<li data-list-item-id="eeecd7ac7b32b1c29e7088ad172411862">To reorder a column, simply hold the mouse over the title and drag it <li>To reorder a column, simply hold the mouse over the title and drag it
to the desired position.</li> to the desired position.</li>
<li data-list-item-id="e6bc6a4b20236a9d2c382a9564eef528f">To delete a column, right click on its title and select <em>Delete column</em>.</li> <li>To delete a column, right click on its title and select <em>Delete column</em>.</li>
<li <li>To rename a column, click on the note title.
data-list-item-id="ea3bd7adf8521c4c2fb2f3ef0cf4def28">To rename a column, click on the note title.
<ul> <ul>
<li data-list-item-id="eb1b0ee1c933e5ca2f4cb57a05b5c07eb">Press Enter to confirm.</li> <li>Press Enter to confirm.</li>
<li data-list-item-id="eabddc4dae9e10189e9c7dc087496e846">Upon renaming a column, the corresponding status attribute of all its <li>Upon renaming a column, the corresponding status attribute of all its
notes will be changed in bulk.</li> notes will be changed in bulk.</li>
</ul> </ul>
</li> </li>
<li data-list-item-id="efc70bbc5f0d1dc25e919a5b9e41a54e2">If there are many columns, use the mouse wheel to scroll.</li> <li>If there are many columns, use the mouse wheel to scroll.</li>
</ul> </ul>
<h3>Working with notes</h3> <h3>Working with notes</h3>
<ul> <ul>
<li data-list-item-id="ee1000666f3c92f251a0262d5e2e30cbf">Create a new note in any column by pressing <em>New item</em> <li>Create a new note in any column by pressing <em>New item</em>
<ul> <ul>
<li data-list-item-id="ea3d86963b86f6820335c3994e3c7a00c">Enter the name of the note and press <kbd>Enter</kbd> or click away. To <li>Enter the name of the note and press <kbd>Enter</kbd> or click away. To
dismiss the creation of a new note, simply press <kbd>Escape</kbd> or leave dismiss the creation of a new note, simply press <kbd>Escape</kbd> or leave
the name empty.</li> the name empty.</li>
<li data-list-item-id="ee8280e96edd38a1bc247ee34ea514c88">Once created, the new note will have an attribute (<code>status</code> label <li>Once created, the new note will have an attribute (<code>status</code> label
by default) set to the name of the column.</li> by default) set to the name of the column.</li>
</ul> </ul>
</li> </li>
<li data-list-item-id="eb03f96167236a14a55a7538b588bed05">To open the note, simply click on it.</li> <li>To open the note, simply click on it.</li>
<li data-list-item-id="e29a6c1186c096f5ec6316edd9d44e626">To change the title of the note directly from the board, hover the mouse <li>To change the title of the note directly from the board, hover the mouse
over its card and press the edit button on the right.</li> over its card and press the edit button on the right.</li>
<li data-list-item-id="e201e4e28bad20f532c5e2c0ada6398f7">To change the state of a note, simply drag a note from one column to the <li>To change the state of a note, simply drag a note from one column to the
other to change its state.</li> other to change its state.</li>
<li data-list-item-id="e98766e577d03db3dfd8acb850ddf8268">The order of the notes in each column corresponds to their position in <li>The order of the notes in each column corresponds to their position in
the tree. the tree.
<ul> <ul>
<li data-list-item-id="e905430d6d0a5e51e2596611ccb3a0f2a">It's possible to reorder notes simply by dragging them to the desired <li>It's possible to reorder notes simply by dragging them to the desired
position within the same columns.</li> position within the same columns.</li>
<li data-list-item-id="e66108d33aee9387b325a554e12a85a73">It's also possible to drag notes across columns, at the desired position.</li> <li>It's also possible to drag notes across columns, at the desired position.</li>
</ul> </ul>
</li> </li>
<li data-list-item-id="ebb5b8df8459f8b32d2e1712d268b63df">For more options, right click on a note to display a context menu with <li>For more options, right click on a note to display a context menu with
the following options: the following options:
<ul> <ul>
<li data-list-item-id="efe7840fa83c41d4a23759927bbe824d2">Open the note in a new tab/split/window or quick edit.</li> <li>Open the note in a new tab/split/window or quick edit.</li>
<li data-list-item-id="ea44a2cd0895413620eff0720524e9938">Move the note to any column.</li> <li>Move the note to any column.</li>
<li data-list-item-id="e505699fc18903f73f96ddfe29a4cc694">Insert a new note above/below the current one.</li> <li>Insert a new note above/below the current one.</li>
<li data-list-item-id="e153bf42c4f955bb1421d586f9e7b5498">Archive/unarchive the current note.</li> <li>Archive/unarchive the current note.</li>
<li data-list-item-id="e3c0a0113e5bb4a69a9dfe90862f5ee1e">Delete the current note.</li> <li>Delete the current note.</li>
</ul> </ul>
</li> </li>
<li data-list-item-id="e1d6b1303eb3567b51fec1174993dcb71">If there are many notes within the column, move the mouse over the column <li>If there are many notes within the column, move the mouse over the column
and use the mouse wheel to scroll.</li> and use the mouse wheel to scroll.</li>
</ul> </ul>
<h3>Working with the note tree</h3> <h3>Working with the note tree</h3>
<p>It's also possible to add items on the board using the&nbsp;<a class="reference-link" <p>It's also possible to add items on the board using the&nbsp;<a class="reference-link"
href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</p> href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</p>
<ol> <ol>
<li data-list-item-id="ef31c436ab587f75725f224880891c063">Select the desired note in the&nbsp;<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</li> <li>Select the desired note in the&nbsp;<a class="reference-link" href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</li>
<li <li>Hold the mouse on the note and drag it to the to the desired column.</li>
data-list-item-id="e4e3b01f6a772fe9f5ea2bbb91f2b1f6d">Hold the mouse on the note and drag it to the to the desired column.</li>
</ol> </ol>
<p>This works for:</p> <p>This works for:</p>
<ul> <ul>
<li data-list-item-id="e4b395d82d6e6220afbacdca93b80bea3">Notes that are not children of the board, case in which a <a href="#root/_help_IakOLONlIfGI">clone</a> will <li>Notes that are not children of the board, case in which a <a href="#root/_help_IakOLONlIfGI">clone</a> will
be created.</li> be created.</li>
<li data-list-item-id="ef1eeff2b993c6285ed33440520254f7f">Notes that are children of the board, but not yet assigned on the board.</li> <li>Notes that are children of the board, but not yet assigned on the board.</li>
<li <li>Notes that are children of the board, case in which they will be moved
data-list-item-id="ee4610f6d74645e030570bfa9420dad61">Notes that are children of the board, case in which they will be moved
to the new column.</li> to the new column.</li>
</ul> </ul>
<h3>Keyboard interaction</h3> <h3>Keyboard interaction</h3>
<p>The board view has mild support for keyboard-based navigation:</p> <p>The board view has mild support for keyboard-based navigation:</p>
<ul> <ul>
<li data-list-item-id="ef209d621d05adddb8648e11c1aff106a">Use <kbd>Tab</kbd> and <kbd>Shift</kbd>+<kbd>Tab</kbd> to navigate between <li>Use <kbd>Tab</kbd> and <kbd>Shift</kbd>+<kbd>Tab</kbd> to navigate between
column titles, notes and the “New item” button for each of the columns, column titles, notes and the “New item” button for each of the columns,
in sequential order.</li> in sequential order.</li>
<li data-list-item-id="e48cffbf4ee1a7452c1e01277c8dd2cbf">To rename a column or a note, press <kbd>F2</kbd> while it is focused.</li> <li>To rename a column or a note, press <kbd>F2</kbd> while it is focused.</li>
<li <li>To open a specific note or create a new item, press <kbd>Enter</kbd> while
data-list-item-id="e02a6fb1c98d4e4b75e9e4245cf7cf6b1">To open a specific note or create a new item, press <kbd>Enter</kbd> while
it is focused.</li> it is focused.</li>
<li data-list-item-id="eec6f2285fa4d8e95f6a3d40cf51e3d69">To dismiss a rename of a note or a column, press <kbd>Escape</kbd>.</li> <li>To dismiss a rename of a note or a column, press <kbd>Escape</kbd>.</li>
</ul> </ul>
<h2>Configuration</h2> <h2>Configuration</h2>
<h3>Displaying custom attributes</h3> <h3>Displaying custom attributes</h3>
@ -109,30 +105,27 @@
<p>Note attributes can be displayed on the board to enhance it with custom <p>Note attributes can be displayed on the board to enhance it with custom
information such as adding a Due date for your tasks.</p> information such as adding a Due date for your tasks.</p>
<p>This feature works exclusively via attribute definitions (<a class="reference-link" <p>This feature works exclusively via attribute definitions (<a class="reference-link"
href="#root/zEY4DaJG4YT5/_help_OFXdgB2nNk1F">Promoted Attributes</a>). The easiest href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a>). The easiest way to
way to add these is:</p> add these is:</p>
<ol> <ol>
<li data-list-item-id="eb2220bf769a14b4d3c3763ddb412215a">Go to board note.</li> <li>Go to board note.</li>
<li data-list-item-id="ef2b3775a79f59cc97c77a69ca78a345e">In the ribbon select <em>Owned Attributes</em> → plus button → <em>Add new label/relation definition</em>.</li> <li>In the ribbon select <em>Owned Attributes</em> → plus button → <em>Add new label/relation definition</em>.</li>
<li <li>Configure the attribute as desired.</li>
data-list-item-id="e2565a4dfea04fba704b37927e6252ce4">Configure the attribute as desired.</li> <li>Check <em>Inheritable</em> to make it applicable to child notes automatically.</li>
<li data-list-item-id="ee18605ea5b4a07f7b3f5529ba00b2a57">Check <em>Inheritable</em> to make it applicable to child notes automatically.</li>
</ol> </ol>
<p>After creating the attribute, click on a note and fill in the promoted <p>After creating the attribute, click on a note and fill in the promoted
attributes which should then reflect inside the board.</p> attributes which should then reflect inside the board.</p>
<p>Of note:</p> <p>Of note:</p>
<ul> <ul>
<li data-list-item-id="e5a19ed95dbafe9a850690bea201deba1">Both promoted and non-promoted attribute definitions are supported. The <li>Both promoted and non-promoted attribute definitions are supported. The
only difference is that non-promoted attributes don't have an “Alias” for only difference is that non-promoted attributes don't have an “Alias” for
assigning a custom name.</li> assigning a custom name.</li>
<li data-list-item-id="e7ec69af7257cfe86e14bb803910872b4">Both “Single value” and “Multi value” attributes are supported. In case <li>Both “Single value” and “Multi value” attributes are supported. In case
of multi-value, a badge is displayed for every instance of the attribute.</li> of multi-value, a badge is displayed for every instance of the attribute.</li>
<li <li>All label types are supported, including dates, booleans and URLs.</li>
data-list-item-id="e810a5dbe56db7e59f9091e45c545a611">All label types are supported, including dates, booleans and URLs.</li> <li>Relation attributes are also supported as well, showing a link with the
<li
data-list-item-id="e49414fe2d9d206692332cd7d7ff1d4c0">Relation attributes are also supported as well, showing a link with the
target note title and icon.</li> target note title and icon.</li>
<li data-list-item-id="e1c3fb07ae71ca498c04613917eca93d4">Currently, it's not possible to adjust which promoted attributes are displayed, <li>Currently, it's not possible to adjust which promoted attributes are displayed,
since all promoted attributes will be displayed (except the <code>board:groupBy</code> one). since all promoted attributes will be displayed (except the <code>board:groupBy</code> one).
There are plans to improve upon this being able to hide promoted attributes There are plans to improve upon this being able to hide promoted attributes
individually.</li> individually.</li>
@ -147,36 +140,38 @@
<img style="aspect-ratio:535/245;" src="1_Kanban Board_image.png" <img style="aspect-ratio:535/245;" src="1_Kanban Board_image.png"
width="535" height="245"> width="535" height="245">
</figure> </figure>
<p>A more advanced use-case is grouping by <a href="#root/pOsGYCXsbNQG/tC7s2alapj8V/zEY4DaJG4YT5/_help_Cq5X6iKQop6R">Relations</a>.</p> <p>A more advanced use-case is grouping by <a href="#root/_help_Cq5X6iKQop6R">Relations</a>.</p>
<p>During this mode:</p> <p>During this mode:</p>
<ul> <ul>
<li data-list-item-id="e597b9ecddfae34bb858559de09ee1f6a">The columns represent the <em>target notes</em> of a relation.</li> <li>The columns represent the <em>target notes</em> of a relation.</li>
<li data-list-item-id="eb59f890b2223d7f3f43e7ebae747002d">When creating a new column, a note is selected instead of a column name.</li> <li>When creating a new column, a note is selected instead of a column name.</li>
<li <li>The column icon will match the target note.</li>
data-list-item-id="e566f9ab556f5c47b00ce0854def37bea">The column icon will match the target note.</li> <li>Moving notes between columns will change its relation.</li>
<li data-list-item-id="e43d3786e7e6590a003f16f3eb437bba5">Moving notes between columns will change its relation.</li> <li>Renaming an existing column will change the target note of all the notes
<li data-list-item-id="e5c2a414d0c80f0d1a67066078c7a4f79">Renaming an existing column will change the target note of all the notes
in that column.</li> in that column.</li>
</ul> </ul>
<p>Using relations instead of labels has some benefits:</p> <p>Using relations instead of labels has some benefits:</p>
<ul> <ul>
<li data-list-item-id="e580344f5638c09e80f566dc789db656a">The status/grouping of the notes is visible outside the Kanban board, <li>The status/grouping of the notes is visible outside the Kanban board,
for example on the&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_bdUJEHsAPYQR">Note Map</a>.</li> for example on the&nbsp;<a class="reference-link" href="#root/_help_bdUJEHsAPYQR">Note Map</a>.</li>
<li <li>Columns can have icons.</li>
data-list-item-id="e1d59fe7873950babd8e1f3dbcb913e1a">Columns can have icons.</li> <li>Renaming columns is less intensive since it simply involves changing the
<li data-list-item-id="e9933195c1f7708326f434321482cd917">Renaming columns is less intensive since it simply involves changing the
note title of the target note instead of having to do a bulk rename.</li> note title of the target note instead of having to do a bulk rename.</li>
</ul> </ul>
<p>To do so:</p> <p>To do so:</p>
<ol> <ol>
<li data-list-item-id="e66855292cf2639a13ecd642482681653">First, create a Kanban board from scratch and not a template:</li> <li>
<li <p>First, create a Kanban board from scratch and not a template:</p>
data-list-item-id="eaf16b94767674ca24de65ae102b84fc7">Assign <code>#viewType=board #hidePromotedAttributes</code> to emulate the </li>
default template.</li> <li>
<li data-list-item-id="e861d2859085e0dba83a44946fdc67c32">Set <code>#board:groupBy</code> to the name of a relation to group by, <strong>including the </strong><code><strong>~</strong></code><strong> prefix</strong> (e.g. <code>~status</code>).</li> <p>Assign <code>#viewType=board #hidePromotedAttributes</code> to emulate the
<li default template.</p>
data-list-item-id="efd300f3e766d485e28b7c8fd0a73364c"> </li>
<p>Optionally, use&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/zEY4DaJG4YT5/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;for <li>
<p>Set <code>#board:groupBy</code> to the name of a relation to group by, <strong>including the</strong> <code>**~**</code> <strong>prefix</strong> (e.g. <code>~status</code>).</p>
</li>
<li>
<p>Optionally, use&nbsp;<a class="reference-link" href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;for
easy status change within the note:</p><pre><code class="language-text-x-trilium-auto">#relation:status(inheritable)="promoted,alias=Status,single"</code></pre> easy status change within the note:</p><pre><code class="language-text-x-trilium-auto">#relation:status(inheritable)="promoted,alias=Status,single"</code></pre>
</li> </li>
</ol> </ol>

35
docs/Developer Guide/!!!meta.json vendored
View File

@ -1974,6 +1974,13 @@
"value": "i18n", "value": "i18n",
"isInheritable": false, "isInheritable": false,
"position": 20 "position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "lXjOyKpUSKgE",
"isInheritable": false,
"position": 30
} }
], ],
"format": "markdown", "format": "markdown",
@ -2071,6 +2078,34 @@
"format": "markdown", "format": "markdown",
"dataFileName": "Server translations.md", "dataFileName": "Server translations.md",
"attachments": [] "attachments": []
},
{
"isClone": false,
"noteId": "lXjOyKpUSKgE",
"notePath": [
"jdjRLhLV3TtI",
"yeqU0zo0ZQ83",
"TLXJwBDo8Rdv",
"lXjOyKpUSKgE"
],
"title": "Adding a new locale",
"notePosition": 40,
"prefix": null,
"isExpanded": false,
"type": "text",
"mime": "text/html",
"attributes": [
{
"type": "label",
"name": "shareAlias",
"value": "new-locale",
"isInheritable": false,
"position": 20
}
],
"format": "markdown",
"dataFileName": "Adding a new locale.md",
"attachments": []
} }
] ]
}, },

8
docs/Developer Guide/Developer Guide/Concepts/Internationalisation Translat.md vendored
View File

@ -15,7 +15,7 @@ One important aspect is the fact that we are using a key-based approach. This me
The key-based approach allows a hierarchical structure. For example, a key of `about.title` would be added in `translation.json` as follows: The key-based approach allows a hierarchical structure. For example, a key of `about.title` would be added in `translation.json` as follows:
```json ```
{ {
"about": { "about": {
"title": "About Trilium Notes" "title": "About Trilium Notes"
@ -27,11 +27,7 @@ Follow the <a class="reference-link" href="Internationalisation%20%20Translatio
### Adding a new locale ### Adding a new locale
To add a new locale, go to `src/public/translations` with your favorite text editor and copy the `en` directory. See <a class="reference-link" href="Internationalisation%20%20Translations/Adding%20a%20new%20locale.md">Adding a new locale</a>.
Rename the copy to the ISO code (e.g. `fr`, `ro`) of the language being translated.
Translations with a country-language combination, using their corresponding ISO code (e.g. `fr_FR`, `fr_BE`), has not been tested yet.
### Changing the language ### Changing the language

11
docs/Developer Guide/Developer Guide/Concepts/Internationalisation Translations/Adding a new locale.md vendored Normal file
View File

@ -0,0 +1,11 @@
# Adding a new locale
Once the Weblate translations for a single language have reached ~50% in coverage, it's time to add it to the application.
To do so:
1. In `packages/commons` look for `i18n.ts` and add a new entry to `UNSORTED_LOCALES` for the language.
2. In `apps/server` look for `services/i18n.ts` and add a mapping for the new language in `DAYJS_LOADER`. Sort the entire list.
3. In `apps/client`, look for `collections/calendar/index.tsx` and modify `LOCALE_MAPPINGS` to add support to the new language.
4. In `apps/client`, look for `widgets/type_widgets/canvas/i18n.ts` and modify `LANGUAGE_MAPPINGS`. A unit test ensures that the language is actually loadable.
5. In `apps/client`, look for `widgets/type_widgets/MindMap.tsx` and modify `LOCALE_MAPPINGS`. The type definitions should already validate if the new value is supported by Mind Elixir.
6. In `packages/ckeditor5`, look for `i18n.ts` and modify `LOCALE_MAPPINGS`. The import validation should already check if the new value is supported by CKEditor, and there's also a test to ensure it.

2
docs/Developer Guide/Developer Guide/Documentation.md vendored
View File

@ -1,5 +1,5 @@
# Documentation # Documentation
There are multiple types of documentation for Trilium:<img class="image-style-align-right" src="api/images/cJTTOrI5C1jn/Documentation_image.png" width="205" height="162"> There are multiple types of documentation for Trilium:<img class="image-style-align-right" src="api/images/5q5br2G87GtN/Documentation_image.png" width="205" height="162">
* The _User Guide_ represents the user-facing documentation. This documentation can be browsed by users directly from within Trilium, by pressing <kbd>F1</kbd>. * The _User Guide_ represents the user-facing documentation. This documentation can be browsed by users directly from within Trilium, by pressing <kbd>F1</kbd>.
* The _Developer's Guide_ represents a set of Markdown documents that present the internals of Trilium, for developers. * The _Developer's Guide_ represents a set of Markdown documents that present the internals of Trilium, for developers.

184
docs/User Guide/!!!meta.json vendored
View File

@ -9872,23 +9872,16 @@
"position": 10 "position": 10
}, },
{ {
"type": "label", "type": "relation",
"name": "iconClass", "name": "internalLink",
"value": "bx bx-columns", "value": "oPVyFC7WL2Lp",
"isInheritable": false,
"position": 10
},
{
"type": "label",
"name": "shareAlias",
"value": "kanban-board",
"isInheritable": false, "isInheritable": false,
"position": 20 "position": 20
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "Cq5X6iKQop6R", "value": "IakOLONlIfGI",
"isInheritable": false, "isInheritable": false,
"position": 30 "position": 30
}, },
@ -9902,23 +9895,30 @@
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "bdUJEHsAPYQR", "value": "Cq5X6iKQop6R",
"isInheritable": false, "isInheritable": false,
"position": 50 "position": 50
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "oPVyFC7WL2Lp", "value": "bdUJEHsAPYQR",
"isInheritable": false, "isInheritable": false,
"position": 60 "position": 60
}, },
{ {
"type": "relation", "type": "label",
"name": "internalLink", "name": "iconClass",
"value": "IakOLONlIfGI", "value": "bx bx-columns",
"isInheritable": false, "isInheritable": false,
"position": 70 "position": 10
},
{
"type": "label",
"name": "shareAlias",
"value": "kanban-board",
"isInheritable": false,
"position": 20
} }
], ],
"format": "markdown", "format": "markdown",
@ -9968,59 +9968,73 @@
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "KSZ04uQ2D1St", "value": "zEY4DaJG4YT5",
"isInheritable": false, "isInheritable": false,
"position": 10 "position": 10
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "0ESUbbAxVnoK", "value": "OFXdgB2nNk1F",
"isInheritable": false, "isInheritable": false,
"position": 20 "position": 20
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "XpOYSgsLkTJy", "value": "KSZ04uQ2D1St",
"isInheritable": false, "isInheritable": false,
"position": 30 "position": 30
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "oPVyFC7WL2Lp", "value": "0ESUbbAxVnoK",
"isInheritable": false, "isInheritable": false,
"position": 40 "position": 40
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "IakOLONlIfGI", "value": "XpOYSgsLkTJy",
"isInheritable": false, "isInheritable": false,
"position": 50 "position": 50
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "lgKX7r3aL30x", "value": "oPVyFC7WL2Lp",
"isInheritable": false, "isInheritable": false,
"position": 60 "position": 60
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "ZjLYv08Rp3qC", "value": "IakOLONlIfGI",
"isInheritable": false, "isInheritable": false,
"position": 70 "position": 70
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "BlN9DFI679QC", "value": "lgKX7r3aL30x",
"isInheritable": false, "isInheritable": false,
"position": 80 "position": 80
}, },
{
"type": "relation",
"name": "internalLink",
"value": "ZjLYv08Rp3qC",
"isInheritable": false,
"position": 90
},
{
"type": "relation",
"name": "internalLink",
"value": "BlN9DFI679QC",
"isInheritable": false,
"position": 100
},
{ {
"type": "label", "type": "label",
"name": "iconClass", "name": "iconClass",
@ -10034,20 +10048,6 @@
"value": "geomap", "value": "geomap",
"isInheritable": false, "isInheritable": false,
"position": 90 "position": 90
},
{
"type": "relation",
"name": "internalLink",
"value": "zEY4DaJG4YT5",
"isInheritable": false,
"position": 100
},
{
"type": "relation",
"name": "internalLink",
"value": "OFXdgB2nNk1F",
"isInheritable": false,
"position": 110
} }
], ],
"format": "markdown", "format": "markdown",
@ -11240,24 +11240,45 @@
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "BlN9DFI679QC", "value": "oPVyFC7WL2Lp",
"isInheritable": false, "isInheritable": false,
"position": 30 "position": 30
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "OFXdgB2nNk1F", "value": "eIg8jdvaoNNd",
"isInheritable": false, "isInheritable": false,
"position": 40 "position": 40
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "bwZpz2ajCEwO", "value": "CdNpE2pqjmI6",
"isInheritable": false, "isInheritable": false,
"position": 50 "position": 50
}, },
{
"type": "relation",
"name": "internalLink",
"value": "OFXdgB2nNk1F",
"isInheritable": false,
"position": 60
},
{
"type": "relation",
"name": "internalLink",
"value": "BlN9DFI679QC",
"isInheritable": false,
"position": 70
},
{
"type": "relation",
"name": "internalLink",
"value": "bwZpz2ajCEwO",
"isInheritable": false,
"position": 80
},
{ {
"type": "label", "type": "label",
"name": "shareAlias", "name": "shareAlias",
@ -11271,27 +11292,6 @@
"value": "bx bx-list-check", "value": "bx bx-list-check",
"isInheritable": false, "isInheritable": false,
"position": 110 "position": 110
},
{
"type": "relation",
"name": "internalLink",
"value": "oPVyFC7WL2Lp",
"isInheritable": false,
"position": 120
},
{
"type": "relation",
"name": "internalLink",
"value": "eIg8jdvaoNNd",
"isInheritable": false,
"position": 130
},
{
"type": "relation",
"name": "internalLink",
"value": "CdNpE2pqjmI6",
"isInheritable": false,
"position": 140
} }
], ],
"format": "markdown", "format": "markdown",
@ -11740,10 +11740,38 @@
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "bwZpz2ajCEwO", "value": "BlN9DFI679QC",
"isInheritable": false, "isInheritable": false,
"position": 20 "position": 20
}, },
{
"type": "relation",
"name": "internalLink",
"value": "bwZpz2ajCEwO",
"isInheritable": false,
"position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "GTwFsgaA0lCt",
"isInheritable": false,
"position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "zP3PMqaG71Ct",
"isInheritable": false,
"position": 50
},
{
"type": "relation",
"name": "internalLink",
"value": "R9pX4DGra2Vt",
"isInheritable": false,
"position": 60
},
{ {
"type": "label", "type": "label",
"name": "shareAlias", "name": "shareAlias",
@ -11757,34 +11785,6 @@
"value": "bx bx-table", "value": "bx bx-table",
"isInheritable": false, "isInheritable": false,
"position": 20 "position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "BlN9DFI679QC",
"isInheritable": false,
"position": 50
},
{
"type": "relation",
"name": "internalLink",
"value": "GTwFsgaA0lCt",
"isInheritable": false,
"position": 60
},
{
"type": "relation",
"name": "internalLink",
"value": "zP3PMqaG71Ct",
"isInheritable": false,
"position": 70
},
{
"type": "relation",
"name": "internalLink",
"value": "R9pX4DGra2Vt",
"isInheritable": false,
"position": 80
} }
], ],
"format": "markdown", "format": "markdown",