From 6ee54ced8b96c76e17c6a2ef3b65b53b9353d500 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hugo=20H=C3=B6rnquist?= Date: Tue, 14 Nov 2023 16:57:11 +0100 Subject: Document vcomponent grouping utilities. --- doc/ref/vcomponent.texi | 1 + doc/ref/vcomponent/group.texi | 20 ++++++++++++++++++++ 2 files changed, 21 insertions(+) create mode 100644 doc/ref/vcomponent/group.texi diff --git a/doc/ref/vcomponent.texi b/doc/ref/vcomponent.texi index 5823e88e..4e0fb2c7 100644 --- a/doc/ref/vcomponent.texi +++ b/doc/ref/vcomponent.texi @@ -9,6 +9,7 @@ the generialization of VCALENDAR, VEVENT, ... Some of these values are still Calp specific. @include vcomponent/general.texi +@include vcomponent/group.texi @include vcomponent/create.texi @include vcomponent/data-formats.texi diff --git a/doc/ref/vcomponent/group.texi b/doc/ref/vcomponent/group.texi new file mode 100644 index 00000000..27e94732 --- /dev/null +++ b/doc/ref/vcomponent/group.texi @@ -0,0 +1,20 @@ +@node VComponent Grouping Utilities +@section VComponent Grouping Utilities + +@code{(vcomponent util group)} + +@defun group-stream input-stream +Given a sorted stream of vevent's, where each MUST have at least a +DTSTART property, returns a new stream of pairs of dates and all +events from the original streams which at least in part reside inside +that date. +@end defun + +@defun get-groups-between groups start-date end-date +Returns the subset of @var{groups}, as generated by +@code{group-stream}, which overlaps the date interval between +@var{start-date} and @var{end-date}. +@end defun + +@defun group->event-list group +@end defun -- cgit v1.2.3