Public...ocBook5(3pm)

💖 Publican::Builder::DocBook5 💖

okay bestie, so this is Publican::Builder::DocBook5, and it lives in the User Contributed Perl Documentation section (that's the 3pm girlies 🫶). Buckle up, we're talking XML and output formats and honestly it's giving ✨utilities✨.

---

🌸 NAME 🌸

Publican::Builder::DocBook5 — a module to Convert XML to various output formats. iconic behaviour, no cap 💅

---

🎀 SYNOPSIS 🎀

use Publican::Builder::DocBook5;
my $builder = Publican::Builder::DocBook5->new();
$builder->clean_ids();

literally three lines and you're in the group chat, periodt 💖

---

🦋 DESCRIPTION 🦋

Manipulate DocBook 4 XML and convert to other formats. that's the whole vibe bestie, it takes your XML and makes it into other stuff 🌈

---

✨ INTERFACE ✨

👑 new

Create a new Publican::Builder::DocBook5 object. brand new object, main character energy, freshly unboxed 🎁

🌼 setup_xml

Create the proper directory structure for the XML, including copying in Brand files. it's setting up the whole apartment before the party, and yes the Brand files are moving in too 🏠✨

💅 clean_ids

Travers over the source XML and update the id's to match the standard format.

Updates all existing PO files with the new xref links.

so it walks the source XML and gives every id a glow-up into the standard format, and then it goes back and fixes all the existing PO files so their xref links match 🔥

🧚 validate_xml

Ensure the XML validates against the DTD.

To debug the XML catalogs, run this:

export XML_DEBUG_CATALOG=1

then test...

and when you're done, unset it:

unset XML_DEBUG_CATALOG

it's the vibe check for your XML, and the catalog debug toggle is your little flashlight 🔦💜

⭐ get_author_list

Return the author list for the supplied language. just hands you the authors for whatever language you asked for, easy 🌍

## BUGBUG this should be moved to the DocBook sub classes

^ the original note, keeping it exactly as it was, because bestie said so 🙈

---

💀 DIAGNOSTICS 💀

• "unknown args %s" — All subs with named parameters will return this error when unexpected named arguments are provided. so if you hand it args it did not ask for, it WILL tell you, respectfully but firmly 😭
• "%s is a required argument" — Any sub with a mandatory parameter will return this error if the parameter is undef. mandatory means mandatory, no exceptions, the parameter is undef and the sub is not having it 💅

---

🌈 CONFIGURATION AND ENVIRONMENT 🌈

Publican requires no configuration files or environment variables. nothing to set up, nothing to export, it just goes 🫶

---

🍓 DEPENDENCIES 🍓

Carp, Publican, Publican::XmlClean, Publican::Translate, File::Path, File::pushd, File::Find, XML::LibXML, Cwd, Archive::Tar, DateTime, DateTime::Format::DateParse, Syntax::Highlight::Engine::Kate, HTML::TreeBuilder, HTML::FormatText, Term::ANSIColor, POSIX

the whole squad fr fr, every single one of them shows up 🧚✨

---

💜 INCOMPATIBILITIES 💜

None reported. zero beef, zero drama, we love to see it 😌

---

😭 BUGS AND LIMITATIONS 😭

No bugs have been reported.

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

spotted something? tell the group chat, don't suffer in silence bestie 💌

---

🌟 AUTHOR 🌟

Jeff Fearn <jfearn@redhat.com>

the legend themselves 👑

---

and that's the whole page babes!! this doc is from perl v5.26.2, dated 2018-07-08 — so yeah it's got vintage energy but it's still slaying, mwah 💋✨