diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Calendar.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Calendar.html index 704e9390e..33d4f4850 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Calendar.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Calendar.html @@ -6,369 +6,412 @@ a start date and optionally an end date, as an event.

The Calendar view has multiple display modes:

Unlike other Collection view types, the Calendar view also allows some kind of interaction, such as moving events around as well as creating new ones.

Creating a calendar

- - - - - - - - - - - - - - - - - - - - -
1 - - The Calendar View works only for Collection note types. To create a new - note, right click on the note tree on the left and select Insert note after, - or Insert child note and then select Collection.
2 - - Once created, the “View type” of the Collection needs changed to “Calendar”, - by selecting the “Collection Properties” tab in the ribbon.
- +
+ + + + + + + + + + + + + + + + + + + + +
   
1 + + The Calendar View works only for Collection note types. To create a new + note, right click on the note tree on the left and select Insert note after, + or Insert child note and then select Collection.
2 + + Once created, the “View type” of the Collection needs changed to “Calendar”, + by selecting the “Collection Properties” tab in the ribbon.
+

Creating a new event/note

Interacting with events

+

Interaction on mobile

+

When Trilium is on mobile, the interaction with the calendar is slightly + different:

+

Configuring the calendar view

In the Collections tab in the Ribbon, it's possible to adjust the following:

Configuring the calendar using attributes

The following attributes can be added to the Collection 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:initialDate - Change the date the calendar opens on. When not present, the calendar - opens on the current date.
#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 using attributes

-

For each note of the calendar, the following attributes can be used:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
#startDate - The date the event starts, which will display it in the calendar. The - format is YYYY-MM-DD (year, month and day separated by a minus - sign).
#endDate - Similar to startDate, mentions the end date if the event spans - across multiple days. The date is inclusive, so the end day is also considered. - The attribute can be missing for single-day events.
#startTime - The time the event starts at. If this value is missing, then the event - is considered a full-day event. The format is HH:MM (hours in - 24-hour format and minutes).
#endTime - Similar to startTime, it mentions the time at which the event - ends (in relation with endDate if present, or startDate).
#color - Displays the event with a specified color (named such as red, gray or - hex such as #FF0000). This will also change the color of the - note in other places such as the note tree.
#calendar:color - Similar to #color, but applies the color only for the event - in the calendar and not for other places such as the note tree. (Deprecated)
#iconClass - If present, the icon of the note will be displayed to the left of the - event title.
#calendar:title - Changes the title of an event to point to an attribute of the note other - than the title, can either a label or a relation (without the # or ~ symbol). - See Use-cases for more information.
#calendar:displayedAttributes - Allows displaying the value of one or more attributes in the calendar - like this:     -
-
-    -
-
#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.
#calendar:endTime - Similar to #calendar:startDate, allows changing the attribute - which is being used to read the end time.
- -

How the calendar works

-

- -

-

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

-

If editing the start date and end date from the note itself is desirable, - the following attributes can be added to the Collection note:

#viewType=calendar #label:startDate(inheritable)="promoted,alias=Start Date,single,date"
+

+  
+    
+      
+        
+        
+      
+    
+    
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+    
+  
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:initialDate
+        Change the date the calendar opens on. When not present, the calendar
+          opens on the current date.
#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 using attributes

+  
For each note of the calendar, the following attributes can be used:

+  

+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
NameDescription
#startDate
+          The date the event starts, which will display it in the calendar. The
+            format is YYYY-MM-DD (year, month and day separated by a minus
+            sign).
#endDate
+          Similar to startDate, mentions the end date if the event spans
+            across multiple days. The date is inclusive, so the end day is also considered.
+            The attribute can be missing for single-day events.
#startTime
+          The time the event starts at. If this value is missing, then the event
+            is considered a full-day event. The format is HH:MM (hours in
+            24-hour format and minutes).
#endTime
+          Similar to startTime, it mentions the time at which the event
+            ends (in relation with endDate if present, or startDate).
#color
+          Displays the event with a specified color (named such as red, gray or
+            hex such as #FF0000). This will also change the color of the
+            note in other places such as the note tree.
#calendar:color
+          Similar to #color, but applies the color only for the event
+            in the calendar and not for other places such as the note tree. (Deprecated)
#iconClass
+          If present, the icon of the note will be displayed to the left of the
+            event title.
#calendar:title
+          Changes the title of an event to point to an attribute of the note other
+            than the title, can either a label or a relation (without the # or ~ symbol).
+            See Use-cases for more information.
#calendar:displayedAttributes
+          Allows displaying the value of one or more attributes in the calendar
+            like this:     
+            

+            

+               
+            

+            
#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.
#calendar:endTime
+          Similar to #calendar:startDate, allows changing the attribute
+            which is being used to read the end time.

+    

+    
How the calendar works

+    

+      
+    

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

+    
If editing the start date and end date from the note itself is desirable,
+      the following attributes can be added to the Collection note:
#viewType=calendar #label:startDate(inheritable)="promoted,alias=Start Date,single,date"
 #label:endDate(inheritable)="promoted,alias=End Date,single,date"
 #hidePromotedAttributes 

-
This will result in:

-

-  
-

-
When not used in a Journal, the calendar is recursive. That is, it will
-  look for events not just in its child notes but also in the children of
-  these child notes.

-
Use-cases

-
Using with the Journal / calendar

-
It is possible to integrate the calendar view into the Journal with day
-  notes. In order to do so change the note type of the Journal note (calendar
-  root) to Collection and then select the Calendar View.

-
Based on the #calendarRoot (or #workspaceCalendarRoot)
-  attribute, the calendar will know that it's in a calendar and apply the
-  following:

-
-
-
-
Using a different attribute as event title

-
By default, events are displayed on the calendar by their note title.
-  However, it is possible to configure a different attribute to be displayed
-  instead.

-
To do so, assign #calendar:title to the child note (not the
-  calendar/Collection note), with the value being name where name can
-  be any label (make not to add the # prefix). The attribute can
-  also come through inheritance such as a template attribute. If the note
-  does not have the requested label, the title of the note will be used instead.

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

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

-      		
-        

-          
-        

-      

\ No newline at end of file
+    
This will result in:

+    

+      
+    

+    
When not used in a Journal, the calendar is recursive. That is, it will
+      look for events not just in its child notes but also in the children of
+      these child notes.

+    
Use-cases

+    
Using with the Journal / calendar

+    
It is possible to integrate the calendar view into the Journal with day
+      notes. In order to do so change the note type of the Journal note (calendar
+      root) to Collection and then select the Calendar View.

+    
Based on the #calendarRoot (or #workspaceCalendarRoot)
+      attribute, the calendar will know that it's in a calendar and apply the
+      following:

+    
+    

+      
+    

+    
Using a different attribute as event title

+    
By default, events are displayed on the calendar by their note title.
+      However, it is possible to configure a different attribute to be displayed
+      instead.

+    
To do so, assign #calendar:title to the child note (not the
+      calendar/Collection note), with the value being name where name can
+      be any label (make not to add the # prefix). The attribute can
+      also come through inheritance such as a template attribute. If the note
+      does not have the requested label, the title of the note will be used instead.

+    

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

+      

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

+              		
+                

+                  
+                

+              

+      

\ No newline at end of file
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Script API/Day.js.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Script API/Day.js.html
index f0b61cb73..40234a230 100644
--- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Script API/Day.js.html	
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Script API/Day.js.html	
@@ -12,21 +12,21 @@ api.log(date.format("YYYY-MM-DD"));
and back-end scripts.

The following Day.js plugins are directly integrated into Trilium: