Dockery/Trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-10-31 18:36:30 +01:00
Code Issues Packages Projects Releases Activity

feat(docs): document the items of the ribbon

Browse Source
This commit is contained in:
Elian Doran
2025-04-03 21:40:02 +03:00
parent 25fe6c2690
commit a4f39d6376
11 changed files with 835 additions and 277 deletions
Download Patch File Download Diff File Expand all files Collapse all files

209
docs/User Guide/!!!meta.json
View File

@@ -1265,19 +1265,159 @@
"type": "text", "type": "text",
"mime": "text/html", "mime": "text/html",
"attributes": [ "attributes": [
{
"type": "relation",
"name": "internalLink",
"value": "4TIF1oA4VQRO",
"isInheritable": false,
"position": 10
},
{ {
"type": "label", "type": "label",
"name": "iconClass", "name": "iconClass",
"value": "bx bx-dots-horizontal", "value": "bx bx-dots-horizontal",
"isInheritable": false, "isInheritable": false,
"position": 20 "position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "KSZ04uQ2D1St",
"isInheritable": false,
"position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "4FahAwuGTAwC",
"isInheritable": false,
"position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "bwg0e8ewQMak",
"isInheritable": false,
"position": 50
},
{
"type": "relation",
"name": "internalLink",
"value": "CoFPLs3dRlXc",
"isInheritable": false,
"position": 60
},
{
"type": "relation",
"name": "internalLink",
"value": "xYmIYSP6wE3F",
"isInheritable": false,
"position": 70
},
{
"type": "relation",
"name": "internalLink",
"value": "u3YFHC9tQlpm",
"isInheritable": false,
"position": 80
},
{
"type": "relation",
"name": "internalLink",
"value": "WOcw2SLH6tbX",
"isInheritable": false,
"position": 90
},
{
"type": "relation",
"name": "internalLink",
"value": "R9pX4DGra2Vt",
"isInheritable": false,
"position": 100
},
{
"type": "relation",
"name": "internalLink",
"value": "KC1HB96bqqHX",
"isInheritable": false,
"position": 110
},
{
"type": "relation",
"name": "internalLink",
"value": "veGu4faJErEM",
"isInheritable": false,
"position": 120
},
{
"type": "relation",
"name": "internalLink",
"value": "nRhnJkTT8cPs",
"isInheritable": false,
"position": 130
},
{
"type": "relation",
"name": "internalLink",
"value": "zEY4DaJG4YT5",
"isInheritable": false,
"position": 140
},
{
"type": "relation",
"name": "internalLink",
"value": "OFXdgB2nNk1F",
"isInheritable": false,
"position": 150
},
{
"type": "relation",
"name": "internalLink",
"value": "bwZpz2ajCEwO",
"isInheritable": false,
"position": 160
},
{
"type": "relation",
"name": "internalLink",
"value": "IakOLONlIfGI",
"isInheritable": false,
"position": 170
},
{
"type": "relation",
"name": "internalLink",
"value": "oPVyFC7WL2Lp",
"isInheritable": false,
"position": 180
},
{
"type": "relation",
"name": "internalLink",
"value": "xWtq5NUHOwql",
"isInheritable": false,
"position": 190
},
{
"type": "relation",
"name": "internalLink",
"value": "m1lbrzyKDaRB",
"isInheritable": false,
"position": 200
},
{
"type": "relation",
"name": "internalLink",
"value": "wX4HbRucYSDD",
"isInheritable": false,
"position": 210
},
{
"type": "relation",
"name": "internalLink",
"value": "4TIF1oA4VQRO",
"isInheritable": false,
"position": 220
},
{
"type": "relation",
"name": "internalLink",
"value": "l0tKav7yLHGF",
"isInheritable": false,
"position": 230
} }
], ],
"format": "markdown", "format": "markdown",
@@ -2420,6 +2560,34 @@
"dataFileName": "1_Workspace_image.png" "dataFileName": "1_Workspace_image.png"
} }
] ]
},
{
"isClone": false,
"noteId": "xWtq5NUHOwql",
"notePath": [
"pOsGYCXsbNQG",
"gh7bpGYxajRS",
"wArbEsdSae6g",
"xWtq5NUHOwql"
],
"title": "Similar Notes",
"notePosition": 80,
"prefix": null,
"isExpanded": false,
"type": "text",
"mime": "text/html",
"attributes": [
{
"type": "label",
"name": "iconClass",
"value": "bx bx-bar-chart",
"isInheritable": false,
"position": 10
}
],
"format": "markdown",
"dataFileName": "Similar Notes.md",
"attachments": []
} }
] ]
}, },
@@ -7194,6 +7362,33 @@
"attachments": [] "attachments": []
} }
] ]
},
{
"isClone": false,
"noteId": "m1lbrzyKDaRB",
"notePath": [
"pOsGYCXsbNQG",
"tC7s2alapj8V",
"m1lbrzyKDaRB"
],
"title": "Note ID",
"notePosition": 180,
"prefix": null,
"isExpanded": false,
"type": "text",
"mime": "text/html",
"attributes": [
{
"type": "label",
"name": "iconClass",
"value": "bx bx-hash",
"isInheritable": false,
"position": 10
}
],
"format": "markdown",
"dataFileName": "Note ID.md",
"attachments": []
} }
] ]
}, },

0
docs/User Guide/User Guide/Advanced Usage/Note ID.md Normal file
View File

0
docs/User Guide/User Guide/Basic Concepts and Features/Navigation/Similar Notes.md Normal file
View File

56
docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Ribbon.md
View File

@@ -6,3 +6,59 @@ The ribbon allows changing options, attributes and viewing information about the
## Settings ## Settings
It is possible to change whether some ribbon items will be automatically open when navigating to a new note. To do so, in [Settings](Options.md), go to _Appearance_ and look for the _Ribbon widgets_ section. It is possible to change whether some ribbon items will be automatically open when navigating to a new note. To do so, in [Settings](Options.md), go to _Appearance_ and look for the _Ribbon widgets_ section.
## Formatting
If you are using the _Fixed_ formatting toolbar, all the formatting buttons for text notes will appear here. See [Formatting toolbar](../../Note%20Types/Text/Formatting%20toolbar.md) for more information.
## Tabs
### Basic Properties
* _**Note type**_ allows changing the [note type](../../Note%20Types) of a note.
* Generally this is desirable only if the note is empty.
* As a more advanced use, it's possible to change the note type in order to modify the [source code](../../Advanced%20Usage/Note%20source.md) of a note.
* _**Protect the note**_ toggles whether the current note is encrypted and accessible only by entering the protected session. See [Protected Notes](../Notes/Protected%20Notes.md) for more information.
* _**Editable**_ changes whether the current note:
* Enters [read-only mode](../Notes/Read-Only%20Notes.md) automatically if the note is too big (default behaviour).
* Is always in read-only mode (however it can still be edited temporarily).
* Is always editable, regardless of its size.
* _**Bookmark**_ toggles the display of the current note into the [Launch Bar](Launch%20Bar.md) for easy access. See [Bookmarks](../Navigation/Bookmarks.md) for more information.
* _**Shared**_ toggles whether the current note is publicly accessible if you have a [server instance](../../Installation%20%26%20Setup/Server%20Installation.md) set up. See [Sharing](../../Advanced%20Usage/Sharing.md) for more information.
* _**Template**_ toggles whether the current note is considered a template and can be used to easily create notes with the same content. See [Template](../../Advanced%20Usage/Attributes/Template.md) for more information.
* _**Language**_ changes the main language of the current note, mostly useful for spell checking or right-to-left support. See [Content language & Right-to-left support](../../Note%20Types/Text/Content%20language%20%26%20Right-to-le.md) for more information.
### Owned Attributes
This section allows editing the labels and relations of a note. For more information, see [Attributes](../../Advanced%20Usage/Attributes.md).
The plus button to the right offers a simplified way to insert labels and relations, via a graphical input. From this menu, it's also possible to define label and relation definitions (see [Promoted Attributes](../../Advanced%20Usage/Attributes/Promoted%20Attributes.md)).
### Inherited Attributes
This section displays the attributes which are applied to this note via [Attribute Inheritance](../../Advanced%20Usage/Attributes/Attribute%20Inheritance.md). It is not possible to alter the attributes from this section.
### Note Paths
This section displays all the places where the current note has been cloned to. Here the current note can also be cloned to a new location (similar to the [Note Tree](Note%20Tree.md)) See [Cloning Notes](../Notes/Cloning%20Notes.md) for more information.
### Note Map
The note map displays all the relations of the current note to other notes, as well as the subtree structure. See [Note Tree](Note%20Tree.md) for more information.
### Similar Notes
This section lists all the notes that are similar to the current one. See [Similar Notes](../Navigation/Similar%20Notes.md) for more information.
### Note Info
This section displays information about the current note:
* The [internal ID](../../Advanced%20Usage/Note%20ID.md) of the note.
* The [type of the note](../../Note%20Types), as well as its MIME type (used mostly for exporting notes).
* The created and modification dates.
* The estimated size of the note in the [Database](../../Advanced%20Usage/Database.md), as well as its children count and size.
### Edited notes
This section pops automatically when entering a [day note](../../Advanced%20Usage/Advanced%20Showcases/Day%20Notes.md) and shows the notes that were edited that day.

209
src/public/app/doc_notes/en/User Guide/!!!meta.json generated
View File

@@ -1265,19 +1265,159 @@
"type": "text", "type": "text",
"mime": "text/html", "mime": "text/html",
"attributes": [ "attributes": [
{
"type": "relation",
"name": "internalLink",
"value": "4TIF1oA4VQRO",
"isInheritable": false,
"position": 10
},
{ {
"type": "label", "type": "label",
"name": "iconClass", "name": "iconClass",
"value": "bx bx-dots-horizontal", "value": "bx bx-dots-horizontal",
"isInheritable": false, "isInheritable": false,
"position": 20 "position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "KSZ04uQ2D1St",
"isInheritable": false,
"position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "4FahAwuGTAwC",
"isInheritable": false,
"position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "bwg0e8ewQMak",
"isInheritable": false,
"position": 50
},
{
"type": "relation",
"name": "internalLink",
"value": "CoFPLs3dRlXc",
"isInheritable": false,
"position": 60
},
{
"type": "relation",
"name": "internalLink",
"value": "xYmIYSP6wE3F",
"isInheritable": false,
"position": 70
},
{
"type": "relation",
"name": "internalLink",
"value": "u3YFHC9tQlpm",
"isInheritable": false,
"position": 80
},
{
"type": "relation",
"name": "internalLink",
"value": "WOcw2SLH6tbX",
"isInheritable": false,
"position": 90
},
{
"type": "relation",
"name": "internalLink",
"value": "R9pX4DGra2Vt",
"isInheritable": false,
"position": 100
},
{
"type": "relation",
"name": "internalLink",
"value": "KC1HB96bqqHX",
"isInheritable": false,
"position": 110
},
{
"type": "relation",
"name": "internalLink",
"value": "veGu4faJErEM",
"isInheritable": false,
"position": 120
},
{
"type": "relation",
"name": "internalLink",
"value": "nRhnJkTT8cPs",
"isInheritable": false,
"position": 130
},
{
"type": "relation",
"name": "internalLink",
"value": "zEY4DaJG4YT5",
"isInheritable": false,
"position": 140
},
{
"type": "relation",
"name": "internalLink",
"value": "OFXdgB2nNk1F",
"isInheritable": false,
"position": 150
},
{
"type": "relation",
"name": "internalLink",
"value": "bwZpz2ajCEwO",
"isInheritable": false,
"position": 160
},
{
"type": "relation",
"name": "internalLink",
"value": "IakOLONlIfGI",
"isInheritable": false,
"position": 170
},
{
"type": "relation",
"name": "internalLink",
"value": "oPVyFC7WL2Lp",
"isInheritable": false,
"position": 180
},
{
"type": "relation",
"name": "internalLink",
"value": "xWtq5NUHOwql",
"isInheritable": false,
"position": 190
},
{
"type": "relation",
"name": "internalLink",
"value": "m1lbrzyKDaRB",
"isInheritable": false,
"position": 200
},
{
"type": "relation",
"name": "internalLink",
"value": "wX4HbRucYSDD",
"isInheritable": false,
"position": 210
},
{
"type": "relation",
"name": "internalLink",
"value": "4TIF1oA4VQRO",
"isInheritable": false,
"position": 220
},
{
"type": "relation",
"name": "internalLink",
"value": "l0tKav7yLHGF",
"isInheritable": false,
"position": 230
} }
], ],
"format": "html", "format": "html",
@@ -2420,6 +2560,34 @@
"dataFileName": "1_Workspace_image.png" "dataFileName": "1_Workspace_image.png"
} }
] ]
},
{
"isClone": false,
"noteId": "xWtq5NUHOwql",
"notePath": [
"pOsGYCXsbNQG",
"gh7bpGYxajRS",
"wArbEsdSae6g",
"xWtq5NUHOwql"
],
"title": "Similar Notes",
"notePosition": 80,
"prefix": null,
"isExpanded": false,
"type": "text",
"mime": "text/html",
"attributes": [
{
"type": "label",
"name": "iconClass",
"value": "bx bx-bar-chart",
"isInheritable": false,
"position": 10
}
],
"format": "html",
"dataFileName": "Similar Notes.html",
"attachments": []
} }
] ]
}, },
@@ -7194,6 +7362,33 @@
"attachments": [] "attachments": []
} }
] ]
},
{
"isClone": false,
"noteId": "m1lbrzyKDaRB",
"notePath": [
"pOsGYCXsbNQG",
"tC7s2alapj8V",
"m1lbrzyKDaRB"
],
"title": "Note ID",
"notePosition": 180,
"prefix": null,
"isExpanded": false,
"type": "text",
"mime": "text/html",
"attributes": [
{
"type": "label",
"name": "iconClass",
"value": "bx bx-hash",
"isInheritable": false,
"position": 10
}
],
"format": "html",
"dataFileName": "Note ID.html",
"attachments": []
} }
] ]
}, },

19
src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Note ID.html generated Normal file
View File

@@ -0,0 +1,19 @@
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../../style.css">
<base target="_parent">
<title data-trilium-title>Note ID</title>
</head>
<body>
<div class="content">
<h1 data-trilium-h1>Note ID</h1>
<div class="ck-content"></div>
</div>
</body>
</html>

19
src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Navigation/Similar Notes.html generated Normal file
View File

@@ -0,0 +1,19 @@
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../../../style.css">
<base target="_parent">
<title data-trilium-title>Similar Notes</title>
</head>
<body>
<div class="content">
<h1 data-trilium-h1>Similar Notes</h1>
<div class="ck-content"></div>
</div>
</body>
</html>

86
src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Ribbon.html generated
View File

@@ -22,6 +22,92 @@
<p>It is possible to change whether some ribbon items will be automatically <p>It is possible to change whether some ribbon items will be automatically
open when navigating to a new note. To do so, in&nbsp;<a href="Options.html">Settings</a>, open when navigating to a new note. To do so, in&nbsp;<a href="Options.html">Settings</a>,
go to <em>Appearance</em> and look for the <em>Ribbon widgets</em> section.</p> go to <em>Appearance</em> and look for the <em>Ribbon widgets</em> section.</p>
<h2>Formatting</h2>
<p>If you are using the <em>Fixed</em> formatting toolbar, all the formatting
buttons for text notes will appear here. See&nbsp;<a class="reference-link"
href="../../Note%20Types/Text/Formatting%20toolbar.html">Formatting toolbar</a>&nbsp;for
more information.</p>
<h2>Tabs</h2>
<h3>Basic Properties</h3>
<ul>
<li><em><strong>Note type</strong></em> allows changing the <a href="../../Note%20Types">note type</a> of
a note.
<ul>
<li>Generally this is desirable only if the note is empty.</li>
<li>As a more advanced use, it's possible to change the note type in order
to modify the <a href="../../Advanced%20Usage/Note%20source.html">source code</a> of
a note.</li>
</ul>
</li>
<li><em><strong>Protect the note</strong></em> toggles whether the current
note is encrypted and accessible only by entering the protected session.
See&nbsp;<a class="reference-link" href="../Notes/Protected%20Notes.html">Protected Notes</a>&nbsp;for
more information.</li>
<li><em><strong>Editable</strong> </em>changes whether the current note:
<ul>
<li>Enters <a href="../Notes/Read-Only%20Notes.html">read-only mode</a> automatically
if the note is too big (default behaviour).</li>
<li>Is always in read-only mode (however it can still be edited temporarily).</li>
<li>Is always editable, regardless of its size.</li>
</ul>
</li>
<li><em><strong>Bookmark</strong></em> toggles the display of the current note
into the&nbsp;<a class="reference-link" href="Launch%20Bar.html">Launch Bar</a>&nbsp;for
easy access. See&nbsp;<a class="reference-link" href="../Navigation/Bookmarks.html">Bookmarks</a>&nbsp;for
more information.</li>
<li><em><strong>Shared</strong></em> toggles whether the current note is publicly
accessible if you have a <a href="../../Installation%20%26%20Setup/Server%20Installation.html">server instance</a> set
up. See&nbsp;<a class="reference-link" href="../../Advanced%20Usage/Sharing.html">Sharing</a>&nbsp;for
more information.</li>
<li><em><strong>Template</strong></em> toggles whether the current note is
considered a template and can be used to easily create notes with the same
content. See&nbsp;<a class="reference-link" href="../../Advanced%20Usage/Attributes/Template.html">Template</a>&nbsp;for
more information.</li>
<li><em><strong>Language</strong></em> changes the main language of the current
note, mostly useful for spell checking or right-to-left support. See&nbsp;
<a
class="reference-link" href="../../Note%20Types/Text/Content%20language%20%26%20Right-to-le.html">Content language &amp; Right-to-left support</a>&nbsp;for more information.</li>
</ul>
<h3>Owned Attributes</h3>
<p>This section allows editing the labels and relations of a note. For more
information, see&nbsp;<a class="reference-link" href="../../Advanced%20Usage/Attributes.html">Attributes</a>.</p>
<p>The plus button to the right offers a simplified way to insert labels
and relations, via a graphical input. From this menu, it's also possible
to define label and relation definitions (see&nbsp;<a class="reference-link"
href="../../Advanced%20Usage/Attributes/Promoted%20Attributes.html">Promoted Attributes</a>).</p>
<h3>Inherited Attributes</h3>
<p>This section displays the attributes which are applied to this note via&nbsp;
<a
class="reference-link" href="../../Advanced%20Usage/Attributes/Attribute%20Inheritance.html">Attribute Inheritance</a>. It is not possible to alter the attributes
from this section.</p>
<h3>Note Paths</h3>
<p>This section displays all the places where the current note has been cloned
to. Here the current note can also be cloned to a new location (similar
to the&nbsp;<a class="reference-link" href="Note%20Tree.html">Note Tree</a>)
See&nbsp;<a class="reference-link" href="../Notes/Cloning%20Notes.html">Cloning Notes</a>&nbsp;for
more information.</p>
<h3>Note Map</h3>
<p>The note map displays all the relations of the current note to other notes,
as well as the subtree structure. See&nbsp;<a class="reference-link" href="Note%20Tree.html">Note Tree</a>&nbsp;for
more information.</p>
<h3>Similar Notes</h3>
<p>This section lists all the notes that are similar to the current one.
See&nbsp;<a class="reference-link" href="../Navigation/Similar%20Notes.html">Similar Notes</a>&nbsp;for
more information.</p>
<h3>Note Info</h3>
<p>This section displays information about the current note:</p>
<ul>
<li>The <a href="../../Advanced%20Usage/Note%20ID.html">internal ID</a> of the
note.</li>
<li>The <a href="../../Note%20Types">type of the note</a>, as well as its MIME
type (used mostly for exporting notes).</li>
<li>The created and modification dates.</li>
<li>The estimated size of the note in the&nbsp;<a class="reference-link" href="../../Advanced%20Usage/Database.html">Database</a>,
as well as its children count and size.</li>
</ul>
<h3>Edited notes</h3>
<p>This section pops automatically when entering a <a href="../../Advanced%20Usage/Advanced%20Showcases/Day%20Notes.html">day note</a> and
shows the notes that were edited that day.</p>
</div> </div>
</div> </div>
</body> </body>

425
src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Geo map.html generated
View File

@@ -14,34 +14,33 @@
<div class="ck-content"> <div class="ck-content">
<h2>Creating a new geo map</h2> <h2>Creating a new geo map</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="8_Geo map_image.png">
<img src="8_Geo map_image.png"> </td>
</td> <td>Right click on any note on the note tree and select <em>Insert child note</em> → <em>Geo Map (beta)</em>.</td>
<td>Right click on any note on the note tree and select <em>Insert child note</em> → <em>Geo Map (beta)</em>.</td> </tr>
</tr> <tr>
<tr> <td>2</td>
<td>2</td> <td>
<td> <img src="10_Geo map_image.png">
<img src="10_Geo map_image.png"> </td>
</td> <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>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>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
@@ -50,57 +49,56 @@
<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>
<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>
<td>&nbsp;</td> <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="15_Geo map_image.png">button on the top-right of the map.&nbsp;&nbsp;
<img src="15_Geo map_image.png">button on the top-right of the map.&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 ( <img src="2_Geo map_image.png">) in the top-right of the map.</td>
<img src="2_Geo map_image.png">) in the top-right of the map.</td> </tr>
</tr> <tr>
<tr> <td>2</td>
<td>2</td> <td>
<td> <img src="3_Geo map_image.png">
<img src="3_Geo map_image.png"> </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;
the notification.&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> </tr>
</tr> <tr>
<tr> <td>3</td>
<td>3</td> <td>
<td> <img src="9_Geo map_image.png">
<img src="9_Geo map_image.png"> </td>
</td> <td>Enter the name of the marker/note to be created.</td>
<td>Enter the name of the marker/note to be created.</td> </tr>
</tr> <tr>
<tr> <td>4</td>
<td>4</td> <td>
<td> <img src="16_Geo map_image.png">
<img src="16_Geo map_image.png"> </td>
</td> <td>Once confirmed, the marker will show up on the map and it will also be
<td>Once confirmed, the marker will show up on the map and it will also be 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> <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> <p>
@@ -137,10 +135,9 @@
</li> </li>
</ul> </ul>
<h2>Icon and color of the markers</h2> <h2>Icon and color of the markers</h2>
<figure class="image image-style-align-center"> <p>
<img style="aspect-ratio:523/295;" src="Geo map_image.jpg" alt="image" <img src="Geo map_image.jpg" alt="image">
width="523" height="295"> </p>
</figure>
<p>The markers will have the same icon as the note.</p> <p>The markers will have the same icon as the note.</p>
<p>It's possible to add a custom color to a marker by assigning them a <code>#color</code> attribute <p>It's possible to add a custom color to a marker by assigning them a <code>#color</code> attribute
such as <code>#color=green</code>.</p> such as <code>#color=green</code>.</p>
@@ -150,141 +147,137 @@
<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></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="12_Geo map_image.png">
<img src="12_Geo map_image.png"> </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;
on it and a context menu will show up.&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;
be copied to clipboard.&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> </tr>
</tr> <tr>
<tr> <td>2</td>
<td>2</td> <td>
<td> <img src="5_Geo map_image.png">
<img src="5_Geo map_image.png"> </td>
</td> <td>In Trilium, create a child note under the map.</td>
<td>In Trilium, create a child note under the map.</td> </tr>
</tr> <tr>
<tr> <td>3</td>
<td>3</td> <td>
<td> <img src="11_Geo map_image.png">
<img src="11_Geo map_image.png"> </td>
</td> <td>And then go to Owned Attributes and type <code>#geolocation="</code>, then
<td>And then go to Owned Attributes and type <code>#geolocation="</code>, then paste from the clipboard as-is and then add the ending <code>"</code> character.
paste from the clipboard as-is and then add the ending <code>"</code> character. Press Enter to confirm and the map should now be updated to contain the
Press Enter to confirm and the map should now be updated to contain the 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></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="1_Geo map_image.png">
<img src="1_Geo map_image.png"> </td>
</td> <td>Go to any location on openstreetmap.org and right click to bring up the
<td>Go to any location on openstreetmap.org and right click to bring up the context menu. Select the “Show address” item.</td>
context menu. Select the “Show address” item.</td> </tr>
</tr> <tr>
<tr> <td>2</td>
<td>2</td> <td>
<td> <img src="Geo map_image.png">
<img src="Geo map_image.png"> </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;
of the search bar.&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> <tr>
<tr> <td>3</td>
<td>3</td> <td>
<td> <img src="6_Geo map_image.png">
<img src="6_Geo map_image.png"> </td>
</td> <td>Simply paste the value inside the text box into the <code>#geolocation</code> attribute
<td>Simply paste the value inside the text box into the <code>#geolocation</code> attribute 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"> <thead>
<table> <tr>
<thead> <th></th>
<tr> <th></th>
<th>&nbsp;</th> <th></th>
<th>&nbsp;</th> </tr>
<th>&nbsp;</th> </thead>
</tr> <tbody>
</thead> <tr>
<tbody> <td>1</td>
<tr> <td>
<td>1</td> <img src="4_Geo map_image.png">
<td> </td>
<img src="4_Geo map_image.png"> <td>To add a track, simply drag &amp; drop a .gpx file inside the geo map
</td> in the note tree.</td>
<td>To add a track, simply drag &amp; drop a .gpx file inside the geo map </tr>
in the note tree.</td> <tr>
</tr> <td>2</td>
<tr> <td>
<td>2</td> <img src="14_Geo map_image.png">
<td> </td>
<img src="14_Geo map_image.png"> <td>In order for the file to be recognized as a GPS track, it needs to show
</td> up as <code>application/gpx+xml</code> in the <em>File type</em> field.</td>
<td>In order for the file to be recognized as a GPS track, it needs to show </tr>
up as <code>application/gpx+xml</code> in the <em>File type</em> field.</td> <tr>
</tr> <td>3</td>
<tr> <td>
<td>3</td> <img src="7_Geo map_image.png">
<td> </td>
<img src="7_Geo map_image.png"> <td>When going back to the map, the track should now be visible.&nbsp;&nbsp;
</td> <br>
<td>When going back to the map, the track should now be visible.&nbsp;&nbsp; <br>The start and end points of the track are indicated by the two blue markers.</td>
<br> </tr>
<br>The start and end points of the track are indicated by the two blue markers.</td> </tbody>
</tr> </table>
</tbody>
</table> <h2>Troubleshooting</h2>
</figure> <p>
<h2>Troubleshooting</h2> <img src="13_Geo map_image.png">
<p> </p>
<img src="13_Geo map_image.png"> <h3>Grid-like artifacts on the map</h3>
</p> <p>This occurs if the application is not at 100% zoom which causes the pixels
<h3>Grid-like artifacts on the map</h3> of the map to not render correctly due to fractional scaling. The only
<p>This occurs if the application is not at 100% zoom which causes the pixels possible solution is to set the UI zoom at 100% (default keyboard shortcut
of the map to not render correctly due to fractional scaling. The only is <kbd>Ctrl</kbd>+<kbd>0</kbd>).</p>
possible solution is to set the UI zoom at 100% (default keyboard shortcut
is <kbd>Ctrl</kbd>+<kbd>0</kbd>).</p>
</div> </div>
</div> </div>
</body> </body>

82
src/public/app/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme.html generated
View File

@@ -19,52 +19,42 @@
keep them into one place.</p> keep them into one place.</p>
<p>As such, the first step is to create a new note to gather all the themes.</p> <p>As such, the first step is to create a new note to gather all the themes.</p>
<p> <p>
<img src="1_Creating a custom theme_5_.png" width="181" height="84"> <img src="1_Creating a custom theme_5_.png">
</p> </p>
<h2>Step 2. Create the theme</h2> <h2>Step 2. Create the theme</h2>
<figure class="table"> <table>
<table> <thead>
<thead> <tr>
<tr> <th></th>
<th>&nbsp;</th> <th></th>
<th>&nbsp;</th> </tr>
</tr> </thead>
</thead> <tbody>
<tbody> <tr>
<tr> <td>
<td> <img src="Creating a custom theme_3_.png">
<figure class="image"> </td>
<img style="aspect-ratio:651/220;" src="Creating a custom theme_3_.png" <td>Themes are code notes with a special attribute. Start by creating a new
width="651" height="220"> code note.</td>
</figure> </tr>
</td> <tr>
<td>Themes are code notes with a special attribute. Start by creating a new <td>
code note.</td> <img src="Creating a custom theme_1_.png">
</tr> </td>
<tr> <td>Then change the note type to a CSS code.</td>
<td> </tr>
<figure class="image"> <tr>
<img style="aspect-ratio:302/349;" src="Creating a custom theme_1_.png" <td>
width="302" height="349"> <img src="Creating a custom theme_Cr.png">
</figure> </td>
</td> <td>In the <em>Owned Attributes</em> section define the <code>#appTheme</code> attribute
<td>Then change the note type to a CSS code.</td> to point to any desired name. This is the name that will show up in the
</tr> appearance section in settings.</td>
<tr> </tr>
<td> </tbody>
<figure class="image"> </table>
<img style="aspect-ratio:316/133;" src="Creating a custom theme_Cr.png"
width="316" height="133"> <h2>Step 3. Define the theme's CSS</h2>
</figure>
</td>
<td>In the <em>Owned Attributes</em> section define the <code>#appTheme</code> attribute
to point to any desired name. This is the name that will show up in the
appearance section in settings.</td>
</tr>
</tbody>
</table>
</figure>
<h2>Step 3. Define the theme's CSS</h2>
<p>As a very simple example we will change the background color of the launcher <p>As a very simple example we will change the background color of the launcher
pane to a shade of blue.</p> pane to a shade of blue.</p>
<p>To alter the different variables of the theme:</p><pre><code class="language-text-css">:root { <p>To alter the different variables of the theme:</p><pre><code class="language-text-css">:root {
@@ -74,11 +64,11 @@
<p>Refresh the application (Ctrl+Shift+R is a good way to do so) and go to <p>Refresh the application (Ctrl+Shift+R is a good way to do so) and go to
settings. You should see the newly created theme:</p> settings. You should see the newly created theme:</p>
<p> <p>
<img src="Creating a custom theme_2_.png" width="631" height="481"> <img src="Creating a custom theme_2_.png">
</p> </p>
<p>Afterwards the application will refresh itself with the new theme:</p> <p>Afterwards the application will refresh itself with the new theme:</p>
<p> <p>
<img src="Creating a custom theme_4_.png" width="653" height="554"> <img src="Creating a custom theme_4_.png">
</p> </p>
<p>Do note that the theme will be based off of the legacy theme. To override <p>Do note that the theme will be based off of the legacy theme. To override
that and base the theme on the new TriliumNext theme, see:&nbsp;<a href="Customize%20the%20Next%20theme.html">Theme base (legacy vs. next)</a> that and base the theme on the new TriliumNext theme, see:&nbsp;<a href="Customize%20the%20Next%20theme.html">Theme base (legacy vs. next)</a>

5
src/public/app/doc_notes/en/User Guide/navigation.html generated
View File

@@ -156,6 +156,9 @@
<li><a href="User%20Guide/Basic%20Concepts%20and%20Features/Navigation/Workspace.html" <li><a href="User%20Guide/Basic%20Concepts%20and%20Features/Navigation/Workspace.html"
target="detail">Workspace</a> target="detail">Workspace</a>
</li> </li>
<li><a href="User%20Guide/Basic%20Concepts%20and%20Features/Navigation/Similar%20Notes.html"
target="detail">Similar Notes</a>
</li>
</ul> </ul>
</li> </li>
<li><a href="User%20Guide/Basic%20Concepts%20and%20Features/Keyboard%20Shortcuts.html" <li><a href="User%20Guide/Basic%20Concepts%20and%20Features/Keyboard%20Shortcuts.html"
@@ -410,6 +413,8 @@
</li> </li>
</ul> </ul>
</li> </li>
<li><a href="User%20Guide/Advanced%20Usage/Note%20ID.html" target="detail">Note ID</a>
</li>
</ul> </ul>
</li> </li>
<li>Attachments <li>Attachments