mirror of
https://github.com/zadam/trilium.git
synced 2025-11-01 19:05:59 +01:00
docs(guide): relocate note list documentation
This commit is contained in:
Elian Doran
1118
docs/User Guide/!!!meta.json
vendored
1118
docs/User Guide/!!!meta.json
vendored
File diff suppressed because it is too large
Load Diff
File diff suppressed because one or more lines are too long
@@ -41,4 +41,14 @@ These relations are supported and used internally by Trilium.
|
||||
> [!TIP]
|
||||
> Some relations presented here end with a `*`. That means that there are multiple relations with the same prefix, consult the specific page linked in the description of that relation for more information.
|
||||
|
||||
<figure class="table" style="width:100%;"><table class="ck-table-resized"><colgroup><col style="width:33.95%;"><col style="width:66.05%;"></colgroup><thead><tr><th>Label</th><th>Description</th></tr></thead><tbody><tr><td><code>runOn*</code></td><td>See <a class="reference-link" href="../../Scripting/Events.md">Events</a></td></tr><tr><td><code>template</code></td><td>note's attributes will be inherited even without a parent-child relationship, note's content and subtree will be added to instance notes if empty. See documentation for details.</td></tr><tr><td><code>inherit</code></td><td>note's attributes will be inherited even without a parent-child relationship. See <a class="reference-link" href="../Templates.md">Templates</a> for a similar concept. See <a class="reference-link" href="Attribute%20Inheritance.md">Attribute Inheritance</a> in the documentation.</td></tr><tr><td><code>renderNote</code></td><td>notes of type <a class="reference-link" href="../../Note%20Types/Render%20Note.md">Render Note</a> will be rendered using a code note (HTML or script) and it is necessary to point using this relation to which note should be rendered</td></tr><tr><td><code>widget_relation</code></td><td>target of this relation will be executed and rendered as a widget in the sidebar</td></tr><tr><td><code>shareCss</code></td><td>CSS note which will be injected into the share page. CSS note must be in the shared sub-tree as well. Consider using <code>share_hidden_from_tree</code> and <code>share_omit_default_css</code> as well.</td></tr><tr><td><code>shareJs</code></td><td>JavaScript note which will be injected into the share page. JS note must be in the shared sub-tree as well. Consider using <code>share_hidden_from_tree</code>.</td></tr><tr><td><code>shareTemplate</code></td><td>Embedded JavaScript note that will be used as the template for displaying the shared note. Falls back to the default template. Consider using <code>share_hidden_from_tree</code>.</td></tr><tr><td><code>shareFavicon</code></td><td>Favicon note to be set in the shared page. Typically you want to set it to share root and make it inheritable. Favicon note must be in the shared sub-tree as well. Consider using <code>share_hidden_from_tree</code>.</td></tr></tbody></table></figure>
|
||||
| Label | Description |
|
||||
| --- | --- |
|
||||
| `runOn*` | See <a class="reference-link" href="../../Scripting/Events.md">Events</a> |
|
||||
| `template` | note's attributes will be inherited even without a parent-child relationship, note's content and subtree will be added to instance notes if empty. See documentation for details. |
|
||||
| `inherit` | note's attributes will be inherited even without a parent-child relationship. See <a class="reference-link" href="../Templates.md">Templates</a> for a similar concept. See <a class="reference-link" href="Attribute%20Inheritance.md">Attribute Inheritance</a> in the documentation. |
|
||||
| `renderNote` | notes of type <a class="reference-link" href="../../Note%20Types/Render%20Note.md">Render Note</a> will be rendered using a code note (HTML or script) and it is necessary to point using this relation to which note should be rendered |
|
||||
| `widget_relation` | target of this relation will be executed and rendered as a widget in the sidebar |
|
||||
| `shareCss` | CSS note which will be injected into the share page. CSS note must be in the shared sub-tree as well. Consider using `share_hidden_from_tree` and `share_omit_default_css` as well. |
|
||||
| `shareJs` | JavaScript note which will be injected into the share page. JS note must be in the shared sub-tree as well. Consider using `share_hidden_from_tree`. |
|
||||
| `shareTemplate` | Embedded JavaScript note that will be used as the template for displaying the shared note. Falls back to the default template. Consider using `share_hidden_from_tree`. |
|
||||
| `shareFavicon` | Favicon note to be set in the shared page. Typically you want to set it to share root and make it inheritable. Favicon note must be in the shared sub-tree as well. Consider using `share_hidden_from_tree`. |
|
||||
@@ -3,4 +3,8 @@ By default, Trilium cannot be accessed in web browsers by requests coming from o
|
||||
|
||||
However, it is possible to manually configure [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/CORS) since Trilium v0.93.0 using environment variables or `config.ini`, as follows:
|
||||
|
||||
<figure class="table" style="width:100%;"><table class="ck-table-resized"><colgroup><col style="width:26.93%;"><col style="width:32.46%;"><col style="width:40.61%;"></colgroup><thead><tr><th>CORS Header</th><th>Corresponding option in <code>config.ini</code></th><th>Corresponding option in environment variables in the <code>Network</code> section</th></tr></thead><tbody><tr><td><code>Access-Control-Allow-Origin</code></td><td><code>TRILIUM_NETWORK_CORS_ALLOW_ORIGIN</code></td><td><code>corsAllowOrigin</code> </td></tr><tr><td><code>Access-Control-Allow-Methods</code></td><td><code>TRILIUM_NETWORK_CORS_ALLOW_METHODS</code></td><td><code>corsAllowMethods</code> </td></tr><tr><td><code>Access-Control-Allow-Headers</code></td><td><code>TRILIUM_NETWORK_CORS_ALLOW_HEADERS</code></td><td><code>corsAllowHeaders</code></td></tr></tbody></table></figure>
|
||||
| CORS Header | Corresponding option in `config.ini` | Corresponding option in environment variables in the `Network` section |
|
||||
| --- | --- | --- |
|
||||
| `Access-Control-Allow-Origin` | `TRILIUM_NETWORK_CORS_ALLOW_ORIGIN` | `corsAllowOrigin` |
|
||||
| `Access-Control-Allow-Methods` | `TRILIUM_NETWORK_CORS_ALLOW_METHODS` | `corsAllowMethods` |
|
||||
| `Access-Control-Allow-Headers` | `TRILIUM_NETWORK_CORS_ALLOW_HEADERS` | `corsAllowHeaders` |
|
||||
File diff suppressed because one or more lines are too long
@@ -7,7 +7,7 @@ For example:
|
||||
|
||||
* <a class="reference-link" href="../Note%20Types/Text.md">Text</a> notes are represented internally as HTML, using the <a class="reference-link" href="Technologies%20used/CKEditor.md">CKEditor</a> representation. Note that due to the custom plugins, some HTML elements are specific to Trilium only, for example the admonitions.
|
||||
* <a class="reference-link" href="../Note%20Types/Code.md">Code</a> notes are plain text and are represented internally as-is.
|
||||
* <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Notes/Note%20List/Geo%20Map%20View.md">Geo Map</a> notes contain only minimal information (viewport, zoom) as a JSON.
|
||||
* <a class="reference-link" href="../Note%20Types/Collections/Geo%20Map%20View.md">Geo Map</a> notes contain only minimal information (viewport, zoom) as a JSON.
|
||||
* <a class="reference-link" href="../Note%20Types/Canvas.md">Canvas</a> notes are represented as JSON, with Trilium's own information alongside with <a class="reference-link" href="Technologies%20used/Excalidraw.md">Excalidraw</a>'s internal JSON representation format.
|
||||
* <a class="reference-link" href="../Note%20Types/Mind%20Map.md">Mind Map</a> notes are represented as JSON, with the internal format of <a class="reference-link" href="Technologies%20used/MindElixir.md">MindElixir</a>.
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ Trilium allows you to share selected notes as **publicly accessible** read-only
|
||||
|
||||
### By note type
|
||||
|
||||
<figure class="table" style="width:100%;"><table class="ck-table-resized"><colgroup><col style="width:19.92%;"><col style="width:41.66%;"><col style="width:38.42%;"></colgroup><thead><tr><th> </th><th>Supported features</th><th>Limitations</th></tr></thead><tbody><tr><th><a class="reference-link" href="../Note%20Types/Text.md">Text</a></th><td><ul><li>Table of contents.</li><li>Syntax highlight of code blocks, provided a language is selected (does not work if “Auto-detected” is enabled).</li><li>Rendering for math equations.</li></ul></td><td><ul><li>Including notes is not supported.</li><li>Inline Mermaid diagrams are not rendered.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Code.md">Code</a></th><td><ul><li>Basic support (displaying the contents of the note in a monospace font).</li></ul></td><td><ul><li>No syntax highlight.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Saved%20Search.md">Saved Search</a></th><td>Not supported.</td><td> </td></tr><tr><th><a class="reference-link" href="../Note%20Types/Relation%20Map.md">Relation Map</a></th><td>Not supported.</td><td> </td></tr><tr><th><a class="reference-link" href="../Note%20Types/Note%20Map.md">Note Map</a></th><td>Not supported.</td><td> </td></tr><tr><th><a class="reference-link" href="../Note%20Types/Render%20Note.md">Render Note</a></th><td>Not supported.</td><td> </td></tr><tr><th><a class="reference-link" href="../Note%20Types/Collections.md">Collections</a></th><td><ul><li>The child notes are displayed in a fixed format. </li></ul></td><td><ul><li>More advanced view types such as the calendar view are not supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Mermaid%20Diagrams.md">Mermaid Diagrams</a></th><td><ul><li>The diagram is displayed as a vector image.</li></ul></td><td><ul><li>No further interaction supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Canvas.md">Canvas</a></th><td><ul><li>The diagram is displayed as a vector image.</li></ul></td><td><ul><li>No further interaction supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Web%20View.md">Web View</a></th><td>Not supported.</td><td> </td></tr><tr><th><a class="reference-link" href="../Note%20Types/Mind%20Map.md">Mind Map</a></th><td>The diagram is displayed as a vector image.</td><td><ul><li>No further interaction supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Basic%20Concepts%20and%20Features/Notes/Note%20List/Geo%20Map%20View.md">Geo Map View</a></th><td>Not supported.</td><td> </td></tr><tr><th><a class="reference-link" href="../Note%20Types/File.md">File</a></th><td>Basic interaction (downloading the file).</td><td><ul><li>No further interaction supported.</li></ul></td></tr></tbody></table></figure>
|
||||
<table class="ck-table-resized"><colgroup><col style="width:19.92%;"><col style="width:41.66%;"><col style="width:38.42%;"></colgroup><thead><tr><th> </th><th>Supported features</th><th>Limitations</th></tr></thead><tbody><tr><th><a class="reference-link" href="../Note%20Types/Text.md">Text</a></th><td><ul><li>Table of contents.</li><li>Syntax highlight of code blocks, provided a language is selected (does not work if “Auto-detected” is enabled).</li><li>Rendering for math equations.</li></ul></td><td><ul><li>Including notes is not supported.</li><li>Inline Mermaid diagrams are not rendered.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Code.md">Code</a></th><td><ul><li>Basic support (displaying the contents of the note in a monospace font).</li></ul></td><td><ul><li>No syntax highlight.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Saved%20Search.md">Saved Search</a></th><td>Not supported.</td><td> </td></tr><tr><th><a class="reference-link" href="../Note%20Types/Relation%20Map.md">Relation Map</a></th><td>Not supported.</td><td> </td></tr><tr><th><a class="reference-link" href="../Note%20Types/Note%20Map.md">Note Map</a></th><td>Not supported.</td><td> </td></tr><tr><th><a class="reference-link" href="../Note%20Types/Render%20Note.md">Render Note</a></th><td>Not supported.</td><td> </td></tr><tr><th><a class="reference-link" href="../Note%20Types/Collections.md">Collections</a></th><td><ul><li>The child notes are displayed in a fixed format. </li></ul></td><td><ul><li>More advanced view types such as the calendar view are not supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Mermaid%20Diagrams.md">Mermaid Diagrams</a></th><td><ul><li>The diagram is displayed as a vector image.</li></ul></td><td><ul><li>No further interaction supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Canvas.md">Canvas</a></th><td><ul><li>The diagram is displayed as a vector image.</li></ul></td><td><ul><li>No further interaction supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Web%20View.md">Web View</a></th><td>Not supported.</td><td> </td></tr><tr><th><a class="reference-link" href="../Note%20Types/Mind%20Map.md">Mind Map</a></th><td>The diagram is displayed as a vector image.</td><td><ul><li>No further interaction supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Collections/Geo%20Map%20View.md">Geo Map View</a></th><td>Not supported.</td><td> </td></tr><tr><th><a class="reference-link" href="../Note%20Types/File.md">File</a></th><td>Basic interaction (downloading the file).</td><td><ul><li>No further interaction supported.</li></ul></td></tr></tbody></table>
|
||||
|
||||
While the sharing feature is powerful, it has some limitations:
|
||||
|
||||
@@ -103,7 +103,7 @@ You can designate a specific note or folder as the root of your shared content b
|
||||
|
||||
## Attribute reference
|
||||
|
||||
<figure class="table"><table><thead><tr><th>Attribute</th><th>Description</th></tr></thead><tbody><tr><td><code>shareHiddenFromTree</code></td><td>this note is hidden from left navigation tree, but still accessible with its URL</td></tr><tr><td><code>shareExternalLink</code></td><td>note will act as a link to an external website in the share tree</td></tr><tr><td><code>shareAlias</code></td><td>define an alias using which the note will be available under <code>https://your_trilium_host/share/[your_alias]</code></td></tr><tr><td><code>shareOmitDefaultCss</code></td><td>default share page CSS will be omitted. Use when you make extensive styling changes.</td></tr><tr><td><code>shareRoot</code></td><td>marks note which is served on /share root.</td></tr><tr><td><code>shareDescription</code></td><td>define text to be added to the HTML meta tag for description</td></tr><tr><td><code>shareRaw</code></td><td>Note will be served in its raw format, without HTML wrapper. See also <a class="reference-link" href="Sharing/Serving%20directly%20the%20content%20o.md">Serving directly the content of a note</a> for an alternative method without setting an attribute.</td></tr><tr><td><code>shareDisallowRobotIndexing</code></td><td><p>Indicates to web crawlers that the page should not be indexed of this note by:</p><ul><li>Setting the <code>X-Robots-Tag: noindex</code> HTTP header.</li><li>Setting the <code>noindex, follow</code> meta tag.</li></ul></td></tr><tr><td><code>shareCredentials</code></td><td>require credentials to access this shared note. Value is expected to be in format <code>username:password</code>. Don't forget to make this inheritable to apply to child-notes/images.</td></tr><tr><td><code>shareIndex</code></td><td>Note with this label will list all roots of shared notes.</td></tr></tbody></table></figure>
|
||||
<table><thead><tr><th>Attribute</th><th>Description</th></tr></thead><tbody><tr><td><code>shareHiddenFromTree</code></td><td>this note is hidden from left navigation tree, but still accessible with its URL</td></tr><tr><td><code>shareExternalLink</code></td><td>note will act as a link to an external website in the share tree</td></tr><tr><td><code>shareAlias</code></td><td>define an alias using which the note will be available under <code>https://your_trilium_host/share/[your_alias]</code></td></tr><tr><td><code>shareOmitDefaultCss</code></td><td>default share page CSS will be omitted. Use when you make extensive styling changes.</td></tr><tr><td><code>shareRoot</code></td><td>marks note which is served on /share root.</td></tr><tr><td><code>shareDescription</code></td><td>define text to be added to the HTML meta tag for description</td></tr><tr><td><code>shareRaw</code></td><td>Note will be served in its raw format, without HTML wrapper. See also <a class="reference-link" href="Sharing/Serving%20directly%20the%20content%20o.md">Serving directly the content of a note</a> for an alternative method without setting an attribute.</td></tr><tr><td><code>shareDisallowRobotIndexing</code></td><td><p>Indicates to web crawlers that the page should not be indexed of this note by:</p><ul><li>Setting the <code>X-Robots-Tag: noindex</code> HTTP header.</li><li>Setting the <code>noindex, follow</code> meta tag.</li></ul></td></tr><tr><td><code>shareCredentials</code></td><td>require credentials to access this shared note. Value is expected to be in format <code>username:password</code>. Don't forget to make this inheritable to apply to child-notes/images.</td></tr><tr><td><code>shareIndex</code></td><td>Note with this label will list all roots of shared notes.</td></tr></tbody></table>
|
||||
|
||||
## Credits
|
||||
|
||||
|
||||
@@ -1,7 +1,9 @@
|
||||
# Serving directly the content of a note
|
||||
When accessing a shared note, Trilium will render it as a web page. Sometimes it's desirable to serve the content directly so that it can be used in a script or downloaded by the user.
|
||||
|
||||
<figure class="table"><table><thead><tr><th>A note displayed as a web page (HTML)</th><th>A note displayed as a raw format</th></tr></thead><tbody><tr><td><figure class="image"><img style="aspect-ratio:738/275;" src="1_Serving directly the conte.png" width="738" height="275"></figure></td><td><img src="Serving directly the conte.png"></td></tr></tbody></table></figure>
|
||||
| A note displayed as a web page (HTML) | A note displayed as a raw format |
|
||||
| --- | --- |
|
||||
| <figure class="image"><img style="aspect-ratio:738/275;" src="1_Serving directly the conte.png" width="738" height="275"></figure> |  |
|
||||
|
||||
## By adding an attribute to the note
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# Leaflet
|
||||
Leaflet is the library behind [Geo map](../../Basic%20Concepts%20and%20Features/Notes/Note%20List/Geo%20Map%20View.md) notes.
|
||||
Leaflet is the library behind [Geo map](../../Note%20Types/Collections/Geo%20Map%20View.md) notes.
|
||||
|
||||
## Plugins
|
||||
|
||||
|
||||
@@ -12,4 +12,12 @@ So far workspace consists of these features:
|
||||
|
||||
### Configuration
|
||||
|
||||
<figure class="table"><table><thead><tr><th>Label</th><th>Description</th></tr></thead><tbody><tr><td><code>workspace</code></td><td>Marks this note as a workspace, button to enter the workspace is controlled by this</td></tr><tr><td><code>workspaceIconClass</code></td><td>defines box icon CSS class which will be used in tab when hoisted to this note</td></tr><tr><td><code>workspaceTabBackgroundColor</code></td><td>CSS color used in the note tab when hoisted to this note, use any CSS color format, e.g. "lightblue" or "#ddd". See <a href="https://www.w3schools.com/cssref/css_colors.asp">https://www.w3schools.com/cssref/css_colors.asp</a>.</td></tr><tr><td><code>workspaceCalendarRoot</code></td><td>Marking a note with this label will define a new per-workspace calendar for <a class="reference-link" href="../../Advanced%20Usage/Advanced%20Showcases/Day%20Notes.md">Day Notes</a>. If there's no such note, the global calendar will be used.</td></tr><tr><td><code>workspaceTemplate</code></td><td>This note will appear in the selection of available template when creating new note, but only when hoisted into a workspace containing this template</td></tr><tr><td><code>workspaceSearchHome</code></td><td>new search notes will be created as children of this note when hoisted to some ancestor of this workspace note</td></tr><tr><td><code>workspaceInbox</code></td><td>default inbox location for new notes when hoisted to some ancestor of this workspace note</td></tr></tbody></table></figure>
|
||||
| Label | Description |
|
||||
| --- | --- |
|
||||
| `workspace` | Marks this note as a workspace, button to enter the workspace is controlled by this |
|
||||
| `workspaceIconClass` | defines box icon CSS class which will be used in tab when hoisted to this note |
|
||||
| `workspaceTabBackgroundColor` | CSS color used in the note tab when hoisted to this note, use any CSS color format, e.g. "lightblue" or "#ddd". See [https://www.w3schools.com/cssref/css\_colors.asp](https://www.w3schools.com/cssref/css_colors.asp). |
|
||||
| `workspaceCalendarRoot` | Marking a note with this label will define a new per-workspace calendar for <a class="reference-link" href="../../Advanced%20Usage/Advanced%20Showcases/Day%20Notes.md">Day Notes</a>. If there's no such note, the global calendar will be used. |
|
||||
| `workspaceTemplate` | This note will appear in the selection of available template when creating new note, but only when hoisted into a workspace containing this template |
|
||||
| `workspaceSearchHome` | new search notes will be created as children of this note when hoisted to some ancestor of this workspace note |
|
||||
| `workspaceInbox` | default inbox location for new notes when hoisted to some ancestor of this workspace note |
|
||||
@@ -10,8 +10,6 @@ When a note has one or more child notes, they will be listed at the end of the n
|
||||
|
||||
## View types
|
||||
|
||||
The view types dictate how the child notes are represented.
|
||||
|
||||
By default, the notes will be displayed in a grid, however there are also some other view types available.
|
||||
The view types dictate how the child notes are represented. By default, the notes will be displayed in a grid, however there are also some other view types available.
|
||||
|
||||
Generally the view type can only be changed in a <a class="reference-link" href="../../Note%20Types/Collections.md">Collections</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.
|
||||
@@ -1,111 +0,0 @@
|
||||
# Calendar View
|
||||
<figure class="image image-style-align-center"><img style="aspect-ratio:767/606;" src="4_Calendar View_image.png" width="767" height="606"></figure>
|
||||
|
||||
The Calendar view will display each child note in a calendar that has a start date and optionally an end date, as an event.
|
||||
|
||||
The Calendar view has multiple display modes:
|
||||
|
||||
* Week view, where all the 7 days of the week (or 5 if the weekends are hidden) are displayed in columns. This mode allows entering and displaying time-specific events, not just all-day events.
|
||||
* Month view, where the entire month is displayed and all-day events can be inserted. Both time-specific events and all-day events are listed.
|
||||
* Year view, which displays the entire year for quick reference.
|
||||
* List view, which displays all the events of a given month in sequence.
|
||||
|
||||
Unlike other Collection view types, the Calendar view also allows some kind of interaction, such as moving events around as well as creating new ones.
|
||||
|
||||
## Creating a calendar
|
||||
|
||||
<figure class="table"><table><thead><tr><th> </th><th> </th><th> </th></tr></thead><tbody><tr><td>1</td><td><img src="2_Calendar View_image.png"></td><td>The Calendar View works only for Collection note types. To create a new note, right click on the note tree on the left and select Insert note after, or Insert child note and then select <em>Collection</em>.</td></tr><tr><td>2</td><td><img src="3_Calendar View_image.png"></td><td>Once created, the “View type” of the Collection needs changed to “Calendar”, by selecting the “Collection Properties” tab in the ribbon.</td></tr></tbody></table></figure>
|
||||
|
||||
## Creating a new event/note
|
||||
|
||||
* Clicking on a day will create a new child note and assign it to that particular day.
|
||||
* You will be asked for the name of the new note. If the popup is dismissed by pressing the close button or escape, then the note will not be created.
|
||||
* It's possible to drag across multiple days to set both the start and end date of a particular note.
|
||||
|
||||
* Creating new notes from the calendar will respect the `~child:template` relation if set on the Collection note.
|
||||
|
||||
## Interacting with events
|
||||
|
||||
* Hovering the mouse over an event will display information about the note.
|
||||
|
||||
* Left clicking the event will open a <a class="reference-link" href="../../UI%20Elements/Quick%20edit.md">Quick edit</a> to edit the note in a popup while allowing easy return to the calendar by just dismissing the popup.
|
||||
* Middle clicking will open the note in a new tab.
|
||||
* Right click will offer more options including opening the note in a new split or window.
|
||||
* Drag and drop an event on the calendar to move it to another day.
|
||||
* The length of an event can be changed by placing the mouse to the right edge of the event and dragging the mouse around.
|
||||
|
||||
## Configuring the calendar view
|
||||
|
||||
In the _Collections_ tab in the <a class="reference-link" href="../../UI%20Elements/Ribbon.md">Ribbon</a>, it's possible to adjust the following:
|
||||
|
||||
* Hide weekends from the week view.
|
||||
* Display week numbers on the calendar.
|
||||
|
||||
## Configuring the calendar using attributes
|
||||
|
||||
The following attributes can be added to the Collection type:
|
||||
|
||||
<figure class="table"><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><code>#calendar:hideWeekends</code></td><td>When present (regardless of value), it will hide Saturday and Sundays from the calendar.</td></tr><tr><td><code>#calendar:weekNumbers</code></td><td>When present (regardless of value), it will show the number of the week on the calendar.</td></tr><tr><td><code>#calendar:view</code></td><td><p>Which view to display in the calendar:</p><ul><li><code>timeGridWeek</code> for the <em>week</em> view;</li><li><code>dayGridMonth</code> for the <em>month</em> view;</li><li><code>multiMonthYear</code> for the <em>year</em> view;</li><li><code>listMonth</code> for the <em>list</em> view.</li></ul><p>Any other value will be dismissed and the default view (month) will be used instead.</p><p>The value of this label is automatically updated when changing the view using the UI buttons.</p></td></tr><tr><td><code>~child:template</code></td><td>Defines the template for newly created notes in the calendar (via dragging or clicking).</td></tr></tbody></table></figure>
|
||||
|
||||
In addition, the first day of the week can be either Sunday or Monday and can be adjusted from the application settings.
|
||||
|
||||
## Configuring the calendar events using attributes
|
||||
|
||||
For each note of the calendar, the following attributes can be used:
|
||||
|
||||
<figure class="table"><table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><code>#startDate</code></td><td>The date the event starts, which will display it in the calendar. The format is <code>YYYY-MM-DD</code> (year, month and day separated by a minus sign).</td></tr><tr><td><code>#endDate</code></td><td>Similar to <code>startDate</code>, mentions the end date if the event spans across multiple days. The date is inclusive, so the end day is also considered. The attribute can be missing for single-day events.</td></tr><tr><td><code>#startTime</code></td><td>The time the event starts at. If this value is missing, then the event is considered a full-day event. The format is <code>HH:MM</code> (hours in 24-hour format and minutes).</td></tr><tr><td><code>#endTime</code></td><td>Similar to <code>startTime</code>, it mentions the time at which the event ends (in relation with <code>endDate</code> if present, or <code>startDate</code>).</td></tr><tr><td><code>#color</code></td><td>Displays the event with a specified color (named such as <code>red</code>, <code>gray</code> or hex such as <code>#FF0000</code>). This will also change the color of the note in other places such as the note tree.</td></tr><tr><td><code>#calendar:color</code></td><td>Similar to <code>#color</code>, but applies the color only for the event in the calendar and not for other places such as the note tree.</td></tr><tr><td><code>#iconClass</code></td><td>If present, the icon of the note will be displayed to the left of the event title.</td></tr><tr><td><code>#calendar:title</code></td><td>Changes the title of an event to point to an attribute of the note other than the title, can either a label or a relation (without the <code>#</code> or <code>~</code> symbol). See <em>Use-cases</em> for more information.</td></tr><tr><td><code>#calendar:displayedAttributes</code></td><td>Allows displaying the value of one or more attributes in the calendar like this: <br><br><img src="9_Calendar View_image.png"> <br><br><code>#weight="70" #Mood="Good" #calendar:displayedAttributes="weight,Mood"</code> <br><br>It can also be used with relations, case in which it will display the title of the target note: <br><br><code>~assignee=@My assignee #calendar:displayedAttributes="assignee"</code></td></tr><tr><td><code>#calendar:startDate</code></td><td>Allows using a different label to represent the start date, other than <code>startDate</code> (e.g. <code>expiryDate</code>). The label name <strong>must not be</strong> prefixed with <code>#</code>. If the label is not defined for a note, the default will be used instead.</td></tr><tr><td><code>#calendar:endDate</code></td><td>Similar to <code>#calendar:startDate</code>, allows changing the attribute which is being used to read the end date.</td></tr><tr><td><code>#calendar:startTime</code></td><td>Similar to <code>#calendar:startDate</code>, allows changing the attribute which is being used to read the start time.</td></tr><tr><td><code>#calendar:endTime</code></td><td>Similar to <code>#calendar:startDate</code>, allows changing the attribute which is being used to read the end time.</td></tr></tbody></table></figure>
|
||||
|
||||
## How the calendar works
|
||||
|
||||
|
||||
|
||||
The calendar displays all the child notes of the Collection that have a `#startDate`. An `#endDate` can optionally be added.
|
||||
|
||||
If editing the start date and end date from the note itself is desirable, the following attributes can be added to the Collection note:
|
||||
|
||||
```
|
||||
#viewType=calendar #label:startDate(inheritable)="promoted,alias=Start Date,single,date"
|
||||
#label:endDate(inheritable)="promoted,alias=End Date,single,date"
|
||||
#hidePromotedAttributes
|
||||
```
|
||||
|
||||
This will result in:
|
||||
|
||||
|
||||
|
||||
When not used in a Journal, the calendar is recursive. That is, it will look for events not just in its child notes but also in the children of these child notes.
|
||||
|
||||
## Use-cases
|
||||
|
||||
### Using with the Journal / calendar
|
||||
|
||||
It is possible to integrate the calendar view into the Journal with day notes. In order to do so change the note type of the Journal note (calendar root) to Collection and then select the Calendar View.
|
||||
|
||||
Based on the `#calendarRoot` (or `#workspaceCalendarRoot`) attribute, the calendar will know that it's in a calendar and apply the following:
|
||||
|
||||
* The calendar events are now rendered based on their `dateNote` attribute rather than `startDate`.
|
||||
* Interactive editing such as dragging over an empty era or resizing an event is no longer possible.
|
||||
* Clicking on the empty space on a date will automatically open that day's note or create it if it does not exist.
|
||||
* Direct children of a day note will be displayed on the calendar despite not having a `dateNote` attribute. Children of the child notes will not be displayed.
|
||||
|
||||
<img src="8_Calendar View_image.png" width="1217" height="724">
|
||||
|
||||
### Using a different attribute as event title
|
||||
|
||||
By default, events are displayed on the calendar by their note title. However, it is possible to configure a different attribute to be displayed instead.
|
||||
|
||||
To do so, assign `#calendar:title` to the child note (not the calendar/Collection note), with the value being `name` where `name` can be any label (make not to add the `#` prefix). The attribute can also come through inheritance such as a template attribute. If the note does not have the requested label, the title of the note will be used instead.
|
||||
|
||||
<figure class="table" style="width:100%;"><table><thead><tr><th> </th><th> </th></tr></thead><tbody><tr><td><pre><code class="language-text-x-trilium-auto">#startDate=2025-02-11 #endDate=2025-02-13 #name="My vacation" #calendar:title="name"</code></pre></td><td><p> </p><figure class="image image-style-align-center"><img style="aspect-ratio:445/124;" src="5_Calendar View_image.png" width="445" height="124"></figure></td></tr></tbody></table></figure>
|
||||
|
||||
### Using a relation attribute as event title
|
||||
|
||||
Similarly to using an attribute, use `#calendar:title` and set it to `name` where `name` is the name of the relation to use.
|
||||
|
||||
Moreover, if there are more relations of the same name, they will be displayed as multiple events coming from the same note.
|
||||
|
||||
<figure class="table" style="width:100%;"><table><thead><tr><th> </th><th> </th></tr></thead><tbody><tr><td><pre><code class="language-text-x-trilium-auto">#startDate=2025-02-14 #endDate=2025-02-15 ~for=@John Smith ~for=@Jane Doe #calendar:title="for"</code></pre></td><td><img src="6_Calendar View_image.png" width="294" height="151"></td></tr></tbody></table></figure>
|
||||
|
||||
Note that it's even possible to have a `#calendar:title` on the target note (e.g. “John Smith”) which will try to render an attribute of it. Note that it's not possible to use a relation here as well for safety reasons (an accidental recursion of attributes could cause the application to loop infinitely).
|
||||
|
||||
<figure class="table" style="width:100%;"><table><thead><tr><th> </th><th> </th></tr></thead><tbody><tr><td><pre><code class="language-text-x-trilium-auto">#calendar:title="shortName" #shortName="John S."</code></pre></td><td><figure class="image image-style-align-center"><img style="aspect-ratio:296/150;" src="1_Calendar View_image.png" width="296" height="150"></figure></td></tr></tbody></table></figure>
|
||||
@@ -1,134 +0,0 @@
|
||||
# Geo Map View
|
||||
> [!IMPORTANT]
|
||||
> Starting with Trilium v0.97.0, the geo map has been converted from a standalone [note type](../../../Note%20Types.md) to a type of view for the <a class="reference-link" href="../Note%20List.md">Note List</a>.
|
||||
|
||||
<figure class="image image-style-align-center"><img style="aspect-ratio:892/675;" src="9_Geo Map View_image.png" width="892" height="675"></figure>
|
||||
|
||||
This note type displays the children notes on a geographical map, based on an attribute. It is also possible to add new notes at a specific location using the built-in interface.
|
||||
|
||||
## Creating a new geo map
|
||||
|
||||
<figure class="table"><table><thead><tr><th> </th><th> </th><th> </th></tr></thead><tbody><tr><td>1</td><td><figure class="image"><img style="aspect-ratio:483/413;" src="15_Geo Map View_image.png" width="483" height="413"></figure></td><td>Right click on any note on the note tree and select <em>Insert child note</em> → <em>Geo Map (beta)</em>.</td></tr><tr><td>2</td><td><figure class="image image-style-align-center image_resized" style="width:53.44%;"><img style="aspect-ratio:1720/1396;" src="8_Geo Map View_image.png" width="1720" height="1396"></figure></td><td>By default the map will be empty and will show the entire world.</td></tr></tbody></table></figure>
|
||||
|
||||
## Repositioning the map
|
||||
|
||||
* Click and drag the map in order to move across the map.
|
||||
* Use the mouse wheel, two-finger gesture on a touchpad or the +/- buttons on the top-left to adjust the zoom.
|
||||
|
||||
The position on the map and the zoom are saved inside the map note and restored when visiting again the note.
|
||||
|
||||
## Adding a marker using the map
|
||||
|
||||
### Adding a new note using the plus button
|
||||
|
||||
<figure class="table"><table><thead><tr><th> </th><th> </th><th> </th></tr></thead><tbody><tr><td>1</td><td>To create a marker, first navigate to the desired point on the map. Then press the <img src="10_Geo Map View_image.png"> button in the <a href="../../UI%20Elements/Floating%20buttons.md">Floating buttons</a> (top-right) area. <br><br>If the button is not visible, make sure the button section is visible by pressing the chevron button (<img src="17_Geo Map View_image.png">) in the top-right of the map.</td><td> </td></tr><tr><td>2</td><td><img class="image_resized" style="aspect-ratio:1730/416;width:100%;" src="2_Geo Map View_image.png" width="1730" height="416"></td><td>Once pressed, the map will enter in the insert mode, as illustrated by the notification. <br><br>Simply click the point on the map where to place the marker, or the Escape key to cancel.</td></tr><tr><td>3</td><td><img class="image_resized" style="aspect-ratio:1586/404;width:100%;" src="7_Geo Map View_image.png" width="1586" height="404"></td><td>Enter the name of the marker/note to be created.</td></tr><tr><td>4</td><td><img class="image_resized" style="aspect-ratio:1696/608;width:100%;" src="16_Geo Map View_image.png" width="1696" height="608"></td><td>Once confirmed, the marker will show up on the map and it will also be displayed as a child note of the map.</td></tr></tbody></table></figure>
|
||||
|
||||
### Adding a new note using the contextual menu
|
||||
|
||||
1. Right click anywhere on the map, where to place the newly created marker (and corresponding note).
|
||||
2. Select _Add a marker at this location_.
|
||||
3. Enter the name of the newly created note.
|
||||
4. The map should be updated with the new marker.
|
||||
|
||||
### Adding an existing note on note from the note tree
|
||||
|
||||
1. Select the desired note in the <a class="reference-link" href="../../UI%20Elements/Note%20Tree.md">Note Tree</a>.
|
||||
2. Hold the mouse on the note and drag it to the map to the desired location.
|
||||
3. The map should be updated with the new marker.
|
||||
|
||||
This works for:
|
||||
|
||||
* Notes that are not part of the geo map, case in which a [clone](../Cloning%20Notes.md) will be created.
|
||||
* Notes that are a child of the geo map but not yet positioned on the map.
|
||||
* Notes that are a child of the geo map and also positioned, case in which the marker will be relocated to the new position.
|
||||
|
||||
## How the location of the markers is stored
|
||||
|
||||
The location of a marker is stored in the `#geolocation` attribute of the child notes:
|
||||
|
||||
<img src="18_Geo Map View_image.png" width="1288" height="278">
|
||||
|
||||
This value can be added manually if needed. The value of the attribute is made up of the latitude and longitude separated by a comma.
|
||||
|
||||
## Repositioning markers
|
||||
|
||||
It's possible to reposition existing markers by simply drag and dropping them to the new destination.
|
||||
|
||||
As soon as the mouse is released, the new position is saved.
|
||||
|
||||
If moved by mistake, there is currently no way to undo the change. If the mouse was not yet released, it's possible to force a refresh of the page (<kbd>Ctrl</kbd>+<kbd>R</kbd> ) to cancel it.
|
||||
|
||||
## Interaction with the markers
|
||||
|
||||
* Hovering over a marker will display a <a class="reference-link" href="../../UI%20Elements/Note%20Tooltip.md">Note Tooltip</a> with the content of the note it belongs to.
|
||||
* Clicking on the note title in the tooltip will navigate to the note in the current view.
|
||||
* Middle-clicking the marker will open the note in a new tab.
|
||||
* Right-clicking the marker will open a contextual menu (as described below).
|
||||
* If the map is in read-only mode, clicking on a marker will open a <a class="reference-link" href="../../UI%20Elements/Quick%20edit.md">Quick edit</a> popup for the corresponding note.
|
||||
|
||||
## Contextual menu
|
||||
|
||||
It's possible to press the right mouse button to display a contextual menu.
|
||||
|
||||
1. If right-clicking an empty section of the map (not on a marker), it allows to:
|
||||
1. Displays the latitude and longitude. Clicking this option will copy them to the clipboard.
|
||||
2. Open the location using an external application (if the operating system supports it).
|
||||
3. Adding a new marker at that location.
|
||||
2. If right-clicking on a marker, it allows to:
|
||||
1. Displays the latitude and longitude. Clicking this option will copy them to the clipboard.
|
||||
2. Open the location using an external application (if the operating system supports it).
|
||||
3. Open the note in a new tab, split or window.
|
||||
4. Remove the marker from the map, which will remove the `#geolocation` attribute of the note. To add it back again, the coordinates have to be manually added back in.
|
||||
|
||||
## Icon and color of the markers
|
||||
|
||||
<figure class="image image-style-align-center"><img style="aspect-ratio:523/295;" src="Geo Map View_image.jpg" alt="image" width="523" height="295"></figure>
|
||||
|
||||
The markers will have the same icon as the note.
|
||||
|
||||
It's possible to add a custom color to a marker by assigning them a `#color` attribute such as `#color=green`.
|
||||
|
||||
## Adding the coordinates manually
|
||||
|
||||
In a nutshell, create a child note and set the `#geolocation` attribute to the coordinates.
|
||||
|
||||
The value of the attribute is made up of the latitude and longitude separated by a comma.
|
||||
|
||||
### Adding from Google Maps
|
||||
|
||||
<figure class="table" style="width:100%;"><table class="ck-table-resized"><colgroup><col style="width:2.77%;"><col style="width:33.24%;"><col style="width:63.99%;"></colgroup><thead><tr><th> </th><th> </th><th> </th></tr></thead><tbody><tr><td>1</td><td><figure class="image image-style-align-center image_resized" style="width:56.84%;"><img style="aspect-ratio:732/918;" src="12_Geo Map View_image.png" width="732" height="918"></figure></td><td>Go to Google Maps on the web and look for a desired location, right click on it and a context menu will show up. <br><br>Simply click on the first item displaying the coordinates and they will be copied to clipboard. <br><br>Then paste the value inside the text box into the <code>#geolocation</code> attribute of a child note of the map (don't forget to surround the value with a <code>"</code> character).</td></tr><tr><td>2</td><td><figure class="image image-style-align-center image_resized" style="width:100%;"><img style="aspect-ratio:518/84;" src="4_Geo Map View_image.png" width="518" height="84"></figure></td><td>In Trilium, create a child note under the map.</td></tr><tr><td>3</td><td><figure class="image image-style-align-center image_resized" style="width:100%;"><img style="aspect-ratio:1074/276;" src="11_Geo Map View_image.png" width="1074" height="276"></figure></td><td>And then go to Owned Attributes and type <code>#geolocation="</code>, then paste from the clipboard as-is and then add the ending <code>"</code> character. Press Enter to confirm and the map should now be updated to contain the new note.</td></tr></tbody></table></figure>
|
||||
|
||||
### Adding from OpenStreetMap
|
||||
|
||||
Similarly to the Google Maps approach:
|
||||
|
||||
<figure class="table" style="width:100%;"><table class="ck-table-resized"><colgroup><col style="width:2.77%;"><col style="width:33.42%;"><col style="width:63.81%;"></colgroup><thead><tr><th> </th><th> </th><th> </th></tr></thead><tbody><tr><td>1</td><td><img class="image_resized" style="aspect-ratio:562/454;width:100%;" src="1_Geo Map View_image.png" width="562" height="454"></td><td>Go to any location on openstreetmap.org and right click to bring up the context menu. Select the “Show address” item.</td></tr><tr><td>2</td><td><img class="image_resized" style="aspect-ratio:696/480;width:100%;" src="Geo Map View_image.png" width="696" height="480"></td><td>The address will be visible in the top-left of the screen, in the place of the search bar. <br><br>Select the coordinates and copy them into the clipboard.</td></tr><tr><td>3</td><td><img class="image_resized" style="aspect-ratio:640/276;width:100%;" src="5_Geo Map View_image.png" width="640" height="276"></td><td>Simply paste the value inside the text box into the <code>#geolocation</code> attribute of a child note of the map and then it should be displayed on the map.</td></tr></tbody></table></figure>
|
||||
|
||||
## Adding GPS tracks (.gpx)
|
||||
|
||||
Trilium has basic support for displaying GPS tracks on the geo map.
|
||||
|
||||
<figure class="table" style="width:100%;"><table class="ck-table-resized"><colgroup><col style="width:2.77%;"><col style="width:30.22%;"><col style="width:67.01%;"></colgroup><thead><tr><th> </th><th> </th><th> </th></tr></thead><tbody><tr><td>1</td><td><figure class="image image-style-align-center"><img style="aspect-ratio:226/74;" src="3_Geo Map View_image.png" width="226" height="74"></figure></td><td>To add a track, simply drag & drop a .gpx file inside the geo map in the note tree.</td></tr><tr><td>2</td><td><figure class="image image-style-align-center"><img style="aspect-ratio:322/222;" src="14_Geo Map View_image.png" width="322" height="222"></figure></td><td>In order for the file to be recognized as a GPS track, it needs to show up as <code>application/gpx+xml</code> in the <em>File type</em> field.</td></tr><tr><td>3</td><td><figure class="image image-style-align-center"><img style="aspect-ratio:620/530;" src="6_Geo Map View_image.png" width="620" height="530"></figure></td><td>When going back to the map, the track should now be visible. <br><br>The start and end points of the track are indicated by the two blue markers.</td></tr></tbody></table></figure>
|
||||
|
||||
> [!NOTE]
|
||||
> The starting point of the track will be displayed as a marker, with the name of the note underneath. The start marker will also respect the icon and the `color` of the note. The end marker is displayed with a distinct icon.
|
||||
>
|
||||
> If the GPX contains waypoints, they will also be displayed. If they have a name, it is displayed when hovering over it with the mouse.
|
||||
|
||||
## Read-only mode
|
||||
|
||||
When a map is in read-only all editing features will be disabled such as:
|
||||
|
||||
* The add button in the <a class="reference-link" href="../../UI%20Elements/Floating%20buttons.md">Floating buttons</a>.
|
||||
* Dragging markers.
|
||||
* Editing from the contextual menu (removing locations or adding new items).
|
||||
|
||||
To enable read-only mode simply press the _Lock_ icon from the <a class="reference-link" href="../../UI%20Elements/Floating%20buttons.md">Floating buttons</a>. To disable it, press the button again.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
<figure class="image image-style-align-right image_resized" style="width:34.06%;"><img style="aspect-ratio:678/499;" src="13_Geo Map View_image.png" width="678" height="499"></figure>
|
||||
|
||||
### Grid-like artifacts on the map
|
||||
|
||||
This occurs if the application is not at 100% zoom which causes the pixels of the map to not render correctly due to fractional scaling. The only possible solution is to set the UI zoom at 100% (default keyboard shortcut is <kbd>Ctrl</kbd>+<kbd>0</kbd>).
|
||||
@@ -40,4 +40,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:
|
||||
|
||||
* <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.
|
||||
* <a class="reference-link" href="Note%20List/Geo%20Map%20View.md">Geo Map View</a> will disallow all interaction that would otherwise change the map (dragging notes, adding new items).
|
||||
* <a class="reference-link" href="../../Note%20Types/Collections/Geo%20Map%20View.md">Geo Map View</a> will disallow all interaction that would otherwise change the map (dragging notes, adding new items).
|
||||
@@ -5,7 +5,26 @@ These are user-created themes which were made publicly available:
|
||||
|
||||
These themes may or may not be compatible with the latest versions of TriliumNext and are based on the original/legacy theme.
|
||||
|
||||
<figure class="table"><table><thead><tr><th>Theme</th><th>Author</th></tr></thead><tbody><tr><td><a href="https://github.com/tobealive/trilium-midnight-theme">Midnight</a></td><td><a href="https://github.com/tobealive">tobealive</a></td></tr><tr><td><a href="https://github.com/tobealive/trilum-eote-theme">EOTE</a></td><td><a href="https://github.com/tobealive">tobealive</a></td></tr><tr><td><a href="https://github.com/Abourass/TriliumThemes">Trilium Themes</a></td><td><a href="https://github.com/Abourass">Abourass</a></td></tr><tr><td><a href="https://github.com/ZMonk91/Material-Dark-Trilium">MaterialDark</a></td><td><a href="https://github.com/ZMonk91">ZMonk91</a></td></tr><tr><td><a href="https://github.com/jaroet/trilium-theme-lightslategray">lightslategray</a></td><td><a href="https://github.com/jaroet">jaroet</a></td></tr><tr><td><a href="https://github.com/raphwriter/trilium-theme-melon">melon-4</a></td><td><a href="https://github.com/raphwriter">raphwriter</a></td></tr><tr><td><a href="https://github.com/Engr-AllanG/trilium-themes">Neon_Dark</a></td><td><a href="https://github.com/Engr-AllanG">Engr-AllanG</a></td></tr><tr><td><a href="https://github.com/Engr-AllanG/trilium-themes">Coder_Dark</a></td><td><a href="https://github.com/Engr-AllanG">Engr-AllanG</a></td></tr><tr><td><a href="https://github.com/idelem/trilium-theme-velvet">velvet</a></td><td><a href="https://github.com/idelem">idelem</a></td></tr><tr><td><a href="https://github.com/SADAVA/trilium-notes-theme-dark-plus">Dark Plus</a></td><td><a href="https://github.com/SADAVA">SADAVA</a></td></tr><tr><td><a href="https://github.com/WKSu/trilium-solarized-theme">Solarized</a></td><td><a href="https://github.com/WKSu">WKSu</a></td></tr><tr><td><a href="https://github.com/en3r0/Trilium-Nord-Theme">Nord</a></td><td><a href="https://github.com/en3r0">en3r0</a></td></tr><tr><td><a href="https://github.com/AllanZyne/trilium-bear-theme">Bear Note Light</a></td><td><a href="https://github.com/AllanZyne">AllanZyne</a></td></tr><tr><td><a href="https://github.com/AllanZyne/trilium-bear-theme">Bear Note Dark</a></td><td><a href="https://github.com/AllanZyne">AllanZyne</a></td></tr><tr><td><a href="https://github.com/Sebiann/miku-hatsune-trilium-theme">Miku Hatsune</a></td><td><a href="https://github.com/Sebiann">Sebiann</a></td></tr><tr><td><a href="https://github.com/cwilliams5/Midnight-Trilium-Dark-Mode">Midnight</a></td><td><a href="https://github.com/cwilliams5">cwilliams5</a></td></tr><tr><td><a href="https://github.com/SiriusXT/trilium-theme-blue">Blue</a> (light)</td><td><a href="https://github.com/SiriusXT">SiriusXT</a></td></tr><tr><td><a href="https://github.com/SiriusXT/trilium-theme-blue">Blue</a> (dark)</td><td><a href="https://github.com/SiriusXT">SiriusXT</a></td></tr></tbody></table></figure>
|
||||
| Theme | Author |
|
||||
| --- | --- |
|
||||
| [Midnight](https://github.com/tobealive/trilium-midnight-theme) | [tobealive](https://github.com/tobealive) |
|
||||
| [EOTE](https://github.com/tobealive/trilum-eote-theme) | [tobealive](https://github.com/tobealive) |
|
||||
| [Trilium Themes](https://github.com/Abourass/TriliumThemes) | [Abourass](https://github.com/Abourass) |
|
||||
| [MaterialDark](https://github.com/ZMonk91/Material-Dark-Trilium) | [ZMonk91](https://github.com/ZMonk91) |
|
||||
| [lightslategray](https://github.com/jaroet/trilium-theme-lightslategray) | [jaroet](https://github.com/jaroet) |
|
||||
| [melon-4](https://github.com/raphwriter/trilium-theme-melon) | [raphwriter](https://github.com/raphwriter) |
|
||||
| [Neon\_Dark](https://github.com/Engr-AllanG/trilium-themes) | [Engr-AllanG](https://github.com/Engr-AllanG) |
|
||||
| [Coder\_Dark](https://github.com/Engr-AllanG/trilium-themes) | [Engr-AllanG](https://github.com/Engr-AllanG) |
|
||||
| [velvet](https://github.com/idelem/trilium-theme-velvet) | [idelem](https://github.com/idelem) |
|
||||
| [Dark Plus](https://github.com/SADAVA/trilium-notes-theme-dark-plus) | [SADAVA](https://github.com/SADAVA) |
|
||||
| [Solarized](https://github.com/WKSu/trilium-solarized-theme) | [WKSu](https://github.com/WKSu) |
|
||||
| [Nord](https://github.com/en3r0/Trilium-Nord-Theme) | [en3r0](https://github.com/en3r0) |
|
||||
| [Bear Note Light](https://github.com/AllanZyne/trilium-bear-theme) | [AllanZyne](https://github.com/AllanZyne) |
|
||||
| [Bear Note Dark](https://github.com/AllanZyne/trilium-bear-theme) | [AllanZyne](https://github.com/AllanZyne) |
|
||||
| [Miku Hatsune](https://github.com/Sebiann/miku-hatsune-trilium-theme) | [Sebiann](https://github.com/Sebiann) |
|
||||
| [Midnight](https://github.com/cwilliams5/Midnight-Trilium-Dark-Mode) | [cwilliams5](https://github.com/cwilliams5) |
|
||||
| [Blue](https://github.com/SiriusXT/trilium-theme-blue) (light) | [SiriusXT](https://github.com/SiriusXT) |
|
||||
| [Blue](https://github.com/SiriusXT/trilium-theme-blue) (dark) | [SiriusXT](https://github.com/SiriusXT) |
|
||||
|
||||
> [!TIP]
|
||||
> If you would like to add your theme to this gallery, write a new post in [👐 Show and tell](https://github.com/TriliumNext/Notes/discussions/categories/show-and-tell).
|
||||
@@ -16,6 +16,6 @@ The tooltip can be found in multiple places, including:
|
||||
|
||||
* In <a class="reference-link" href="../../Note%20Types/Text.md">Text</a> notes, when hovering over <a class="reference-link" href="../../Note%20Types/Text/Links/Internal%20(reference)%20links.md">Internal (reference) links</a> .
|
||||
* <a class="reference-link" href="../../Note%20Types/Collections.md">Collections</a>:
|
||||
* <a class="reference-link" href="../Notes/Note%20List/Geo%20Map%20View.md">Geo Map View</a>, when hovering over a marker.
|
||||
* <a class="reference-link" href="../Notes/Note%20List/Calendar%20View.md">Calendar View</a>, when hovering over an event.
|
||||
* <a class="reference-link" href="../Notes/Note%20List/Table%20View.md">Table View</a>, when hovering over a note title, or over a [relation](../../Advanced%20Usage/Attributes/Relations.md).
|
||||
* <a class="reference-link" href="../../Note%20Types/Collections/Geo%20Map%20View.md">Geo Map View</a>, when hovering over a marker.
|
||||
* <a class="reference-link" href="../../Note%20Types/Collections/Calendar%20View.md">Calendar View</a>, when hovering over an event.
|
||||
* <a class="reference-link" href="../../Note%20Types/Collections/Table%20View.md">Table View</a>, when hovering over a note title, or over a [relation](../../Advanced%20Usage/Attributes/Relations.md).
|
||||
@@ -26,8 +26,8 @@ This feature is also well integrated with <a class="reference-link" href="../..
|
||||
* or, press <kbd>Ctrl</kbd>+<kbd>Right click</kbd> on the link.
|
||||
* On a <a class="reference-link" href="Note%20Tooltip.md">Note Tooltip</a>, press the quick edit icon.
|
||||
* In <a class="reference-link" href="../../Note%20Types/Collections.md">Collections</a>:
|
||||
* For <a class="reference-link" href="../Notes/Note%20List/Calendar%20View.md">Calendar View</a>:
|
||||
* For <a class="reference-link" href="../../Note%20Types/Collections/Calendar%20View.md">Calendar View</a>:
|
||||
* Clicking on an event will open that event for quick editing.
|
||||
* If the calendar is for the <a class="reference-link" href="../../Advanced%20Usage/Advanced%20Showcases/Day%20Notes.md">Day Notes</a> root, clicking on the day number will open the popup for that day note.
|
||||
* For <a class="reference-link" href="../Notes/Note%20List/Geo%20Map%20View.md">Geo Map View</a>:
|
||||
* For <a class="reference-link" href="../../Note%20Types/Collections/Geo%20Map%20View.md">Geo Map View</a>:
|
||||
* Clicking on a marker will open that marker, but only if the map is in read-only mode.
|
||||
@@ -3,7 +3,7 @@ This section presents the most important changes by version. For a full set of c
|
||||
|
||||
* v0.97.0:
|
||||
* Books are now <a class="reference-link" href="Note%20Types/Collections.md">Collections</a>.
|
||||
* <a class="reference-link" href="Basic%20Concepts%20and%20Features/Notes/Note%20List/Table%20View.md">Table View</a> is a new collection type displaying notes and attributes in an editable grid.
|
||||
* <a class="reference-link" href="Note%20Types/Collections/Table%20View.md">Table View</a> is a new collection type displaying notes and attributes in an editable grid.
|
||||
* <a class="reference-link" href="Basic%20Concepts%20and%20Features/UI%20Elements/Quick%20edit.md">Quick edit</a> is introduced, adding a new way to edit notes in a popup instead of opening a new tab. It also integrates well with <a class="reference-link" href="Note%20Types/Collections.md">Collections</a>.
|
||||
* v0.96.0:
|
||||
* <a class="reference-link" href="Note%20Types/Text.md">Text</a> gain premium features thanks to a collaboration with the CKEditor team:
|
||||
@@ -21,12 +21,12 @@ This section presents the most important changes by version. For a full set of c
|
||||
* <a class="reference-link" href="Note%20Types/Text.md">Text</a> notes can now have adjustable <a class="reference-link" href="Note%20Types/Text/Content%20language%20%26%20Right-to-le.md">Content language & Right-to-left support</a>.
|
||||
* <a class="reference-link" href="Basic%20Concepts%20and%20Features/Notes/Export%20as%20PDF.md">Export as PDF</a>
|
||||
* <a class="reference-link" href="Basic%20Concepts%20and%20Features/Zen%20mode.md">Zen mode</a>
|
||||
* <a class="reference-link" href="Basic%20Concepts%20and%20Features/Notes/Note%20List/Calendar%20View.md">Calendar View</a>, allowing notes to be displayed in a monthly grid based on start and end dates.
|
||||
* <a class="reference-link" href="Note%20Types/Collections/Calendar%20View.md">Calendar View</a>, allowing notes to be displayed in a monthly grid based on start and end dates.
|
||||
* v0.91.5:
|
||||
* Significant improvements for mobile.
|
||||
* <a class="reference-link" href="Note%20Types/Text/Footnotes.md">Footnotes</a> are now supported in <a class="reference-link" href="Note%20Types/Text.md">Text</a> notes.
|
||||
* Mermaid diagrams can now be inserted inline within <a class="reference-link" href="Note%20Types/Text.md">Text</a> notes.
|
||||
* The TriliumNext theme is introduced, bringing a more modern design to the application.
|
||||
* <a class="reference-link" href="Basic%20Concepts%20and%20Features/Notes/Note%20List/Geo%20Map%20View.md">Geo Map View</a>, displaying notes as markers on a geographical map for easy trip planning.
|
||||
* <a class="reference-link" href="Note%20Types/Collections/Geo%20Map%20View.md">Geo Map View</a>, displaying notes as markers on a geographical map for easy trip planning.
|
||||
* v0.90.8:
|
||||
* A new note type was introduced: <a class="reference-link" href="Note%20Types/Mind%20Map.md">Mind Map</a>
|
||||
16
docs/User Guide/User Guide/Note Types.md
vendored
16
docs/User Guide/User Guide/Note Types.md
vendored
@@ -25,4 +25,18 @@ It is possible to change the type of a note after it has been created via the _B
|
||||
|
||||
The following note types are supported by Trilium:
|
||||
|
||||
<figure class="table" style="width:100%;"><table class="ck-table-resized"><colgroup><col style="width:29.42%;"><col style="width:70.58%;"></colgroup><thead><tr><th>Note Type</th><th>Description</th></tr></thead><tbody><tr><td><a class="reference-link" href="Note%20Types/Text.md">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.md">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.md">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.md">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.md">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.md">Render Note</a></td><td>Used in <a class="reference-link" href="Scripting.md">Scripting</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/Collections.md">Collections</a></td><td><p>Displays the children of the note either as a grid, a list, or for a more specialized case: a calendar.</p><p>Generally useful for easy reading of short notes.</p></td></tr><tr><td><a class="reference-link" href="Note%20Types/Mermaid%20Diagrams.md">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.md">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.md">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.md">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="Basic%20Concepts%20and%20Features/Notes/Note%20List/Geo%20Map%20View.md">Geo Map View</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><tr><td><a class="reference-link" href="Note%20Types/File.md">File</a></td><td>Represents an uploaded file such as PDFs, images, video or audio files.</td></tr></tbody></table></figure>
|
||||
| Note Type | Description |
|
||||
| --- | --- |
|
||||
| <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="Scripting.md">Scripting</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/Collections.md">Collections</a> | Displays the children of the note either as a grid, a list, or for a more specialized case: a calendar.<br><br>Generally useful for easy reading of short notes. |
|
||||
| <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/Collections/Geo%20Map%20View.md">Geo Map View</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. |
|
||||
| <a class="reference-link" href="Note%20Types/File.md">File</a> | Represents an uploaded file such as PDFs, images, video or audio files. |
|
||||
@@ -3,14 +3,14 @@ Collections are a unique type of notes that don't have a content, but instead di
|
||||
|
||||
Classic collections are read-only mode and compiles the contents of all child notes into one continuous view. This makes it ideal for reading extensive information broken into smaller, manageable segments.
|
||||
|
||||
* <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Notes/Note%20List/Grid%20View.md">Grid View</a> which is the default presentation method for child notes (see <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Notes/Note%20List.md">Note List</a>), where the notes are displayed as tiles with their title and content being visible.
|
||||
* <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Notes/Note%20List/List%20View.md">List View</a> is similar to <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Notes/Note%20List/Grid%20View.md">Grid View</a>, but it displays the notes one under the other with the content being expandable/collapsible, but also works recursively.
|
||||
* <a class="reference-link" href="Collections/Grid%20View.md">Grid View</a> which is the default presentation method for child notes (see <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Notes/Note%20List.md">Note List</a>), where the notes are displayed as tiles with their title and content being visible.
|
||||
* <a class="reference-link" href="Collections/List%20View.md">List View</a> is similar to <a class="reference-link" href="Collections/Grid%20View.md">Grid View</a>, but it displays the notes one under the other with the content being expandable/collapsible, but also works recursively.
|
||||
|
||||
More specialized collections were introduced, such as the:
|
||||
|
||||
* <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Notes/Note%20List/Calendar%20View.md">Calendar View</a> which displays a week, month or year calendar with the notes being shown as events. New events can be added easily by dragging across the calendar.
|
||||
* <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Notes/Note%20List/Geo%20Map%20View.md">Geo Map View</a> which displays a geographical map in which the notes are represented as markers/pins on the map. New events can be easily added by pointing on the map.
|
||||
* <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Notes/Note%20List/Table%20View.md">Table View</a> displays each note as a row in a table, with <a class="reference-link" href="../Advanced%20Usage/Attributes/Promoted%20Attributes.md">Promoted Attributes</a> being shown as well. This makes it easy to visualize attributes of notes, as well as making them easily editable.
|
||||
* <a class="reference-link" href="Collections/Calendar%20View.md">Calendar View</a> which displays a week, month or year calendar with the notes being shown as events. New events can be added easily by dragging across the calendar.
|
||||
* <a class="reference-link" href="Collections/Geo%20Map%20View.md">Geo Map View</a> which displays a geographical map in which the notes are represented as markers/pins on the map. New events can be easily added by pointing on the map.
|
||||
* <a class="reference-link" href="Collections/Table%20View.md">Table View</a> displays each note as a row in a table, with <a class="reference-link" href="../Advanced%20Usage/Attributes/Promoted%20Attributes.md">Promoted Attributes</a> being shown as well. This makes it easy to visualize attributes of notes, as well as making them easily editable.
|
||||
|
||||
For a quick presentation of all the supported view types, see the child notes of this help page, including screenshots.
|
||||
|
||||
|
||||
|
Before Width: | Height: | Size: 3.5 KiB After Width: | Height: | Size: 3.5 KiB |
|
Before Width: | Height: | Size: 605 B After Width: | Height: | Size: 605 B |
|
Before Width: | Height: | Size: 2.8 KiB After Width: | Height: | Size: 2.8 KiB |
|
Before Width: | Height: | Size: 22 KiB After Width: | Height: | Size: 22 KiB |
|
Before Width: | Height: | Size: 68 KiB After Width: | Height: | Size: 68 KiB |
|
Before Width: | Height: | Size: 31 KiB After Width: | Height: | Size: 31 KiB |
|
Before Width: | Height: | Size: 5.4 KiB After Width: | Height: | Size: 5.4 KiB |
|
Before Width: | Height: | Size: 44 KiB After Width: | Height: | Size: 44 KiB |
|
Before Width: | Height: | Size: 249 KiB After Width: | Height: | Size: 249 KiB |
|
Before Width: | Height: | Size: 179 B After Width: | Height: | Size: 179 B |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 909 B After Width: | Height: | Size: 909 B |
|
Before Width: | Height: | Size: 141 KiB After Width: | Height: | Size: 141 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 210 KiB After Width: | Height: | Size: 210 KiB |
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
|
Before Width: | Height: | Size: 1.8 KiB After Width: | Height: | Size: 1.8 KiB |
|
Before Width: | Height: | Size: 7.6 KiB After Width: | Height: | Size: 7.6 KiB |
|
Before Width: | Height: | Size: 3.5 KiB After Width: | Height: | Size: 3.5 KiB |
|
Before Width: | Height: | Size: 1014 B After Width: | Height: | Size: 1014 B |
|
Before Width: | Height: | Size: 9.6 KiB After Width: | Height: | Size: 9.6 KiB |
|
Before Width: | Height: | Size: 966 B After Width: | Height: | Size: 966 B |
|
Before Width: | Height: | Size: 62 KiB After Width: | Height: | Size: 62 KiB |
|
Before Width: | Height: | Size: 4.3 KiB After Width: | Height: | Size: 4.3 KiB |
|
Before Width: | Height: | Size: 8.5 KiB After Width: | Height: | Size: 8.5 KiB |
|
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |
|
Before Width: | Height: | Size: 338 KiB After Width: | Height: | Size: 338 KiB |
|
Before Width: | Height: | Size: 3.0 KiB After Width: | Height: | Size: 3.0 KiB |
|
Before Width: | Height: | Size: 108 KiB After Width: | Height: | Size: 108 KiB |
@@ -1,2 +0,0 @@
|
||||
# Calendar View
|
||||
This is a clone of a note. Go to its [primary location](../../Basic%20Concepts%20and%20Features/Notes/Note%20List/Calendar%20View.md).
|
||||
128
docs/User Guide/User Guide/Note Types/Collections/Calendar View.md
vendored
Normal file
128
docs/User Guide/User Guide/Note Types/Collections/Calendar View.md
vendored
Normal file
@@ -0,0 +1,128 @@
|
||||
# Calendar View
|
||||
<figure class="image image-style-align-center"><img style="aspect-ratio:767/606;" src="4_Calendar View_image.png" width="767" height="606"></figure>
|
||||
|
||||
The Calendar view will display each child note in a calendar that has a start date and optionally an end date, as an event.
|
||||
|
||||
The Calendar view has multiple display modes:
|
||||
|
||||
* Week view, where all the 7 days of the week (or 5 if the weekends are hidden) are displayed in columns. This mode allows entering and displaying time-specific events, not just all-day events.
|
||||
* Month view, where the entire month is displayed and all-day events can be inserted. Both time-specific events and all-day events are listed.
|
||||
* Year view, which displays the entire year for quick reference.
|
||||
* List view, which displays all the events of a given month in sequence.
|
||||
|
||||
Unlike other Collection view types, the Calendar view also allows some kind of interaction, such as moving events around as well as creating new ones.
|
||||
|
||||
## Creating a calendar
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| 1 |  | The Calendar View works only for Collection note types. To create a new note, right click on the note tree on the left and select Insert note after, or Insert child note and then select _Collection_. |
|
||||
| 2 |  | Once created, the “View type” of the Collection needs changed to “Calendar”, by selecting the “Collection Properties” tab in the ribbon. |
|
||||
|
||||
## Creating a new event/note
|
||||
|
||||
* Clicking on a day will create a new child note and assign it to that particular day.
|
||||
* You will be asked for the name of the new note. If the popup is dismissed by pressing the close button or escape, then the note will not be created.
|
||||
* It's possible to drag across multiple days to set both the start and end date of a particular note.
|
||||
|
||||
* Creating new notes from the calendar will respect the `~child:template` relation if set on the Collection note.
|
||||
|
||||
## Interacting with events
|
||||
|
||||
* Hovering the mouse over an event will display information about the note.
|
||||
|
||||
* Left clicking the event will open a <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Quick%20edit.md">Quick edit</a> to edit the note in a popup while allowing easy return to the calendar by just dismissing the popup.
|
||||
* Middle clicking will open the note in a new tab.
|
||||
* Right click will offer more options including opening the note in a new split or window.
|
||||
* Drag and drop an event on the calendar to move it to another day.
|
||||
* The length of an event can be changed by placing the mouse to the right edge of the event and dragging the mouse around.
|
||||
|
||||
## Configuring the calendar view
|
||||
|
||||
In the _Collections_ tab in the <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">Ribbon</a>, it's possible to adjust the following:
|
||||
|
||||
* Hide weekends from the week view.
|
||||
* Display week numbers on the calendar.
|
||||
|
||||
## Configuring the calendar using attributes
|
||||
|
||||
The following attributes can be added to the Collection type:
|
||||
|
||||
<table><thead><tr><th>Name</th><th>Description</th></tr></thead><tbody><tr><td><code>#calendar:hideWeekends</code></td><td>When present (regardless of value), it will hide Saturday and Sundays from the calendar.</td></tr><tr><td><code>#calendar:weekNumbers</code></td><td>When present (regardless of value), it will show the number of the week on the calendar.</td></tr><tr><td><code>#calendar:view</code></td><td><p>Which view to display in the calendar:</p><ul><li><code>timeGridWeek</code> for the <em>week</em> view;</li><li><code>dayGridMonth</code> for the <em>month</em> view;</li><li><code>multiMonthYear</code> for the <em>year</em> view;</li><li><code>listMonth</code> for the <em>list</em> view.</li></ul><p>Any other value will be dismissed and the default view (month) will be used instead.</p><p>The value of this label is automatically updated when changing the view using the UI buttons.</p></td></tr><tr><td><code>~child:template</code></td><td>Defines the template for newly created notes in the calendar (via dragging or clicking).</td></tr></tbody></table>
|
||||
|
||||
In addition, the first day of the week can be either Sunday or Monday and can be adjusted from the application settings.
|
||||
|
||||
## Configuring the calendar events using attributes
|
||||
|
||||
For each note of the calendar, the following attributes can be used:
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| `#startDate` | The date the event starts, which will display it in the calendar. The format is `YYYY-MM-DD` (year, month and day separated by a minus sign). |
|
||||
| `#endDate` | Similar to `startDate`, mentions the end date if the event spans across multiple days. The date is inclusive, so the end day is also considered. The attribute can be missing for single-day events. |
|
||||
| `#startTime` | The time the event starts at. If this value is missing, then the event is considered a full-day event. The format is `HH:MM` (hours in 24-hour format and minutes). |
|
||||
| `#endTime` | Similar to `startTime`, it mentions the time at which the event ends (in relation with `endDate` if present, or `startDate`). |
|
||||
| `#color` | Displays the event with a specified color (named such as `red`, `gray` or hex such as `#FF0000`). This will also change the color of the note in other places such as the note tree. |
|
||||
| `#calendar:color` | Similar to `#color`, but applies the color only for the event in the calendar and not for other places such as the note tree. |
|
||||
| `#iconClass` | If present, the icon of the note will be displayed to the left of the event title. |
|
||||
| `#calendar:title` | Changes the title of an event to point to an attribute of the note other than the title, can either a label or a relation (without the `#` or `~` symbol). See _Use-cases_ for more information. |
|
||||
| `#calendar:displayedAttributes` | Allows displaying the value of one or more attributes in the calendar like this: <br> <br> <br> <br>`#weight="70" #Mood="Good" #calendar:displayedAttributes="weight,Mood"` <br> <br>It can also be used with relations, case in which it will display the title of the target note: <br> <br>`~assignee=@My assignee #calendar:displayedAttributes="assignee"` |
|
||||
| `#calendar:startDate` | Allows using a different label to represent the start date, other than `startDate` (e.g. `expiryDate`). The label name **must not be** prefixed with `#`. If the label is not defined for a note, the default will be used instead. |
|
||||
| `#calendar:endDate` | Similar to `#calendar:startDate`, allows changing the attribute which is being used to read the end date. |
|
||||
| `#calendar:startTime` | Similar to `#calendar:startDate`, allows changing the attribute which is being used to read the start time. |
|
||||
| `#calendar:endTime` | Similar to `#calendar:startDate`, allows changing the attribute which is being used to read the end time. |
|
||||
|
||||
## How the calendar works
|
||||
|
||||
|
||||
|
||||
The calendar displays all the child notes of the Collection that have a `#startDate`. An `#endDate` can optionally be added.
|
||||
|
||||
If editing the start date and end date from the note itself is desirable, the following attributes can be added to the Collection note:
|
||||
|
||||
```
|
||||
#viewType=calendar #label:startDate(inheritable)="promoted,alias=Start Date,single,date"
|
||||
#label:endDate(inheritable)="promoted,alias=End Date,single,date"
|
||||
#hidePromotedAttributes
|
||||
```
|
||||
|
||||
This will result in:
|
||||
|
||||
|
||||
|
||||
When not used in a Journal, the calendar is recursive. That is, it will look for events not just in its child notes but also in the children of these child notes.
|
||||
|
||||
## Use-cases
|
||||
|
||||
### Using with the Journal / calendar
|
||||
|
||||
It is possible to integrate the calendar view into the Journal with day notes. In order to do so change the note type of the Journal note (calendar root) to Collection and then select the Calendar View.
|
||||
|
||||
Based on the `#calendarRoot` (or `#workspaceCalendarRoot`) attribute, the calendar will know that it's in a calendar and apply the following:
|
||||
|
||||
* The calendar events are now rendered based on their `dateNote` attribute rather than `startDate`.
|
||||
* Interactive editing such as dragging over an empty era or resizing an event is no longer possible.
|
||||
* Clicking on the empty space on a date will automatically open that day's note or create it if it does not exist.
|
||||
* Direct children of a day note will be displayed on the calendar despite not having a `dateNote` attribute. Children of the child notes will not be displayed.
|
||||
|
||||
<img src="8_Calendar View_image.png" width="1217" height="724">
|
||||
|
||||
### Using a different attribute as event title
|
||||
|
||||
By default, events are displayed on the calendar by their note title. However, it is possible to configure a different attribute to be displayed instead.
|
||||
|
||||
To do so, assign `#calendar:title` to the child note (not the calendar/Collection note), with the value being `name` where `name` can be any label (make not to add the `#` prefix). The attribute can also come through inheritance such as a template attribute. If the note does not have the requested label, the title of the note will be used instead.
|
||||
|
||||
<table><thead><tr><th> </th><th> </th></tr></thead><tbody><tr><td><pre><code class="language-text-x-trilium-auto">#startDate=2025-02-11 #endDate=2025-02-13 #name="My vacation" #calendar:title="name"</code></pre></td><td><p> </p><figure class="image image-style-align-center"><img style="aspect-ratio:445/124;" src="5_Calendar View_image.png" width="445" height="124"></figure></td></tr></tbody></table>
|
||||
|
||||
### Using a relation attribute as event title
|
||||
|
||||
Similarly to using an attribute, use `#calendar:title` and set it to `name` where `name` is the name of the relation to use.
|
||||
|
||||
Moreover, if there are more relations of the same name, they will be displayed as multiple events coming from the same note.
|
||||
|
||||
<table><thead><tr><th> </th><th> </th></tr></thead><tbody><tr><td><pre><code class="language-text-x-trilium-auto">#startDate=2025-02-14 #endDate=2025-02-15 ~for=@John Smith ~for=@Jane Doe #calendar:title="for"</code></pre></td><td><img src="6_Calendar View_image.png" width="294" height="151"></td></tr></tbody></table>
|
||||
|
||||
Note that it's even possible to have a `#calendar:title` on the target note (e.g. “John Smith”) which will try to render an attribute of it. Note that it's not possible to use a relation here as well for safety reasons (an accidental recursion of attributes could cause the application to loop infinitely).
|
||||
|
||||
<table><thead><tr><th> </th><th> </th></tr></thead><tbody><tr><td><pre><code class="language-text-x-trilium-auto">#calendar:title="shortName" #shortName="John S."</code></pre></td><td><figure class="image image-style-align-center"><img style="aspect-ratio:296/150;" src="1_Calendar View_image.png" width="296" height="150"></figure></td></tr></tbody></table>
|
||||
|
Before Width: | Height: | Size: 968 B After Width: | Height: | Size: 968 B |
@@ -1,2 +0,0 @@
|
||||
# Geo Map View
|
||||
This is a clone of a note. Go to its [primary location](../../Basic%20Concepts%20and%20Features/Notes/Note%20List/Geo%20Map%20View.md).
|
||||
154
docs/User Guide/User Guide/Note Types/Collections/Geo Map View.md
vendored
Normal file
154
docs/User Guide/User Guide/Note Types/Collections/Geo Map View.md
vendored
Normal file
@@ -0,0 +1,154 @@
|
||||
# Geo Map View
|
||||
> [!IMPORTANT]
|
||||
> Starting with Trilium v0.97.0, the geo map has been converted from a standalone [note type](../../Note%20Types.md) to a type of view for the <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/Notes/Note%20List.md">Note List</a>.
|
||||
|
||||
<figure class="image image-style-align-center"><img style="aspect-ratio:892/675;" src="9_Geo Map View_image.png" width="892" height="675"></figure>
|
||||
|
||||
This note type displays the children notes on a geographical map, based on an attribute. It is also possible to add new notes at a specific location using the built-in interface.
|
||||
|
||||
## Creating a new geo map
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| 1 | <figure class="image"><img style="aspect-ratio:483/413;" src="15_Geo Map View_image.png" width="483" height="413"></figure> | Right click on any note on the note tree and select _Insert child note_ → _Geo Map (beta)_. |
|
||||
| 2 | <figure class="image image-style-align-center image_resized" style="width:53.44%;"><img style="aspect-ratio:1720/1396;" src="8_Geo Map View_image.png" width="1720" height="1396"></figure> | By default the map will be empty and will show the entire world. |
|
||||
|
||||
## Repositioning the map
|
||||
|
||||
* Click and drag the map in order to move across the map.
|
||||
* Use the mouse wheel, two-finger gesture on a touchpad or the +/- buttons on the top-left to adjust the zoom.
|
||||
|
||||
The position on the map and the zoom are saved inside the map note and restored when visiting again the note.
|
||||
|
||||
## Adding a marker using the map
|
||||
|
||||
### Adding a new note using the plus button
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| 1 | To create a marker, first navigate to the desired point on the map. Then press the  button in the [Floating buttons](../../Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons.md) (top-right) area. <br> <br>If the button is not visible, make sure the button section is visible by pressing the chevron button () in the top-right of the map. | |
|
||||
| 2 | <img class="image_resized" style="aspect-ratio:1730/416;width:100%;" src="2_Geo Map View_image.png" width="1730" height="416"> | Once pressed, the map will enter in the insert mode, as illustrated by the notification. <br> <br>Simply click the point on the map where to place the marker, or the Escape key to cancel. |
|
||||
| 3 | <img class="image_resized" style="aspect-ratio:1586/404;width:100%;" src="7_Geo Map View_image.png" width="1586" height="404"> | Enter the name of the marker/note to be created. |
|
||||
| 4 | <img class="image_resized" style="aspect-ratio:1696/608;width:100%;" src="16_Geo Map View_image.png" width="1696" height="608"> | Once confirmed, the marker will show up on the map and it will also be displayed as a child note of the map. |
|
||||
|
||||
### Adding a new note using the contextual menu
|
||||
|
||||
1. Right click anywhere on the map, where to place the newly created marker (and corresponding note).
|
||||
2. Select _Add a marker at this location_.
|
||||
3. Enter the name of the newly created note.
|
||||
4. The map should be updated with the new marker.
|
||||
|
||||
### Adding an existing note on note from the note tree
|
||||
|
||||
1. Select the desired note in the <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree.md">Note Tree</a>.
|
||||
2. Hold the mouse on the note and drag it to the map to the desired location.
|
||||
3. The map should be updated with the new marker.
|
||||
|
||||
This works for:
|
||||
|
||||
* Notes that are not part of the geo map, case in which a [clone](../../Basic%20Concepts%20and%20Features/Notes/Cloning%20Notes.md) will be created.
|
||||
* Notes that are a child of the geo map but not yet positioned on the map.
|
||||
* Notes that are a child of the geo map and also positioned, case in which the marker will be relocated to the new position.
|
||||
|
||||
## How the location of the markers is stored
|
||||
|
||||
The location of a marker is stored in the `#geolocation` attribute of the child notes:
|
||||
|
||||
<img src="18_Geo Map View_image.png" width="1288" height="278">
|
||||
|
||||
This value can be added manually if needed. The value of the attribute is made up of the latitude and longitude separated by a comma.
|
||||
|
||||
## Repositioning markers
|
||||
|
||||
It's possible to reposition existing markers by simply drag and dropping them to the new destination.
|
||||
|
||||
As soon as the mouse is released, the new position is saved.
|
||||
|
||||
If moved by mistake, there is currently no way to undo the change. If the mouse was not yet released, it's possible to force a refresh of the page (<kbd>Ctrl</kbd>+<kbd>R</kbd> ) to cancel it.
|
||||
|
||||
## Interaction with the markers
|
||||
|
||||
* Hovering over a marker will display a <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tooltip.md">Note Tooltip</a> with the content of the note it belongs to.
|
||||
* Clicking on the note title in the tooltip will navigate to the note in the current view.
|
||||
* Middle-clicking the marker will open the note in a new tab.
|
||||
* Right-clicking the marker will open a contextual menu (as described below).
|
||||
* If the map is in read-only mode, clicking on a marker will open a <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Quick%20edit.md">Quick edit</a> popup for the corresponding note.
|
||||
|
||||
## Contextual menu
|
||||
|
||||
It's possible to press the right mouse button to display a contextual menu.
|
||||
|
||||
1. If right-clicking an empty section of the map (not on a marker), it allows to:
|
||||
1. Displays the latitude and longitude. Clicking this option will copy them to the clipboard.
|
||||
2. Open the location using an external application (if the operating system supports it).
|
||||
3. Adding a new marker at that location.
|
||||
2. If right-clicking on a marker, it allows to:
|
||||
1. Displays the latitude and longitude. Clicking this option will copy them to the clipboard.
|
||||
2. Open the location using an external application (if the operating system supports it).
|
||||
3. Open the note in a new tab, split or window.
|
||||
4. Remove the marker from the map, which will remove the `#geolocation` attribute of the note. To add it back again, the coordinates have to be manually added back in.
|
||||
|
||||
## Icon and color of the markers
|
||||
|
||||
<figure class="image image-style-align-center"><img style="aspect-ratio:523/295;" src="Geo Map View_image.jpg" alt="image" width="523" height="295"></figure>
|
||||
|
||||
The markers will have the same icon as the note.
|
||||
|
||||
It's possible to add a custom color to a marker by assigning them a `#color` attribute such as `#color=green`.
|
||||
|
||||
## Adding the coordinates manually
|
||||
|
||||
In a nutshell, create a child note and set the `#geolocation` attribute to the coordinates.
|
||||
|
||||
The value of the attribute is made up of the latitude and longitude separated by a comma.
|
||||
|
||||
### Adding from Google Maps
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| 1 | <figure class="image image-style-align-center image_resized" style="width:56.84%;"><img style="aspect-ratio:732/918;" src="12_Geo Map View_image.png" width="732" height="918"></figure> | Go to Google Maps on the web and look for a desired location, right click on it and a context menu will show up. <br> <br>Simply click on the first item displaying the coordinates and they will be copied to clipboard. <br> <br>Then paste the value inside the text box into the `#geolocation` attribute of a child note of the map (don't forget to surround the value with a `"` character). |
|
||||
| 2 | <figure class="image image-style-align-center image_resized" style="width:100%;"><img style="aspect-ratio:518/84;" src="4_Geo Map View_image.png" width="518" height="84"></figure> | In Trilium, create a child note under the map. |
|
||||
| 3 | <figure class="image image-style-align-center image_resized" style="width:100%;"><img style="aspect-ratio:1074/276;" src="11_Geo Map View_image.png" width="1074" height="276"></figure> | And then go to Owned Attributes and type `#geolocation="`, then paste from the clipboard as-is and then add the ending `"` character. Press Enter to confirm and the map should now be updated to contain the new note. |
|
||||
|
||||
### Adding from OpenStreetMap
|
||||
|
||||
Similarly to the Google Maps approach:
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| 1 | <img class="image_resized" style="aspect-ratio:562/454;width:100%;" src="1_Geo Map View_image.png" width="562" height="454"> | Go to any location on openstreetmap.org and right click to bring up the context menu. Select the “Show address” item. |
|
||||
| 2 | <img class="image_resized" style="aspect-ratio:696/480;width:100%;" src="Geo Map View_image.png" width="696" height="480"> | The address will be visible in the top-left of the screen, in the place of the search bar. <br> <br>Select the coordinates and copy them into the clipboard. |
|
||||
| 3 | <img class="image_resized" style="aspect-ratio:640/276;width:100%;" src="5_Geo Map View_image.png" width="640" height="276"> | Simply paste the value inside the text box into the `#geolocation` attribute of a child note of the map and then it should be displayed on the map. |
|
||||
|
||||
## Adding GPS tracks (.gpx)
|
||||
|
||||
Trilium has basic support for displaying GPS tracks on the geo map.
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| 1 | <figure class="image image-style-align-center"><img style="aspect-ratio:226/74;" src="3_Geo Map View_image.png" width="226" height="74"></figure> | To add a track, simply drag & drop a .gpx file inside the geo map in the note tree. |
|
||||
| 2 | <figure class="image image-style-align-center"><img style="aspect-ratio:322/222;" src="14_Geo Map View_image.png" width="322" height="222"></figure> | In order for the file to be recognized as a GPS track, it needs to show up as `application/gpx+xml` in the _File type_ field. |
|
||||
| 3 | <figure class="image image-style-align-center"><img style="aspect-ratio:620/530;" src="6_Geo Map View_image.png" width="620" height="530"></figure> | When going back to the map, the track should now be visible. <br> <br>The start and end points of the track are indicated by the two blue markers. |
|
||||
|
||||
> [!NOTE]
|
||||
> The starting point of the track will be displayed as a marker, with the name of the note underneath. The start marker will also respect the icon and the `color` of the note. The end marker is displayed with a distinct icon.
|
||||
>
|
||||
> If the GPX contains waypoints, they will also be displayed. If they have a name, it is displayed when hovering over it with the mouse.
|
||||
|
||||
## Read-only mode
|
||||
|
||||
When a map is in read-only all editing features will be disabled such as:
|
||||
|
||||
* The add button in the <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons.md">Floating buttons</a>.
|
||||
* Dragging markers.
|
||||
* Editing from the contextual menu (removing locations or adding new items).
|
||||
|
||||
To enable read-only mode simply press the _Lock_ icon from the <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons.md">Floating buttons</a>. To disable it, press the button again.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
<figure class="image image-style-align-right image_resized" style="width:34.06%;"><img style="aspect-ratio:678/499;" src="13_Geo Map View_image.png" width="678" height="499"></figure>
|
||||
|
||||
### Grid-like artifacts on the map
|
||||
|
||||
This occurs if the application is not at 100% zoom which causes the pixels of the map to not render correctly due to fractional scaling. The only possible solution is to set the UI zoom at 100% (default keyboard shortcut is <kbd>Ctrl</kbd>+<kbd>0</kbd>).
|
||||
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
|
Before Width: | Height: | Size: 32 KiB After Width: | Height: | Size: 32 KiB |
@@ -1,2 +0,0 @@
|
||||
# Grid View
|
||||
This is a clone of a note. Go to its [primary location](../../Basic%20Concepts%20and%20Features/Notes/Note%20List/Grid%20View.md).
|
||||
@@ -11,12 +11,12 @@ Each tile contains:
|
||||
|
||||
Depending on the type of note:
|
||||
|
||||
* For <a class="reference-link" href="../../../Note%20Types/Text.md">Text</a> notes, the text can be slightly 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.
|
||||
* For <a class="reference-link" href="../Text.md">Text</a> notes, the text can be slightly scrollable via the mouse wheel to reveal more context.
|
||||
* For <a class="reference-link" href="../Code.md">Code</a> notes, syntax highlighting is applied.
|
||||
* For <a class="reference-link" href="../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.
|
||||
|
||||
The grid view is also used by default in the <a class="reference-link" href="../Note%20List.md">Note List</a> of every note, making it easy to navigate to children notes.
|
||||
The grid view is also used by default in the <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/Notes/Note%20List.md">Note List</a> of every note, making it easy to navigate to children notes.
|
||||
|
||||
## Configuration
|
||||
|
||||
|
Before Width: | Height: | Size: 78 KiB After Width: | Height: | Size: 78 KiB |
@@ -1,2 +0,0 @@
|
||||
# List View
|
||||
This is a clone of a note. Go to its [primary location](../../Basic%20Concepts%20and%20Features/Notes/Note%20List/List%20View.md).
|
||||
@@ -8,4 +8,4 @@ In the example above, the "Node.js" note on the left panel contains several chil
|
||||
## Interaction
|
||||
|
||||
* Each note can be expanded or collapsed by clicking on the arrow to the left of the title.
|
||||
* In the <a class="reference-link" href="../../UI%20Elements/Ribbon.md">Ribbon</a>, in the _Collection_ tab there are options to expand and to collapse all notes easily.
|
||||
* In the <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">Ribbon</a>, in the _Collection_ tab there are options to expand and to collapse all notes easily.
|
||||
|
Before Width: | Height: | Size: 119 KiB After Width: | Height: | Size: 119 KiB |
@@ -1,2 +0,0 @@
|
||||
# Table View
|
||||
This is a clone of a note. Go to its [primary location](../../Basic%20Concepts%20and%20Features/Notes/Note%20List/Table%20View.md).
|
||||
@@ -1,7 +1,7 @@
|
||||
# Table View
|
||||
<figure class="image"><img style="aspect-ratio:1050/259;" src="Table View_image.png" width="1050" height="259"></figure>
|
||||
|
||||
The table view displays information in a grid, where the rows are individual notes and the columns are <a class="reference-link" href="../../../Advanced%20Usage/Attributes/Promoted%20Attributes.md">Promoted Attributes</a>. In addition, values are editable.
|
||||
The table view displays information in a grid, where the rows are individual notes and the columns are <a class="reference-link" href="../../Advanced%20Usage/Attributes/Promoted%20Attributes.md">Promoted Attributes</a>. In addition, values are editable.
|
||||
|
||||
## How it works
|
||||
|
||||
@@ -9,7 +9,7 @@ The tabular structure is represented as such:
|
||||
|
||||
* Each child note is a row in the table.
|
||||
* If child rows also have children, they will be displayed under an expander (nested notes).
|
||||
* Each column is a [promoted attribute](../../../Advanced%20Usage/Attributes/Promoted%20Attributes.md) that is defined on the Collection note.
|
||||
* Each column is a [promoted attribute](../../Advanced%20Usage/Attributes/Promoted%20Attributes.md) that is defined on the Collection note.
|
||||
* Actually, both promoted and unpromoted attributes are supported, but it's a requirement to use a label/relation definition.
|
||||
* The promoted attributes are usually defined as inheritable in order to show up in the child notes, but it's not a requirement.
|
||||
* If there are multiple attribute definitions with the same `name`, only one will be displayed.
|
||||
@@ -18,18 +18,18 @@ There are also a few predefined columns:
|
||||
|
||||
* The current item number, identified by the `#` symbol.
|
||||
* This simply counts the note and is affected by sorting.
|
||||
* <a class="reference-link" href="../../../Advanced%20Usage/Note%20ID.md">Note ID</a>, representing the unique ID used internally by Trilium
|
||||
* <a class="reference-link" href="../../Advanced%20Usage/Note%20ID.md">Note ID</a>, representing the unique ID used internally by Trilium
|
||||
* The title of the note.
|
||||
|
||||
## Interaction
|
||||
|
||||
### Creating a new table
|
||||
|
||||
Right click the <a class="reference-link" href="../../UI%20Elements/Note%20Tree.md">Note Tree</a> and select _Insert child note_ and look for the _Table item_.
|
||||
Right click the <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree.md">Note Tree</a> and select _Insert child note_ and look for the _Table item_.
|
||||
|
||||
### Adding columns
|
||||
|
||||
Each column is a [promoted or unpromoted attribute](../../../Advanced%20Usage/Attributes/Promoted%20Attributes.md) that is defined on the Collection note.
|
||||
Each column is a [promoted or unpromoted attribute](../../Advanced%20Usage/Attributes/Promoted%20Attributes.md) that is defined on the Collection note.
|
||||
|
||||
To create a new column, either:
|
||||
|
||||
@@ -48,7 +48,7 @@ To create a new note, either:
|
||||
|
||||
By default it will try to edit the title of the newly created note.
|
||||
|
||||
Alternatively, the note can be created from the <a class="reference-link" href="../../UI%20Elements/Note%20Tree.md">Note Tree</a> or [scripting](../../../Scripting.md).
|
||||
Alternatively, the note can be created from the <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree.md">Note Tree</a> or [scripting](../../Scripting.md).
|
||||
|
||||
### Context menu
|
||||
|
||||
@@ -88,7 +88,7 @@ If the _Name_ field of a column is changed, this will trigger a batch operation
|
||||
|
||||
### Sorting by column
|
||||
|
||||
By default, the order of the notes matches the order in the <a class="reference-link" href="../../UI%20Elements/Note%20Tree.md">Note Tree</a>. However, it is possible to sort the data by the values of a column:
|
||||
By default, the order of the notes matches the order in the <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree.md">Note Tree</a>. However, it is possible to sort the data by the values of a column:
|
||||
|
||||
* To do so, simply click on a column.
|
||||
* To switch between ascending or descending sort, simply click again on the same column. The arrow next to the column will indicate the direction of the sort.
|
||||
@@ -103,7 +103,7 @@ By default, the order of the notes matches the order in the <a class="reference
|
||||
|
||||
Notes can be dragged around to change their order. To do so, move the mouse over the three vertical dots near the number row and drag the mouse to the desired position.
|
||||
|
||||
This will also change the order of the note in the <a class="reference-link" href="../../UI%20Elements/Note%20Tree.md">Note Tree</a>.
|
||||
This will also change the order of the note in the <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20Tree.md">Note Tree</a>.
|
||||
|
||||
Reordering does have some limitations:
|
||||
|
||||
@@ -119,7 +119,7 @@ Next to the title of each element there will be a button to expand or collapse.
|
||||
|
||||
Since nesting is not always desirable, it is possible to limit the nesting to a certain number of levels or even disable it completely. To do so, either:
|
||||
|
||||
* Go to _Collection Properties_ in the <a class="reference-link" href="../../UI%20Elements/Ribbon.md">Ribbon</a> and look for the _Max nesting depth_ section.
|
||||
* Go to _Collection Properties_ in the <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">Ribbon</a> and look for the _Max nesting depth_ section.
|
||||
* To disable nesting, type 0 and press Enter.
|
||||
* To limit to a certain depth, type in the desired number (e.g. 2 to only display children and sub-children).
|
||||
* To re-enable unlimited nesting, remove the number and press Enter.
|
||||
@@ -131,19 +131,19 @@ Limitations:
|
||||
|
||||
## Limitations
|
||||
|
||||
Multi-value labels and relations are not supported. If a <a class="reference-link" href="../../../Advanced%20Usage/Attributes/Promoted%20Attributes.md">Promoted Attributes</a> is defined with a _Multi value_ specificity, they will be ignored.
|
||||
Multi-value labels and relations are not supported. If a <a class="reference-link" href="../../Advanced%20Usage/Attributes/Promoted%20Attributes.md">Promoted Attributes</a> is defined with a _Multi value_ specificity, they will be ignored.
|
||||
|
||||
## Use in search
|
||||
|
||||
The table view can be used in a <a class="reference-link" href="../../../Note%20Types/Saved%20Search.md">Saved Search</a> by adding the `#viewType=table` attribute.
|
||||
The table view can be used in a <a class="reference-link" href="../Saved%20Search.md">Saved Search</a> by adding the `#viewType=table` attribute.
|
||||
|
||||
Unlike when used in a Collection, saved searches are not limited to the sub-hierarchy of a note and allows for advanced queries thanks to the power of the <a class="reference-link" href="../../Navigation/Search.md">Search</a>.
|
||||
Unlike when used in a Collection, saved searches are not limited to the sub-hierarchy of a note and allows for advanced queries thanks to the power of the <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/Navigation/Search.md">Search</a>.
|
||||
|
||||
However, there are also some limitations:
|
||||
|
||||
* It's not possible to reorder notes.
|
||||
* It's not possible to add a new row.
|
||||
|
||||
Columns are supported, by being defined as <a class="reference-link" href="../../../Advanced%20Usage/Attributes/Promoted%20Attributes.md">Promoted Attributes</a> to the <a class="reference-link" href="../../../Note%20Types/Saved%20Search.md">Saved Search</a> note.
|
||||
Columns are supported, by being defined as <a class="reference-link" href="../../Advanced%20Usage/Attributes/Promoted%20Attributes.md">Promoted Attributes</a> to the <a class="reference-link" href="../Saved%20Search.md">Saved Search</a> note.
|
||||
|
||||
Editing is also supported.
|
||||
|
Before Width: | Height: | Size: 34 KiB After Width: | Height: | Size: 34 KiB |
@@ -16,7 +16,7 @@ Fore more information see <a class="reference-link" href="Text/Formatting%20too
|
||||
|
||||
Here's a list of various features supported by text notes:
|
||||
|
||||
<figure class="table"><table><thead><tr><th>Dedicated article</th><th>Feature</th></tr></thead><tbody><tr><td><a class="reference-link" href="Text/General%20formatting.md">General formatting</a></td><td><ul><li>Headings (section titles, paragraph)</li><li>Font size</li><li>Bold, italic, underline, strike-through</li><li>Superscript, subscript</li><li>Font color & background color</li><li>Remove formatting</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Lists.md">Lists</a></td><td><ul><li>Bulleted lists</li><li>Numbered lists</li><li>To-do lists</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Block%20quotes%20%26%20admonitions.md">Block quotes & admonitions</a></td><td><ul><li>Block quotes</li><li>Admonitions</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Tables.md">Tables</a></td><td><ul><li>Basic tables</li><li>Merging cells</li><li>Styling tables and cells.</li><li>Table captions</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Developer-specific%20formatting.md">Developer-specific formatting</a></td><td><ul><li>Inline code</li><li>Code blocks</li><li>Keyboard shortcuts</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Footnotes.md">Footnotes</a></td><td><ul><li>Footnotes</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Images.md">Images</a></td><td><ul><li>Images</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Links.md">Links</a></td><td><ul><li>External links</li><li>Internal Trilium links</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Include%20Note.md">Include Note</a></td><td><ul><li>Include note</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Insert%20buttons.md">Insert buttons</a></td><td><ul><li>Symbols</li><li><a class="reference-link" href="Text/Math%20Equations.md">Math Equations</a></li><li>Mermaid diagrams</li><li>Horizontal ruler</li><li>Page break</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Other%20features.md">Other features</a></td><td><ul><li>Indentation<ul><li>Markdown import</li></ul></li><li><a class="reference-link" href="Text/Cut%20to%20subnote.md">Cut to subnote</a></li></ul></td></tr><tr><td><a class="reference-link" href="Text/Premium%20features.md">Premium features</a></td><td><ul><li><a class="reference-link" href="Text/Premium%20features/Slash%20Commands.md">Slash Commands</a></li><li><a class="reference-link" href="../Advanced%20Usage/Templates.md">Templates</a></li></ul></td></tr></tbody></table></figure>
|
||||
<table><thead><tr><th>Dedicated article</th><th>Feature</th></tr></thead><tbody><tr><td><a class="reference-link" href="Text/General%20formatting.md">General formatting</a></td><td><ul><li>Headings (section titles, paragraph)</li><li>Font size</li><li>Bold, italic, underline, strike-through</li><li>Superscript, subscript</li><li>Font color & background color</li><li>Remove formatting</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Lists.md">Lists</a></td><td><ul><li>Bulleted lists</li><li>Numbered lists</li><li>To-do lists</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Block%20quotes%20%26%20admonitions.md">Block quotes & admonitions</a></td><td><ul><li>Block quotes</li><li>Admonitions</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Tables.md">Tables</a></td><td><ul><li>Basic tables</li><li>Merging cells</li><li>Styling tables and cells.</li><li>Table captions</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Developer-specific%20formatting.md">Developer-specific formatting</a></td><td><ul><li>Inline code</li><li>Code blocks</li><li>Keyboard shortcuts</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Footnotes.md">Footnotes</a></td><td><ul><li>Footnotes</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Images.md">Images</a></td><td><ul><li>Images</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Links.md">Links</a></td><td><ul><li>External links</li><li>Internal Trilium links</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Include%20Note.md">Include Note</a></td><td><ul><li>Include note</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Insert%20buttons.md">Insert buttons</a></td><td><ul><li>Symbols</li><li><a class="reference-link" href="Text/Math%20Equations.md">Math Equations</a></li><li>Mermaid diagrams</li><li>Horizontal ruler</li><li>Page break</li></ul></td></tr><tr><td><a class="reference-link" href="Text/Other%20features.md">Other features</a></td><td><ul><li>Indentation<ul><li>Markdown import</li></ul></li><li><a class="reference-link" href="Text/Cut%20to%20subnote.md">Cut to subnote</a></li></ul></td></tr><tr><td><a class="reference-link" href="Text/Premium%20features.md">Premium features</a></td><td><ul><li><a class="reference-link" href="Text/Premium%20features/Slash%20Commands.md">Slash Commands</a></li><li><a class="reference-link" href="../Advanced%20Usage/Templates.md">Templates</a></li></ul></td></tr></tbody></table>
|
||||
|
||||
## Read-Only vs. Editing Mode
|
||||
|
||||
|
||||
@@ -24,7 +24,12 @@ Clicking on an image will reveal a popup with multiple options:
|
||||
|
||||
The first set of options configure the alignment are, in order:
|
||||
|
||||
<figure class="table"><table><thead><tr><th>Icon</th><th>Option</th><th>Preview</th><th>Description</th></tr></thead><tbody><tr><td><img src="5_Images_image.png"></td><td>Inline</td><td><img src="1_Images_image.png"></td><td>As the name suggests, the name can be put inside a paragraph and moved around similarly as if it was a block of text. Use drag & drop or cut-paste to move it around.</td></tr><tr><td><img src="10_Images_image.png"></td><td>Centered image</td><td><img src="2_Images_image.png"></td><td>The image will be displayed as a block and centered, not allowing text in either the left or right of it.</td></tr><tr><td><img src="4_Images_image.png"></td><td>Wrap text</td><td><img src="7_Images_image.png"></td><td>The image will be displayed to the left or the right of the text.</td></tr><tr><td><img src="Images_image.png"></td><td>Block align</td><td><img src="3_Images_image.png"></td><td>Similarly to <em>Centered image</em>, the image will be displayed as a block and aligned either to the left or to the right, but not allowing text to flow on either of its sides.</td></tr></tbody></table></figure>
|
||||
| Icon | Option | Preview | Description |
|
||||
| --- | --- | --- | --- |
|
||||
|  | Inline |  | As the name suggests, the name can be put inside a paragraph and moved around similarly as if it was a block of text. Use drag & drop or cut-paste to move it around. |
|
||||
|  | Centered image |  | The image will be displayed as a block and centered, not allowing text in either the left or right of it. |
|
||||
|  | Wrap text |  | The image will be displayed to the left or the right of the text. |
|
||||
|  | Block align |  | Similarly to _Centered image_, the image will be displayed as a block and aligned either to the left or to the right, but not allowing text to flow on either of its sides. |
|
||||
|
||||
## Compression
|
||||
|
||||
|
||||
@@ -1,7 +1,21 @@
|
||||
# Keyboard shortcuts
|
||||
## Trilium-specific shortcuts
|
||||
|
||||
<figure class="table"><table><thead><tr><th>Action</th><th>PC</th><th>Mac</th></tr></thead><tbody><tr><td>Bring up inline formatting toolbar (arrow keys <kbd><span>←</span></kbd>,<kbd><span>→</span></kbd> to navigate, <kbd>Enter</kbd> to apply)</td><td><kbd>Alt</kbd>+<kbd>F10</kbd></td><td><kbd>⌥</kbd>+<kbd>F10</kbd></td></tr><tr><td>Bring up block formatting toolbar</td><td><kbd>Alt</kbd>+<kbd>F10</kbd></td><td><kbd>⌥</kbd>+<kbd>F10</kbd></td></tr><tr><td>Create <a href="Links.md">external link</a></td><td><kbd>Ctrl</kbd>+<kbd>K</kbd></td><td><kbd>⌘</kbd>+<kbd>K</kbd></td></tr><tr><td>Create <a href="Links.md">internal (note) link</a></td><td><kbd>Ctrl</kbd>+<kbd>L</kbd></td><td><kbd>⌘</kbd>+<kbd>L</kbd></td></tr><tr><td>Inserts current date and time at caret position</td><td><kbd>Alt</kbd>+<kbd>T</kbd> </td><td><kbd>⌥</kbd>+<kbd>T</kbd> </td></tr><tr><td>Increase paragraph indentation</td><td><kbd>Tab</kbd></td><td><kbd>⇥</kbd></td></tr><tr><td>Decrease paragraph indentation</td><td><kbd>Shift</kbd> + <kbd>Tab</kbd></td><td><kbd>⇧</kbd> + <kbd>⇥</kbd></td></tr><tr><td>Mark selected text as <a href="Developer-specific%20formatting.md">keyboard shortcut</a></td><td><kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>K</kbd></td><td><kbd>⌘</kbd>+ <kbd>⌥</kbd>+ <kbd>K</kbd></td></tr><tr><td>Insert <a class="reference-link" href="Math%20Equations.md">Math Equations</a></td><td><kbd>Ctrl</kbd> + <kbd>M</kbd></td><td><kbd>⌘</kbd>+ <kbd>M</kbd></td></tr><tr><td>Move blocks (lists, paragraphs, etc.) up</td><td><kbd>Ctrl</kbd>+<kbd>↑</kbd> </td><td><kbd>⌘</kbd>+<kbd>↑</kbd> </td></tr><tr><td><kbd>Alt</kbd>+<kbd>↑</kbd></td><td><kbd>⌥</kbd>+<kbd>↑</kbd></td></tr><tr><td>Move blocks (lists, paragraphs, etc.) down</td><td><kbd>Ctrl</kbd>+<kbd>↑</kbd></td><td><kbd>⌘</kbd>+<kbd>↑</kbd></td></tr><tr><td><kbd>Alt</kbd>+<kbd>↓</kbd></td><td><kbd>⌥</kbd>+<kbd>↓</kbd></td></tr></tbody></table></figure>
|
||||
| Action | PC | Mac |
|
||||
| --- | --- | --- |
|
||||
| Bring up inline formatting toolbar (arrow keys <kbd><span>←</span></kbd>,<kbd><span>→</span></kbd> to navigate, <kbd>Enter</kbd> to apply) | <kbd>Alt</kbd>+<kbd>F10</kbd> | <kbd>⌥</kbd>+<kbd>F10</kbd> |
|
||||
| Bring up block formatting toolbar | <kbd>Alt</kbd>+<kbd>F10</kbd> | <kbd>⌥</kbd>+<kbd>F10</kbd> |
|
||||
| Create [external link](Links.md) | <kbd>Ctrl</kbd>+<kbd>K</kbd> | <kbd>⌘</kbd>+<kbd>K</kbd> |
|
||||
| Create [internal (note) link](Links.md) | <kbd>Ctrl</kbd>+<kbd>L</kbd> | <kbd>⌘</kbd>+<kbd>L</kbd> |
|
||||
| Inserts current date and time at caret position | <kbd>Alt</kbd>+<kbd>T</kbd> | <kbd>⌥</kbd>+<kbd>T</kbd> |
|
||||
| Increase paragraph indentation | <kbd>Tab</kbd> | <kbd>⇥</kbd> |
|
||||
| Decrease paragraph indentation | <kbd>Shift</kbd> + <kbd>Tab</kbd> | <kbd>⇧</kbd> + <kbd>⇥</kbd> |
|
||||
| Mark selected text as [keyboard shortcut](Developer-specific%20formatting.md) | <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>K</kbd> | <kbd>⌘</kbd>\+ <kbd>⌥</kbd>\+ <kbd>K</kbd> |
|
||||
| Insert <a class="reference-link" href="Math%20Equations.md">Math Equations</a> | <kbd>Ctrl</kbd> + <kbd>M</kbd> | <kbd>⌘</kbd>\+ <kbd>M</kbd> |
|
||||
| Move blocks (lists, paragraphs, etc.) up | <kbd>Ctrl</kbd>+<kbd>↑</kbd> | <kbd>⌘</kbd>+<kbd>↑</kbd> |
|
||||
| <kbd>Alt</kbd>+<kbd>↑</kbd> | <kbd>⌥</kbd>+<kbd>↑</kbd> |
|
||||
| Move blocks (lists, paragraphs, etc.) down | <kbd>Ctrl</kbd>+<kbd>↑</kbd> | <kbd>⌘</kbd>+<kbd>↑</kbd> |
|
||||
| <kbd>Alt</kbd>+<kbd>↓</kbd> | <kbd>⌥</kbd>+<kbd>↓</kbd> |
|
||||
|
||||
## Common shortcuts
|
||||
|
||||
@@ -10,22 +24,66 @@
|
||||
|
||||
### Content editing
|
||||
|
||||
<figure class="table"><table><thead><tr><th>Action</th><th>PC</th><th>Mac</th></tr></thead><tbody><tr><td>Insert a hard break (a new paragraph)</td><td><kbd>Enter</kbd></td><td> </td></tr><tr><td>Insert a soft break (a <code><br></code> element)</td><td><kbd>Shift</kbd>+<kbd>Enter</kbd></td><td><kbd>⇧Enter</kbd></td></tr><tr><td>Copy selected content</td><td><kbd>Ctrl</kbd>+<kbd>C</kbd></td><td><kbd>⌘C</kbd></td></tr><tr><td>Paste content</td><td><kbd>Ctrl</kbd>+<kbd>V</kbd></td><td><kbd>⌘V</kbd></td></tr><tr><td>Paste content as plain text</td><td><kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>V</kbd></td><td><kbd>⌘⇧V</kbd></td></tr><tr><td>Undo</td><td><kbd>Ctrl</kbd>+<kbd>Z</kbd></td><td><kbd>⌘Z</kbd></td></tr><tr><td>Redo</td><td><kbd>Ctrl</kbd>+<kbd>Y</kbd>, <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Z</kbd></td><td><kbd>⌘Y</kbd>, <kbd>⌘⇧Z</kbd></td></tr><tr><td>Bold text</td><td><kbd>Ctrl</kbd>+<kbd>B</kbd></td><td><kbd>⌘B</kbd></td></tr><tr><td>Change text case</td><td><kbd>Shift</kbd>+<kbd>F3</kbd></td><td><kbd>⇧F3</kbd> (may require <kbd>Fn</kbd>)</td></tr><tr><td>Create link</td><td><kbd>Ctrl</kbd>+<kbd>K</kbd></td><td><kbd>⌘K</kbd></td></tr><tr><td>Move out of a link</td><td><kbd>←←</kbd>, <kbd>→→</kbd></td><td> </td></tr><tr><td>Move out of an inline code style</td><td><kbd>←←</kbd>, <kbd>→→</kbd></td><td> </td></tr><tr><td>Select all</td><td><kbd>Ctrl</kbd>+<kbd>A</kbd></td><td><kbd>⌘A</kbd></td></tr><tr><td>Find in the document</td><td><kbd>Ctrl</kbd>+<kbd>F</kbd></td><td><kbd>⌘F</kbd></td></tr><tr><td>Copy text formatting</td><td><kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>C</kbd></td><td><kbd>⌘⇧C</kbd></td></tr><tr><td>Paste text formatting</td><td><kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>V</kbd></td><td><kbd>⌘⇧V</kbd></td></tr><tr><td>Italic text</td><td><kbd>Ctrl</kbd>+<kbd>I</kbd></td><td><kbd>⌘I</kbd></td></tr><tr><td>Strikethrough text</td><td><kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>X</kbd></td><td><kbd>⌘⇧X</kbd></td></tr><tr><td>Underline text</td><td><kbd>Ctrl</kbd>+<kbd>U</kbd></td><td><kbd>⌘U</kbd></td></tr><tr><td>Revert autoformatting action</td><td><kbd>Backspace</kbd></td><td> </td></tr></tbody></table></figure>
|
||||
| Action | PC | Mac |
|
||||
| --- | --- | --- |
|
||||
| Insert a hard break (a new paragraph) | <kbd>Enter</kbd> | |
|
||||
| Insert a soft break (a `<br>` element) | <kbd>Shift</kbd>+<kbd>Enter</kbd> | <kbd>⇧Enter</kbd> |
|
||||
| Copy selected content | <kbd>Ctrl</kbd>+<kbd>C</kbd> | <kbd>⌘C</kbd> |
|
||||
| Paste content | <kbd>Ctrl</kbd>+<kbd>V</kbd> | <kbd>⌘V</kbd> |
|
||||
| Paste content as plain text | <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>V</kbd> | <kbd>⌘⇧V</kbd> |
|
||||
| Undo | <kbd>Ctrl</kbd>+<kbd>Z</kbd> | <kbd>⌘Z</kbd> |
|
||||
| Redo | <kbd>Ctrl</kbd>+<kbd>Y</kbd>, <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Z</kbd> | <kbd>⌘Y</kbd>, <kbd>⌘⇧Z</kbd> |
|
||||
| Bold text | <kbd>Ctrl</kbd>+<kbd>B</kbd> | <kbd>⌘B</kbd> |
|
||||
| Change text case | <kbd>Shift</kbd>+<kbd>F3</kbd> | <kbd>⇧F3</kbd> (may require <kbd>Fn</kbd>) |
|
||||
| Create link | <kbd>Ctrl</kbd>+<kbd>K</kbd> | <kbd>⌘K</kbd> |
|
||||
| Move out of a link | <kbd>←←</kbd>, <kbd>→→</kbd> | |
|
||||
| Move out of an inline code style | <kbd>←←</kbd>, <kbd>→→</kbd> | |
|
||||
| Select all | <kbd>Ctrl</kbd>+<kbd>A</kbd> | <kbd>⌘A</kbd> |
|
||||
| Find in the document | <kbd>Ctrl</kbd>+<kbd>F</kbd> | <kbd>⌘F</kbd> |
|
||||
| Copy text formatting | <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>C</kbd> | <kbd>⌘⇧C</kbd> |
|
||||
| Paste text formatting | <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>V</kbd> | <kbd>⌘⇧V</kbd> |
|
||||
| Italic text | <kbd>Ctrl</kbd>+<kbd>I</kbd> | <kbd>⌘I</kbd> |
|
||||
| Strikethrough text | <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>X</kbd> | <kbd>⌘⇧X</kbd> |
|
||||
| Underline text | <kbd>Ctrl</kbd>+<kbd>U</kbd> | <kbd>⌘U</kbd> |
|
||||
| Revert autoformatting action | <kbd>Backspace</kbd> | |
|
||||
|
||||
### Interacting with blocks
|
||||
|
||||
Blocks are images, tables, blockquotes, annotations.
|
||||
|
||||
<figure class="table"><table><thead><tr><th>Action</th><th>PC</th><th>Mac</th></tr></thead><tbody><tr><td>Insert a new paragraph directly after a widget</td><td><kbd>Enter</kbd></td><td> </td></tr><tr><td>Insert a new paragraph directly before a widget</td><td><kbd>Shift</kbd>+<kbd>Enter</kbd></td><td><kbd>⇧Enter</kbd></td></tr><tr><td>Move the caret to allow typing directly before a widget</td><td><kbd>↑</kbd>, <kbd>←</kbd></td><td> </td></tr><tr><td>Move the caret to allow typing directly after a widget</td><td><kbd>↓</kbd>, <kbd>→</kbd></td><td> </td></tr><tr><td>After entering a nested editable, move the selection to the closest ancestor widget. For example: move from an image caption to the whole image widget.</td><td><kbd>Tab</kbd> then <kbd>Esc</kbd></td><td> </td></tr></tbody></table></figure>
|
||||
| Action | PC | Mac |
|
||||
| --- | --- | --- |
|
||||
| Insert a new paragraph directly after a widget | <kbd>Enter</kbd> | |
|
||||
| Insert a new paragraph directly before a widget | <kbd>Shift</kbd>+<kbd>Enter</kbd> | <kbd>⇧Enter</kbd> |
|
||||
| Move the caret to allow typing directly before a widget | <kbd>↑</kbd>, <kbd>←</kbd> | |
|
||||
| Move the caret to allow typing directly after a widget | <kbd>↓</kbd>, <kbd>→</kbd> | |
|
||||
| After entering a nested editable, move the selection to the closest ancestor widget. For example: move from an image caption to the whole image widget. | <kbd>Tab</kbd> then <kbd>Esc</kbd> | |
|
||||
|
||||
Specifically for lists:
|
||||
|
||||
<figure class="table"><table><thead><tr><th>Action</th><th>PC</th><th>Mac</th></tr></thead><tbody><tr><td>Increase list item indent</td><td><kbd>⇥</kbd></td><td> </td></tr><tr><td>Decrease list item indent</td><td><kbd>Shift</kbd>+<kbd>⇥</kbd></td><td><kbd>⇧⇥</kbd></td></tr></tbody></table></figure>
|
||||
| Action | PC | Mac |
|
||||
| --- | --- | --- |
|
||||
| Increase list item indent | <kbd>⇥</kbd> | |
|
||||
| Decrease list item indent | <kbd>Shift</kbd>+<kbd>⇥</kbd> | <kbd>⇧⇥</kbd> |
|
||||
|
||||
In tables:
|
||||
|
||||
<figure class="table"><table><thead><tr><th>Action</th><th>PC</th><th>Mac</th></tr></thead><tbody><tr><td>Move the selection to the next cell</td><td><kbd>⇥</kbd></td><td> </td></tr><tr><td>Move the selection to the previous cell</td><td><kbd>Shift</kbd>+<kbd>⇥</kbd></td><td><kbd>⇧⇥</kbd></td></tr><tr><td>Insert a new table row (when in the last cell of a table)</td><td><kbd>⇥</kbd></td><td> </td></tr><tr><td>Navigate through the table</td><td><kbd>↑</kbd>, <kbd>→</kbd>, <kbd>↓</kbd>, <kbd>←</kbd></td><td> </td></tr></tbody></table></figure>
|
||||
| Action | PC | Mac |
|
||||
| --- | --- | --- |
|
||||
| Move the selection to the next cell | <kbd>⇥</kbd> | |
|
||||
| Move the selection to the previous cell | <kbd>Shift</kbd>+<kbd>⇥</kbd> | <kbd>⇧⇥</kbd> |
|
||||
| Insert a new table row (when in the last cell of a table) | <kbd>⇥</kbd> | |
|
||||
| Navigate through the table | <kbd>↑</kbd>, <kbd>→</kbd>, <kbd>↓</kbd>, <kbd>←</kbd> | |
|
||||
|
||||
### General UI shortcuts
|
||||
|
||||
<figure class="table"><table><thead><tr><th>Action</th><th>PC</th><th>Mac</th></tr></thead><tbody><tr><td>Close contextual balloons, dropdowns, and dialogs</td><td><kbd>Esc</kbd></td><td> </td></tr><tr><td>Open the accessibility help dialog</td><td><kbd>Alt</kbd>+<kbd>0</kbd></td><td><kbd>⌥0</kbd></td></tr><tr><td>Move focus between form fields (inputs, buttons, etc.)</td><td><kbd>⇥</kbd>, <kbd>Shift</kbd>+<kbd>⇥</kbd></td><td><kbd>⇥</kbd>, <kbd>⇧⇥</kbd></td></tr><tr><td>Move focus to the toolbar, navigate between toolbars</td><td><kbd>Alt</kbd>+<kbd>F10</kbd></td><td><kbd>⌥F10</kbd> (may require <kbd>Fn</kbd>)</td></tr><tr><td>Navigate through the toolbar or menu bar</td><td><kbd>↑</kbd>, <kbd>→</kbd>, <kbd>↓</kbd>, <kbd>←</kbd></td><td> </td></tr><tr><td>Navigate to the next focusable field or an element outside the editor</td><td><kbd>Tab</kbd>, <kbd>Shift</kbd>+<kbd>Tab</kbd></td><td> </td></tr><tr><td>Execute the currently focused button. Executing buttons that interact with the editor content moves the focus back to the content.</td><td><kbd>Enter</kbd>, <kbd>Space</kbd></td><td> </td></tr><tr><td>Move focus in and out of an active dialog window</td><td><kbd>Ctrl</kbd>+<kbd>F6</kbd></td><td><kbd>⌘F6</kbd> (may require <kbd>Fn</kbd>)</td></tr></tbody></table></figure>
|
||||
| Action | PC | Mac |
|
||||
| --- | --- | --- |
|
||||
| Close contextual balloons, dropdowns, and dialogs | <kbd>Esc</kbd> | |
|
||||
| Open the accessibility help dialog | <kbd>Alt</kbd>+<kbd>0</kbd> | <kbd>⌥0</kbd> |
|
||||
| Move focus between form fields (inputs, buttons, etc.) | <kbd>⇥</kbd>, <kbd>Shift</kbd>+<kbd>⇥</kbd> | <kbd>⇥</kbd>, <kbd>⇧⇥</kbd> |
|
||||
| Move focus to the toolbar, navigate between toolbars | <kbd>Alt</kbd>+<kbd>F10</kbd> | <kbd>⌥F10</kbd> (may require <kbd>Fn</kbd>) |
|
||||
| Navigate through the toolbar or menu bar | <kbd>↑</kbd>, <kbd>→</kbd>, <kbd>↓</kbd>, <kbd>←</kbd> | |
|
||||
| Navigate to the next focusable field or an element outside the editor | <kbd>Tab</kbd>, <kbd>Shift</kbd>+<kbd>Tab</kbd> | |
|
||||
| Execute the currently focused button. Executing buttons that interact with the editor content moves the focus back to the content. | <kbd>Enter</kbd>, <kbd>Space</kbd> | |
|
||||
| Move focus in and out of an active dialog window | <kbd>Ctrl</kbd>+<kbd>F6</kbd> | <kbd>⌘F6</kbd> (may require <kbd>Fn</kbd>) |
|
||||
@@ -23,6 +23,13 @@ For bulleted and numbered lists, it's possible to configure an alternative marke
|
||||
|
||||
It possible to add content-level blocks such as headings, code blocks, tables within lists, as follows:
|
||||
|
||||
<figure class="table" style="width:100%;"><table class="ck-table-resized"><colgroup><col style="width:4.79%;"><col style="width:57.19%;"><col style="width:38.02%;"></colgroup><tbody><tr><th>1</th><td><img src="6_Lists_image.png"></td><td>First, create a list.</td></tr><tr><th>2</th><td><img src="4_Lists_image.png"></td><td>Press Enter to create a new list item.</td></tr><tr><th>3</th><td><img src="5_Lists_image.png"></td><td>Press Backspace to get rid of the bullet point. Notice the cursor position.</td></tr><tr><th>4</th><td><img class="image_resized" style="aspect-ratio:676/112;width:98.29%;" src="1_Lists_image.png" width="676" height="112"></td><td>At this point, insert any desired block-level item such as a code block.</td></tr><tr><th>5</th><td><img class="image_resized" style="aspect-ratio:675/129;width:94.22%;" src="Lists_image.png" width="675" height="129"></td><td>To continue with a new bullet point, press Enter until the cursor moves to a new blank position.</td></tr><tr><th>6</th><td><img class="image_resized" style="aspect-ratio:675/129;width:100%;" src="3_Lists_image.png" width="675" height="129"></td><td>Press Enter once more to create the new bullet.</td></tr></tbody></table></figure>
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| 1 |  | First, create a list. |
|
||||
| 2 |  | Press Enter to create a new list item. |
|
||||
| 3 |  | Press Backspace to get rid of the bullet point. Notice the cursor position. |
|
||||
| 4 | <img class="image_resized" style="aspect-ratio:676/112;width:98.29%;" src="1_Lists_image.png" width="676" height="112"> | At this point, insert any desired block-level item such as a code block. |
|
||||
| 5 | <img class="image_resized" style="aspect-ratio:675/129;width:94.22%;" src="Lists_image.png" width="675" height="129"> | To continue with a new bullet point, press Enter until the cursor moves to a new blank position. |
|
||||
| 6 | <img class="image_resized" style="aspect-ratio:675/129;width:100%;" src="3_Lists_image.png" width="675" height="129"> | Press Enter once more to create the new bullet. |
|
||||
|
||||
The same principle applies to all three list types (bullet, numbered and to-do).
|
||||
16
docs/User Guide/User Guide/Scripting/Events.md
vendored
16
docs/User Guide/User Guide/Scripting/Events.md
vendored
@@ -5,10 +5,22 @@
|
||||
|
||||
Global events are attached to the script note via label. Simply create e.g. "run" label with some of these values and script note will be executed once the event occurs.
|
||||
|
||||
<figure class="table"><table><thead><tr><th>Label</th><th>Description</th></tr></thead><tbody><tr><td><code>run</code></td><td><p>Defines on which events script should run. Possible values are:</p><ul><li><code>frontendStartup</code> - when Trilium frontend starts up (or is refreshed), but not on mobile.</li><li><code>mobileStartup</code> - when Trilium frontend starts up (or is refreshed), on mobile.</li><li><code>backendStartup</code> - when Trilium backend starts up</li><li><code>hourly</code> - run once an hour. You can use additional label <code>runAtHour</code> to specify at which hour, on the back-end.</li><li><code>daily</code> - run once a day, on the back-end</li></ul></td></tr><tr><td><code>runOnInstance</code></td><td>Specifies that the script should only run on a particular <a class="reference-link" href="../Advanced%20Usage/Configuration%20(config.ini%20or%20environment%20variables)/Trilium%20instance.md">Trilium instance</a>.</td></tr><tr><td><code>runAtHour</code></td><td>On which hour should this run. Should be used together with <code>#run=hourly</code>. Can be defined multiple times for more runs during the day.</td></tr></tbody></table></figure>
|
||||
<table><thead><tr><th>Label</th><th>Description</th></tr></thead><tbody><tr><td><code>run</code></td><td><p>Defines on which events script should run. Possible values are:</p><ul><li><code>frontendStartup</code> - when Trilium frontend starts up (or is refreshed), but not on mobile.</li><li><code>mobileStartup</code> - when Trilium frontend starts up (or is refreshed), on mobile.</li><li><code>backendStartup</code> - when Trilium backend starts up</li><li><code>hourly</code> - run once an hour. You can use additional label <code>runAtHour</code> to specify at which hour, on the back-end.</li><li><code>daily</code> - run once a day, on the back-end</li></ul></td></tr><tr><td><code>runOnInstance</code></td><td>Specifies that the script should only run on a particular <a class="reference-link" href="../Advanced%20Usage/Configuration%20(config.ini%20or%20environment%20variables)/Trilium%20instance.md">Trilium instance</a>.</td></tr><tr><td><code>runAtHour</code></td><td>On which hour should this run. Should be used together with <code>#run=hourly</code>. Can be defined multiple times for more runs during the day.</td></tr></tbody></table>
|
||||
|
||||
## Entity events
|
||||
|
||||
Other events are bound to some entity, these are defined as [relations](../Advanced%20Usage/Attributes.md) - meaning that script is triggered only if note has this script attached to it through relations (or it can inherit it).
|
||||
|
||||
<figure class="table"><table><thead><tr><th>Relation</th><th>Description</th></tr></thead><tbody><tr><td><code>runOnNoteCreation</code></td><td>executes when note is created on backend. Use this relation if you want to run the script for all notes created under a specific subtree. In that case, create it on the subtree root note and make it inheritable. A new note created within the subtree (any depth) will trigger the script.</td></tr><tr><td><code>runOnChildNoteCreation</code></td><td>executes when new note is created under the note where this relation is defined</td></tr><tr><td><code>runOnNoteTitleChange</code></td><td>executes when note title is changed (includes note creation as well)</td></tr><tr><td><code>runOnNoteContentChange</code></td><td>executes when note content is changed (includes note creation as well).</td></tr><tr><td><code>runOnNoteChange</code></td><td>executes when note is changed (includes note creation as well). Does not include content changes</td></tr><tr><td><code>runOnNoteDeletion</code></td><td>executes when note is being deleted</td></tr><tr><td><code>runOnBranchCreation</code></td><td>executes when a branch is created. Branch is a link between parent note and child note and is created e.g. when cloning or moving note.</td></tr><tr><td><code>runOnBranchChange</code></td><td>executes when a branch is updated. (since v0.62)</td></tr><tr><td><code>runOnBranchDeletion</code></td><td>executes when a branch is deleted. Branch is a link between parent note and child note and is deleted e.g. when moving note (old branch/link is deleted).</td></tr><tr><td><code>runOnAttributeCreation</code></td><td>executes when new attribute is created for the note which defines this relation</td></tr><tr><td><code>runOnAttributeChange</code></td><td>executes when the attribute is changed of a note which defines this relation. This is triggered also when the attribute is deleted</td></tr></tbody></table></figure>
|
||||
| Relation | Description |
|
||||
| --- | --- |
|
||||
| `runOnNoteCreation` | executes when note is created on backend. Use this relation if you want to run the script for all notes created under a specific subtree. In that case, create it on the subtree root note and make it inheritable. A new note created within the subtree (any depth) will trigger the script. |
|
||||
| `runOnChildNoteCreation` | executes when new note is created under the note where this relation is defined |
|
||||
| `runOnNoteTitleChange` | executes when note title is changed (includes note creation as well) |
|
||||
| `runOnNoteContentChange` | executes when note content is changed (includes note creation as well). |
|
||||
| `runOnNoteChange` | executes when note is changed (includes note creation as well). Does not include content changes |
|
||||
| `runOnNoteDeletion` | executes when note is being deleted |
|
||||
| `runOnBranchCreation` | executes when a branch is created. Branch is a link between parent note and child note and is created e.g. when cloning or moving note. |
|
||||
| `runOnBranchChange` | executes when a branch is updated. (since v0.62) |
|
||||
| `runOnBranchDeletion` | executes when a branch is deleted. Branch is a link between parent note and child note and is deleted e.g. when moving note (old branch/link is deleted). |
|
||||
| `runOnAttributeCreation` | executes when new attribute is created for the note which defines this relation |
|
||||
| `runOnAttributeChange` | executes when the attribute is changed of a note which defines this relation. This is triggered also when the attribute is deleted |
|
||||
Reference in New Issue
Block a user