TWiki/VarLANGUAGES.mdwn

   1 <a name="VarLANGUAGES"></a>
   2
   3 ### <a name="LANGUAGES -- list available TWik"></a> LANGUAGES -- list available TWiki languages
   4
   5 - List the languages available (as `PO` files) to TWiki. Those are the languages in which TWiki's user interface is available.
   6 - Syntax: `%LANGUAGES{...}%`
   7 - Supported parameters: <table border="1" cellpadding="0" cellspacing="0">
   8   <tr>
   9     <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
  10     <th bgcolor="#99CCCC"><strong> Description: </strong></th>
  11     <th bgcolor="#99CCCC"><strong> Default: </strong></th>
  12   </tr>
  13   <tr>
  14     <td><code>format</code></td>
  15     <td> format for each item. See below for variables available in the format string. </td>
  16     <td><code>"   * $langname"</code></td>
  17   </tr>
  18   <tr>
  19     <td><code>separator</code></td>
  20     <td> separator between items. </td>
  21     <td><code>"\n"</code> (newline) </td>
  22   </tr>
  23   <tr>
  24     <td><code>marker="selected"</code></td>
  25     <td> Text for <code>$marker</code> if the item matches <code>selection</code></td>
  26     <td><code>"selected"</code></td>
  27   </tr>
  28   <tr>
  29     <td><code>selection="%LANGUAGE%"</code></td>
  30     <td> Current language to be selected in list </td>
  31     <td><code>(none)</code></td>
  32   </tr>
  33 </table>
  34 - `format` variables: <table border="1" cellpadding="0" cellspacing="0">
  35   <tr>
  36     <th bgcolor="#99CCCC"><strong> Variable </strong></th>
  37     <th bgcolor="#99CCCC"><strong> Meaning </strong></th>
  38   </tr>
  39   <tr>
  40     <td><code>$langname</code></td>
  41     <td> language's name, as informed by the translators </td>
  42   </tr>
  43   <tr>
  44     <td><code>$langtag</code></td>
  45     <td> language's tag. Ex: <code>en</code>, <code>pt-br</code>, etc. </td>
  46   </tr>
  47 </table>
  48 - Example: `<select>%LANGUAGES{format="<option $marker value='$langtag'>$langname</option>" selection="%LANGUAGE%"}%</select>` creates an option list of the available languages with the current language selected