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

chore(docs): add back some reference links

Browse Source
This commit is contained in:
Elian Doran
2025-04-05 02:42:14 +03:00
parent 6a69e9b208
commit 79fa2a2200
30 changed files with 845 additions and 807 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/User Guide/User Guide/Basic Concepts and Features/Navigation/Jump to Note.md
View File

@@ -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 ![](1_Jump%20to%20Note_image.png) button.
* In the <a class="reference-link" href="../UI%20Elements/Launch%20Bar.md">Launch Bar</a>, press ![](1_Jump%20to%20Note_image.png) 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.

10
docs/User Guide/User Guide/Basic Concepts and Features/Navigation/Quick search.md
View File

@@ -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.

4
docs/User Guide/User Guide/Basic Concepts and Features/Notes/Attachments.md
View File

@@ -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.

10
docs/User Guide/User Guide/Basic Concepts and Features/Notes/Note List.md
View File

@@ -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
![](2_Note%20List_image.png)
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.

10
docs/User Guide/User Guide/Basic Concepts and Features/Notes/Read-Only Notes.md
View File

@@ -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 ![](Read-Only%20Notes_image.png) 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 ![](Read-Only%20Notes_image.png) 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.

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

@@ -1,11 +1,11 @@
# Floating buttons
![](Floating%20buttons_image.png)
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

5
docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Options.md
View File

@@ -10,8 +10,9 @@ The Options can be accessed via:
* The [Global menu](Global%20menu.md), by selecting the _Options_ item.
* The ![](1_Options_image.png) 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).

10
docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Split View.md
View File

@@ -5,19 +5,19 @@ In Trilium, is possible to work with two or more notes side-by-side.
## **Interactions**
* Press the ![](Split%20View_Split%20View_imag.png)![](https://file+.vscode-resource.vscode-cdn.net/home/elian/UI%20Elements/Split%20View_image.png) button to the right of a note's title to open a new split to the right of it.
* Press the ![](Split%20View_Split%20View_imag.png) 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 ![](https://file+.vscode-resource.vscode-cdn.net/home/elian/UI%20Elements/3_Split%20View_image.png)![](Split%20View_3_Split%20View_im.png) button next to it to close it.
* Use the ![](Split%20View_4_Split%20View_im.png)![](https://file+.vscode-resource.vscode-cdn.net/home/elian/UI%20Elements/4_Split%20View_image.png) or the ![](Split%20View_1_Split%20View_im.png)![](https://file+.vscode-resource.vscode-cdn.net/home/elian/UI%20Elements/1_Split%20View_image.png) button to move around the splits.
* When at least one split is open, press the ![](Split%20View_3_Split%20View_im.png) button next to it to close it.
* Use the ![](Split%20View_4_Split%20View_im.png) or the ![](Split%20View_1_Split%20View_im.png) 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.

8
docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Tabs.md
View File

@@ -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 ![](1_Tabs_image.png) button that is to the right of the last tab.
* To close a tab, press the corresponding ![](Tabs_image.png) 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.