.\" 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::Service 3pm"
.TH XML::Atom::Service 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::Service \- Atom Service Document object
.SH "COMPATIBILITY ISSUES"
.IX Header "COMPATIBILITY ISSUES"
XML::Atom::Service has \fBchanged the default namespace\fR since v0.15.0.
The new namespaces are 'http://www.w3.org/2005/Atom' and 'http://www.w3.org/2007/app'.
.PP
See \s-1NAMESPACES\s0 in details.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use XML::Atom::Service;
\&
\&  my $category = XML::Atom::Category\->new;
\&  $category\->term(\*(Aqjoke\*(Aq);
\&  $category\->scheme(\*(Aqhttp://example.org/extra\-cats/\*(Aq);
\&
\&  my $categories = XML::Atom::Categories\->new;
\&  $categories\->add_category($category);
\&
\&  my $collection = XML::Atom::Collection\->new;
\&  $collection\->href(\*(Aqhttp://example.org/reilly/main\*(Aq);
\&  $collection\->title(\*(AqMy Blog Entries\*(Aq);
\&  $collection\->add_accept(\*(Aqapplication/atom+xml;type=entry\*(Aq);
\&  $collection\->add_categories($categories);
\&
\&  my $workspace = XML::Atom::Workspace\->new;
\&  $workspace\->title(\*(AqMain Site\*(Aq);
\&  $workspace\->add_collection($collection);
\&
\&  my $service = XML::Atom::Service\->new;
\&  $service\->add_workspace($workspace);
\&
\&  my $xml = $service\->as_xml;
\&
\&  # Get lists of the workspace, collection, and categories elements
\&  my @workspace = $service\->workspaces;
\&  my @collection = $workspace[0]\->collections;
\&  my @categories = $collection[0]\->categories;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The Atom Publishing Protocol (Atompub) is a protocol for publishing and 
editing Web resources described at
http://www.ietf.org/internet\-drafts/draft\-ietf\-atompub\-protocol\-17.txt <http://www.ietf.org/internet-drafts/draft-ietf-atompub-protocol-17.txt>.
.PP
XML::Atom::Service is an Service Document implementation.
In the Atom Publishing Protocol, a client needs to first discover the 
capabilities and locations of Collections.
The Service Document is designed to support this discovery process.
The document describes the location and capabilities of Collections.
.PP
The Atom Publishing Protocol introduces some new \s-1XML\s0 elements, such as
\&\fIapp:edited\fR and \fIapp:draft\fR, which are imported into XML::Atom.
See XML::Atom::Atompub in detail.
.PP
This module was tested in InteropTokyo2007
<http://intertwingly.net/wiki/pie/July2007InteropTokyo>, 
and interoperated with other implementations.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "XML::Atom::Service\->new([ $stream ])"
.el .SS "XML::Atom::Service\->new([ \f(CW$stream\fP ])"
.IX Subsection "XML::Atom::Service->new([ $stream ])"
Creates a new Service Document object, and if \f(CW$stream\fR is supplied, fills 
it with the data specified by \f(CW$stream\fR.
.PP
Automatically handles autodiscovery if \f(CW$stream\fR is a \s-1URI\s0 (see below).
.PP
Returns the new XML::Atom::Service object. On failure, returns \f(CW\*(C`undef\*(C'\fR.
.PP
\&\f(CW$stream\fR can be any one of the following:
.IP "\(bu" 4
Reference to a scalar
.Sp
This is treated as the \s-1XML\s0 body of the Service Document.
.IP "\(bu" 4
Scalar
.Sp
This is treated as the name of a file containing the Service Document \s-1XML\s0.
.IP "\(bu" 4
Filehandle
.Sp
This is treated as an open filehandle from which the Service Document \s-1XML\s0 can be read.
.IP "\(bu" 4
\&\s-1URI\s0 object
.Sp
This is treated as a \s-1URI\s0, and the Service Document \s-1XML\s0 will be retrieved from the \s-1URI\s0.
.ie n .SS "$service\->workspace"
.el .SS "\f(CW$service\fP\->workspace"
.IX Subsection "$service->workspace"
If called in scalar context, returns an XML::Atom::Workspace object
corresponding to the first \*(L"app:workspace\*(R" element found in the Service 
Document.
.PP
If called in list context, returns a list of XML::Atom::Workspace objects
corresponding to all of the app:workspace elements found in the Service Document.
.ie n .SS "$service\->add_workspace($workspace)"
.el .SS "\f(CW$service\fP\->add_workspace($workspace)"
.IX Subsection "$service->add_workspace($workspace)"
Adds the workspace \f(CW$workspace\fR, which must be an XML::Atom::Workspace object, to
the Service Document as a new app:workspace element. For example:
.PP
.Vb 3
\&    my $workspace = XML::Atom::Workspace\->new;
\&    $workspace\->title(\*(AqFoo Bar\*(Aq);
\&    $service\->add_workspace($workspace);
.Ve
.ie n .SS "$service\->element_name"
.el .SS "\f(CW$service\fP\->element_name"
.IX Subsection "$service->element_name"
.ie n .SS "$service\->element_ns"
.el .SS "\f(CW$service\fP\->element_ns"
.IX Subsection "$service->element_ns"
.SH "NAMESPACES"
.IX Header "NAMESPACES"
By default, XML::Atom::Service will create entities using the new
Atom namespaces, 'http://www.w3.org/2005/Atom' and 'http://www.w3.org/2007/app'.
In order to use old ones, you can set them by setting global variables like:
.PP
.Vb 4
\&  use XML::Atom;
\&  use XML::Atom::Service;
\&  $XML::Atom::DefaultVersion = \*(Aq0.3\*(Aq;   # \*(Aqhttp://purl.org/atom/ns#\*(Aq
\&  $XML::Atom::Service::DefaultNamespace = \*(Aqhttp://purl.org/atom/app#\*(Aq;
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
XML::Atom
Atompub
Catalyst::Controller::Atompub
.SH "AUTHOR"
.IX Header "AUTHOR"
Takeru \s-1INOUE\s0, <takeru.inoue _ gmail.com>
.SH "LICENCE AND COPYRIGHT"
.IX Header "LICENCE AND COPYRIGHT"
Copyright (c) 2007, Takeru \s-1INOUE\s0 \f(CW\*(C`<takeru.inoue _ gmail.com>\*(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.