You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit ee113cf
Browse filesBrowse the repository at this point in the historyBrowse files
* Follow up to 1789 xCal support
- Rename XCalComponentParser to XCalComponentsParser
* Use terminology from RFC 6321
* Add glossary terms and cross-references
* Link to Python Element class
* Add docstrings for xcal.adapter
* Add missing docstring sections to xcal.base
* Clean up docstrings in xcal.parameters
* Clean up docstrings of xcal.property
* Polish docstrings for xcal/string
- Add a glossary term and definition for XSD and friends
- Add datatypes to Vale dictionary
* Update docstrings for xcal.wrapper
- Convert comment to TODO for greater visibility.
* Clean up docstrings in parser.parameter
* Clean up docstrings in prop.dt.date
* Clean up docstrings in prop.dt.datetime
* Clean up docstrings in prop.dt.duration
* ruff
* Clean up the remaining docstrings. Most are repetitive.
* Fix Sphinx warnings.
* news
* Standardize xCal properties
* Apply most but not all batched suggestions from code review
Co-authored-by: Nicco Kunzmann <niccokunzmann@rambler.ru>
* Update src/icalendar/cal/journal.py
* Apply batched suggestions from code review
Co-authored-by: Steve Piercy <web@stevepiercy.com>
* Apply suggestion from @niccokunzmann
Co-authored-by: Nicco Kunzmann <niccokunzmann@rambler.ru>
* Ruff
* Update docs/reference/glossary.rst
---------
Co-authored-by: Nicco Kunzmann <niccokunzmann@rambler.ru>
Copy file name to clipboardExpand all lines: docs/reference/glossary.rst
+67-1Lines changed: 67 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -67,8 +67,74 @@ Glossary
67
67
For example, the calendar component can specify an event, a to-do, a journal entry, time zone information, free/busy time information, or an alarm.
68
68
69
69
All calendar components start with the letter "V".
70
-
For example, "VEVENT" refers to the event calendar component.
70
+
For example, VEVENT refers to the event calendar component.
71
71
72
72
.. seealso::
73
73
74
74
:rfc:`5545#section-3.6`
75
+
76
+
iCalendar object
77
+
As defined by :rfc:`5545#section-3.4`, an iCalendar object consists of a pair of delimiter strings—one defining its start (``BEGIN:VCALENDAR``) and the other its end (``END:VCALENDAR``), with both having trailing ``CRLF``\ s—and a body consisting of a sequence of calendar properties and one or more calendar components.
78
+
79
+
Typically, an :term:`iCalendar stream` contains a single iCalendar object.
80
+
However, multiple iCalendar objects can be sequentially grouped together in an iCalendar stream.
81
+
82
+
iCalendar stream
83
+
At the top level of the iCalendar object model is an iCalendar stream.
84
+
An iCalendar stream can contain one or more iCalendar objects.
85
+
86
+
.. seealso::
87
+
88
+
:term:`IC:icalendar`
89
+
90
+
IC:icalendar
91
+
In xCal, an IC:icalendar XML element representation of an :term:`iCalendar stream`.
92
+
93
+
.. seealso::
94
+
95
+
:rfc:`6321#section-3.2`
96
+
97
+
IC:vcalendar
98
+
In xCal, an IC:vcalendar XML element representation of a single :term:`iCalendar object` in an :term:`iCalendar stream`.
99
+
100
+
.. seealso::
101
+
102
+
:rfc:`6321#section-3.2`
103
+
104
+
IC:components
105
+
In :term:`xCal`, an IC:components element is an XML element that contains zero or more :term:`component element`\ s.
106
+
107
+
.. seealso::
108
+
109
+
:rfc:`6321#section-3.2`
110
+
111
+
component element
112
+
In :term:`xCal`, a component element represents the :term:`iCalendar` :term:`component`.
113
+
Its name is the same as that in iCalendar, but lowercase.
114
+
115
+
.. seealso::
116
+
117
+
:rfc:`6321#section-3.3`
118
+
119
+
IC:properties
120
+
In xCal, an IC:property is an XML element representation of an :term:`iCalendar` :term:`property`.
121
+
Its name is the same as that in iCalendar, but lowercase.
122
+
123
+
.. seealso::
124
+
125
+
:rfc:`6321#section-3.4`
126
+
127
+
IC:parameters
128
+
In xCal, an IC:parameter is an XML element representation of an :term:`iCalendar` :term:`parameter`.
129
+
Its name is the same as that in iCalendar, but lowercase.
130
+
131
+
.. seealso::
132
+
133
+
:rfc:`6321#section-3.5`
134
+
135
+
XSD
136
+
XML Schema Definition
137
+
XML Schema Definition Language
138
+
The `XML Schema Definition Language <https://www.w3.org/TR/xmlschema11-2/>`__ (XSD) defines facilities for defining datatypes to be used in XML Schemas as well as other XML specifications.
139
+
The names of datatypes typically begin with either ``xs:`` or ``xsd:``.
140
+
The xCal specification :rfc:`6321` uses the latter, and, therefore, so does icalendar.
0 commit comments