NAME Locale::TextDomain::OO::Extract::HTML - Extracts internationalization data from HTML

VERSION

2.017

DESCRIPTION

This module extracts internationalization data from HTML.

Implemented rules:

Gettext::Loc

            

              
              
<any_tag ... class="... loc_ ..." ... >text to extract<
<any_tag ... class="... loc_ ..." ... >context{CONTEXT_SEPARATOR}text to extract<
            
          

Gettext

            

              
              
<any_tag ... class="... __ ..." ... >text to extract<
<any_tag ... class="... __ ..." ... >context{CONTEXT_SEPARATOR}text to extract<
            
          

Maketext

            

              
              
<any_tag ... class="... loc ..." ... >text to extract<
<any_tag ... class="... loc ..." ... >context{CONTEXT_SEPARATOR}text to extract<
            
          

Whitespace is allowed everywhere.

SYNOPSIS

            

              
              
use Locale::TextDomain::OO::Extract::HTML;
use Path::Tiny qw(path);
my $extractor = Locale::TextDomain::OO::Extract::HTML->new(
    # optional filter parameter, the default is ['all'],
    # the following means:
    # extract for all plugins but not for Plugin
    # Locale::TextDomain::OO::Plugin::Maketext
    filter => [ qw(
        all
        !Maketext
    ) ],
);
for ( @files ) {
    $extractor->clear;
    $extractor->filename($_);            # dir/filename for reference
    $extractor->content_ref( \( path($_)->slurp_utf8 ) );
    $extractor->project('my project');   # set or default undef is used
    $extractor->category('LC_MESSAGES'); # set or default q{} is used
    $extractor->domain('my domain');     # set or default q{} is used
    $extractor->extract;
}
... = $extractor->lexicon_ref;
            
          

SUBROUTINES/METHODS

method new

All parameters are optional. See Locale::TextDomain::OO::Extract to replace the defaults.

            

              
              
my $extractor = Locale::TextDomain::OO::Extract::HTML->new;
            
          

method filter

Ignore some of 'all' or define what to scan. See SYNOPSIS and DESCRIPTION for how and what.

            

              
              
my $array_ref = $extractor->filter;
$extractor->filter(['all']); # the default
            
          

method preprocess (called by method extract)

Remove code between <!-- -->

            

              
              
$extractor->preprocess;
            
          

method stack_item_mapping (called by method extract)

            

              
              
$extractor->stack_item_mapping;
            
          

method extract

This method runs the extraction.

            

              
              
$extractor->extract;
            
          

EXAMPLE

Inside of this distribution is a directory named example. Run this *.pl files.

DIAGNOSTICS

none

CONFIGURATION AND ENVIRONMENT

none

DEPENDENCIES

Moo

MooX::Types::MooseLike::Base

namespace::autoclean

Locale::TextDomain::OO::Extract::Base::RegexBasedExtractor

Locale::TextDomain::OO::Extract::Role::File

INCOMPATIBILITIES

not known

BUGS AND LIMITATIONS

none

SEE ALSO

Locale::TextDoamin::OO

HTML::Zoom

AUTHOR

Steffen Winkler

LICENSE AND COPYRIGHT

Copyright (c) 2014 - 2025, Steffen Winkler <steffenw at cpan.org>. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

cpanm Locale::TextDomain::OO::Extract

perl -MCPAN -e shell
install Locale::TextDomain::OO::Extract