MAKETEXT -- translate text using TWiki's I18N infrastructure
- Text in MAKETEXT is translated into another language at page view time if the user activates a language other than the default English language.
- Syntax:
%MAKETEXT{"string" args="..."}%
- Supported parameters:
Parameter | Description | Default |
"text" or string="text" | The text to be displayed. | none |
args="param1, param2" | a comma-separated list of arguments to be interpolated in the string, replacing the [_N] placeholders in it. | none |
- Examples:
-
%MAKETEXT{string="Notes:"}%
expands to
Notes:
-
%MAKETEXT{"If you have any questions, please contact [_1]." args="%WIKIWEBMASTER%"}%
expands to
If you have any questions, please contact 0.
-
%MAKETEXT{"Did you want to ~[~[[_1]~]~[reset [_2]'s password~]~]?" args="%SYSTEMWEB%.ResetPassword, %WIKINAME%"}%
expands to
Did you want to reset TWikiGuest's password?
- Notes:
- TWiki will translate the
string
to the current user's language only if it has such string in its translation table for that language.
- Ampersands (
&
) followed by one letter (one of a...z
, A...Z
-- say, X
) in the translatable string will be translated to <span class='twikiAccessKey'>X</span>
. This is used to implement access keys. If you want to write an actual amperstand that stays just before a letter, write two consecutive amperstands (&&
): they will be transformed in just one.
- Square brackets
~[
and ~]
in the text have a special meaning and need to be escaped using ~[
and ~]
, respectively.
- Translatable string starting with underscores (
_
) are reserved. You must not use translatable phrases starting with an underscore.
- Make sure that the translatable string is constant. Specially, do not include
%VARIABLES%
inside the translatable strings - string would not get translated because variables get expanded before the %MAKETEXT{...}%
itself is handled.
- Category: DevelopmentVariables, FormattingAndRenderingVariables
- Related: TWiki:Codev.UserInterfaceInternationalisation
(on TWiki.org), CPAN:Locale::Maketext
(Maketext documentation)
This topic: TWiki
> WebHome >
TWikiVariables > VarMAKETEXT
Topic revision: r6 - 2014-01-29 - TWikiContributor