Dist::Zilla::Plugin::PotWriter - Something that writes gettext language translation template file
with 'Dist::Zilla::Role::PotWriter'; # ... sub execute { my $self = shift; $self->write_pot(%params); }
This role provides a utility method for generating a GNU gettext-style language translation template.
write_pot
$self->write_pot(%params);
Creates or updates a GNU gettext-style language translation file. The supported parameters are:
to
Path::Class::File object representing the file to write to. Required.
scan_files
Array reference listing the files to scan. Defaults to all *.pm files gathered by Dist::Zilla.
xgettext
Path to the xgettext application. Defaults to just xgettext (xgettext.exe on Windows), which should work if it's in your path.
xgettext.exe
encoding
Encoding to assume when scanning for localizable strings. Defaults to UTF-8.
UTF-8
package
The name of the localization package. Defaults to the distribution name as configured for Dist::Zilla.
version
The version of the package. Defaults to the version as configured for Dist::Zilla.
copyright_holder
The name of the translation copyright holder. Defaults to the copyright holder configured for Dist::Zilla.
bugs_email
Email address for reporting translation bugs. Defaults to the email address of the first author known to Dist::Zilla, if available and parseable by Email::Address.
David E. Wheeler <david@justatheory.com>
This software is copyright (c) 2012-2013 by David E. Wheeler.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Dist::Zilla::LocaleTextDomain, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Dist::Zilla::LocaleTextDomain
CPAN shell
perl -MCPAN -e shell install Dist::Zilla::LocaleTextDomain
For more information on module installation, please visit the detailed CPAN module installation guide.