1LaTeXML::Util::Pack(3)User Contributed Perl DocumentationLaTeXML::Util::Pack(3)
2
3
4

NAME

6       "LaTeXML::Util::Pack" - smart packing and unpacking of TeX archives
7

DESCRIPTION

9       This module provides an API and convenience methods for:
10           1. Unpacking Zip archives which contain a TeX manuscript.
11           2. Packing the files of a LaTeXML manuscript into a single archive
12           3. Extracting embeddable fragments, as well as single formulas from
13       LaTeXML documents
14
15       All user-level methods are unconditionally exported by default.
16
17   METHODS
18       "$main_tex_source = unpack_source($archive,$extraction_directory);"
19           Unpacks a given $archive into the $extraction_directory. Next,
20           perform a
21               heuristic analysis to determine, and return, the main file of
22           the TeX manuscript.
23               If the main file cannot be determined, the
24           $extraction_directory is removed and undef is returned.
25
26           In this regard, we implement a simplified form of the logic in
27               TeX::AutoTeX and particularly arXiv::FileGuess
28
29       "@packed_documents = pack_collection(collection=>\@documents,
30       whatsout=>'math|fragment|archive', siteDirectory=>$path);"
31           Packs a collection of documents using the packing method specified
32           via the 'whatsout' option.
33               If 'fragment' or 'math' are chosen, each input document is
34           transformed into
35               an embeddable fragment or a single formula, respectively.
36               If 'archive' is chose, all input documents are written into an
37           archive in the specified 'siteDirectory'.
38               The name of the archive is provided by the 'destination'
39           property of the first provided $document object.
40               Each document is expected to be a LaTeXML::Post::Document
41           object.
42

AUTHOR

44       Bruce Miller <bruce.miller@nist.gov>, Deyan Ginev
45       <deyan.ginev@nist.gov>
46

48       Public domain software, produced as part of work done by the United
49       States Government & not subject to copyright in the US.
50
51
52
53perl v5.36.0                      2022-07-20            LaTeXML::Util::Pack(3)
Impressum