.\" 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::Atom::Categories 3pm"
.TH XML::Atom::Categories 3pm "2021-01-06" "perl v5.32.0" "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::Categories \- Atom Category Document object
.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 $xml = $categories\->as_xml;
\&
\&  # Get a list of the category elements.
\&  my @category = $categories\->category;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Category Documents contain lists of categories described using the 
\&\*(L"atom:category\*(R" element from the Atom Syndication Format [\s-1RFC4287\s0].
.PP
The Category Document is defined in \*(L"The Atom Publishing Protocol,\*(R" 
\&\s-1IETF\s0 Internet-Draft.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "XML::Atom::Categories\->new([ $stream ])"
.el .SS "XML::Atom::Categories\->new([ \f(CW$stream\fP ])"
.IX Subsection "XML::Atom::Categories->new([ $stream ])"
Creates a new Category 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::Categories 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 Category Document.
.IP "\(bu" 4
Scalar
.Sp
This is treated as the name of a file containing the Category Document 
\&\s-1XML.\s0
.IP "\(bu" 4
Filehandle
.Sp
This is treated as an open filehandle from which the Category 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 Category Document \s-1XML\s0 will be retrieved 
from the \s-1URI.\s0
.ie n .SS "$categories\->categoryk([ $category ])"
.el .SS "\f(CW$categories\fP\->categoryk([ \f(CW$category\fP ])"
.IX Subsection "$categories->categoryk([ $category ])"
If called in scalar context, returns an XML::Atom::Category object
corresponding to the first \*(L"app:category\*(R" element found in the Category Document.
.PP
If called in list context, returns a list of XML::Atom::Category objects
corresponding to all of the \*(L"app:category\*(R" elements found in the Service Document.
.ie n .SS "$service\->add_category($category)"
.el .SS "\f(CW$service\fP\->add_category($category)"
.IX Subsection "$service->add_category($category)"
Adds the category \f(CW$category\fR, which must be an XML::Atom::Category object, to
the Service Document as a new \*(L"app:category\*(R" element. For example:
.PP
.Vb 3
\&    my $category = XML::Atom::Category\->new;
\&    $category\->term(\*(Aqjoke\*(Aq);
\&    $categories\->add_category($category);
.Ve
.ie n .SS "$categories\->fixed"
.el .SS "\f(CW$categories\fP\->fixed"
.IX Subsection "$categories->fixed"
.ie n .SS "$categories\->scheme"
.el .SS "\f(CW$categories\fP\->scheme"
.IX Subsection "$categories->scheme"
.ie n .SS "$categories\->href"
.el .SS "\f(CW$categories\fP\->href"
.IX Subsection "$categories->href"
.ie n .SS "$categories\->element_name"
.el .SS "\f(CW$categories\fP\->element_name"
.IX Subsection "$categories->element_name"
.ie n .SS "$categories\->element_ns"
.el .SS "\f(CW$categories\fP\->element_ns"
.IX Subsection "$categories->element_ns"
.SH "SEE ALSO"
.IX Header "SEE ALSO"
XML::Atom
XML::Atom::Service
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 THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE SOFTWARE \*(L"AS IS\*(R" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR, OR CORRECTION.\s0
.PP
\&\s-1IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
THE SOFTWARE\s0 (\s-1INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE\s0), \s-1EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.\s0