NAME

XML::RSS::PicLens - Create a PicLens compatible RSS feed

VERSION

This document describes XML::RSS::PicLens version 0.04

SYNOPSIS

  use XML::RSS::PicLens;

  my $feed = XML::RSS::PicLens->new;
  $feed->add_content(
    link      => 'foo.jpg',
    image     => 'foo.jpg',
    thumbnail => 'thumbs/foo.jpg',
    title     => 'An bootiful foo'
  );
  print $feed->as_string;

DESCRIPTION

PicLens is an immersive media browser that can be launched directly from a web browser when visiting a supported site. It uses RSS autodiscovery to locate an RSS feed describing the available media. This module provides a simple interface for generating such a feed.

See http://piclens.com/lite/webmasterguide.php for more information.

INTERFACE

new

Create a new XML::RSS::PicLens object. XML::RSS::PicLens is a subclass of XML::RSS; any arguments to new are passed to the superclass's constructor. The RSS version defaults to 2.0.

add_content

Add media content to the feed:

    $feed->add_content(
        link            => 'foo.jpg',
        content         => 'foo.jpg',
        thumbnail       => 'thumbs/foo.jpg',
        title           => 'An bootiful foo',
        content_type    => 'image/jpeg',
        thumbnail_type  => 'image/jpeg',
    );

At least one of content, thumbnail must be supplied. Optionally you may supply link and title. If these are omitted they will default to values based on content or thumbnail.

The optional content_type and thumbnail_type items may be used to specify the MIME types of the content.

For backwards compatibility with previous versions image and image_type are accepted as aliases for content and content_type.

add_image

An alias for add_content for backwards compatibility with previous versions. Use add_content in new code.

as_string

Gets a string containing the XML for the feed.

CONFIGURATION AND ENVIRONMENT

XML::RSS::PicLens requires no configuration files or environment variables.

DEPENDENCIES

None.

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to bug-xml-atom-piclens@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR

Andy Armstrong <andy.armstrong@messagesystems.com>

LICENCE AND COPYRIGHT

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

Copyright (c) 2008, Message Systems, Inc. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in
      the documentation and/or other materials provided with the
      distribution.
    * Neither the name Message Systems, Inc. nor the names of its
      contributors may be used to endorse or promote products derived
      from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.