-
Notifications
You must be signed in to change notification settings - Fork 4
/
example.toml
164 lines (155 loc) · 7.8 KB
/
example.toml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# MANDATORY: Title of this calendar.
name = "Example Calendar"
# MANDATORY: More detailed description of this calendar.
description = "An example calendar for testing"
[meta]
# OPTIONAL: Path to other calendar files with the same format as this file, the events of which are
# added to this calendar.
includes = [ "example-incl.toml" ]
# OPTIONAL: Any timezones used in events must be defined.
[[timezones]]
# MANDATORY: Name of the timezone.
name = "Europe/Amsterdam"
# MANDATORY: Timezone offset when daylight savings time is not in effect.
[timezones.standard]
# Name of this timezone.
name = "CET"
# When this timezone takes effect.
start = "1970-10-25T03:00:00.00"
# When this timezone repeats.
# In the below example, each year on the last Sunday of October.
rule = { frequency = "yearly", by_month = [10], by_day = [ { day = "sunday", num = -1 } ] }
# UTC offset in use when this timezone begins.
from = "+0200"
# UTC offset when this timezone is in use.
to = "+0100"
# MANDATORY: Timezone offset when daylight savings time is in effect.
# Same schema as in `timezones.standard`.
[timezones.daylight]
name = "CEST"
start = "1970-03-29T02:00:00.00"
from = "+0100"
to = "+0200"
rule = { frequency = "yearly", by_month = [3], by_day = [ { day = "sunday", num = -1 } ] }
[[events]]
# MANDATORY: Each event have a globally unique identifier (within this calendar, including events
# from includes) - it should never be changed after the calendar has been published. Just use the
# current unix time or something like that to basically guarantee that you don't overlap with
# anything or anyone else.
#
# Linux: date +%s%N | cut -b1-13
# Windows (PowerShell): [DateTimeOffset]::UtcNow.ToUnixTimeMilliseconds()
uid = "1704380847852"
# OPTIONAL: Date that this event was created. Expected RFC 3339 format.
created_on = "2024-01-04T10:00:00.00Z"
# MANDATORY: Date that this event was last modified. Expected RFC 3339 format.
last_modified_on = "2024-01-04T10:00:00.00Z"
# MANDATORY: Title of this event.
title = "An overview of calendar generation from TOML"
# OPTIONAL: More detailed description of this event.
description = "Learn how to use toml-to-ical"
# MANDATORY: Start date of this event.
#
# Expected RFC 3339 format.
# Time component can be excluded, e.g. 2024-01-04, for all-day events.
# Timezone can be included (must be one of the timezones defined in `timezones`):
# e.g. `{ date = "2024-01-04T11:00:00.00", timezone = "Europe/Amsterdam" }` and
# `{ date = "2024-01-04", timezone = "Europe/Amsterdam" }`
#
# If `start` is a date and time then `end` must be too, and likewise when `start` is just a date
# then `end` must be too.
start = "2024-01-04T11:00:00.00Z"
# OPTIONAL: End date of this event.
#
# Expected RFC 3339 format.
# Time component can be excluded, e.g. 2024-01-04, for all-day events.
# Timezone can be included (must be one of the timezones defined in `timezones`):
# e.g. `{ date = "2024-01-04T11:00:00.00", timezone = "Europe/Amsterdam" }` and
# `{ date = "2024-01-04", timezone = "Europe/Amsterdam" }`
#
# If `start` is a date and time then `end` must be too, and vice versa when `start` is
# just a date then `end` must be too.
# If not provided and `start` is just a date (with no time component), then this is an all-day
# event on the `start` date. Must be provided if `start` is a date and time.
end = "2024-01-04T12:00:00.00Z"
# OPTIONAL: Location of this event.
location = "#calendar on Zulip"
# OPTIONAL: Status of this event - must be one of "tentative"/"cancelled"/"confirmed".
status = "confirmed"
# OPTIONAL: Whether this event mark a subscriber as busy during it - must be one of "opaque" (busy)
# or "transparency" (free).
transparency = "opaque"
# OPTIONAL: Dates to when this event should repeat. Must be list of strings. Expected
# RFC 3339 format. Compatible with `recurrence_rules`. Does not appear to be supported by all
# calendar applications (e.g. Calendar on Apple devices).
recurrences = [ "2024-02-02T11:00:00.00Z" ]
# OPTIONAL: Exception dates to when this event should repeat. Must be list of strings. Expected
# RFC 3339 format.
exceptions = [ "2024-02-01T11:00:00.00Z" ]
# OPTIONAL: Identify a specific recurrence of an event. This must be a date/datetime that
# matches one of the recurrences of the primary event (which should have the same `uid` as this
# event). If you want to change the start date of the event, then change the `start` field, this
# field must match the original reccurence date. To change the details of this recurrence, change
# any of the other fields.
#
# Expected RFC 3339 format.
# Time component can be excluded, e.g. 2024-01-04, for all-day events.
# Timezone can be included (must be one of the timezones defined in `timezones`):
# e.g. `{ date = "2024-01-04T11:00:00.00", timezone = "Europe/Amsterdam" }` and
# `{ date = "2024-01-04", timezone = "Europe/Amsterdam" }`
#
# If `start` is a date and time then `recurrence_id` must be too, and likewise when `start` is just
# a date then `recurrence_id` must be too. `start` and `recurrence_id` must be in the same timezone.
# recurrence_id = "2024-01-18T11:00:00.00Z"
# OPTIONAL: Organizer of this event.
[events.organizer]
# MANDATORY: Name of the organizer.
name = "toml-to-ical team"
# MANDATORY: Email of the organizer.
email = "..."
# OPTIONAL: When this event should repeat. List of tables with the format described below.
# Compatible with `recurrences`.
[[events.recurrence_rules]]
# MANDATORY: Frequency that the event should repeat on - must be one of "yearly", "monthly",
# "weekly", "daily", "hourly", "minutely", "secondly".
frequency = "weekly"
# OPTIONAL: Number of 'frequency' between each event? e.g. "frequency = weekly" and
# "interval = 2" is every other week.
interval = 2
# OPTIONAL: Number of times the event should repeat with the given frequency. Mutually exclusive
# with `until`.
count = 10
# OPTIONAL: A date that the event repetitions should stop. Mutually exclusive with `count`.
# until = "2025-01-01T00:00:00.00Z"
# OPTIONAL: Seconds on which the event will recur. Must be between 0 and 60.
# In the below example, this is at the 0th second of the minute and the 30th second of the minute.
# by_second = [ 0, 30 ]
# OPTIONAL: Minutes on which the event will recur. Must be between 0 and 59.
# In the below example, this is at the 15th minute of the hour and the 45th minute of the hour.
# by_minute = [ 15, 45 ]
# OPTIONAL: Hours on which the event will recur. Must be between 0 and 23.
# In the below example, this is at 3pm and 4pm.
# by_hour = [ 15, 16 ]
# OPTIONAL: Days of the week on which the event will recur.
# `num` must be between -53 and 53 (excl. 0) and `day` must be one of "monday", "tuesday",
# "wednesday", "thursday", "friday", "saturday", "sunday".
# In the below example, this is on the first Sunday and on the second-to-last Tuesday.
# by_day = [ { day = "sunday", num = 1 }, { day = "tuesday", num = -2 } ]
# OPTIONAL: Days of the month on which the event will recur. Must be between -31 and 31 (excl. 0).
# In the below example, this is on the fifth day of the month and the fifth-from-last day of the
# month.
# by_month_day = [ 5, -5 ]
# OPTIONAL: Days of the year on which the event will recur. Must be between -366 and 366 (excl. 0).
# In the below example, this is on the 100th day of the year and the 200th-from-last day of the
# year.
# by_year_day = [ 100, -200 ]
# OPTIONAL: Weeks of the year on which the event will recur. Must be between 1 and 52.
# In the below example, this is on the 12th week of the year and the 34th-from-last week of the
# year.
# by_week_no = [ 12, 34 ]
# OPTIONAL: Months of the year on which the event will recur. Must be between 1 and 12.
# In the below example, this is on the 2nd month of the year and the 4th month of the year.
# by_month = [ 2, 4 ]
# OPTIONAL: Day that will be considered start of the week. Must be one of "monday", "tuesday",
# "wednesday", "thursday", "friday", "saturday", "sunday".
# week_start = "monday"