mirror of
https://github.com/TriliumNext/Notes.git
synced 2025-07-27 18:12:29 +08:00
chore(docs): add back some reference links
This commit is contained in:
Elian Doran
parent
6a69e9b208
commit
79fa2a2200
File diff suppressed because it is too large
Load Diff
@ -5,7 +5,7 @@ Generally, the Note ID is a 12-character long alphanumeric sequence (including b
|
||||
|
||||
## How does the import/export affect the note IDs
|
||||
|
||||
When notes are exported, their note ID is kept in the metadata of the export. However when they are imported back in, a new note ID is generated for all the notes. This also includes other entities that are part of the import/export process such as [Attachments](../Basic%20Concepts%20and%20Features/Notes/Attachments.md).
|
||||
When notes are exported, their note ID is kept in the metadata of the export. However when they are imported back in, a new note ID is generated for all the notes. This also includes other entities that are part of the import/export process such as <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Notes/Attachments.md">Attachments</a>.
|
||||
|
||||
## Note collisions
|
||||
|
||||
|
||||
@ -5,11 +5,11 @@ The _Jump to Note_ function allows easy navigation between notes by searching fo
|
||||
|
||||
## Entering jump to note
|
||||
|
||||
* In the [Launch Bar](../UI%20Elements/Launch%20Bar.md), press  button.
|
||||
* In the <a class="reference-link" href="../UI%20Elements/Launch%20Bar.md">Launch Bar</a>, press  button.
|
||||
* Using the keyboard, press <kbd>Ctrl</kbd> + <kbd>J</kbd>.
|
||||
|
||||
## Interaction
|
||||
|
||||
* By default, when there is no text entered it will display the most recent notes (see [Note Navigation](Note%20Navigation.md)).
|
||||
* By default, when there is no text entered it will display the most recent notes (see <a class="reference-link" href="Note%20Navigation.md">Note Navigation</a>).
|
||||
* Using the keyboard, use the up or down arrow keys to navigate between items. Press <kbd>Enter</kbd> to open the desired note.
|
||||
* If the note doesn't exist, it's possible to create it by typing the desired note title and selecting the _Create and link child note_ option.
|
||||
@ -3,13 +3,13 @@
|
||||
|
||||
The _Quick search_ function does a full-text search (that is, it searches through the content of notes and not just the title of a note) and displays the result in an easy-to-access manner.
|
||||
|
||||
The alternative to the quick search is the [Search](Search.md) function, which opens in a dedicated tab and has support for advanced queries.
|
||||
The alternative to the quick search is the <a class="reference-link" href="Search.md">Search</a> function, which opens in a dedicated tab and has support for advanced queries.
|
||||
|
||||
For even faster navigation, it's possible to use [Jump to Note](Jump%20to%20Note.md) which will only search through the note titles instead of the content.
|
||||
For even faster navigation, it's possible to use <a class="reference-link" href="Jump%20to%20Note.md">Jump to Note</a> which will only search through the note titles instead of the content.
|
||||
|
||||
## Layout
|
||||
|
||||
Based on the [Vertical and horizontal layout](../UI%20Elements/Vertical%20and%20horizontal%20layout.md), the quick search is placed:
|
||||
Based on the <a class="reference-link" href="../UI%20Elements/Vertical%20and%20horizontal%20layout.md">Vertical and horizontal layout</a>, the quick search is placed:
|
||||
|
||||
* On the vertical layout, it is displayed right above the [Note Tree](../UI%20Elements/Note%20Tree.md).
|
||||
* On the horizontal layout, it is displayed in the [Launch Bar](../UI%20Elements/Launch%20Bar.md), where it can be positioned just like any other icon.
|
||||
* On the vertical layout, it is displayed right above the <a class="reference-link" href="../UI%20Elements/Note%20Tree.md">Note Tree</a>.
|
||||
* On the horizontal layout, it is displayed in the <a class="reference-link" href="../UI%20Elements/Launch%20Bar.md">Launch Bar</a>, where it can be positioned just like any other icon.
|
||||
@ -1,7 +1,7 @@
|
||||
# Attachments
|
||||
A [note](../Notes.md) in Trilium can _own_ one or more attachments, which can be either images or files. These attachments can be displayed or linked within the note that owns them.
|
||||
|
||||
This can be especially useful to include dependencies for your [scripts](../../Note%20Types/Code/Scripts.md). The [Weight Tracker](../../Advanced%20Usage/Advanced%20Showcases/Weight%20Tracker.md) shows how to use [chartjs](https://chartjs.org/) which is attached to the [script note](#root/HcUYTojFohtb).
|
||||
This can be especially useful to include dependencies for your [scripts](../../Note%20Types/Code/Scripts.md). The <a class="reference-link" href="../../Advanced%20Usage/Advanced%20Showcases/Weight%20Tracker.md">Weight Tracker</a> shows how to use [chartjs](https://chartjs.org/) which is attached to the [script note](#root/HcUYTojFohtb).
|
||||
|
||||
Each note exclusively owns its attachments, meaning attachments cannot be shared or linked from one note to another. If an attachment link is copied to a different note, the attachment itself is duplicated, and the copies are managed independently thereafter.
|
||||
|
||||
@ -9,4 +9,4 @@ Attachments, especially image files, are the recommended method for embedding vi
|
||||
|
||||
## Attachment previews
|
||||
|
||||
Attachments share the same content preview for images, videos, PDFs, etc. as the [File](../../Note%20Types/File.md) note type.
|
||||
Attachments share the same content preview for images, videos, PDFs, etc. as the <a class="reference-link" href="../../Note%20Types/File.md">File</a> note type.
|
||||
@ -6,7 +6,7 @@ When a note has one or more child notes, they will be listed at the end of the n
|
||||
By default, the notes will be displayed in a grid, however there are also some other view types available.
|
||||
|
||||
> [!TIP]
|
||||
> Generally the view type can only be changed in a [Book](../../Note%20Types/Book.md) note from the [Ribbon](../UI%20Elements/Ribbon.md), but it can also be changed manually on any type of note using the `#viewType` attribute.
|
||||
> Generally the view type can only be changed in a <a class="reference-link" href="../../Note%20Types/Book.md">Book</a> note from the <a class="reference-link" href="../UI%20Elements/Ribbon.md">Ribbon</a>, but it can also be changed manually on any type of note using the `#viewType` attribute.
|
||||
|
||||
### Grid view
|
||||
|
||||
@ -14,9 +14,9 @@ By default, the notes will be displayed in a grid, however there are also some o
|
||||
|
||||
This view presents the child notes in a grid format, allowing for a more visual navigation experience.
|
||||
|
||||
* For [Text](../../Note%20Types/Text.md) note, the text can be slighly scrollable via the mouse wheel to reveal more context.
|
||||
* For [Code](../../Note%20Types/Code.md) notes, syntax highlighting is applied.
|
||||
* For [File](../../Note%20Types/File.md) notes, a preview is made available for audio, video and PDF notes.
|
||||
* For <a class="reference-link" href="../../Note%20Types/Text.md">Text</a> notes, the text can be slighly scrollable via the mouse wheel to reveal more context.
|
||||
* For <a class="reference-link" href="../../Note%20Types/Code.md">Code</a> notes, syntax highlighting is applied.
|
||||
* For <a class="reference-link" href="../../Note%20Types/File.md">File</a> notes, a preview is made available for audio, video and PDF notes.
|
||||
* If the note does not have a content, a list of its child notes will be displayed instead.
|
||||
|
||||
This is the default view type.
|
||||
@ -31,4 +31,4 @@ In the list view mode, each note is displayed in a single row with only the titl
|
||||
|
||||
|
||||
|
||||
In the calendar view, child notes are represented as events, with a start date and optionally an end date. The view also has interaction support such as moving or creating new events. See [Calendar View](Note%20List/Calendar%20View.md) for more information.
|
||||
In the calendar view, child notes are represented as events, with a start date and optionally an end date. The view also has interaction support such as moving or creating new events. See <a class="reference-link" href="Note%20List/Calendar%20View.md">Calendar View</a> for more information.
|
||||
@ -7,18 +7,16 @@ For optimization purposes, Trilium will automatically set very large notes to re
|
||||
|
||||
This behavior can be disabled on a per-note basis, by following the instructions of the next section.
|
||||
|
||||
In addition, it's possible to change the number of characters at which the automatic read-only mode will trigger in [Options](../UI%20Elements/Options.md) by going to the options for [Text](../../Note%20Types/Text.md) and [Code](../../Note%20Types/Code.md) notes.
|
||||
In addition, it's possible to change the number of characters at which the automatic read-only mode will trigger in [Options](../UI%20Elements/Options.md) by going to the options for <a class="reference-link" href="#root/_hidden/_options/_optionsTextNotes">Text Notes</a> and <a class="reference-link" href="#root/_hidden/_options/_optionsCodeNotes">Code Notes</a>.
|
||||
|
||||
## Changing a note's read-only behavior
|
||||
|
||||
Via the [Ribbon](../UI%20Elements/Ribbon.md), by going to the _Basic Properties_ tab and looking for the _Editable_ selection. The following options are possible:
|
||||
Via the <a class="reference-link" href="../UI%20Elements/Ribbon.md">Ribbon</a>, by going to the _Basic Properties_ tab and looking for the _Editable_ selection. The following options are possible:
|
||||
|
||||
* **Auto**
|
||||
This is the default behavior in which the note will be editable by default, unless it becomes large enough to trigger read-only mode.
|
||||
|
||||
* **Read-only**
|
||||
The note will be always marked as read-only, regardless of its size. Nevertheless, it's still possible to temporarily edit the note if needed. This is generally useful for notes that are not prone to change.
|
||||
|
||||
* **Always Editable**
|
||||
This option will bypass the automatic read-only activation for this particular note. It's useful for large notes that are frequently edited.
|
||||
|
||||
@ -33,7 +31,7 @@ Apart from using the ribbon as previously mentioned, it's also possible to use [
|
||||
|
||||
## Temporarily editing a read-only note
|
||||
|
||||
When accessing a read-only note, it's possible to temporarily edit it by using the  button in the [Floating buttons](../UI%20Elements/Floating%20buttons.md) area.
|
||||
When accessing a read-only note, it's possible to temporarily edit it by using the  button in the <a class="reference-link" href="../UI%20Elements/Floating%20buttons.md">Floating buttons</a> area.
|
||||
|
||||
When pressed, the note will become editable but will become read-only again after navigating to a different note.
|
||||
|
||||
@ -41,4 +39,4 @@ When pressed, the note will become editable but will become read-only again afte
|
||||
|
||||
Some note types have a special behavior based on whether the read-only mode is enabled:
|
||||
|
||||
* [Mermaid Diagrams](#root/rswjxUmAz64R/aOI0RYfC3wic/ObWG9tSNscDb) will hide the Mermaid source code and display the diagram preview in full-size. In this case, the read-only mode can be easily toggled on or off via a dedicated button in the [Floating buttons](../UI%20Elements/Floating%20buttons.md) area.
|
||||
* <a class="reference-link" href="../../Note%20Types/Mermaid%20Diagrams.md">Mermaid Diagrams</a> will hide the Mermaid source code and display the diagram preview in full-size. In this case, the read-only mode can be easily toggled on or off via a dedicated button in the <a class="reference-link" href="../UI%20Elements/Floating%20buttons.md">Floating buttons</a> area.
|
||||
@ -1,11 +1,11 @@
|
||||
# Floating buttons
|
||||
|
||||
|
||||
Depending on the current note, a panel will appear near the top-right of the note, right underneath the [Ribbon](Ribbon.md). These buttons offer additional interaction that is specific to that particular note.
|
||||
Depending on the current note, a panel will appear near the top-right of the note, right underneath the <a class="reference-link" href="Ribbon.md">Ribbon</a>. These buttons offer additional interaction that is specific to that particular note.
|
||||
|
||||
For example:
|
||||
|
||||
* For [Mermaid Diagrams](../../Note%20Types/Mermaid%20Diagrams.md) and [Canvas](../../Note%20Types/Canvas.md), there are buttons to download the SVG representation of the note, or to copy a reference to the note for pasting it a [Text](../../Note%20Types/Text.md) note.
|
||||
* For <a class="reference-link" href="../../Note%20Types/Mermaid%20Diagrams.md">Mermaid Diagrams</a> and <a class="reference-link" href="../../Note%20Types/Canvas.md">Canvas</a>, there are buttons to download the SVG representation of the note, or to copy a reference to the note for pasting it a <a class="reference-link" href="../../Note%20Types/Text.md">Text</a> note.
|
||||
* For [read-only notes](../Notes/Read-Only%20Notes.md), there is a button to temporarily edit the note for quick modifications.
|
||||
|
||||
## Interaction
|
||||
|
||||
@ -10,8 +10,9 @@ The Options can be accessed via:
|
||||
* The [Global menu](Global%20menu.md), by selecting the _Options_ item.
|
||||
* The  button in the [Launch Bar](Launch%20Bar.md) which can optionally be hidden if not desirable.
|
||||
* Optionally, a keyboard shortcut can be defined, but it is not assigned by default.
|
||||
* By clicking on this link: <a class="reference-link" href="#root/_hidden/_options">Options</a>.
|
||||
|
||||
Once in the options section, simply select one of the option categories using the [Note Tree](Note%20Tree.md).
|
||||
Once in the options section, simply select one of the option categories using the <a class="reference-link" href="Note%20Tree.md">Note Tree</a>.
|
||||
|
||||
## Exiting options
|
||||
|
||||
@ -19,6 +20,6 @@ When entering the options, they are opened in a new [tab](Tabs.md). To close the
|
||||
|
||||
## Options when using sync
|
||||
|
||||
When using [Synchronization](../../Installation%20%26%20Setup/Synchronization.md), some of the options will be kept in sync across all the devices while others can be changed independently.
|
||||
When using <a class="reference-link" href="../../Installation%20%26%20Setup/Synchronization.md">Synchronization</a>, some of the options will be kept in sync across all the devices while others can be changed independently.
|
||||
|
||||
Generally, the options that relate to appearance are intentionally kept not synced in order to allow per-client customization (layout orientation, theme, vertical/horizontal layout, code block themes).
|
||||
@ -5,19 +5,19 @@ In Trilium, is possible to work with two or more notes side-by-side.
|
||||
|
||||
## **Interactions**
|
||||
|
||||
* Press the  button to the right of a note's title to open a new split to the right of it.
|
||||
* Press the  button to the right of a note's title to open a new split to the right of it.
|
||||
* It is possible to have as many splits as desired, simply press again the button.
|
||||
* Only horizontal splits are possible, vertical or drag & dropping is not supported.
|
||||
* When at least one split is open, press the  button next to it to close it.
|
||||
* Use the  or the  button to move around the splits.
|
||||
* When at least one split is open, press the  button next to it to close it.
|
||||
* Use the  or the  button to move around the splits.
|
||||
* Each [tab](Tabs.md) has its own split view configuration (e.g. one tab can have two notes in a split view, whereas the others are one-note views).
|
||||
* The tab will indicate only the title of the main note (the first one in the list).
|
||||
|
||||
## Splits and the note tree & hoisting
|
||||
|
||||
Clicking on the content of a split will focus that split. While focused, the [Note Tree](Note%20Tree.md) will also indicate the note that is being edited.
|
||||
Clicking on the content of a split will focus that split. While focused, the <a class="reference-link" href="Note%20Tree.md">Note Tree</a> will also indicate the note that is being edited.
|
||||
|
||||
It is possible for each of the splits to have their own [Note Hoisting](../Navigation/Note%20Hoisting.md).
|
||||
It is possible for each of the splits to have their own <a class="reference-link" href="../Navigation/Note%20Hoisting.md">Note Hoisting</a>.
|
||||
|
||||
When a new split is created, it will share the same note hoisting as the previous one. An easy solution to this is to simply hoist the notes after the split is created.
|
||||
|
||||
|
||||
@ -5,16 +5,16 @@ In Trilium, tabs allow easy switching between notes.
|
||||
|
||||
## Layout
|
||||
|
||||
Depending on the [Vertical and horizontal layout](Vertical%20and%20horizontal%20layout.md):
|
||||
Depending on the <a class="reference-link" href="Vertical%20and%20horizontal%20layout.md">Vertical and horizontal layout</a>:
|
||||
|
||||
* For the vertical layout, the tabs will be placed at the top but to the right of the [Note Tree](Note%20Tree.md).
|
||||
* For the horizontal layout, the tabs will be placed at the top in full-width, above the [Note Tree](Note%20Tree.md), allowing for more tabs to be comfortably displayed.
|
||||
* For the vertical layout, the tabs will be placed at the top but to the right of the <a class="reference-link" href="Note%20Tree.md">Note Tree</a>.
|
||||
* For the horizontal layout, the tabs will be placed at the top in full-width, above the [note tree](Note%20Tree.md), allowing for more tabs to be comfortably displayed.
|
||||
|
||||
## Interaction
|
||||
|
||||
* To create a new tab, press the  button that is to the right of the last tab.
|
||||
* To close a tab, press the corresponding  button.
|
||||
* For multitasking, tabs can be used alongside [Split View](Split%20View.md). Each tab can have one or more notes, displayed horizontally.
|
||||
* For multitasking, tabs can be used alongside <a class="reference-link" href="Split%20View.md">Split View</a>. Each tab can have one or more notes, displayed horizontally.
|
||||
* Tabs can be reordered by drag-and-dropping it into a new position.
|
||||
* An existing tab can be displayed in a new window by dragging the tab upwards or downwards. It is not possible to combine tabs back into another window.
|
||||
|
||||
|
||||
@ -3,9 +3,9 @@ One core features of Trilium is that it supports multiple types of notes, depend
|
||||
|
||||
## 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.
|
||||
The default note type in Trilium (e.g. when creating a new note) is <a class="reference-link" href="Note%20Types/Text.md">Text</a>, 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:
|
||||
To create a new note of a different type, head to the <a class="reference-link" href="Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree.md">Note Tree</a> 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.
|
||||
@ -14,12 +14,12 @@ To create a new note of a different type, head to the [Note Tree](Basic%20Conce
|
||||
|
||||
## 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.
|
||||
* When adding a [link](Note%20Types/Text/Links.md) in a <a class="reference-link" href="Note%20Types/Text.md">Text</a> 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).
|
||||
It is possible to change the type of a note after it has been created via the _Basic Properties_ tab in the <a class="reference-link" href="Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">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 [source of a note](Advanced%20Usage/Note%20source.md).
|
||||
|
||||
## Supported note types
|
||||
|
||||
@ -27,15 +27,15 @@ 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. |
|
||||
| <a class="reference-link" href="Note%20Types/Text.md">Text</a> | The default note type, which allows for rich text formatting, images, admonitions and right-to-left support. |
|
||||
| <a class="reference-link" href="Note%20Types/Code.md">Code</a> | 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. |
|
||||
| <a class="reference-link" href="Note%20Types/Saved%20Search.md">Saved Search</a> | 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. |
|
||||
| <a class="reference-link" href="Note%20Types/Relation%20Map.md">Relation Map</a> | Allows easy creation of notes and relations between them. Can be used for mainly relational data such as a family tree. |
|
||||
| <a class="reference-link" href="Note%20Types/Note%20Map.md">Note Map</a> | Displays the relationships between the notes, whether via relations or their hierarchical structure. |
|
||||
| <a class="reference-link" href="Note%20Types/Render%20Note.md">Render Note</a> | Used in <a class="reference-link" href="Note%20Types/Code/Scripts.md">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. |
|
||||
| <a class="reference-link" href="Note%20Types/Book.md">Book</a> | Displays the children of the note either as a grid, a list, or for a more specialized case: a calendar. |
|
||||
| <a class="reference-link" href="Note%20Types/Mermaid%20Diagrams.md">Mermaid Diagrams</a> | Displays diagrams such as bar charts, flow charts, state diagrams, etc. Requires a bit of technical knowledge since the diagrams are written in a specialized format. |
|
||||
| <a class="reference-link" href="Note%20Types/Canvas.md">Canvas</a> | Allows easy drawing of sketches, diagrams, handwritten content. Uses the same technology behind [excalidraw.com](https://excalidraw.com). |
|
||||
| <a class="reference-link" href="Note%20Types/Web%20View.md">Web View</a> | Displays the content of an external web page, similar to a browser. |
|
||||
| <a class="reference-link" href="Note%20Types/Mind%20Map.md">Mind Map</a> | Easy for brainstorming ideas, by placing them in a hierarchical layout. |
|
||||
| <a class="reference-link" href="Note%20Types/Geo%20Map.md">Geo Map</a> | 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. |
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 112 KiB |
@ -1,7 +1,7 @@
|
||||
# Book
|
||||
A **Book Note** in Trilium is a special type of [note](../Basic%20Concepts%20and%20Features/Notes.md) designed to display the contents of its child notes sequentially, creating a linear, book-like reading experience. This format is particularly useful for viewing multiple smaller notes in a cohesive, continuous manner.
|
||||
|
||||
|
||||
|
||||
|
||||
In the example above, the "node.js" note on the left panel contains several child notes. The right panel displays the content of these child notes as a single continuous document.
|
||||
|
||||
@ -9,6 +9,6 @@ In the example above, the "node.js" note on the left panel contains several chil
|
||||
|
||||
The Book Note format compiles the contents of all child notes into one continuous view. This makes it ideal for reading extensive information broken into smaller, manageable segments.
|
||||
|
||||
It uses the [Note List](../Basic%20Concepts%20and%20Features/Notes/Note%20List.md) mechanism to display the child notes, allowing the use of any of the view types (grid, list, calendar).
|
||||
It uses the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Notes/Note%20List.md">Note List</a> mechanism to display the child notes, allowing the use of any of the view types (grid, list, calendar).
|
||||
|
||||
To adjust the view type, see the dedicated _Book_ tab in the [Ribbon](../Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md).
|
||||
To adjust the view type, see the dedicated _Book_ tab in the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">Ribbon</a>.
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 176 KiB After Width: | Height: | Size: 112 KiB |
@ -12,7 +12,7 @@ So we have frontend and backend, each with their own set of responsibilities, bu
|
||||
|
||||
## Use cases
|
||||
|
||||
* [A button launcher button](Scripts/New%20Task%20launcher%20button.md)
|
||||
* <a class="reference-link" href="Scripts/New%20Task%20launcher%20button.md">"New Task" launcher button</a>
|
||||
|
||||
## Action handler
|
||||
|
||||
@ -30,12 +30,12 @@ The solution is marked by red circle at the bottom - this note has [label](../..
|
||||
|
||||
## More showcases
|
||||
|
||||
You can see more scripting with explanation in [Advanced showcases](../../Advanced%20Usage/Advanced%20Showcases.md)
|
||||
You can see more scripting with explanation in <a class="reference-link" href="../../Advanced%20Usage/Advanced%20Showcases.md">Advanced Showcases</a>.
|
||||
|
||||
## Events
|
||||
|
||||
See [Events](Events.md).
|
||||
See <a class="reference-link" href="Events.md">Events</a>.
|
||||
|
||||
## Script API
|
||||
|
||||
See [Script API](Script%20API.md).
|
||||
See <a class="reference-link" href="Script%20API.md">Script API</a>.
|
||||
@ -1,10 +1,10 @@
|
||||
# "New Task" launcher button
|
||||
In this example we are going to extend the functionality of the [Task Manager](../../../Advanced%20Usage/Advanced%20Showcases/Task%20Manager.md) showcase (which comes by default with Trilium) by adding a button in the [Launch Bar](../../../Basic%20Concepts%20and%20Features/UI%20Elements/Launch%20Bar.md) () to create a new task automatically and open it.
|
||||
In this example we are going to extend the functionality of <a class="reference-link" href="../../../Advanced%20Usage/Advanced%20Showcases/Task%20Manager.md">Task Manager</a> showcase (which comes by default with Trilium) by adding a button in the <a class="reference-link" href="../../../Basic%20Concepts%20and%20Features/UI%20Elements/Launch%20Bar.md">Launch Bar</a> () to create a new task automatically and open it.
|
||||
|
||||
## Creating the note
|
||||
|
||||
1. First, create a new [Code](../../Code.md) note type with the _JS frontend_ language.
|
||||
2. Define the `#run=frontendStartup` label in [Attributes](../../../Advanced%20Usage/Attributes.md).
|
||||
1. First, create a new <a class="reference-link" href="../../Code.md">Code</a> note type with the _JS frontend_ language.
|
||||
2. Define the `#run=frontendStartup` label in <a class="reference-link" href="../../../Advanced%20Usage/Attributes.md">Attributes</a>.
|
||||
|
||||
## Content of the script
|
||||
|
||||
@ -34,7 +34,7 @@ Since we set the script to be run on start-up, all we need to do is to [refresh
|
||||
|
||||
## Understanding how the script works
|
||||
|
||||
<table class="ck-table-resized"><colgroup><col style="width:53.57%;"><col style="width:46.43%;"></colgroup><tbody><tr><td><pre><code class="language-application-javascript-env-frontend">api.addButtonToToolbar({
|
||||
<table class="ck-table-resized"><colgroup><col style="width:50%;"><col style="width:50%;"></colgroup><tbody><tr><td><pre><code class="language-application-javascript-env-frontend">api.addButtonToToolbar({
|
||||
title: "New task",
|
||||
icon: "task",
|
||||
shortcut: "alt+n",
|
||||
|
||||
@ -5,7 +5,7 @@ The _File_ note type can be used to attach various external files such as images
|
||||
|
||||
Since these files come from an external source, it is not possible to create a _File_ note type directly:
|
||||
|
||||
* Drag a file into the [Note Tree](../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree.md).
|
||||
* Drag a file into the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree.md">Note Tree</a>.
|
||||
* Right click a note and select _Import into note_ and point it to one of the supported files.
|
||||
|
||||
## Supported file types
|
||||
@ -42,7 +42,7 @@ Interaction:
|
||||
Video files can be added in as well. The file is streamed directly, so when accessing the note from a server it doesn't have to download the entire video to start playing it.
|
||||
|
||||
> [!CAUTION]
|
||||
> Although Trilium offers support for videos, it is generally not meant to be used with very large files. Uploading large videos will cause the [Database](../Advanced%20Usage/Database.md) to balloon as well as the any [Backup](../Installation%20%26%20Setup/Backup.md) of it. In addition to that, there might be slowdowns when first uploading the files. Otherwise, a large database should not impact the general performance of Trilium significantly.
|
||||
> Although Trilium offers support for videos, it is generally not meant to be used with very large files. Uploading large videos will cause the <a class="reference-link" href="../Advanced%20Usage/Database.md">Database</a> to balloon as well as the any <a class="reference-link" href="../Installation%20%26%20Setup/Backup.md">Backup</a> of it. In addition to that, there might be slowdowns when first uploading the files. Otherwise, a large database should not impact the general performance of Trilium significantly.
|
||||
|
||||
### Audio
|
||||
|
||||
@ -63,7 +63,7 @@ Interactions:
|
||||
|
||||
Files that are identified as containing text will show a preview of their content. One common use case for this type of file is to embed text files whose content is not necessarily of interest to the user, such as third-party libraries or generated content, that can then be downloaded if needed.
|
||||
|
||||
Note that generally text files will be [imported](../Basic%20Concepts%20and%20Features/Import%20%26%20Export) as either [Text](Text.md) or [Code](Code.md) notes. To bypass this behavior and create a _File_ note type, use the _Import into note_ feature and uncheck _Import HTML, Markdown and TXT as text notes_, as well as _Import recognized code files as code notes_.
|
||||
Note that generally text files will be [imported](../Basic%20Concepts%20and%20Features/Import%20%26%20Export) as either <a class="reference-link" href="Text.md">Text</a> or <a class="reference-link" href="Code.md">Code</a> notes. To bypass this behavior and create a _File_ note type, use the _Import into note_ feature and uncheck _Import HTML, Markdown and TXT as text notes_, as well as _Import recognized code files as code notes_.
|
||||
|
||||
Since one of the use cases for having files instead of notes is to display large files, the content preview is limited to a relatively small amount of characters. To view the full file, consider opening it in an external application.
|
||||
|
||||
@ -75,7 +75,7 @@ If the file could not be identified as any of the supported file types from abov
|
||||
|
||||
## Interaction
|
||||
|
||||
* Regardless of the file type, a series of buttons will be displayed in the _Image_ or _File_ tab in the [Ribbon](../Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md).
|
||||
* Regardless of the file type, a series of buttons will be displayed in the _Image_ or _File_ tab in the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">Ribbon</a>.
|
||||
* _Download_, which will download the file for local use.
|
||||
* _Open_, will will open the file with the system-default application.
|
||||
* Upload new revision to replace the file with a new one.
|
||||
@ -84,6 +84,6 @@ If the file could not be identified as any of the supported file types from abov
|
||||
|
||||
## Relation with other notes
|
||||
|
||||
* Files are also displayed in the [Note List](../Basic%20Concepts%20and%20Features/Notes/Note%20List.md) based on their type:
|
||||
* Non-image files can be embedded into text notes as read-only widgets via the [Include Note](Text/Include%20Note.md) functionality.
|
||||
* Image files can be embedded into text notes like normal images via [Image references](Text/Images/Image%20references.md).
|
||||
* Files are also displayed in the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Notes/Note%20List.md">Note List</a> based on their type:
|
||||
* Non-image files can be embedded into text notes as read-only widgets via the <a class="reference-link" href="Text/Include%20Note.md">Include Note</a> functionality.
|
||||
* Image files can be embedded into text notes like normal images via <a class="reference-link" href="Text/Images/Image%20references.md">Image references</a>.
|
||||
@ -12,7 +12,7 @@ Depending on the chart being edited and user preference, there are two layouts s
|
||||
* Horizontal, where the source code (editable part) is on the left side of the screen and the preview is to the right.
|
||||
* Vertical, where the source code is at the bottom of the screen and the preview is at the top.
|
||||
|
||||
It's possible to switch between the two layouts at any time by pressing the  icon in the [Floating buttons](../Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons.md) area.
|
||||
It's possible to switch between the two layouts at any time by pressing the  icon in the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons.md">Floating buttons</a> area.
|
||||
|
||||
## Interaction
|
||||
|
||||
@ -24,10 +24,10 @@ It's possible to switch between the two layouts at any time by pressing the  area:
|
||||
* In the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons.md">Floating buttons</a> area:
|
||||
* The source/preview can be laid out left-right or bottom-top via the _Move editing pane to the left / bottom_ option.
|
||||
* Press _Lock editing_ to automatically mark the note as read-only. In this mode, the code pane is hidden and the diagram is displayed full-size. Similarly, press _Unlock editing_ to mark a read-only note as editable.
|
||||
* Press the _Copy image reference to the clipboard_ to be able to insert the image representation of the diagram into a text note. See [Image references](Text/Images/Image%20references.md) for more information.
|
||||
* Press the _Copy image reference to the clipboard_ to be able to insert the image representation of the diagram into a text note. See <a class="reference-link" href="Text/Images/Image%20references.md">Image references</a> for more information.
|
||||
* Press the _Export diagram as SVG_ to download a scalable/vector rendering of the diagram. Can be used to present the diagram without degrading when zooming.
|
||||
* Press the _Export diagram as PNG_ to download a normal image (at 1x scale, raster) of the diagram. Can be used to send the diagram in more traditional channels such as e-mail.
|
||||
|
||||
|
||||
@ -19,6 +19,6 @@ The mindmap allows for easy jotting down of ideas and storing them in a hierarch
|
||||
* To select one or more notes, drag and drop across the map.
|
||||
* Right click the node to bring a contextual menu with options such as creating new nodes, focusing on a particular notes or creating links between them.
|
||||
* Use the buttons at the top-left to change the positioning of the nodes relative to the root node (to the left, to the right, or to both sides).
|
||||
* In the [Floating buttons](../Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons.md) area:
|
||||
* In the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons.md">Floating buttons</a> area:
|
||||
* An [image reference](Text/Images/Image%20references.md) can be copied, to paste the mind map in a text note.
|
||||
* The diagram can be exported either as SVG (vectorial) or PNG (raster).
|
||||
@ -1,21 +1,21 @@
|
||||
# Image references
|
||||
|
||||
|
||||
Image references are an easy way to embed the preview of another note type into a [Text](../../Text.md) note.
|
||||
Image references are an easy way to embed the preview of another note type into a <a class="reference-link" href="../../Text.md">Text</a> note.
|
||||
|
||||
## Supported note types
|
||||
|
||||
* [Canvas](../../Canvas.md)
|
||||
* [Mermaid Diagrams](../../Mermaid%20Diagrams.md)
|
||||
* [Mind Map](../../Mind%20Map.md)
|
||||
* <a class="reference-link" href="../../Canvas.md">Canvas</a>
|
||||
* <a class="reference-link" href="../../Mermaid%20Diagrams.md">Mermaid Diagrams</a>
|
||||
* <a class="reference-link" href="../../Mind%20Map.md">Mind Map</a>
|
||||
|
||||
## Steps
|
||||
|
||||
1. Go to one of the supported notes (listed above) and look for the  button in the [Floating buttons](../../../Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons.md) area.
|
||||
2. Go to a [Text](../../Text.md) note and use the Paste function to insert the reference to that note.
|
||||
1. Go to one of the supported notes (listed above) and look for the  button in the <a class="reference-link" href="../../../Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons.md">Floating buttons</a> area.
|
||||
2. Go to a <a class="reference-link" href="../../Text.md">Text</a> note and use the Paste function to insert the reference to that note.
|
||||
|
||||
## Interaction
|
||||
|
||||
* Double-clicking an image reference from a text note will automatically open the target note.
|
||||
* Clicking an image reference while <kbd>Ctrl</kbd> is pressed will open the target note in a new tab.
|
||||
* Modifying the target note should also update the image reference. If that doesn't happen, consider [Refreshing the application](../../../Troubleshooting/Refreshing%20the%20application.md).
|
||||
* Modifying the target note should also update the image reference. If that doesn't happen, consider <a class="reference-link" href="../../../Troubleshooting/Refreshing%20the%20application.md">Refreshing the application</a>.
|
||||
@ -3,4 +3,4 @@ Text notes can "include" another note as a read-only widget. This can be useful
|
||||
|
||||
## Including a note
|
||||
|
||||
In the [Formatting toolbar](Formatting%20toolbar.md), look for the  button. There is also a keyboard shortcut defined for it but it is not allocated by default.
|
||||
In the <a class="reference-link" href="Formatting%20toolbar.md">Formatting toolbar</a>, look for the  button. There is also a keyboard shortcut defined for it but it is not allocated by default.
|
||||
736
src/public/app/doc_notes/en/User Guide/!!!meta.json
generated
736
src/public/app/doc_notes/en/User Guide/!!!meta.json
generated
File diff suppressed because it is too large
Load Diff
@ -17,7 +17,7 @@
|
||||
attachments, which can be either images or files. These attachments can
|
||||
be displayed or linked within the note that owns them.</p>
|
||||
<p>This can be especially useful to include dependencies for your <a href="../../Note%20Types/Code/Scripts.html">scripts</a>.
|
||||
The <a href="../../Advanced%20Usage/Advanced%20Showcases/Weight%20Tracker.html">Weight Tracker</a> shows
|
||||
The <a class="reference-link" href="../../Advanced%20Usage/Advanced%20Showcases/Weight%20Tracker.html">Weight Tracker</a> shows
|
||||
how to use <a href="https://chartjs.org/">chartjs</a> which is attached to
|
||||
the <a href="#root/HcUYTojFohtb">script note</a>.</p>
|
||||
<p>Each note exclusively owns its attachments, meaning attachments cannot
|
||||
|
||||
@ -32,7 +32,7 @@
|
||||
<p>This view presents the child notes in a grid format, allowing for a more
|
||||
visual navigation experience.</p>
|
||||
<ul>
|
||||
<li>For <a class="reference-link" href="../../Note%20Types/Text.html">Text</a> note,
|
||||
<li>For <a class="reference-link" href="../../Note%20Types/Text.html">Text</a> notes,
|
||||
the text can be slighly scrollable via the mouse wheel to reveal more context.</li>
|
||||
<li>For <a class="reference-link" href="../../Note%20Types/Code.html">Code</a> notes,
|
||||
syntax highlighting is applied.</li>
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 112 KiB |
@ -18,7 +18,7 @@
|
||||
book-like reading experience. This format is particularly useful for viewing
|
||||
multiple smaller notes in a cohesive, continuous manner.</p>
|
||||
<p>
|
||||
<img src="1_Book_image.png">
|
||||
<img src="Book_image.png">
|
||||
</p>
|
||||
<p>In the example above, the "node.js" note on the left panel contains several
|
||||
child notes. The right panel displays the content of these child notes
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 176 KiB After Width: | Height: | Size: 112 KiB |
@ -33,7 +33,7 @@
|
||||
we're onto something.</p>
|
||||
<h2>Use cases</h2>
|
||||
<ul>
|
||||
<li><a class="reference-link" href="Scripts/New%20Task%20launcher%20button.html">A button launcher button</a>
|
||||
<li><a class="reference-link" href="Scripts/New%20Task%20launcher%20button.html">"New Task" launcher button</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h2>Action handler</h2>
|
||||
@ -55,12 +55,12 @@
|
||||
<p>(<code>#run=frontendStartup</code> does not work for <a href="../../Installation%20%26%20Setup/Mobile%20Frontend.html">Mobile frontend</a> -
|
||||
if you want to have scripts running there, give the script <code>#run=mobileStartup</code> label)</p>
|
||||
<h2>More showcases</h2>
|
||||
<p>You can see more scripting with explanation in <a href="../../Advanced%20Usage/Advanced%20Showcases.html">Advanced showcases</a>
|
||||
</p>
|
||||
<p>You can see more scripting with explanation in <a class="reference-link"
|
||||
href="../../Advanced%20Usage/Advanced%20Showcases.html">Advanced Showcases</a>.</p>
|
||||
<h2>Events</h2>
|
||||
<p>See <a href="Events.html">Events</a>.</p>
|
||||
<p>See <a class="reference-link" href="Events.html">Events</a>.</p>
|
||||
<h2>Script API</h2>
|
||||
<p>See <a href="Script%20API.html">Script API</a>.</p>
|
||||
<p>See <a class="reference-link" href="Script%20API.html">Script API</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
@ -30,9 +30,8 @@
|
||||
</ul>
|
||||
<h2>Interaction</h2>
|
||||
<ul>
|
||||
<li>To create a new<strong> </strong>node at the same level as the current
|
||||
one, press <kbd>Enter</kbd>, enter the desired text and then press <kbd>Enter</kbd> once
|
||||
again to confirm.</li>
|
||||
<li>To create a new node at the same level as the current one, press <kbd>Enter</kbd>,
|
||||
enter the desired text and then press <kbd>Enter</kbd> once again to confirm.</li>
|
||||
<li>Similarly, to create a sub-node, press <kbd>Tab</kbd>, enter the desired
|
||||
text and then press <kbd>Enter</kbd>.</li>
|
||||
<li>To create a parent, use <kbd>Ctrl</kbd>+<kbd>Enter</kbd> instead.</li>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user