Renee Baecker > EPublisher-1 > EPublisher::Source::Base

Download:
EPublisher-1.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.02   Source   Latest Release: EPublisher-1.2

NAME ^

EPublisher::Source::Base - Base class for Source plugins

VERSION ^

version 1

SYNOPSIS ^

  package EPublisher::Source::Plugin::AnyVCS;
  use  EPublisher::Source::Base;
  
  our @ISA = qw(EPublisher::Source::Base);
  
  # ... more code ...

METHODS ^

new

publisher

_config

HOW TO WRITE YOUR OWN SOURCE PLUGIN ^

It's fairly simple to write your own plugin. Basically it has to inherit from this module and it has to provide the methods new and load_source.

new has to return an object and load_source has to return a list of hashreferences where each reference should look like

  {
      pod => $pod_as_string,
      filename => $filename_of_documentation,
      title    => $a_title_for_documentation,
  }

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 same 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: