-
Notifications
You must be signed in to change notification settings - Fork 4
/
cl-icalendar.texi
191 lines (135 loc) · 4.37 KB
/
cl-icalendar.texi
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
\input texinfo
@c -*-texinfo-*-
@c %**start of header
@setfilename cl-icalendar.info
@settitle cl-icalendar
@c %**end of header
@include version.texi
@c Copy the type, variable and function indexes to the cp one.
@syncodeindex tp cp
@syncodeindex vr cp
@syncodeindex fn cp
@copying
This is the @cite{Common Lisp iCalendar Library} updated for
the version @cite{@value{VERSION}}.
Copyright @copyright{} 2010 Mario Castel@'an Castro
Copyright @copyright{} 2010,2011 David V@'azquez P@'ua
@quotation
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled ``GNU
Free Documentation License''.
A copy of the license is also available from the Free Software
Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
@end quotation
The document was typeset with
@uref{http://www.texinfo.org/, GNU Texinfo}.
@end copying
@titlepage
@title Common Lisp iCalendar Library
@subtitle An implementation of the iCalendar specification
@subtitle for cl-icalendar version @value{VERSION}.
@author Mario Castel@'an Castro
@author David V@'azquez P@'ua
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage
@c Output the table of the contents at the beginning.
@contents
@ifnottex
@node Top
@top Common Lisp iCalendar Library
@insertcopying
@end ifnottex
@c Generate the nodes for this menu with `C-c C-u C-m'.
@menu
* Introduction::
* Data types::
* GNU Free Documentation License::
* Index::
@end menu
@node Introduction
@chapter Introduction
The @emph{Common Lisp iCalendar Library} is an implementation of
iCalendar specification as described in RFC5545. It provides a
convenient object-oriented abstractions so that user to be able treat
with iCalendar as easy as possible, even it can be extended and suited
to advanced uses.
This document should not be considered a complete documentation of the
Common Lisp iCalendar library. The object of this document is give an
insight to the user about the usage of the library.
@node Package structure
@section Package structure
The library provides a package named @samp{ICAL}. Every exported symbol
will be in this package. It is granted you can @strong{use} this package
and it will not cause collisions with the standard @samp{COMMON-LISP}
package.
@node Overview
@section Overview
@node Data types
@chapter Data types
The value of each property is always a @code{ical-value} type. This
type includes the ANSI Common Lisp data types @code{Boolean},
@code{Integer}, @code{Float}, as well as specific iCal data types
@code{URI}, @code{Geo}, @code{Cal-address}, @code{Binary}, @code{Text},
@code{UTC-Offset}, @code{Date}, @code{Time}, @code{Datetime},
@code{Duration}, @code{Period} and @code{Recur}. Indeed, it also covers
the data type @code{x-ical-value}, which can be extend by defining a
subclass of the class with the same name. It is explained in detail in
the section ``Custom data types''.
@node Boolean
@section Boolean
The boolean data type is defined as ``TRUE'' or ``FALSE''. They are
mapped to the Common Lisp values @code{T} and @code{NIL} respectively.
@node Integer
@section Integer
The Common Lisp integer type, a mathematical integer. The RFC5545 limits
the magnitude of the integer type to the range -2147483648 to
2147483647. This limitation is not implemented in the library.
@node Float
@section Float
The Common Lisp float type is used in properties that contain real
number value.
@node URI
@section URI
This value type is used to identify values that contain a uniform
resource identifier (URI) type of reference to the property value.
urip
make-uri
uri
@node Geo
@section Geo
@node Cal-address
@section Cal-address
@node Binary
@section Binary
@node Text
@section Text
@node UTC-Offset
@section UTC-Offset
@node Date
@section Date
@node Time
@section Time
@node Datetime
@section Datetime
@node Duration
@section Duration
@node Period
@section Period
@node Recur
@section Recur
@node Custom data types
@section Custom data types
@node GNU Free Documentation License
@appendix GNU Free Documentation License
@c Get fdl.texi from http://www.gnu.org/licenses/fdl.html
@include fdl.texi
@node Index
@unnumbered Index
@printindex cp
@bye
@c cl-icalendar.texi ends here