Public...ocBook4(3pm)

πŸ’– Publican::Builder::DocBook4 β€” the manual, but make it cute ✨

okay bestie so this is Publican::Builder::DocBook4, straight out of the 3pm section (Perl module land, iykyk). Buckle up, she's a whole vibe πŸ’…


πŸ¦‹ NAME

Publican::Builder::DocBook4 β€” a module that converts XML into a bunch of other output formats. that's it. that's the girl. 🌸


✨ SYNOPSIS

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

literally three lines and you're off 🫢


πŸŽ€ DESCRIPTION

Manipulate DocBook 4 XML and convert it into other formats. that's the whole plot bestie πŸ’–


πŸ‘‘ INTERFACE

🌟 new

Create a new Publican::Builder::DocBook4 object. fresh out the box, no cap ✨

🌟 setup_xml

Create the proper directory structure for the XML β€” and yes, that includes copying in the Brand files. gotta have the fits ready πŸŽ€

🌟 clean_ids

Travers over the source XML and update the id's so they match the standard format. glow-up for your IDs πŸ’…

Also updates all existing PO files with the new xref links. not me accidentally leaving a PO file out... no bestie, she handles it 🌈

🌟 validate_xml

Ensure the XML validates against the DTD. vibe check but for your markup πŸ¦‹

To debug the XML catalogs:

export XML_DEBUG_CATALOG=1

test...

unset XML_DEBUG_CATALOG

🌟 get_author_list

Return the author list for the supplied language. multilingual queens only πŸ‘‘


😭 DIAGNOSTICS

  • "unknown args %s" β€” every sub that takes named parameters returns this error when unexpected named arguments get passed in. she does not do surprises πŸ’€
  • "%s is a required argument" β€” any sub with a mandatory parameter returns this error if that parameter is undef. she needs her things, fr fr πŸ™ˆ

🌸 CONFIGURATION AND ENVIRONMENT

Publican requires no configuration files or environment variables. low maintenance, high value, iconic behavior ✨


πŸ“ DEPENDENCIES

Carp version 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

look at that roster. the whole squad pulled up πŸ’œ


🧚 INCOMPATIBILITIES

None reported. she plays nice with everyone 🫢


πŸ’€ BUGS AND LIMITATIONS

No bugs have been reported. (we love a clean record, periodt πŸ”₯)

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> β€” thank you king πŸ’–


and that's the whole page bestie!! this one shipped with perl v5.26.2, dated 2018-07-08, and it lives in the Publican::Builder::DocBook4(3pm) corner of the manual-verse. slay, go build something gorgeous βœ¨πŸ’…πŸ¦‹

πŸ“¦ where this page comes from