.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07) .\" .\" 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" '' '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. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" 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 "Template::Declare::TagSet 3pm" .TH Template::Declare::TagSet 3pm "2010-12-08" "perl v5.10.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 "" can be \& # combined to "": \& 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`\*(C'\fR can be combined into a single token, \&\f(CW\*(C`\*(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`\*(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 . .SH "SEE ALSO" .IX Header "SEE ALSO" Template::Declare::TagSet::HTML, Template::Declare::TagSet::XUL, Template::Declare::Tags, Template::Declare.