LaTeXML...il::Pack(3)

💖 LaTeXML::Util::Pack 💖

okay bestie, this is the LaTeXML...il::Pack(3) page from the User Contributed Perl Documentation, and we're about to make TeX archives make sense. no cap. ✨

🌸 NAME 🌸

"LaTeXML::Util::Pack" — smart packing and unpacking of TeX archives. That's the whole name, and honestly it ate. 💅

🦋 DESCRIPTION 🦋

This module serves up an API and convenience methods for:

1. Unpacking Zip archives which contain a TeX manuscript.
2. Packing the files of a LaTeXML manuscript into a single archive
3. Extracting embeddable fragments, as well as single formulas from LaTeXML documents

All user-level methods are unconditionally exported by default. literally all the user-level ones, no extra import ceremony. 👑

🎀 METHODS 🎀

💜 unpack_source

$main_tex_source = unpack_source($archive,$extraction_directory);

Unpacks a given $archive into the $extraction_directory. Then it does a heuristic analysis to determine, and return, the main file of the TeX manuscript. If the main file cannot be determined, the $extraction_directory is removed and undef is returned. 😭

In this regard, we implement a simplified form of the logic in TeX::AutoTeX and particularly arXiv::FileGuess. iykyk. 🧚

bestie, pay attention: failed main-file detection means the extraction directory gets deleted and you get undef. that's the vibe check. 💀

💖 pack_collection

@packed_documents = pack_collection(collection=>\@documents,
       whatsout=>'math|fragment|archive', siteDirectory=>$path);

Packs a collection of documents using the packing method specified via the 'whatsout' option. If 'fragment' or 'math' are chosen, each input document is transformed into an embeddable fragment or a single formula, respectively. If 'archive' is chose (the page's spelling, bestie), all input documents are written into an archive in the specified 'siteDirectory'.

The name of the archive is provided by the 'destination' property of the first provided $document object.

Each document is expected to be a LaTeXML::Post::Document object. 👑

👑 AUTHOR 👑

Bruce Miller <bruce.miller@nist.gov>, Deyan Ginev <deyan.ginev@nist.gov>. iconic. 🫶

🌈 COPYRIGHT 🌈

Public domain software, produced as part of work done by the United States Government & not subject to copyright in the US. periodt. 💖

---

okay that's the whole page, bestie 💋 — it's perl v5.42.3, dated 2024-02-26, and it's the LaTeXML...il::Pack(3) page from the User Contributed Perl Documentation. byeeee ✨🎀