Subversion Repositories DevTools

########################################################################
# COPYRIGHT - VIX IP PTY LTD ("VIX"). ALL RIGHTS RESERVED.
#
# Module name   : test_pod_html.pl
# Module type   : Makefile system
# Compiler(s)   : Perl
# Environment(s): jats
#
# Description   :
#
# Usage:
#
# Version   Who      Date        Description
#
#......................................................................#

require 5.008_002;
use strict;
use warnings;

use Pod::Usage;
use Getopt::Long;

use JatsError;
use FileUtils;
use JatsCopy;
InitFileUtils();

my $opt_root = $ENV{'GBE_CORE'};
my $opt_package = $opt_root . '/pkg/core_devl';
my $opt_interface = $opt_root . '/interface';
my $opt_verbose = $ENV{GBE_VERBOSE} || '0';
my $opt_force = '1';

use FileUtils;
use JatsCopy;

Message ("Root: $opt_root");
if ( $opt_force >= 0 )
{
    Message "Copy in Basic HTML - will clobber existing WEB Page Base";
    for my $dir (qw(HTML))
    {
        Message "Copy in: $dir";
        CopyDir ( "$opt_root/$dir", $opt_package,
                    'IgnoreDirs' => ['LOCAL', 'JatsDocTools'],
                    'KeepSrcTail' => 1);
    }

    #Message "Copy in this test page";
    #CopyFile ('test_pod_html.pl', "$opt_root/TOOLS" );
    TouchFile ("$opt_root/TOOLS/LOCAL/test_pod_html.pl");
}
#
#   Generate the HTML documenation from the POD
#   Generate the HTML TOc
#
Message ("Generate HTML documentation" );
use JatsDocTools::JatsDocTools;
JatsDocTools::UpdateHTML( 
                          'force' => $opt_force,
                          'verbose' => $opt_verbose,
                          'htmldir' => FullPath("$opt_package/HTML"),
                          #'prefix' => FullPath($opt_package),
                          'prefix' => FullPath($opt_root),
                          'cacheDir' => FullPath($opt_interface),
                          'ChangeLog' => FullPath("$opt_root/ChangeLog.txt"),
                          'index' => 1,
                          );
Message ("Path", FullPath($opt_root) );

=pod

=for htmltoc    GENERAL::Test::A Nice Name7::A Nice Name

=head1 NAME

pod_hmtl - POD to HTML Test Page

=head1 SYNOPSIS

  jats pod test page [options]

 Options:
    -help[=n]           - brief help message
    -help -help         - Detailed help message

=head1 OPTIONS

=over 8

=item B<-help[=n]>

Print a brief help message and exits.

The verbosity of the help text can be controlled by setting the help level to a
number in the range of 1 to 3, or by invoking the option multiple times.

=back

=head1 DESCRIPTION

This utility is used by the automated build system to create a workspace
for the view. The main function of this utility is to invoke the correct
utility for the creation of a workspace.

The utility will examine the -label option and detect the required Version
Control System. It will then invoke a suitable tools to create the workspace.

=for htmlclass Note

NOTE: This is a note. It can only be in one paragraph and it will not allow
other stuff within it.

Some Text.

=for htmlclass Warning

WARNING: This is a note. It can only be in one paragraph and it will not allow
other stuff within it.

Some text

=for htmlclass Tip

Tip: This is a note. It can only be in one paragraph and it will not allow
other stuff within it.

=for htmlclass Tip

Tip: This is a note. It can only be in one paragraph and it will not allow
other stuff within it.

The label must start with a Version Control Header. This is of the form of:

    XXX::Data

Where XXX identifies the Version Control System. Valid values are:

=over 4

=item   1 This is numbered

Body of the first item

Another para within the item

=item   2 This is numbered

Body of the 2nd item

Another para within the item

=back

Back to body level

=over 4

=item   * This is bulleted

=item   * This is bulleted

=back

=over 4

=item   3 This is numbered

=item   4 This is numbered

=back

Back to body level

=over 4

=item   1

This is numbered - body on a seperate line

Another para within the item

=item   2

This is numbered - body on a seperate line

Another para within the item

=back

Back to body level

=over 4

=item   *

This is bulleted - body on a seperate line

=item   *

This is bulleted - body on a seperate line

=back

Back to body level

Bulleted items, with  a numbered sub-indent

=over 8

=item   *

This is bulleted - body on a seperate line

=item   *

This is bulleted - body on a seperate line

=over 4

=item   1

This is numbered - body on a seperate line

=item   2

This is numbered - body on a seperate line

=back

Back to FIRST level of indentation

=item *

Continue with the bullet list

=back

Back to body level

Test of C<sandbox_archive> will this do good stuff. Also see C<Environment
variables>. What about C<Environment variables> and C<sandbox_archive>.
Also C<Environment variables>

=cut