1Publican::CreateBook(3)User Contributed Perl DocumentatioPnublican::CreateBook(3)
2
3
4
6 Publican::CreateBook - A module for generating documentation
7 boilerplate
8
10 use Publican::CreateBook;
11
12 my $creator = Publican::CreateBook->new({name => 'foo'});
13 $creator->create();
14
16 Creates a new Book, Article or Set for use with the publican package
17
19 new
20 Create a Publican object set.
21
22 Parameters:
23
24 docname Book Name (Required)
25 version Product Version (default: 0.1)
26 edition Edition (default: 0)
27 product Product Name (default: Documentation)
28 brand Brand (default: common)
29 xml_lang Source Language (default: en-US)
30 type Book|Set|Article (default: Book)
31
32 create
33 Try embedding templates in perl to avoid licensing rubbish
34
36 "unknown args %s"
37 All subs with named parameters will return this error when
38 unexpected named arguments are provided.
39
40 "%s is a required argument"
41 Any sub with a mandatory parameter will return this error if the
42 parameter is undef.
43
44 "directory %s exists"
45 When creating a book a directory is created named
46 publican-<book_name>. If a directory with that name is in the
47 current directory the creation will fail.
48
50 Publican::CreateBook requires no configuration files or environment
51 variables.
52
54 Carp Config::Simple XML::TreeBuilder File::Path DateTime
55 Term::ANSIColor Publican
56
58 None reported.
59
61 No bugs have been reported.
62
63 Please report any bugs or feature requests to
64 "publican-list@redhat.com", or through the web interface at
65 <https://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Publican&component=publican>.
66
68 Jeff Fearn "<jfearn@redhat.com>"
69
70
71
72perl v5.28.1 2019-02-02 Publican::CreateBook(3)