Locale:...in::TT2(3)

📦
version 1.00 · 9 versions
, in alpine 3.22

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

okay so bestie, welcome to the manual page for Locale::Maketext::Extract::Plugin::TT2 — it's the Template Toolkit format parser, and it's literally here to help you pull out all the strings you need to localise from your TT templates. slay. ✨

VERSION

version 1.00 — iconic, we love a stable release 🎀

SYNOPSIS

$plugin = Locale::Maketext::Extract::Plugin::TT2->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 Template Toolkit templates. no cap, that's literally the whole job and it does it well 💖

SHORT PLUGIN NAME

tt2

that's the nickname, that's what you call it in your configs, periodt 🦋

VALID FORMATS

Valid formats are:

[% |l(args) %]string[% END %]
[% 'string' | l(args) %]
[% l('string',args) %]
[% c.l('string') %]

Also all the above combinations with c. prepended should work correctly. This is the default syntax when using TT templates with Mojolicious. so like, c. is the main character in Mojo land 👑

l and loc are interchangeable.

| and FILTER are interchangeable.

lowkey obsessed with how flexible this is fr fr 💅

KNOWN FILE TYPES

  • .tt
  • .tt2
  • .html
  • .tt.*
  • .tt2.*

these are the vibes, these are the files it happily munches on 🌸

REQUIRES

Template

you gotta have it, no way around it bestie 🫶

NOTES

  • BEWARE Using the loc form can give false positives if you use the Perl parser plugin on TT files. If you want to use the loc form, then you should specify the file types that you want to the Perl plugin to parse, or enable the default file types, eg:
xgetext.pl -P perl ....        # default file types
xgettext.pl -P perl=pl,pm  ... # specified file types

like, this is a real warning, don't just ignore it 😭

  • The string-to-be-localised must be a string, not a variable. We try not to extract calls to your localise function which contain variables eg:
l('string',arg)  # extracted
l(var,arg)       # not extracted

This doesn't work for block filters, so don't do that. Eg:

[%  FILTER l %]
   string [% var %]      # BAD!
[% END %]

literally do not do this, it's giving chaos 💀

  • Getting the right line number is difficult in TT. Often it'll be a range of lines, or it may be thrown out by the use of PRE_CHOMP or POST_CHOMP. It will always be within a few lines of the correct location. so like, close enough, it's fine, don't stress 🙈
  • If you have PRE/POST_CHOMP enabled by default in your templates, then you should extract the strings using the same values. In order to set them, you can use the following wrapper script:
#!/usr/bin/perl

use Locale::Maketext::Extract::Run qw(xgettext);
use Locale::Maketext::Extract::Plugin::TT2();

%Locale::Maketext::Extract::Plugin::TT2::PARSER_OPTIONS = (
     PRE_CHOMP  => 1, # or 2
     POST_CHOMP => 1, # or 2

     # Also START/END_TAG, ANYCASE, INTERPOLATE, V1DOLLAR, EVAL_PERL
);

xgettext(@ARGV);

use the wrapper, it's the move 🔥

ACKNOWLEDGEMENTS

Thanks to Andy Wardley for writing the Template::Directive subclass which made this possible. absolute legend behaviour, we stan 🌈

SEE ALSO

  • xgettext.pl — for extracting translatable strings from common template systems and perl source files.
  • Locale::Maketext::Lexicon
  • Locale::Maketext::Extract::Plugin::Base
  • Locale::Maketext::Extract::Plugin::FormFu
  • Locale::Maketext::Extract::Plugin::Perl
  • Locale::Maketext::Extract::Plugin::YAML
  • Locale::Maketext::Extract::Plugin::Mason
  • Locale::Maketext::Extract::Plugin::TextTemplate
  • Locale::Maketext::Extract::Plugin::Generic
  • Template::Toolkit

all the related besties, go read them too 👑

AUTHORS

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 (again, yes really)

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

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

This is free software, licensed under:

The MIT (X11) License

so yeah, that's the whole page bestie 💜 this was Locale:...in::TT2(3) from perl v5.40.2, dated 2025-01-03 — go forth and localise, you're gonna slay ✨🎀🦋

📦 where this page comes from