.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Template::Declare::TagSet 3pm"
.TH Template::Declare::TagSet 3pm "2017-11-21" "perl v5.26.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"
Template::Declare::TagSet \- Base class for tag sets used by Template::Declare::Tags
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    package My::TagSet;
\&    use base \*(AqTemplate::Declare::TagSet\*(Aq;
\&
\&    # returns an array ref for the tag names
\&    sub get_tag_list {
\&        [ qw(
\&            html body tr td table
\&            base meta link hr
\&        )]
\&    }
\&
\&    # prevents potential naming conflicts:
\&    sub get_alternate_spelling {
\&        my ($self, $tag) = @_;
\&        return \*(Aqrow\*(Aq  if $tag eq \*(Aqtr\*(Aq;
\&        return \*(Aqcell\*(Aq if $tag eq \*(Aqtd\*(Aq;
\&    }
\&
\&    # Specifies whether "<tag></tag>" can be
\&    # combined to "<tag />":
\&    sub can_combine_empty_tags {
\&        my ($self, $tag) = @_;
\&        $tag =~ /^ (?: base | meta | link | hr ) $/x;
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Template::Declare::TagSet is the base class for declaring packages of
Template::Delcare tags. If you need to create new tags for use in your
templates, this is the base class for you! Review the source code of
Template::Declare::TagSet::HTML for a
useful example.
.SH "METHODS"
.IX Header "METHODS"
.SS "new( \s-1PARAMS\s0 )"
.IX Subsection "new( PARAMS )"
.Vb 4
\&    my $tag_set = Template::Declare::TagSet\->new({
\&        package   => \*(AqFoo::Bar\*(Aq,
\&        namespace => undef,
\&    });
.Ve
.PP
Constructor created by \f(CW\*(C`Class::Accessor::Fast\*(C'\fR, accepting an optional hash
reference of parameters.
.SS "get_tag_list"
.IX Subsection "get_tag_list"
.Vb 1
\&    my $list = $tag_set\->get_tag_list();
.Ve
.PP
Returns an array ref for the tag names offered by a tag set.
.SS "get_alternate_spelling( \s-1TAG\s0 )"
.IX Subsection "get_alternate_spelling( TAG )"
.Vb 1
\&    $bool = $obj\->get_alternate_spelling($tag);
.Ve
.PP
Returns true if a tag has an alternative spelling. Basically it provides a way
to work around naming conflicts. For example, the \f(CW\*(C`tr\*(C'\fR tag in \s-1HTML\s0 conflicts
with Perl's \f(CW\*(C`tr\*(C'\fR operator, and the \f(CW\*(C`template\*(C'\fR tag in \s-1XUL\s0 conflicts with the
\&\f(CW\*(C`template\*(C'\fR sub exported by \f(CW\*(C`Template::Declare::Tags\*(C'\fR.
.SS "can_combine_empty_tags( \s-1TAG\s0 )"
.IX Subsection "can_combine_empty_tags( TAG )"
.Vb 1
\&    $bool = $obj\->can_combine_empty_tags($tag);
.Ve
.PP
Specifies whether \f(CW\*(C`<tag></tag>\*(C'\fR can be combined into a single token,
\&\f(CW\*(C`<tag />\*(C'\fR. By default, all tags can be combined into a single token;
override in a subclass to change this value where appropriate. For example,
\&\f(CW\*(C`Template::Declare::TagSet::HTML\->can_combine_empty_tags(\*(Aqimg\*(Aq)\*(C'\fR returns
true since \f(CW\*(C`<img src="..." />\*(C'\fR is always required for \s-1HTML\s0 pages.
\&\f(CW\*(C`Template::Declare::TagSet::HTML\->can_combine_empty_tags(\*(Aqscript\*(Aq)\*(C'\fR, on
the other hand, returns false, since some browsers can't handle a single
script token.
.SH "ACCESSORS"
.IX Header "ACCESSORS"
This class has two read-only accessors:
.SS "package"
.IX Subsection "package"
.Vb 1
\&    my $package = $obj\->package();
.Ve
.PP
Retrieves the value of the \f(CW\*(C`package\*(C'\fR option set via the constructor.
.SS "namespace"
.IX Subsection "namespace"
.Vb 1
\&    my $namespace = $obj\->namespace();
.Ve
.PP
Retrieves the value of the \f(CW\*(C`namespace\*(C'\fR option set via the constructor.
.SH "AUTHOR"
.IX Header "AUTHOR"
Agent Zhang <agentzh@yahoo.cn>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Template::Declare::TagSet::HTML, Template::Declare::TagSet::XUL, Template::Declare::Tags,
Template::Declare.