doc/api/python/localisation-module.html
changeset 432 f2ddfa555b0f
equal deleted inserted replaced
431:7685cec9fd3c 432:f2ddfa555b0f
       
     1 <?xml version="1.0" encoding="ascii"?>
       
     2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
       
     3           "DTD/xhtml1-transitional.dtd">
       
     4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
       
     5 <head>
       
     6   <title>localisation</title>
       
     7   <link rel="stylesheet" href="epydoc.css" type="text/css" />
       
     8   <script type="text/javascript" src="epydoc.js"></script>
       
     9 </head>
       
    10 
       
    11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
       
    12       alink="#204080">
       
    13 <!-- ==================== NAVIGATION BAR ==================== -->
       
    14 <table class="navbar" border="0" width="100%" cellpadding="0"
       
    15        bgcolor="#a0c0ff" cellspacing="0">
       
    16   <tr valign="middle">
       
    17 
       
    18   <!-- Tree link -->
       
    19       <th>&nbsp;&nbsp;&nbsp;<a
       
    20         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
    21 
       
    22   <!-- Index link -->
       
    23       <th>&nbsp;&nbsp;&nbsp;<a
       
    24         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
    25 
       
    26   <!-- Help link -->
       
    27       <th>&nbsp;&nbsp;&nbsp;<a
       
    28         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
    29 
       
    30       <th class="navbar" width="100%"></th>
       
    31   </tr>
       
    32 </table>
       
    33 <table width="100%" cellpadding="0" cellspacing="0">
       
    34   <tr valign="top">
       
    35     <td width="100%">
       
    36       <span class="breadcrumbs">
       
    37         Module&nbsp;localisation
       
    38       </span>
       
    39     </td>
       
    40     <td>
       
    41       <table cellpadding="0" cellspacing="0">
       
    42         <!-- hide/show private -->
       
    43         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
       
    44     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
       
    45         <tr><td align="right"><span class="options"
       
    46             >[<a href="frames.html" target="_top">frames</a
       
    47             >]&nbsp;|&nbsp;<a href="localisation-module.html"
       
    48             target="_top">no&nbsp;frames</a>]</span></td></tr>
       
    49       </table>
       
    50     </td>
       
    51   </tr>
       
    52 </table>
       
    53 <!-- ==================== MODULE DESCRIPTION ==================== -->
       
    54 <h1 class="epydoc">Module localisation</h1><span class="codelink"><a href="localisation-pysrc.html">source&nbsp;code</a></span><br /><br />
       
    55 Localisation related function.
       
    56 * Parsing of languages.xml<br /><br />
       
    57 
       
    58 <!-- ==================== CLASSES ==================== -->
       
    59 <a name="section-Classes"></a>
       
    60 <table class="summary" border="1" cellpadding="3"
       
    61        cellspacing="0" width="100%" bgcolor="white">
       
    62 <tr bgcolor="#70b0f0" class="table-header">
       
    63   <td colspan="2" class="table-header">
       
    64     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
    65       <tr valign="top">
       
    66         <td align="left"><span class="table-header">Classes</span></td>
       
    67         <td align="right" valign="top"
       
    68          ><span class="options">[<a href="#section-Classes"
       
    69          class="privatelink" onclick="toggle_private();"
       
    70          >hide private</a>]</span></td>
       
    71       </tr>
       
    72     </table>
       
    73   </td>
       
    74 </tr>
       
    75 <tr>
       
    76     <td width="15%" align="right" valign="top" class="summary">
       
    77       <span class="summary-type">&nbsp;</span>
       
    78     </td><td class="summary">
       
    79         <a href="localisation.Languages-class.html" class="summary-name">Languages</a><br />
       
    80       Languages.xml file parser.
       
    81     </td>
       
    82   </tr>
       
    83 </table>
       
    84 <!-- ==================== FUNCTIONS ==================== -->
       
    85 <a name="section-Functions"></a>
       
    86 <table class="summary" border="1" cellpadding="3"
       
    87        cellspacing="0" width="100%" bgcolor="white">
       
    88 <tr bgcolor="#70b0f0" class="table-header">
       
    89   <td colspan="2" class="table-header">
       
    90     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
    91       <tr valign="top">
       
    92         <td align="left"><span class="table-header">Functions</span></td>
       
    93         <td align="right" valign="top"
       
    94          ><span class="options">[<a href="#section-Functions"
       
    95          class="privatelink" onclick="toggle_private();"
       
    96          >hide private</a>]</span></td>
       
    97       </tr>
       
    98     </table>
       
    99   </td>
       
   100 </tr>
       
   101 <tr>
       
   102     <td width="15%" align="right" valign="top" class="summary">
       
   103       <span class="summary-type">&nbsp;</span>
       
   104     </td><td class="summary">
       
   105       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   106         <tr>
       
   107           <td><span class="summary-sig"><a name="get_all_variations"></a><span class="summary-sig-name">get_all_variations</span>(<span class="summary-sig-arg">languages_xml</span>)</span><br />
       
   108       Returns a list of all regional variations supported by platform.</td>
       
   109           <td align="right" valign="top">
       
   110             <span class="codelink"><a href="localisation-pysrc.html#get_all_variations">source&nbsp;code</a></span>
       
   111             
       
   112           </td>
       
   113         </tr>
       
   114       </table>
       
   115       
       
   116     </td>
       
   117   </tr>
       
   118 <tr>
       
   119     <td width="15%" align="right" valign="top" class="summary">
       
   120       <span class="summary-type">&nbsp;</span>
       
   121     </td><td class="summary">
       
   122       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   123         <tr>
       
   124           <td><span class="summary-sig"><a name="get_languages_for_variation"></a><span class="summary-sig-name">get_languages_for_variation</span>(<span class="summary-sig-arg">languages_xml</span>,
       
   125         <span class="summary-sig-arg">variation</span>=<span class="summary-sig-default">'western'</span>)</span><br />
       
   126       Returns alist of all supported languages for a specific region.</td>
       
   127           <td align="right" valign="top">
       
   128             <span class="codelink"><a href="localisation-pysrc.html#get_languages_for_variation">source&nbsp;code</a></span>
       
   129             
       
   130           </td>
       
   131         </tr>
       
   132       </table>
       
   133       
       
   134     </td>
       
   135   </tr>
       
   136 <tr class="private">
       
   137     <td width="15%" align="right" valign="top" class="summary">
       
   138       <span class="summary-type">&nbsp;</span>
       
   139     </td><td class="summary">
       
   140       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   141         <tr>
       
   142           <td><span class="summary-sig"><a name="_apply_override"></a><span class="summary-sig-name">_apply_override</span>(<span class="summary-sig-arg">overrides</span>,
       
   143         <span class="summary-sig-arg">line</span>)</span></td>
       
   144           <td align="right" valign="top">
       
   145             <span class="codelink"><a href="localisation-pysrc.html#_apply_override">source&nbsp;code</a></span>
       
   146             
       
   147           </td>
       
   148         </tr>
       
   149       </table>
       
   150       
       
   151     </td>
       
   152   </tr>
       
   153 <tr>
       
   154     <td width="15%" align="right" valign="top" class="summary">
       
   155       <span class="summary-type">&nbsp;</span>
       
   156     </td><td class="summary">
       
   157       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   158         <tr>
       
   159           <td><span class="summary-sig"><a name="create_locales_iby"></a><span class="summary-sig-name">create_locales_iby</span>(<span class="summary-sig-arg">product</span>,
       
   160         <span class="summary-sig-arg">lid</span>,
       
   161         <span class="summary-sig-arg">flags</span>=<span class="summary-sig-default">None</span>,
       
   162         <span class="summary-sig-arg">prefix</span>=<span class="summary-sig-default">''</span>,
       
   163         <span class="summary-sig-arg">suffix</span>=<span class="summary-sig-default">''</span>)</span><br />
       
   164       Function that generates locales_xx.iby into rom product folder.</td>
       
   165           <td align="right" valign="top">
       
   166             <span class="codelink"><a href="localisation-pysrc.html#create_locales_iby">source&nbsp;code</a></span>
       
   167             
       
   168           </td>
       
   169         </tr>
       
   170       </table>
       
   171       
       
   172     </td>
       
   173   </tr>
       
   174 <tr>
       
   175     <td width="15%" align="right" valign="top" class="summary">
       
   176       <span class="summary-type">&nbsp;</span>
       
   177     </td><td class="summary">
       
   178       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   179         <tr>
       
   180           <td><span class="summary-sig"><a name="find_variant_path"></a><span class="summary-sig-name">find_variant_path</span>(<span class="summary-sig-arg">config</span>,
       
   181         <span class="summary-sig-arg">key</span>=<span class="summary-sig-default">VARIANT_ID_KEY</span>)</span><br />
       
   182       This function helps to find the variant directory
       
   183 using variant configuration</td>
       
   184           <td align="right" valign="top">
       
   185             <span class="codelink"><a href="localisation-pysrc.html#find_variant_path">source&nbsp;code</a></span>
       
   186             
       
   187           </td>
       
   188         </tr>
       
   189       </table>
       
   190       
       
   191     </td>
       
   192   </tr>
       
   193 </table>
       
   194 <!-- ==================== VARIABLES ==================== -->
       
   195 <a name="section-Variables"></a>
       
   196 <table class="summary" border="1" cellpadding="3"
       
   197        cellspacing="0" width="100%" bgcolor="white">
       
   198 <tr bgcolor="#70b0f0" class="table-header">
       
   199   <td colspan="2" class="table-header">
       
   200     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   201       <tr valign="top">
       
   202         <td align="left"><span class="table-header">Variables</span></td>
       
   203         <td align="right" valign="top"
       
   204          ><span class="options">[<a href="#section-Variables"
       
   205          class="privatelink" onclick="toggle_private();"
       
   206          >hide private</a>]</span></td>
       
   207       </tr>
       
   208     </table>
       
   209   </td>
       
   210 </tr>
       
   211 <tr>
       
   212     <td width="15%" align="right" valign="top" class="summary">
       
   213       <span class="summary-type">&nbsp;</span>
       
   214     </td><td class="summary">
       
   215         <a name="VARIANT_ID_KEY"></a><span class="summary-name">VARIANT_ID_KEY</span> = <code title="'variant.id'">'variant.id'</code>
       
   216     </td>
       
   217   </tr>
       
   218 <tr>
       
   219     <td width="15%" align="right" valign="top" class="summary">
       
   220       <span class="summary-type">&nbsp;</span>
       
   221     </td><td class="summary">
       
   222         <a name="VARIATION_DIR_KEY"></a><span class="summary-name">VARIATION_DIR_KEY</span> = <code title="'variation.dir'">'variation.dir'</code>
       
   223     </td>
       
   224   </tr>
       
   225 </table>
       
   226 <!-- ==================== NAVIGATION BAR ==================== -->
       
   227 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   228        bgcolor="#a0c0ff" cellspacing="0">
       
   229   <tr valign="middle">
       
   230 
       
   231   <!-- Tree link -->
       
   232       <th>&nbsp;&nbsp;&nbsp;<a
       
   233         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   234 
       
   235   <!-- Index link -->
       
   236       <th>&nbsp;&nbsp;&nbsp;<a
       
   237         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   238 
       
   239   <!-- Help link -->
       
   240       <th>&nbsp;&nbsp;&nbsp;<a
       
   241         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   242 
       
   243       <th class="navbar" width="100%"></th>
       
   244   </tr>
       
   245 </table>
       
   246 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   247   <tr>
       
   248     <td align="left" class="footer">
       
   249     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:16 2009
       
   250     </td>
       
   251     <td align="right" class="footer">
       
   252       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   253     </td>
       
   254   </tr>
       
   255 </table>
       
   256 
       
   257 <script type="text/javascript">
       
   258   <!--
       
   259   // Private objects are initially displayed (because if
       
   260   // javascript is turned off then we want them to be
       
   261   // visible); but by default, we want to hide them.  So hide
       
   262   // them unless we have a cookie that says to show them.
       
   263   checkCookie()
       
   264   // -->
       
   265 </script>
       
   266   
       
   267 </body>
       
   268 </html>