# Failimallid

Anders
Lund

    anders@alweb.dk

Esmaspäev, 16. veebruar 2004
0.1

KDE
kate
kdeaddons
mall
makro

# Sissejuhatus

Failimallide plugin lubab olemasolevate failide baasil luua uusi faile. Mallina saab kasutada iga faili: 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.

Mallikataloogides asuvaid malle saab näha menüükäsuga Fail Mallist...

Plugin lubab ka hõlpsasti luua uue malli avatud dokumendi põhjal.

Mallikataloogid on osa &kde; failisüsteemist ning neiks on vähemalt KDEDIR/share/applications/kate/plugins/katefiletemplates/templates ja 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 Kasuta hiljutist

  Näitab hiljuti mallina kasutatud failide loendit, tuues ära nende URL-id.

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 salveesta 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:

`Template`

  See on malli nimi, mida näidatakse menüüs Fail Mallist.

`Group`

  Grupp asetab malli menüü Fail Mallist alammenüüsse.

`Name`

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

`Highlight`

  Plugin püüab uue dokumendi esiletõstmise 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 aega 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

&kate; plugina failimallid autoriõigus 2004: Anders Lund anders@alweb.dk.

Dokumentatsiooni autoriõigus 2004: Anders Lund

Tõlge eesti keelde: Marek Laane bald@online.ee

&underGPL;