.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Catmandu::I18N 3pm" .TH Catmandu::I18N 3pm "2023-02-04" "perl v5.36.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Catmandu::I18N \- tools for text localisation .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Catmandu::Sane; \& \& use Catmandu::I18N; \& \& my $i = Catmandu::I18N\->new( \& config => { \& en => [ \& "Gettext", \& "/path/to/en.po" \& ], \& nl => [ \& "Gettext", \& "/path/to/nl.po" \& ] \& } \& ); \& \& $i\->t( "my\-lang", "my\-key" ); \& $i\->t( "my\-lang", "my\-key2", "arg\-1", "arg\-2" ); .Ve .SH "CONSTRUCTOR ARGUMENTS" .IX Header "CONSTRUCTOR ARGUMENTS" .IP "config" 4 .IX Item "config" Configuration for Locale::Maketext. .Sp Must be either: .Sp * hash reference .Sp * string (e.g. \*(L"i18n\*(R") .Sp When the config is a string, it is interpreted as the path to the I18N configuration in Catmandu config. .Sp Required .IP "on_failure" 4 .IX Item "on_failure" What to do when a lookup does not give a result. .Sp Possible values: .Sp * \*(L"undef\*(R" : return undef .Sp * \*(L"auto\*(R" : return key itself. Always a result. .Sp * \*(L"die\*(R" : die .Sp Default: \*(L"undef\*(R" .Sp Note: \*(L"undef\*(R" should be a string, as opposed to undef. .IP "fallback_languages" 4 .IX Item "fallback_languages" array of fallback language codes .Sp * must be array reference .Sp * default is [ \*(L"i\-default\*(R",\*(L"en\*(R",\*(L"en\-US\*(R" ] as determined by Locale::Maketext .Sp When Locale::Maketext does not find the specified language in your config, it will fallback to one of these, and then load the handle for that. .Sp Only if that fallback language does not exist in the config, will it fail. .Sp Example 1: .Sp fallback_languages is [ \*(L"en\*(R" ] .Sp you have only language \*(L"en\*(R" in your config, but you request language \*(L"nl\*(R", then you'll get the message in English. .Sp Example 2: .Sp fallback_languages is [ \*(L"en\*(R" ] .Sp you have only language \*(L"nl\*(R" in your config, but you request language \*(L"fr\*(R", then the creation of the message will fail .Sp You can set this to an empty array for consistent behaviour. .SH "NOTES" .IX Header "NOTES" * the lexicon implementation determines the format of the message. .PP e.g. only Locale::Maketext::Lexicon::Gettext supports placeholders like \f(CW%1\fR. .PP For other implementations you need to use placeholders like [_1] .SH "AUTHORS" .IX Header "AUTHORS" Nicolas Franck \f(CW\*(C`\*(C'\fR .SH "SEE ALSO" .IX Header "SEE ALSO" Catmandu::Fix::i18n, Locale::Maketext::Lexicon::CatmanduConfig, Catmandu, Locale::Maketext .SH "LICENSE AND COPYRIGHT" .IX Header "LICENSE AND COPYRIGHT" This program is free software; you can redistribute it and/or modify it under the terms of either: the \s-1GNU\s0 General Public License as published by the Free Software Foundation; or the Artistic License. .PP See for more information.