Florian Ragwitz > MasonX-Component > MasonX::Component

Download:
MasonX-Component-0.01_02.tar.gz

Dependencies

Annotate this POD

Module Version: 0.01_02   Source  

NAME ^

MasonX::Component - manage mason components

SYNOPSIS ^

    use MasonX::Component::Interp;

    my $interp = MasonX::Component::Interp->new;
    $interp->exec('/component');

DESCRIPTION ^

This distribution contains infrastructure to manage systemwide installed mason components. It's intended to be used to install mason components from CPAN and use them in your applications.

This works by registering components at installation time with MasonX::Component::Registry and using MasonX::Component::Interp instead of HTML::Mason::Interp which will automatically pick up all components registered in the registry.

WRITING COMPONENTS ^

Writing MasonX::Component components is easy. They are just normal CPAN distributions with the following differences:

They contain a directory with mason components which needs to be installed next to the things in lib/.
They need to register their components with MasonX::Registry at installation time.

If you happen to like Module::Install, do the following:

create a component directory

Put all your components in there.

create a component.ini file

This contains meta information of your components:

    [MasonX::Component::YourDistribution]
    priority = 5
    components = foo, bar
depend on MasonX::Component

Makefile.PL:

    requires 'MasonX::Component' => 0;
install and register your components

Makefile.PL:

    mason_component;

This will automatically install files in component and register them with the information in component.ini when you run make install.

BUGS AND LIMITATIONS ^

Currently MasonX::Component::Interp puts all registered components into the comp_root. A mechanism to only use requested components or exclude certain things is planned but not implemented yet.

No bugs have been reported.

Please report any bugs or feature requests to bug-masonx-component@rt.cpan.org, or through the web interface at http://rt.cpan.org.

SEE ALSO ^

HTML::Mason
HTML::Mason::Interp
MasonX::Component::Registry
MasonX::Component::Interp

AUTHOR ^

Florian Ragwitz <rafl@debian.org>

LICENCE AND COPYRIGHT ^

Copyright (c) 2007, Florian Ragwitz <rafl@debian.org>. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY ^

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

syntax highlighting: