Publican(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 — the `Publican(3pm)` page, but make it cute 💖

okay bestie, you found the man page for Publican — a Perl module from the User Contributed Perl Documentation corner of the world. It's the little control room that holds the settings for all the sub modules. Let's get into it. 🎀

✨ NAME ✨

Publican — used to control settings for sub modules. That's the whole job. She's the group chat admin of configuration. 👑

🌸 VERSION 🌸

This document describes Publican version $VERSION. Yes, literally the variable $VERSION, the docs are being mysterious and honestly? respect. 💅

🦋 SYNOPSIS 🦋

The vibe check, in code:

use Publican;

my $publican = Publican->new({DEBUG => 1});

That's it. That's the whole entrance. ✨

🎀 DESCRIPTION 🎀

She handles the general configuration of all sub modules. Every sub module shows up to her house and she hands out the settings. It's giving main character energy, no cap. 💜

🌈 INTERFACE 🌈

Here come the methods, one by one, no skips, no summarising, we do not do that here.

🔧 `_load_config`

Private method for loading a config file. It's the little helper behind the curtain — don't poke at her directly. 🙈

✅ `_validate_config`

Private method for validating configuration. Also behind the curtain. She checks that your config isn't a mess. 💅

🌟 `new`

Create a Publican object. 🎉

my $publican = Publican->new({debug => 1});

Parameters:

configfile — override the configuration file to use.
debug — use debug mode for messages.
common_config — override path to coomo configuration files. (yes, it really says coomo in the source docs, and we are preserving that typo with love 🫶)
common_content — override path to common content files.

🔊 `debug_msg`

Print out debugging information. Spammy in the best way. 🔥

🔍 `param`

Return the current value of a configuration parameter.

$publican->param('debug');

📖 `help_config`

Display a list of config file parameters and a short description of them. It's the "what even are my options" button. ✨

📂 `dir_list`

List all the files in a directory, and its sub-directories, matching the supplied regex. Recursive queen. 👑

🌍 `get_all_langs`

Get all valid language directories. 🌐

📝 `logger`

Log something — currently emits to STDOUT.

TODO: consider using Log::Dispatch or similar.

🗣️ `valid_lang`

Is the requested language valid according to I18N::LangTags::List? She'll tell you. No cap.

💬 `maketext`

Get localised strings. Translation bestie. 🦋

⚙️ `run_xslt`

Apply the supplied xslt file to the supplied XML and return a string of the output. Magic, but make it XML. ✨

🌳 `new_tree`

Create a new XML::TreeBuilder object with the required attributes for DocBook.

TODO: Make XmlClean use this.

📜 `dtd_string`

Returns a valid DTD for the DocBook tag supplied.

Parameters:

tag — the root tag for this file
dtdver — the DTD version
ent_file — an entity file to include (optional)

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

🚫 `print_banned_tags`

Print a list of tags that are not supported. Nope list. Not today. 💀

🕰️ `add_revision`

Add a full entry in to the revision history.

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

🔢 `get_ed_rev`

Get the current edition (version) and release from the Revision History file.

Parameters: language, bump.

If bump is set the returned revision will increment before it's returned.

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