.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.el \{\
. de IX
..
.\}
.\"
.\" 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::Atom::Atompub 3pm"
.TH XML::Atom::Atompub 3pm "2012-04-04" "perl v5.14.2" "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::Atom::Atompub
\&\- Extensions of XML::Atom for the Atom Publishing Protocol
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\& use XML::Atom::Entry;
\& use XML::Atom::Feed;
\& use XML::Atom::Atompub;
\&
\& my $entry = XML::Atom::Entry\->new;
\&
\& # 2007\-01\-01T00:00:00Z
\& $entry\->edited(\*(Aq2007\-01\-01T00:00:00Z\*(Aq);
\&
\& # yes
\& my $control = XML::Atom::Control\->new;
\& $control\->draft(\*(Aqyes\*(Aq);
\& $entry\->control($control);
\&
\& #
\& my $content = XML::Atom::Content\->new;
\& $content\->type(\*(Aqimage/png\*(Aq);
\& $content\->src(\*(Aqhttp://example.com/foo.png\*(Aq);
\& $entry\->content($content);
\&
\& #
\& $entry\->alternate_link(\*(Aqhttp://example.com/foo.html\*(Aq);
\&
\& my $feed = XML::Atom::Feed\->new;
\&
\& #
\& $feed\->self_link(\*(Aqhttp://example.com\*(Aq);
.Ve
.SH "METHODS of XML::Atom"
.IX Header "METHODS of XML::Atom"
Some elements are introduced by the Atom Publishing Protocol, which
are imported into XML::Atom by this module.
.ie n .SS "$entry\->control([ $control ])"
.el .SS "\f(CW$entry\fP\->control([ \f(CW$control\fP ])"
.IX Subsection "$entry->control([ $control ])"
Returns an XML::Atom::Control object representing the control of the
Entry, or \f(CW\*(C`undef\*(C'\fR if there is no control.
.PP
If \f(CW$control\fR is supplied, it should be an XML::Atom::Control object
representing the control. For example:
.PP
.Vb 3
\& my $control = XML::Atom::Control\->new;
\& $control\->draft(\*(Aqyes\*(Aq);
\& $entry\->control($control);
.Ve
.ie n .SS "$entry\->edited([ $edited ])"
.el .SS "\f(CW$entry\fP\->edited([ \f(CW$edited\fP ])"
.IX Subsection "$entry->edited([ $edited ])"
Returns an \fIatom:edited\fR element.
.PP
If \f(CW$edited\fR is given, sets the \fIatom:edited\fR element.
.ie n .SS "$content\->src([ $src ])"
.el .SS "\f(CW$content\fP\->src([ \f(CW$src\fP ])"
.IX Subsection "$content->src([ $src ])"
Returns a value of \fIsrc\fR attribute in \fIatom:content\fR element.
.PP
If \f(CW$src\fR is given, the \fIsrc\fR attribute is added.
.ie n .SS "$atom\->alternate_link([ $href ])"
.el .SS "\f(CW$atom\fP\->alternate_link([ \f(CW$href\fP ])"
.IX Subsection "$atom->alternate_link([ $href ])"
Returns a value of \fIhref\fR attribute in \fIatom:link\fR element with a link relation of \fIalternate\fR.
.PP
If \f(CW$href\fR is given, an \fIatom:link\fR element with a link relation of \fIalternate\fR is added.
.ie n .SS "$atom\->self_link([ $href ])"
.el .SS "\f(CW$atom\fP\->self_link([ \f(CW$href\fP ])"
.IX Subsection "$atom->self_link([ $href ])"
Returns a value of \fIhref\fR attribute in \fIatom:link\fR element with a link relation of \fIself\fR.
.PP
If \f(CW$href\fR is given, an \fIatom:link\fR element with a link relation of \fIself\fR is added.
.ie n .SS "$atom\->edit_link([ $href ])"
.el .SS "\f(CW$atom\fP\->edit_link([ \f(CW$href\fP ])"
.IX Subsection "$atom->edit_link([ $href ])"
Returns a value of \fIhref\fR attribute in \fIatom:link\fR element with a link relation of \fIedit\fR.
.PP
If \f(CW$href\fR is given, an \fIatom:link\fR element with a link relation of \fIedit\fR is added.
.ie n .SS "$atom\->edit_media_link([ $href ])"
.el .SS "\f(CW$atom\fP\->edit_media_link([ \f(CW$href\fP ])"
.IX Subsection "$atom->edit_media_link([ $href ])"
Returns a value of \fIhref\fR attribute in \fIatom:link\fR element with a link relation of \fIedit-media\fR.
.PP
If \f(CW$href\fR is given, an \fIatom:link\fR element with a link relation of \fIedit-media\fR is added.
.ie n .SS "$atom\->related_link([ $href ])"
.el .SS "\f(CW$atom\fP\->related_link([ \f(CW$href\fP ])"
.IX Subsection "$atom->related_link([ $href ])"
Returns a value of \fIhref\fR attribute in \fIatom:link\fR element with a link relation of \fIrelated\fR.
.PP
If \f(CW$href\fR is given, an \fIatom:link\fR element with a link relation of \fIrelated\fR is added.
.ie n .SS "$atom\->enclosure_link([ $href ])"
.el .SS "\f(CW$atom\fP\->enclosure_link([ \f(CW$href\fP ])"
.IX Subsection "$atom->enclosure_link([ $href ])"
Returns a value of \fIhref\fR attribute in \fIatom:link\fR element with a link relation of \fIenclosure\fR.
.PP
If \f(CW$href\fR is given, an \fIatom:link\fR element with a link relation of \fIenclosure\fR is added.
.ie n .SS "$atom\->via_link([ $href ])"
.el .SS "\f(CW$atom\fP\->via_link([ \f(CW$href\fP ])"
.IX Subsection "$atom->via_link([ $href ])"
Returns a value of \fIhref\fR attribute in \fIatom:link\fR element with a link relation of \fIvia\fR.
.PP
If \f(CW$href\fR is given, an \fIatom:link\fR element with a link relation of \fIvia\fR is added.
.ie n .SS "$atom\->first_link([ $href ])"
.el .SS "\f(CW$atom\fP\->first_link([ \f(CW$href\fP ])"
.IX Subsection "$atom->first_link([ $href ])"
Returns a value of \fIhref\fR attribute in \fIatom:link\fR element with a link relation of \fIfirst\fR.
.PP
If \f(CW$href\fR is given, an \fIatom:link\fR element with a link relation of \fIfirst\fR is added.
.ie n .SS "$atom\->previous_link([ $href ])"
.el .SS "\f(CW$atom\fP\->previous_link([ \f(CW$href\fP ])"
.IX Subsection "$atom->previous_link([ $href ])"
Returns a value of \fIhref\fR attribute in \fIatom:link\fR element with a link relation of \fIprevious\fR.
.PP
If \f(CW$href\fR is given, an \fIatom:link\fR element with a link relation of \fIprevious\fR is added.
.ie n .SS "$atom\->next_link([ $href ])"
.el .SS "\f(CW$atom\fP\->next_link([ \f(CW$href\fP ])"
.IX Subsection "$atom->next_link([ $href ])"
Returns a value of \fIhref\fR attribute in \fIatom:link\fR element with a link relation of \fInext\fR.
.PP
If \f(CW$href\fR is given, an \fIatom:link\fR element with a link relation of \fInext\fR is added.
.ie n .SS "$atom\->last_link([ $href ])"
.el .SS "\f(CW$atom\fP\->last_link([ \f(CW$href\fP ])"
.IX Subsection "$atom->last_link([ $href ])"
Returns a value of \fIhref\fR attribute in \fIatom:link\fR element with a link relation of \fIlast\fR.
.PP
If \f(CW$href\fR is given, an \fIatom:link\fR element with a link relation of \fIlast\fR is added.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
XML::Atom
XML::Atom::Service
.SH "AUTHOR"
.IX Header "AUTHOR"
Takeru \s-1INOUE\s0,
.SH "LICENCE AND COPYRIGHT"
.IX Header "LICENCE AND COPYRIGHT"
Copyright (c) 2007, Takeru \s-1INOUE\s0 \f(CW\*(C`\*(C'\fR. All rights reserved.
.PP
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See perlartistic.
.SH "DISCLAIMER OF WARRANTY"
.IX Header "DISCLAIMER OF WARRANTY"
\&\s-1BECAUSE\s0 \s-1THIS\s0 \s-1SOFTWARE\s0 \s-1IS\s0 \s-1LICENSED\s0 \s-1FREE\s0 \s-1OF\s0 \s-1CHARGE\s0, \s-1THERE\s0 \s-1IS\s0 \s-1NO\s0 \s-1WARRANTY\s0
\&\s-1FOR\s0 \s-1THE\s0 \s-1SOFTWARE\s0, \s-1TO\s0 \s-1THE\s0 \s-1EXTENT\s0 \s-1PERMITTED\s0 \s-1BY\s0 \s-1APPLICABLE\s0 \s-1LAW\s0. \s-1EXCEPT\s0 \s-1WHEN\s0
\&\s-1OTHERWISE\s0 \s-1STATED\s0 \s-1IN\s0 \s-1WRITING\s0 \s-1THE\s0 \s-1COPYRIGHT\s0 \s-1HOLDERS\s0 \s-1AND/OR\s0 \s-1OTHER\s0 \s-1PARTIES\s0
\&\s-1PROVIDE\s0 \s-1THE\s0 \s-1SOFTWARE\s0 \*(L"\s-1AS\s0 \s-1IS\s0\*(R" \s-1WITHOUT\s0 \s-1WARRANTY\s0 \s-1OF\s0 \s-1ANY\s0 \s-1KIND\s0, \s-1EITHER\s0
\&\s-1EXPRESSED\s0 \s-1OR\s0 \s-1IMPLIED\s0, \s-1INCLUDING\s0, \s-1BUT\s0 \s-1NOT\s0 \s-1LIMITED\s0 \s-1TO\s0, \s-1THE\s0 \s-1IMPLIED\s0
\&\s-1WARRANTIES\s0 \s-1OF\s0 \s-1MERCHANTABILITY\s0 \s-1AND\s0 \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0. \s-1THE\s0
\&\s-1ENTIRE\s0 \s-1RISK\s0 \s-1AS\s0 \s-1TO\s0 \s-1THE\s0 \s-1QUALITY\s0 \s-1AND\s0 \s-1PERFORMANCE\s0 \s-1OF\s0 \s-1THE\s0 \s-1SOFTWARE\s0 \s-1IS\s0 \s-1WITH\s0
\&\s-1YOU\s0. \s-1SHOULD\s0 \s-1THE\s0 \s-1SOFTWARE\s0 \s-1PROVE\s0 \s-1DEFECTIVE\s0, \s-1YOU\s0 \s-1ASSUME\s0 \s-1THE\s0 \s-1COST\s0 \s-1OF\s0 \s-1ALL\s0
\&\s-1NECESSARY\s0 \s-1SERVICING\s0, \s-1REPAIR\s0, \s-1OR\s0 \s-1CORRECTION\s0.
.PP
\&\s-1IN\s0 \s-1NO\s0 \s-1EVENT\s0 \s-1UNLESS\s0 \s-1REQUIRED\s0 \s-1BY\s0 \s-1APPLICABLE\s0 \s-1LAW\s0 \s-1OR\s0 \s-1AGREED\s0 \s-1TO\s0 \s-1IN\s0 \s-1WRITING\s0
\&\s-1WILL\s0 \s-1ANY\s0 \s-1COPYRIGHT\s0 \s-1HOLDER\s0, \s-1OR\s0 \s-1ANY\s0 \s-1OTHER\s0 \s-1PARTY\s0 \s-1WHO\s0 \s-1MAY\s0 \s-1MODIFY\s0 \s-1AND/OR\s0
\&\s-1REDISTRIBUTE\s0 \s-1THE\s0 \s-1SOFTWARE\s0 \s-1AS\s0 \s-1PERMITTED\s0 \s-1BY\s0 \s-1THE\s0 \s-1ABOVE\s0 \s-1LICENCE\s0, \s-1BE\s0
\&\s-1LIABLE\s0 \s-1TO\s0 \s-1YOU\s0 \s-1FOR\s0 \s-1DAMAGES\s0, \s-1INCLUDING\s0 \s-1ANY\s0 \s-1GENERAL\s0, \s-1SPECIAL\s0, \s-1INCIDENTAL\s0,
\&\s-1OR\s0 \s-1CONSEQUENTIAL\s0 \s-1DAMAGES\s0 \s-1ARISING\s0 \s-1OUT\s0 \s-1OF\s0 \s-1THE\s0 \s-1USE\s0 \s-1OR\s0 \s-1INABILITY\s0 \s-1TO\s0 \s-1USE\s0
\&\s-1THE\s0 \s-1SOFTWARE\s0 (\s-1INCLUDING\s0 \s-1BUT\s0 \s-1NOT\s0 \s-1LIMITED\s0 \s-1TO\s0 \s-1LOSS\s0 \s-1OF\s0 \s-1DATA\s0 \s-1OR\s0 \s-1DATA\s0 \s-1BEING\s0
\&\s-1RENDERED\s0 \s-1INACCURATE\s0 \s-1OR\s0 \s-1LOSSES\s0 \s-1SUSTAINED\s0 \s-1BY\s0 \s-1YOU\s0 \s-1OR\s0 \s-1THIRD\s0 \s-1PARTIES\s0 \s-1OR\s0 A
\&\s-1FAILURE\s0 \s-1OF\s0 \s-1THE\s0 \s-1SOFTWARE\s0 \s-1TO\s0 \s-1OPERATE\s0 \s-1WITH\s0 \s-1ANY\s0 \s-1OTHER\s0 \s-1SOFTWARE\s0), \s-1EVEN\s0 \s-1IF\s0
\&\s-1SUCH\s0 \s-1HOLDER\s0 \s-1OR\s0 \s-1OTHER\s0 \s-1PARTY\s0 \s-1HAS\s0 \s-1BEEN\s0 \s-1ADVISED\s0 \s-1OF\s0 \s-1THE\s0 \s-1POSSIBILITY\s0 \s-1OF\s0
\&\s-1SUCH\s0 \s-1DAMAGES\s0.