NAME

Slash::XML - Perl extension for Slash


SYNOPSIS

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


DESCRIPTION

Slash::XML aids in creating XML. Right now, only RSS is supported.


EXPORTED FUNCTIONS

xmlDisplay(TYPE, PARAM [, OPTIONS])

Creates XML data.

Parameters
TYPE
The XML type, which determines which XML creation routine to call. Right now, supports only ``rss'' which calls XML::RSS::create().

PARAM
A hashref of parameters to pass to the XML creation routine.

OPTIONS
Hashref of options. Currently supported options are below. If OPTIONS is the value 1 instead of a hashref, that will be the same as if the hashref were { Return => 1 }.
Return
Boolean for whether to print (false) or return (true) the processed template data. Default is to print output via Apache, with full HTML headers.

Return value
If OPTIONS->{Return} is true, the XML data. Otherwise, returns true/false for success/failure.

date2iso8601([TIME])

Return a standard ISO 8601 time string.

Parameters
TIME
Some sort of string in GMT that can be parsed by Date::Parse. If no TIME given, uses current time.

Return value
The time string.

encode(VALUE [, KEY])

Encodes the data to put it into the XML. Normally will encode assuming the parsed data will be printed in HTML. See KEY.

Parameters
VALUE
Value to be encoded.

KEY
If KEY is ``link'', then data will be encoded so as NOT to assume the parsed data will be printed in HTML.

Return value
The encoded data.

Dependencies
See xmlencode() and xmlencode_plain() in Slash::Utility.


SEE ALSO

Slash(3), Slash::Utility(3), XML::Parser(3), XML::RSS(3).