.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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 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.
.\"
.\" 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 "HTML::Microformats::Documentation::Notes 3pm"
.TH HTML::Microformats::Documentation::Notes 3pm "2012-07-05" "perl v5.20.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"
HTML::Microformats::Documentation::Notes \- misc usage and design notes
.SH "NOTES"
.IX Header "NOTES"
.SS "Byzantine Internals"
.IX Subsection "Byzantine Internals"
The internals of HTML::Microformats are pretty complicated \- best to steer clear
of them. Here are three usage patterns that mostly avoid dealing with the internals:
.IP "\(bu" 4
\&\fBParse a page and use it as a single \s-1RDF\s0 graph.\fR
.Sp
A page can be parsed into an RDF::Trine::Model and queried
using \s-1SPARQL.\s0
.Sp
.Vb 3
\&        use HTML::Microformats;
\&        use LWP::Simple qw[get];
\&        use RDF::Query;
\&        
\&        my $page  = \*(Aqhttp://example.net/\*(Aq;
\&        my $graph = HTML::Microformats
\&                       \->new_document(get($page), $page)
\&                       \->assume_all_profiles
\&                       \->parse_microformats
\&                       \->model;
\&        
\&        my $query = RDF::Query\->new(<<SPARQL);
\&        PREFIX foaf: <http://xmlns.com/foaf/0.1/>
\&        SELECT DISTINCT ?friendname ?friendpage
\&        WHERE {
\&                <$page> ?p ?friendpage .
\&                ?person foaf:name ?friendname ;
\&                        foaf:page ?friendpage .
\&                FILTER (
\&                        isURI(?friendpage)
\&                        && isLiteral(?friendname) 
\&                        && regex(str(?p), "^http://vocab.sindice.com/xfn#(.+)\-hyperlink")
\&                )
\&        }
\&        SPARQL
\&        
\&        my $results = $query\->execute($graph);
\&        while (my $result = $results\->next)
\&        {
\&                printf("%s <%s>\en",
\&                        $result\->{friendname}\->literal_value,
\&                        $result\->{friendpage}\->uri,
\&                        );
\&        }
.Ve
.IP "\(bu" 4
\&\fBUse the data method on each object.\fR
.Sp
The \f(CW\*(C`data\*(C'\fR method on microformat objects returns a hashref of useful data.
.Sp
.Vb 2
\&        use HTML::Microformats;
\&        use LWP::Simple qw[get];
\&        
\&        my $page     = \*(Aqhttp://example.net/\*(Aq;
\&        my @xfn_objs = HTML::Microformats
\&                       \->new_document(get($page), $page)
\&                       \->assume_all_profiles
\&                       \->parse_microformats
\&                       \->objects(\*(AqXFN\*(Aq);
\&        
\&        while (my $xfn = shift @xfn_objs)
\&        {
\&                printf("%s <%s>\en",
\&                        $xfn\->data\->{title},
\&                        $xfn\->data\->{href},
\&                        );
\&        }
.Ve
.Sp
(If you're wondering why the second example's simpler it's because it returns
somewhat dumber data.)
.IP "\(bu" 4
\&\fBConvert to other formats.\fR
.Sp
Various microformat objects have \f(CW\*(C`to_foo\*(C'\fR methods allowing the data to be
exported in various formats..
.Sp
.Vb 2
\&        use HTML::Microformats;
\&        use LWP::Simple qw[get];
\&        
\&        my $page     = \*(Aqhttp://example.net/\*(Aq;
\&        my @hcards   = HTML::Microformats
\&                       \->new_document(get($page), $page)
\&                       \->assume_all_profiles
\&                       \->parse_microformats
\&                       \->objects(\*(AqhCard\*(Aq);
\&        
\&        print $_\->to_vcard foreach @hcards;
.Ve
.Sp
Methods available are:
.RS 4
.IP "\(bu" 4
\&\f(CW\*(C`to_vcard\*(C'\fR (hCard objects)
.Sp
Exports as vCard 3.0.
.IP "\(bu" 4
\&\f(CW\*(C`to_vcard4\*(C'\fR (hCard objects)
.Sp
Exports as vCard 4.0.
.IP "\(bu" 4
\&\f(CW\*(C`to_vcard4_xml\*(C'\fR (hCard objects)
.Sp
Exports as vCard \s-1XML.\s0
.IP "\(bu" 4
\&\f(CW\*(C`to_icalendar\*(C'\fR (hCalendar, hEvent, hTodo, hFreebusy, hAlarm and hEntry objects)
.Sp
Exports as iCalendar.
.IP "\(bu" 4
\&\f(CW\*(C`to_atom\*(C'\fR (hAtom and hEntry objects)
.Sp
Exports as Atom 1.0.
.IP "\(bu" 4
\&\f(CW\*(C`to_kml\*(C'\fR (geo objects)
.Sp
Exports as \s-1KML 2.0.\s0
.IP "\(bu" 4
\&\f(CW\*(C`serialialise_model(as => $format)\*(C'\fR (all microformat objects)
.Sp
Exports as \s-1RDF,\s0 serialised as \f(CW$format\fR. (Format can be '\s-1RDFXML\s0', 'Turtle',
\&'NTriples', '\s-1RDFJSON\s0'.)
.RE
.RS 4
.RE
.SS "Stuff that's b0rked"
.IX Subsection "Stuff that's b0rked"
The \f(CW\*(C`get_foo\*(C'\fR, \f(CW\*(C`set_foo\*(C'\fR, \f(CW\*(C`add_foo\*(C'\fR, \f(CW\*(C`clear_foo\*(C'\fR methods defined in
HTML::Microformats::Format work unreliably and are poorly documented.
You're better off using the \f(CW\*(C`data\*(C'\fR method and inspecting the returned structure
for the data you need. This will be fixed in the future.
.SS "Here be monsters"
.IX Subsection "Here be monsters"
There are several parts of the code which are incredibly complicated and desperately
need refactoring. This will be done at some point, so don't rely too much on their current
behaviour.
.PP
\&\f(CW\*(C`stringify\*(C'\fR and \f(CW\*(C`_stringify_helper\*(C'\fR in HTML::Microformats::Utilities.
The whole of HTML::Microformats::Mixin::Parser.
.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.