.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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::HTML5::Outline 3pm"
.TH HTML::HTML5::Outline 3pm "2022-11-19" "perl v5.36.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"
HTML::HTML5::Outline \- implementation of the HTML5 Outline algorithm
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& use JSON;
\& use HTML::HTML5::Outline;
\&
\& my $html = <<\*(AqHTML\*(Aq;
\&
\&
Hello
\&
World
\&
Good Morning
\&
Vietnam
\& HTML
\&
\& my $outline = HTML::HTML5::Outline\->new($html);
\& print to_json($outline\->to_hashref, {pretty=>1,canonical=>1});
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is an implementation of the \s-1HTML5\s0 Outline algorithm, as per
.
.PP
The module can output a JSON-friendly hashref, or an \s-1RDF\s0 model.
.SS "Constructor"
.IX Subsection "Constructor"
.IP "\(bu" 4
\&\f(CW\*(C`HTML::HTML5::Outline\->new($html, %options)\*(C'\fR
.Sp
Construct a new outline. \f(CW$html\fR is the \s-1HTML\s0 to generate an outline from,
either as an \s-1HTML\s0 or \s-1XHTML\s0 string, or as an XML::LibXML::Document object.
.Sp
Options:
.RS 4
.IP "\(bu" 4
\&\fBdefault_language\fR \- default language to assume text is in when no
lang/xml:lang attribute is available. e.g. 'en\-gb'.
.IP "\(bu" 4
\&\fBelement_subjects\fR \- rather advanced feature that doesn't bear
explaining. See \s-1USE WITH RDF::RDFA::PARSER\s0 for an example.
.IP "\(bu" 4
\&\fBmicroformats\fR \- support \f(CW\*(C`
\*(C'\fR,
\&\f(CW\*(C`\*(C'\fR and \f(CW\*(C`\*(C'\fR as
sectioning elements (like \f(CW\*(C`\*(C'\fR, \f(CW\*(C`\*(C'\fR, etc).
Boolean, defaults to false.
.IP "\(bu" 4
\&\fBparser\fR \- 'html' (default) or 'xml' \- choose the parser to use for
\&\s-1XHTML/HTML.\s0 If the constructor is passed an XML::LibXML::Document, this is
ignored.
.IP "\(bu" 4
\&\fBsuppress_collections\fR \- allows rdf:List stuff to be suppressed
from \s-1RDF\s0 output. \s-1RDF\s0 output \- especially in Turtle format \- looks somewhat
nicer without them, but if you care about the order of headings and sections,
then you'll want them. Boolean, defaults to false.
.IP "\(bu" 4
\&\fBuri\fR \- the document \s-1URI\s0 for resolving relative \s-1URI\s0 references.
Only really used by the \s-1RDF\s0 output.
.RE
.RS 4
.RE
.SS "Object Methods"
.IX Subsection "Object Methods"
.IP "\(bu" 4
\&\f(CW\*(C`to_hashref\*(C'\fR
.Sp
Returns data as a nested hashref/arrayref structure. Dump it as \s-1JSON\s0 and
you'll figure out the format pretty easily.
.IP "\(bu" 4
\&\f(CW\*(C`to_rdf\*(C'\fR
.Sp
Returns data as a n RDF::Trine::Model. Requires RDF::Trine to be
installed. Otherwise this method won't exist.
.IP "\(bu" 4
\&\f(CW\*(C`primary_outlinee\*(C'\fR
.Sp
Returns a HTML::HTML5::Outline::Outlinee element representing the
outline for the page.
.SS "Class Methods"
.IX Subsection "Class Methods"
.IP "\(bu" 4
\&\f(CW\*(C`has_rdf\*(C'\fR
.Sp
Indicates whether the \f(CW\*(C`to_rdf\*(C'\fR object method exists.
.SH "USE WITH RDF::RDFA::PARSER"
.IX Header "USE WITH RDF::RDFA::PARSER"
This module produces \s-1RDF\s0 data where many of the resources described
are \s-1HTML\s0 elements. RDFa data typically does not, but RDF::RDFa::Parser
does also support some extensions to RDFa which do (e.g. support for the
\&\f(CW\*(C`cite\*(C'\fR and \f(CW\*(C`role\*(C'\fR attributes). It's useful to combine the \s-1RDF\s0 data
from each, and RDF::RDFa::Parser 1.093 and upwards contains a few shims
to make this possible.
.PP
Without further ado...
.PP
.Vb 3
\& use HTML::HTML5::Outline;
\& use RDF::RDFa::Parser 1.093;
\& use RDF::TrineShortcuts;
\&
\& my $rdfa = RDF::RDFa::Parser\->new(
\& $html_source,
\& $base_url,
\& RDF::RDFa::Parser::Config\->new(
\& \*(Aqhtml5\*(Aq, \*(Aq1.1\*(Aq,
\& role_attr => 1,
\& cite_attr => 1,
\& longdesc_attr => 1,
\& ),
\& )\->consume;
\&
\& my $outline = HTML::HTML5::Outline\->new(
\& $rdfa\->dom,
\& uri => $rdfa\->uri,
\& element_subjects => $rdfa\->element_subjects,
\& );
\&
\& # Merging two graphs is pretty complicated in RDF::Trine
\& # but a little easier with RDF::TrineShortcuts...
\& my $combined = rdf_parse();
\& rdf_parse($rdfa\->graph, model => $combined);
\& rdf_parse($outline\->to_rdf, model => $combined);
\&
\& my $NS = {
\& dc => \*(Aqhttp://purl.org/dc/terms/\*(Aq,
\& o => \*(Aqhttp://ontologi.es/outline#\*(Aq,
\& type => \*(Aqhttp://purl.org/dc/dcmitype/\*(Aq,
\& xs => \*(Aqhttp://www.w3.org/2001/XMLSchema#\*(Aq,
\& xhv => \*(Aqhttp://www.w3.org/1999/xhtml/vocab#\*(Aq,
\& };
\&
\& print rdf_string($combined => \*(AqTurtle\*(Aq, namespaces => $NS);
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
HTML::HTML5::Outline::RDF,
HTML::HTML5::Outline::Outlinee,
HTML::HTML5::Outline::Section.
.PP
HTML::HTML5::Parser, HTML::HTML5::Sanity.
.SH "AUTHOR"
.IX Header "AUTHOR"
Toby Inkster,
.SH "ACKNOWLEDGEMENTS"
.IX Header "ACKNOWLEDGEMENTS"
This module is a fork of the document structure parser from Swignition
.
.PP
That in turn includes the following credits: thanks to Ryan King and
Geoffrey Sneddon for pointing me towards [the \s-1HTML5\s0] algorithm. I also
used Geoffrey's python implementation as a crib sheet to help me figure
out what was supposed to happen when the \s-1HTML5\s0 spec was ambiguous.
.SH "COPYRIGHT AND LICENCE"
.IX Header "COPYRIGHT AND LICENCE"
Copyright (C) 2008\-2011 by Toby Inkster
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.