Text::Amuse::Compile::File - Object for file scheduled for compilation
Everything here is pretty much private. It's used by Text::Amuse::Compile in a forked and chdir'ed environment.
Constructor. Accepts the following named parameters:
If it's a virtual file which doesn't exit on the disk (a merged one)
The directory with the custom templates.
An optional Text::Amuse::Compile::FileName object (for partials)
When set to true, the tex output will obey bcor and twoside/oneside.
An hashref with the options to pass to the templates.
Include paths arrayref.
Run timeout for latex/xindy run in seconds, default to 600 (which should be plenty).
The Text::Amuse object
The Template::Tiny object
The logger subroutine set in the constructor.
Remove auxiliary files (like the complete file and the status file)
Use luatex instead of xetex
The Text::Amuse::Compile::Fonts::Selected object (required).
Boolean (default to true) which triggers the epub font embedding.
Boolean (default to false). Activates the conditional article output.
The raw, unparsed indexes found in the muse comments
If present, the parsed indexes are stored here
See Text::Amuse::Compile::TemplateOptions for the explanation.
Remove all the output files related to basename
Remove all the files produces by the slides call, i.e. file.sl.pdf and file.sl.log and all the leftovers (.sl.toc, .sl.aux, etc.).
slides
Remove files left by previous latex compilation, i.e. file.pdf and file.log and all the leftovers (toc, aux, etc.).
Remove the latex leftover files (toc, aux, etc.).
Remove the latex leftover files (.sl.toc, .sl.aux, etc.).
Remove the files associated with this file, by extension.
Emit the respective format, saving it in a file. Return value is meaningless, but exceptions could be raised.
The zipped sources. Beware that if you don't call html or tex before this, the attachments (if any) are ignored if both html and tex files exist. Hence, the muse-compile.pl scripts forces the --tex and --html switches.
This method is a bit tricky, because it's called with arguments internally by lt_pdf and a4_pdf, and with no arguments before pdf.
lt_pdf
a4_pdf
pdf
With no arguments, this method enforces the options twoside=true and bcor=0mm, effectively ignoring the global options which affect the imposed output, unless standalone is set to true.
twoside=true
bcor=0mm
standalone
This means that the twoside and binding correction options follow this logic: if you have some imposed format, they are ignored for the standalone PDF but applied for the imposed ones. If you have only the standalone PDF, they are applied to it.
Produce a file with extension .sl.tex, a LaTeX Beamer source file. If the source muse file doesn't require slides, do nothing.
.sl.tex
Compiles the file produced by sl_tex (if any) and generate the slides with extension .sl.pdf
sl_tex
.sl.pdf
While the logger accessor holds a reference to a sub, but could be very well be empty, the object uses these two methods:
logger
If logger exists, it will call it passing the strings as arguments. Otherwise print to the standard output.
Calls log_info, remove the lock and dies.
log_info
(Internal) Parse the produced logfile for missing characters.
Set from AMW_DEBUG environment.
To install Text::Amuse::Compile, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Text::Amuse::Compile
CPAN shell
perl -MCPAN -e shell install Text::Amuse::Compile
For more information on module installation, please visit the detailed CPAN module installation guide.