GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  LOCALE::MAKETEXT::EXTRACT::PLUGIN::YAML (3)

.ds Aq ’

NAME

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

CONTENTS

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 YAML files.

SHORT PLUGIN NAME



    yaml



VALID FORMATS

Valid formats are:
o



    key: _"string"



o



    key: _string



o



    key: _string with embedded quotes



o



    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.

o



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



KNOWN FILE TYPES

.yaml
.yml
.conf

REQUIRES

YAML

NOTES

The docs for the YAML 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 YAML. If it does, either correct the YAML 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 MIT 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.

THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

AUTHORS

o Clinton Gormley <drtech@cpan.org>
o 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



Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 LOCALE::MAKETEXT::EXTRACT::PLUGIN::YAML (3) 2014-03-06

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.