.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28) .\" .\" 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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 turned on, 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 .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "iCal::Parser::HTML 3pm" .TH iCal::Parser::HTML 3pm "2014-07-02" "perl v5.18.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" iCal::Parser::HTML \- Generate HTML calendars from iCalendars .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 3 \& use iCal::Parser::HTML; \& my $parser=iCal::Parser::HTML\->new; \& print $parser\->parse(type=>$type,start=>$date,files=>[@icals]); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module uses iCal::Parser::SAX and XML::LibXSLT with included stylesheets to generates html calendars from icalendars. .PP The html document generated includes (when appropriate) a sidebar containing a legend, a list of todos and a three month calendar for the previous, current and next months. .PP The stylesheets are stored in the HTML/stylesheet directory under the installed package directory. .PP Also included in this package are an optionally installed command line program \*(L"ical2html\*(R" in scripts and, in the example directory, a cgi handler (\*(L"ical.cgi\*(R" in examples) and a stylesheet (\*(L"calendar.css\*(R" in examples) for formatting the html output. Note that the html output will look quite broken without the stylesheet. .SH "ARGUMENTS" .IX Header "ARGUMENTS" The following arguments are processed by this module. Any addtional arguments are passed to iCal::Parser::SAX. .IP "type" 4 .IX Item "type" The type of calendar to generate. One of: \f(CW\*(C`day\*(C'\fR, \f(CW\*(C`week\*(C'\fR, \f(CW\*(C`month\*(C'\fR or \&\f(CW\*(C`year\*(C'\fR. The daily, weekly and monthly calendars include the sidebar. The calendar generated will be for the specified period (day, week, etc.) which includes the specified date. .IP "start" 4 .IX Item "start" The date to generated the calendar for. The date only needs to be specified to the precision necessary for the type of calendar. That is, \f(CW\*(C`YYYY\*(C'\fR for a yearly calendar, \f(CW\*(C`YYYYMM\*(C'\fR for a monthly, and \&\f(CW\*(C`YYYYMMDD\*(C'\fR for daily and weekly. In addition, the date can be in one of the following forms: .RS 4 .IP "YYYY[MM[\s-1DD\s0]]" 4 .IX Item "YYYY[MM[DD]]" .PD 0 .IP "YYYY[\-MM[\-DD]]" 4 .IX Item "YYYY[-MM[-DD]]" .IP "A DateTime object initialized to the necessary precision" 4 .IX Item "A DateTime object initialized to the necessary precision" .RE .RS 4 .RE .IP "files" 4 .IX Item "files" .PD An array reference to the list of icalendars to include in the results. .IP "url" 4 .IX Item "url" If this params is specified, then the html output will contain links back to this url for getting other calendar periods. The params \f(CW\*(C`type\*(C'\fR and \f(CW\*(C`date\*(C'\fR will be appended to this url when generating the links. .SH "AUTHOR" .IX Header "AUTHOR" Rick Frankel, cpan@rickster.com .SH "COPYRIGHT" .IX Header "COPYRIGHT" This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. .PP The full text of the license can be found in the \&\s-1LICENSE\s0 file included with this module. .SH "SEE ALSO" .IX Header "SEE ALSO" iCal::Parser::SAX, XML::LibXML::SAX::Builder, XML::LibXSLT, DateTime