.\" 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
.\" ========================================================================
.\"
.IX Title "HTML::Microformats::Format::XOXO 3pm"
.TH HTML::Microformats::Format::XOXO 3pm "2021-09-12" "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"
HTML::Microformats::Format::XOXO \- the XOXO microformat
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& use HTML::Microformats::DocumentContext;
\& use HTML::Microformats::Format::XOXO;
\&
\& my $context = HTML::Microformats::DocumentContext\->new($dom, $uri);
\& my @objects = HTML::Microformats::Format::XOXO\->extract_all(
\&                   $dom\->documentElement, $context);
\& my $list = $objects[0];
\& 
\& # Let\*(Aqs assume this structure:
\& #
\& # <ol class="xoxo people">
\& #   <li>
\& #     <a href="http://tobyinkster.co.uk/">Toby Inkster</a>
\& #     <dl>
\& #       <dt>Eye colour</dt>
\& #       <dd>Blue</dt>
\& #       <dt>Hair colour</dt>
\& #       <dd>Blonde</dt>
\& #       <dd>Brown</dt>
\& #     </dl>
\& #   </li>
\& # </ol>
\& 
\& print $list\->data\->as_array\->[0]\->get_link_title;
\& # Toby Inkster
\& print $list\->data\->as_array\->[0]\->get_properties
\&      \->get_value(\*(AqEye colour\*(Aq)\->[0];
\& # Blue
\& print join \*(Aq\-\*(Aq, $list\->data\->as_array\->[0]
\&      \->get_value(\*(AqHair colour\*(Aq);
\& # Blonde\-Brown
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
HTML::Microformats::Format::XOXO inherits from HTML::Microformats::Format. See the
base class definition for a description of property getter/setter methods,
constructors, etc.
.PP
Unlike most of the modules in the HTML::Microformats suite,
the \f(CW\*(C`data\*(C'\fR method returns an HTML::Microformats::Format::XOXO::UL,
HTML::Microformats::Format::XOXO::OL or HTML::Microformats::Format::XOXO::DL
object, rather than a plain hashref.
.SS "HTML::Microformats::Format::XOXO::DL"
.IX Subsection "HTML::Microformats::Format::XOXO::DL"
Represents an \s-1HTML DL\s0 element.
.ie n .IP """$dl\->get_values($key)""" 4
.el .IP "\f(CW$dl\->get_values($key)\fR" 4
.IX Item "$dl->get_values($key)"
Treating a \s-1DL\s0 as a key-value structure, returns a list of values for a given key.
Each value is an HTML::Microformats::Format::XOXO::DD object.
.ie n .IP """$dl\->as_hash""" 4
.el .IP "\f(CW$dl\->as_hash\fR" 4
.IX Item "$dl->as_hash"
Returns a hash of keys pointing to arrayrefs of values, where each value is an
HTML::Microformats::Format::XOXO::DD object.
.ie n .IP """$dl\->as_array""" 4
.el .IP "\f(CW$dl\->as_array\fR" 4
.IX Item "$dl->as_array"
Logically what you think get_values(\*(L"*\*(R") might do.
.SS "HTML::Microformats::Format::XOXO::UL"
.IX Subsection "HTML::Microformats::Format::XOXO::UL"
Represents an \s-1HTML UL\s0 element.
.ie n .IP """$ul\->as_array""" 4
.el .IP "\f(CW$ul\->as_array\fR" 4
.IX Item "$ul->as_array"
Returns an array of values, where each is a HTML::Microformats::Format::XOXO::LI object.
.SS "HTML::Microformats::Format::XOXO::OL"
.IX Subsection "HTML::Microformats::Format::XOXO::OL"
Represents an \s-1HTML OL\s0 element.
.ie n .IP """$ol\->as_array""" 4
.el .IP "\f(CW$ol\->as_array\fR" 4
.IX Item "$ol->as_array"
Returns an array of values, where each is a HTML::Microformats::Format::XOXO::LI object.
.SS "HTML::Microformats::Format::XOXO::LI"
.IX Subsection "HTML::Microformats::Format::XOXO::LI"
Represents an \s-1HTML LI\s0 element.
.ie n .IP """$li\->get_link_href""" 4
.el .IP "\f(CW$li\->get_link_href\fR" 4
.IX Item "$li->get_link_href"
Returns the \s-1URL\s0 linked to by the \fBfirst\fR link found within the item.
.ie n .IP """$li\->get_link_rel""" 4
.el .IP "\f(CW$li\->get_link_rel\fR" 4
.IX Item "$li->get_link_rel"
Returns the value of the rel attribute of the first link found within the item.
This is an unparsed string.
.ie n .IP """$li\->get_link_type""" 4
.el .IP "\f(CW$li\->get_link_type\fR" 4
.IX Item "$li->get_link_type"
Returns the value of the type attribute of the first link found within the item.
This is an unparsed string.
.ie n .IP """$li\->get_link_title""" 4
.el .IP "\f(CW$li\->get_link_title\fR" 4
.IX Item "$li->get_link_title"
Returns the value of the rel attribute of the first link found within the item
if present; the link text otherwise.
.ie n .IP """$li\->get_text""" 4
.el .IP "\f(CW$li\->get_text\fR" 4
.IX Item "$li->get_text"
Returns the value of the text in the \s-1LI\s0 element \fBexcept\fR for the first \s-1DL\s0
element within the \s-1LI,\s0 and the first \s-1UL\s0 or \s-1OL\s0 element.
.ie n .IP """$li\->get_html""" 4
.el .IP "\f(CW$li\->get_html\fR" 4
.IX Item "$li->get_html"
Returns the \s-1HTML\s0 code in the \s-1LI\s0 element \fBexcept\fR for the first \s-1DL\s0
element within the \s-1LI,\s0 and the first \s-1UL\s0 or \s-1OL\s0 element.
.ie n .IP """$li\->get_properties""" 4
.el .IP "\f(CW$li\->get_properties\fR" 4
.IX Item "$li->get_properties"
Returns an HTML::Microformats::Format::XOXO::DL object representing the first
\&\s-1DL\s0 element within the \s-1LI.\s0
.ie n .IP """$li\->get_children""" 4
.el .IP "\f(CW$li\->get_children\fR" 4
.IX Item "$li->get_children"
Returns an HTML::Microformats::Format::XOXO::OL or HTML::Microformats::Format::XOXO::UL
object representing the first \s-1OL\s0 or \s-1UL\s0 element within the \s-1LI.\s0
.ie n .IP """$li\->get_value($key)""" 4
.el .IP "\f(CW$li\->get_value($key)\fR" 4
.IX Item "$li->get_value($key)"
A shortcut for \f(CW\*(C`$li\->get_properties\->get_values($key)\*(C'\fR.
.SS "HTML::Microformats::Format::XOXO::DD"
.IX Subsection "HTML::Microformats::Format::XOXO::DD"
This has an identical interface to HTML::Microformats::Format::XOXO::LI.
.SH "MICROFORMAT"
.IX Header "MICROFORMAT"
HTML::Microformats::Format::XOXO supports \s-1XOXO\s0 as described at
<http://microformats.org/wiki/xoxo>.
.SH "RDF OUTPUT"
.IX Header "RDF OUTPUT"
\&\s-1XOXO\s0 does not map especially naturally to \s-1RDF,\s0 so this module returns
the data as a \s-1JSON\s0 literal using the property <http://open.vocab.org/terms/json>.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs to <http://rt.cpan.org/>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
HTML::Microformats::Format,
HTML::Microformats.
.SH "AUTHOR"
.IX Header "AUTHOR"
Toby Inkster <tobyink@cpan.org>.
.SH "COPYRIGHT AND LICENCE"
.IX Header "COPYRIGHT AND LICENCE"
Copyright 2008\-2012 Toby Inkster
.PP
This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
.SH "DISCLAIMER OF WARRANTIES"
.IX Header "DISCLAIMER OF WARRANTIES"
\&\s-1THIS PACKAGE IS PROVIDED \*(L"AS IS\*(R" AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.\s0