David E. Wheeler > Dist-Zilla-LocaleTextDomain > Dist::Zilla::Plugin::PotFile

Download:
Dist-Zilla-LocaleTextDomain-0.90.tar.gz

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Source  

Name ^

Dist::Zilla::Plugin::PotFile - Something finds or creates a gettext language translation template file

Synopsis ^

  with 'Dist::Zilla::Role::PotFile';

  # ...

  sub execute {
      my $self = shift;
      my $pot_file = $self->pot_file(%params);
  }

Description ^

This role provides a utility method for finding or creating a GNU gettext-style language translation template.

Instance Methods

pot_file

  $self->pot_file(%params);

Finds or creates a temporary GNU gettext-style language translation file. It works in this order:

The supported parameters are:

pot_file

A path to an existing translation template file. If this file does not exist, an exception will be thrown.

xgettext

Path to the xgettext application. Defaults to just xgettext (xgettext.exe on Windows), which should work if it's in your path.

encoding

Encoding to assume when scanning for localizable strings. Defaults to UTF-8.

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.

Author ^

David E. Wheeler <david@justatheory.com>

Copyright and License ^

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.

syntax highlighting: