.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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::Builder 3pm"
.TH HTML::HTML5::Builder 3pm 2024-03-05 "perl v5.38.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::HTML5::Builder \- erect some scaffolding for your documents
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use HTML::HTML5::Builder qw[:standard JQUERY];
\&
\&  open my $fh, \*(Aq<\*(Aq, \*(Aqinline\-script.js\*(Aq;
\&  
\&  print html(
\&    \-lang => \*(Aqen\*(Aq,
\&    head(
\&      title(\*(AqTest\*(Aq),
\&      Meta(\-charset => \*(Aqutf\-8\*(Aq),
\&    ),
\&    body(
\&      h1(\*(AqTest\*(Aq),
\&      p(\*(AqThis is a test.\*(Aq),
\&      JQUERY(\-version => \*(Aq1.6.4\*(Aq),
\&      script(\-type => \*(Aqtext/javascript\*(Aq, $fh),
\&    ),
\&  );
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module can export function names corresponding to any HTML5 element.
.PP
Each function returns an XML::LibXML::Element with the same name as the
function. The arguments to each function are processed as a list, and
used to set the attributes and contents of that element.
.PP
For each item on the list:
.IP \(bu 4
if it's an XML::LibXML::Element, XML::LibXML::TextNode,
XML::LibXML::Comment, or XML::LibXML::PI, it's appended as a
child of the returned element.
.IP \(bu 4
if it's an XML::LibXML::NodeList, each item on the list is
appended as a child of the returned element.
.IP \(bu 4
if it's an XML::LibXML::Attr, it's set as an attribute on
the returned element
.IP \(bu 4
if it's an IO::Handle, then it will be slurped and appended
to the returned element as a text node.
.IP \(bu 4
if it's a scalar reference, then the returned element is also
assigned to it. (This feature is \fBat risk\fR.)
.IP \(bu 4
if it's a scalar (string) some guesswork is conducted to figure
out whether you're setting an attribute and value, or whether the string
should be used as a text node. The presence of a hyphen at the start of
the string is the main deciding factor.
.Sp
.Vb 1
\&  p(\*(Aq\-class\*(Aq, \*(Aqwarning\*(Aq, \*(Aq$LordLucan not found.\*(Aq);
.Ve
.Sp
In this example, a paragraph element is returned, with the class attribute
set to 'warning' and the textual contents '$LordLucan not found.'.
.Sp
Sometimes it's necessary to protect values against this guesswork. By
passing a hashref, all the keys and values are interpreted as setting
attributes; by passing an arrayref, all values are interpreted as setting
the contents of the element.
.Sp
.Vb 1
\&  p([\*(Aq\-class\*(Aq], { warning => \*(Aq$LordLucan not found.\*(Aq });
.Ve
.Sp
In this example, a paragraph element is returned, with the warning attribute
set to '$LordLucan not found.' and the textual contents '\-class'.
.IP \(bu 4
Anything else is stringified and added as a text node. This is
useful for things with sensible stringification defined, such as \f(CW\*(C`DateTime\*(C'\fR
and \f(CW\*(C`URI\*(C'\fR objects, but less so for some other objects, so you will
sometimes get a warning if warnings are enabled. Warnings can be disabled
using:
.Sp
.Vb 1
\&  no warnings \*(AqHTML::HTML::Builder\*(Aq;
.Ve
.SS "Exceptional Cases"
.IX Subsection "Exceptional Cases"
The \f(CW\*(C`html\*(C'\fR function does not return an \f(CW\*(C`XML::LibXML::Element\*(C'\fR, but rather a
\&\f(CW\*(C`HTML::HTML5::Builder::Document\*(C'\fR object.
.PP
There is special handling for \f(CW\*(C`time\*(C'\fR (or \f(CW\*(C`Time\*(C'\fR). If the first parameter passed to
it is a DateTime object, then that object is used to set its datetime attribute.
If there are no subsequent parameters, then the stringified form of the object is also
used to form the content of the <time> element.
.PP
Note that the functions that generate <meta>, <link>, <q>, <time>, <sub>, <s> and <map>
HTML elements are named \f(CWMeta()\fR, \f(CWLink()\fR, \f(CWQ()\fR, \f(CWTime()\fR, \f(CWSub()\fR,
\&\f(CWS()\fR and \f(CWMap()\fR respectively, with an upper-case first letter. This is
because each of these names corresponds to a built-in perl keyword (except meta,
which is used by Moose). The lower-case versions of these do exist, and can be
exported if you ask for them explicitly. The lower-case versions are also
available as methods using the object-oriented syntax. (In fact, lower case and ucfirst
versions exist for all HTML elements \- they're just not always exportable.)
.SS "General Purpose Functions"
.IX Subsection "General Purpose Functions"
.ie n .IP """ELEMENT($tagname, @arguments)""" 4
.el .IP "\f(CWELEMENT($tagname, @arguments)\fR" 4
.IX Item "ELEMENT($tagname, @arguments)"
If you need to insert an element which doesn't have its own function.
.ie n .IP TEXT($string) 4
.el .IP \f(CWTEXT($string)\fR 4
.IX Item "TEXT($string)"
Produces a text node.
.ie n .IP COMMENT($string) 4
.el .IP \f(CWCOMMENT($string)\fR 4
.IX Item "COMMENT($string)"
Produces an HTML comment.
.ie n .IP CHUNK($string) 4
.el .IP \f(CWCHUNK($string)\fR 4
.IX Item "CHUNK($string)"
Parses the string as HTML, and produces a list of elements, text nodes and
comments.
.Sp
This should be a so-called "balanced chunk". Due to limitations in
HTML::HTML5::Parser, this only works for body content. Croaks if
HTML::HTML5::Parser is not installed.
.ie n .IP XML_CHUNK($string) 4
.el .IP \f(CWXML_CHUNK($string)\fR 4
.IX Item "XML_CHUNK($string)"
More useful version of \f(CW\*(C`CHUNK\*(C'\fR, without the restriction on content,
but input needs to be a balanced and well-formed XML chunk.
.ie n .IP RAW_CHUNK($string) 4
.el .IP \f(CWRAW_CHUNK($string)\fR 4
.IX Item "RAW_CHUNK($string)"
This allows you to include stuff that isn't anything close to valid 
HTML into the output document, such as a PHP block. e.g.
.Sp
.Vb 9
\&  html(
\&    head(
\&      title(\*(AqFunny test\*(Aq),
\&      ),
\&    body(
\&      h1(\*(AqFunny test\*(Aq),
\&      RAW_CHUNK("<p>Here\*(Aqs a fish: <=><"),
\&      ),
\&    );
.Ve
.Sp
A processing instruction is used to represent this data in the DOM.
HTML::HTML5::Writer can detect that processing instruction and use it to
output the raw data. If you're not using HTML::HTML5::Writer to serialise
the document, then you may need to post-process the serialised document.
.Sp
With great power comes great responsibility.
.SS "Boiler-Plate Functions"
.IX Subsection "Boiler-Plate Functions"
There are also a number of functions that create lists of multiple HTML
elements, for boiler-plate code.
.ie n .IP """JQUERY(\-version => $ver, %options)""" 4
.el .IP "\f(CWJQUERY(\-version => $ver, %options)\fR" 4
.IX Item "JQUERY(-version => $ver, %options)"
Link to jQuery at a CDN.
.Sp
Other options include \fB\-source\fR, to indicate where to link to jQuery (currently
allowed values are "Google", "Microsoft" and "official"); and \fB\-min\fR, a boolean
which indicates whether the minified version should be linked to (true by
default).
.Sp
Setting option \fB\-ui\fR to true, also includes jQuery UI. A version number can be
indicated using \fB\-ui_version\fR. A theme can be included setting \fB\-theme\fR. Setting
either \fB\-ui_version\fR or \fB\-theme\fR will imply \fB\-ui\fR.
.Sp
.Vb 6
\&  JQUERY(
\&    \-source     => \*(Aqofficial\*(Aq,
\&    \-version    => \*(Aq1.6.4\*(Aq,
\&    \-ui_version => \*(Aq1.8.16\*(Aq,
\&    \-theme      => \*(Aqeggplant\*(Aq,
\&    );
.Ve
.Sp
If versions aren't provided, defaults to the latest versions of the libraries
that the author of HTML::HTML5::Builder was aware of at the time of publication.
If you choose a version which is known to be unavailable at the selected CDN,
the function should automatically choose a slightly later version.
.ie n .IP CREATIVE_COMMONS($licence) 4
.el .IP \f(CWCREATIVE_COMMONS($licence)\fR 4
.IX Item "CREATIVE_COMMONS($licence)"
.PD 0
.ie n .IP """CREATIVE_COMMONS(\-licence => $licence, %options)""" 4
.el .IP "\f(CWCREATIVE_COMMONS(\-licence => $licence, %options)\fR" 4
.IX Item "CREATIVE_COMMONS(-licence => $licence, %options)"
.PD
\&\f(CW$licence\fR can be one of 'by', 'by\-nd', 'by\-nc', 'by\-sa', 'by\-sa\-nc',
or 'by\-sa\-nd'.
.Sp
Other options supported are:
.RS 4
.IP \(bu 4
\&\fB\-url\fR \- URL of the thing being licensed (if not the page itself)
.IP \(bu 4
\&\fB\-size\fR \- 'large' or 'small' for the image
.IP \(bu 4
\&\fB\-title\fR \- title of the work
.IP \(bu 4
\&\fB\-attributionName\fR \- name people should use for attribution
.IP \(bu 4
\&\fB\-attributionURL\fR \- link people should use for attribution
.RE
.RS 4
.RE
.ie n .IP OPENGRAPH(%data) 4
.el .IP \f(CWOPENGRAPH(%data)\fR 4
.IX Item "OPENGRAPH(%data)"
Returns a list of <meta> elements providing Open Graph Protocol data
for your page.
.Sp
.Vb 5
\&  OPENGRAPH(
\&    \-title       => "Hello World",
\&    \-type        => "example",
\&    \-description => "A global greeting.",
\&    );
.Ve
.SS "Exporting Functions"
.IX Subsection "Exporting Functions"
None by default. Pretty much anything can be exported on request.
.PP
Export tags:
.IP \(bu 4
\&\f(CW\*(C`:all\*(C'\fR \- everything
.IP \(bu 4
\&\f(CW\*(C`:standard\*(C'\fR \- elements that are not obsolete in HTML5, plus ELEMENT, TEXT, COMMENT, CHUNK, XML_CHUNK and RAW_CHUNK
.IP \(bu 4
\&\f(CW\*(C`:metadata\*(C'\fR \- head title base Link Meta style
.IP \(bu 4
\&\f(CW\*(C`:sections\*(C'\fR \- body div section nav article aside h1 h2 h3 h4 h5 h6 header footer address
.IP \(bu 4
\&\f(CW\*(C`:grouping\*(C'\fR \- p hr br pre dialog blockquote ol ul li dl dt dd
.IP \(bu 4
\&\f(CW\*(C`:text\*(C'\fR \- a Q cite em strong small mark dfn abbr progress meter code var samp kbd Sub sup span i b bdo ruby rt rp Time
.IP \(bu 4
\&\f(CW\*(C`:embedded\*(C'\fR \- figure img iframe embed object param video audio source canvas area
.IP \(bu 4
\&\f(CW\*(C`:tabular\*(C'\fR \- table thead tbody tfoot th td colgroup col caption
.IP \(bu 4
\&\f(CW\*(C`:form\*(C'\fR \- form fieldset label input button select datalist optgroup option textarea output
.SS "Object Oriented Interface"
.IX Subsection "Object Oriented Interface"
You can also use these functions as methods of an object blessed into
the HTML::HTML5::Builder package.
.PP
.Vb 12
\&  my $b = HTML::HTML5::Builder\->new;
\&  my $document = $b\->html(
\&    \-lang => \*(Aqen\*(Aq,
\&    $b\->head(
\&      $b\->title(\*(AqTest\*(Aq, \e(my $foo)),
\&      $b\->meta(\-charset => \*(Aqutf\-8\*(Aq),
\&    ),
\&    $b\->body(
\&      $b\->h1(\*(AqTest\*(Aq),
\&      $b\->p(\*(AqThis is a test.\*(Aq)
\&    ),
\&  );
.Ve
.SS "Using with RDF::RDFa::Generator"
.IX Subsection "Using with RDF::RDFa::Generator"
RDF::RDFa::Generator has a \f(CW\*(C`nodes\*(C'\fR method which returns a handy list of
\&\f(CW\*(C`XML::LibXML::Node\*(C'\fR objects.
.PP
.Vb 4
\&  use DateTime;
\&  use HTML::HTML5::Builder qw[:standard];
\&  use RDF::RDFa::Generator;
\&  use RDF::Trine;
\&  
\&  my $url   = \*(Aqhttp://dbpedia.org/data/Charles_Darwin\*(Aq;
\&  my $model = RDF::Trine::Model\->new;
\&  RDF::Trine::Parser\->parse_url_into_model($url, $model);
\&  
\&  my $gen = RDF::RDFa::Generator\->new(style=>\*(AqHTML::Pretty\*(Aq);
\&  
\&  print html(
\&    head(
\&      title("Some Data About Charles Darwin"),
\&      ),
\&    body(
\&      h1("Some Data About Charles Darwin"),
\&      $gen\->nodes($model),
\&      hr(),
\&      address(
\&        "Source: $url", br(),
\&        "Generated: ", Time(DateTime\->now),
\&        ),
\&      ),
\&    );
.Ve
.PP
Nice?
.SS "Using with XML::LibXML::PrettyPrint"
.IX Subsection "Using with XML::LibXML::PrettyPrint"
HTML::HTML5::Builder doesn't nicely indent your markup, but
XML::LibXML::PrettyPrint can.
.PP
.Vb 6
\&  use HTML::HTML5::Builder qw(:standard);
\&  use XML::LibXML::PrettyPrint qw(print_xml);
\&  print_xml html(
\&    head(title("Test")),
\&    body(h1("Test"), p("This is a test.")),
\&    );
.Ve
.SH BUGS
.IX Header "BUGS"
Please report any bugs to
<http://rt.cpan.org/Dist/Display.html?Queue=HTML\-HTML5\-Builder>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
XML::LibXML,
HTML::HTML5::Writer,
HTML::HTML5::Builder::Document.
.SH AUTHOR
.IX Header "AUTHOR"
Toby Inkster <tobyink@cpan.org>.
.SH "COPYRIGHT AND LICENCE"
.IX Header "COPYRIGHT AND LICENCE"
This software is copyright (c) 2011 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"
THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.