Renee Baecker > EPublisher-1.2 > EPublisher::Source::Plugin::Dir

Download:
EPublisher-1.2.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 1   Source  

NAME ^

EPublisher::Source::Plugin::Dir - Dir source plugin

VERSION ^

version 1.2

SYNOPSIS ^

  my $source_options = { type => 'Dir', path => '/var/lib/' };
  my $file_source    = EPublisher::Source->new( $source_options );
  my $pod            = $File_source->load_source;

METHODS ^

load_source

  my $pod = $file_source->load_source;

checks all pod/pm/pl files in the given directory (and its subdirectories) and returns information about those files:

  (
      {
          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.

COPYRIGHT & LICENSE ^

Copyright 2010 - 2012 Renee Baecker, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the terms of Artistic License 2.0.

AUTHOR ^

Renee Baecker (<module@renee-baecker.de>)

AUTHOR ^

Renee Baecker <module@renee-baecker.de>

COPYRIGHT AND LICENSE ^

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

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)
syntax highlighting: