App-Pods2Site

 view release on metacpan or  search on metacpan

README.md  view on Meta::CPAN

# App::Pods2Site 1.003

This module provides a command to easily create a simple HTML site from pods, by
default the core docs, scripts, pragmas and other modules in the Perl distro
it is installed in, but it can also handle everything reachable through @INC and/or
arbitrary trees. If necessary, the set of pods can be trimmed based on queries.
Once a site has been constructed, it can be efficiently updated with new module installs
by running the command again.

It is inspired by the 'ap-update-html' command provided with an ActivePerl implementation.

### INSTALLATION

To install this module, run the following commands:

	perl Makefile.PL
	make

lib/App/Pods2Site.pm  view on Meta::CPAN

	print "Generating HTML from pods\n" if $args->isVerboseLevel(0);
	my $pod2html = App::Pods2Site::Pod2HTML->new($args, $podCopier->getPodRoot(), $podCopier->getWorkGroups());

	print "Generated ", $pod2html->getGenerated(), " documents (", $pod2html->getUptodate(), " up to date)\n" if $args->isVerboseLevel(0);

	$sitebuilder->makeSite($args, $podCopier->getWorkGroups(), $partCounts, $mainpage);

	$args->finish();
	
	my $style = $args->getStyle();
	my $updatedOrCreated = $args->getUpdating() ? 'updated' : 'created';
	print "Site $updatedOrCreated in '$siteDir' using style '$style'.\n" if $args->isVerboseLevel(0);

	chdir($cwd);
	
	return 0;
}

1;

lib/App/Pods2Site.pod  view on Meta::CPAN

This package is an application, generally intended to be run from a command line.

It was inspired by the HTML documentation present in an ActivePerl installation, and which was
updatable by using the 'ap-update-html' application after new modules had been installed.

As I also use other Perl distributions on both Windows and Linux, I felt the need to have a simple way
to generate something similar anywhere. Hence, this tool which generates a no-frills site similarly looking.

In short, this application will by default create a simple site based on all pods found in the distribution it's installed
in. As modules are updated/installed in the distribution, the application can be run again and efficiently update
the documentation site.

However, it also allows you to search arbitrary locations for pods, as well as cherrypick among the found pods and
skip ones of no interest to you.

=head1 FUNCTION

The overall function is simple:

Use the L<Config> module in the running Perl to find all pods, convert them using L<Pod::Html> and lastly, generate an index page

lib/App/Pods2Site/Args.pod  view on Meta::CPAN

=item * :std

All of the above in the order: :std-core, :std-scripts, :std-pragmas, :std-modules.

=back

=back

=item B<sitedirectory> or B<:std>

This is where the site should be created or updated. If the path doesn't exist, the full site will be created.

If the path exists, it must contain a site created by this tool, and will then be updated efficiently
(e.g. only new/updated pods will be written as necessary).
In this case however, the listed L<"Sticky options"> above are not allowed on the command line.
Instead they will be read from the site and reused as they were when the site was created.

Use C<:std> for the sitedir 'pods2site' inside the Perl tree (will only work if you have write permissions
there).
 
=back

=head1 MORE HELP