.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "RDF::iCalendar::Exporter 3pm"
.TH RDF::iCalendar::Exporter 3pm 2024-03-09 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
RDF::iCalendar::Exporter \- export RDF data to iCalendar format
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& use RDF::iCalendar;
\& 
\& my $input    = "http://example.com/calendar\-data.ics";
\& my $exporter = RDF::iCalendar::Exporter\->new;
\& 
\& print $_ foreach $exporter\->export_calendars($input);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module reads RDF and writes iCalendar files.
.PP
This is a subclass of RDF::vCard::Exporter, so it can also export vCards.
.SS Constructor
.IX Subsection "Constructor"
.IP \(bu 4
\&\f(CWnew(%options)\fR
.Sp
Returns a new RDF::iCalendar::Exporter object.
.Sp
There are no valid options at the moment \- the hash is reserved
for future use.
.SS Methods
.IX Subsection "Methods"
.IP \(bu 4
\&\f(CW\*(C`export_calendars($input, %options)\*(C'\fR
.Sp
Returns a list of iCalendars found in the input, in no particular order.
.Sp
The input may be a URI, file name, RDF::Trine::Model or anything else
that can be handled by the \f(CW\*(C`rdf_parse\*(C'\fR method of RDF::TrineShortcuts.
.Sp
Each item in the list returned is an RDF::iCalendar::Entity, though
that class overloads stringification, so you can just treat each item
as a string mostly.
.IP \(bu 4
\&\f(CW\*(C`export_calendar($input, $subject, %options)\*(C'\fR
.Sp
As per \f(CW\*(C`export_calendars\*(C'\fR but exports just a single calendar.
.Sp
The subject provided must be an RDF::Trine::Node::Blank or
RDF::Trine::Node::Resource of type icaltzd:Vcalendar.
.IP \(bu 4
\&\f(CW\*(C`export_component($input, $subject, %options)\*(C'\fR
.Sp
Exports a component from a calendar \- e.g. a single VEVENT
.Sp
The subject provided must be an RDF::Trine::Node::Blank or
RDF::Trine::Node::Resource of type icaltzd:Vevent, icaltzd:Vtodo
or similar.
.IP \(bu 4
\&\f(CW\*(C`export_cards($input, %options)\*(C'\fR
.Sp
See RDF::vCard::Exporter.
.IP \(bu 4
\&\f(CW\*(C`export_card($input, $subject, %options)\*(C'\fR
.Sp
See RDF::vCard::Exporter.
.SS "RDF Input"
.IX Subsection "RDF Input"
Input is expected to use the newer of the 2005 revision of the W3C's
vCard vocabulary <http://www.w3.org/TR/rdfcal/>. (Note that even
though this was revised in 2005, the term URIs include "2002" in
them.)
.PP
Some extensions from the namespace <http://buzzword.org.uk/rdf/icaltzdx#>
are also supported.
.SS "iCalendar Output"
.IX Subsection "iCalendar Output"
The output of this module aims at iCalendar (RFC 2445) compliance.
In the face of weird input data though, (e.g. an DTSTART property that is a
URI instead of a literal) it can pretty easily descend into exporting
junk, non-compliant iCalendars.
.PP
The output has barely been tested in any iCalendar-supporting software,
so beware.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
RDF::iCalendar.
.PP
RDF::vCard, HTML::Microformats, RDF::TrineShortcuts.
.PP
<http://www.w3.org/TR/rdfcal/>.
.PP
<http://www.perlrdf.org/>.
.SH AUTHOR
.IX Header "AUTHOR"
Toby Inkster <tobyink@cpan.org>.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2011, 2013 Toby Inkster
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
.SH "DISCLAIMER OF WARRANTIES"
.IX Header "DISCLAIMER OF WARRANTIES"
THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.