sysmodellibs/sysmodelgen/doc/sysmodel/SMG-Input-Files/Localisation-XMLFile.html
changeset 7 3c36c452f013
equal deleted inserted replaced
6:5b32dc297d05 7:3c36c452f013
       
     1 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
       
     2     <!-- Generated by Xbuild version: 5.0.20 -->
       
     3     <head>
       
     4         <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
       
     5 	<meta name="show-comments" content="" />
       
     6 	<title>Localization XML File in System Model Generator Input Files</title>    
       
     7 	<link href="../../_stock/css/reset.css" rel="stylesheet" type="text/css" />
       
     8 	<link href="../../_stock/css/portal.css" rel="stylesheet" type="text/css" />
       
     9 	<link href="../../_stock/css/iefix.css" rel="stylesheet" type="text/css" />
       
    10 	<link href="../../_stock/css/ui.tabs.css" rel="stylesheet" type="text/css" />
       
    11 	<link href="../../_stock/css/developer.css" rel="stylesheet" type="text/css" />
       
    12 	<link rel="stylesheet" type="text/css" href="../../_stock/css/ui.css" media="screen" />
       
    13 	<link rel="stylesheet" type="text/css" href="../../_stock/css/sysdoc.css" media="screen" />
       
    14 	<link rel="stylesheet" type="text/css" href="../../_stock/css/sdlplugin.css" media="screen" />
       
    15     </head>
       
    16     <body>
       
    17 	<div id="main_content">
       
    18 	    <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
    19 		<tr>
       
    20 		    <td valign="top" width="100%">
       
    21 			<div id="main_content_txt">
       
    22 			    <div class="main_content_padding">		
       
    23                                 <div id="main">
       
    24                                     <div id="authoredContent">
       
    25                                         <div class="section">
       
    26 <a name="Localisation"></a><h1>Localization XML File</h1><div class="section">
       
    27 <h2>Purpose</h2><p>
       
    28 		You can use the Localization XML file to customize the appearance of an
       
    29 		item name on the model. It enables you to perform the following tasks: 
       
    30 	  </p><ul> 
       
    31 		<li>
       
    32  
       
    33 		  <p>
       
    34 			Provide abbreviations of item names. For example,
       
    35 			&#8220;<code>Application Launch Services</code>&#8221;.  can appear as &#8220;<code>App. Launch
       
    36 			Services</code>&#8221;. 
       
    37 		  </p> 
       
    38 		</li>
       
    39  
       
    40 		<li>
       
    41  
       
    42 		  <p>
       
    43 			Include special characters in names, such as soft hyphens. For
       
    44 			example, "<code>Graphics Device Interface</code>" can appear as "<code>Graphics Dev&amp;#xad;ice Interface</code>". This allows the word to split across
       
    45 			multiple lines on the diagram if it is needed. 
       
    46 		  </p> 
       
    47 		</li>
       
    48  
       
    49 		<li>
       
    50  
       
    51 		  <p>
       
    52 			Provide a localized translation of a word. For example, "Device
       
    53 			Provisioning" can appear as "&#31471;&#26411;&#31649;&#29702;". 
       
    54 		  </p> 
       
    55 		</li>
       
    56  
       
    57 	  </ul>
       
    58 	  
       
    59 <p>If using the Localization XML file just to provide abbreviations, you may be better of using a <a href="Dictionary-XMLFile.html">Dictionary XML file</a> instead.</p>	  
       
    60 	  
       
    61 	  </div>
       
    62 <div class="section">
       
    63 <h2>Syntax</h2>
       
    64 <div class="Example"><code class="xml">&lt;?xml version="1.0"?&gt;  
       
    65 <br>&lt;display-names <span class="opt">xml:lang="<var>language-code</var></span> <span class="opt">id-namespace="<var>uri</var>"</span> <span class="opt"><var>&#133;namespaces&#133;</var></span> &gt;
       
    66 <div class="indent">    &lt;abbrev ref="<var>id</var>" abbrev="<var>abbreviation</var>"/&gt;
       
    67 <br>    &lt;abbrev name="<var>item-name</var>" abbrev="<var>abbreviation</var>"/&gt;
       
    68 <br>    &#133;
       
    69 </div>&lt;/display-names&gt;</code></div>
       
    70 
       
    71 <p>There are two ways to assign a localized name to a system model item. </p>
       
    72 <ol>
       
    73 <li><strong>By ID</strong> - you can use the <code>ref</code> attribute to specify the unique ID of a single system model item to rename.</li>
       
    74 <li><strong>By name</strong> - you can use the <code>name</code> attribute to specify that any system model item with that human-readable name will be renamed.</li>
       
    75 </ol>
       
    76 
       
    77 <p>The root element <code>display-names</code> can take these optional attributes: 
       
    78 	  </p><ul> 
       
    79 	  
       
    80 		<li>
       
    81 		  <p>
       
    82 			<code class="xml">xml:lang="<var>language-code</var>"</code>: This indicates that the file is for localisation and not just a set of abbreviations. 
       
    83 			The affects of setting this are: <ol>
       
    84 			<li>The xml:lang will be set to this value in the generated SVG. This lets you put CSS like this in the Shapes XML: 
       
    85 				<br/><code class="CSS">text.title:lang(jp) {letter-spacing: -0.15}</code><br/>
       
    86 				so that you can fine tune the diagram for different languages. 
       
    87 
       
    88 				</li>
       
    89 			<li>All generated numbers (eg when counting in the legend) will be localised (if possible) to this language.</li>
       
    90 			</ol>
       
    91 		  </p> 
       
    92 		</li>
       
    93 
       
    94 		<li>
       
    95 		  <p>
       
    96 			<code class="xml">id-namespace="<var>uri</var>"</code>: The default namespace for all <code>ref</code> attributes in the XML file. Has the same meaning, usage and default value as <code>id-namespace</code> in the <a href="http://developer.symbian.org/wiki/index.php/System_Definition/Root#Attributes">System Definition</a>.
       
    97 		  </p> 
       
    98 		</li>
       
    99 
       
   100 		<li>
       
   101 		  <p>
       
   102 			<code><var>namespaces</var></code>: Any namespace declaration should be done in the root element. ID references can use namespace prefixes to associate with system model items. See <a href="http://developer.symbian.org/wiki/index.php/System_Definition/Attributes#Namespacing_names">Namespacing names</A> in the System Definition specification.
       
   103 		  </p> 
       
   104 		</li>
       
   105 
       
   106 
       
   107 </div>
       
   108 <div class="section">
       
   109 <h2>Example</h2>
       
   110 <div class="Example"><code class="xml">&lt;?xml version="1.0" ?&gt; 
       
   111 <br>&lt;display-names xml:lang="jp"&gt;
       
   112 <div class="indent">   &lt;abbrev name="Device Provisioning" abbrev="端末管理" /&gt; 
       
   113 <br>  &lt;abbrev name="PIM App Support" abbrev="PIM アプリケーション・サポート" /&gt; 
       
   114 <br>        &lt;abbrev name="Multimedia" abbrev="マルチメディア" /&gt; 
       
   115 <br>  &lt;abbrev name="Messaging Application Support" abbrev="メッセージング・アプリケーション・サポート" /&gt; 
       
   116 <br>  &lt;abbrev name="Graphics" abbrev="グラフィックス" /&gt; 
       
   117 <br>  &lt;abbrev name="Application Framework" abbrev="アプリケーション・フレームワーク" /&gt;
       
   118 <br>  &lt;abbrev name="Plugin Compo&amp;#xad;nent" abbrev="プラグイン コンポーネント"/&gt;
       
   119 </div>&lt;/display-names&gt;</code></div></div>
       
   120 <div class="section">
       
   121 <h2> See also</h2><p>
       
   122 		<a href="System-Info-XMLFile.html#SystemInfoXML">SystemInfo XML File</a> 
       
   123 	  </p><p>
       
   124 		<a href="Dependencies-sysinfo.html">Dependencies Sysinfo File</a> 
       
   125 	  </p><p>
       
   126 		<a href="Values-XML-index.html#valuesxml" title="The Values XML files are used to define default and per-component display properties. You can use a values XML file to define colors, patterns, border shapes, or border styles of the components.">Values XML File</a> 
       
   127 	  </p></div>
       
   128 </div>
       
   129 
       
   130                                     </div>
       
   131                                     <div id="printer_copyright">
       
   132                                         <div id="printer_copyright_padding">
       
   133                                             Copyright &copy;2009  Nokia Corporation and/or its subsidiary(-ies). All rights reserved. License: <a href="http://www.symbianfoundation.org/legal/sfl-v10.html">SFL</a>
       
   134                                         </div>
       
   135                                     </div>
       
   136                                 </div>
       
   137 			    </div>
       
   138 			</div>
       
   139 		    </td>
       
   140 		</tr>
       
   141 	    </table>
       
   142 	    <div style="clear: both"></div>
       
   143 	</div>
       
   144 	<div id="includedFooter">
       
   145 	    <div id="devnet_footer">
       
   146             <div style="float: left;">Copyright &copy;2009  Nokia Corporation and/or its subsidiary(-ies). All rights reserved. License: <a href="http://www.symbianfoundation.org/legal/sfl-v10.html">SFL</a>. </div>
       
   147             <div id='BUILD_VERSION'></div>
       
   148 	    </div>
       
   149 	</div>
       
   150 </body>
       
   151 </html>