Update of /cvsroot/openinteract/OpenInteract2/pkg/system_doc/OpenInteract2/App
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv27523/system_doc/OpenInteract2/App
Added Files:
SystemDoc.pm
Log Message:
OIN-72: move docs to ::App class and remove package doc display functionality
--- NEW FILE: SystemDoc.pm ---
package OpenInteract2::App::SystemDoc;
use strict;
use base qw( Exporter OpenInteract2::App );
use OpenInteract2::Manage;
$OpenInteract2::App::SystemDoc::VERSION = sprintf("%d.%02d", q$Revision: 1.1 $ =~ /(\d+)\.(\d+)/);
@OpenInteract2::App::SystemDoc::EXPORT = qw( install );
sub get_brick_name {
return 'system_doc';
}
# Not a method, just an exported sub
sub install {
my ( $website_dir ) = @_;
my $manage = OpenInteract2::Manage->new( 'install_package' );
$manage->param( website_dir => $website_dir );
$manage->param( package_class => __PACKAGE__ );
return $manage->execute;
}
__END__
=pod
=head1 NAME
OpenInteract2::App::SystemDoc - Package for browsing OpenInteract, SPOPS and Perl module documentation
=head1 SYNOPSIS
http://www.mysite.com/SystemDoc/
=head1 DESCRIPTION
This module displays System Documentation, including:
=over 4
=item *
the HTML pages forming the distribution documentation
=item *
documentation from the individual packages' C<doc/> directories.
=item *
the OpenInteract and SPOPS manpages
=back
Just go to C<SystemDoc> on your website -- that will explain much
better.
=head1 AUTHORS
Chris Winters E<lt>ch...@cw...E<gt>
=cut
|
