Kasutusjuhend

1 Ksitsi mrgendamise juhend

Ksitsi mrgendamise juhend neb ette jrgmist:
Mrgendatava faili ldkuju on jrgmine: 
snavorm 
tvi+lpp // morf info // sntaktilised mrgendid 
uus_snavorm 
tvi+lpp // morf info // sntaktilised mrgendid 
... 
Ksitsi mrgendamisel tuleb ige sntaktilise mrgendi ette panna +-mrk. Kui iget mrgendit ei leidu, tuleb see ksitsi lisada ja thistada samuti +-ga. Kui snal ongi ainult ks mrgend ja see on ige, siis seda thistama ei pea. Kui iget analsi on raske valida, tuleb lahtiseks jv sna mrgendada kahe ksimrgi abil (??) ja lisada nende taha ksimus.  
/.../
Kui kski pakutavatest sntaktilistest mrgenditest ei tundu ige, lisada uus mrgend, mille ees on +=, nt +=@SUBJ 
Nide ksitsi mrgendatud tekstist 
Pealegi 
pealegi+0 //_D_ // **CLB +@ADVL @AD> @<AD 
on 
ole+0 //_V_ main indic pres ps3 sg ps af #FinV #Intr // @+FMV 
kell 
kell+0 //_S_ com sg nom // @SUBJ @PRD @OBJ +@NN> @<NN @ADVL @<Q 
?? kumb on tiend ja kumb alus, kell vi kuus 
kuus 
kuus+0 //_N_ card sg nom l // +@SUBJ @OBJ @PRD @ADVL @NN> @<NN 
?? kas kuus on alus 
hommikul 
hommik+l //_S_ com sg ad // @ADVL @<Q @NN> +@<NN 
niisugune 
niisugune+0 //_P_ dem sg nom // @SUBJ @PRD @OBJ @<Q +@NN> @<NN @ADVL 
aeg 
aeg+0 //_S_ com sg nom // @SUBJ +@PRD @OBJ @NN> @<NN @ADVL @<Q  ([6])


2 Kasutajaliidese kivitamine

Kasutajaliidese kivitamiseks tuleb Windowsi keskkonnas kivitada fail nimega Margendaja.bat. Linuxi keskkonnas tuleb kivitada Margendaja.sh.
Kesolevat kasutajaliidest vib vajadusel kivitada ka ksurealt ksuga 
java SyntaxAnnot
Kasutajaliides nuab kasutaja arvutilt java jdk1.3 toetust (vt. Installeerimise juhendit) ning graafilise kasutajaliidesega operatsioonissteemi.
Ksurida on vimalik kivitada Windowsi keskkonnas valides "Start" menst "Run" ning sisestades sinna "Command". Unixi keskkonnas tuleb kivitada konsool.




3 Ekraani seletus

Ekraanil on nha menpunktid "T failidega", "Triistad" ja "Abi". Nendest esimel hiirega klpsates saab anda programmile kske "Uus fail", "Ava pooleliolev fail", "Salvesta fail",  "Mrgendaja info" ning "Lahku". "Triistad" mens on lisavimalused kasutajaliidese mugavamaks kasutamiseks. Men "Abi" all on kasutusjuhend ning info programmi autori kohta.
Menriba all on nha nn triistade riba. Seal on 4 ikooni. Nende sisu ilmub nhtavale, kui liiguda hiirega nupu juurde - "Uus", "Ava pooleliolev fail", "Salvesta" ning "Abiinfo".
Keskne ekraan on tekstipaneel. Siia ilmub tekst, mis loetakse soovitud failist.
Akna kige allservas on nha mrgendaja nimi ja tsoleva faili nimi.

Sntaktilise mrgendamise alustamiseks peate kigepealt sobiva faili avama.

4 Teksti avamine

Soovides alustada mrgendamist valige menst "T failidega" -> "Uus fail" vi klpsake kige vasakpoolsemal ikoonil. Kui te pole veel sisestanud oma nime, ksitakse seda teie kest. Seejrel valige failibrauserist sobiv fail, kitudes standardsel moel (otsige sobiv kataloog, klpsake sobival failil ning vajutage "open" nuppu). 


Praeguses versioonis kitub menpunkt "T failidega" -> "Ava pooleliolev fail" ning vasakult teine ikoon tpselt samamoodi. 

5 Vrvide seletused

Rohelise vrviga on mrgitud kik tlgendused, mis on juba hestatud - neid kasutaja enam mrgendama ei pea, kuid kontrollima kll.
Mustalt ja rasvaselt on mrgendid, mis pole mrgitud, eemaldatud ega lisatud. 
Tumeroheline vrv thistab kommentaare. Neid saab lisada ning eemaldada. 
Helehall mrgistab mrgendeid, mis on eemaldatud.
Lilla vrviga on thistatud mrgendaja poolt lisatud mrgendid.


6 ige mrgendi valimine

Kasutaja valib sobiva mrgendi ning klpsab hiirega vastaval kohal. ige kasutuse korral muutub mrgend roheliseks ning selle ette tekib "+" mrk. See thistab valitud mrgendit. Kui real on algselt ainult ks sntaktiline tlgendus, mis on ka ige, ei pea kasutaja seda mrgistama.

7 Valitud mrgendi eemaldamine

Kasutaja leiab mrgendi, mille ees on juba "+" mrk, s.t. et ta on valitud. Soovides seda mrkida mitte-valituks, liigub kasutaja hiire kursoriga tlgenduse peale ning klpsab he korra vasaku hiire nupuga. Mrgend muutub halliks ning tema eest kaob "+" mrk.

8 Uue mrgendi lisamine

Soovides lisada uut mrgendit juhul, kui automaatselt genereeritud tlgenduste seas pole iget, tuleb kasutajal liikuda hiirega vastava rea sntaktiliste tlgenduste juurde ning klpsata hiire paremat nuppu. Kasutajal tekib valikuvimalus - "Lisa uus" ning "Abiinfo". Nendest esimese valides ilmub kasutaja ette kikide mrgendite loetelu. Nendest tuleb valida sobiv ning vajutada siis "OK" nupul. Ekraanile, sobivale reale ilmub lilla valitud mrgend koos eesliitega "+=".

9 Kommentaari lisamine

Selleks peab kasutaja liikuma kursoriga snavormile ning vajutama hiire paremat nuppu. Avaneb men, kus on vimalused "Lisa kommentaar" ning "Abiinfo". Valides "Lisa kommentaar" avaneb uus aken, kuhu saab sisestada vabateksti. Kommentaari ette pole vaja lisada mrke "?". Need paneb kommentaari ette programm.


10 Kommentaari eemaldamine

Kasutaja peab kommentaari eemaldamiseks leidma ekraanilt sobiva kommentaari, selle peal klpsama hiirega parema nupuga ning valima "Eemalda kommentaar".

11 Salvestamine

Kasutajal tuleb salvestamiseks valida menst "T failidega" punkti "Salvesta fail". Seejrel ksitakse kasutajalt salvestatava faili nime. Tuleb valida sobiv kataloog  ja sobiv fail ning vajutada nupule "Save". Automaatselt salvestatakse ka logifail.

12 Mrgendaja info

Mrgendaja info all on meldud mrgendaja nime, mida on vajalik logifailide loomiseks. Faili avades ksitakse mrgendajalt tema nime, kuid selle punkti abil on vimalik kasutajal seda muuta. Mrgendaja info on nha kogu t jooksul ka akna all servas olevas ribas. Samuti on seal on ka mrgendatava faili nimetus.


13 Programmist lahkumine

Programmiga t lpetamiseks peab kasutaja valima menpunktist "T failidega" valiku "Lahku". Kui kasutaja pole oma viimaseid muudatusi salvestanud, antakse talle selleks vimalus. 


Valides "Salvesta", toimib kik analoogselt eelmises punktis tooduga. Valides "ra salvesta" loobub kasutaja kikidest muudatustest, mis prast viimast salvestamist on tehtud. Valides "Loobu" ei lahkuta programmist.

14 Triistad

Selles mens avaneb kasutajal vimalus kasutada teksti mrgendamisel erinevaid lisafunktsioone. Kikide triistade t on veidi aeganudev, seega vib kasutajal vaja minna veidi kannatust prast triista valikut.

14.1 Nita algteksti

Valides Triistade menst "Nita algteksti" ilmub teise aknasse antud faili algtekst - ilma analsita. Selle abil on vimalik tekst lihtsamalt lbi lugeda. Aken vib jda avatuks ka kogu t ajaks. 

14.2 Nita hestatud snu algtekstina

Antud "Triist" ei nita analsi nendel snadel, mis on kasutaja poolt juba heselt mrgendatud - tpselt hel sntaktilisel mrgend on valitud vi lisatud. 

14.3 Nita kike

Nidatakse kikide snade analsi ridu, mrgendeid, kommentaare jms. Antud triist on meldud just eelmises punktis toodud triista tulemuse ellimineerimiseks.

14.4 Kontrolli mrgendite hesust

Antud triist kib le terve teksti ning otsib vlja sellised snad, millel on le he mrgendi valitud. ldjuhul on selline seis lubamatu, kuid vahel vib kasutaja seda just soovida. Kasutajale nidatakse dialoogi aknas, mitu sellist sna on tekstis ning antakse vimalus liikuda ekraanil esimese sellise sna juurde. Seejrel on kasutajal vimalus liikuda kas jrgmise taolise sna juurde vi katkestada tegevus. Kui kasutaja neb sna, millel on kaks vi rohkem mrgendit valitud eksklikult, peab kasutaja valima "Katkesta" ning seejrel sna muutma. Kui kasutaja soovib kontrollida ka viimaseid liigselt mrgendatud snu, peab ta valima uuesti antud triista.

14.5 Nita kommentaare

Kasutajale nidatakse, mitu kommenteeritud sna on terves tekstis ning vimaldab kasutajal liikuda kommenteeritud snade juurde. Kui kasutaja on liikunud kommentaari juurde, mida soovib parandada, peab vajutama "Katkesta". Ekraani lemisse serva jb kommenteeritud sna.

14.6 Mine viimati mrgendatud sna juurde

Valides antud triista, liigutatakse ekraani kohani, kus kasutaja viimase muudetuse tegi. Prast faili avamist ning enne esimese sna mrgendamist vi kommenteerimist, on selleks kohaks logifailist saadud koht. Logifailist saadakse info ainult sel juhul, kui mrgendajaks on mrgitud sama nimi, mis enne on salvestatud.

15 Abiinfo

Abiinfo ehk kasutusjuhend on abiks kasutajale, kes on htta jnud vi ei oska soovitud tegevust sooritada. Programmi autor on proovinud vimalikult tpselt seal kirjeldada iga tegevust, mis selle programmiga teha saab.

