.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32) .\" .\" Standard preamble: .\" ======================================================================== .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. \*(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- .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" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "RDF::Redland::RSS 3pm" .TH RDF::Redland::RSS 3pm "2016-06-22" "perl v5.24.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" RDF::Redland::RSS \- Redland RSS 1.0 Class .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use RDF::Redland::RSS; \& \& ... \& my $rss=RDF::Redland::RSS\->new_from_model($model); \& \& my $rss2=new RDF::Redland::RSS("http://example.com/test.rdf"); \& ... \& \& for my $channel ($rss\->channels) { \& ... \& print "channel title is ",$channel\->title\->as_string,"\en"; # UTF\-8 \& } \& \& my(@items)=$channel\->items; \& # Print channel items (URI, title) \& for my $item (@items) { \& print "item ",$item\->uri\->as_string, " ", $item\->title\->as_string, "\en"; \& } \& \& ... \& \& print $rss\->as_xhtml(width => 320, align => \*(Aqright\*(Aq); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" A class for processing \s-1RSS 1.0\s0 as \s-1RDF,\s0 traversing the resulting graph using \s-1RSS\s0 propertiiies and formatting the output as \s-1XHTML.\s0 .SH "CONSTRUCTORS" .IX Header "CONSTRUCTORS" .IP "new \s-1SOURCE_URI_STRING\s0 [\s-1BASE_URI_STRING\s0]" 4 .IX Item "new SOURCE_URI_STRING [BASE_URI_STRING]" Process \s-1RSS 1.0\s0 at source \s-1URI \s0\fI\s-1SOURCE_URI_STRING\s0\fR. If the \&\fI\s-1BASE_URI_STRING\s0\fR string is given then use that as the base \s-1URI\s0 rather than the source \s-1URI.\s0 .IP "new \s-1MODEL\s0" 4 .IX Item "new MODEL" Process \s-1RSS 1.0\s0 from content stored in RDF::Redland::Model \fI\s-1MODEL\s0\fR. .SH "METHODS" .IX Header "METHODS" .IP "channels" 4 .IX Item "channels" Return the \s-1RSS\s0 channels ( tags) as a list of RDF::Redland::RSS::Node objects. .IP "items" 4 .IX Item "items" Return the \s-1RSS\s0 items ( tags) as a list of RDF::Redland::RSS::Node objects. .IP "image" 4 .IX Item "image" Return the \s-1RSS 1.0\s0 image ( tag) as an RDF::Redland::RSS::Node object. .IP "textinput" 4 .IX Item "textinput" Return the \s-1RSS 1.0\s0 textinput ( tag) as an RDF::Redland::RSS::Node object. .IP "as_xhtml (key1 => value1, key2 => value2, ...)" 4 .IX Item "as_xhtml (key1 => value1, key2 => value2, ...)" Return a formatted \s-1XHTML\s0 string (or full \s-1XHTML\s0 document) representing the \s-1RSS 1.0\s0 content with various options set as listed in the section below. .Sp The parameters to this method are mostly from the specification of the viewRssBox macro at http://macros.userland.com/viewRssBox .SH "AS_XHTML OPTIONS" .IX Header "AS_XHTML OPTIONS" .IP "boxTitle" 4 .IX Item "boxTitle" A string, is the text displayed in the title of the box. It defaults to the title element of the channel. .IP "align" 4 .IX Item "align" A string, has three possible values, left, right or the empty string. The \s-1HTML\s0 table is either left-aligned, right-aligned or not aligned. It defaults to the empty string. .IP "width" 4 .IX Item "width" A number, is the width of the box, in pixels. It defaults to 125. Note that the title bar determines the minimum width of the box, if you're having trouble getting it to be narrower, try shortening boxTitle. .IP "frameColor" 4 .IX Item "frameColor" A string, is the hex browser color for the frame of the box. Defaults to \*(L"#000000\*(R". .IP "titleBarTextColor" 4 .IX Item "titleBarTextColor" A string, is the hex browser color for the text in the title bar of the box. Defalults to \*(L"#000000\*(R". .IP "titleBarColor" 4 .IX Item "titleBarColor" A string, is the hex browser color for the title bar of the box. Defaults to \*(L"#ADD8E6\*(R". .IP "boxFillColor" 4 .IX Item "boxFillColor" A string, is the hex browser color for the main part of the box. Defaults to \*(L"#FFFFFF\*(R". .IP "time" 4 .IX Item "time" A string, is text that's displayed as the time to the right of the box title. Defaults to "". .IP "hspace" 4 .IX Item "hspace" A number, is the number of pixels to the left and right of the box. Defaults to 0. .IP "vspace" 4 .IX Item "vspace" A number, is the number of pixels above and below the box. Defaults to 0. .IP "full" 4 .IX Item "full" If set to any value, returns a full \s-1XHTML\s0 document. Defaults to returning an \s-1HTML\s0 fragment. .IP "imageAlign" 4 .IX Item "imageAlign" A string, has two possible values, left or right. The channel image is either left-aligned or right-aligned. It defaults to right aligned. .SH "NAME" RDF::Redland::RSS::Node \- Redland RSS 1.0 Node Class .SH "DESCRIPTION" .IX Header "DESCRIPTION" Class representing concepts in an \s-1RSS 1.0 RDF\s0 graph. .SH "CONSTRUCTORS" .IX Header "CONSTRUCTORS" No public constructors. Nodes are created either by methods of this class or RDF::Redland::RSS. .SH "METHODS" .IX Header "METHODS" .IP "title" 4 .IX Item "title" Get the \s-1RSS\s0 titles for channel, image, item or textinput. Returns either a list or first one found depending on calling context. .IP "link" 4 .IX Item "link" Get the \s-1RSS\s0 link for channel, image, item or textinput. Returns either a list or first one found depending on calling context. .IP "description" 4 .IX Item "description" Get the Dublin Core description element or \s-1RSS\s0 description for channel, item or textinput. Returns either a list or first one found depending on calling context. .IP "image_url" 4 .IX Item "image_url" Get the \s-1RSS\s0 image \s-1URL\s0 string for an image. Returns either a list or first one found depending on calling context. .IP "name" 4 .IX Item "name" Get the \s-1RSS\s0 name for a textinput. Returns either a list or first one found depending on calling context. .IP "items" 4 .IX Item "items" Get the \s-1RSS\s0 items in a channel as a list of RDF::Redland::RSS::Node objects. .IP "image" 4 .IX Item "image" Get the image of a channel as an RDF::Redland::RSS::Node object or undef if not present. .IP "textinput" 4 .IX Item "textinput" Get the textinput of a channel as an RDF::Redland::RSS::Node object or undef if not present. .IP "property \s-1PROPERTY\s0" 4 .IX Item "property PROPERTY" Get the value of the named property off an RDF::Redland::RSS::Node where \&\fI\s-1PROPERTY\s0\fR is an RDF::Redland::Node or RDF::Redland::RSS::Node. Returns a list of RDF::Redland::RSS::Node objects or first one found depending on calling context. .IP "properties" 4 .IX Item "properties" Get all properties off the RDF::Redland::RSS::Node. Returns a list of RDF::Redland::RSS::Node objects. .IP "properties_with_ns_prefix \s-1NS_PREFIX\s0" 4 .IX Item "properties_with_ns_prefix NS_PREFIX" Get all unique properties of the RDF::Redland::RSS::Node which have namespace \s-1URI\s0 prefix \fI\s-1NS_PREFIX\s0\fR. Returns a list of the properties as RDF::Redland::RSS::Node objects. .SH "SEE ALSO" .IX Header "SEE ALSO" RDF::Redland::Model and \s-1RSS 1.0\s0 web pages at http://purl.org/rss/1.0/ .SH "AUTHOR" .IX Header "AUTHOR" Dave Beckett \- http://www.dajobe.org/