diff --git a/docs/User Guide/!!!meta.json b/docs/User Guide/!!!meta.json index 047f6c807..ee524ea75 100644 --- a/docs/User Guide/!!!meta.json +++ b/docs/User Guide/!!!meta.json @@ -1265,19 +1265,159 @@ "type": "text", "mime": "text/html", "attributes": [ - { - "type": "relation", - "name": "internalLink", - "value": "4TIF1oA4VQRO", - "isInheritable": false, - "position": 10 - }, { "type": "label", "name": "iconClass", "value": "bx bx-dots-horizontal", "isInheritable": false, "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "KSZ04uQ2D1St", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "4FahAwuGTAwC", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "bwg0e8ewQMak", + "isInheritable": false, + "position": 50 + }, + { + "type": "relation", + "name": "internalLink", + "value": "CoFPLs3dRlXc", + "isInheritable": false, + "position": 60 + }, + { + "type": "relation", + "name": "internalLink", + "value": "xYmIYSP6wE3F", + "isInheritable": false, + "position": 70 + }, + { + "type": "relation", + "name": "internalLink", + "value": "u3YFHC9tQlpm", + "isInheritable": false, + "position": 80 + }, + { + "type": "relation", + "name": "internalLink", + "value": "WOcw2SLH6tbX", + "isInheritable": false, + "position": 90 + }, + { + "type": "relation", + "name": "internalLink", + "value": "R9pX4DGra2Vt", + "isInheritable": false, + "position": 100 + }, + { + "type": "relation", + "name": "internalLink", + "value": "KC1HB96bqqHX", + "isInheritable": false, + "position": 110 + }, + { + "type": "relation", + "name": "internalLink", + "value": "veGu4faJErEM", + "isInheritable": false, + "position": 120 + }, + { + "type": "relation", + "name": "internalLink", + "value": "nRhnJkTT8cPs", + "isInheritable": false, + "position": 130 + }, + { + "type": "relation", + "name": "internalLink", + "value": "zEY4DaJG4YT5", + "isInheritable": false, + "position": 140 + }, + { + "type": "relation", + "name": "internalLink", + "value": "OFXdgB2nNk1F", + "isInheritable": false, + "position": 150 + }, + { + "type": "relation", + "name": "internalLink", + "value": "bwZpz2ajCEwO", + "isInheritable": false, + "position": 160 + }, + { + "type": "relation", + "name": "internalLink", + "value": "IakOLONlIfGI", + "isInheritable": false, + "position": 170 + }, + { + "type": "relation", + "name": "internalLink", + "value": "oPVyFC7WL2Lp", + "isInheritable": false, + "position": 180 + }, + { + "type": "relation", + "name": "internalLink", + "value": "xWtq5NUHOwql", + "isInheritable": false, + "position": 190 + }, + { + "type": "relation", + "name": "internalLink", + "value": "m1lbrzyKDaRB", + "isInheritable": false, + "position": 200 + }, + { + "type": "relation", + "name": "internalLink", + "value": "wX4HbRucYSDD", + "isInheritable": false, + "position": 210 + }, + { + "type": "relation", + "name": "internalLink", + "value": "4TIF1oA4VQRO", + "isInheritable": false, + "position": 220 + }, + { + "type": "relation", + "name": "internalLink", + "value": "l0tKav7yLHGF", + "isInheritable": false, + "position": 230 } ], "format": "markdown", @@ -2420,6 +2560,34 @@ "dataFileName": "1_Workspace_image.png" } ] + }, + { + "isClone": false, + "noteId": "xWtq5NUHOwql", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "wArbEsdSae6g", + "xWtq5NUHOwql" + ], + "title": "Similar Notes", + "notePosition": 80, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "label", + "name": "iconClass", + "value": "bx bx-bar-chart", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "Similar Notes.md", + "attachments": [] } ] }, @@ -7194,6 +7362,33 @@ "attachments": [] } ] + }, + { + "isClone": false, + "noteId": "m1lbrzyKDaRB", + "notePath": [ + "pOsGYCXsbNQG", + "tC7s2alapj8V", + "m1lbrzyKDaRB" + ], + "title": "Note ID", + "notePosition": 180, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "label", + "name": "iconClass", + "value": "bx bx-hash", + "isInheritable": false, + "position": 10 + } + ], + "format": "markdown", + "dataFileName": "Note ID.md", + "attachments": [] } ] }, diff --git a/docs/User Guide/User Guide/Advanced Usage/Note ID.md b/docs/User Guide/User Guide/Advanced Usage/Note ID.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/User Guide/User Guide/Basic Concepts and Features/Navigation/Similar Notes.md b/docs/User Guide/User Guide/Basic Concepts and Features/Navigation/Similar Notes.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Ribbon.md b/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Ribbon.md index e99138df6..4109d8166 100644 --- a/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Ribbon.md +++ b/docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Ribbon.md @@ -5,4 +5,60 @@ The ribbon allows changing options, attributes and viewing information about the ## Settings -It is possible to change whether some ribbon items will be automatically open when navigating to a new note. To do so, in [Settings](Options.md), go to _Appearance_ and look for the _Ribbon widgets_ section. \ No newline at end of file +It is possible to change whether some ribbon items will be automatically open when navigating to a new note. To do so, in [Settings](Options.md), go to _Appearance_ and look for the _Ribbon widgets_ section. + +## Formatting + +If you are using the _Fixed_ formatting toolbar, all the formatting buttons for text notes will appear here. See [Formatting toolbar](../../Note%20Types/Text/Formatting%20toolbar.md) for more information. + +## Tabs + +### Basic Properties + +* _**Note type**_ allows changing the [note type](../../Note%20Types) of a note. + * Generally this is desirable only if the note is empty. + * As a more advanced use, it's possible to change the note type in order to modify the [source code](../../Advanced%20Usage/Note%20source.md) of a note. +* _**Protect the note**_ toggles whether the current note is encrypted and accessible only by entering the protected session. See [Protected Notes](../Notes/Protected%20Notes.md) for more information. +* _**Editable**_ changes whether the current note: + * Enters [read-only mode](../Notes/Read-Only%20Notes.md) automatically if the note is too big (default behaviour). + * Is always in read-only mode (however it can still be edited temporarily). + * Is always editable, regardless of its size. +* _**Bookmark**_ toggles the display of the current note into the [Launch Bar](Launch%20Bar.md) for easy access. See [Bookmarks](../Navigation/Bookmarks.md) for more information. +* _**Shared**_ toggles whether the current note is publicly accessible if you have a [server instance](../../Installation%20%26%20Setup/Server%20Installation.md) set up. See [Sharing](../../Advanced%20Usage/Sharing.md) for more information. +* _**Template**_ toggles whether the current note is considered a template and can be used to easily create notes with the same content. See [Template](../../Advanced%20Usage/Attributes/Template.md) for more information. +* _**Language**_ changes the main language of the current note, mostly useful for spell checking or right-to-left support. See [Content language & Right-to-left support](../../Note%20Types/Text/Content%20language%20%26%20Right-to-le.md) for more information. + +### Owned Attributes + +This section allows editing the labels and relations of a note. For more information, see [Attributes](../../Advanced%20Usage/Attributes.md). + +The plus button to the right offers a simplified way to insert labels and relations, via a graphical input. From this menu, it's also possible to define label and relation definitions (see [Promoted Attributes](../../Advanced%20Usage/Attributes/Promoted%20Attributes.md)). + +### Inherited Attributes + +This section displays the attributes which are applied to this note via [Attribute Inheritance](../../Advanced%20Usage/Attributes/Attribute%20Inheritance.md). It is not possible to alter the attributes from this section. + +### Note Paths + +This section displays all the places where the current note has been cloned to. Here the current note can also be cloned to a new location (similar to the [Note Tree](Note%20Tree.md)) See [Cloning Notes](../Notes/Cloning%20Notes.md) for more information. + +### Note Map + +The note map displays all the relations of the current note to other notes, as well as the subtree structure. See [Note Tree](Note%20Tree.md) for more information. + +### Similar Notes + +This section lists all the notes that are similar to the current one. See [Similar Notes](../Navigation/Similar%20Notes.md) for more information. + +### Note Info + +This section displays information about the current note: + +* The [internal ID](../../Advanced%20Usage/Note%20ID.md) of the note. +* The [type of the note](../../Note%20Types), as well as its MIME type (used mostly for exporting notes). +* The created and modification dates. +* The estimated size of the note in the [Database](../../Advanced%20Usage/Database.md), as well as its children count and size. + +### Edited notes + +This section pops automatically when entering a [day note](../../Advanced%20Usage/Advanced%20Showcases/Day%20Notes.md) and shows the notes that were edited that day. \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/!!!meta.json b/src/public/app/doc_notes/en/User Guide/!!!meta.json index b1974eaa4..5fea531ba 100644 --- a/src/public/app/doc_notes/en/User Guide/!!!meta.json +++ b/src/public/app/doc_notes/en/User Guide/!!!meta.json @@ -1265,19 +1265,159 @@ "type": "text", "mime": "text/html", "attributes": [ - { - "type": "relation", - "name": "internalLink", - "value": "4TIF1oA4VQRO", - "isInheritable": false, - "position": 10 - }, { "type": "label", "name": "iconClass", "value": "bx bx-dots-horizontal", "isInheritable": false, "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "KSZ04uQ2D1St", + "isInheritable": false, + "position": 30 + }, + { + "type": "relation", + "name": "internalLink", + "value": "4FahAwuGTAwC", + "isInheritable": false, + "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "bwg0e8ewQMak", + "isInheritable": false, + "position": 50 + }, + { + "type": "relation", + "name": "internalLink", + "value": "CoFPLs3dRlXc", + "isInheritable": false, + "position": 60 + }, + { + "type": "relation", + "name": "internalLink", + "value": "xYmIYSP6wE3F", + "isInheritable": false, + "position": 70 + }, + { + "type": "relation", + "name": "internalLink", + "value": "u3YFHC9tQlpm", + "isInheritable": false, + "position": 80 + }, + { + "type": "relation", + "name": "internalLink", + "value": "WOcw2SLH6tbX", + "isInheritable": false, + "position": 90 + }, + { + "type": "relation", + "name": "internalLink", + "value": "R9pX4DGra2Vt", + "isInheritable": false, + "position": 100 + }, + { + "type": "relation", + "name": "internalLink", + "value": "KC1HB96bqqHX", + "isInheritable": false, + "position": 110 + }, + { + "type": "relation", + "name": "internalLink", + "value": "veGu4faJErEM", + "isInheritable": false, + "position": 120 + }, + { + "type": "relation", + "name": "internalLink", + "value": "nRhnJkTT8cPs", + "isInheritable": false, + "position": 130 + }, + { + "type": "relation", + "name": "internalLink", + "value": "zEY4DaJG4YT5", + "isInheritable": false, + "position": 140 + }, + { + "type": "relation", + "name": "internalLink", + "value": "OFXdgB2nNk1F", + "isInheritable": false, + "position": 150 + }, + { + "type": "relation", + "name": "internalLink", + "value": "bwZpz2ajCEwO", + "isInheritable": false, + "position": 160 + }, + { + "type": "relation", + "name": "internalLink", + "value": "IakOLONlIfGI", + "isInheritable": false, + "position": 170 + }, + { + "type": "relation", + "name": "internalLink", + "value": "oPVyFC7WL2Lp", + "isInheritable": false, + "position": 180 + }, + { + "type": "relation", + "name": "internalLink", + "value": "xWtq5NUHOwql", + "isInheritable": false, + "position": 190 + }, + { + "type": "relation", + "name": "internalLink", + "value": "m1lbrzyKDaRB", + "isInheritable": false, + "position": 200 + }, + { + "type": "relation", + "name": "internalLink", + "value": "wX4HbRucYSDD", + "isInheritable": false, + "position": 210 + }, + { + "type": "relation", + "name": "internalLink", + "value": "4TIF1oA4VQRO", + "isInheritable": false, + "position": 220 + }, + { + "type": "relation", + "name": "internalLink", + "value": "l0tKav7yLHGF", + "isInheritable": false, + "position": 230 } ], "format": "html", @@ -2420,6 +2560,34 @@ "dataFileName": "1_Workspace_image.png" } ] + }, + { + "isClone": false, + "noteId": "xWtq5NUHOwql", + "notePath": [ + "pOsGYCXsbNQG", + "gh7bpGYxajRS", + "wArbEsdSae6g", + "xWtq5NUHOwql" + ], + "title": "Similar Notes", + "notePosition": 80, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "label", + "name": "iconClass", + "value": "bx bx-bar-chart", + "isInheritable": false, + "position": 10 + } + ], + "format": "html", + "dataFileName": "Similar Notes.html", + "attachments": [] } ] }, @@ -7194,6 +7362,33 @@ "attachments": [] } ] + }, + { + "isClone": false, + "noteId": "m1lbrzyKDaRB", + "notePath": [ + "pOsGYCXsbNQG", + "tC7s2alapj8V", + "m1lbrzyKDaRB" + ], + "title": "Note ID", + "notePosition": 180, + "prefix": null, + "isExpanded": false, + "type": "text", + "mime": "text/html", + "attributes": [ + { + "type": "label", + "name": "iconClass", + "value": "bx bx-hash", + "isInheritable": false, + "position": 10 + } + ], + "format": "html", + "dataFileName": "Note ID.html", + "attachments": [] } ] }, diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Note ID.html b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Note ID.html new file mode 100644 index 000000000..b2c3dbec9 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Advanced Usage/Note ID.html @@ -0,0 +1,19 @@ + + + + + + + + Note ID + + + +
+

Note ID

+ +
+
+ + + \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Navigation/Similar Notes.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Navigation/Similar Notes.html new file mode 100644 index 000000000..e3b2186b4 --- /dev/null +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Navigation/Similar Notes.html @@ -0,0 +1,19 @@ + + + + + + + + Similar Notes + + + +
+

Similar Notes

+ +
+
+ + + \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Ribbon.html b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Ribbon.html index ae7d4803c..d31e04e54 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Ribbon.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Ribbon.html @@ -22,6 +22,92 @@

It is possible to change whether some ribbon items will be automatically open when navigating to a new note. To do so, in Settings, go to Appearance and look for the Ribbon widgets section.

+

Formatting

+

If you are using the Fixed formatting toolbar, all the formatting + buttons for text notes will appear here. See Formatting toolbar for + more information.

+

Tabs

+

Basic Properties

+ +

Owned Attributes

+

This section allows editing the labels and relations of a note. For more + information, see Attributes.

+

The plus button to the right offers a simplified way to insert labels + and relations, via a graphical input. From this menu, it's also possible + to define label and relation definitions (see Promoted Attributes).

+

Inherited Attributes

+

This section displays the attributes which are applied to this note via  + Attribute Inheritance. It is not possible to alter the attributes + from this section.

+

Note Paths

+

This section displays all the places where the current note has been cloned + to. Here the current note can also be cloned to a new location (similar + to the Note Tree) + See Cloning Notes for + more information.

+

Note Map

+

The note map displays all the relations of the current note to other notes, + as well as the subtree structure. See Note Tree for + more information.

+

Similar Notes

+

This section lists all the notes that are similar to the current one. + See Similar Notes for + more information.

+

Note Info

+

This section displays information about the current note:

+ +

Edited notes

+

This section pops automatically when entering a day note and + shows the notes that were edited that day.

diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Geo map.html b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Geo map.html index e3cf9db68..066d9a652 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Geo map.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Geo map.html @@ -14,34 +14,33 @@

Creating a new geo map

-
- - - - - - - - - - - - - - - - - - - - -
   
1 - - Right click on any note on the note tree and select Insert child noteGeo Map (beta).
2 - - By default the map will be empty and will show the entire world.
-
-

Repositioning the map

+ + + + + + + + + + + + + + + + + + + + +
1 + + Right click on any note on the note tree and select Insert child noteGeo Map (beta).
2 + + By default the map will be empty and will show the entire world.
+ +

Repositioning the map

Icon and color of the markers

-
- image -
+

+ image +

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.

@@ -150,141 +147,137 @@

The value of the attribute is made up of the latitude and longitude separated by a comma.

Adding from Google Maps

-
- - - - - - - - - - - - - - - - - - - - - - - - - -
   
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.   -
-
Simply click on the first item displaying the coordinates and they will - be copied to clipboard.   -
-
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

+ + + + + + + + + + + + + + + + + + + + + + + + + +
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.   +
+
Simply click on the first item displaying the coordinates and they will + be copied to clipboard.   +
+
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

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

Adding GPS tracks (.gpx)

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

Adding GPS tracks (.gpx)

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.   -
-
The start and end points of the track are indicated by the two blue markers.
-
-

Troubleshooting

-

- -

-

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 Ctrl+0).

+ + + + + + + + + + + + + + + + + + + + + + + + + +
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.   +
+
The start and end points of the track are indicated by the two blue markers.
+ +

Troubleshooting

+

+ +

+

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 Ctrl+0).

diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme.html b/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme.html index b4e9cb7bc..32fcf1711 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Theme development/Creating a custom theme.html @@ -19,52 +19,42 @@ keep them into one place.

As such, the first step is to create a new note to gather all the themes.

- +

Step 2. Create the theme

-
- - - - - - - - - - - - - - - - - - - - - -
  
-
- -
-
Themes are code notes with a special attribute. Start by creating a new - code note.
-
- -
-
Then change the note type to a CSS code.
-
- -
-
In the Owned Attributes section define the #appTheme attribute - to point to any desired name. This is the name that will show up in the - appearance section in settings.
-
-

Step 3. Define the theme's CSS

+ + + + + + + + + + + + + + + + + + + + + +
+ + Themes are code notes with a special attribute. Start by creating a new + code note.
+ + Then change the note type to a CSS code.
+ + In the Owned Attributes section define the #appTheme attribute + to point to any desired name. This is the name that will show up in the + appearance section in settings.
+ +

Step 3. Define the theme's CSS

As a very simple example we will change the background color of the launcher pane to a shade of blue.

To alter the different variables of the theme:

:root {
@@ -74,11 +64,11 @@
         

Refresh the application (Ctrl+Shift+R is a good way to do so) and go to settings. You should see the newly created theme:

- +

Afterwards the application will refresh itself with the new theme:

- +

Do note that the theme will be based off of the legacy theme. To override that and base the theme on the new TriliumNext theme, see: Theme base (legacy vs. next) diff --git a/src/public/app/doc_notes/en/User Guide/navigation.html b/src/public/app/doc_notes/en/User Guide/navigation.html index 58d3d6300..ee04b1043 100644 --- a/src/public/app/doc_notes/en/User Guide/navigation.html +++ b/src/public/app/doc_notes/en/User Guide/navigation.html @@ -156,6 +156,9 @@

  • Workspace
  • +
  • Similar Notes +
  • +
  • Note ID +
  • Attachments