Module::Build::IkiWiki - Extension for develop Ikiwiki plugins


Module-Build-IkiWiki documentation  | view source Contained in the Module-Build-IkiWiki distribution.

Index


NAME

Top

Module::Build::IkiWiki - Extension for develop Ikiwiki plugins

VERSION

Top

This document describes Module::Build::IkiWiki version 0.0.2

SYNOPSIS

Top

    #!/usr/bin/perl 

    use Module::Build::IkiWiki;

    my $build = Module::Build::IkiWiki->new(
                    module_name     =>  'xxxx',
                    license         =>  'gpl',
                    ...
                    ikiwiki_paths       =>  {
                        'templates' =>  q(/usr/share/ikiwiki/templates),
                        'css'       =>  q(/usr/share/ikiwiki/basewiki),
                        },
                    ikiwiki_templates   =>  [ glob('extras/*.tmpl') ],
                    ikiwiki_stylesheets =>  [ glob('extras/*.css') ],
                );

    $build->create_build_script();

DESCRIPTION

Top

The goal of this module is build and install IkiWiki plugins in Perl, subclassing the Module::Build and adding some extra funcionalites to it.

For a description of the interface see Module::Build::API.

This is a list of a new parameters in the Module::Build::new method:

ikiwiki_paths

Define the install paths of the components using a hash with the following keys:

templates

The default value is /usr/share/ikiwiki/templates.

css

The default value is /usr/share/ikiwiki/basewiki.

ikiwiki_templates

List of templates for install.

ikiwiki_stylesheets

List of css stylesheets files to install.

SUBROUTINES/METHODS

Top

new( )

Override the new method in the base class and check the special parameters for ikiwiki.

ACTION_install( )

Install the template and css files of the package.

ACTION_fakeinstall( )

Show the install actions to the standard output.

DIAGNOSTICS

Top

The error messages are from the base class. This package don't generate any exceptions.

CONFIGURATION AND ENVIRONMENT

Top

Module::Build::IkiWiki requires no configuration files or environment variables.

DEPENDENCIES

Top

Module::Build

INCOMPATIBILITIES

Top

None reported.

BUGS AND LIMITATIONS

Top

No bugs have been reported.

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

AUTHOR

Top

Víctor Moral <victor@taquiones.net>

LICENSE AND COPYRIGHT

Top


Module-Build-IkiWiki documentation  | view source Contained in the Module-Build-IkiWiki distribution.