Locale::Maketext::Extract::Plugin::YAML (3)

Leading comments

Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/Locale::Maketext::Extract::Plugin::YAML.3pm".)

NAME

Locale::Maketext::Extract::Plugin::YAML - YAML format parser

VERSION

version 1.00

SYNOPSIS

    $plugin = Locale::Maketext::Extract::Plugin::YAML->new(
        $lexicon            # A Locale::Maketext::Extract object
        @file_types         # Optionally specify a list of recognised file types
    )

    $plugin->extract($filename,$filecontents);

DESCRIPTION

Extracts strings to localise from files.

SHORT PLUGIN NAME

    yaml

VALID FORMATS

Valid formats are:

*

    key: _"string"

*

    key: _'string'

*

    key: _'string with embedded 'quotes''

*

    key: |-
         _'my folded
         string
         to translate'

Note, the left hand side of the folded string must line up with the "_", otherwise

YAML

adds spaces at the beginning of each line.

*

    key: |-
         _'my block
         string
         to translate
         '
Note, you must use the trailing C<-> so that YAMl doesn't add a carriage
return after your final quote.

KNOWN FILE TYPES

.yaml

.yml

.conf

REQUIRES

NOTES

The docs for the module describes it as alpha code. It is not as tolerant of errors as YAML::Syck. However, because it is pure Perl, it is easy to hook into.

I have seen it enter endless loops, so if xgettext.pl hangs, try running it again with "--verbose --verbose" (twice) enabled, so that you can see if the fault lies with

If it does, either correct the source file, or use the file_types to exclude that file.

SEE ALSO

xgettext.pl

for extracting translatable strings from common template systems and perl source files.

YAML

Locale::Maketext::Lexicon

Locale::Maketext::Extract::Plugin::Base

Locale::Maketext::Extract::Plugin::FormFu

Locale::Maketext::Extract::Plugin::Perl

Locale::Maketext::Extract::Plugin::TT2

Locale::Maketext::Extract::Plugin::Mason

Locale::Maketext::Extract::Plugin::TextTemplate

Locale::Maketext::Extract::Plugin::Generic

AUTHORS

Clinton Gormley <clint@traveljury.com>

COPYRIGHT

Copyright 2002-2013 by Audrey Tang <cpan@audreyt.org>.

This software is released under the

license cited below.

The

MIT

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ``Software''), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

AUTHORS

*

Clinton Gormley <drtech@cpan.org>

*

Audrey Tang <cpan@audreyt.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2014 by Audrey Tang.

This is free software, licensed under:

  The MIT (X11) License