Publican::CreateBook3pm
A module for generating documentation boilerplate
Usage
use Publican::CreateBook;my $creator = Publican::CreateBook->new({name => 'foo'});$creator->create();
Overview
Creates a new Book, Article or Set for use with the publican package
Interface
new
Create a Publican object set.
Parameters:
docname Book Name (Required)version Product Version (default: 0.1)edition Edition (default: 0)product Product Name (default: Documentation)brand Brand (default: common)xml_lang Source Language (default: en-US)type Book|Set|Article (default: Book)
create
Try embedding templates in perl to avoid licensing rubbish
Diagnostics
- "unknown args %s"
-
All subs with named parameters will return this error when unexpected named arguments are provided.
- "%s is a required argument"
-
Any sub with a mandatory parameter will return this error if the parameter is undef.
- "directory %s exists"
-
When creating a book a directory is created named publican-<book_name>. If a directory with that name is in the current directory the creation will fail.
Configuration and environment
Publican::CreateBook requires no configuration files or environment variables.
Dependencies
Carp Config::Simple XML::TreeBuilder File::Path DateTime Term::ANSIColor Publican
Incompatibilities
None reported.
Bugs and limitations
No bugs have been reported.
Please report any bugs or feature requests to "[email protected]", or through the web interface at <https://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Publican&component=publican>.
Releases
8 releases since Debian 6.0 (Squeeze); the text changed 5 times.