.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "RSS 3"
.TH RSS 3 "2001-09-05" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Slash::XML::RSS \- Perl extension for Slash
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&        use Slash::XML;
\&        xmlDisplay(%data);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\s-1LONG\s0 \s-1DESCRIPTION\s0.
.SH "EXPORTED FUNCTIONS"
.IX Header "EXPORTED FUNCTIONS"
.Sh "create(\s-1PARAM\s0)"
.IX Subsection "create(PARAM)"
Creates \s-1RSS\s0.
.IP "Parameters" 4
.IX Item "Parameters"
.RS 4
.PD 0
.IP "\s-1PARAM\s0" 4
.IX Item "PARAM"
.PD
Hashref of parameters.  Currently supported options are below.
.RS 4
.IP "version" 4
.IX Item "version"
Defaults to \*(L"1.0\*(R".  May be >= \*(L"1.0\*(R", >= \*(L"0.91\*(R", or \*(L"0.9\*(R".
.IP "rdfencoding" 4
.IX Item "rdfencoding"
Defaults to \*(L"rdfencoding\*(R" in vars.
.IP "title" 4
.IX Item "title"
Defaults to \*(L"sitename\*(R" in vars.
.IP "description" 4
.IX Item "description"
Defaults to \*(L"slogan\*(R" in vars.
.IP "link" 4
.IX Item "link"
Defaults to \*(L"absolutedir\*(R" in vars.
.IP "date" 4
.IX Item "date"
Defaults to current date.  See \fIdate2iso8601()\fR.
.IP "subject" 4
.IX Item "subject"
Defaults to \*(L"rdfsubject\*(R" in vars.
.IP "language" 4
.IX Item "language"
Defaults to \*(L"rdflanguage\*(R" in vars.
.IP "creator" 4
.IX Item "creator"
Defaults to \*(L"adminmail\*(R" in vars.
.IP "publisher" 4
.IX Item "publisher"
Defaults to \*(L"rdfpublisher\*(R" in vars.
.IP "rights" 4
.IX Item "rights"
Defaults to \*(L"rdfrights\*(R" in vars.
.IP "updatePeriod" 4
.IX Item "updatePeriod"
Defaults to \*(L"rdfupdateperiod\*(R" in vars.
.IP "updateFrequency" 4
.IX Item "updateFrequency"
Defaults to \*(L"rdfupdatefrequency\*(R" in vars.
.IP "updateBase" 4
.IX Item "updateBase"
Defaults to \*(L"rdfupdatebase\*(R" in vars.
.IP "image" 4
.IX Item "image"
If scalar, then just prints the default image data if scalar is true.
If hashref, then may have \*(L"title\*(R", \*(L"url\*(R", and \*(L"link\*(R" passed.
.IP "textinput" 4
.IX Item "textinput"
If scalar, then just prints the default textinput data if scalar is true.
If hashref, then may have \*(L"title\*(R", \*(L"description\*(R", \*(L"name\*(R", and \*(L"link\*(R" passed.
.IP "items" 4
.IX Item "items"
An arrayref of hashrefs.  If the \*(L"story\*(R" key of the hashref is true,
then the item is passed to \fIrss_story()\fR.  Otherwise, \*(L"title\*(R" and \*(L"link\*(R" must
be defined keys, and any other single-level key may be defined
(no multiple level hash keys).
.RE
.RS 4
.RE
.RE
.RS 4
.RE
.IP "Return value" 4
.IX Item "Return value"
The complete \s-1RSS\s0 data as a string.
.Sh "rss_story(\s-1ITEM\s0, \s-1ENCODED_ITEM\s0, \s-1VERSION\s0)"
.IX Subsection "rss_story(ITEM, ENCODED_ITEM, VERSION)"
Set up a story item for \s-1RSS\s0.  Called from \fIcreate()\fR.
.IP "Parameters" 4
.IX Item "Parameters"
.RS 4
.PD 0
.IP "\s-1ITEM\s0" 4
.IX Item "ITEM"
.PD
The item hashref passed in the items param key passed to \fIxmlDisplay()\fR.
.IP "\s-1ENCODED_ITEM\s0" 4
.IX Item "ENCODED_ITEM"
The prepared encoded data from \s-1ITEM\s0.
.IP "\s-1VERSION\s0" 4
.IX Item "VERSION"
The \s-1VERSION\s0 as defined in \fIcreate()\fR.  Does the Right Thing for >= \*(L"1.0\*(R",
>= \*(L"0.91\*(R", and \*(L"0.9\*(R".
.RE
.RS 4
.RE
.IP "Return value" 4
.IX Item "Return value"
The encoded item.
.Sh "rss_item_description(\s-1DESC\s0)"
.IX Subsection "rss_item_description(DESC)"
Set up an item description.  If rdfitemdesc in the vars table is \*(L"1\*(R",
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.
.IP "Parameters" 4
.IX Item "Parameters"
.RS 4
.PD 0
.IP "\s-1DESC\s0" 4
.IX Item "DESC"
.PD
The description.
.RE
.RS 4
.RE
.IP "Return value" 4
.IX Item "Return value"
The fixed description.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fISlash\fR\|(3), \fISlash::XML\fR\|(3).
.SH "VERSION"
.IX Header "VERSION"
$Id: \s-1RSS\s0.pm,v 1.1.2.4 2001/08/28 15:35:19 jamie Exp $