.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" 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::Feed::Entry 3pm"
.TH XML::Feed::Entry 3pm "2021-09-01" "perl v5.32.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"
XML::Feed::Entry \- Entry/item in a syndication feed
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 4
\&    ## $feed is an XML::Feed object.
\&    for my $entry ($feed\->entries) {
\&        print $entry\->title, "\en", $entry\->summary, "\en\en";
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fIXML::Feed::Entry\fR represents an entry/item in an XML::Feed syndication
feed.
.SH "USAGE"
.IX Header "USAGE"
.SS "XML::Feed::Entry\->new($format)"
.IX Subsection "XML::Feed::Entry->new($format)"
Creates a new \fIXML::Feed::Entry\fR object in the format \fI\f(CI$format\fI\fR, which
should be either \fI\s-1RSS\s0\fR or \fIAtom\fR.
.ie n .SS "$entry\->convert($format)"
.el .SS "\f(CW$entry\fP\->convert($format)"
.IX Subsection "$entry->convert($format)"
Converts the \fIXML::Feed::Entry\fR object into the \fI\f(CI$format\fI\fR format, and
returns the new object.
.ie n .SS "$entry\->title([ $title ])"
.el .SS "\f(CW$entry\fP\->title([ \f(CW$title\fP ])"
.IX Subsection "$entry->title([ $title ])"
The title of the entry.
.ie n .SS "$entry\->base([ $base ])"
.el .SS "\f(CW$entry\fP\->base([ \f(CW$base\fP ])"
.IX Subsection "$entry->base([ $base ])"
The url base of the entry.
.ie n .SS "$entry\->link([ $uri ])"
.el .SS "\f(CW$entry\fP\->link([ \f(CW$uri\fP ])"
.IX Subsection "$entry->link([ $uri ])"
The permalink of the entry, in most cases, except in cases where it points
instead to an offsite \s-1URI\s0 referenced in the entry.
.ie n .SS "$entry\->content([ $content ])"
.el .SS "\f(CW$entry\fP\->content([ \f(CW$content\fP ])"
.IX Subsection "$entry->content([ $content ])"
An XML::Feed::Content object representing the full entry body, or as
much as is available in the feed.
.PP
In \s-1RSS\s0 feeds, this method will look first for
<http://purl.org/rss/1.0/modules/content/#encoded> and
<http://www.w3.org/1999/xhtml#body> elements, then fall back to a
\&\fI<description>\fR element.
.ie n .SS "$entry\->summary([ $summary ])"
.el .SS "\f(CW$entry\fP\->summary([ \f(CW$summary\fP ])"
.IX Subsection "$entry->summary([ $summary ])"
An XML::Feed::Content object representing a short summary of the entry.
Possibly.
.PP
Since \s-1RSS\s0 feeds do not have the idea of a summary separate from the entry
body, this may not always be what you want. If the entry contains both a
\&\fI<description>\fR element \fBand\fR another element typically used for
the full content of the entry\*(--either \fIhttp://www.w3.org/1999/xhtml/body\fR
or <http://purl.org/rss/1.0/modules/content/#encoded>\-\-we treat that as
the summary. Otherwise, we assume that there isn't a summary, and return
an XML::Feed::Content object with an empty string in the \fIbody\fR.
.ie n .SS "$entry\->category([ $category ])"
.el .SS "\f(CW$entry\fP\->category([ \f(CW$category\fP ])"
.IX Subsection "$entry->category([ $category ])"
The category in which the entry was posted.
.PP
Returns a list of categories if called in array context or the first
category if called in scalar context.
.PP
\&\fB\s-1WARNING\s0\fR It's possible this \s-1API\s0 might change to have an
\&\fIadd_category\fR instead.
.ie n .SS "$entry\->tags([ $tag ])"
.el .SS "\f(CW$entry\fP\->tags([ \f(CW$tag\fP ])"
.IX Subsection "$entry->tags([ $tag ])"
A synonym (alias) for \fIcategory\fR;
.ie n .SS "$entry\->author([ $author ])"
.el .SS "\f(CW$entry\fP\->author([ \f(CW$author\fP ])"
.IX Subsection "$entry->author([ $author ])"
The name or email address of the person who posted the entry.
.ie n .SS "$entry\->id([ $id ])"
.el .SS "\f(CW$entry\fP\->id([ \f(CW$id\fP ])"
.IX Subsection "$entry->id([ $id ])"
The unique \s-1ID\s0 of the entry.
.ie n .SS "$entry\->issued([ $issued ])"
.el .SS "\f(CW$entry\fP\->issued([ \f(CW$issued\fP ])"
.IX Subsection "$entry->issued([ $issued ])"
A \fIDateTime\fR object representing the date and time at which the entry
was posted.
.PP
If present, \fI\f(CI$issued\fI\fR should be a \fIDateTime\fR object.
.ie n .SS "$entry\->modified([ $modified ])"
.el .SS "\f(CW$entry\fP\->modified([ \f(CW$modified\fP ])"
.IX Subsection "$entry->modified([ $modified ])"
A \fIDateTime\fR object representing the last-modified date of the entry.
.PP
If present, \fI\f(CI$modified\fI\fR should be a \fIDateTime\fR object.
.ie n .SS "$entry\->wrap"
.el .SS "\f(CW$entry\fP\->wrap"
.IX Subsection "$entry->wrap"
Take an entry in its native format and turn it into an \fIXML::Feed::Entry\fR object.
.ie n .SS "$entry\->unwrap"
.el .SS "\f(CW$entry\fP\->unwrap"
.IX Subsection "$entry->unwrap"
Take an \fIXML::Feed::Entry\fR object and turn it into its native format.
.SH "AUTHOR & COPYRIGHT"
.IX Header "AUTHOR & COPYRIGHT"
Please see the \fIXML::Feed\fR manpage for author, copyright, and license
information.