| 1 | package Positron; | ||
| 2 | our $VERSION = 'v0.1.3'; # VERSION | ||
| 3 | |||
| 4 | =head1 NAME | ||
| 5 | |||
| 6 | Positron - a family of templating and markup modules | ||
| 7 | |||
| 8 | =head1 VERSION | ||
| 9 | |||
| 10 | version v0.1.3 | ||
| 11 | |||
| 12 | =head1 SYNOPSIS | ||
| 13 | |||
| 14 | use Positron; | ||
| 15 | |||
| 16 | my $template = Positron::Template->new(); | ||
| 17 | |||
| 18 | my $dom = create_dom_tree(); | ||
| 19 | my $data = { foo => 'bar', baz => [ 1, 2, 3 ] }; | ||
| 20 | my $result = $template->process($dom, $data); | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | Positron is a family of templating and markup modules. The module C<Positron> itself | ||
| 25 | is an umbrella module which simply requires all the other modules, but you can also | ||
| 26 | load them all separately. | ||
| 27 | |||
| 28 | B<Warning:> this is still B<alpha software> at best. Things can and will change, in | ||
| 29 | backwards incompatible and inconvenient ways. | ||
| 30 | |||
| 31 | =head1 MAIN MODULES | ||
| 32 | |||
| 33 | These are the modules you will most likely be using. | ||
| 34 | |||
| 35 | =head2 Positron::DataTemplate | ||
| 36 | |||
| 37 | L<Positron::DataTemplate> is a templating system for plain data. It accepts plain data | ||
| 38 | as templates, i.e. nested lists and hashes, and transforms them using the passed | ||
| 39 | template parameters (the "environment") into even more plain data. If this sounds | ||
| 40 | confusing, please check the module itself for examples. | ||
| 41 | |||
| 42 | =cut | ||
| 43 | |||
| 44 | use Positron::DataTemplate; | ||
| 45 | |||
| 46 | =head1 SUPPORTING MODULES | ||
| 47 | |||
| 48 | =head2 Positron::Environment | ||
| 49 | |||
| 50 | L<Positron::Environment> represents a set of template parameters, a mapping between | ||
| 51 | keys and values for evaluating the template. This is very similar to a plain hash, | ||
| 52 | but with an additional C<parent> mechanism for forming a hierarchical | ||
| 53 | stack of environments. | ||
| 54 | |||
| 55 | =cut | ||
| 56 | |||
| 57 | use Positron::Environment; | ||
| 58 | |||
| 59 | =head2 Positron::Expression | ||
| 60 | |||
| 61 | L<Positron::Expression> implements a simple language for template parameter evaluation. | ||
| 62 | Instead of only looking up values with plain keys, expressions can be hash lookups, | ||
| 63 | method calls, or literal strings. | ||
| 64 | |||
| 65 | =cut | ||
| 66 | |||
| 67 | use Positron::Expression; | ||
| 68 | |||
| 69 | 1; # End of Positron | ||
| 70 | |||
| 71 | __END__ |