Locale:...::FormFu(3)

📦
version 1.00 · 9 versions
, in alpine 3.22

💖 Locale:...::FormFu(3) 💖

ok so this is a page from the User Contributed Perl Documentation besties, and honestly? it's giving "niche parser plugin that absolutely carries the whole form-localization situation." let's get into it 🫶

✨ NAME ✨

Locale::Maketext::Extract::Plugin::FormFu — it's the FormFu format parser, no cap 💅

🌸 VERSION 🌸

version 1.00 ✨

🎀 SYNOPSIS 🎀

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

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

like, $lexicon is a Locale::Maketext::Extract object (iconic), and @file_types is optional — you can hand it a list of recognised file types if you're feeling extra 🌈

🦋 DESCRIPTION 🦋

so HTML::FormFu uses a config-file to generate forms, and it has built in support for localizing errors, labels etc. that's the whole vibe 💜

⭐ SHORT PLUGIN NAME ⭐

formfu

short, sweet, slays 🔥

👑 VALID FORMATS 👑

we extract the text after any key which ends in _loc — the way that works is genuinely so clean:

content_loc: this is the string
message_loc: ['Max length [_1]', 10]

see? anything ending in _loc gets its text yoinked out 💖

🌈 KNOWN FILE TYPES 🌈

  • .yaml
  • .yml
  • .conf

those three, periodt 🎀

🧚 REQUIRES 🧚

YAML

ngl, that's the whole list.

💀 NOTES 💀

ok bestie, read this part carefully because it's lowkey important 🙈

The docs for the YAML module describe 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.

and here's the real tea: "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." 😭 so yeah — hang = maybe YAML's fault, and you fix it or exclude it. literally that simple 💅

💜 SEE ALSO 💜

  • xgettext.pl — for extracting translatable strings from common template systems and perl source files. the main character of this whole ecosystem ✨
  • YAML
  • HTML::FormFu
  • Locale::Maketext::Lexicon
  • Locale::Maketext::Extract::Plugin::Base
  • Locale::Maketext::Extract::Plugin::Perl
  • Locale::Maketext::Extract::Plugin::TT2
  • Locale::Maketext::Extract::Plugin::YAML
  • Locale::Maketext::Extract::Plugin::Mason
  • Locale::Maketext::Extract::Plugin::TextTemplate
  • Locale::Maketext::Extract::Plugin::Generic

a whole little plugin family reunion 🫶

🍓 AUTHORS 🍓

Clinton Gormley <clint@traveljury.com>

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 🔥

  • Clinton Gormley <drtech@cpan.org>
  • Audrey Tang <cpan@audreyt.org>

(yeah, there's two AUTHORS sections. we don't question it, we respect it 💅)

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

This is free software, licensed under:

The MIT (X11) License

and that's the whole page bestie, hope it ate 💖 this lovely little number shipped as perl v5.40.2 on 2025-01-03 — go forth and extract those _loc strings, ily, bye 🎀✨🦋

📦 where this page comes from