mirror of
https://github.com/zadam/trilium.git
synced 2025-10-30 01:36:24 +01:00
feat(docs): document note types
This commit is contained in:
@@ -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
|
||||
<a class="reference-link" href="../Note%20Types">
|
||||
<a class="reference-link" href="../Note%20Types.md">
|
||||
Note Types
|
||||
</a>
|
||||
.
|
||||
|
||||
@@ -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.
|
||||
@@ -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
41
docs/User Guide/User Guide/Note Types.md
Normal 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.
|
||||
|
||||

|
||||
|
||||
## 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
BIN
docs/User Guide/User Guide/Note Types_image.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 71 KiB |
Reference in New Issue
Block a user