TWiki/VarMAKETEXT.mdwn

   1 <a name="VarMAKETEXT"></a>
   2
   3 ### <a name="MAKETEXT -- creates text using T"></a> MAKETEXT -- creates text using TWiki's I18N infrastructure
   4
   5 - Syntax: `%MAKETEXT{"string" args="..."}%`
   6 - Supported parameters: <table border="1" cellpadding="0" cellspacing="0">
   7   <tr>
   8     <th bgcolor="#99CCCC"><strong> Parameter </strong></th>
   9     <th bgcolor="#99CCCC"><strong> Description </strong></th>
  10     <th bgcolor="#99CCCC"><strong> Default </strong></th>
  11   </tr>
  12   <tr>
  13     <td><code>"text"</code> or <code>string="text"</code></td>
  14     <td> The text to be displayed. </td>
  15     <td><em>none</em></td>
  16   </tr>
  17   <tr>
  18     <td><code>args="param1, param2"</code></td>
  19     <td> a comma-separated list of arguments to be interpolated in the string, replacing the <code>[_N]</code> placeholders in it. </td>
  20     <td><em>none</em></td>
  21   </tr>
  22 </table>
  23 - Examples:
  24   - `%MAKETEXT{string="Notes:"}%` %BR% expands to %BR% _ Notes: _
  25   - `%MAKETEXT{"If you have any questions, please contact [_1]." args="%WIKIWEBMASTER%"}%` %BR% expands to %BR% _ If you have any questions, please contact 0. _
  26   - `%MAKETEXT{"Did you want to [[[_1]][reset [_2]'s password]]?" args="%SYSTEMWEB%.ResetPassword,%WIKIUSERNAME%"}%` %BR% expands to %BR% _ Did you want to [[reset Main.admin's password|TWiki/ResetPassword]]? _
  27 - **_Notes:_**
  28   - TWiki will translate the `string` to the current user's language _only_ if it has such string in its translation table for that language.
  29   - 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.
  30   - translatable string starting with underscores (`_`) are reserved. You **cannot** use translatable phrases starting with an underscore.
  31   - 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).