Dictionary Configuration File

Dictionary configuration file has .cfg extension and it is stored in the same directory as the other dictionary related files. It contains specific information about one dictionary. Data in this file are XML structured.

1. Global dictionary information

There are following global tags in the configuration file:

NAME - a full name of the dictionary, this name is visible, e.g. on the top of the dictionary sub-window in the application.
SHORT_NAME - a short name of the dictionary. This name is not used at the time.
LANG - a language of the dictionary. This information is not used at the time, but in future it can serve e.g. as an indicator for the morphological searching, translation support, etc.
CHARSET - a name of a character set indicating the encoding of the dictionary. This information is necessary for correct manipulation of a dictionary in Windows systems. Possible values are
ASCII, ISO-8859-{1,2,3,4,5,7,9,10,13,14,15,16}, KOI8-R, KOI8-U, KOI8-RU, CP{1250,1251,1252,1253,1254,1257}, CP{850,866}, Mac{Roman,CentralEurope,Iceland,Croatian,Romania}, Mac{Cyrillic,Ukraine,Greek,Turkish}, Macintosh, ISO-8859-{6,8}, CP{1255,1256}, CP862, Mac{Hebrew,Arabic}, EUC-JP, SHIFT-JIS, CP932, ISO-2022-JP, ISO-2022-JP-2, ISO-2022-JP-1, EUC-CN, HZ, GBK, GB18030, EUC-TW, BIG5, CP950, BIG5-HKSCS, ISO-2022-CN, ISO-2022-CN-EXT, UC-KR, CP949, ISO-2022-KR, JOHAB, ARMSCII-8, Georgian-Academy, Georgian-PS, TIS-620, CP874, MacThai, uleLao-1, CP1133, VISCII, TCVN, CP1258, HP-ROMAN8, NEXTSTEP

MAIN_TAG - a tag which will be taken as a default one in dictionary queries.

MAX_QUERY - maximum number of displayed entries after a query is entered

2. Visual definitions

The VISUAL tag contains so called Visual definitions. Every definition is a receipt for displaying one entry of a dictionary. Definitions are enclosed in tags corresponding to their names. VisDic uses primarily two types of definitions. The first type is called VISDIC_SHORT and it shows the entry in a short format. This is used e.g. for displaying all entries matching the query or in a tree view. The second one shows entry in a more descriptive view. You can use that type of definition e.g. in a user text view.

Every tag in the XML file can be displayed its own way. The definition containes C-like string format consisting of a string in a double quotation marks and other parameters. These parameters have the following meaning:

%c - color name (taken from visdic.cfg), changes the actual color
%f - font name (taken from visdic.cfg), changes the actual font
%s - string, it can be @tag:name - a tag name or @tag:value - a tag value.
%i - including subtags

The tag is specified by comma separated tag names. If you omit a tag name and write * instead, it means, that there any tag on the specific level can be presented. The DEFAULT tag stands for every tag and it is used for tags that have not their own definitions.

The NESTED_END tag has also a special meaning. Inside it, there can be stored the same tags as in the visual definition. However, this definition will be used when it is needed to print something in addition at the end of the entry, typically after all its children is printed. This tag can be suitable for some functions described below.

3. Views

The View section specify a notebook design. It contains LIST tags corresponding to pages. Every page has its own name in NAME tag and its own type in TYPE tag. The type can be XML, USER, TREE, EDIT, WORD or ENTR:

XML view has no other options. It just displays the XML structure of an entry.
USER type has DEF tag referencing the visual definition of the page.
TREE type contains two tags specifying a parent and children tags in XML file. Those information are stored in PARENT tag and CHILD tag respectively.
EDIT type contains ITEM tags or BUTTON tags. Items are referencing XML tags in TAG tag, each has its own head label in HEAD tag and its own type in TYPE tag. The only possible value of type is TREE at the time. You can specify, whether the editation box for the tag is a single line (ENTRY) or a multi line (TEXT) entry in EDIT tag. All editation boxes used for changing the link or reverse link tags (see Dictionary definition) will be displayed as combo boxes and supported by a button on the right side of the box, which allows the user to transport to the referenced entry. All editation boxes or combo boxes which represent the tag that can occur more than once will be supported by two other buttons signed with + and -. Those buttons are used for adding another instance of the tag or removing the current instance of a tag. Buttons have their own labels specified in a TEXT tag and their own types in a TYPE tag. The type can be either NEW for creating the new entry, DELETE for deleting the actual entry or UPDATE for updating the actual entry.
WORD type contains TAG tag. This type of view is represented by a list of all words placed in a dictionary as the value of the given tag.
ENTR type displays all entries meeting some condition. The condition is given by a query in a QUERY tag.

4. Main menu configuration

The Menu section specify a special items which can be added to the VisDic Main Menu. These items are stored in the MENU tag. At the time, you can append functions described in the following sub-chapters. All functions will be appended to the "Dictionary" sub-menu.

4.1 Finding duplicate entries

This function is able to find duplicate values within the dictionary, either in entries or just in one entry. The function definition is enclosed in DUPL tag. The TYPE tag specifies the type of comparing - ENTR for comparing entries or ITEM for comparing items in the range of one entry. The NAME contains a name of function, which will be displayed in Menu. In the TAGS tag you can specify all tags, according to which the comparison will be processed. Individual tags must be divided by | sign. If the tag begins with a dot (.), then the tag is considered as the subtag enclosed in the previous tag.

Examples:

  <DUPL>
    <TYPE>ENTR</TYPE>
    <NAME>Check duplicate ILI numbers</NAME>
    <TAGS>SYNSET.ILI</TAGS>
  </DUPL>

This function searches all entries (synsets in WordNet) having the same SYNSET.ILI value.

```
  <DUPL>
    <TYPE>ENTR</TYPE>
    <NAME>Check duplicate literals & senses</NAME>
    <TAGS>SYNSET.SYNONYM.LITERAL|.SENSE</TAGS>
  </DUPL>
```
This function searches all pairs literal:sense in WordNet stored in more than one synset. Notice that the .SENSE specifies, that a value of this tag is taken from SYNSET.SYNONYM.LITERAL.SENSE nested in the current SYNSET.SYNONYM.LITERAL tag. Therefore, if you have the following XML structure
```
  <SYNSET>
    <SYNONYM>
      <LITERAL>A<SENSE>1</SENSE></LITERAL>
      <LITERAL>B<SENSE>2</SENSE></LITERAL>
    </SYNONYM>
  </SYNSET>
```
you will get just two pairs A:1 and B:2, but not A:2 or B:1.

  <DUPL>
    <TYPE>ITEM</TYPE>
    <NAME>Check duplicate synset literals</NAME>
    <TAGS>SYNSET.SYNONYM.LITERAL</TAGS>
  </DUPL>

This function searches all literals in WordNet occuring more than once in one entry (synset).

4.1 Exporting a dictionary according to a tree structure

Using this function you can export all the dictionary according to a tree structure. The function is enclosed in the EXP_TREE tag. The NAME tag specifies a name of the function which will be displayed in Menu. FILE contains a default name of the exported file. PARENT and CHILD tags specify tags according to which the parent and children entries will be searched. DEF tag contains a name of visual definition (see chapter 2). At the end of each entry, the definition present in the NESTED_END tag of the visual definition is printed. The LINE tag tells, whether the end-of-line mark is appended after the entry is written. The TABS tag tells, whether each entry is prefixed by double spaces corresponding to its level of depth in a tree.

Example:

  <EXP_TREE>
    <NAME>	Export HH Tree ILIs	</NAME>
    <FILE>	wn_gr_HH.xml		</FILE>
    <PARENT>	SYNSET.HYPERONYM	</PARENT>
    <CHILD>	SYNSET.HYPONYM		</CHILD>
    <DEF>		EXTR_ILI		</DEF>
    <LINE>	YES			</LINE>
    <TABS>	YES			</TABS>
  </EXP_TREE>

and the visual definition

  <EXTR_ILI>
    <DEFAULT>""</DEFAULT>
    <SYNSET.ILI>"\<ILI\>%s",@tag:value</SYNSET.ILI>
    <NESTED_END>
      <DEFAULT>""</DEFAULT>
      <SYNSET.ILI>"\</ILI\>"</SYNSET.ILI>
    </NESTED_END>
  </EXTR_ILI>

will print the entry having SYNSET.ILI value 00000001-n referrencing by SYNSET.HYPONYM relation to a synset having SYNSET.ILI value 00000002-n the following way:

  <ILI>00000001-n
    <ILI>00000002-n</ILI>
  </ILI>

5. Example of Dictionary Configuration File

<CONFIG>
  <NAME>       Greek WordNet           </NAME>
  <SHORT_NAME> GR                      </SHORT_NAME>
  <LANG>       GR                      </LANG>
  <CHARSET>    ISO-8859-7              </CHARSET>
  <MAX_QUERY>  100                     </MAX_QUERY>
  <MAIN_TAG>   SYNSET.SYNONYM.LITERAL  </MAIN_TAG>

  <VISUAL>
    <VISDIC>
      <DEFAULT>""</DEFAULT>
      <SYNSET.BASE>"%c%s%c",RED,@tag:value,BLACK</SYNSET.BASE>
      <SYNSET.POS>"%cSynonyms: %c[%s]",BLACK,BLUE,@tag:value</SYNSET.POS>
      <SYNSET.SYNONYM>
        " %i%c.\\n",BLACK,BLACK
        <LITERAL>
          "%c%s:%i\\{*%c, \\}",BLUE,@tag:value,BLACK
       	  <SENSE>
  	    "%s",@tag:value
  	  </SENSE>
        </LITERAL>
      </SYNSET.SYNONYM>
      <SYNSET.ILI>
        "%cILI: %s\\n",BLACK,@tag:value
      </SYNSET.ILI>
      <SYNSET.GLOSS>
        "%cGloss: %c%s\\n",BLACK,DARK_RED,@tag:value
      </SYNSET.GLOSS>
      <SYNSET.ENGLOSS>
        "%cEnglish Gloss: %c%s\\n",BLACK,DARK_RED,@tag:value
      </SYNSET.ENGLOSS>
      <SYNSET.HYPERONYM>
        "%cHyperonym: %c%s\\n",BLACK,BLUE,@tag:value
      </SYNSET.HYPERONYM>
      <SYNSET.HYPONYM>
        "%cHyponym: %c%s\\n",BLACK,BLUE,@tag:value
      </SYNSET.HYPONYM>
    </VISDIC>

    <VISDIC_SHORT>
      <DEFAULT>""</DEFAULT>
      <SYNSET.BASE>"%s",@tag:value</SYNSET.BASE>
      <SYNSET.POS>"[%s] ",@tag:value</SYNSET.POS>
      <SYNSET.SYNONYM>"%i"
        <LITERAL>
          "%s:%i\\{*, \\}",@tag:value
       	  <SENSE>"%s",@tag:value</SENSE>
        </LITERAL>
      </SYNSET.SYNONYM>
    </VISDIC_SHORT>

    <EXTR_ILI>
      <DEFAULT>""</DEFAULT>
      <SYNSET.ILI>"\<ILI\>%s",@tag:value</SYNSET.ILI>
      <NESTED_END>
        <DEFAULT>""</DEFAULT>
        <SYNSET.ILI>"\</ILI\>"</SYNSET.ILI>
      </NESTED_END>
    </EXTR_ILI>
  </VISUAL>

  <VIEW>
    <LIST>
      <TYPE>  USER              </TYPE>
      <NAME>  View              </NAME>
      <DEF>   VISDIC            </DEF>
    </LIST>
    <LIST>
      <TYPE>   TREE             </TYPE>
      <NAME>   HH Tree          </NAME>
      <PARENT> SYNSET.HYPERONYM </PARENT>
      <CHILD>  SYNSET.HYPONYM   </CHILD>
    </LIST>
    <LIST>
      <TYPE>   EDIT             </TYPE>
      <NAME>   Edit             </NAME>
      <ITEM>
        <HEAD> Gloss            </HEAD>
        <TAG>  SYNSET.GLOSS     </TAG>
        <TYPE> TREE             </TYPE>
        <EDIT> ENTRY            </EDIT>
      </ITEM>
      <ITEM>
        <HEAD> Part of Speech   </HEAD>
        <TAG>  SYNSET.POS       </TAG>
        <TYPE> TREE             </TYPE>
        <EDIT> ENTRY            </EDIT>
      </ITEM>
      <ITEM>
        <HEAD> Synonyms         </HEAD>
        <TAG>  SYNSET.SYNONYM.LITERAL </TAG>
        <TYPE> TREE             </TYPE>
        <EDIT> ENTRY            </EDIT>
      </ITEM>
      <ITEM>
        <HEAD> Hyperonyms       </HEAD>
        <TAG>  SYNSET.HYPERONYM </TAG>
        <TYPE> TREE             </TYPE>
        <EDIT> ENTRY            </EDIT>
      </ITEM>
      <ITEM>
        <HEAD> Hyponyms         </HEAD>
        <TAG>  SYNSET.HYPONYM   </TAG>
        <TYPE> TREE             </TYPE>
        <EDIT> ENTRY            </EDIT>
      </ITEM>
      <BUTTON>
        <TYPE>  NEW             </TYPE>
        <TEXT>  New             </TEXT>
      </BUTTON>
      <BUTTON>
        <TYPE>  DELETE          </TYPE>
        <TEXT>  Delete          </TEXT>
      </BUTTON>
      <BUTTON>
        <TYPE>  UPDATE          </TYPE>
        <TEXT>  Update          </TEXT>
      </BUTTON>
    </LIST>
    <LIST>
      <TYPE>    WORD            </TYPE>
      <NAME>    Words           </NAME>
      <TAG>     SYNSET.SYNONYM.LITERAL  </TAG>
    </LIST>
    <LIST>
      <TYPE>    ENTR            </TYPE>
      <NAME>    Base Concepts   </NAME>
      <DEF>     VISDIC_SHORT    </DEF>
      <QUERY>   SYNSET.BASE="*" </QUERY>
    </LIST>
    <LIST>
      <TYPE>    XML             </TYPE>
      <NAME>    XML             </NAME>
    </LIST>
  </VIEW>

  <MENU>
    <EXP_TREE>
      <NAME>	Export HH Tree ILIs	</NAME>
      <FILE>	wn_cz_HH.xml		</FILE>
      <PARENT>	SYNSET.HYPERONYM	</PARENT>
      <CHILD>	SYNSET.HYPONYM		</CHILD>
      <DEF>	EXTR_ILI		</DEF>
      <LINE>	YES			</LINE>
      <TABS>	YES			</TABS>
    </EXP_TREE>

    <EXP_TREE>
      <NAME>	Export readable HH Tree	</NAME>
      <FILE>	wn_cz_HH_text.xml      	</FILE>
      <PARENT>	SYNSET.HYPERONYM	</PARENT>
      <CHILD>	SYNSET.HYPONYM		</CHILD>
      <DEF>	VISDIC_SHORT		</DEF>
      <LINE>	YES			</LINE>
      <TABS>	YES			</TABS>
    </EXP_TREE>

    <DUPL>
      <TYPE>ENTR</TYPE>
      <NAME>Check duplicate ILI numbers</NAME>
      <TAGS>SYNSET.ILI</TAGS>
    </DUPL>

    <DUPL>
      <TYPE>ENTR</TYPE>
      <NAME>Check duplicate literals & senses</NAME>
      <TAGS>SYNSET.SYNONYM.LITERAL|.SENSE</TAGS>
    </DUPL>

    <DUPL>
      <TYPE>ITEM</TYPE>
      <NAME>Check duplicate synset literals</NAME>
      <TAGS>SYNSET.SYNONYM.LITERAL</TAGS>
    </DUPL>
  </MENU>
</CONFIG>

Feel free to ask me about VisDic via e-mail tomaspavelek@lycos.co.uk.