:splint classname Stenciller::Plugin::ToUnparsedText

SYNOPSIS

use Stenciller;
my $stenciller = Stenciller->new(filepath => 't/corpus/test-1.stencil');
my $content = $stenciller->transform('ToUnparsedText');

DESCRIPTION

This plugin to Stenciller basically returns all text content of the stencils.

METHODS

:splint method transform

The currently available keys in the $transform_args hash ref is:

skip_header_lines => 1

skip_header_lines takes a boolean indicating if the Stenciller's header_lines should be skipped. Default is 0.

stencils => [ ]

stencils takes an array reference of which stencils in the currently parsed file that should be included in the output. The index is zero based.

If this plugin is used via Pod::Elemental::Transformer::Stenciller it could be used like this in pod:

=pod

# includes header_lines and all stencils
:stenciller ToUnparsedText atestfile-1.stencil

# includes header_lines and all stencils
:stenciller ToUnparsedText atestfile-1.stencil { }

# includes only the first stencil in the file
:stenciller ToUnparsedText atestfile-1.stencil { stencils => [0], skip_header_lines => 1 }

# includes only the header_lines
:stenciller ToUnparsedText atestfile-1.stencil { stencils => [] }