.\" 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 "XML 3" .TH XML 3 "2001-10-24" "perl v5.8.8" "User Contributed Perl Documentation" .SH "NAME" Slash::XML \- Perl extension for Slash .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& use Slash::XML; \& xmlDisplay(%data); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Slash::XML aids in creating \s-1XML\s0. Right now, only \s-1RSS\s0 is supported. .SH "EXPORTED FUNCTIONS" .IX Header "EXPORTED FUNCTIONS" .Sh "xmlDisplay(\s-1TYPE\s0, \s-1PARAM\s0 [, \s-1OPTIONS\s0])" .IX Subsection "xmlDisplay(TYPE, PARAM [, OPTIONS])" Creates \s-1XML\s0 data. .IP "Parameters" 4 .IX Item "Parameters" .RS 4 .PD 0 .IP "\s-1TYPE\s0" 4 .IX Item "TYPE" .PD The \s-1XML\s0 type, which determines which \s-1XML\s0 creation routine to call. Right now, supports only \*(L"rss\*(R" which calls \fIXML::RSS::create()\fR. .IP "\s-1PARAM\s0" 4 .IX Item "PARAM" A hashref of parameters to pass to the \s-1XML\s0 creation routine. .IP "\s-1OPTIONS\s0" 4 .IX Item "OPTIONS" Hashref of options. Currently supported options are below. If \s-1OPTIONS\s0 is the value \f(CW1\fR instead of a hashref, that will be the same as if the hashref were \f(CW\*(C`{ Return => 1 }\*(C'\fR. .RS 4 .IP "Return" 4 .IX Item "Return" Boolean for whether to print (false) or return (true) the processed template data. Default is to print output via Apache, with full \s-1HTML\s0 headers. .RE .RS 4 .RE .RE .RS 4 .RE .IP "Return value" 4 .IX Item "Return value" If \s-1OPTIONS\-\s0>{Return} is true, the \s-1XML\s0 data. Otherwise, returns true/false for success/failure. .Sh "date2iso8601([\s-1TIME\s0])" .IX Subsection "date2iso8601([TIME])" Return a standard \s-1ISO\s0 8601 time string. .IP "Parameters" 4 .IX Item "Parameters" .RS 4 .PD 0 .IP "\s-1TIME\s0" 4 .IX Item "TIME" .PD Some sort of string in \s-1GMT\s0 that can be parsed by Date::Parse. If no \s-1TIME\s0 given, uses current time. .RE .RS 4 .RE .IP "Return value" 4 .IX Item "Return value" The time string. .Sh "encode(\s-1VALUE\s0 [, \s-1KEY\s0])" .IX Subsection "encode(VALUE [, KEY])" Encodes the data to put it into the \s-1XML\s0. Normally will encode assuming the parsed data will be printed in \s-1HTML\s0. See \s-1KEY\s0. .IP "Parameters" 4 .IX Item "Parameters" .RS 4 .PD 0 .IP "\s-1VALUE\s0" 4 .IX Item "VALUE" .PD Value to be encoded. .IP "\s-1KEY\s0" 4 .IX Item "KEY" If \s-1KEY\s0 is \*(L"link\*(R", then data will be encoded so as \s-1NOT\s0 to assume the parsed data will be printed in \s-1HTML\s0. .RE .RS 4 .RE .IP "Return value" 4 .IX Item "Return value" The encoded data. .IP "Dependencies" 4 .IX Item "Dependencies" See \fIxmlencode()\fR and \fIxmlencode_plain()\fR in Slash::Utility. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fISlash\fR\|(3), \fISlash::Utility\fR\|(3), \fIXML::Parser\fR\|(3), \s-1\fIXML::RSS\s0\fR\|(3).