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 note types

Browse Source
This commit is contained in:
Elian Doran
2025-04-04 21:29:18 +03:00
parent cf46f8cf70
commit 2a8ab728a7
13 changed files with 463 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1436,7 +1436,7 @@
"3seOhtN8uLIY"
],
"title": "Tabs",
"notePosition": 50,
"notePosition": 60,
"prefix": null,
"isExpanded": false,
"type": "text",
@@ -1510,7 +1510,7 @@
"xYmIYSP6wE3F"
],
"title": "Launch Bar",
"notePosition": 90,
"notePosition": 100,
"prefix": null,
"isExpanded": false,
"type": "text",
@@ -1603,7 +1603,7 @@
"Ms1nauBra7gq"
],
"title": "Quick search",
"notePosition": 100,
"notePosition": 110,
"prefix": null,
"isExpanded": false,
"type": "text",
@@ -1631,7 +1631,7 @@
"8YBEPzcpUgxw"
],
"title": "Note buttons",
"notePosition": 110,
"notePosition": 120,
"prefix": null,
"isExpanded": false,
"type": "text",
@@ -1696,7 +1696,7 @@
"4TIF1oA4VQRO"
],
"title": "Options",
"notePosition": 120,
"notePosition": 130,
"prefix": null,
"isExpanded": false,
"type": "text",
@@ -1724,7 +1724,7 @@
"luNhaphA37EO"
],
"title": "Split View",
"notePosition": 130,
"notePosition": 140,
"prefix": null,
"isExpanded": false,
"type": "text",
@@ -3327,10 +3327,139 @@
"value": "bx bx-edit",
"isInheritable": false,
"position": 10
},
{
"type": "relation",
"name": "internalLink",
"value": "iPIMuisry3hd",
"isInheritable": false,
"position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "oPVyFC7WL2Lp",
"isInheritable": false,
"position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "QEAPj01N5f7w",
"isInheritable": false,
"position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "6f9hih2hXXZk",
"isInheritable": false,
"position": 50
},
{
"type": "relation",
"name": "internalLink",
"value": "m523cpzocqaD",
"isInheritable": false,
"position": 60
},
{
"type": "relation",
"name": "internalLink",
"value": "iRwzGnHPzonm",
"isInheritable": false,
"position": 70
},
{
"type": "relation",
"name": "internalLink",
"value": "bdUJEHsAPYQR",
"isInheritable": false,
"position": 80
},
{
"type": "relation",
"name": "internalLink",
"value": "HcABDtFCkbFN",
"isInheritable": false,
"position": 90
},
{
"type": "relation",
"name": "internalLink",
"value": "GTwFsgaA0lCt",
"isInheritable": false,
"position": 100
},
{
"type": "relation",
"name": "internalLink",
"value": "s1aBHPd79XYj",
"isInheritable": false,
"position": 110
},
{
"type": "relation",
"name": "internalLink",
"value": "grjYqerjn243",
"isInheritable": false,
"position": 120
},
{
"type": "relation",
"name": "internalLink",
"value": "1vHRoWCEjj0L",
"isInheritable": false,
"position": 130
},
{
"type": "relation",
"name": "internalLink",
"value": "gBbsAeiuUxI5",
"isInheritable": false,
"position": 140
},
{
"type": "relation",
"name": "internalLink",
"value": "81SGnPGMk7Xc",
"isInheritable": false,
"position": 150
},
{
"type": "relation",
"name": "internalLink",
"value": "CdNpE2pqjmI6",
"isInheritable": false,
"position": 160
},
{
"type": "relation",
"name": "internalLink",
"value": "BlN9DFI679QC",
"isInheritable": false,
"position": 170
},
{
"type": "relation",
"name": "internalLink",
"value": "4FahAwuGTAwC",
"isInheritable": false,
"position": 180
}
],
"format": "markdown",
"attachments": [],
"dataFileName": "Note Types.md",
"attachments": [
{
"attachmentId": "CRt4gLIroyZ9",
"title": "image.png",
"role": "image",
"mime": "image/png",
"position": 10,
"dataFileName": "Note Types_image.png"
}
],
"dirFileName": "Note Types",
"children": [
{

4
docs/User Guide/User Guide/Advanced Usage/Note source.md
View File

@@ -1,7 +1,7 @@
# Note source
## Understanding the source code of the different notes
Internally, the structure of the content of each note is different based on the [Note Types](../Note%20Types).
Internally, the structure of the content of each note is different based on the [Note Types](../Note%20Types.md).
For example:
@@ -21,7 +21,7 @@ Here's part of the HTML representation of this note, as it's stored in the datab
</h2>
<p>
Internally, the structure of the content of each note is different based on the&nbsp;
<a class="reference-link" href="../Note%20Types">
<a class="reference-link" href="../Note%20Types.md">
Note Types
</a>
.

2
docs/User Guide/User Guide/Advanced Usage/Technologies used.md
View File

@@ -1,4 +1,4 @@
# Technologies used
One core aspect of Trilium that allows it to have support for multiple [Note Types](../Note%20Types) is the fact that it makes use of various off-the-shelf or reusable libraries.
One core aspect of Trilium that allows it to have support for multiple [Note Types](../Note%20Types.md) is the fact that it makes use of various off-the-shelf or reusable libraries.
The sub-pages showcase some of the technologies used, for a better understanding of how Trilium works but also to credit the developers of that particular technology.

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

@@ -15,7 +15,7 @@ If you are using the _Fixed_ formatting toolbar, all the formatting buttons for
### Basic Properties
* _**Note type**_ allows changing the [note type](../../Note%20Types) of a note.
* _**Note type**_ allows changing the [note type](../../Note%20Types.md) 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.
@@ -55,7 +55,7 @@ This section lists all the notes that are similar to the current one. See [Simi
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 [type of the note](../../Note%20Types.md), 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.

41
docs/User Guide/User Guide/Note Types.md Normal file
View File

@@ -0,0 +1,41 @@
# Note Types
One core features of Trilium is that it supports multiple types of notes, depending on the need.
## Creating a new note with a different type via the note tree
The default note type in Trilium (e.g. when creating a new note) is [Text](Note%20Types/Text.md), since it's for general use.
To create a new note of a different type, head to the [Note Tree](Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree.md) and right click an existing note where to place the new one and select:
* _Insert note after_, to put the new note underneath the one selected.
* _Insert child note_, to insert the note as a child of the selected note.
![](Note%20Types_image.png)
## Creating a new note of a different type via add link or new tab
* When adding a [link](Note%20Types/Text/Links.md) in a [Text](Note%20Types/Text.md) note, type the desired title of the new note and press Enter. Afterwards the type of the note will be asked.
* Similarly, when creating a new tab, type the desired title and press Enter.
## Changing the type of a note
It is possible to change the type of a note after it has been created via the _Basic Properties_ tab in the [Ribbon](Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md). Note that it's generally a good idea to change the note type only if the note is empty. Can also be used to edit the [source of a note](Advanced%20Usage/Note%20source.md).
## Supported note types
The following note types are supported by Trilium:
| | |
| --- | --- |
| [Text](Note%20Types/Text.md) | The default note type, which allows for rich text formatting, images, admonitions and right-to-left support. |
| [Code](Note%20Types/Code.md) | Uses a mono-space font and can be used to store larger chunks of code or plain text than a text note, and has better syntax highlighting. |
| [Saved Search](Note%20Types/Saved%20Search.md) | Stores the information about a search (the search text, criteria, etc.) for later use. Can be used for quick filtering of a large amount of notes, for example. The search can easily be triggered. |
| [Relation Map](Note%20Types/Relation%20Map.md) | Allows easy creation of notes and relations between them. Can be used for mainly relational data such as a family tree. |
| [Note Map](Note%20Types/Note%20Map.md) | Displays the relationships between the notes, whether via relations or their hierarchical structure. |
| [Render Note](Note%20Types/Render%20Note.md) | Used in [Scripts](Note%20Types/Code/Scripts.md), it displays the HTML content of another note. This allows displaying any kind of content, provided there is a script behind it to generate it. |
| [Book](Note%20Types/Book.md) | Displays the children of the note either as a grid, a list, or for a more specialized case: a calendar. |
| [Mermaid Diagrams](Note%20Types/Mermaid%20Diagrams.md) | Displays diagrams such as bar charts, flow charts, state diagrams, etc. Requires a bit of technical knowledge since the diagrams are written in a specialized format. |
| [Canvas](Note%20Types/Canvas.md) | Allows easy drawing of sketches, diagrams, handwritten content. Uses the same technology behind [excalidraw.com](https://excalidraw.com). |
| [Web View](Note%20Types/Web%20View.md) | Displays the content of an external web page, similar to a browser. |
| [Mind Map](Note%20Types/Mind%20Map.md) | Easy for brainstorming ideas, by placing them in a hierarchical layout. |
| [Geo map](Note%20Types/Geo%20map.md) | Displays the children of the note as a geographical map, one use-case would be to plan vacations. It even has basic support for tracks. Notes can also be created from it. |

BIN
docs/User Guide/User Guide/Note Types_image.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 71 KiB

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

@@ -1436,7 +1436,7 @@
"3seOhtN8uLIY"
],
"title": "Tabs",
"notePosition": 50,
"notePosition": 60,
"prefix": null,
"isExpanded": false,
"type": "text",
@@ -1510,7 +1510,7 @@
"xYmIYSP6wE3F"
],
"title": "Launch Bar",
"notePosition": 90,
"notePosition": 100,
"prefix": null,
"isExpanded": false,
"type": "text",
@@ -1603,7 +1603,7 @@
"Ms1nauBra7gq"
],
"title": "Quick search",
"notePosition": 100,
"notePosition": 110,
"prefix": null,
"isExpanded": false,
"type": "text",
@@ -1631,7 +1631,7 @@
"8YBEPzcpUgxw"
],
"title": "Note buttons",
"notePosition": 110,
"notePosition": 120,
"prefix": null,
"isExpanded": false,
"type": "text",
@@ -1696,7 +1696,7 @@
"4TIF1oA4VQRO"
],
"title": "Options",
"notePosition": 120,
"notePosition": 130,
"prefix": null,
"isExpanded": false,
"type": "text",
@@ -1724,7 +1724,7 @@
"luNhaphA37EO"
],
"title": "Split View",
"notePosition": 130,
"notePosition": 140,
"prefix": null,
"isExpanded": false,
"type": "text",
@@ -3327,10 +3327,139 @@
"value": "bx bx-edit",
"isInheritable": false,
"position": 10
},
{
"type": "relation",
"name": "internalLink",
"value": "iPIMuisry3hd",
"isInheritable": false,
"position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "oPVyFC7WL2Lp",
"isInheritable": false,
"position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "QEAPj01N5f7w",
"isInheritable": false,
"position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "6f9hih2hXXZk",
"isInheritable": false,
"position": 50
},
{
"type": "relation",
"name": "internalLink",
"value": "m523cpzocqaD",
"isInheritable": false,
"position": 60
},
{
"type": "relation",
"name": "internalLink",
"value": "iRwzGnHPzonm",
"isInheritable": false,
"position": 70
},
{
"type": "relation",
"name": "internalLink",
"value": "bdUJEHsAPYQR",
"isInheritable": false,
"position": 80
},
{
"type": "relation",
"name": "internalLink",
"value": "HcABDtFCkbFN",
"isInheritable": false,
"position": 90
},
{
"type": "relation",
"name": "internalLink",
"value": "GTwFsgaA0lCt",
"isInheritable": false,
"position": 100
},
{
"type": "relation",
"name": "internalLink",
"value": "s1aBHPd79XYj",
"isInheritable": false,
"position": 110
},
{
"type": "relation",
"name": "internalLink",
"value": "grjYqerjn243",
"isInheritable": false,
"position": 120
},
{
"type": "relation",
"name": "internalLink",
"value": "1vHRoWCEjj0L",
"isInheritable": false,
"position": 130
},
{
"type": "relation",
"name": "internalLink",
"value": "gBbsAeiuUxI5",
"isInheritable": false,
"position": 140
},
{
"type": "relation",
"name": "internalLink",
"value": "81SGnPGMk7Xc",
"isInheritable": false,
"position": 150
},
{
"type": "relation",
"name": "internalLink",
"value": "CdNpE2pqjmI6",
"isInheritable": false,
"position": 160
},
{
"type": "relation",
"name": "internalLink",
"value": "BlN9DFI679QC",
"isInheritable": false,
"position": 170
},
{
"type": "relation",
"name": "internalLink",
"value": "4FahAwuGTAwC",
"isInheritable": false,
"position": 180
}
],
"format": "html",
"attachments": [],
"dataFileName": "Note Types.html",
"attachments": [
{
"attachmentId": "CRt4gLIroyZ9",
"title": "image.png",
"role": "image",
"mime": "image/png",
"position": 10,
"dataFileName": "Note Types_image.png"
}
],
"dirFileName": "Note Types",
"children": [
{

4
src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Note source.html generated
View File

@@ -15,7 +15,7 @@
<div class="ck-content">
<h2>Understanding the source code of the different notes</h2>
<p>Internally, the structure of the content of each note is different based
on the&nbsp;<a href="../Note%20Types">Note Types</a>.</p>
on the&nbsp;<a href="../Note%20Types.html">Note Types</a>.</p>
<p>For example:</p>
<ul>
<li><a href="#root/_hidden/_options/_optionsTextNotes">Text Notes</a>&nbsp;are
@@ -45,7 +45,7 @@
&lt;/h2&gt;
&lt;p&gt;
Internally, the structure of the content of each note is different based on the&amp;nbsp;
&lt;a class="reference-link" href="../Note%20Types"&gt;
&lt;a class="reference-link" href="../Note%20Types.html"&gt;
Note Types
&lt;/a&gt;
.

2
src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Technologies used.html generated
View File

@@ -15,7 +15,7 @@
<div class="ck-content">
<p>One core aspect of Trilium that allows it to have support for multiple&nbsp;
<a
href="../Note%20Types">Note Types</a>&nbsp;is the fact that it makes use of various off-the-shelf
href="../Note%20Types.html">Note Types</a>&nbsp;is the fact that it makes use of various off-the-shelf
or reusable libraries.</p>
<p>The sub-pages showcase some of the technologies used, for a better understanding
of how Trilium works but also to credit the developers of that particular

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

@@ -29,7 +29,7 @@
<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
<li><em><strong>Note type</strong></em> allows changing the <a href="../../Note%20Types.html">note type</a> of
a note.
<ul>
<li>Generally this is desirable only if the note is empty.</li>
@@ -96,8 +96,8 @@
<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 <a href="../../Note%20Types.html">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 href="../../Advanced%20Usage/Database.html">Database</a>,
as well as its children count and size.</li>

138
src/public/app/doc_notes/en/User Guide/User Guide/Note Types.html generated Normal file
View File

@@ -0,0 +1,138 @@
<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 Types</title>
</head>
<body>
<div class="content">
<h1 data-trilium-h1>Note Types</h1>
<div class="ck-content">
<p>One core features of Trilium is that it supports multiple types of notes,
depending on the need.</p>
<h2>Creating a new note with a different type via the note tree</h2>
<p>The default note type in Trilium (e.g. when creating a new note) is&nbsp;
<a
class="reference-link" href="Note%20Types/Text.html">Text</a>, since it's for general use.</p>
<p>To create a new note of a different type, head to the&nbsp;<a class="reference-link"
href="Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree.html">Note Tree</a>&nbsp;and
right click an existing note where to place the new one and select:</p>
<ul>
<li><em>Insert note after</em>, to put the new note underneath the one selected.</li>
<li><em>Insert child note</em>, to insert the note as a child of the selected
note.</li>
</ul>
<p>
<img src="Note Types_image.png" width="613" height="529">
</p>
<h2>Creating a new note of a different type via add link or new tab</h2>
<ul>
<li>When adding a <a href="Note%20Types/Text/Links.html">link</a> in a&nbsp;
<a
class="reference-link" href="Note%20Types/Text.html">Text</a>&nbsp;note, type the desired title of the new note and press Enter.
Afterwards the type of the note will be asked.</li>
<li>Similarly, when creating a new tab, type the desired title and press Enter.</li>
</ul>
<h2>Changing the type of a note</h2>
<p>It is possible to change the type of a note after it has been created
via the <em>Basic Properties</em> tab in the&nbsp;<a class="reference-link"
href="Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.html">Ribbon</a>.
Note that it's generally a good idea to change the note type only if the
note is empty. Can also be used to edit the <a href="Advanced%20Usage/Note%20source.html">source of a note</a>.</p>
<h2>Supported note types</h2>
<p>The following note types are supported by Trilium:</p>
<figure class="table"
style="width:100%;">
<table class="ck-table-resized">
<colgroup>
<col style="width:19.5%;">
<col style="width:80.5%;">
</colgroup>
<tbody>
<tr>
<td><a class="reference-link" href="Note%20Types/Text.html">Text</a>
</td>
<td>The default note type, which allows for rich text formatting, images,
admonitions and right-to-left support.</td>
</tr>
<tr>
<td><a class="reference-link" href="Note%20Types/Code.html">Code</a>
</td>
<td>Uses a mono-space font and can be used to store larger chunks of code
or plain text than a text note, and has better syntax highlighting.</td>
</tr>
<tr>
<td><a class="reference-link" href="Note%20Types/Saved%20Search.html">Saved Search</a>
</td>
<td>Stores the information about a search (the search text, criteria, etc.)
for later use. Can be used for quick filtering of a large amount of notes,
for example. The search can easily be triggered.</td>
</tr>
<tr>
<td><a class="reference-link" href="Note%20Types/Relation%20Map.html">Relation Map</a>
</td>
<td>Allows easy creation of notes and relations between them. Can be used
for mainly relational data such as a family tree.</td>
</tr>
<tr>
<td><a class="reference-link" href="Note%20Types/Note%20Map.html">Note Map</a>
</td>
<td>Displays the relationships between the notes, whether via relations or
their hierarchical structure.</td>
</tr>
<tr>
<td><a class="reference-link" href="Note%20Types/Render%20Note.html">Render Note</a>
</td>
<td>Used in&nbsp;<a class="reference-link" href="Note%20Types/Code/Scripts.html">Scripts</a>,
it displays the HTML content of another note. This allows displaying any
kind of content, provided there is a script behind it to generate it.</td>
</tr>
<tr>
<td><a class="reference-link" href="Note%20Types/Book.html">Book</a>
</td>
<td>Displays the children of the note either as a grid, a list, or for a more
specialized case: a calendar.</td>
</tr>
<tr>
<td><a class="reference-link" href="Note%20Types/Mermaid%20Diagrams.html">Mermaid Diagrams</a>
</td>
<td>Displays diagrams such as bar charts, flow charts, state diagrams, etc.
Requires a bit of technical knowledge since the diagrams are written in
a specialized format.</td>
</tr>
<tr>
<td><a class="reference-link" href="Note%20Types/Canvas.html">Canvas</a>
</td>
<td>Allows easy drawing of sketches, diagrams, handwritten content. Uses the
same technology behind <a href="https://excalidraw.com">excalidraw.com</a>.</td>
</tr>
<tr>
<td><a class="reference-link" href="Note%20Types/Web%20View.html">Web View</a>
</td>
<td>Displays the content of an external web page, similar to a browser.</td>
</tr>
<tr>
<td><a class="reference-link" href="Note%20Types/Mind%20Map.html">Mind Map</a>
</td>
<td>Easy for brainstorming ideas, by placing them in a hierarchical layout.</td>
</tr>
<tr>
<td><a class="reference-link" href="Note%20Types/Geo%20map.html">Geo map</a>
</td>
<td>Displays the children of the note as a geographical map, one use-case
would be to plan vacations. It even has basic support for tracks. Notes
can also be created from it.</td>
</tr>
</tbody>
</table>
</figure>
</div>
</div>
</body>
</html>

BIN
src/public/app/doc_notes/en/User Guide/User Guide/Note Types_image.png generated Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 71 KiB

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

@@ -199,7 +199,7 @@
</li>
<li><a href="User%20Guide/FAQ.html" target="detail">FAQ</a>
</li>
<li>Note Types
<li><a href="User%20Guide/Note%20Types.html" target="detail">Note Types</a>
<ul>
<li><a href="User%20Guide/Note%20Types/Text.html" target="detail">Text</a>
<ul>