Skip to content

Commit 8a45d9b

Browse files
ronaldtseronaldtse
committed
chore: cleanup
1 parent 4e7fb08 commit 8a45d9b

23 files changed

+147
-133
lines changed

‎.github/workflows/generate.yml‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,10 @@ jobs:
2828
uses: actions-mn/cache@v1
2929

3030
- name: Metanorma generate site
31-
uses: actions-mn/build-and-publish@main
31+
uses: actions-mn/build-and-publish@v2
3232
with:
33-
token: ${{ secrets.GITHUB_TOKEN }}
3433
agree-to-terms: true
35-
34+
destination: gh-pages
3635
deploy:
3736
if: ${{ github.ref == 'refs/heads/main' }}
3837
environment:

‎sources/cc-51014.adoc‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ include::sections/02-norm-refs.adoc[]
2727

2828
include::sections/03-terms.adoc[]
2929

30+
include::sections/03-conventions.adoc[]
31+
3032
include::sections/03-overview.adoc[]
3133

3234
include::sections/04-vinstance-component.adoc[]

‎sources/sections/00-abstract.adoc‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
[abstract]
22
== Abstract
33

4-
This document updates the iCalendar (<<RFC5545>>) specification to allow a more compact representation of overridden recurrence instances.
4+
This document updates the iCalendar (<<RFC5545>>) specification to allow a more
5+
compact representation of overridden recurrence instances.

‎sources/sections/01-intro.adoc‎

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
== Introduction
22

3-
The iCalendar <<RFC5545>> data format is in widespread use to represent calendar data.
4-
iCalendar has a data model that supports the concept of recurring, or repeating,
5-
events (or other types of objects such as tasks). With repeating events, it is often
6-
the case that one particular instance may differ from the rest. In that case
7-
iCalendar requires that all the data for that event be included, even though only a
8-
small portion of it may be different. For long lived recurring events with lots of
9-
attendees present, this can often result in a significant increase in the size of
10-
the iCalendar data as many instances get overridden.
3+
The iCalendar <<RFC5545>> data format is in widespread use to represent calendar
4+
data. iCalendar has a data model that supports the concept of recurring, or
5+
repeating, events (or other types of objects such as tasks). With repeating
6+
events, it is often the case that one particular instance may differ from the
7+
rest. In that case iCalendar requires that all the data for that event be
8+
included, even though only a small portion of it may be different. For long
9+
lived recurring events with lots of attendees present, this can often result in
10+
a significant increase in the size of the iCalendar data as many instances get
11+
overridden.
1112

1213
This specification updates the iCalendar data model to support a new iCalendar
13-
component that can be used to represent just the changes in an overridden instance,
14-
rather than having to include everything describing it. This can significantly
15-
reduce the size of the iCalendar data, leading to reductions in network I/O (with
16-
resultant savings in battery usage on mobile devices), and storage requirements, on
17-
clients, servers, and associated databases.
14+
component that can be used to represent just the changes in an overridden
15+
instance, rather than having to include everything describing it. This can
16+
significantly reduce the size of the iCalendar data, leading to reductions in
17+
network I/O (with resultant savings in battery usage on mobile devices), and
18+
storage requirements, on clients, servers, and associated databases.

‎sources/sections/01-scope.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
== Scope
22

3-
//This document specifies a new iCalendar component that provides a more compact
4-
//representation of overridden recurrence instances.
3+
This document updates the iCalendar (<<RFC5545>>) specification to allow a more
4+
compact representation of overridden recurrence instances.

‎sources/sections/03-conventions.adoc‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
== Terms and Definitions
2+
3+
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
4+
"SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document
5+
are to be interpreted as described in <<RFC2119>>.
6+
7+
The notation used in this memo is the ABNF notation of <<RFC5234>> as used by
8+
iCalendar <<RFC5545>>. Any syntax elements shown below that are not explicitly defined in this
9+
specification come from iCalendar <<RFC5545>>, CalDAV <<RFC4791>>, and [draft-patch].

‎sources/sections/03-overview.adoc‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Those rules produce a set of "generated instances". "Generated instances" do not
66
need to have a representation in the iCalendar data, as their content can be
77
inferred from the "master component". In some cases specific "generated
88
instances" are changed, resulting in an "overridden instance". An "overridden
9-
instance" is represented in iCalendar as an "overridden component", which has the
10-
same "UID" property value as the "master component", and a "RECURRENCE-ID"
9+
instance" is represented in iCalendar as an "overridden component", which has
10+
the same "UID" property value as the "master component", and a "RECURRENCE-ID"
1111
property whose value matches the start time of the corresponding "generated
1212
instance" (which can be different from the actual start time of the "overridden
1313
instance").
@@ -61,10 +61,10 @@ END:VCALENDAR
6161

6262
As can be seen, the overridden component for 20160903 duplicates many iCalendar
6363
properties from the master component, with the "SUMMARY" property being
64-
different, "RECURRENCE-ID" added, and "DTSTART" adjusted to the start time of the
65-
instance. All the other properties are the same as the corresponding ones in the
66-
master component. Using the new representation described by this specification,
67-
this iCalendar object would appear as:
64+
different, "RECURRENCE-ID" added, and "DTSTART" adjusted to the start time of
65+
the instance. All the other properties are the same as the corresponding ones in
66+
the master component. Using the new representation described by this
67+
specification, this iCalendar object would appear as:
6868

6969
[source%unnumbered]
7070
----
@@ -90,5 +90,5 @@ In this case the "VINSTANCE" component is used to encapsulate just those
9090
iCalendar properties that are different from the generated instance - just
9191
"SUMMARY" in this case. The new representation is just over 80% of the size of
9292
the traditional representation, giving a small, but not insignificant, reduction
93-
in size. But as more overrides are needed, or as more properties are added to the
94-
master component, the savings will increase dramatically.
93+
in size. But as more overrides are needed, or as more properties are added to
94+
the master component, the savings will increase dramatically.

‎sources/sections/03-terms.adoc‎

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1 @@
1-
== Terms and Definitions
2-
3-
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
4-
"SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document
5-
are to be interpreted as described in <<RFC2119>>.
6-
7-
The notation used in this memo is the ABNF notation of <<RFC5234>> as used by
8-
iCalendar <<RFC5545>>. Any syntax elements shown below that are not explicitly defined in this
9-
specification come from iCalendar <<RFC5545>>, CalDAV <<RFC4791>>, and [draft-patch].
1+
== Terms and definitions

‎sources/sections/04-vinstance-component.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33

44
This specification defines the new "VINSTANCE" component, which is used to
55
represent just the differences between a generated instance, derived from the
6-
master component, and the actual overridden instance that will be used instead of
7-
the generated instance.
6+
master component, and the actual overridden instance that will be used instead
7+
of the generated instance.
88

99
"VINSTANCE" components MUST only appear as sub-components within master
1010
components (e.g., they can only appear as sub-components of components that

‎sources/sections/05-instance-components.adoc‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ value that is unique (at least within that master component). This allows such
66
sub-components to be easily identified for the purposes of indicating whether a
77
"VINSTANCE" is adding, updating, or deleting a sub-component.
88

9-
Any iCalendar component defined in the "VINSTANCE" component (referred to here as
10-
the "instance component"), other than a "PATCH" component [draft-patch], is
9+
Any iCalendar component defined in the "VINSTANCE" component (referred to here
10+
as the "instance component"), other than a "PATCH" component [draft-patch], is
1111
treated as either an addition to the generated instance, or as an update of an
1212
existing component in the generated instance, as follows:
1313

@@ -19,17 +19,17 @@ component is an addition to the generated instance.
1919
value that matches that of the instance component, then the instance component
2020
replaces the matching one in the generated instance.
2121

22-
Alternatively, a sub-component can be "incrementally" updated by use of a "PATCH"
23-
component [draft-patch] that targets the sub-component. A "PATCH" component is
24-
created by determining the difference between the sub-component in the overridden
25-
instance and the matching sub-component in the generated instance. The
26-
"PATCH-TARGET" property value in the "PATCH" component is specified as a path
27-
relative to the overridden component targeting the sub-component by its "UID"
28-
property value (e.g., if a "VALARM" component inside a "VEVENT" component is
29-
being updated, the "PATCH-TARGET" property value would be "/VALARM[UID=1234]"
30-
(assuming that the "UID" property value of the sub-component being updated is
31-
"1234"). The "PATCH" component is then added as a sub-component of the
32-
"VINSTANCE" component representing the overridden instance.
22+
Alternatively, a sub-component can be "incrementally" updated by use of a
23+
"PATCH" component [draft-patch] that targets the sub-component. A "PATCH"
24+
component is created by determining the difference between the sub-component in
25+
the overridden instance and the matching sub-component in the generated
26+
instance. The "PATCH-TARGET" property value in the "PATCH" component is
27+
specified as a path relative to the overridden component targeting the
28+
sub-component by its "UID" property value (e.g., if a "VALARM" component inside
29+
a "VEVENT" component is being updated, the "PATCH-TARGET" property value would
30+
be "/VALARM[UID=1234]" (assuming that the "UID" property value of the
31+
sub-component being updated is "1234"). The "PATCH" component is then added as a
32+
sub-component of the "VINSTANCE" component representing the overridden instance.
3333

3434
When expanding a "VINSTANCE" component into an overridden component, any "PATCH"
3535
sub-components are used to update sub-components in the generated instance, by

0 commit comments

Comments
 (0)