Edit D:\app\Administrator\product\11.2.0\dbhome_1\perl\html\lib\Pod\Simple\HTMLBatch.html
<?xml version="1.0" ?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>Pod::Simple::HTMLBatch - convert several Pod files to several HTML files</title> <meta http-equiv="content-type" content="text/html; charset=utf-8" /> <link rev="made" href="mailto:" /> </head> <body style="background-color: white"> <table border="0" width="100%" cellspacing="0" cellpadding="3"> <tr><td class="block" style="background-color: #cccccc" valign="middle"> <big><strong><span class="block"> Pod::Simple::HTMLBatch - convert several Pod files to several HTML files</span></strong></big> </td></tr> </table> <!-- INDEX BEGIN --> <div name="index"> <p><a name="__index__"></a></p> <ul> <li><a href="#name">NAME</a></li> <li><a href="#synopsis">SYNOPSIS</a></li> <li><a href="#description">DESCRIPTION</a></li> <ul> <li><a href="#from_the_command_line">FROM THE COMMAND LINE</a></li> </ul> <li><a href="#main_methods">MAIN METHODS</a></li> <ul> <li><a href="#accessor_methods">ACCESSOR METHODS</a></li> </ul> <li><a href="#notes_on_customization">NOTES ON CUSTOMIZATION</a></li> <li><a href="#ask_me_">ASK ME!</a></li> <li><a href="#see_also">SEE ALSO</a></li> <li><a href="#copyright_and_disclaimers">COPYRIGHT AND DISCLAIMERS</a></li> <li><a href="#author">AUTHOR</a></li> </ul> <hr name="index" /> </div> <!-- INDEX END --> <p> </p> <h1><a name="name">NAME</a></h1> <p>Pod::Simple::HTMLBatch - convert several Pod files to several HTML files</p> <p> </p> <hr /> <h1><a name="synopsis">SYNOPSIS</a></h1> <pre> perl -MPod::Simple::HTMLBatch -e 'Pod::Simple::HTMLBatch::go' in out</pre> <p> </p> <hr /> <h1><a name="description">DESCRIPTION</a></h1> <p>This module is used for running batch-conversions of a lot of HTML documents</p> <p>This class is NOT a subclass of Pod::Simple::HTML (nor of bad old Pod::Html) -- although it uses Pod::Simple::HTML for doing the conversion of each document.</p> <p>The normal use of this class is like so:</p> <pre> use Pod::Simple::HTMLBatch; my $batchconv = Pod::Simple::HTMLBatch->new; $batchconv->some_option( some_value ); $batchconv->some_other_option( some_other_value ); $batchconv->batch_convert( \@search_dirs, $output_dir );</pre> <p> </p> <h2><a name="from_the_command_line">FROM THE COMMAND LINE</a></h2> <p>Note that this class also provides (but does not export) the function Pod::Simple::HTMLBatch::go. This is basically just a shortcut for <code>< Pod::Simple::HTMLBatch-</code><a href="#batch_convert"><code>batch_convert(@ARGV)</code></a> >>. It's meant to be handy for calling from the command line.</p> <p>However, the shortcut requires that you specify exactly two command-line arguments, <code>indirs</code> and <code>outdir</code>.</p> <p>Example:</p> <pre> % mkdir out_html % perl -MPod::Simple::HTMLBatch -e Pod::Simple::HTMLBatch::go @INC out_html (to convert the pod from Perl's @INC files under the directory ../htmlversion)</pre> <p>(Note that the command line there contains a literal atsign-I-N-C. This is handled as a special case by batch_convert, in order to save you having to enter the odd-looking "" as the first command-line parameter when you mean "just use whatever's in @INC".)</p> <p>Example:</p> <pre> % mkdir ../seekrut % chmod og-rx ../seekrut % perl -MPod::Simple::HTMLBatch -e Pod::Simple::HTMLBatch::go . ../htmlversion (to convert the pod under the current dir into HTML files under the directory ../htmlversion)</pre> <p>Example:</p> <pre> % perl -MPod::Simple::HTMLBatch -e Pod::Simple::HTMLBatch::go happydocs . (to convert all pod from happydocs into the current directory)</pre> <p> </p> <hr /> <h1><a name="main_methods">MAIN METHODS</a></h1> <dl> <dt><strong><a name="new" class="item">$batchconv = Pod::Simple::HTMLBatch->new;</a></strong> <dd> <p>This TODO</p> </dd> </li> <dt><strong><a name="batch_convert" class="item">$batchconv->batch_convert( <em>indirs</em>, <em>outdir</em> );</a></strong> <dd> <p>this TODO</p> </dd> </li> <dt><strong>$batchconv->batch_convert( undef , ...);</strong> <dt><strong>$batchconv->batch_convert( q{@INC}, ...);</strong> <dd> <p>These two values for <em>indirs</em> specify that the normal Perl @INC</p> </dd> </li> <dt><strong>$batchconv->batch_convert( \@dirs , ...);</strong> <dd> <p>This specifies that the input directories are the items in the arrayref <code>\@dirs</code>.</p> </dd> </li> <dt><strong>$batchconv->batch_convert( "somedir" , ...);</strong> <dd> <p>This specifies that the director "somedir" is the input. (This can be an absolute or relative path, it doesn't matter.)</p> </dd> <dd> <p>A common value you might want would be just "." for the current directory:</p> </dd> <dd> <pre> $batchconv->batch_convert( "." , ...);</pre> </dd> </li> <dt><strong>$batchconv->batch_convert( 'somedir:someother:also' , ...);</strong> <dd> <p>This specifies that you want the dirs "somedir", "somother", and "also" scanned, just as if you'd passed the arrayref <code>[qw( somedir someother also)]</code>. Note that a ":"-separator is normal under Unix, but Under MSWin, you'll need <code>'somedir;someother;also'</code> instead, since the pathsep on MSWin is ";" instead of ":". (And <em>that</em> is because ":" often comes up in paths, like <code>"c:/perl/lib"</code>.)</p> </dd> <dd> <p>(Exactly what separator character should be used, is gotten from <code>$Config::Config{'path_sep'}</code>, via the <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/lib/Config.html">the Config manpage</a> module.)</p> </dd> </li> <dt><strong>$batchconv->batch_convert( ... , undef );</strong> <dd> <p>This specifies that you want the HTML output to go into the current directory.</p> </dd> <dd> <p>(Note that a missing or undefined value means a different thing in the first slot than in the second. That's so that <a href="#batch_convert"><code>batch_convert()</code></a> with no arguments (or undef arguments) means "go from @INC, into the current directory.)</p> </dd> </li> <dt><strong>$batchconv->batch_convert( ... , 'somedir' );</strong> <dd> <p>This specifies that you want the HTML output to go into the directory 'somedir'. (This can be an absolute or relative path, it doesn't matter.)</p> </dd> </li> </dl> <p>Note that you can also call <a href="#batch_convert"><code>batch_convert</code></a> as a class method, like so:</p> <pre> Pod::Simple::HTMLBatch->batch_convert( ... );</pre> <p>That is just short for this:</p> <pre> Pod::Simple::HTMLBatch-> new-> batch_convert(...);</pre> <p>That is, it runs a conversion with default options, for whatever inputdirs and output dir you specify.</p> <p> </p> <h2><a name="accessor_methods">ACCESSOR METHODS</a></h2> <p>The following are all accessor methods -- that is, they don't do anything on their own, but just alter the contents of the conversion object, which comprises the options for this particular batch conversion.</p> <p>We show the "put" form of the accessors below (i.e., the syntax you use for setting the accessor to a specific value). But you can also call each method with no parameters to get its current value. For example, <a href="#contents_file"><code>$self->contents_file()</code></a> returns the current value of the contents_file attribute.</p> <dl> <dt><strong><a name="verbose" class="item">$batchconv->verbose( <em>nonnegative_integer</em> );</a></strong> <dd> <p>This controls how verbose to be during batch conversion, as far as notes to STDOUT (or whatever is <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/pod/perlfunc.html#select"><code>select</code></a>'d) about how the conversion is going. If 0, no progress information is printed. If 1 (the default value), some progress information is printed. Higher values print more information.</p> </dd> </li> <dt><strong><a name="index" class="item">$batchconv->index( <em>true-or-false</em> );</a></strong> <dd> <p>This controls whether or not each HTML page is liable to have a little table of contents at the top (which we call an "index" for historical reasons). This is true by default.</p> </dd> </li> <dt><strong><a name="contents_file" class="item">$batchconv->contents_file( <em>filename</em> );</a></strong> <dd> <p>If set, should be the name of a file (in the output directory) to write the HTML index to. The default value is "index.html". If you set this to a false value, no contents file will be written.</p> </dd> </li> <dt><strong><a name="contents_page_start" class="item">$batchconv->contents_page_start( <em>HTML_string</em> );</a></strong> <dd> <p>This specifies what string should be put at the beginning of the contents page. The default is a string more or less like this:</p> </dd> <dd> <pre> <html> <head><title>Perl Documentation</title></head> <body class='contentspage'> <h1>Perl Documentation</h1></pre> </dd> </li> <dt><strong><a name="contents_page_end" class="item">$batchconv->contents_page_end( <em>HTML_string</em> );</a></strong> <dd> <p>This specifies what string should be put at the end of the contents page. The default is a string more or less like this:</p> </dd> <dd> <pre> <p class='contentsfooty'>Generated by Pod::Simple::HTMLBatch v3.01 under Perl v5.008 <br >At Fri May 14 22:26:42 2004 GMT, which is Fri May 14 14:26:42 2004 local time.</p></pre> </dd> </li> <dt><strong><a name="add_css" class="item">$batchconv->add_css( $url );</a></strong> <dd> <p>TODO</p> </dd> </li> <dt><strong><a name="add_javascript" class="item">$batchconv->add_javascript( $url );</a></strong> <dd> <p>TODO</p> </dd> </li> <dt><strong><a name="css_flurry" class="item">$batchconv->css_flurry( <em>true-or-false</em> );</a></strong> <dd> <p>If true (the default value), we autogenerate some CSS files in the output directory, and set our HTML files to use those. TODO: continue</p> </dd> </li> <dt><strong><a name="javascript_flurry" class="item">$batchconv->javascript_flurry( <em>true-or-false</em> );</a></strong> <dd> <p>If true (the default value), we autogenerate a JavaScript in the output directory, and set our HTML files to use it. Currently, the JavaScript is used only to get the browser to remember what stylesheet it prefers. TODO: continue</p> </dd> </li> <dt><strong><a name="no_contents_links" class="item">$batchconv->no_contents_links( <em>true-or-false</em> );</a></strong> <dd> <p>TODO</p> </dd> </li> <dt><strong><a name="html_render_class" class="item">$batchconv->html_render_class( <em>classname</em> );</a></strong> <dd> <p>This sets what class is used for rendering the files. The default is "Pod::Simple::Search". If you set it to something else, it should probably be a subclass of Pod::Simple::Search, and you should <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/pod/perlfunc.html#require"><code>require</code></a> or <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/pod/perlfunc.html#use"><code>use</code></a> that class so that's it's loaded before Pod::Simple::HTMLBatch tries loading it.</p> </dd> </li> </dl> <p> </p> <hr /> <h1><a name="notes_on_customization">NOTES ON CUSTOMIZATION</a></h1> <p>TODO</p> <pre> call add_css($someurl) to add stylesheet as alternate call add_css($someurl,1) to add as primary stylesheet </pre> <pre> call add_javascript </pre> <pre> subclass Pod::Simple::HTML and set $batchconv->html_render_class to that classname and maybe override $page->batch_mode_page_object_init($self, $module, $infile, $outfile, $depth) or maybe override $batchconv->batch_mode_page_object_init($page, $module, $infile, $outfile, $depth) </pre> <p> </p> <hr /> <h1><a name="ask_me_">ASK ME!</a></h1> <p>If you want to do some kind of big pod-to-HTML version with some particular kind of option that you don't see how to achieve using this module, email me (<code>sburke@cpan.org</code>) and I'll probably have a good idea how to do it. For reasons of concision and energetic laziness, some methods and options in this module (and the dozen modules it depends on) are undocumented; but one of those undocumented bits might be just what you're looking for.</p> <p> </p> <hr /> <h1><a name="see_also">SEE ALSO</a></h1> <p><a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/lib/Pod/Simple.html">the Pod::Simple manpage</a>, <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/lib/Pod/Simple/HTMLBatch.html">the Pod::Simple::HTMLBatch manpage</a>, <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/pod/perlpod.html">the perlpod manpage</a>, <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/pod/perlpodspec.html">the perlpodspec manpage</a></p> <p> </p> <hr /> <h1><a name="copyright_and_disclaimers">COPYRIGHT AND DISCLAIMERS</a></h1> <p>Copyright (c) 2004 Sean M. Burke. All rights reserved.</p> <p>This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.</p> <p>This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose.</p> <p> </p> <hr /> <h1><a name="author">AUTHOR</a></h1> <p>Sean M. Burke <code>sburke@cpan.org</code></p> <table border="0" width="100%" cellspacing="0" cellpadding="3"> <tr><td class="block" style="background-color: #cccccc" valign="middle"> <big><strong><span class="block"> Pod::Simple::HTMLBatch - convert several Pod files to several HTML files</span></strong></big> </td></tr> </table> </body> </html>
Ms-Dos/Windows
Unix
Write backup
jsp File Browser version 1.2 by
www.vonloesch.de