feat(docs): improve documentation for read-only notes
Elian Doran
@ -2432,20 +2432,6 @@
|
||||
"isInheritable": false,
|
||||
"position": 10
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "iPIMuisry3hd",
|
||||
"isInheritable": false,
|
||||
"position": 20
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "6f9hih2hXXZk",
|
||||
"isInheritable": false,
|
||||
"position": 30
|
||||
},
|
||||
{
|
||||
"type": "label",
|
||||
"name": "shareAlias",
|
||||
@ -2459,11 +2445,55 @@
|
||||
"value": "bx bx-edit-alt",
|
||||
"isInheritable": false,
|
||||
"position": 40
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "iPIMuisry3hd",
|
||||
"isInheritable": false,
|
||||
"position": 50
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "6f9hih2hXXZk",
|
||||
"isInheritable": false,
|
||||
"position": 60
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "BlN9DFI679QC",
|
||||
"isInheritable": false,
|
||||
"position": 70
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "XpOYSgsLkTJy",
|
||||
"isInheritable": false,
|
||||
"position": 80
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "4TIF1oA4VQRO",
|
||||
"isInheritable": false,
|
||||
"position": 100
|
||||
}
|
||||
],
|
||||
"format": "markdown",
|
||||
"dataFileName": "Read-Only Notes.md",
|
||||
"attachments": []
|
||||
"attachments": [
|
||||
{
|
||||
"attachmentId": "dUmc6vYfoQgZ",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "Read-Only Notes_image.png"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
@ -3718,13 +3748,6 @@
|
||||
"isInheritable": false,
|
||||
"position": 20
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "zEY4DaJG4YT5",
|
||||
"isInheritable": false,
|
||||
"position": 30
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
@ -5480,7 +5503,7 @@
|
||||
"dataFileName": "1_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "6wUkw5RWE39e",
|
||||
"attachmentId": "aCSNn9QlgHFi",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
@ -5488,7 +5511,7 @@
|
||||
"dataFileName": "2_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "aCSNn9QlgHFi",
|
||||
"attachmentId": "aCuXZY7WV4li",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
@ -5496,7 +5519,7 @@
|
||||
"dataFileName": "3_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "aCuXZY7WV4li",
|
||||
"attachmentId": "agH6yREFgsoU",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
@ -5504,7 +5527,7 @@
|
||||
"dataFileName": "4_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "agH6yREFgsoU",
|
||||
"attachmentId": "AHyDUM6R5HeG",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
@ -5512,7 +5535,7 @@
|
||||
"dataFileName": "5_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "AHyDUM6R5HeG",
|
||||
"attachmentId": "CcjWLhE3KKfv",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
@ -5520,7 +5543,7 @@
|
||||
"dataFileName": "6_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "CcjWLhE3KKfv",
|
||||
"attachmentId": "DapDey8gMiFc",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
@ -5528,7 +5551,7 @@
|
||||
"dataFileName": "7_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "DapDey8gMiFc",
|
||||
"attachmentId": "fQy8R1vxKhwN",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
@ -5536,28 +5559,20 @@
|
||||
"dataFileName": "8_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "fQy8R1vxKhwN",
|
||||
"attachmentId": "gJ4Yz80jxcbn",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "9_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "gJ4Yz80jxcbn",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "10_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "I39BinT2gsN9",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "11_Geo Map_image.png"
|
||||
"dataFileName": "10_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "IeXU8SLZU7Oz",
|
||||
@ -5573,7 +5588,7 @@
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "12_Geo Map_image.png"
|
||||
"dataFileName": "11_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "Mx2xwNIk76ZS",
|
||||
@ -5581,7 +5596,7 @@
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "13_Geo Map_image.png"
|
||||
"dataFileName": "12_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "oaahbsMRbqd2",
|
||||
@ -5589,7 +5604,7 @@
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "14_Geo Map_image.png"
|
||||
"dataFileName": "13_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "pGf1p74KKGU4",
|
||||
@ -5597,7 +5612,7 @@
|
||||
"role": "image",
|
||||
"mime": "image/jpg",
|
||||
"position": 10,
|
||||
"dataFileName": "15_Geo Map_image.png"
|
||||
"dataFileName": "14_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "tfa1TRUatWEh",
|
||||
@ -5605,15 +5620,7 @@
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "16_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "USbvJ38T4AKA",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "17_Geo Map_image.png"
|
||||
"dataFileName": "15_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "x6yBLIsY2LSv",
|
||||
@ -5621,7 +5628,7 @@
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "18_Geo Map_image.png"
|
||||
"dataFileName": "16_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "yJMyBRYA3Kwi",
|
||||
@ -5629,7 +5636,7 @@
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "19_Geo Map_image.png"
|
||||
"dataFileName": "17_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "ZvTlu9WMd37z",
|
||||
@ -5637,7 +5644,7 @@
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "20_Geo Map_image.png"
|
||||
"dataFileName": "18_Geo Map_image.png"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@ -1,12 +1,44 @@
|
||||
# Read-Only Notes
|
||||
Both [text](../../Note%20Types/Text.md) and [code](../../Note%20Types/Code.md) notes in Trilium can be set to read-only. When a note is in read-only mode, it is presented to the user in a non-editable view, with the option to switch to editing mode if needed.
|
||||
Some note types such as [Text](../../Note%20Types/Text.md) and [Code](../../Note%20Types/Code.md) notes in Trilium can be set to read-only. When a note is in read-only mode, it is presented to the user in a non-editable view, with the option to switch to editing mode if needed.
|
||||
|
||||
## Setting Read-Only Mode with a Label
|
||||
|
||||
To set a note as read-only, add the `readOnly` [label](../../Advanced%20Usage/Attributes.md) to the note.
|
||||
|
||||
## Automatic Read-Only Mode
|
||||
## Automatic read-only mode
|
||||
|
||||
For optimization purposes, Trilium will automatically set very large notes to read-only. Displaying such lengthy notes in editing mode can slow down performance, especially when editing is unnecessary.
|
||||
|
||||
If you want to ensure that a specific note remains editable regardless of its size, you can add the `autoReadOnlyDisabled` [label](../../Advanced%20Usage/Attributes.md) to the note.
|
||||
This behavior can be disabled on a per-note basis, by following the instructions of the next section.
|
||||
|
||||
In addition, it's possible to change the number of characters at which the automatic read-only mode will trigger in [Options](../UI%20Elements/Options.md) by going to the options for [Text](../../Note%20Types/Text.md) and [Code](../../Note%20Types/Code.md) notes.
|
||||
|
||||
## Changing a note's read-only behavior
|
||||
|
||||
Via the [Ribbon](../UI%20Elements/Ribbon.md), by going to the _Basic Properties_ tab and looking for the _Editable_ selection. The following options are possible:
|
||||
|
||||
* **Auto**
|
||||
This is the default behavior in which the note will be editable by default, unless it becomes large enough to trigger read-only mode.
|
||||
|
||||
* **Read-only**
|
||||
The note will be always marked as read-only, regardless of its size. Nevertheless, it's still possible to temporarily edit the note if needed. This is generally useful for notes that are not prone to change.
|
||||
|
||||
* **Always Editable**
|
||||
This option will bypass the automatic read-only activation for this particular note. It's useful for large notes that are frequently edited.
|
||||
|
||||
If the _Editable_ section is missing from the ribbon, then the note type does not support read-only mode.
|
||||
|
||||
### Manually setting the options
|
||||
|
||||
Apart from using the ribbon as previously mentioned, it's also possible to use [labels](../../Advanced%20Usage/Attributes.md) to change the behavior:
|
||||
|
||||
* To set as read-only, apply the `readOnly` label to the note.
|
||||
* To disable automatic read-only (always editable), apply the `autoReadOnlyDisabled` label.
|
||||
|
||||
## Temporarily editing a read-only note
|
||||
|
||||
When accessing a read-only note, it's possible to temporarily edit it by using the  button in the [Floating buttons](../UI%20Elements/Floating%20buttons.md) area.
|
||||
|
||||
When pressed, the note will become editable but will become read-only again after navigating to a different note.
|
||||
|
||||
## Special read-only behavior
|
||||
|
||||
Some note types have a special behavior based on whether the read-only mode is enabled:
|
||||
|
||||
* [Mermaid Diagrams](#root/rswjxUmAz64R/aOI0RYfC3wic/ObWG9tSNscDb) will hide the Mermaid source code and display the diagram preview in full-size. In this case, the read-only mode can be easily toggled on or off via a dedicated button in the [Floating buttons](../UI%20Elements/Floating%20buttons.md) area.
|
||||
|
After Width: | Height: | Size: 429 B |
|
Before Width: | Height: | Size: 515 KiB After Width: | Height: | Size: 176 KiB |
|
Before Width: | Height: | Size: 176 KiB After Width: | Height: | Size: 815 B |
|
Before Width: | Height: | Size: 815 B After Width: | Height: | Size: 43 KiB |
|
Before Width: | Height: | Size: 43 KiB After Width: | Height: | Size: 117 KiB |
|
Before Width: | Height: | Size: 117 KiB After Width: | Height: | Size: 31 KiB |
|
Before Width: | Height: | Size: 31 KiB After Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 397 KiB |
|
Before Width: | Height: | Size: 4.2 KiB After Width: | Height: | Size: 359 B |
|
Before Width: | Height: | Size: 397 KiB After Width: | Height: | Size: 42 KiB |
|
Before Width: | Height: | Size: 359 B |
|
Before Width: | Height: | Size: 42 KiB |
|
Before Width: | Height: | Size: 8.8 KiB After Width: | Height: | Size: 323 KiB |
|
Before Width: | Height: | Size: 323 KiB After Width: | Height: | Size: 5.2 KiB |
|
Before Width: | Height: | Size: 5.2 KiB After Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 28 KiB |
|
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 102 KiB |
|
Before Width: | Height: | Size: 102 KiB After Width: | Height: | Size: 260 KiB |
|
Before Width: | Height: | Size: 260 KiB After Width: | Height: | Size: 35 KiB |
|
Before Width: | Height: | Size: 35 KiB After Width: | Height: | Size: 515 KiB |
@ -1,5 +1,5 @@
|
||||
# Geo Map
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
@ -7,8 +7,8 @@ This note type displays the children notes on a geographical map, based on an at
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| 1 |  | Right click on any note on the note tree and select _Insert child note_ → _Geo Map (beta)_. |
|
||||
| 2 |  | By default the map will be empty and will show the entire world. |
|
||||
| 1 |  | Right click on any note on the note tree and select _Insert child note_ → _Geo Map (beta)_. |
|
||||
| 2 |  | By default the map will be empty and will show the entire world. |
|
||||
|
||||
## Repositioning the map
|
||||
|
||||
@ -21,16 +21,16 @@ The position on the map and the zoom are saved inside the map note and restored
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| 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 |  | 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 |  | Enter the name of the marker/note to be created. |
|
||||
| 4 |  | Once confirmed, the marker will show up on the map and it will also be displayed as a child note of the map. |
|
||||
| 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 |  | 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 |  | Enter the name of the marker/note to be created. |
|
||||
| 4 |  | Once confirmed, the marker will show up on the map and it will also be displayed as a child note of the map. |
|
||||
|
||||
## How the location of the markers is stored
|
||||
|
||||
The location of a marker is stored in the `#geolocation` attribute of the child notes:
|
||||
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
@ -70,9 +70,9 @@ The value of the attribute is made up of the latitude and longitude separated by
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| 1 |  | 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 |  | In Trilium, create a child note under the map. |
|
||||
| 3 |  | 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. |
|
||||
| 1 |  | 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 |  | In Trilium, create a child note under the map. |
|
||||
| 3 |  | 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
|
||||
|
||||
@ -82,7 +82,7 @@ Similarly to the Google Maps approach:
|
||||
| --- | --- | --- |
|
||||
| 1 |  | Go to any location on openstreetmap.org and right click to bring up the context menu. Select the “Show address” item. |
|
||||
| 2 |  | 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 |  | 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. |
|
||||
| 3 |  | 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)
|
||||
|
||||
@ -90,13 +90,13 @@ Trilium has basic support for displaying GPS tracks on the geo map.
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| 1 |  | To add a track, simply drag & drop a .gpx file inside the geo map in the note tree. |
|
||||
| 2 |  | 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 |  | 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. |
|
||||
| 1 |  | To add a track, simply drag & drop a .gpx file inside the geo map in the note tree. |
|
||||
| 2 |  | 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 |  | 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. |
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
|
||||
|
||||
|
||||
### Grid-like artifacts on the map
|
||||
|
||||
|
||||
@ -13,14 +13,7 @@ The Trilium text note interface does not display toolbars or formatting options
|
||||
|
||||
## Read-Only vs. Editing Mode
|
||||
|
||||
Text notes are usually opened in edit mode. However, they may open in read-only mode under the following circumstances:
|
||||
|
||||
* The note is long and would take time to load, so it is opened in read-only mode by default for quicker access.
|
||||
* The note has a `readOnly` [label](../Advanced%20Usage/Attributes.md).
|
||||
|
||||
In both cases, it is possible to switch back to editable mode using the button at top right of page.
|
||||
|
||||
For more information, see [Read-Only Notes](../Basic%20Concepts%20and%20Features/Notes/Read-Only%20Notes.md).
|
||||
Text notes are usually opened in edit mode. However, they may open in read-only mode if the note is too big or the note is explicitly marked as read-only. For more information, see [Read-Only Notes](../Basic%20Concepts%20and%20Features/Notes/Read-Only%20Notes.md).
|
||||
|
||||
## General Formatting
|
||||
|
||||
|
||||
117
src/public/app/doc_notes/en/User Guide/!!!meta.json
generated
@ -2432,20 +2432,6 @@
|
||||
"isInheritable": false,
|
||||
"position": 10
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "iPIMuisry3hd",
|
||||
"isInheritable": false,
|
||||
"position": 20
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "6f9hih2hXXZk",
|
||||
"isInheritable": false,
|
||||
"position": 30
|
||||
},
|
||||
{
|
||||
"type": "label",
|
||||
"name": "shareAlias",
|
||||
@ -2459,11 +2445,55 @@
|
||||
"value": "bx bx-edit-alt",
|
||||
"isInheritable": false,
|
||||
"position": 40
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "iPIMuisry3hd",
|
||||
"isInheritable": false,
|
||||
"position": 50
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "6f9hih2hXXZk",
|
||||
"isInheritable": false,
|
||||
"position": 60
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "BlN9DFI679QC",
|
||||
"isInheritable": false,
|
||||
"position": 70
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "XpOYSgsLkTJy",
|
||||
"isInheritable": false,
|
||||
"position": 80
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "4TIF1oA4VQRO",
|
||||
"isInheritable": false,
|
||||
"position": 100
|
||||
}
|
||||
],
|
||||
"format": "html",
|
||||
"dataFileName": "Read-Only Notes.html",
|
||||
"attachments": []
|
||||
"attachments": [
|
||||
{
|
||||
"attachmentId": "dUmc6vYfoQgZ",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "Read-Only Notes_image.png"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
@ -3718,13 +3748,6 @@
|
||||
"isInheritable": false,
|
||||
"position": 20
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "zEY4DaJG4YT5",
|
||||
"isInheritable": false,
|
||||
"position": 30
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
@ -5480,7 +5503,7 @@
|
||||
"dataFileName": "1_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "6wUkw5RWE39e",
|
||||
"attachmentId": "aCSNn9QlgHFi",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
@ -5488,7 +5511,7 @@
|
||||
"dataFileName": "2_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "aCSNn9QlgHFi",
|
||||
"attachmentId": "aCuXZY7WV4li",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
@ -5496,7 +5519,7 @@
|
||||
"dataFileName": "3_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "aCuXZY7WV4li",
|
||||
"attachmentId": "agH6yREFgsoU",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
@ -5504,7 +5527,7 @@
|
||||
"dataFileName": "4_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "agH6yREFgsoU",
|
||||
"attachmentId": "AHyDUM6R5HeG",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
@ -5512,7 +5535,7 @@
|
||||
"dataFileName": "5_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "AHyDUM6R5HeG",
|
||||
"attachmentId": "CcjWLhE3KKfv",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
@ -5520,7 +5543,7 @@
|
||||
"dataFileName": "6_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "CcjWLhE3KKfv",
|
||||
"attachmentId": "DapDey8gMiFc",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
@ -5528,7 +5551,7 @@
|
||||
"dataFileName": "7_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "DapDey8gMiFc",
|
||||
"attachmentId": "fQy8R1vxKhwN",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
@ -5536,28 +5559,20 @@
|
||||
"dataFileName": "8_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "fQy8R1vxKhwN",
|
||||
"attachmentId": "gJ4Yz80jxcbn",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "9_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "gJ4Yz80jxcbn",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "10_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "I39BinT2gsN9",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "11_Geo Map_image.png"
|
||||
"dataFileName": "10_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "IeXU8SLZU7Oz",
|
||||
@ -5573,7 +5588,7 @@
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "12_Geo Map_image.png"
|
||||
"dataFileName": "11_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "Mx2xwNIk76ZS",
|
||||
@ -5581,7 +5596,7 @@
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "13_Geo Map_image.png"
|
||||
"dataFileName": "12_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "oaahbsMRbqd2",
|
||||
@ -5589,7 +5604,7 @@
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "14_Geo Map_image.png"
|
||||
"dataFileName": "13_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "pGf1p74KKGU4",
|
||||
@ -5597,7 +5612,7 @@
|
||||
"role": "image",
|
||||
"mime": "image/jpg",
|
||||
"position": 10,
|
||||
"dataFileName": "15_Geo Map_image.png"
|
||||
"dataFileName": "14_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "tfa1TRUatWEh",
|
||||
@ -5605,15 +5620,7 @@
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "16_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "USbvJ38T4AKA",
|
||||
"title": "image.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "17_Geo Map_image.png"
|
||||
"dataFileName": "15_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "x6yBLIsY2LSv",
|
||||
@ -5621,7 +5628,7 @@
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "18_Geo Map_image.png"
|
||||
"dataFileName": "16_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "yJMyBRYA3Kwi",
|
||||
@ -5629,7 +5636,7 @@
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "19_Geo Map_image.png"
|
||||
"dataFileName": "17_Geo Map_image.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "ZvTlu9WMd37z",
|
||||
@ -5637,7 +5644,7 @@
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "20_Geo Map_image.png"
|
||||
"dataFileName": "18_Geo Map_image.png"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@ -13,20 +13,70 @@
|
||||
<h1 data-trilium-h1>Read-Only Notes</h1>
|
||||
|
||||
<div class="ck-content">
|
||||
<p>Both <a href="../../Note%20Types/Text.html">text</a> and <a href="../../Note%20Types/Code.html">code</a> notes
|
||||
in Trilium can be set to read-only. When a note is in read-only mode, it
|
||||
is presented to the user in a non-editable view, with the option to switch
|
||||
to editing mode if needed.</p>
|
||||
<h2>Setting Read-Only Mode with a Label</h2>
|
||||
<p>To set a note as read-only, add the <code>readOnly</code> <a href="../../Advanced%20Usage/Attributes.html">label</a> to
|
||||
the note.</p>
|
||||
<h2>Automatic Read-Only Mode</h2>
|
||||
<p>Some note types such as <a class="reference-link" href="../../Note%20Types/Text.html">Text</a> and
|
||||
<a
|
||||
class="reference-link" href="../../Note%20Types/Code.html">Code</a> notes in Trilium can be set to read-only. When a note is
|
||||
in read-only mode, it is presented to the user in a non-editable view,
|
||||
with the option to switch to editing mode if needed.</p>
|
||||
<h2>Automatic read-only mode</h2>
|
||||
<p>For optimization purposes, Trilium will automatically set very large notes
|
||||
to read-only. Displaying such lengthy notes in editing mode can slow down
|
||||
performance, especially when editing is unnecessary.</p>
|
||||
<p>If you want to ensure that a specific note remains editable regardless
|
||||
of its size, you can add the <code>autoReadOnlyDisabled</code> <a href="../../Advanced%20Usage/Attributes.html">label</a> to
|
||||
the note.</p>
|
||||
<p>This behavior can be disabled on a per-note basis, by following the instructions
|
||||
of the next section.</p>
|
||||
<p>In addition, it's possible to change the number of characters at which
|
||||
the automatic read-only mode will trigger in <a class="reference-link"
|
||||
href="../UI%20Elements/Options.html">Options</a> by going to the options
|
||||
for <a class="reference-link" href="../../Note%20Types/Text.html">Text</a> and
|
||||
<a
|
||||
class="reference-link" href="../../Note%20Types/Code.html">Code</a> notes.</p>
|
||||
<h2>Changing a note's read-only behavior</h2>
|
||||
<p>Via the <a class="reference-link" href="../UI%20Elements/Ribbon.html">Ribbon</a>,
|
||||
by going to the <em>Basic Properties</em> tab and looking for the <em>Editable</em> selection.
|
||||
The following options are possible:</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p><strong>Auto</strong>
|
||||
<br>This is the default behavior in which the note will be editable by default,
|
||||
unless it becomes large enough to trigger read-only mode.</p>
|
||||
<p> </p>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>Read-only</strong>
|
||||
<br>The note will be always marked as read-only, regardless of its size. Nevertheless,
|
||||
it's still possible to temporarily edit the note if needed. This is generally
|
||||
useful for notes that are not prone to change.</p>
|
||||
<p> </p>
|
||||
</li>
|
||||
<li><strong>Always Editable</strong>
|
||||
<br>This option will bypass the automatic read-only activation for this particular
|
||||
note. It's useful for large notes that are frequently edited.</li>
|
||||
</ul>
|
||||
<p>If the <em>Editable</em> section is missing from the ribbon, then the note
|
||||
type does not support read-only mode.</p>
|
||||
<h3>Manually setting the options</h3>
|
||||
<p>Apart from using the ribbon as previously mentioned, it's also possible
|
||||
to use <a href="../../Advanced%20Usage/Attributes.html">labels</a> to change
|
||||
the behavior:</p>
|
||||
<ul>
|
||||
<li>To set as read-only, apply the <code>readOnly</code> label to the note.</li>
|
||||
<li>To disable automatic read-only (always editable), apply the <code>autoReadOnlyDisabled</code> label.</li>
|
||||
</ul>
|
||||
<h2>Temporarily editing a read-only note</h2>
|
||||
<p>When accessing a read-only note, it's possible to temporarily edit it
|
||||
by using the
|
||||
<img src="Read-Only Notes_image.png" width="17" height="16">button in the <a class="reference-link" href="../UI%20Elements/Floating%20buttons.html">Floating buttons</a> area.</p>
|
||||
<p>When pressed, the note will become editable but will become read-only
|
||||
again after navigating to a different note.</p>
|
||||
<h2>Special read-only behavior</h2>
|
||||
<p>Some note types have a special behavior based on whether the read-only
|
||||
mode is enabled:</p>
|
||||
<ul>
|
||||
<li><a class="reference-link" href="#root/rswjxUmAz64R/aOI0RYfC3wic/ObWG9tSNscDb">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.html">Floating buttons</a> area.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
|
After Width: | Height: | Size: 429 B |
|
Before Width: | Height: | Size: 515 KiB After Width: | Height: | Size: 176 KiB |
|
Before Width: | Height: | Size: 176 KiB After Width: | Height: | Size: 815 B |
|
Before Width: | Height: | Size: 815 B After Width: | Height: | Size: 43 KiB |
|
Before Width: | Height: | Size: 43 KiB After Width: | Height: | Size: 117 KiB |
|
Before Width: | Height: | Size: 117 KiB After Width: | Height: | Size: 31 KiB |
|
Before Width: | Height: | Size: 31 KiB After Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 397 KiB |
|
Before Width: | Height: | Size: 4.2 KiB After Width: | Height: | Size: 359 B |
|
Before Width: | Height: | Size: 397 KiB After Width: | Height: | Size: 42 KiB |
|
Before Width: | Height: | Size: 359 B |
|
Before Width: | Height: | Size: 42 KiB |
|
Before Width: | Height: | Size: 8.8 KiB After Width: | Height: | Size: 323 KiB |
|
Before Width: | Height: | Size: 323 KiB After Width: | Height: | Size: 5.2 KiB |
|
Before Width: | Height: | Size: 5.2 KiB After Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 28 KiB |
|
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 102 KiB |
|
Before Width: | Height: | Size: 102 KiB After Width: | Height: | Size: 260 KiB |
|
Before Width: | Height: | Size: 260 KiB After Width: | Height: | Size: 35 KiB |
|
Before Width: | Height: | Size: 35 KiB After Width: | Height: | Size: 515 KiB |
@ -14,7 +14,7 @@
|
||||
|
||||
<div class="ck-content">
|
||||
<figure class="image">
|
||||
<img style="aspect-ratio:892/675;" src="11_Geo Map_image.png" width="892"
|
||||
<img style="aspect-ratio:892/675;" src="10_Geo Map_image.png" width="892"
|
||||
height="675">
|
||||
</figure>
|
||||
<p>This note type displays the children notes on a geographical map, based
|
||||
@ -34,14 +34,14 @@
|
||||
<tr>
|
||||
<td>1</td>
|
||||
<td>
|
||||
<img src="8_Geo Map_image.png">
|
||||
<img src="7_Geo Map_image.png">
|
||||
</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>
|
||||
<img src="10_Geo Map_image.png">
|
||||
<img src="9_Geo Map_image.png">
|
||||
</td>
|
||||
<td>By default the map will be empty and will show the entire world.</td>
|
||||
</tr>
|
||||
@ -76,18 +76,18 @@
|
||||
<td>1</td>
|
||||
<td colspan="2">To create a marker, first navigate to the desired point on the map. Then
|
||||
press the
|
||||
<img src="12_Geo Map_image.png" width="18" height="18">button in the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons.html">Floating buttons</a> (top-right)
|
||||
<img src="11_Geo Map_image.png" width="18" height="18">button in the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Floating%20buttons.html">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="19_Geo Map_image.png" width="11"
|
||||
<img src="17_Geo Map_image.png" width="11"
|
||||
height="10">) in the top-right of the map.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>2</td>
|
||||
<td>
|
||||
<img class="image_resized" style="aspect-ratio:1730/416;width:100%;" src="3_Geo Map_image.png"
|
||||
<img class="image_resized" style="aspect-ratio:1730/416;width:100%;" src="2_Geo Map_image.png"
|
||||
width="1730" height="416">
|
||||
</td>
|
||||
<td>Once pressed, the map will enter in the insert mode, as illustrated by
|
||||
@ -99,7 +99,7 @@
|
||||
<tr>
|
||||
<td>3</td>
|
||||
<td>
|
||||
<img class="image_resized" style="aspect-ratio:1586/404;width:100%;" src="9_Geo Map_image.png"
|
||||
<img class="image_resized" style="aspect-ratio:1586/404;width:100%;" src="8_Geo Map_image.png"
|
||||
width="1586" height="404">
|
||||
</td>
|
||||
<td>Enter the name of the marker/note to be created.</td>
|
||||
@ -108,7 +108,7 @@
|
||||
<td>4</td>
|
||||
<td>
|
||||
<img class="image_resized" style="aspect-ratio:1696/608;width:99.95%;"
|
||||
src="18_Geo Map_image.png" width="1696" height="608">
|
||||
src="16_Geo Map_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>
|
||||
@ -120,7 +120,7 @@
|
||||
<p>The location of a marker is stored in the <code>#geolocation</code> attribute
|
||||
of the child notes:</p>
|
||||
<p>
|
||||
<img src="20_Geo Map_image.png">
|
||||
<img src="18_Geo Map_image.png">
|
||||
</p>
|
||||
<p>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.</p>
|
||||
@ -178,7 +178,7 @@
|
||||
<tr>
|
||||
<td>1</td>
|
||||
<td>
|
||||
<img src="14_Geo Map_image.png">
|
||||
<img src="13_Geo Map_image.png">
|
||||
</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.
|
||||
@ -192,14 +192,14 @@
|
||||
<tr>
|
||||
<td>2</td>
|
||||
<td>
|
||||
<img src="5_Geo Map_image.png">
|
||||
<img src="4_Geo Map_image.png">
|
||||
</td>
|
||||
<td>In Trilium, create a child note under the map.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>3</td>
|
||||
<td>
|
||||
<img src="13_Geo Map_image.png">
|
||||
<img src="12_Geo Map_image.png">
|
||||
</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.
|
||||
@ -242,7 +242,7 @@
|
||||
<tr>
|
||||
<td>3</td>
|
||||
<td>
|
||||
<img src="6_Geo Map_image.png">
|
||||
<img src="5_Geo Map_image.png">
|
||||
</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>
|
||||
@ -266,7 +266,7 @@
|
||||
<tr>
|
||||
<td>1</td>
|
||||
<td>
|
||||
<img src="4_Geo Map_image.png">
|
||||
<img src="3_Geo Map_image.png">
|
||||
</td>
|
||||
<td>To add a track, simply drag & drop a .gpx file inside the geo map
|
||||
in the note tree.</td>
|
||||
@ -274,7 +274,7 @@
|
||||
<tr>
|
||||
<td>2</td>
|
||||
<td>
|
||||
<img src="16_Geo Map_image.png">
|
||||
<img src="15_Geo Map_image.png">
|
||||
</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>
|
||||
@ -282,7 +282,7 @@
|
||||
<tr>
|
||||
<td>3</td>
|
||||
<td>
|
||||
<img src="7_Geo Map_image.png">
|
||||
<img src="6_Geo Map_image.png">
|
||||
</td>
|
||||
<td>When going back to the map, the track should now be visible.
|
||||
<br>
|
||||
@ -293,7 +293,7 @@
|
||||
</figure>
|
||||
<h2>Troubleshooting</h2>
|
||||
<p>
|
||||
<img src="15_Geo Map_image.png">
|
||||
<img src="14_Geo Map_image.png">
|
||||
</p>
|
||||
<h3>Grid-like artifacts on the map</h3>
|
||||
<p>This occurs if the application is not at 100% zoom which causes the pixels
|
||||
|
||||
@ -28,16 +28,8 @@
|
||||
<img src="../Attachments/text-notes-formatting-bloc.png" alt="formating note block">2. Clicking on the block toolbar.</p>
|
||||
<h2>Read-Only vs. Editing Mode</h2>
|
||||
<p>Text notes are usually opened in edit mode. However, they may open in
|
||||
read-only mode under the following circumstances:</p>
|
||||
<ul>
|
||||
<li>The note is long and would take time to load, so it is opened in read-only
|
||||
mode by default for quicker access.</li>
|
||||
<li>The note has a <code>readOnly</code> <a href="../Advanced%20Usage/Attributes.html">label</a>.</li>
|
||||
</ul>
|
||||
<p>In both cases, it is possible to switch back to editable mode using the
|
||||
<img
|
||||
src="Text_bx-edit-alt.svg">button at top right of page.</p>
|
||||
<p>For more information, see <a href="../Basic%20Concepts%20and%20Features/Notes/Read-Only%20Notes.html">Read-Only Notes</a>.</p>
|
||||
read-only mode if the note is too big or the note is explicitly marked
|
||||
as read-only. For more information, see <a href="../Basic%20Concepts%20and%20Features/Notes/Read-Only%20Notes.html">Read-Only Notes</a>.</p>
|
||||
<h2>General Formatting</h2>
|
||||
<p>Since Trilium uses CKEditor, all of its formatting options are available
|
||||
here. You may use the graphical toolbar shown above, or enter formatting
|
||||
@ -47,7 +39,7 @@
|
||||
</li>
|
||||
<li><em>Italic</em>: Type <code>*text*</code> or <code>_text_</code>
|
||||
</li>
|
||||
<li><del>Strikethrough</del>: Type <code>~~text~~</code>
|
||||
<li><s>Strikethrough</s>: Type <code>~~text~~</code>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Lists</h3>
|
||||
|
||||