.\" 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::Utilities 3pm"
.TH HTML::Microformats::Utilities 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::Utilities \- utility functions for searching and manipulating HTML
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module includes a few functions for searching and manipulating \s-1HTML\s0 trees.
.ie n .IP """searchClass($class, $node, [$prefix])""" 4
.el .IP "\f(CWsearchClass($class, $node, [$prefix])\fR" 4
.IX Item "searchClass($class, $node, [$prefix])"
Returns a list of elements which are descendents of \f(CW$node\fR and have class name \f(CW$class\fR.
.Sp
\&\f(CW$class\fR can be a plain string, or a regular expression.
.Sp
If \f(CW$prefix\fR is supplied it is used as an optional prefix for \f(CW$class\fR. For example, with \f(CW$class\fR 'bar'
and \f(CW$prefix\fR 'foo', searchClass will look for all of the following classes: 'bar', 'foobar', 'foo\-bar'
and 'foo:bar'.
.ie n .IP """searchAncestorClass($class, $node, [$skip])""" 4
.el .IP "\f(CWsearchAncestorClass($class, $node, [$skip])\fR" 4
.IX Item "searchAncestorClass($class, $node, [$skip])"
Returns the first element which is an ancestor of \f(CW$node\fR having class name \f(CW$class\fR.
.Sp
\&\f(CW$class\fR can be a plain string, or a regular expression.
.Sp
\&\f(CW$skip\fR is the number of levels of ancestor to skip. If \f(CW$skip\fR is 0, then potentially searchAncestorClass
will return \f(CW$node\fR itself. If \f(CW$skip\fR is 1, then it will not return \f(CW$node\fR but could potentially return
its parent, and so on.
.ie n .IP """searchRel($relationship, $node)""" 4
.el .IP "\f(CWsearchRel($relationship, $node)\fR" 4
.IX Item "searchRel($relationship, $node)"
Returns a list of elements which are descendents of \f(CW$node\fR and have relationship \f(CW$relationship\fR.
.Sp
\&\f(CW$relationship\fR can be a plain string, or a regular expression.
.ie n .IP """searchRev($relationship, $node)""" 4
.el .IP "\f(CWsearchRev($relationship, $node)\fR" 4
.IX Item "searchRev($relationship, $node)"
As per searchRel, but uses the rev attribute.
.ie n .IP """searchID($id, $node)""" 4
.el .IP "\f(CWsearchID($id, $node)\fR" 4
.IX Item "searchID($id, $node)"
Returns a descendent of \f(CW$node\fR with id attribute \f(CW$id\fR, or undef.
.ie n .IP """searchAncestorTag($tagname, $node)""" 4
.el .IP "\f(CWsearchAncestorTag($tagname, $node)\fR" 4
.IX Item "searchAncestorTag($tagname, $node)"
Returns the nearest ancestor of \f(CW$node\fR with tag name \f(CW$tagname\fR, or undef.
.ie n .IP """stringify($node, \e%options)""" 4
.el .IP "\f(CWstringify($node, \e%options)\fR" 4
.IX Item "stringify($node, %options)"
Returns a stringified version of a \s-1DOM\s0 element. This is conceptually equivalent
to \f(CW\*(C`$node\->textContent\*(C'\fR, but follows microformat-specific stringification
rules, including value excerption, the abbr pattern and so on.
.ie n .IP """xml_stringify($node)""" 4
.el .IP "\f(CWxml_stringify($node)\fR" 4
.IX Item "xml_stringify($node)"
Returns an \s-1XML\s0 serialisation of a \s-1DOM\s0 element. This is conceptually equivalent
to \f(CW\*(C`$node\->toStringEC14N\*(C'\fR, but hides certain attributes which
HTML::Microformats::DocumentContext adds for internal processing.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs to <http://rt.cpan.org/>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
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