# Pluginate kasutamine

Kate kasutab kaht erinevat tüüpi pluginaid: &kate; rakenduse pluginad ja &kate; redaktorikomponendi pluginad. Viimaseid saavad kasutada kõik teised rakendused, mis tarvitavad redaktorikomponenti, näiteks KDevelop, Quanta, Kile, KWrite ja paljud muud, rakenduse pluginad on aga spetsiifilised just &kate;le endale.

Mõlemat tüüpi pluginate kasutamist saab sisse ja välja lülitada seadistustedialoogis, mis ühtlasi võimaldab mõningate pluginate juures üht-teist seadistada.

Mitmesuguseid üsna erinevaks otstarbeks mõeldud pluginaid on päris palju ning pluginaid leiab ka veebist. Teatud pluginad on juba kaasa pandud redaktorikomponendiga, need võimaldavad automaatset sulgude lisamist, failide lisamist, andmetööriistu ja teksti eksportimist &HTML;-ina.

## Redaktori komponendi pluginad

Lehekülje Laiendused kaardil Pluginad on näha kõik saadaolevad pluginad ning siin saab märkida, milliseid neist kasutada, milliseid mitte. Klõpsuga nupule Info avatakse antud plugina infodialoog.

Plugina märkimise korral saab tarvitada nuppu Seadista ning vastavat pluginat seadistada.

Automaatsulud

- Automaatsulgude plugin tühistab &kate; sisemise automaatsulgude omaduse. See lisab automaatselt lõpetava sulu } järgmise rea algusse pärast selle rea lõppu jõudmist, millel seisab alustav sulg {, ning klahvi &Enter; vajutamist.

Andmete tööriistad

- Võimaldab kasutada andmetööriistu, näiteks tesaurust ja õigekirja kontrolli (kui need on paigaldatud). Andmetööriistad on saadaval ainult siis, kui tekst on valitud või kui hiire parema nupuga klõpsatakse mõne sõna kohal. Kui andmetööriistu ei pakuta isegi siis, kui tekst on valitud, tuleb need paigaldada. Mõned andmetööriistad kuuluvad paketti &koffice;. Kui see plugin on sisse lülitatud ja andmetööriistad paigaldatud, ilmuvad kontekstimenüüsse vastavad lisakirjed.

Eksport

- See käsk võimaldab eksportida aktiivse dokumendi koos kogu esiletõstmise teabega HTML-dokumenti menüükäsu Fail Ekspordi HTML-ina abil. Lisaks võib kasutada käsku Redigeerimine Kopeeri HTML-ina valitud teksti kopeerimiseks HTML-ina süsteemi lõikepuhvrisse.

Ikoonilisaja

- Ikoonilisaja plugin on mõeldud peamiselt &kde; arendajatele. See lisab redaktori kontekstimenüüsse kirje Lisa KIcon-Code. Valimise korral avatakse &kde; ikoonivalija (mis näitab rakenduste, toimingute jne. ikoone). Sellel klõpsates lisatakse tekstina failinimi ilma laiendita. See on kasulik ainult ikoonide määramiseks &kde; raamistiku kaudu klassi KIcon() abil.

Hullumeelne (mitte ZEN) HTML kodeering (kerge versioon)

- Plugin, mis kasutab zen-kodeerimise laadset selektori lõpetamist. Täpsemalt kõneldakse sellest Wikipedias Zen Coding.

Faili lisamine

- See plugin võimaldab lisada kursori asukohta mis tahes loetava faili. Sisselülitamise korral ilmub menüüsse Tööriistad lisakirje Faili lisamine.

## &kate; rakenduse pluginad

&kate; pluginad on &kate; redaktori lisafunktsioonid Need võivad lisada menüüsid ja kiirviitu, samuti laiendada &kate; võimalusi. Neid võib paigaldada &kate;le just nii vähe või palju, kui sulle endale meeldib. Ava &kate; seadistustedialoog menüükäsuga Seadistused&kate; seadistamine... Vali soovitud pluginad kaardilt Rakendus Pluginad.

Saadaolevad rakenduse pluginad on järgmised:

- Failides otsimise tööriistavaade - tööriistavaade, mis võimaldab otsida kõigis avatud või failisüsteemis leiduvates failides

- Tagasijälituse brauser - tagasijälituse liikumistööriista vaade

- Dokumentide kiirlülitaja - võimaldab kiiresti lülituda mõnele teisele avatud dokumendile

- Kaardiriba - lisab Kate peaaknasse kaardiriba

- Tekstifilter - lihtne teksti filtreerimine

- Sümbolite näitaja - hangib lähtekoodist sümbolid ja näitab neid

- Failisüsteemi sirvija - failisüsteemi sirvija tööriistavaade

- Terminali tööriistavaade - terminalividinat põimiv tööriistavaade

- CTagsi plugin - definitsiooni/deklaratsiooni otsimine CTagsiga

- Failimallid - uute failide loomine malli põhjal

- Päisefaili avaja - vastava .h/[.cpp|.c] faili avamine

- Välised tööriistad

- Ehitamisplugin - kompileerimine või ehitamine (make) ja veateadete parsimine

- Failide saatmine e-postiga

- Kate jupid - juppide plugin koodilõpetuse toetusega

- KTextEditori Jovie plugin - lisab menüükirje teksti kõnelemiseks

- &XML; süntaksi kontrollija- kontrollib -faile xmllint'i abil

- &XML;-i lõpetus - Loetleb &XML;-i elemendid, atribuudid, atribuutide väärtused ja olemid, mida võimaldab DTD

- Taibfy - lisab Kate peaaknasse kaardiriba

## Failimallid

Failimallide plugin võimaldab luua faile teiste failide põhjal.

Kate esmapaigaldusel tuleb plugin sisse lülitada:

1. Vali Seadistused Kate seadistamine...

2. Klõpsa vasakul asuvas puus kirjele Pluginad.

3. Vali paremal asuvas paneelis Pluginahaldur Failimallid ja klõpsa seejärel nupule OK.

Nüüd võid kasutada iga faili mallinai: sellest luuakse koopia tühja &URL;-iga. Samuti võib kasutada spetsiaalset mallifaili, kus on juba olemas teatud makrod, mis annavad ette mõningase info, näiteks sinu nime ja e-posti aadressi, kuupäeva ja keskkonnamuutujad ning isegi kursori asukoha uues failis.

Sa võid ka hõlpsasti luua uue malli avatud dokumendi põhjal.

Malle, mida oled salvestanud mallikataloogi, näeb menüüs kirje Fail Uus mallist järel.

Mallide kataloog on osa &kde; failisüsteemist ja sisaldab vähemalt

- `$`KDEDIR`/share/applications/kate/plugins/katefiletemplates/templates`

- `$`KDEHOME`/share/applications/kate/plugins/katefiletemplates/templates.`

Kui sinu keskkonnamuutujas `KDEDIRS` on veel katalooge, otsitakse ka neist samasuguseid alamkatalooge. Kui leitakse ühenimelised mallid, valitakse neist kohalikus kataloogis (KDEHOME) leiduv.

### Menüü struktuur

Fail Uus mallist Suvaline fail...

- Avab failiavamise dialoogi, kus võid valida malliks suvalise faili. Kui valitul on laiend `katetemplate`, parsitakse seda malliinfo ja makrode leidmiseks.

Fail Uus mallist

- Alammenüü ülejäänud osa sisaldab viitu mallidele. Klõpsa menüükirjel, kui soovid luua sellele vastavat faili.

Seadistused Mallide haldamine...

- Avab dialoogi, kus on ära toodud kõik mallikataloogides leitud mallid, ning kus saab neid lisada, muuta või eemaldada.

### &kate; mallide kasutamine

Luues makrosid sisaldava malli põhjal faili, ilmuvad mõned makrod teksti redigeeritavate muutujatena. Selliseid muutujaid eristatakse allajoonimisega.

Esimene muutuja on kohe valitud, nii et sul tuleb selle redigeerimiseks vaid kirjutama asuda. Kui sama muutujat esineb dokumendis rohkemgi, muudetakse ka kohe ka neid. Järgmisele redigeeritavale muutujale saab liikuda tabeldusklahviga (TAB). Pärast viimase muutuja redigeerimist nimekiri kaob ning tabeldusklahv hakkab taas normaalselt tööle.

### Oma mallide loomine

Uue malli loomiseks käivita mallihaldur menüükäsuga Seadistused Mallide haldamine. Selle avanedes klõpsa nupul Uus..., mis käivitab failimalli nõustaja. Sinu käest päritakse faili, mida malliks muuta, võimaldatakse määrata malli info ja seejärel luuaksegi mall.

Muidugi võib malli ka päris käsitsi luua, lisades malli info mis tahes faili algusse, andes teksti, makrod ja kursori asukoha markeri ning salvestades faili laiendiga `katetemplate`.

Mallimenüü uuendatakse automaatselt, kui salvestad mallikataloogi uue malli.

### Mallide muutmine

Malli muutmiseks vali menüükäsk Seadistused Mallide haldamine... Vali mall, mida soovid muuta, ja klõpsa nupule Muuda... Seejärel avatakse mallifail. Sulge dialoog, muuda faili, salvesta ja sulge. Malli tehtud muudatused rakendatakse otsekohe, soovi korral võid selle kohe pärast salvestamist ja sulgemist uuesti avada, et vaadata, kas kõik sai nii, nagu tahtsid.

### &kate; malli vorming

Kui kasutad faile laiendiga `katetemplate`, parsitakse neid malli info, makrode ja kursori asukoha leidmiseks.

#### Malli info

Fali lugedes otsib parser ridu, mille alguses seisab `katetemplate:`, sest just neisse peaks olema salvestatud malli info kujul MUUTUJANIMI=VÄÄRTUS. Esimest rida, mille alguses ei seisa `katetemplate:`, peetakse malli sisu alguseks. VÄÄRTUS võib olla mis tahes sümbol, välja arvatud võrdusmärk (=). Kindlasti tuntakse ära järgmised muutujad:

`Mall`

- See on malli nimi, mida näidatakse menüüs Fail Uus mallist.

`Group`

- Grupp asetab malli menüü Fail Uus mallist alammenüüsse.

`Name`

- Dokumendi nimi, mida näidatakse nii failinimekirjas kui tiitliribal. Kui nimes leidub `%N`, asendatakse see numbriga, mis samanimeliste dokumentide korral kasvab.

`Highlight`

- Plugin püüab uue dokumendi esiletõstu määrata selle muutuja väärtusele. Väärtus peab olema nimi, nagu see esineb menüüs Tööriistad Esiletõstmine .

`Description`

- Malli lühike kirjeldus. Praegu on see kasutatav abivõimaluse 'Mis see on?' jaoks, kuid tulevikus võib-olla muukski.

Author

- See string määrab autori, näiteks kujul `Nimi <e-posti aadress>`. Praegu on see kasutatav abivõimaluse 'Mis see on?' jaoks, kuid tulevikus võib-olla muukski.

#### Malli makrod

Malli sisu parsides avatakse makrod kujul `%{NAME}` või `${NAME}`. Kui kasutad prefiksit `$`, koheldakse avatud makrot redigeeritava muutujana, kui dokument luuakse malli põhjal. `%` kasutamisel seda ei tehta, kui just avamine ei ebaõnnestu.

Toetatud on järgmised makrod:

time

- Näitab käesolevat kellaaega kohalikul kujul.

date

- Näitab käesolevat kuupäeva lühivormingus.

datetime

- Näitab käesolevat kuupäeva ja kellaaega stringina kohalikul kujul.

year

- Käesolev aasta neljakohalise numbrina.

month

- Käesoleva kuu täisnimi kohalikul kujul.

day

- Näitab käesolevat kuu päeva.

hostname

- Näitab arvuti masinanime.

index

- Näitab 'i'.

fullname

- Näitab sinu täielikku nime, nagu selle määrab sinu standardse &kde; aadressiraamatu omaniku aadress.

firstname

- Näitab sinu eesnime, nagu selle määrab sinu standardse &kde; aadressiraamatu omaniku aadress.

lastname

- Näitab sinu perekonnanime, nagu selle määrab sinu standardse &kde; aadressiraamatu omaniku aadress.

email

- Näitab sinu e-posti aadressi, nagu selle määrab sinu standardse &kde; aadressiraamatu omaniku aadress.

Kõiki muid makrosid tõlgendatakse prefiksist sõltumata redigeeritavate muutujatena. Kui üks ja sama muutuja esineb mallis mitu korda, saab neid redigeerida kohe korraga pärast dokumendi loomist malli põhjal.

#### Kursori asukoha määramine

Spetsiaalne makro `${cursor}` asendatakse püstjoonega ning lisatakse sõltumata asukohast tekstis redigeeritavate muutujate nimekirja lõppu.

### Autorid ja litsents

&kate; plugina failimallid autoriõigus 2004: &Anders.Lund; &Anders.Lund.mail;.

Dokumentatsiooni autoriõigus 2004: &Anders.Lund;

## &XML; süntaksi kontrollija

See plugin kontrollib, kas &XML;-failid on korrektselt vormistatud.

See plugin kontrollib aktiivset faili. Hoiatuste ja vigade nimekiri ilmub &kate; põhiakna allserva. Veateatele klõpsates saab hüpata vastavale kohale failis. Kui failil on DOCTYPE, kasutatakse faili kontrollimiseks selle dokumenditüübiga seotud DTD-d. DTD eeldatakse asuvat suhtelises asukohas aktiivse faili suhtes - ⪚ kui dokumenditüüp viitab tüübile DTD/xhtml1-transitional.dtd ja failinimi on `/home/juku/test.xml`, siis eeldatakse, et DTD paikneb asukohas `/home/juku/DTD/xhtml1-transitional.dtd`. Kuid toetatud on ka võrgu-DTD, mis on määratud http vahendusel.

Kui failil puudub dokumenditüüp, kontrollitakse vormistust.

&XML; süntaksi kontrollimise kohta leiab rohkem infot internetist W3C ametlikult &XML;-leheküljelt.

Seesmiselt kutsub see plugin välja käsu `xmllint`, mis on osa paketist libxml2. Kui see käsk ei ole süsteemi korrektselt paigaldatud, ei hakka plugin tööle.

Kontrollimise ajal on vajalik kirjutada ajutine fail samasse kataloogi, kus asub kontrollitav fail, nii et sul peab olema sellesse kataloogi kirjutamisõigus.

Plugina sisselülitamiseks ava &kate; seadistustedialoog menüükäsuga Seadistused &kate; seadistamine... Seejärel vali XML süntaksi kontrollija, mille leiad kaardilt Rakendus/Pluginad, ja sulge dialoog.

### Menüü struktuur

XML XML süntaksi kontroll

- See käivitab ülalkirjeldatud kontrolli.

### Autorid ja litsents

&kate; plugin XML süntaksi kontrollija autoriõigus 2002: &Daniel.Naber; &Daniel.Naber.mail;.

Dokumentatsiooni autoriõigus 2002: &Daniel.Naber;

## &XML;-i lõpetus

See plugin pakub variante, mis on &XML;-failis mingis positsioonis vastavalt faili DTD-le lubatud ja mis mitte. Plugin loetleb võimalikud elemendid, atribuudid, atribuudi väärtused ja olemid vastavalt kursori asukohale (nt. kõik olemid, kui märk kursorist vasakul on &). Samuti võimaldab see sulgeda lähima vasakul avatud sildi.

DTD peab eksisteerima &XML;-vormingus nii, nagu selle on loonud Perli rakendus `dtdparse`. Me nimetame selles vormingus DTD-d meta-DTD-ks. Mõned meta-DTD-d on juba paketiga kaasas, need asuvad kataloogis `$KDEDIR/share/apps/katexmltools/`, mis on ühtlasi ka vaikekataloog, kui valid menüükäsu Omista meta-DTD.... Omaenda DTD loomiseks tõmba `dtdparse` internetist: http://dtdparse.sourceforge.net.

### Kasutamisjuhend

Käivita &kate; ja ava seadistustedialoog menüükäsuga Seadistused &kate; seadistamine.... Seejärel vali XML soovitaja, mille leiab sektsioonis Rakendus/Pluginad, ja sulge dialoog. Pärast seda vali XML Omista meta-DTD... Kui dokumendil puudub DOCTYPE või on see tundmatu, tuleb failisüsteemist valida meta-DTD. Muidu laaditakse aktiivse dokumendiga sobiv DOCTYPE automaatselt.

Nüüd saab kasutada pluginat kirjutamise ajal:

< ("vähem kui"-klahv)

- See toob esile võimalike elementide loendi, kui kursor ei asu juba sildi sees. Arvesta, et praegu ei ole seda võimalik kasutada tipptaseme elemendi lisamiseks (⪚ <html>).

</("vähem kui"-klahv + kaldkriips)

- Nende märkide sisestamisel pakutakse aktiivse elemendi sulgemist (lähim kursorist vasakule jääv avatud element). Ettepanekuga nõustumiseks vajuta &Enter;. Erinevalt menüükäsust Sulge element toimib see ainult omistatud DTD puhul.

" (jutumärk)

- See toob esile võimalike atribuutide väärtuste nimekirja (kui neid on), kui kursor on sildi sees.

(tühikuklahv)

- See toob esile praeguse elemendi võimalikud väärtused, kui kursor on sildi sees.

& (ja-märk ehk ampersand)

- See toob esile võimalike olemite nimekirja.

### Võimalused ja piirangud

Kõiki funktsioone ja piiranguid saab testida, kui avada &kate;s `$KDEDIR/share/apps/katexmltools/testcases.xml` ja järgida juhiseid.

### Menüü struktuur

&Ctrl;Return XML Lisa element...

- Avab dialoogi, mis võimaldab sisestada &XML;-i elemendi. Märgid <, > ja sulgev silt lisatakse automaatselt. Kui oled menüükäsu kasutamisel valinud teksti, ümbritsetakse valitud tekst alustava ja lõpetava sildiga. Samuti pakub dialoog võimalust lõpetada kõiki elemente, mida on võimalik lisada kursori asukohta, kui oled omistanud meta-DTD, kasutades menüükäsku Omista meta-DTD...

&Ctrl;< XML Sulge element

- See otsib tekstis silti, mis ei ole veel suletud, ning lisab vastava lõpusildi. Otsing algab kursori asukohast ja suundub vasakule. Kui midagi ei leita, siis ka midagi ei juhtu.

XML Omista meta-DTD...

- See ütleb pluginale, millist meta-DTD-d kasutada aktiivse dokumendi jaoks. Pane tähele, et omistamist ei saa salvestada ja operatsiooni tuleb korrata, kui käivitad &kate; uuesti.

### Autorid ja litsents

&kate; plugina &XML; soovitaja autoriõigus 2001, 2002: &Daniel.Naber; &Daniel.Naber.mail;.

KDE SC 4 versiooni autoriõigus 2010: Tomáš Trnka

Dokumentatsiooni autoriõigus 2001, 2002: &Daniel.Naber;