mirror of
https://github.com/zadam/trilium.git
synced 2025-10-27 00:06:30 +01:00
docs(help): document new features for collections
This commit is contained in:
7
docs/User Guide/!!!meta.json
vendored
7
docs/User Guide/!!!meta.json
vendored
@@ -1728,6 +1728,13 @@
|
||||
"value": "bx bx-menu",
|
||||
"isInheritable": false,
|
||||
"position": 10
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "MKmLg5x6xkor",
|
||||
"isInheritable": false,
|
||||
"position": 200
|
||||
}
|
||||
],
|
||||
"format": "markdown",
|
||||
|
||||
@@ -52,6 +52,10 @@ The contextual menu can operate:
|
||||
* Creates a copy of the note and its descendants.
|
||||
* This process is different from <a class="reference-link" href="../../Notes/Cloning%20Notes.md">Cloning Notes</a> since the duplicated note can be edited independently from the original.
|
||||
* An alternative to this, if done regularly, would be <a class="reference-link" href="../../../Advanced%20Usage/Templates.md">Templates</a>.
|
||||
* **Archive/Unarchive**
|
||||
* Marks a note as [archived](../../Notes/Archived%20Notes.md).
|
||||
* If the note is already archived, it will be unarchived instead.
|
||||
* Multiple notes can be selected as well. However, all the selected notes must be in the same state (archived or not), otherwise the option will be disabled.
|
||||
* **Delete**
|
||||
* Will delete the given notes, asking for confirmation first.
|
||||
* In the dialog, the following options can be configured:
|
||||
|
||||
@@ -47,6 +47,12 @@ By default, collections come with a default configuration and sometimes even sam
|
||||
3. Still in the ribbon, go to _Collection Properties_ and select the desired view type.
|
||||
4. Consult the help page of the corresponding view type in order to understand how to configure them.
|
||||
|
||||
## Archived notes
|
||||
|
||||
By default, archived notes will not be shown in collections. This behaviour can be changed by going to _Collection Properties_ in the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">Ribbon</a> and checking _Show archived notes_.
|
||||
|
||||
Archived notes will be generally indicated by being greyed out as opposed to the normal ones.
|
||||
|
||||
## Under the hood
|
||||
|
||||
Collections by themselves are simply notes with no content that rely on the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/Notes/Note%20List.md">Note List</a> mechanism (the one that lists the children notes at the bottom of a note) to display information.
|
||||
|
||||
@@ -12,7 +12,7 @@ Notes are displayed recursively, so even the child notes of the child notes will
|
||||
## Interaction with columns
|
||||
|
||||
* Create a new column by pressing _Add Column_ near the last column.
|
||||
* Once pressed, a text box will be displayed to set the name of the column. Press Enter to confirm.
|
||||
* Once pressed, a text box will be displayed to set the name of the column. Press <kbd>Enter</kbd> to confirm, or <kbd>Escape</kbd> to dismiss.
|
||||
* To reorder a column, simply hold the mouse over the title and drag it to the desired position.
|
||||
* To delete a column, right click on its title and select _Delete column_.
|
||||
* To rename a column, click on the note title.
|
||||
@@ -23,8 +23,10 @@ Notes are displayed recursively, so even the child notes of the child notes will
|
||||
## Interaction with notes
|
||||
|
||||
* Create a new note in any column by pressing _New item_
|
||||
* Enter the name of the note and press _Enter_.
|
||||
* Doing so will create a new note. The new note will have an attribute (`status` label by default) set to the name of the column.
|
||||
* Enter the name of the note and press <kbd>Enter</kbd> or click away. To dismiss the creation of a new note, simply press <kbd>Escape</kbd> or leave the name empty.
|
||||
* Once created, the new note will have an attribute (`status` label by default) set to the name of the column.
|
||||
* To open the note, simply click on it.
|
||||
* To change the title of the note directly from the board, hover the mouse over its card and press the edit button on the right.
|
||||
* To change the state of a note, simply drag a note from one column to the other to change its state.
|
||||
* The order of the notes in each column corresponds to their position in the tree.
|
||||
* It's possible to reorder notes simply by dragging them to the desired position within the same columns.
|
||||
@@ -33,6 +35,7 @@ Notes are displayed recursively, so even the child notes of the child notes will
|
||||
* Open the note in a new tab/split/window or quick edit.
|
||||
* Move the note to any column.
|
||||
* Insert a new note above/below the current one.
|
||||
* Archive/unarchive the current note.
|
||||
* Delete the current note.
|
||||
* If there are many notes within the column, move the mouse over the column and use the mouse wheel to scroll.
|
||||
|
||||
|
||||
@@ -26,8 +26,8 @@ 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 | <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. |
|
||||
| 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. |
|
||||
|
||||
@@ -50,6 +50,9 @@ This works for:
|
||||
* 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.
|
||||
|
||||
> [!NOTE]
|
||||
> Dragging existing notes only works if the map is in editing mode. See the _Read-only_ section for more information.
|
||||
|
||||
## How the location of the markers is stored
|
||||
|
||||
The location of a marker is stored in the `#geolocation` attribute of the child notes:
|
||||
@@ -106,7 +109,7 @@ The value of the attribute is made up of the latitude and longitude separated by
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| 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). |
|
||||
| 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. |
|
||||
|
||||
@@ -117,7 +120,7 @@ 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. |
|
||||
| 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)
|
||||
@@ -128,7 +131,7 @@ 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. |
|
||||
| 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.
|
||||
|
||||
@@ -65,7 +65,8 @@ There are multiple menus:
|
||||
* Adding new columns.
|
||||
* Right clicking on a row, allows:
|
||||
* Opening the corresponding note of the row in a new tab, split, window or quick editing it.
|
||||
* Inserting rows above, below or as a child note.
|
||||
* Inserting a new note above or below the selected row. These options are only enabled if the table is not sorted.
|
||||
* Inserting a new child note for the selected row.
|
||||
* Deleting the row.
|
||||
|
||||
### Editing data
|
||||
|
||||
Reference in New Issue
Block a user