Dictionary - use in HI process

In D2000 System application, there is possible to display some data in several languages. The feature is allowed by means of the program Dictionary.
Within the frame of the Dictionary, you can define languages, keywords and texts, which are assigned to individual keywords.

The procedure for defining your Dictionary is very simple. At first, you have to define the languages, which form the table columns (see the dialog box below). Then define the keywords (the column Key) and text (translations).
The keywords will be used for various definitions (e.g. object description, technical units, user tool description, ... - see the list at the end of the topic). According to your language selection, these definitions will be displayed as they are defined for particular language in the Dictionary.

In the configuration of user's parameters, you can either define the language for a user, or allow him/her to switch among the defined languages, or enable him/her editing the Dictionary.

To open Dictionary in the process D2000 HI:

1. Press the shortcut CTRL+L when you define a text in the input field (see the list at the end of the topic).

Example of the dictionary configuration in the D2000 system:

The dialog window is divided into following parts:

• Filter (1)
• Functional buttons (2)
• List of keywords or translations (3)
• Entry field to define keyword and translations (4)
• Information about keywords (5)

Filter

Filter enables to select the required list of keywords or translations from the dictionary.

Control buttons:

	Deletes a text from filter and cancels filtering.
	Creates keyword based on text in filter or enables editing the translation for selected language.

Functional buttons

	Opens dialog window List of keywords and translations.
	Opens dialog window containing detailed information.
	Deletes all keywords from dictionary.
	Deletes unused keywords from dictionary.
	Exports (saves) the dictionary into the *.csv file. The keys can be exported also with a time stamp modify time. Clicking on the export button the above mentioned modal window opens.
	Exports (saves) the used keywords into the *.csv file. The keywords can be exported also with a time stamp modify time. Clicking on the export button, the above mentioned window opens.
	Exports (saves) the unused keywords into the *.csv file. The keywords can be exported also with a time stamp modify time. Clicking on the export button, the above mentioned window opens.
	Exports (saves) the selected keys into the *.csv file. The keys can be exported also with a time stamp modify time. Clicking on the export button, the following modal window opens.
	Imports the dictionary from a file. Notes: 1. When exceeding the permitted number of languages, the user will be notified and the language is not created. The permitted number of languages is specified in your D2000 System Licence. 2. When the dictionary is imported without the time stamps, then the time stamps of the translation are set according to the import time or they are acquired from csv file. 3. When some error regarding a key length, a key validity (the key need not be enclosed by white spaces) or the time stamp validity occurs, the user must approve the import. If the import is aborted, no word is imported from csv file, otherwise only incorrect records are skipped at the import (a record = the key with translation). 4. Csv file, exported from Detailed information dialog box, may be also imported from this main dialog window.
	Defining the languages. Clicking the button opens the dialog window for defining the languages.

List of keywords or translations

The contents of the list depend on the filter - keywords or languages variations.
If the list contains the keywords, it is able to change their names. When editing the key, there may occur these colors:

• Black – original name,
• Blue – new, nonexistent name,
• Purple – new name already exists,
• Red - text does not match the conditions for keyword name, a blank space is either at the beginning or end of text.

The background of new keywords is light blue.

Entry field to define keyword and translations

When creating the new key, a user must enter the name and translations into the text field. Over the text field, there are these buttons:

	Key into object - this button is enabled only if there is a relation between dictionary and text entry field. This connection is created when pressing CTRL+L or clicking the special button. Then, the keyword will be entered into the field.
	References of key - opens the dialog window that displays the list of objects, which use the given key.
	Deletes the key from dictionary.

Below the text field, there is list of translations in various languages. The translations may be edited in this list.

Information about keywords

In the bottom of dialog window, there is this information:

• Number of current page (number of keys on the page) / number of pages, e.g. 1(200)/75.
• Total number of keys (+keys that are used in the application / -keys that are not used in the application), e.g. 14896 (+3220/-11676).

The arrow keys are used to navigate between the pages.

Controlling dictionary

Adding keyword into dictionary

1. Click Create key.
2. Enter the name of key into the text field in the part for defining the keywords and translations. If the name does not already exist, it has a blue color. This key will be created when at least one translation is defined. Providing that the keyword already exists, the text is black and the translations are automatically showed. Red text means that the text does not match the conditions for keyword name, a blank space is either at the beginning or end of text.
3. Enter the translations of given key in the part Translations.
4. After entering the new key, the field has turquoise background.

List editing

The each record can be edited directly in the list. Click on particular cell to edit key or the translation. The edited records (rows) are highlighted in yellow colour. This change of key word / translation will become evident automatically, any confirmation by a button is not required.

Sorting columns

Clicking on the column header on the left, the data in table are arranged upwardly, next clicking arranges data downwardly. The icon in the column header shows the word order in column (ascending/descending).

Keyword usage

When you configure texts, which are presented to users, you can enter a keyword. This keyword will be replaced by corresponding text from the Dictionary according to the language setting for the logged on user.
If there is no language defined for user, then replacing keywords from the Dictionary is disabled.

Keywords are inserted by using the string {!}.

Example:

The string {!DB} displays the following text:

• for Slovak language: Databáza
• for Czech language: Databaze
• for English language: Database

When you want to use such keywords in configuration, use the keyboard CTRL+L to open the Dictionary, when the mouse cursor is in the input edit field. When you press the shortcut:

1. out of the brackets {!} -  select the key in the Dictionary and the key will be inserted on the current cursor position and the Dictionary will be closed,
2. between the brackets {!} containing an existing key - the Dictionary automatically finds the key,
3. between the brackets {!} not containing an existing key - the Dictionary automatically provides the possibility to create the key you entered.

Keywords defined in the Dictionary can be used when you configure the following texts in process D2000 HI:

• graphs, reports and compositions - the parameter Description,
• graphs - the parameter Axis description in the Axis configuration dialog box and the parameter Description in the Object configuration dialog box,
• when configuring External tools in D2000 HI - the column Description,
• console (or user) preferences, the parameter groups Critical alarms and Uncritical alarms - the parameter Tab name,
• console (or user) preferences, the parameter group Logging - tooltips for the buttons in the User toolbar.