= DEBVisDic Manual =

[[PageOutline]]

= Installation of Debvisdic =

== How to install DEBVisDic ==

 * you may see http://nlp.fi.muni.cz/projects/deb2/install.html
 * [http://www.mozilla.com/firefox Mozilla Firefox] has to be installed first in an usual way (you download it using Google first)
 * When Firefox is installed go to the following address: http://nlp.fi.muni.cz/projekty/deb2/clients/
 * Click on ''DEBVisDic''
 * ''Note:'' Before the first installation, you need to add our site nlp.fi.muni.cz to the list of sites allowed for installing. The dialog for adding the site to the list appears the first time you click on any installation package (at our site). Then you must Allow the site and next time you click on the package, you can begin the real installation.
[[Image(manual-allow1.png, 350, top)]]
[[Image(manual-allow2.png, 350, top)]]
 * a window will open with 3 packages - click on ''Install'' 
[[Image(manual-install1.png)]]
 * close all windows in Firefox (with {{{File -> Quit}}})
 * start Firefox again and DEBVisDic should appear as a new menu entry in Firefox {{{Tools}}} 

== First start ==

 * Click on {{{Tools -> DEBVisDic}}}
 * Log-in with your username and password
 * DEBVisDic will automatically install packages for all the !WordNets you have access to
 * Close DEBVisDic and all Firefox windows (with {{{File -> Quit}}})
 * Run DEBVisDic (for example, click on {{{Tools -> DEBVisDic}}} in Firefox)
 * Log-in with your username and password
 * You will see long and narrow DEBVisDic window

== Choose !WordNets == 

 * Click on {{{Settings -> Preferences}}}
 * Upper part of the window contains list of !WordNets available to you. Select the packages in the left list (Ctrl+click, Shift+click to select multiple packages) and click the ''Add'' button. You can ''Add'' one !WordNet several times, you'll get more windows for the same dictionary.
 * Click OK and selected !WordNets will open
 * Now you can start working
[[Image(manual-prefs.png)]]


== How to uninstall/remove DEBVisDic ==

 * run Firefox (without the {{{-chrome}}} option)
 * in {{{Tools -> Extensions}}} (or {{{Add-ons}}}) select all DEBVisDic
   packages ({{{debvisdic}}}, {{{jslib}}}, and {{{wn...}}} for each
   wordnet) and Uninstall them

= Short overview =

== Interface description (main components) ==

Each !WordNet client is opened in its own dictionary, you can arrange those windows as you like on your desktop,
or you can select one of the options in the ''Windows'' menu of DEBVisDic main window to arrange windows automatically.

[[Image(manual-wn1.png)]]

'''1: Search query'''

Enter the search query into this box (previously used queries are automatically offered).
The ''Search'' button will run the query only in the actual !WordNet window,
while the ''Search in all'' wiil run the same query in all open windows.
Query possibilities are listed in section [#Searchqueries Search, queries]

'''2: Result list'''

List of synstes found as a result of the query. Each line represents one synsets - PoS and list of literals.
Click on a synset to display detailed information in the bottom part of the window.


'''3: Synset information'''

This part of window contains several ''tabs'', by clicking on them you'll get detailed information about selected synset.

== Synset information, tabs ==
 * Preview - text preview of a given synset. When you click on a synset link (for example hypernym), linked synset is selected and its information displayed.
 * Tree - hypernym/hyponym tree related to given synset. By default, selected synset is displayed plus all the hypernyms to the topmost one. By clicking on the ![+] button in front of synset name in tree, the synset hyponyms are displayed. You can also click on ![-] button to hide tree levels below. When you click on ![+] again, all the hyponyms of synset are displayed.
 * Rev(ersed) Tree - basically, the same tree as before, only reversed upside-down. This time, hyponyms are up and hypernyms down.
 * Edit - form for synset editing and adding, see section [#Editingfunctions Editing functions]
 * XML - synset displayed in XML format

== Search, queries ==

=== Query language ===

=== Advanced queries ===

== Inter-!WordNet functions ==

== Editing functions ==

=== Writing a new synset ===

=== Changing the existing synset ===

=== Inter-!WordNet functions - linking to other !WordNets ===

=== Relations editing ===

===  Locking synsets ===

= Typical errors =
 * Do not try to write a new synset on the first top line (box). To enter a new synset you have to open the ''Edit'' tab.
 * When entering a relation between two synsets or linking two synsets via ILI, always check whether they both exist.
 * Do not forget to click on the ''New'' button when entering a new synset and the ''Save'' button when you want to store it. If you do not click the ''Save'' button, nothing will be stored.
 * Avoid entering one synset twice or more times.


= Linguistic recommendations =
 * Use a synonymical dictionary if it exists for a given language.
 * A good explanatory dictionary of a given language should be used for establishing hyperonym relations on the first level, e.g ''chair'' is a ''piece of furniture''.
 * To find reliable translation equivalents use parallel corpora.


= How to write a synset? =
 * You decide what literals a synset will consist of and what part of speech it belongs to: noun (n), verb (v), adjective (a) or adverb (b)
 * When you open the ''Edit'' tab, click on ''New'', then type down a respective literal (one or more), assign it a symbol of PoS and click ''Save''.
 * If you do not click ''Save'', all what you wrote will be lost.


= Numbering senses =
 * A new synset (in fact, any synset) has to be always numbered, i.e. you have to provide a sense number for it. 
 * Sense number distinguishes the different senses of synset, e.g.  ''bank:1'' - financial institution, ''bank:2'' as in "river bank". 
 * It is usual as you can observe in Princeton !WordNet (v. 2.0 and higher) to assign lower numbers (1, 2, 3) to the basic senses.
 * It can be seen that senses in PWN 2.0 are quite often too fine grained - see e.g. verb ''to get'' with 36 senses. We recommend to translate only the senses that can be confirmed in a corpus.

= Eq_Relations, IL relations, ILI =

= Glossary of basic terms =
 * synset 
 * literal 
 * sense
 * IL relations: synonymy, antonymy, hyperonymy/hyponymy, holo/meronymy, deriv
 * EQ_relations
 * Interlingual Index
 * Set of Base Concepts
 * Top Ontology
 * ...