diff options
| author | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-04-19 15:47:54 +0200 |
|---|---|---|
| committer | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-04-21 15:58:41 +0200 |
| commit | 041b70cd1cd7883a12a71612784d937361aa5efd (patch) | |
| tree | 098cc98f73c5f1e71fe6b6bacc6d08cc4b921f9a /doc/ref/guile/data-formats.texi | |
| parent | Remove old unit-test style seraliazation tests. (diff) | |
| download | calp-041b70cd1cd7883a12a71612784d937361aa5efd.tar.gz calp-041b70cd1cd7883a12a71612784d937361aa5efd.tar.xz | |
Split data-store and data-format indo separate doc pages.
Diffstat (limited to '')
| -rw-r--r-- | doc/ref/guile/data-formats.texi | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/ref/guile/data-formats.texi b/doc/ref/guile/data-formats.texi new file mode 100644 index 00000000..037d3ae7 --- /dev/null +++ b/doc/ref/guile/data-formats.texi @@ -0,0 +1,25 @@ +@node Data Formats +@section Data Formats +A data format is some way that an individual event may get serialized +to disk. The default is iCalendar (TODO reference RFC 5545), but +others might be available (TODO footnote and reference xcal). + +Each available format should be included as +@code{(vcomponent formats @var{format-name})}. +Which module corresponds to what file type is currently defined out of band. + +Each module should expose the following procedures. + +@defun serialize component port +Write a serialized representation of @var{component} to @var{port}. +@end defun + +@defun deserialize port +Read a serialized representation of a component from @var{port}, and +return the deserialized instance of this object. +@end defun + +@subsection iCalendar +RFC 5545 + +@subsection xCal |