.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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
.\" ========================================================================
.\"
.IX Title "WWW::OpenSearch::Description 3pm"
.TH WWW::OpenSearch::Description 3pm "2022-07-02" "perl v5.34.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"
WWW::OpenSearch::Description \- Encapsulate an OpenSearch Description
provided by an A9 OpenSearch compatible engine
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use WWW::OpenSearch;
\&    
\&    my $url = "http://bulkfeeds.net/opensearch.xml";
\&    my $engine = WWW::OpenSearch\->new($url);
\&    my $description = $engine\->description;
\&    
\&    my $format   = $description\->Format;   # or $description\->format
\&    my $longname = $description\->LongName; # or $description\->longname
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
WWW::OpenSearch::Description is a module designed to encapsulate an
OpenSearch Description provided by an A9 OpenSearch compatible engine.
See http://opensearch.a9.com/spec/1.1/description/ for details.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.ie n .SS "new( [ $xml ] )"
.el .SS "new( [ \f(CW$xml\fP ] )"
.IX Subsection "new( [ $xml ] )"
Constructs a new instance of WWW::OpenSearch::Description. If scalar
parameter \f(CW$xml\fR is provided, data will be automatically loaded from it
using load( \f(CW$xml\fR ).
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "load( $xml )"
.el .SS "load( \f(CW$xml\fP )"
.IX Subsection "load( $xml )"
Loads description data by parsing provided argument using XML::LibXML.
.SS "urls( )"
.IX Subsection "urls( )"
Return all of the urls associated with this description in an array.
.SS "get_best_url( )"
.IX Subsection "get_best_url( )"
Attempts to retrieve the best \s-1URL\s0 associated with this description, based
on the following content types (from most preferred to least preferred):
.IP "\(bu" 4
application/atom+xml
.IP "\(bu" 4
application/rss+xml
.IP "\(bu" 4
text/xml
.ie n .SS "get_url_by_type( $type )"
.el .SS "get_url_by_type( \f(CW$type\fP )"
.IX Subsection "get_url_by_type( $type )"
Retrieves the first WWW::OpenSearch::URL associated with this description
whose type is equal to \f(CW$type\fR.
.SH "ACCESSORS"
.IX Header "ACCESSORS"
.SS "version( )"
.IX Subsection "version( )"
.SS "ns( )"
.IX Subsection "ns( )"
.SS "AdultContent( )"
.IX Subsection "AdultContent( )"
.SS "Attribution( )"
.IX Subsection "Attribution( )"
.SS "Contact( )"
.IX Subsection "Contact( )"
.SS "Description( )"
.IX Subsection "Description( )"
.SS "Developer( )"
.IX Subsection "Developer( )"
.SS "Format( )"
.IX Subsection "Format( )"
.SS "InputEncoding( )"
.IX Subsection "InputEncoding( )"
.SS "Image( )"
.IX Subsection "Image( )"
.SS "Language( )"
.IX Subsection "Language( )"
.SS "LongName( )"
.IX Subsection "LongName( )"
.SS "OutputEncoding( )"
.IX Subsection "OutputEncoding( )"
.SS "Query( )"
.IX Subsection "Query( )"
.SS "SampleSearch( )"
.IX Subsection "SampleSearch( )"
.SS "ShortName( )"
.IX Subsection "ShortName( )"
.SS "SyndicationRight( )"
.IX Subsection "SyndicationRight( )"
.SS "Tags( )"
.IX Subsection "Tags( )"
.SS "Url( )"
.IX Subsection "Url( )"
.SH "AUTHOR"
.IX Header "AUTHOR"
.IP "\(bu" 4
Tatsuhiko Miyagawa <miyagawa@bulknews.net>
.IP "\(bu" 4
Brian Cassidy <bricas@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2005\-2013 by Tatsuhiko Miyagawa and Brian Cassidy
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.