From e53cd7443a37958dd9b78d1deeab1e92d5d484a1 Mon Sep 17 00:00:00 2001 From: BeatLink Date: Sun, 22 Feb 2026 18:22:21 -0500 Subject: [PATCH] Add Docs for Recurrence --- .../User Guide/User Guide/Collections/Calendar.html | 12 ++++++++++++ docs/User Guide/User Guide/Collections/Calendar.md | 5 +++-- 2 files changed, 15 insertions(+), 2 deletions(-) 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 472192219c..6675a93c86 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 @@ -185,6 +185,18 @@ at which the event ends (in relation with endDate if present, or startDate). + + #recurrence + + This is an optional CalDAV RRULE string + that if present, determines whether a task should repeat or not. Note that + it does not include the DTSTART attribute, + which is derived from the #startDate and + #startTimedirectly. For examples of valid RRULE strings + see https://icalendar.org/rrule-tool.html + + #color diff --git a/docs/User Guide/User Guide/Collections/Calendar.md b/docs/User Guide/User Guide/Collections/Calendar.md index f7309feacd..e0be591847 100644 --- a/docs/User Guide/User Guide/Collections/Calendar.md +++ b/docs/User Guide/User Guide/Collections/Calendar.md @@ -72,11 +72,12 @@ For each note of the calendar, the following attributes can be used: | `#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`). | +| `#recurrence` | This is an optional CalDAV `RRULE` string that if present, determines whether a task should repeat or not. Note that it does not include the `DTSTART` attribute, which is derived from the `#startDate` and `#startTime` directly. For examples of valid `RRULE` strings see [https://icalendar.org/rrule-tool.html](https://icalendar.org/rrule-tool.html) | | `#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` | **❌️ Removed since v0.100.0. Use** `**#color**` **instead.** 

Similar to `#color`, but applies the color only for the event in the calendar and not for other places such as the note tree. | +| `#calendar:color` | **❌️ Removed since v0.100.0. Use** `**#color**` **instead.**  

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, 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:      

![](7_Calendar_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:displayedAttributes` | Allows displaying the value of one or more attributes in the calendar like this:       

![](7_Calendar_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. |