/ 
HTML-Links-Localize-0.2.10
River stage one • 5 direct dependents • 5 total dependents
/ HTML::Links::Localize

NAME

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

VERSION

version 0.2.10

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.

AUTHOR

Shlomi Fish <shlomif@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2019 by Shlomi Fish.

This is free software, licensed under:

The MIT (X11) License

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/shlomif/perl-html-links-localize/issues

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

SUPPORT

Perldoc

You can find documentation for this module with the perldoc command.

perldoc HTML::Links::Localize

Websites

The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.

Bugs / Feature Requests

Please report any bugs or feature requests by email to bug-html-links-localize at rt.cpan.org, or through the web interface at https://rt.cpan.org/Public/Bug/Report.html?Queue=HTML-Links-Localize. You will be automatically notified of any progress on the request by the system.

Source Code

The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)

https://github.com/shlomif/perl-html-links-localize

git clone git://github.com/shlomif/perl-html-links-localize.git