iConsole Search Definition Reference Guide › Localization › Dictionary Format

Dictionary Format

The format of the dictionary xml files is illustrated in the following example. The root element is 'strings' and this contains elements for each search parameter that has terms to be translated. Since element names cannot contain spaces or other special characters; these need to be expanded into a hexadecimal format as illustrated by the element for the 'Standard Search'.

Within these elements are the terms to be translated and correspond to attributes of the search definition parameters. This generally only involves label, description and tooltip attributes, and option elements for list parameters.

Where a dictionary file includes terms for several searches, common terms only need to be defined once. However, if different text is required for a particular search, the term can be prefixed with the name of the search, as for the 'subject' term for the 'My Search' search in the example.

<?xml version="1.0" encoding="utf-8"?>
<strings>
  <Standard_x0020_Search>
  <label>Recherche Standard</label>
    <description>La Recherche de Norme d'iConsole du but général de chercher tous les types d'événement.</description>
  </Standard_x0020_Search>
  <My_x0020_Search>
    <label>Ma Recherche</label>
    <description> Ma propre recherche.</description>
  </My_x0020_Search>
  <subject>
    <label>Sujet</label>
  </subject>
  <My_x0020_Search.subject>
    <label>Sujet de Ma Recherche</label>
  </My_x0020_Search.subject>
  <choTypes>
    <tooltip>Choisissez s'il faut pénétrer par les types d'événement</tooltip>
    <option value="0">Tous les Types d'Événement</option>
    <option value="1">Filtre par le Type</option>
  </choTypes>
...
</strings>

To simplify the production of dictionary files, there is an XSL transform available which will take a search definition xml file as input and produce a dictionary file as output. This transform is called SD-to-i18n-dict.xsl and can be found in the Webservice/transformations folder.