NAME

Slash::XML::RSS - Perl extension for Slash


SYNOPSIS

        use Slash::XML;
        xmlDisplay(%data);


DESCRIPTION

LONG DESCRIPTION.


EXPORTED FUNCTIONS

create(PARAM)

Creates RSS.

Parameters
PARAM
Hashref of parameters. Currently supported options are below.
version
Defaults to ``1.0''. May be >= ``1.0'', >= ``0.91'', or ``0.9''.

rdfencoding
Defaults to ``rdfencoding'' in vars.

title
Defaults to ``sitename'' in vars.

description
Defaults to ``slogan'' in vars.

link
Defaults to ``absolutedir'' in vars.

date
Defaults to current date. See date2iso8601().

subject
Defaults to ``rdfsubject'' in vars.

language
Defaults to ``rdflanguage'' in vars.

creator
Defaults to ``adminmail'' in vars.

publisher
Defaults to ``rdfpublisher'' in vars.

rights
Defaults to ``rdfrights'' in vars.

updatePeriod
Defaults to ``rdfupdateperiod'' in vars.

updateFrequency
Defaults to ``rdfupdatefrequency'' in vars.

updateBase
Defaults to ``rdfupdatebase'' in vars.

image
If scalar, then just prints the default image data if scalar is true. If hashref, then may have ``title'', ``url'', and ``link'' passed.

textinput
If scalar, then just prints the default textinput data if scalar is true. If hashref, then may have ``title'', ``description'', ``name'', and ``link'' passed.

items
An arrayref of hashrefs. If the ``story'' key of the hashref is true, then the item is passed to rss_story(). Otherwise, ``title'' and ``link'' must be defined keys, and any other single-level key may be defined (no multiple level hash keys).

Return value
The complete RSS data as a string.

rss_story(ITEM, ENCODED_ITEM, VERSION)

Set up a story item for RSS. Called from create().

Parameters
ITEM
The item hashref passed in the items param key passed to xmlDisplay().

ENCODED_ITEM
The prepared encoded data from ITEM.

VERSION
The VERSION as defined in create(). Does the Right Thing for >= ``1.0'', >= ``0.91'', and ``0.9''.

Return value
The encoded item.

rss_item_description(DESC)

Set up an item description. If rdfitemdesc in the vars table is ``1'', then prints an item's description. If it is some other true value, it will chop the description to that length. If it is false, then no description for the item will be printed.

Parameters
DESC
The description.

Return value
The fixed description.


SEE ALSO

Slash(3), Slash::XML(3).


VERSION

$Id: RSS.pm,v 1.1.2.4 2001/08/28 15:35:19 jamie Exp $