diff --git a/docs/User Guide/User Guide/Note Types/Book/10_Calendar View_image.png b/docs/User Guide/User Guide/Note Types/Book/10_Calendar View_image.png index 23a383270..e050184a7 100644 Binary files a/docs/User Guide/User Guide/Note Types/Book/10_Calendar View_image.png and b/docs/User Guide/User Guide/Note Types/Book/10_Calendar View_image.png differ diff --git a/docs/User Guide/User Guide/Note Types/Book/11_Calendar View_image.png b/docs/User Guide/User Guide/Note Types/Book/11_Calendar View_image.png index 2dea53b64..53ac5632f 100644 Binary files a/docs/User Guide/User Guide/Note Types/Book/11_Calendar View_image.png and b/docs/User Guide/User Guide/Note Types/Book/11_Calendar View_image.png differ diff --git a/docs/User Guide/User Guide/Note Types/Book/12_Calendar View_image.png b/docs/User Guide/User Guide/Note Types/Book/12_Calendar View_image.png deleted file mode 100644 index e050184a7..000000000 Binary files a/docs/User Guide/User Guide/Note Types/Book/12_Calendar View_image.png and /dev/null differ diff --git a/docs/User Guide/User Guide/Note Types/Book/13_Calendar View_image.png b/docs/User Guide/User Guide/Note Types/Book/13_Calendar View_image.png deleted file mode 100644 index 46698faac..000000000 Binary files a/docs/User Guide/User Guide/Note Types/Book/13_Calendar View_image.png and /dev/null differ diff --git a/docs/User Guide/User Guide/Note Types/Book/14_Calendar View_image.png b/docs/User Guide/User Guide/Note Types/Book/14_Calendar View_image.png deleted file mode 100644 index 53ac5632f..000000000 Binary files a/docs/User Guide/User Guide/Note Types/Book/14_Calendar View_image.png and /dev/null differ diff --git a/docs/User Guide/User Guide/Note Types/Book/5_Calendar View_image.png b/docs/User Guide/User Guide/Note Types/Book/5_Calendar View_image.png index f60aa0acc..7e97245a6 100644 Binary files a/docs/User Guide/User Guide/Note Types/Book/5_Calendar View_image.png and b/docs/User Guide/User Guide/Note Types/Book/5_Calendar View_image.png differ diff --git a/docs/User Guide/User Guide/Note Types/Book/6_Calendar View_image.png b/docs/User Guide/User Guide/Note Types/Book/6_Calendar View_image.png index 71f7d2dc3..d588ed568 100644 Binary files a/docs/User Guide/User Guide/Note Types/Book/6_Calendar View_image.png and b/docs/User Guide/User Guide/Note Types/Book/6_Calendar View_image.png differ diff --git a/docs/User Guide/User Guide/Note Types/Book/7_Calendar View_image.png b/docs/User Guide/User Guide/Note Types/Book/7_Calendar View_image.png index 7e97245a6..acf382206 100644 Binary files a/docs/User Guide/User Guide/Note Types/Book/7_Calendar View_image.png and b/docs/User Guide/User Guide/Note Types/Book/7_Calendar View_image.png differ diff --git a/docs/User Guide/User Guide/Note Types/Book/8_Calendar View_image.png b/docs/User Guide/User Guide/Note Types/Book/8_Calendar View_image.png index d588ed568..23a383270 100644 Binary files a/docs/User Guide/User Guide/Note Types/Book/8_Calendar View_image.png and b/docs/User Guide/User Guide/Note Types/Book/8_Calendar View_image.png differ diff --git a/docs/User Guide/User Guide/Note Types/Book/9_Calendar View_image.png b/docs/User Guide/User Guide/Note Types/Book/9_Calendar View_image.png index acf382206..2dea53b64 100644 Binary files a/docs/User Guide/User Guide/Note Types/Book/9_Calendar View_image.png and b/docs/User Guide/User Guide/Note Types/Book/9_Calendar View_image.png differ diff --git a/docs/User Guide/User Guide/Note Types/Book/Calendar View.md b/docs/User Guide/User Guide/Note Types/Book/Calendar View.md index e2e7d2720..0d47956bc 100644 --- a/docs/User Guide/User Guide/Note Types/Book/Calendar View.md +++ b/docs/User Guide/User Guide/Note Types/Book/Calendar View.md @@ -1,4 +1,4 @@ -# Calendar View +# Calendar View ![](4_Calendar%20View_image.png) The Calendar view of Book notes will display each child note in a calendar that has a start date and optionally an end date, as an event. @@ -30,7 +30,7 @@ Unlike other Book view types, the Calendar view also allows some kind of interac ## Interacting with events * Hovering the mouse over an event will display information about the note. - ![](9_Calendar%20View_image.png) + ![](7_Calendar%20View_image.png) * Left clicking the event will go to that note. Middle clicking will open the note in a new tab and 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. @@ -56,8 +56,8 @@ For each note of the calendar, the following attributes can be used: | `#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, either a label (e.g. `#assignee`) or a relation (e.g. `~for`). See _Advanced use-cases_ for more information. | -| `#calendar:displayedAttributes` | Allows displaying the value of one or more attributes in the calendar like this:  

![](11_Calendar%20View_image.png) 

`#weight="70" #Mood="Good" #calendar:displayedAttributes="weight,Mood"`

It can also be used with relations, case in which it will display the title of the target note: 

`~assignee=@My assignee #calendar:displayedAttributes="assignee"` | +| `#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:   

![](9_Calendar%20View_image.png)  

`#weight="70" #Mood="Good" #calendar:displayedAttributes="weight,Mood"` 

It can also be used with relations, case in which it will display the title of the target note:  

`~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. | @@ -65,7 +65,7 @@ For each note of the calendar, the following attributes can be used: ## How the calendar works -![](14_Calendar%20View_image.png) +![](11_Calendar%20View_image.png) The calendar displays all the child notes of the book that have a `#startDate`. An `#endDate` can optionally be added. @@ -79,7 +79,7 @@ If editing the start date and end date from the note itself is desirable, the fo This will result in: -![](12_Calendar%20View_image.png) +![](10_Calendar%20View_image.png) 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. @@ -96,30 +96,28 @@ Based on the `#calendarRoot` (or `#workspaceCalendarRoot`) attribute, the calend * 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. -![](10_Calendar%20View_image.png) +![](8_Calendar%20View_image.png) ### 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/book note), with the value being `#name` where `name` can be any label. 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. +To do so, assign `#calendar:title` to the child note (not the calendar/book 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. -| | | -| --- | --- | -| ![](5_Calendar%20View_image.png) | ![](7_Calendar%20View_image.png) | +
  
#startDate=2025-02-11 #endDate=2025-02-13 #name="My vacation" #calendar:title="name"
### 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. +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. | | | | --- | --- | -| ![](6_Calendar%20View_image.png) | ![](8_Calendar%20View_image.png) | +| `#startDate=2025-02-14 #endDate=2025-02-15 ~for=@John Smith ~for=@Jane Doe #calendar:title="for"` | ![](6_Calendar%20View_image.png) | 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). | | | | --- | --- | -| ![](13_Calendar%20View_image.png) | ![](1_Calendar%20View_image.png) | \ No newline at end of file +| `#calendar:title="shortName" #shortName="John S."` | ![](1_Calendar%20View_image.png) | \ No newline at end of file diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/10_Calendar View_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/10_Calendar View_image.png index 23a383270..e050184a7 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/10_Calendar View_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/10_Calendar View_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/11_Calendar View_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/11_Calendar View_image.png index 2dea53b64..53ac5632f 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/11_Calendar View_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/11_Calendar View_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/12_Calendar View_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/12_Calendar View_image.png deleted file mode 100644 index e050184a7..000000000 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/12_Calendar View_image.png and /dev/null differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/13_Calendar View_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/13_Calendar View_image.png deleted file mode 100644 index 46698faac..000000000 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/13_Calendar View_image.png and /dev/null differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/14_Calendar View_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/14_Calendar View_image.png deleted file mode 100644 index 53ac5632f..000000000 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/14_Calendar View_image.png and /dev/null differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/5_Calendar View_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/5_Calendar View_image.png index f60aa0acc..7e97245a6 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/5_Calendar View_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/5_Calendar View_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/6_Calendar View_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/6_Calendar View_image.png index 71f7d2dc3..d588ed568 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/6_Calendar View_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/6_Calendar View_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/7_Calendar View_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/7_Calendar View_image.png index 7e97245a6..acf382206 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/7_Calendar View_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/7_Calendar View_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/8_Calendar View_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/8_Calendar View_image.png index d588ed568..23a383270 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/8_Calendar View_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/8_Calendar View_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/9_Calendar View_image.png b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/9_Calendar View_image.png index acf382206..2dea53b64 100644 Binary files a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/9_Calendar View_image.png and b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/9_Calendar View_image.png differ diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/Calendar View.html b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/Calendar View.html index 20b049999..f2f1edde0 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/Calendar View.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Book/Calendar View.html @@ -82,7 +82,7 @@

Configuring the calendar

The following attributes can be added to the book type:

-
- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
#calendar:hideWeekends - When present (regardless of value), it will hide Saturday and Sundays - from the calendar.
#calendar:weekNumbers - When present (regardless of value), it will show the number of the week - on the calendar.
#calendar:view - -

Which view to display in the calendar:

-
    -
  • timeGridWeek for the week view;
    • -
  • dayGridMonth for the month view;
    • -
  • multiMonthYear for the year view;
    • -
  • listMonth for the list view.
    • -
-

Any other value will be dismissed and the default view (month) will be - used instead.

-

The value of this label is automatically updated when changing the view - using the UI buttons.

-
~child:template - Defines the template for newly created notes in the calendar (via dragging - or clicking).
-
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription
#calendar:hideWeekends + When present (regardless of value), it will hide Saturday and Sundays + from the calendar.
#calendar:weekNumbers + When present (regardless of value), it will show the number of the week + on the calendar.
#calendar:view + +

Which view to display in the calendar:

+
    +
  • timeGridWeek for the week view;
    • +
  • dayGridMonth for the month view;
    • +
  • multiMonthYear for the year view;
    • +
  • listMonth for the list view.
    • +
+

Any other value will be dismissed and the default view (month) will be + used instead.

+

The value of this label is automatically updated when changing the view + using the UI buttons.

+
~child:template + Defines the template for newly created notes in the calendar (via dragging + or clicking).
+
+

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

@@ -204,22 +206,22 @@ #calendar:title Changes the title of an event to point to an attribute of the note other - than the title, either a label (e.g. #assignee) or a relation - (e.g. ~for). See Advanced use-cases for more information. + 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:   + like this:   

-   +  
-
#weight="70" #Mood="Good" #calendar:displayedAttributes="weight,Mood" +
#weight="70" #Mood="Good" #calendar:displayedAttributes="weight,Mood" 

It can also be used with relations, case in which it will display the - title of the target note:  + title of the target note:  

~assignee=@My assignee #calendar:displayedAttributes="assignee" @@ -254,7 +256,7 @@

How the calendar works

- +

The calendar displays all the child notes of the book that have a #startDate. An #endDate can optionally be added.

@@ -264,7 +266,7 @@ #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 @@ -289,18 +291,19 @@ will not be displayed.

- +

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/book note), with the value being #name where name can - be any label. 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.

-
+ calendar/book 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.

+
@@ -310,67 +313,64 @@ + - 
#startDate=2025-02-11 #endDate=2025-02-13 #name="My vacation" #calendar:title="name"
+ 		- -
-
-

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.

-
- - - - - - - - - - - - - -
  
- - - -
-
-

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

-
- - - - - - - - - - - - - -
  
- - - -
-
+
+

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.

+
+ + + + + + + + + + + + + +
  
#startDate=2025-02-14 #endDate=2025-02-15 ~for=@John Smith ~for=@Jane Doe #calendar:title="for" + + +
+
+

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

+
+ + + + + + + + + + + + + +
  
#calendar:title="shortName" #shortName="John S." + + +
+
diff --git a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Admonitions.html b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Admonitions.html index 5c79e1bf9..40501feaf 100644 --- a/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Admonitions.html +++ b/src/public/app/doc_notes/en/User Guide/User Guide/Note Types/Text/Admonitions.html @@ -13,62 +13,59 @@

Admonitions

-
-
-
- -
-

Admonitions are a way to highlight information to the reader. Other names - for it include call-outs and info/warning/alert boxes.

-

Inserting a new admonition

-

From the UI

-

In the Formatting toolbar:

-

- -

-

Via the keyboard

-

It's possible to insert an admonition simply by typing:

-
    -
  • !!! note -
    • -
  • !!! tip -
    • -
  • !!! important -
    • -
  • !!! caution -
    • -
  • !!! warning -
    • -
-

In addition to that, it's also possible to type !!!  followed - by any text, case in which a default admonition type will appear (note) - with the entered text inside it.

-

Interaction

-

By design, admonitions act very similar to block quotes.

-
    -
  • Selecting a text and pressing the admonition button will turn that text - into an admonition.
    • -
  • If selecting multiple admonitions, pressing the admonition button will - automatically merge them into one.
    • -
-

Inside an admonition:

-
    -
  • Pressing Backspace while the admonition is empty will remove - it.
    • -
  • Pressing Enter will start a new paragraph. Pressing it twice - will exit out of the admonition.
    • -
  • Headings and other block content including tables can be inserted inside - the admonition.
    • -
-

Types of admonitions

-

There are currently five types of admonitions: Note, Tip, Important, Caution, Warning.

-

These types were inspired by GitHub's support for this feature and there - are currently no plans for adjusting it or allowing the user to customize - them.

-

Markdown support

-

The Markdown syntax for admonitions as supported by Trilium is the one - that GitHub uses, which is as follows:

> [!NOTE]
+        

+          
+        

+        
Admonitions are a way to highlight information to the reader. Other names
+          for it include call-outs and info/warning/alert boxes.

+        
Inserting a new admonition

+        
From the UI

+        
In the Formatting toolbar:

+        

+          
+        

+        
Via the keyboard

+        
It's possible to insert an admonition simply by typing:

+        
    
+          
  • !!! note
+          
    • 
+          
  • !!! tip
+          
    • 
+          
  • !!! important
+          
    • 
+          
  • !!! caution
+          
    • 
+          
  • !!! warning
+          
    • 
+        

+        
In addition to that, it's also possible to type !!!  followed
+          by any text, case in which a default admonition type will appear (note)
+          with the entered text inside it.

+        
Interaction

+        
By design, admonitions act very similar to block quotes.

+        
    
+          
  • Selecting a text and pressing the admonition button will turn that text
+            into an admonition.
    • 
+          
  • If selecting multiple admonitions, pressing the admonition button will
+            automatically merge them into one.
    • 
+        

+        
Inside an admonition:

+        
    
+          
  • Pressing Backspace while the admonition is empty will remove
+            it.
    • 
+          
  • Pressing Enter will start a new paragraph. Pressing it twice
+            will exit out of the admonition.
    • 
+          
  • Headings and other block content including tables can be inserted inside
+            the admonition.
    • 
+        

+        
Types of admonitions

+        
There are currently five types of admonitions: Note, Tip, Important, Caution, Warning.

+        
These types were inspired by GitHub's support for this feature and there
+          are currently no plans for adjusting it or allowing the user to customize
+          them.

+        
Markdown support

+        
The Markdown syntax for admonitions as supported by Trilium is the one
+          that GitHub uses, which is as follows:
> [!NOTE]
 > This is a note.
 
 > [!TIP]
@@ -79,10 +76,8 @@
 
 > [!CAUTION]
 > This is a caution.

-            
There are currently no plans of supporting alternative admonition syntaxes
-              such as !!! note.

-
-
+

There are currently no plans of supporting alternative admonition syntaxes + such as !!! note.