xmltv::summarize(3pm) [debian man page]

Summarize(3pm)						User Contributed Perl Documentation					    Summarize(3pm)

NAME

       XMLTV::Summarize - Perl extension to summarize XMLTV data

SYNOPSIS

	   # First get some data from the XMLTV module, eg:
	   use XMLTV;
	   my $data = XMLTV::parsefile('tv_sorted.xml');
	   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 "
Day: $_

";
	       }
	       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.
";
	       }
	   }

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.

       There is one public routine, "summarize()".  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.

       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.

       The list of acceptable languages normally contains just one element, taken from LANG, but you can set it manually as
       @XMLTV::Summarize::PREF_LANGS if wished.

AUTHOR

       Ed Avis, ed@membled.com

SEE ALSO

       XMLTV(1).

perl v5.14.2							    2004-01-03							    Summarize(3pm)

ValidateFile(3pm)					User Contributed Perl Documentation					 ValidateFile(3pm)

NAME

       XMLTV::ValidateFile - Validates an XMLTV file

DESCRIPTION

       Utility library that validates that a file is correct according to http://wiki.xmltv.org/index.php/XMLTVFormat.

EXPORTED FUNCTIONS

       All these functions are exported on demand.

       LoadDtd
	   Load the xmltv dtd. Takes a single parameter which is the name of the xmltv dtd file.

	   LoadDtd must be called before ValidateFile can be called.

       ValidateFile
	   Validate that a file is valid according to the XMLTV dtd and try to check that it contains valid information. ValidateFile takes a
	   filename as parameter and optionally also a day and an offset and prints error messages to STDERR.

	   ValidateFile returns a list of errors that it found with the file. Each error takes the form of a keyword:

	   ValidateFile checks the following:

	   notwell
	       The file is not well-formed XML.

	   notdtd
	       The file does not follow the XMLTV DTD.

	   unknownid
	       No channel-entry found for a channelid that is used in a programme-entry.

	   duplicatechannel
	       More than one channel-entry found for a channelid.

	   noprogrammes
	       No programme entries were found in the file.

	   channelnoprogramme
	       There are no programme entries for one of the channels listed with a channel-entry.

	   invalidid
	       An xmltvid does not look like a proper id, i.e. it does not  match /^[-a-zA-Z0-9]+(.[-a-zA-Z0-9]+)+$/.

	   noid
	       A programme-entry without an id was found.

	   emptytitle
	       A programme entry with an empty or missing title was found.

	   emptydescription
	       A programme entry with an empty desc-element was found. The desc-element shall be omitted if there is no description.

	   badstart
	       A programme entry with an invalid start-time was found.

	   badstop
	       A programme entry with an invalid stop-time was found.

	   badepisode
	       A programme entry with an invalid episode number was found.

	   badiso8859
	       The file is encoded in iso-8859 but contains characters that have no meaning in iso-8859 (or are control characters).  If it's
	       iso-8859-1 aka Latin 1 it might be some characters in windows-1252 encoding.

	   badutf8
	       The file is encoded in utf-8 but contains characters that look strange.	1) Mis-encoded single characters represented with
	       [EF][BF][BD] bytes 2) Mis-encoded single characters represented with [C3][AF][C2][BF][C2][BD] bytes 3) Mis-encoded single
	       characters in range [C2][80-9F]

	   If no errors are found, an empty list is returned.

BUGS

       It is currently necessary to specify the path to the xmltv dtd-file.  This should not be necessary.

COPYRIGHT

       Copyright (C) 2006 Mattias Holmlund.

       This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by
       the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

       This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

       You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation,
       Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

perl v5.14.2							    2011-06-22							 ValidateFile(3pm)