.\" -*- 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 "Summarize 3pm"
.TH Summarize 3pm 2024-02-24 "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
XMLTV::Summarize \- Perl extension to summarize XMLTV data
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 4
\&    # First get some data from the XMLTV module, eg:
\&    use XMLTV;
\&    my $data = XMLTV::parsefile(\*(Aqtv_sorted.xml\*(Aq);
\&    my ($encoding, $credits, $ch, $progs) = @$data;
\&
\&    # Now turn the sorted programmes into a printable summary.
\&    use XMLTV::Summarize qw(summarize);
\&    foreach (summarize($ch, $progs)) {
\&        if (not ref) {
\&            print "\enDay: $_\en\en";
\&        }
\&        else {
\&            my ($start, $stop, $title, $sub_title, $channel) = @$_;
\&            print "programme starts at $start, ";
\&            print "stops at $stop, " if defined $stop;
\&            print "has title $title ";
\&            print "and episode title $sub_title" if defined $sub_title;
\&            print ", on channel $channel.\en";
\&        }
\&    }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module processes programme and channel data from the XMLTV module
to help produce a human-readable summary or TV guide.  It takes care
of choosing the correct language (based on the LANG environment
variable) and of looking up the name of channels from their id.
.PP
There is one public routine, \f(CWsummarize()\fR.  This takes (references
to) a channels hash and a programmes list, the same format as those
returned by the XMLTV module.  It returns a list of 'summary' elements
where each element is a list of five items: start time, stop time,
title, 'sub\-title', and channel name.  The stop time and sub-title may
be undef.
.PP
The times are formatted as hh:mm, with a timezone appended when the
timezone changes in the middle of listings.  For the titles and
channel name, the shortest string that is in an acceptable language is
chosen.
.PP
The list of acceptable languages normally contains just one element,
taken from LANG, but you can set it manually as
\&\f(CW@XMLTV::Summarize::PREF_LANGS\fR if wished.
.SH AUTHOR
.IX Header "AUTHOR"
Ed Avis, ed@membled.com
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBXMLTV\fR\|(1).