%iso8859-1
*English
Morphological Dictionary Acquisition Tool

Contents
 1. Introduction
 2. Loading the guesses file.
 3. Producing descriptions in mmorph format
 4. Saving descriptions in a file.
 5. Customization


1. Introduction

The purpose of this tool is to assist in gathering data for a
morphological dictionary. It is assumed that a morphological
dictionary for a given language already exists, and that it was
created using mmorph - a morphology tool developed at ISSCO, Geneva.
It is also assumed that you use fsa utilities available from
http://www.pg.gda.pl/~jandac/fsa.html .

In order to use this tool you need mmorph and fsa_guess, as well as a
guessing automaton for fsa_guess. You can produce that automaton with
fsa_build or fsa_ubuild, and prepare data for them with scripts
available from the same fsa utilities package.

The basic procedure is as follows:
a) Produce a guessing automaton from the dictionary. Consult the
   README file from the fsa utilities package, and manual pages for
   fsa_build(1), fsa_guess(1), and fsa_guess(5). You will also find
   appropriate scripts in the same package.
b) Produce a list of words not present in the dictionary. You can use
   fsa_spell for that purpose - consult the manual page for
   fsa_spell(1).
c) Run fsa_guess with the guessing automaton on the list of unknown
   words, and save the resulting file (the guesses).
d) You can use chkmorph.pl script to eliminate those guesses that
   do not produce the inflected form they are supposed to produce.
e) Load the guesses file to the Morphological Dictionary Acquisition Tool.
f) Use the Morphological Dictionary Acquisition Tool to produce
   descriptions in mmorph format
g) Save descriptions in a file.
h) Merge the new descriptions with existing ones

2. Loading the guesses file.

The guesses file can either be loaded using menus, or specified in the
command line, or using "Load new" button under the "Word form" window.
To load the file from menus, choose File/Open guesses, and then choose
appropriate file. To specify the file in the command line, use -G
guessesfile. It has to be capital G, as tcl/tk steel -g. To load
guesses using a button, just press it.

3. Producing descriptions in mmorph format

For each word form you are interested in, do:
a) Click the form. One or more descriptions should appear in
   the Descriptions' pane. 
b) Choose a description from the Descriptions' pane. If you are not
   sure which of them is correct, click on the description and press
   Mmorph button. All forms derived from that description should
   appear in the Mmorph output pane. If you cannot see the difference
   between two descriptions, choose both (use Control button) and
   press Mmorph button. The Mmorph pane should show the difference
   between forms produced by those descriptions. If you want to see if
   all required forms are generated, click on "yes" in the "Expand
   alternatives" field. Then if the description contains
   e.g. "case=nom|acc", i.e. more than one possible value, the
   description will be broken into two. The first one will contain
   "gen=mon", the second one -- "gen=acc".
c) If none of the descriptions in Descriptions pane is correct, you
   can correct it by clicking on Correct button. A new popup window
   will appear, in which you could make corrections. Another
   possibility is to correct entries that appear in the mmorph output
   window, and then to press mAtch mmorph. The tool will try to find
   the matching description. In order to do that, it needs additional
   information, usually found in the file "paradigm", or in another
   file that is specified with cusTomize/paradigm file. The first
   character of that file is a character that begins a comment (you
   can change it if you like). All lines in the file beginning with
   that character are ignored. Other lines are formed in three
   columns. The columns are separated with spaces or horizontal
   tabulation characters. The first column contains a part of speech
   (POS). The other two columns are relevant only for descriptions
   containing that POS. There can be more than one line with the same
   POS. The second column contains a regular expression. If the
   expression matches the description, then the third column contains
   a list of features, such that if we change their values, we might
   arrive at the correct description. A feature name can be followed
   with an asterisk. In that case all possible combinations of the
   values of that feature will be generated. If the correct
   description is found, the background color of the corrected entry
   will be changed to green. Notice that it may take some time, during
   which the mAtch mmorph button will still be pressed.
   You can also use guided correction. Press the right mouse button on
   the description you want to change.
d) Press the Save button. The description is added to a list of
   descriptions that will be saved at the end of the session
   (i.e. when you quit the tool). Depending on the "Save removes"
   radio buttons, saving the description removes all word forms
   generated by it from the word form pane, the current form (the one
   that was used for guessing), or none.

4. Saving descriptions in a file.

The descriptions are saved automatically when you quit by pressing on
the Exit button, or choosing Exit from the File menu. You can specify
the output file with -o command line option.

5. Customization

Command line options can be used to change the behavior of the
tool. Remember to separate the option from its value with a space.

You can change the language of menus, buttons, and labels by either
specifying the language in a command line using -l, or by choosing
Customize/Language menu entry. A description for that language must
exist in the language description file. The file itself may be
specified using -c command line option.

You can specify the font used for displaying word forms, descriptions,
and mmorph output either by choosing Customize/Font from the menus, or
with -f command line option.

You can specify the name of the file produced when pressing Mmorph
button, and being the input for mmorph so that it can expand it. You
can do that using -m command line option.

%iso8859-2
*Polski
Pozyskiwanie opisw morfologicznych

Spis treci
 1. Wprowadzenie
 2. Zaadowanie pliku podpowiedzi
 3. Tworzenie opisw w formacie programu mmorph
 4. Zachowanie opisw w pliku
 5. Dostosowanie do potrzeb uytkownika


1. Wprowadzenie

Celem narzdzia jest pomoc w zbieraniu danych dla potrzeb sownika
morfologicznego. Zakada si, e taki sownik ju istnieje i e zosta
utworzony z uyciem programu mmorph opracowanego w ISSCO w
Genewie. Zakada si rwnie, e uytkownik stosuje pakiet programw
wykorzystujcych automaty skoczone dostpny pod adresem
http://www.pg.gda.pl/~jandac/fsa.html .

Do skorzystania z narzdzia konieczna jest instalacja programw mmorph
i fsa_guess a take automat zgadujcy (index a tergo) dla programu
fsa_guess. Automat mona utworzy korzystajc ze skryptw i programu
fsa_build zawartych w pakiecie automatw skoczonych.

Tryb korzystania z narzdzia jest nastpujcy:
a) Utworzenie automatu zgadujcego na podstawie sownika. Odnone
   informacje znajduj si w pliku README pakietu automatw i stronach
   podrcznika dla fsa_build(1), fsa_guess(1) i fsa_guess(5). W tym
   samym pakiecie znajduj si take pomocne skrypty.
b) Utworzenie listy sw nie wystpujcych w sowniku. Mona do tego
   celu uy programu fsa_spell - naley zapozna si z powicon mu
   stron podrcznika fsa_spell(1).
c) Przetworzenie listy nieznanych sw za pomoc programu fsa_guess z
   uyciem automatu odgadujcego i zachowanie wynikw (zbioru
   podpowiedzi) w pliku.
d) Zaadowanie pliku podpowiedzi do narzdzia.
e) Uycie narzdzia do utworzenia opisw w formacie programu mmorph.
f) Zachowanie opisw w pliku.
g) Poczenie nowych opisw z ju istniejcymi.

2. Zaadowanie pliku podpowiedzi

Plik podpowiedzi mona zaadowa uywajc menu lub opcji
wykonania. Korzystajc z menu, naley wybra Plik/Otwrz plik
podpowiedzi, a nastpnie wybra odpowiedni plik z listy. Nazw pliku
podpowiedzi mona te poda w wierszu wywoania poprzedzajc go
napisem -G i odstpem.

3. Tworzenie opisw w formacie programu mmorph

Dla kadego sowa naley:
a) Klikn na sowo. W okienku Opisy powinien pojawi si co
   najmniej jeden opis. Przesuwanie kursora w tym okienku powoduje
   pojawianie si stosownych opisw w okienku opis.
b) Wybra opis z okienka Opis. W przypadku wtpliwoci, po wybraniu
   opisu mona nacisn na klawisz Mmorph, co spowoduje wywietlenie
   w okienku Mmorph wszystkich form utworzonych na podstawie tego
   opisu. Mona te wywietli rnice w formach tworzonych na
   podstawie dwch rnych opisw wybierajc te opisy (posugujc si
   klawiszem Ctrl i lewym przyciskiem myszy) i naciskajc klawisz
   Mmorph. W celu sprawdzenia, czy generowane s wszystkie formy
   danego sowa mona zaznaczy ,,tak'' w polu ,,Upraszcza
   alternatywy''. Wwczas jeli np. w opisie znajdzie si cecha
   ,,case'' z dwoma moliwymi wartociami: ,,mon'' i ,,acc'', czyli
   innymi sowy jeli znajdzie si tam napis ,,case=mon|acc'', to dany
   opis zostanie rozoony na dwa. W pierwszym bdzie ,,gen=mon'', w
   drugim -- ,,gen=acc''.
c) Jeeli aden z opisw z okienka Opisy nie jest prawidowy, mona go
   poprawi naciskajc klawisz Popraw. Pojawi si osobne okno, w
   ktrym bdzie mona dokona poprawek. Inn moliwoci jest
   poprawienie form wywietlanych w okienku ,,Rozwinicie przez
   mmorph'' i nacinicie klawisza ,,Wybierz odmian wg
   mmorph''. Narzdzie sprbuje wwczas znale taki opis, ktry
   produkuje poprawione formy. Narzdzie potrzebuje do tego dodatkowej
   informacji zapisanej w pliku ,,paradigm'', lub w pliku, ktrego
   nazwa zostaa ustalona przez wybranie Dostosuj/Plik z nazwami
   paradygmatw. Pierwszy znak tego pliku jest znakiem pocztku
   komentarza (mona go dowolnie zmienia). Wiersze zaczynajce si
   tym znakiem nie s przez narzdzie interpretowane. Pozostae
   wiersze maj po trzy kolumny, oddzielone od siebie odstpami lub znakami
   tabulacji. Pierwsza kolumna zawiera nazw czci mowy. Pozostae
   dwie kolumny odnosz si wycznie do opisw z tak czci
   mowy. Wierszy z opisem danej czci mowy moe by wicej. Druga
   kolumna zawiera wyraenie regularne. Jeli to wyraenie wystpuje w
   opisie, to trzecia kolumna zawiera nazwy cech, ktrych zmiana moe
   spowodowa, e opis bdzie produkowa poprawione formy pokazane w
   okienku mmorph. Jeeli po cesze wystpi gwiazdka, to bd brane pod
   uwag wszystkie kombinacje wartoci danej cechy. Jeeli narzdzie
   znajdzie odpowiedni opis, kolor ta tego opisu zostanie zmieniony
   na zielono. Poszukiwanie odpowiedniego opisu moe trwa do dugo
   (w zalenoci od zawartoci pliku ,,paradigm'' i liczby wartoci
   podanych tam cech). W czasie wyszukiwania klawisz ,,Wybierz odmian
   wg mmorph'' jest stale wcinity.
   Moliwe jest take uycie poprawiania wspomaganego przez
   program. Wystarczy nacisn prawy przycisk myszy, gdy kursor
   znajdzie si nad opisem do poprawienia.
d) Nacisn klawisz Zachowaj. W zalenoci od tego, ktry z klawiszy
   radiowych na prawo jest wcinity, zachowanie spowoduje take
   usunicie z okienka Sowo wszystkich form produkowanych przez ten
   opis, tylko biecej formy (tej, ktra posuya do odgadnicia
   opisu), lub adnej.

4. Zachowanie opisw w pliku

Opisy zachowywane s automatycznie przy opuszczaniu narzdzia za
pomoc menu Plik/Koniec lub przycisku Koniec. Moliwa jest zmiana
standardowej nazwy pliku opisw za pomoc opcji -o podanej w wierszu
wywoania.

5. Dostosowanie do potrzeb uytkownika

Mona uywa opcji w wierszu wywoania programu w celu zmiany
zachowania narzdzia. Naley wwczas pamita o oddzieleniu odstpem
opcji od jej wartoci.

Mona zmieni jzyk uywany w menu, na przyciskach i w etykietach
podajc nazw jzyka po opcji -l w wierszu wywoania programu, lub
wybierajc z menu Dostosuj/Jzyk. Opis dla tego jzyka musi istnie w
pliku opisw jzykw. Nazw tego pliku mona zmieni uywajc opcji -c
w wierszu wywoania programu.

Mona zmieni czcionk uywan do wywietlania sw, opisw i form
tworzonych za pomoc programu mmorph wybierajc Dostosuj/Czcionka z
menu lub podajc nazw czcionki po opcji -f w wierszu wywoania
programu.

Mona zmieni nazw pliku tworzonego dla potrzeb programu mmorph
w celu wywietlenia form tworzonych na podstawie danego opisu uywajc
opcji -m w wierszu wywoania programu.

%iso8859-1
*Francais
Outil d'acquisition des descriptions morphologiques

Table des matiers
 1. Introduction
 2. Chargement du fichier de prvisions
 3. Cration des descriptions dans le format de mmorph
 4. Sauvgarde des description dans un fichier.
 5. Personnalisation

1. Introduction

Le but de ce outil est d'assister au utilisateur dans le development
des dictionaires morphologiques. On assume qu'un dictionaire
morphologique pour la langue en question dj existe et qu'il a t
cr avec mmorph - un programme dvlop  l'ISSCO  Genve. Vous avec
besoin aussi d'un ensemble de programmes pour la manipulation
d'automates  tats finis disponible de
http://www.pg.gda.pl/~jandac/fsa.html .

Vous avec besoin de mmorph, fsa_guess et un automate devinateur pour
fsa_guess. Vous pouvez crer l'automate en utilisant fsa_build ou
fsa_ubuild, avec les donnes prepares avec des scripts disponible
dans le mme paquet.

La procedure de base et suivante:
a) Produire un automate devinateur  l'aide du dictionnaire. Consulter
   le mannuel pour fsa_build(1), fsa_guess(1) et fsa_guess(5). Vous
   trouverez des scripts outils dans le mme paquet.
b) Produire une liste des mots qui n'existent pas (encore) dans le
   dictionnaire. Vous pouvez utiliser fsa_spell pour ce but - consultez
   le manuel pour fsa_spell(5).
c) Lancer fsa_guess avec l'automate devinateur sur la liste des mots
   inconnus et sauver le resultats (les prvisions) dans un fichier.
d) Vous pouvez utiliser un script chkmorph.pl pour liminer cettes
   prvisions qui ne peuvent pas produire le mot qu'elles doivent produire.
e) Charger le fichier des prvisions dans l'outil.
f) Utiliser l'util pour produire des descritions dans le formatte de
   mmorph.
g) Sauvegarder les descriptions dans un fichier.
h) Fusionner des nouveaux descriptions avec ceux qui dj existent.

2. Chargement du fichier de prvisions

Le fichier des prvisions peut tre charg en utilisant les menus ou
avec la ligne de commande. Pour charger le fichier en utilisant les
menus, slectionnez Fichier/Ouvrir fichier des prvisions et
slectionnez un fichier. Pour faire la mme chose de la ligne de
commande, utilisez l'option -G suivie d'une espace et le nom du
fichier.

3. Cration des descriptions dans le format de mmorph

Pour chaque forme flechie  traiter:
a) Cliquez la forme flechie. Au moins une description dot
   apparatre dans le fentre Descriptions. Si vous utilisez les
   touches curseurs pour changer les mots dans cette fentre, les
   descriptions changent aussi.
b) Slctionnez une description de la fentre Descriptions. Si vous
   n'etez pas sr laquelle description est correcte, cliquez sur une et
   appuyer sur la touche Mmorph. Toute les formes cres  par mmorph 
   la base de cette description vont apparatre dans le fentre
   Mmorph. Pour voir la difference entre deux descriptions,
   slctionnez-les et appuyer sur la touche Mmorph. La fentre doit
   montrer les diffrences entre les mots produits par les deux
   descriptions. Si vouz voulez voir si toutes les formes flechies
   sont produites, cliquez sur "oui" en Simplifier des
   alternatifs. Dans ce cas si la descriptions contiens par exemple
   "case=nom|acc", c'st--dire plus qu'une valeur possible, la
   description aura t divise en deux. La premire contiendra
   "case=nom", l'autre - "case=acc".
c) Si aucune des descriptions dans la fentre Descriptions n'est pas
   correcte, vouz pouvez la corriger en appuyant la touche Corriger. Une
   nouvelle fentre apparatra et vous y pourrez diter la
   description. Il y a encore une possibilit. Vous pouvez corriger
   les formes produites par mmorph. Puis appuyez sur la touche Trouver
   description selon mmorph. L'outil va essayer de trouver la
   description qui produit le contenu de la fentre Expansion mmorph
   (avec vos corrections). Il a besoin d'information
   supplmentaire. Elle se trouve dans le fichier "paradigm" ou dans
   un autre fichier dont nom tait donn avec Personnaliser/Fichier
   avec les noms des paradigmes. Le premier caractre de ce fichier
   commence un commentaire. Chaque ligne qui commence par ce caractre
   est ignore par l'outil. Les autres sont divises en trois
   colonnes. La premire contiens la partie du discours. Il est
   possible d'avoir plusieurs lignes avec la mme partie du discours,
   mais les secondes colonnes doivent tre diffrentes. La seconde
   colonne contient une expression rgulire. Si la description dans
   la fentre Descriptions contient la partie du discours et
   l'expression rgulire s'accorde avec la description, la troisime
   colonne contient une liste de traits qu'on peut changer pour
   arriver  la bonne description. Si le nom du trait est suivi par
   une toile, toutes les combinaisons des valeurs de ces traites
   seront produites. Si la description correcte est trouve, elle sera
   affiche en vert. Pendant la cherche la touche "Trouver
   descriptions selon mmorph" reste appuye.
   Il est possible d'utiliser une correction guide. Il suffit appuyer
   sur le bouton droite du souris quand il est sur la description 
   corriger.
d) Appuyer sur la touche Sauvegarder. La description est ajoute  la
   fin de la liste des descriptions qui seront sauvegardes  la fin
   de la session (c'est--dire quand on quitte l'outil). Selon la
   valeur de "Sauvegarder efface", tout les mots produits par la
   description, seulement le mot courant (ce qui tait  l'origine de
   la prvision), ou rien sera effac de la fentre Forme flechi.

4. Sauvgarde des description dans un fichier.

Les descriptions sont sauvegardes automatiquement quand vous quitter
l'outil avec Fichier/Quitter ou en appuyant sur la touche
Quitter. Vous pouvez changer le nom du fichier avec l'option -o quand
vous lancer l'outil.

5. Personnalisation

Les options de la ligne de commande peuvent tre utilises pour
changer le comportement de l'outil. N'oubliez pas d'introduire une
espace entre l'option et son valeur.

Vous pouvez changer la langue de menus, touches ou tiquettes soit en
donnant le nom de la langue aprs l'option -l dans la ligne de
commande, soit en utilisant les menus Personnaliser/Langue. Une
description pour la langue doit tre prsente dans le fichier de
description de langues. Le nom de ce fichier peut tre chang avec
l'option -c dans la ligne de commande.

Vous pouvez changer la police des caractres utilise pour afficher
les mots avec l'option -f dans la ligne de commande ou avec les menus
en utilisant Personnaliser/Police des caractres.

Vous pouvez changer le nom du fichier avec une description pour mmorph
( afficher dans la fentre Mmorph) avec l'option -m dans la ligne de
commande.
