The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

DARNOLD / Pod-Classdoc-1.01 / bin / mkprojdocs 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
—
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

              
#!perl
use Getopt::Long qw(:config no_ignore_case);
use Pod::Usage;
use Pod::Classdoc::Project qw(renderProject);
use Cwd;
use strict;
use warnings;
our $VERSION = '1.01';
my ($help, $out, $lib, $title, $lang, $desc, $charset, $index, $verbose, $forcegen, $nosrc);
my ($nocomments, $noexpand, $noimports, $jspath, $lines, $openimg, $imgpath, $nopod, 
                $rootimg, $csspath, $closeimg, $noicons, $notree, $download, $additions, $noheredocs,
                $order);
my @sources = ();
my %opt = (
    'additions|a=s' => \$additions,
        'nocomments|C'  => \$nocomments,
    'charset|c=s' => \$charset,
    'desc|d=s'    => \$desc,
    'download|D=s' => \$download,
    'noexpand|e'  => \$noexpand,
    'forcegen!'   => \$forcegen,
    'help|h'      => \$help,
    'noheredoc|H'   => \$noheredocs,
    'noimports|I' => \$noimports,
    'imgpath|i=s' => \$imgpath,
    'jspath|j=s'    => \$jspath,
    'lang|L=s'      => \$lang,
    'lib|l=s'    => sub { push @sources, $_[1]; },
    'lines|N=i'   => \$lines,
    'nosrc|n'     => \$nosrc,
    'openimg|O=s' => \$openimg,
    'output|out|o=s'     => \$out,
    'nopod|p'     => \$nopod,
    'rootimg|r=s' => \$rootimg,
    'css|s=s'     => \$csspath,
    'title|t=s'   => \$title,
    'verbose|v'   => \$verbose,
    'closeimg|x=s' => \$closeimg,
    'order|y=s'   => \$order,
    'noicons|z'   => \$noicons,
);
GetOptions(%opt);
pod2usage(1) if $help;
my @order = $order ? split(/\s*,\s*/, $order) : ();
$| = 1 if $verbose;
renderProject(
        Additions       => $additions,
    Charset             => $charset,
    CloseImage  => $closeimg,
        Comments        => !$nocomments,
    Description => $desc,
    Download    => $download,
    Expandable  => !$noexpand,
    Force               => $forcegen,
    Heredoc     => !$noheredocs,
    Imports             => !$noimports,
    IconPath    => $imgpath,
    JSPath              => $jspath,
    Language    => $lang,
    Libs                => \@sources,
    MinLines    => $lines,
    NoIcons             => $noicons,
    NoSource    => $nosrc,
    OpenImage   => $openimg,
    Order               => \@order,
    Output              => $out,
    POD                 => !$nopod,
    RootImage   => $rootimg,
    CSSPath             => $csspath,
    Title               => $title,
    Verbose             => $verbose,
        );
=pod
=head1 NAME
mkprojdocs
=head1 SYNOPSIS
mkprojdocs [options]
 Options:
    -a|-additions <filename>  additional HTML lists to include in TOC
    -C|-nocomments            disable comment folding in source; 
                                  default enabled
    -c|-charset <string>      set character set meta tag in html;
                                  default 'UTF-8'
    -d|-desc <string>         project description
    -D|-download <filename>   path to a download file for project
    -e|-noexpand              disable expandable source folds;
                                   default enabled
    -f|-forcegen                  force regeneration
    -h|-help                  display this help and exit
    -H|-noheredoc             disable heredoc folding (default enabled)
    -I|-noimports             disable imports folding (default enabled)
    -i|-imgpath <path>        path to icon image directory; default 'img'
    -j|-jspath <path>         path to Javascript files; default 'js'
    -l|-lib <path>            project library-root-directory path
    -L|-lang <language>       language for xml:lang. default 'en'
    -N|-lines <number>        minimum consecutive foldable lines req'd 
                                  for fold (default 4)
    -n|-nosrc                 skip PPI::HTML::CodeFolder generation
    -O|-openimg <filename>    image file used for HTML::ListToTree open 
                                  nodes; default 'openbook.gif'
    -o|-out|-output <path>    target directory path for generated documents
    -p|-nopod                 disable POD folding (default enabled)
    -r|-rootimg <filename>    image file used for root of TOC tree; 
                                 default 'globe.gif'
    -s|-css <path>            path to CSS files; default 'css'
    -t|-title <title>         project title
    -v|-verbose               enable diagnostic messages
    -x|-closeimg <filename>   image file used for closed TOC nodes;
                                 default 'closedbook.gif'
    -y|-order "<pkglist>"   specify order of packages in TOC; 
                                 <pkglist> is comma separated list of 
                                 names, e.g.,
                                 "DBI,DBD::_::dr,DBD::_::db,DBD::_::st"
    -z|-noicons               no icons in tree widget; default is icons on
Multiple library-directories cna be specified:
  mkprojdocs -o /path/to/outputdir -l /path/to/lib1 -l /path/to/lib2
=head1 DESCRIPTION
Generates merged L<Pod::ProjectDocs> (for POD), L<Pod::Classdoc> (for classdocs), and 
L<PPI::HTML::CodeFolder> (for source code) output with a Javascript navigation
tree widget generated via L<HTML::ListToTree>.
=cut