|
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>Dictionary 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>Dictionary XML File</h1><div class="section"> |
|
27 <h2>Purpose</h2><p> |
|
28 You can use the Dictionary XML to provide abbreviations and other short forms for specific words. |
|
29 The system model generator will create a <a href="Localisation-XMLFile.html">Localization XML</a> file from this when creating the system model.</p> |
|
30 |
|
31 |
|
32 <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> |
|
33 |
|
34 </div> |
|
35 <div class="section"> |
|
36 <h2>Syntax</h2> |
|
37 <div class="Example"><code class="xml"><?xml version="1.0"?> |
|
38 <br><dict> |
|
39 <div class="indent"><word term="<var>term</var>" <span class="opt">d="<var>display-form</var>"</span> <span class="opt">abbrev="<var>abbreviation</var>"</span> <span class="opt">s="<var>short-form</var>"</span>/> |
|
40 <br> <word …/> |
|
41 <br> … |
|
42 </div></dict></code></div> |
|
43 |
|
44 <p>The root element <code>dict</code> takes no attributes. the <code>word</code> element specifies a word, and three forms of information: |
|
45 </p><ol> |
|
46 <li> |
|
47 <p> |
|
48 <strong>A display form</strong> |
|
49 </p> |
|
50 </li> |
|
51 |
|
52 <li> |
|
53 |
|
54 <p> |
|
55 <strong>An abbreivation</strong> |
|
56 </p> |
|
57 </li> |
|
58 |
|
59 <li> |
|
60 |
|
61 <p> |
|
62 <strong>A short form</strong> |
|
63 </p> |
|
64 </li> |
|
65 |
|
66 </ol> |
|
67 |
|
68 <p>The element <code>word</code> can takes these attributes: |
|
69 </p><ul> |
|
70 <li> |
|
71 <p> |
|
72 <code class="xml">term="<var>term</var>"</code>: This is the term which is to be abbreviated. It's case sensitive and should apper the same way it appears in the system defiition <code>name</code> attribtues. Spaces are not valid, only a single word can be used. |
|
73 </p> |
|
74 </li> |
|
75 |
|
76 <li> |
|
77 <p> |
|
78 <code class="xml">d="<var>display-form</var>"</code>: An optional attribute specifing how the term will be displayed if there is enough space. This is where you would show the hyphenation or other special character replacements. This will almost always be the full length word, but with added soft hyphens. For example<br/> |
|
79 <code class="xml"><word term="Interface" d="Inter&#xad;face"/><br/> |
|
80 <word term="and" d="&amp;"/></code>. |
|
81 </p> |
|
82 </li> |
|
83 |
|
84 <li> |
|
85 <p> |
|
86 <code class="xml">abbrev="<var>abbreivation</var>"</code>: An optional attribute specifing a shorter abbreviation for the term which can be used if there is insufficient space for the display form. |
|
87 This will often be used in combination with <code>d</code>, but is not required to be. |
|
88 For example<br/> |
|
89 <code class="xml"><word term="Supplementary" d="Suppl."/><br/> |
|
90 <word term="Documentation" d="Docs"/></code>. |
|
91 </p> |
|
92 </li> |
|
93 <li> |
|
94 <p> |
|
95 <code class="xml">s="<var>short-form</var>"</code>: An optional attribute specifing the shortest possible form of the term that still makes sense. |
|
96 This will be used when space is very low. |
|
97 This can be used instead of <code>abbrev</code> or in addition to it. |
|
98 For example<br/> |
|
99 <code class="xml"><word term="Hardware" s="HW"/><br/> |
|
100 <word term="Database" abbrev="Dbase." s="DB"/></code>. |
|
101 </p> |
|
102 </li> |
|
103 |
|
104 |
|
105 </div> |
|
106 <div class="section"> |
|
107 <h2>Example</h2> |
|
108 <div class="Example"><code class="xml"><?xml version="1.0" ?> |
|
109 <br><dict> |
|
110 <div class="indent"> |
|
111 <word term="Multimedia" d="Multi&#xad;media" s="MM"/> |
|
112 <br/> <word term="Frameworks" d="Frame&#xad;works" abbrev="Fmwks." s="FW"/> |
|
113 <br/><word term="Framework" d="Frame&#xad;work" abbrev="Fmwk." s="FW"/> |
|
114 <br/><word term="Adaptation" abbrev="Adapt." d="Adapta&#xad;tion"/> |
|
115 <br/><word term="Bluetooth" d="Blue&#xad;tooth" abbrev="Btooth." s="BT"/> |
|
116 <br/><word term="Localization" d="Localiz&#xad;ation"/> |
|
117 <br/><word term="Communications" d="Communi&#xad;cations" abbrev="Comms"/> |
|
118 <br/><word term="Provisioning" d="Provision&#xad;ing" s="Prov."/> |
|
119 <br/><word term="Phonebook" d="Phone&#xad;book" s="Phbk."/> |
|
120 </div></dict></code></div></div> |
|
121 <div class="section"> |
|
122 <h2> See also</h2><p> |
|
123 <a href="System-Info-XMLFile.html#SystemInfoXML">SystemInfo XML File</a> |
|
124 </p><p> |
|
125 <a href="Localisation-XMLFile.html">Localization XML File</a> |
|
126 </p><p> |
|
127 <a href="Dependencies-sysinfo.html">Dependencies Sysinfo File</a> |
|
128 </p><p> |
|
129 <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> |
|
130 </p></div> |
|
131 </div> |
|
132 |
|
133 </div> |
|
134 <div id="printer_copyright"> |
|
135 <div id="printer_copyright_padding"> |
|
136 Copyright ©2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. License: <a href="http://www.symbianfoundation.org/legal/sfl-v10.html">SFL</a> |
|
137 </div> |
|
138 </div> |
|
139 </div> |
|
140 </div> |
|
141 </div> |
|
142 </td> |
|
143 </tr> |
|
144 </table> |
|
145 <div style="clear: both"></div> |
|
146 </div> |
|
147 <div id="includedFooter"> |
|
148 <div id="devnet_footer"> |
|
149 <div style="float: left;">Copyright ©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> |
|
150 <div id='BUILD_VERSION'></div> |
|
151 </div> |
|
152 </div> |
|
153 </body> |
|
154 </html> |