NAME

Pod::Elemental::Transformer::Stenciller - Injects content from textfiles transformed with Stenciller

VERSION

Version 0.0101, released 2015-02-13.

SYNOPSIS

# in weaver.ini
[-Transformer / Stenciller]
transformer = Stenciller
directory = path/to/stencildir

DESCRIPTION

This transformer uses a special command in pod files to inject content from elsewhere via a Stenciller transformer plugin.

Example

1. Start with the weaver.ini from the "synopsis".

2. Add a textfile, in path/to/stencildir/file-with-stencils.stencil:

== stencil { } ==

Header text

--input--

    Input text

--end input--

Between text

--output--

    Output text

--end output--

Footer text

3. Add a Perl module:

package A::Test::Module;

1;

__END__

=pod

=head1 NAME

=head1 DESCRIPTION

:stenciller ToUnparsedText file-with-stencils.stencil

The last line in the Perl module will cause the textfile to be parsed with Stenciller, and then transformed using the Stenciller::Plugin::ToUnparsedText plugin.

It would be rendered like this (between begin and end):

begin

Header text

Input text

Between text

Output text

Footer text

end

Pod hash

It is possible to filter stencils by index with an optional hash in the module:

:stenciller ToUnparsedText 1-test.stencil { stencils => [0, 2..4] }

This will only include the stencils with index 0, 2, 3 and 4 from 1-test.stencil.

Stencil hash

This module checks for the to_pod key in the stencil hash. If it is true (or doesn't exist) it is included in the transformation.

However, any stencil excluded by the "Pod hash" is already disregarded. It is probably least confusing to choose one of these places to do all filtering.

ATTRIBUTES

directory

Dir

required

read-only

Path to directory where the stencil files are.

SEE ALSO

• Stenciller

• Stenciller::Plugin::ToUnparsedText

• Pod::Weaver

SOURCE

https://github.com/Csson/p5-Pod-Elemental-Transformer-Stenciller

HOMEPAGE

https://metacpan.org/release/Pod-Elemental-Transformer-Stenciller

AUTHOR

Erik Carlsson <info@code301.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2015 by Erik Carlsson <info@code301.com>.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

cpanm Pod::Elemental::Transformer::Stenciller

perl -MCPAN -e shell
install Pod::Elemental::Transformer::Stenciller