From 0a808eb43fd4771b76ce41d286fd2039d1881f9f Mon Sep 17 00:00:00 2001 From: revelaction <96388231+revelaction@users.noreply.github.com> Date: Tue, 1 Oct 2024 02:32:59 +0200 Subject: [PATCH] docs: add example and clarify usage of COMMENT property in iCalendar files --- ical.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/ical.md b/ical.md index f8357af..a40638a 100644 --- a/ical.md +++ b/ical.md @@ -29,14 +29,27 @@ For more details on configuring images, refer to the [Configuration File](config ### Comments (COMMENT property) +In iCalendar files, you can use multiple `COMMENT` properties to provide +additional information about an event. Only one of these `COMMENT` lines will +be displayed in the notification. This can be useful for events without exact +dates, composed of many tasks to be made loosely. + +**Example:** +```ics +COMMENT:Task 1: Prepare materials +COMMENT:Task 2: Schedule meeting +COMMENT:Task 3: Follow up +``` + ### Disable dates (CATEGORIES property) # Managing iCal Files -For detailed instructions on managing iCal files, refer to the [Managing iCal Files](ical.md#managing-ical-files) section. +It is highly advisable to place your iCal files under revision control to +ensure that changes are tracked and can be reverted if necessary. -It is highly advisable to place your iCal files under revision control to ensure that changes are tracked and can be reverted if necessary. -Additionally, setting up a cron job to periodically pull the latest content of these files can help keep your calendar up-to-date. +Additionally, setting up a cron job to periodically pull the latest content of +these files can help keep your calendar up-to-date. ## Setting Up Revision Control