Subversion Repositories DevTools

Rev

Rev 5709 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
392 dpurdie 1
########################################################################
6177 dpurdie 2
# COPYRIGHT - VIX IP PTY LTD ("VIX"). ALL RIGHTS RESERVED.
392 dpurdie 3
#
4
# Module name   : test_pod_html.pl
5
# Module type   : Makefile system
6
# Compiler(s)   : Perl
7
# Environment(s): jats
8
#
9
# Description   :
10
#
11
# Usage:
12
#
13
# Version   Who      Date        Description
14
#
15
#......................................................................#
16
 
17
require 5.008_002;
18
use strict;
19
use warnings;
20
 
21
use Pod::Usage;
22
use Getopt::Long;
23
 
24
use JatsError;
25
use FileUtils;
26
use JatsCopy;
27
InitFileUtils();
28
 
1272 dpurdie 29
my $opt_root = $ENV{'GBE_CORE'};
30
my $opt_package = $opt_root . '/pkg/core_devl';
31
my $opt_interface = $opt_root . '/interface';
4386 dpurdie 32
my $opt_verbose = $ENV{GBE_VERBOSE} || '0';
392 dpurdie 33
my $opt_force = '1';
34
 
35
use FileUtils;
36
use JatsCopy;
37
 
6177 dpurdie 38
Message ("Root: $opt_root");
392 dpurdie 39
if ( $opt_force >= 0 )
40
{
41
    Message "Copy in Basic HTML - will clobber existing WEB Page Base";
42
    for my $dir (qw(HTML))
43
    {
44
        Message "Copy in: $dir";
45
        CopyDir ( "$opt_root/$dir", $opt_package,
46
                    'IgnoreDirs' => ['LOCAL', 'JatsDocTools'],
47
                    'KeepSrcTail' => 1);
48
    }
49
 
50
    #Message "Copy in this test page";
51
    #CopyFile ('test_pod_html.pl', "$opt_root/TOOLS" );
52
    TouchFile ("$opt_root/TOOLS/LOCAL/test_pod_html.pl");
53
}
54
#
55
#   Generate the HTML documenation from the POD
56
#   Generate the HTML TOc
57
#
58
Message ("Generate HTML documentation" );
59
use JatsDocTools::JatsDocTools;
6177 dpurdie 60
JatsDocTools::UpdateHTML( 
61
                          'force' => $opt_force,
392 dpurdie 62
                          'verbose' => $opt_verbose,
63
                          'htmldir' => FullPath("$opt_package/HTML"),
6177 dpurdie 64
                          #'prefix' => FullPath($opt_package),
1272 dpurdie 65
                          'prefix' => FullPath($opt_root),
392 dpurdie 66
                          'cacheDir' => FullPath($opt_interface),
67
                          'ChangeLog' => FullPath("$opt_root/ChangeLog.txt"),
68
                          'index' => 1,
69
                          );
1272 dpurdie 70
Message ("Path", FullPath($opt_root) );
392 dpurdie 71
 
72
=pod
73
 
74
=for htmltoc    GENERAL::Test::A Nice Name7::A Nice Name
75
 
76
=head1 NAME
77
 
78
pod_hmtl - POD to HTML Test Page
79
 
80
=head1 SYNOPSIS
81
 
82
  jats pod test page [options]
83
 
84
 Options:
85
    -help[=n]           - brief help message
86
    -help -help         - Detailed help message
87
 
88
=head1 OPTIONS
89
 
90
=over 8
91
 
92
=item B<-help[=n]>
93
 
94
Print a brief help message and exits.
95
 
96
The verbosity of the help text can be controlled by setting the help level to a
97
number in the range of 1 to 3, or by invoking the option multiple times.
98
 
99
=back
100
 
101
=head1 DESCRIPTION
102
 
103
This utility is used by the automated build system to create a workspace
104
for the view. The main function of this utility is to invoke the correct
105
utility for the creation of a workspace.
106
 
107
The utility will examine the -label option and detect the required Version
108
Control System. It will then invoke a suitable tools to create the workspace.
109
 
110
=for htmlclass Note
111
 
112
NOTE: This is a note. It can only be in one paragraph and it will not allow
113
other stuff within it.
114
 
115
Some Text.
116
 
117
=for htmlclass Warning
118
 
119
WARNING: This is a note. It can only be in one paragraph and it will not allow
120
other stuff within it.
121
 
122
Some text
123
 
124
=for htmlclass Tip
125
 
126
Tip: This is a note. It can only be in one paragraph and it will not allow
127
other stuff within it.
128
 
129
=for htmlclass Tip
130
 
131
Tip: This is a note. It can only be in one paragraph and it will not allow
132
other stuff within it.
133
 
134
The label must start with a Version Control Header. This is of the form of:
135
 
136
    XXX::Data
137
 
138
Where XXX identifies the Version Control System. Valid values are:
139
 
140
=over 4
141
 
142
=item   1 This is numbered
143
 
144
Body of the first item
145
 
146
Another para within the item
147
 
148
=item   2 This is numbered
149
 
150
Body of the 2nd item
151
 
152
Another para within the item
153
 
154
=back
155
 
156
Back to body level
157
 
158
=over 4
159
 
160
=item   * This is bulleted
161
 
162
=item   * This is bulleted
163
 
164
=back
165
 
166
=over 4
167
 
168
=item   3 This is numbered
169
 
170
=item   4 This is numbered
171
 
172
=back
173
 
174
Back to body level
175
 
176
=over 4
177
 
178
=item   1
179
 
180
This is numbered - body on a seperate line
181
 
182
Another para within the item
183
 
184
=item   2
185
 
186
This is numbered - body on a seperate line
187
 
188
Another para within the item
189
 
190
=back
191
 
192
Back to body level
193
 
194
=over 4
195
 
196
=item   *
197
 
198
This is bulleted - body on a seperate line
199
 
200
=item   *
201
 
202
This is bulleted - body on a seperate line
203
 
204
=back
205
 
206
Back to body level
207
 
208
Bulleted items, with  a numbered sub-indent
209
 
210
=over 8
211
 
212
=item   *
213
 
214
This is bulleted - body on a seperate line
215
 
216
=item   *
217
 
218
This is bulleted - body on a seperate line
219
 
220
=over 4
221
 
222
=item   1
223
 
224
This is numbered - body on a seperate line
225
 
226
=item   2
227
 
228
This is numbered - body on a seperate line
229
 
230
=back
231
 
232
Back to FIRST level of indentation
233
 
234
=item *
235
 
236
Continue with the bullet list
237
 
238
=back
239
 
240
Back to body level
241
 
242
Test of C<sandbox_archive> will this do good stuff. Also see C<Environment
243
variables>. What about C<Environment variables> and C<sandbox_archive>.
244
Also C<Environment variables>
245
 
246
=cut
247