Shlomi Fish > HTML-Links-Localize-v0.2.8 > HTML::Links::Localize

Download:
HTML-Links-Localize-v0.2.8.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: v0.2.8   Source  

NAME ^

HTML::Links::Localize - Convert HTML Files to be used on a hard disk

SYNOPSIS ^

    use HTML::Links::Localize;

    my $converter =
        HTML::Links::Localize->new(
            'base_dir' => "/var/www/html/shlomi/Perl/Newbies/lecture4/",
            'dest_dir' => "./dest"
        );

    $converter->process_file("mydir/myfile.html");

    $converter->process_dir_tree('only-newer' => 1);

    my $new_content = $converter->process_content(\$html_text);

DESCRIPTION ^

HTML::Links::Localize converts HTML files to be used when viewing on the hard disk. Namely, it converts relative links to point to "index.html" files in their directories.

To use it, first initialize an instance using new:

$converter = HTML::Links::Localize->new(base_dir => $base_dir, dest_dir => $dest_dir)

The constructor accepts two named parameters which are mandatory. 'base_dir' is the base directory (or source directory) for the operations. 'dest_dir' is the root destination directory.

Afterwards, you can use the other methods.

$new_content = $converter->process_content(FILE)

This function converts a singular text of an HTML file to a hard disk one. FILE is any argument accepatble by HTML::TokeParser. It returns the new content.

$converter->process_file($filename)

This function converts a filename relative to the source directory to its corresponding file in the destination directory.

$converter->process_dir_tree( [ 'only-newer' => 1] );

This function converts the entire directory tree that starts at the base directory. only-newer means to convert only files that are newer in a make-like fashion.

AUTHOR ^

Shlomi Fish, http://www.shlomifish.org/

COPYRIGHT AND LICENSE ^

Copyright 2004, Shlomi Fish.

You can use, modify and distribute this module under the terms of the MIT X11 license. ( http://www.opensource.org/licenses/mit-license.php ).

NOTE

The CPAN meta-data says this work is "BSD-licensed". The BSD license was chosen because it was the closest option to MIT X11, and because the MIT X11 license is a BSD-style license. However, the correct license is the MIT X11.

syntax highlighting: