lib/Excel/Template/Container/Scope.pm

   1 package Excel::Template::Container::Scope;
   2
   3 use strict;
   4
   5 BEGIN {
   6     use vars qw(@ISA);
   7     @ISA = qw(Excel::Template::Container);
   8
   9     use Excel::Template::Container;
  10 }
  11
  12 # This is used as a placeholder for scoping values across any number
  13 # of children. It does nothing on its own.
  14
  15 1;
  16 __END__
  17
  18 =head1 NAME
  19
  20 Excel::Template::Container::Scope
  21
  22 =head1 PURPOSE
  23
  24 To provide scoping of parameters for children
  25
  26 =head1 NODE NAME
  27
  28 SCOPE
  29
  30 =head1 INHERITANCE
  31
  32 Excel::Template::Container
  33
  34 =head1 ATTRIBUTES
  35
  36 None
  37
  38 =head1 CHILDREN
  39
  40 None
  41
  42 =head1 EFFECTS
  43
  44 None
  45
  46 =head1 DEPENDENCIES
  47
  48 None
  49
  50 =head1 USAGE
  51
  52   <scope param1="value1" param2="value2">
  53     ... Children here ...
  54   </scope>
  55
  56 In the above example, the children would all have access to the parameters
  57 param1 and param2. This is useful if you have a section of your template that
  58 all has the same set of parameter values, but don't have a common parent.
  59
  60 =head1 AUTHOR
  61
  62 Rob Kinyon (rob.kinyon@gmail.com)
  63
  64 =head1 SEE ALSO
  65
  66 =cut