Difference: VarMAKETEXT (1 vs. 6)

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.

• • %MAKETEXT{"Did you want to ~[~[[_1]~]~[reset [_2]'s password~]~]?" args="%SYSTEMWEB%.ResetPassword, %WIKINAME%"}%

• • Square brackets ~[ and ~] in the text have a special meaning and need to be escaped using ~[ and ~], respectively.

• • 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.

• Related: TWiki:Codev.UserInterfaceInternationalisation (on TWiki.org), CPAN:Locale::Maketext (Maketext documentation)

• Category: DevelopmentVariables, FormattingAndRenderingVariables
• Related: TWiki:Codev.UserInterfaceInternationalisation (on TWiki.org)

• • 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.
  • 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 (since they will get expanded before the %MAKETEXT{...}% itself is handled).

• Syntax: %MAKETEXT{"string" args="..."}%

• • %MAKETEXT{"Did you want to [[[_1]][reset [_2]'s password]]?" args="%SYSTEMWEB%.ResetPassword,%WIKIUSERNAME%"}%

MAKETEXT -- creates text using TWiki's I18N infrastructure

MAKETEXT -- creates text using TWiki's I18N infrastructure

• 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="%TWIKIWEB%.ResetPassword,%WIKIUSERNAME%"}%
    expands to
    Did you want to reset Main.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.
  • Amperstands (&) 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.
  • translatable string starting with underscores (_) are reserved. You cannot use translatable phrases starting with an underscore.
  • Make sure that the translatable string is constant. Specially, do not include %VARIABLES% inside the translatable strings (since they will get expanded before the %MAKETEXT{...}% itself is handled).