1Publican::CreateBook(3)User Contributed Perl DocumentatioPnublican::CreateBook(3)
2
3
4

NAME

6       Publican::CreateBook - A module for generating documentation
7       boilerplate
8

VERSION

10       This document describes Publican::CreateBook version $VERSION
11

SYNOPSIS

13           use Publican::CreateBook;
14
15           my $creator = Publican::CreateBook->new({name => 'foo'});
16           $creator->create();
17

DESCRIPTION

19           Creates a new Book, Article or Set for use with the publican package
20

INTERFACE

22   new
23       Create a Publican object set.
24
25       Parameters:
26
27          docname           Book Name        (Required)
28          version           Product Version  (default: 0.1)
29          edition           Edition          (default: 0)
30          product           Product Name     (default: Documentation)
31          brand             Brand            (default: common)
32          xml_lang          Source Language  (default: en-US)
33          type              Book|Set|Article (default: Book)
34
35   create
36       Try embedding templates in perl to avoid licensing rubbish
37

DIAGNOSTICS

39       "unknown args %s"
40           All subs with named parameters will return this error when
41           unexpected named arguments are provided.
42
43       "%s is a required argument"
44           Any sub with a mandatory parameter will return this error if the
45           parameter is undef.
46
47       "directory %s exists"
48           When creating a book a directory is created named
49           publican-<book_name>. If a directory with that name is in the
50           current directory the creation will fail.
51

CONFIGURATION AND ENVIRONMENT

53       Publican::CreateBook requires no configuration files or environment
54       variables.
55

DEPENDENCIES

57       Carp Config::Simple XML::TreeBuilder File::Path DateTime
58       Term::ANSIColor Publican
59

INCOMPATIBILITIES

61       None reported.
62

BUGS AND LIMITATIONS

64       No bugs have been reported.
65
66       Please report any bugs or feature requests to
67       "publican-list@redhat.com", or through the web interface at
68       <https://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Publican&amp;component=publican>.
69

AUTHOR

71       Jeff Fearn  "<jfearn@redhat.com>"
72
73
74
75perl v5.12.4                      2011-09-22           Publican::CreateBook(3)
Impressum