+
Dictionary XML File
+
Purpose
+ You can use the Dictionary XML to provide abbreviations and other short forms for specific words.
+ The system model generator will create a Localization XML file from this when creating the system model.
+
+
+
If using the Localization XML file just to provide abbreviations, you may be better of using a Dictionary XML file instead.
+
+
+
+
Syntax
+
<?xml version="1.0"?>
+
<dict>
+<word term="term" d="display-form" abbrev="abbreviation" s="short-form"/>
+
<word …/>
+
…
+
</dict>
+
+
The root element dict takes no attributes. the word element specifies a word, and three forms of information:
+
+ -
+
+ A display form
+
+
+
+ -
+
+
+ An abbreivation
+
+
+
+ -
+
+
+ A short form
+
+
+
+
+
+
The element word can takes these attributes:
+
+ -
+
+ term="term": 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 name attribtues. Spaces are not valid, only a single word can be used.
+
+
+
+ -
+
+ d="display-form": 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
+ <word term="Interface" d="Inter­face"/>
+ <word term="and" d="&"/>.
+
+
+
+ -
+
+ abbrev="abbreivation": An optional attribute specifing a shorter abbreviation for the term which can be used if there is insufficient space for the display form.
+ This will often be used in combination with d, but is not required to be.
+ For example
+ <word term="Supplementary" d="Suppl."/>
+ <word term="Documentation" d="Docs"/>.
+
+
+ -
+
+ s="short-form": An optional attribute specifing the shortest possible form of the term that still makes sense.
+ This will be used when space is very low.
+ This can be used instead of abbrev or in addition to it.
+ For example
+ <word term="Hardware" s="HW"/>
+ <word term="Database" abbrev="Dbase." s="DB"/>.
+
+
+
+
+
+
+
Example
+
<?xml version="1.0" ?>
+
<dict>
+
+ <word term="Multimedia" d="Multi­media" s="MM"/>
+
<word term="Frameworks" d="Frame­works" abbrev="Fmwks." s="FW"/>
+
<word term="Framework" d="Frame­work" abbrev="Fmwk." s="FW"/>
+
<word term="Adaptation" abbrev="Adapt." d="Adapta­tion"/>
+
<word term="Bluetooth" d="Blue­tooth" abbrev="Btooth." s="BT"/>
+
<word term="Localization" d="Localiz­ation"/>
+
<word term="Communications" d="Communi­cations" abbrev="Comms"/>
+
<word term="Provisioning" d="Provision­ing" s="Prov."/>
+
<word term="Phonebook" d="Phone­book" s="Phbk."/>
+
</dict>
+
+