The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
EPublisher-1.27
River stage one • 4 direct dependents • 4 total dependents
/ EPublisher::Source::Plugin::File

NAME

EPublisher::Source::Plugin::File - File source plugin

VERSION

version 1.27

SYNOPSIS

my $source_options = { type => 'File', path => '/var/lib/CGI.pm' };
my $file_source    = EPublisher::Source->new( $source_options );
my $info           = $File_source->load_source;

my $options = { type => 'File', path => '/path.pod', title => 'pod' };
my $file_source = EPublisher::Source->new( $options );
my $info = $file_source->load_source;

METHODS

load_source

my $pod = $file_source->load_source;

reads the File and returns a hashreference with several information about the document.

{
  pod      => $pod_document,
  filename => $file,
  title    => $title,
}

$pod_document is the complete pod documentation that was found in the file. $file is the name of the file (without path) and $title is the title of the pod documentation. By default it is the filename, but you can say "title => 'pod'" in the configuration. The title is the first value for =head1 in the pod.

AUTHOR

Renee Baecker <module@renee-baecker.de>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2015 by Renee Baecker.

This is free software, licensed under:

The Artistic License 2.0 (GPL Compatible)