The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Text-Amuse-Compile-0.13
River stage zero No dependents
1 ++
/ Text::Amuse::Compile

NAME

Text::Amuse::Compile - Compiler for Text::Amuse

VERSION

Version 0.13

SYNOPSIS

    use Text::Amuse::Compile;
    my $compiler = Text::Amuse::Compile->new;
    $compiler->compile($file1, $file2, $file3)

METHODS/ACCESSORS

CONSTRUCTOR

new(ttdir => '.', pdf => 1, ...);

Constructor. It will accept the following options

Format options (by default all of them are activated);

cleanup

Remove auxiliary files after compilation (.status, .ok)

tex

LaTeX output

pdf

Plain PDF without any imposition

a4_pdf

PDF imposed on A4 paper

lt_pdf

PDF imposed on Letter paper

html

Full HTML output

epub

The EPUB

bare_html

The bare HTML, non <head>

zip

The zipped sources

extra

An hashref of key/value pairs to pass to each template in the options namespace.

Template directory:

ttdir

The directory where to look for templates, named as format.tt

You can retrieve the value by calling them on the object.

METHODS

templates

The Text::Amuse::Compile::Templates object, which will provide the templates string references.

version

Report version information

logger

Subroutine reference for logging.

recursive_compile($directory)

Compile recursive a directory, comparing the timestamps of the status file with the muse file. If the status file is newer, the file is ignored.

Return a list of absolute path to the files processed. To infer the success or the failure of each file look at the status file or at the logs.

find_muse_files($directory)

Return a sorted list of files with extension .muse excluding illegal names (including hidden files) and directories.

find_new_muse_files($directory)

As above, but check the age of the status file and skip already processed files.

compile($file1, $file2, ...);

Main method to get the job done, passing the list of muse files. You can inspect the errors calling errors. It does produce some output.

The file may also be an hash reference. In this case, the compile will act on a list of files and will merge them. Beware that so far only the pdf and tex options will work, while the other html methods will throw exceptions or (worse probably) produce empty files. This will be fixed soon. This feature is marked as experimental and could change in the future.

virtual file hashref

The hash reference should have those mandatory fields:

files

An arrayref of filenames without extension.

path

A mandatory directory where to find the above files.

Optional keys

name

Default to virtual. This is the basename of the files which will be produced. It's up to you to provide a sensible name we don't do any check on that.

suffix

Defaults to '.muse' and you have no reason to change this.

Every other key is the metadata of the new document, so usually you want to set title and optionally author.

Example:

  $c->compile({
               # mandatory
               path  => File::Spec->catdir(qw/t merged-dir/),
               files => [qw/first second/],

               # recommended
               name  => 'my-new-test',
               title => 'My new shiny test',

               # optional
               subtitle => 'Another one',
               date => 'Today!',
               source => 'Text::Amuse::Compile',
              });

You can pass as many hashref you want.

report_failure($message1, $message2, ...)

This method is called when the compilation of a file raises an exception, so it's for internal usage.

It passes the arguments along to report_failure_sub as a list if you set that to a sub, otherwise it prints to the standard error.

report_failure_sub(sub { my @problems = @_ ; print @problems });

You can set the sub to be used to report problems using this accessor, which is supposed to receive the list of messages.

errors

Accessor to the catched errors. It returns a list of strings.

add_errors($error1, $error2,...)

Add an error. [Internal]

reset_errors

Reset the errors

AUTHOR

Marco Pessotto, <melmothx at gmail.com>

BUGS

Please mail the author and provide a minimal example to add to the test suite.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Text::Amuse::Compile

LICENSE

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.