.\" 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::Embedded::Turtle 3pm"
.TH HTML::Embedded::Turtle 3pm "2021-09-11" "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::Embedded::Turtle \- embedding RDF in HTML the crazy way
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use HTML::Embedded::Turtle;
\& 
\& my $het = HTML::Embedded::Turtle\->new($html, $base_uri);
\& foreach my $graph ($het\->endorsements)
\& {
\&   my $model = $het\->graph($graph);
\&   
\&   # $model is an RDF::Trine::Model. Do something with it.
\& }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\s-1RDF\s0 can be embedded in (X)HTML using simple <script> tags. This is
described at <http://esw.w3.org/N3inHTML>. This gives you a file format
that can contain multiple (optionally named) graphs. The document as a whole
can \*(L"endorse\*(R" a graph by including:
.PP
.Vb 1
\& <link rel="meta" href="#foo" />
.Ve
.PP
Where \*(L"#foo\*(R" is a fragment identifier pointing to a graph.
.PP
.Vb 1
\& <script type="text/turtle" id="foo"> ... </script>
.Ve
.PP
The rel=\*(L"meta\*(R" stuff is parsed using an RDFa parser, so equivalent RDFa
works too.
.PP
This module parses \s-1HTML\s0 files containing graphs like these, and allows
you to access them each individually; as a union of all graphs on the page;
or as a union of just the endorsed graphs.
.PP
Despite the module name, this module supports a variety of
<script type>s: text/turtle, application/turtle, application/x\-turtle
text/plain (N\-Triples), text/n3 (Notation 3), application/x\-rdf+json (\s-1RDF/JSON\s0),
application/json (\s-1RDF/JSON\s0), and application/rdf+xml (\s-1RDF/XML\s0).
.PP
The deprecated attribute \*(L"language\*(R" is also supported:
.PP
.Vb 1
\& <script language="Turtle" id="foo"> ... </script>
.Ve
.PP
Languages supported are (case insensitive): \*(L"Turtle\*(R", \*(L"NTriples\*(R", \*(L"\s-1RDFJSON\*(R",
\&\*(L"RDFXML\*(R"\s0 and \*(L"Notation3\*(R".
.SS "Constructor"
.IX Subsection "Constructor"
.ie n .IP """HTML::Embedded::Turtle\->new($markup, $base_uri, \e%opts)""" 4
.el .IP "\f(CWHTML::Embedded::Turtle\->new($markup, $base_uri, \e%opts)\fR" 4
.IX Item "HTML::Embedded::Turtle->new($markup, $base_uri, %opts)"
Create a new object. \f(CW$markup\fR is the \s-1HTML\s0 or \s-1XHTML\s0 markup to parse;
\&\f(CW$base_uri\fR is the base \s-1URI\s0 to use for relative references.
.Sp
Options include:
.RS 4
.IP "\(bu" 4
\&\fBmarkup\fR
.Sp
Choose which parser to use: 'html' or 'xml'. The former chooses
HTML::HTML5::Parser, which can handle tag soup; the latter chooses
XML::LibXML, which cannot. Defaults to 'html'.
.IP "\(bu" 4
\&\fBrdfa_options\fR
.Sp
A set of options to be parsed to RDF::RDFa::Parser when looking for
endorsements. See RDF::RDFa::Parser::Config. The default is
probably sensible.
.RE
.RS 4
.RE
.SS "Public Methods"
.IX Subsection "Public Methods"
.ie n .IP """union_graph""" 4
.el .IP "\f(CWunion_graph\fR" 4
.IX Item "union_graph"
A union graph of all graphs found in the document, as an RDF::Trine::Model.
Note that the returned model contains quads.
.ie n .IP """endorsed_union_graph""" 4
.el .IP "\f(CWendorsed_union_graph\fR" 4
.IX Item "endorsed_union_graph"
A union graph of only the endorsed graphs, as an RDF::Trine::Model.
Note that the returned model contains quads.
.ie n .IP """graph($name)""" 4
.el .IP "\f(CWgraph($name)\fR" 4
.IX Item "graph($name)"
A single graph from the page.
.ie n .IP """graphs""" 4
.el .IP "\f(CWgraphs\fR" 4
.IX Item "graphs"
.PD 0
.ie n .IP """all_graphs""" 4
.el .IP "\f(CWall_graphs\fR" 4
.IX Item "all_graphs"
.PD
A hashref where the keys are graph names and the values are
RDF::Trine::Models. Some graph names will be URIs, and others
may be blank nodes (e.g. \*(L"_:foobar\*(R").
.Sp
\&\f(CW\*(C`graphs\*(C'\fR and \f(CW\*(C`all_graphs\*(C'\fR are aliases for each other.
.ie n .IP """endorsed_graphs""" 4
.el .IP "\f(CWendorsed_graphs\fR" 4
.IX Item "endorsed_graphs"
Like \f(CW\*(C`all_graphs\*(C'\fR, but only returns endorsed graphs. Note that
all endorsed graphs will have graph names that are URIs.
.ie n .IP """endorsements""" 4
.el .IP "\f(CWendorsements\fR" 4
.IX Item "endorsements"
Returns a list of URIs which are the names of endorsed graphs. Note that
the presence of a \s-1URI\s0 \f(CW$x\fR in this list does not imply that
\&\f(CW\*(C`$het\->graph($x)\*(C'\fR will be defined.
.ie n .IP """dom""" 4
.el .IP "\f(CWdom\fR" 4
.IX Item "dom"
Returns the page \s-1DOM.\s0
.ie n .IP """uri""" 4
.el .IP "\f(CWuri\fR" 4
.IX Item "uri"
Returns the page \s-1URI.\s0
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs to <http://rt.cpan.org/>.
.PP
Please forgive me in advance for inflicting this module upon you.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
RDF::RDFa::Parser, RDF::Trine, RDF::TriN3.
.PP
<http://www.perlrdf.org/>.
.SH "AUTHOR"
.IX Header "AUTHOR"
Toby Inkster <tobyink@cpan.org>.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2010\-2011, 2013 by Toby Inkster.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system 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