NAME

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

VERSION

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

SYNOPSIS

    #!/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

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

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

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

CONFIGURATION AND ENVIRONMENT

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

DEPENDENCIES

Module::Build

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

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

Víctor Moral <victor@taquiones.net>

LICENSE AND COPYRIGHT

Copyright (C) 2008 <Victor Moral>

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License or any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

cpanm Module::Build::IkiWiki

perl -MCPAN -e shell
install Module::Build::IkiWiki