Public...ocBook(3pm)

📦

version 4.3.2 · 7 versions

4.3.2 · debian bookworm, ubuntu jammy (latest)
4.3.2 · ubuntu stonking
4.3.2 · fedora 43
4.3.2 · fedora 44
4.3.2 · ubuntu noble
4.3.2 · ubuntu resolute
4.3.2 · debian trixie, ubuntu questing

💖 Publican::Builder::DocBook 💖

okay bestie, so this is a Perl module manpage — a 3pm one, straight outta User Contributed Perl Documentation — and it's called Publican::Builder::DocBook. she's the one who takes your DocBook XML and turns it into, like, every other format. iconic behavior honestly.

🌸 NAME 🌸

Publican::Builder::DocBook — a module to Convert XML to various output formats. no cap, that's the whole job description.

✨ SYNOPSIS ✨

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

look at her. three lines. doing the most with the least. we love a low-effort entrance 💅

🦋 DESCRIPTION 🦋

Manipulate DocBook XML and convert to other formats. that's it, that's the vibe. XML goes in, other formats come out 🎀

👑 INTERFACE 👑

this is the part where we meet all the methods. buckle up, there's a lot of them and they're all kinda doing the most.

`new`

Create a new Publican::Builder::DocBook object. the origin story. the main character entrance ✨

`build`

Transform the source in to another format.

and then there's this absolute mess of a template fix that's just sitting here, flagged as a bug, and we're showing it to you verbatim because we do not edit the facts, bestie:

#BUGBUG fix templates print( $OUT <<EOL \t\t\t\t\t\t<div class="group" id="[%
       prod %]-[% ver.replace('\\.', '-')%]-$sort">
       \t\t\t\t\t\t\t<span>$term</span> EOL );
                                           print( $OUT <<EOL
       \t\t\t\t\t\t\t<span>$text</span>
       EOL
                                           ) if ( $text && $text ne "" );

                                           print( $OUT <<EOL
       \t\t\t\t\t\t</div>
       EOL
                                           );

not me showing you a #BUGBUG in the middle of a method description 😭 it's giving "we know, we know."

`transform`

Run XSLT over XML. short. sweet. does what it says on the tin.

`drupal_transform`

Write csv file for drupal node import. very specific. very niche. very slay.

`escape_xml`

Escapes an input string so that it can be used in an XML Element. safety first, always 🫶

`get_nodes_order`

Get all nodes with id from xml files in order. she's organized. she's type A. we stan.

`get_chunk_filename`

Gets the chunked filename for an LibXML::Node in a tree.

`convert_num_to_alpha`

Converts a numeric number to an alpha list item. ie 1 -> a, 27 -> aa. math girlies rise up 🌈

`build_drupal_book`

Convert each html file into csv a row for drupal.

`adjustColumnWidths`

Adjust column widths for XML Tables. Converts hard coded to px and relative withs to %.

FO input:

"<?xml version=\"1.0\"?>\n<fo:table-column
xmlns:fo=\"http://www.w3.org/1999/XSL/Format\" column-number=\"1\"
column-width=\"1*\"/>\n<fo:table-column
xmlns:fo=\"http://www.w3.org/1999/XSL/Format\" column-number=\"2\"
column-width=\"2*\"/>\n<fo:table-column
xmlns:fo=\"http://www.w3.org/1999/XSL/Format\" column-number=\"3\"
column-width=\"1*\"/>\n<fo:table-column
xmlns:fo=\"http://www.w3.org/1999/XSL/Format\" column-number=\"4\"
column-width=\"3*\"/>\n"

HTML input:

"<?xml version=\"1.0\"?>\n<colgroup
xmlns=\"http://www.w3.org/1999/xhtml\"><col width=\"1*\"/><col
width=\"2*\"/><col width=\"1*\"/><col width=\"3*\"/></colgroup>\n"

Returns: modified input tree which is XHTML or XML:FO. cute, she does both 💜

`highlight`

perl_highlight syntax highlighting.

Edit highlight_color template in pdf.xsl and .perl_XXX in CSS to change highlight colours.

Returns: Modified input tree, which is DocBook XML.

`insertCallouts`

XSLT callout function for inserting Callout markup in to verbatim text.

Parameters: areaspec: the DocBook areaspec node set; verbatim: the XHTML/XML:FO tree to place gfx in.

Returns: modified $verbatim

BUGBUG: BZ #561618 — BUGBUG: The approach taken here does not work for tagged content in the verbatim. BUGBUG: Need to walk the node tree in childnode instead of using it as a string. BUGBUG: make sure class is being set.

okay so that's three whole BUGBUGs stacked on top of each other. it's giving "known issues, we're working on it, please don't look directly at it" 💀

`numberLines`

perl_numberLines XSL function for numbering lines.

Returns: Modified input tree, which is DocBook XML.

`web_labels`

Determine if the labels use in the web navigation are different from the names used for packaging.