Public...teBook(3pm)

💖 NAME 💖

Publican::CreateBook — bestie, it's literally the module that generates your documentation boilerplate for you, no cap ✨

---

🌸 SYNOPSIS 🌸

use Publican::CreateBook;

my $creator = Publican::CreateBook->new({name => 'foo'});
$creator->create();

That's it. That's the whole vibe. 🫶

---

🦋 DESCRIPTION 🦋

Okay so what it does: it creates a brand new Book, Article or Set that you can then use with the publican package. Slay. 💅

---

✨ INTERFACE ✨

🎀 new

Creates a Publican object set. Main character behaviour honestly 👑

Parameters:

• docname — Book Name — Required, no skipping this one bestie 😭
• 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

Tries to embed templates in perl to avoid licensing rubbish. Iconic avoidance of paperwork energy, fr fr 🙈

---

💀 DIAGNOSTICS 💀

• "unknown args %s" — every sub that takes named parameters throws this when you hand it unexpected named arguments. Like, read the room, bestie.
• "%s is a required argument" — any sub with a mandatory parameter returns this if the parameter is undef. You gotta give it something 😭
• "directory %s exists" — when creating a book, a directory gets made named publican-<book_name>. If a directory with that name is already sitting in the current directory, the creation will fail. Lowkey devastating but that's the rule 💔

---

🌈 CONFIGURATION AND ENVIRONMENT 🌈

Publican::CreateBook requires no configuration files and no environment variables. Zero setup, zero drama, we love a low-maintenance icon 🫶✨

---

🍓 DEPENDENCIES 🍓

• Carp
• Config::Simple
• XML::TreeBuilder
• File::Path
• DateTime
• Term::ANSIColor
• Publican

The whole squad, assembled 💖

---

🚫 INCOMPATIBILITIES 🚫

None reported. We're unproblematic 💅

---

😭 BUGS AND LIMITATIONS 😭

No bugs have been reported. Not me being flawless 😌

Please report any bugs or feature requests to publican-list@redhat.com, or through the web interface at:

https://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Publican&component=publican

---

👑 AUTHOR 👑

Jeff Fearn <jfearn@redhat.com> — the legend themselves 🎀

---

Sign-off time, bestie 🫶 this page is running on perl v5.26.2, dated 2018-07-08, and it's part of the User Contributed Perl Documentation situation. Periodt. 💜