# Täiustatud redigeerimisvahendid

## Kommentaari lisamine/eemaldamine

Käsud 'Lisa kommentaar' ja 'Eemalda kommentaar', mida saab kasutada menüüst Tööriistad, võimaldavad lisada valitud tekstiosale või kui midagi ei ole valitud, siis parajasti aktiivsele reale kommentaarimärgid või need sealt eemaldada. Seda muidugi juhul, kui parajasti redigeeritava teksti vorming kommentaare üldse kasutada lubab.

Reeglid, mil moel kommentaar välja näeb, on määratud süntaksi definitsioonis, nii et kui süntaksi esiletõstu ei kasutata, ei ole võimalik ka kommentaarimärke lisada või eemaldada.

Mõned vormingud defineerivad ühe rea kommentaarimärgid, mõned lubavad kommenteerida mitut rida korraga ja mõned mõlemat. Kui mitme rea kommentaarimärke ei ole saadaval, siis ei ole võimalik kommenteerida valikut, mille viimane rida ei ole valitud tervikuna.

Kui saadaval on ühe rea kommentaarimärgid, on võimaluse korral mõttekas kommenteerida üksikuid ridasid - nii saab ära hoida näiteks "kommentaari kommentaari sees".

Kommentaarimärkide eemaldamisel ei tohi olla valitud kommenteerimata teksti. Valikult mitmerealise kommentaarimärgistuse eemaldamisel eiratakse iga tühikut väljaspool kommentaarimärgistust.

Kommentaarimärkide lisamiseks kasuta menüükäsku Tööriistad Kommentaar või vastavat kiirklahvikombinatsiooni, mis vaikimisi on &Ctrl;D.

Kommentaarimärkide eemaldamiseks kasuta menüükäsku Tööriistad Kommentaari eemaldamine või vastavat kiirklahvikombinatsiooni, mis vaikimisi on &Ctrl;&Shift;D.

## Redaktori käsureakomponent

&kappname; redaktorikomponent kasutab seesmist käsurida, mis võimaldab minimaalse GUI-ga väga mitmesuguseid toiminguid ette võtta. Käsurida on terminal redaktori allosas, mille saab nähtavaks muuta menüükäsuga Vaade Lülitu käsureale või kiirklahviga (vaikimisi F7). Redaktor pakub omalt poolt välja rea käske, mida tutvustatakse allpool, pluginad võivad neile veelgi lisa pakkuda.

Käsu käivitamiseks vajuta klahvi Enter. Käsurida annab märku, kas täitmine õnnestus ning näitab vajaduse korral teadet. Kui avasid käsurea klahviga F7, peidetakse see automaatselt mõne sekundi pärast. Teate eemaldamiseks ja uue käsu sisestamiseks vajuta uuesti klahvi F7.

Käsureal on omaenda abisüsteem, mille käivitamiseks anna käsk `help`. Kõigi võimalike käskude nägemiseks anna käsk `help list`, mõne konkreetse käsu abi nägemiseks käsk `help `käsk``.

Käsureal on ka omaenda mälu ehk ajalugu, mis võimaldab uuesti kasutada juba varem antud käske. Ajaloos saab liikuda klahvidega Nool üles ja Nool alla. Varasemate käskude näitamisel valitakse selle argument, mis võimaldab neid kergesti asendada.

### Standardsed käsureakäsud

### Argumenditüübid

TÕEVÄÄRTUS

- Seda kasutatakse käskude puhul, millega saab midagi sisse või välja lülitada. Väärtusteks võivad olla `on` ('sees'), `off` ('väljas'), `true` ('tõene'), `false` ('väär'), `1` või `0`.

TÄISARV

- Täisarv

SÕNE

- String

#### Redaktori põhifunktsioonide käsud

    w

- Aktiivse dokumendi salvestamine.

    wa

- Kõigi parajasti avatud dokumendite salvestamine.

    q

- Aktiivse dokumendi sulgemine.

    qa

- Kõigi avatud dokumentide sulgemine.

    wq

- Aktiivse dokumendi salvestamine ja sulgemine.

    wqa

- Kõigi parajasti avatud dokumentide salvestamine ja sulgemine.

    x

- Aktiivse dokumendi salvestamine ja sulgemine ainult siis, kui seda on muudetud.

    x

- Kõigi parajasti avatud dokumentide salvestamine ja sulgemine ainult siis, kui neid on muudetud.

    bp

- Liikumine dokumentide nimekirja eelmisele dokumendile.

    bn

- Liikumine dokumentide nimekirja järgmisele dokumendile.

    new

- Uue dokumendi avamine rõhtsalt poolitatud vaates.

    vnew

- Uue dokumendi avamine püstiselt poolitatud vaates.

    e

- Aktiivse dokumendi taaslaadimine, kui seda on kettal muudetud.

    enew

- Uue dokumendi muutmine.

    print

- Trükkimisdialoogi avamine aktiivse dokumendi trükkimiseks.

#### Redaktori seadistamise käsud

Neid käske võimaldab kasutada redaktorikomponent ja need on mõeldud ainult aktiivse dokumendi ja vaate seadistamiseks. See on mugav juhul, kui sa ei soovi mingil põhjusel kasutada vaikeseadistusi (näiteks soovid teistmoodi treppida).

    set-tab-widthTÄISARV laius

- Määrab tabelduskoha laiuseks arvu `laius`

    set-indent-widthTÄISARV laius

- Määrab taande laiuseks arvu `laius`. Ainult sel juhul, kui trepitakse tühikutega.

    set-word-wrap-columnTÄISARV laius

- Määrab sõnamurdmise korral rea laiuseks arvu `laius`. Ainult siis, kui teksti automaatne murdmine on sisse lülitatud.

    set-icon-borderTÕEVÄÄRTUS enable

- Ikoonipiirde näitamine.

    set-folding-markersTÕEVÄÄRTUS enable

- Voltimismärkide paneeli näitamine.

    set-line-numbersTÕEVÄÄRTUS enable

- Reanumbrite paneeli näitamine.

    set-replace-tabsTÕEVÄÄRTUS enable

- Sisselülitamisel asendatakse tabeldusmärgid kirjutamise ajal tühimärkidega.

    set-remove-trailing-spaceTÕEVÄÄRTUS enable

- Sisselülitamisel eemaldatakse rea lõpus seisvad tühimärgid kohe pärast seda, kui kursor lahkub realt.

    set-show-tabsTÕEVÄÄRTUS enable

- Sisselülitamisel näidatakse tabeldusmärke ja rea lõpus seisvaid tühimärke väikeste punktidena.

    set-show-indentTÕEVÄÄRTUS enable

- Sisselülitamisel näidatakse treppimist vertikaalse punktidest reana.

    set-indent-spacesTÕEVÄÄRTUS enable

- Sisselülitamisel trepib redaktor igal treppimistasemel `indent-width`'iga määratud tühikutega, mitte aga tabeldusmärgiga.

    set-mixed-indentTÕEVÄÄRTUS enable

- Sisselülitamisel kasutab &kappname; treppimisel tabeldus- ja tühimärkide segu. Iga treppimistase on laiusega `indent-width` ning täiendavaid treppimistasemeid optimeeritakse nii paljude tabeldusmärkide kasutamisega kui võimalik.kui võimalik.

  Käivitamisel rakendab see käsk ka treppimise tühikumärkidega ning kui taande laius ei ole määratud, määratakse see täitmise ajal kogu dokumendile poole `tab-width` väärtusele.

    set-word-wrapTÕEVÄÄRTUS enable

- Dünaamilise reamurdmise sisselülitamine vastavalt `enable` väärtusele.

    set-replace-tabs-saveTÕEVÄÄRTUS enable

- Sisselülitamisel asendatakse tabeldusmärgid dokumendi salvestamisel tühimärkidega.

    set-remove-trailing-space-saveTÕEVÄÄRTUS enable

- Sisselülitamisel eemaldatakse dokumendi salvestamisel ridade lõpust tühikud.

    set-indent-modeSTRING nimi

- Määrab automaatse treppimise režiimiks väärtuse `nimi`. Kui `nimi` pole tuntud, on režiimiks 'none' ehk 'puudub'. Sobivad režiimid on 'none', 'normal', 'cstyle', 'haskell', 'lilypond', 'lisp', 'python', 'ruby' ja 'xml'.

    set-auto-identTÕEVÄÄRTUS nimi

- Automaatse treppimise lubamine või keelamine.

    set-highlightSTRING highlight

- Määrab dokumendi süntaksi esiletõstmise süsteemi. Argument peab olema kehtiv esiletõstu nimi, nagu seda näeb näiteks menüüs Tööriistad Esiletõstmine. Käsk võimaldab argumendi lisamisel kasutada automaatset lõpetamist.

    reload-scripts

- Kõigi Kate kasutatud JacaScripti skriptide taaslaadimine, kaasa arvatud treppimis- ja käsureaskriptid.

    set-wrap-cursorTÕEVÄÄRTUS enable

- Kursori murdmise lubamine või keelamine.

    set-modeTÕEVÄÄRTUS enable

- Failitüübi skeemi valimine aktiivsele dokumendile.

    nn[oremap]STRING originaal STRING seostatud

- Klahvijada `originaal` seostamine jadaga `seostatud`.

#### Redigeerimiskäsud

Nende käskudega saab muuta aktiivset dokumenti.

    indent

- Trepib valitud read või aktiivse rea.

    unindent

- Eemaldab valitud ridade või aktiivse rea treppimise.

    cleanindent

- Puhastab valitud ridade või aktiivse rea treppimise vastavalt dokumendi treppimisseadistustele.

    comment

- Lisab kommentaarimärgid, millega muuta valik või valitud read või aktiivne rida kommentaariks vastavalt tekstivormindusele, mille määrab dokumendi süntaksi esiletõstu definitsioon.

    uncomment

- Eemaldab kommentaarimärgid valikult või valitud ridadelt või aktiivselt realt vastavalt tekstivormindusele, mille määrab dokumendi süntaksi esiletõstu definitsioon.

    kill-line

- Kustutab aktiivse rea.

    replace STRING muster STRING asendus

- Asendab teksti, mille määrab `muster`, tekstiga, mille määrab `asendus`. Kui soovid, et `muster` sisaldaks tühimärki, tuleb nii `muster` kui ka `asendus` muuta ühe- või kahekordsete jutumärkidega tsitaadiks. Kui argumendid pole tsiteeritud, arvab käsk, et esimene sõna on `muster` ja ülejäänud `asendus`. Kui `asendus` andmata jätta, eemaldatakse kogu tekst, kus esineb `muster`.

  Otsingule võib lisada lippe, milleks kirjuta koolon ja selle järele vajalik täht või tähed, nii et käsk võtab kuju `replace:võtmed muster asendus`. Kasutada saab järgmisi võtmeid:

  `b`

- Otsing tagasisuunas

`c`

- Otsing alates kursori asukohast.

`e`

- Otsing ainult valikus.

`r`

- Regulaaravaldise otsing. Selle korral võid anda `\N`, kus N on arv, mis tähistab asendusstringi hõivet.

`s`

- Tõstutundlik otsing.

`p`

- Loa küsimine järgmise asenduse korral.

`w`

- Ainult täissõnade sobivus.

    dateSTRING vorming

- Kuupäeva/kellaajastring lisamine kujul, nagu selle määrab `vorming` või kui seda pole antud, siis kujul yyyy-MM-dd hh:mm:ss. Argument `vorming` võib esineda järgmisel kujul:

  `d` | Päev arvuna ilma alustava nullita (1-31).
  `dd` | Päev arvuna alustava nulliga (01-31).
  `ddd` | Lühendatud ja lokaliseeritud päevanimi (nt. 'Esm', 'Püh').
  `dddd` | Pikk ja lokaliseeritud päevanimi (nt. 'Esmaspäev', 'Pühapäev').
  `M` | Kuu arvuna ilma alustava nullita (1-12).
  `MM` | Kuu arvuna alustava nulliga (01-12).
  `MMM` | Lühendatud ja lokaliseeritud kuunimi (nt. 'Jaan', 'Dets').
  `yy` | Aasta kahekohalise arvuna (00-99).
  `yyyy` | Aasta neljakohalise arvuna (1752-8000).
  `h` | Tunnid ilma alustava nullita (0-23 või 1-12, kui näidatakse AM/PM).
  `hh` | Tunnid alustava nulliga (00-23 või 01-12, kui näidatakse AM/PM).
  `m` | Minutid ilma alustava nullita (0-59).
  `mm` | Minutid alustava nulliga (00-59).
  `s` | Sekundid ilma alustava nullita (0-59).
  `ss` | Sekundid alustava nulliga (00-59).
  `z` | Millisekundid ilma alustava nullita (0-999).
  `zzz` | Millisekundid alustava nulliga (000-999).
  `AP` | AM/PM kasutamine. AP asemele pannakse kas "AM" või "PM".
  `ap` | am/pm kasutamine. ap asemele pannakse kas "am" või "pm".

    charSTRING identifikaator

- See võimaldab sisestada tähemärke nende numbrilise koodi kaudu kümnend-, kaheksand- või kuueteistkümnendvormis. Selle kasutamiseks käivita redigeerimiskäsu dialoog, kirjuta sisendikasti `char: [number]` ja klõpsa nupule OK.

  ##### `char` näited

  Sisend: `char:234`

  Väljund: `ê`

  Sisend: `char:0x1234`

  Väljund: `ሴ`

`s///[ig]` `%s///[ig]`

- See käsk käivitab sedi-sarnase otsi/asenda-operatsiooni aktiivsel real või kogu failis (`%s///`).

  Nii otsitakse tekst läbi, et leida sobivused otsingumustriga, st esimese ja teise kaldkriipsu vahele jääva regulaaravaldisega. Kui sobivus leitakse, asendatakse sobiv tekstiosa avaldisega stringi keskmise ja viimase kaldkriipsu vahel. Sulud otsingumustris tekitavad tagasiviidad, see tähendab, et käsk peab meeles, milline osa sobivusest vastas sulgudes olnule; neid stringe saab otsingumustris uuesti kasutada, viidates neile esimese sulukombinatsiooni puhul kui `\1`, teise puhul kui `\2` jne.

  Otsimaks märki `(` või `)`, tuleb need varjestada längkriipsu kasutades: `\(\)`

  Kui kirjutada avaldise lõppu `i`, ei arvestata sobivuse juures tõstu ehk tähesuurust. Kui kirjutada lõppu `g`, asendatakse kõik mustri sobivused, muidu asendatakse ainult esimene sobivus.

  ##### Teksti asendamine aktiivses reas

  Armas arvuti katkestas just äsja töö ja teatas, et lähtefaili real 3902 mainitud klass `myClass` ei ole defineeritud.

  "Neetud!" mõtled sina: aga muidugi peab see olema `MyClass`. Lähed siis reale 3092 ja selle asemel, et püüda tekstist sõnakest üles leida, käivitad redigeerimiskäsu dialoogi, sisestad seal `s/myclass/MyClass`, vajutad nupule OK, salvestad faili ja kompileerid selle – edukalt ja ilma vigadeta.

  ##### Teksti asendamine kogu failis

  Kujuta ette, et sul on fail, kus esineb mitu korda preili Maasikas, ja siis tuleb keegi, kes ütleb, et too neiu äsja abiellus ja kannab nüüd nime proua Vaarikas. On päris mõistetav, et sind tabab võitmatu iha kirjutada kõikjal tekstis preili Maasikas asemele proua Vaarikas.

  Selleks käivita käsurida, anna käsk `%s/preili Maasikas/proua Vaarikas/`, vajuta klahvi Enter - ja asendused ongi tehtud.

  ##### Nõudlikum näide

  See näide selgitab tagasiviidete ja märgiklasside kasutamist (kui sa ei tea, mis need on, vaata selgitusi edaspidi viidatud dokumentides).

  Oletame, et sul on selline rida:

      void MyClass::DoStringOps( String      &foo, String &bar String *p, int  &a, int &b )

  Äkki taipad, et see pole mitte kõige kaunim kood, ja otsustad kasutada võtit `const` kõigi aadressiargumentide puhul (need on need, mille puhul argumendi ees seisab operaator &). Ühtlasi tahad ühtlustada tühikute kasutamist, nii et iga sõna vahel oleks vaid üks tühik.

  Käivita redigeerimiskäsu dialoog ja sisesta sinna: `s/\s+(\w+)\s+(&)/ const \1 \2/g` ning vajuta nuppu OK. Avaldise lõpus paiknev `g` annab regulaaravaldisele korralduse rekompileerida iga sobivus tagasiviidete säilitamiseks.

  Väljund: `void MyClass::DoStringOps( const String &foo, const String &bar String *p, const int &a, const int &b )`

  Ja ongi valmis! Mis siis tegelikult juhtus? Juhtus see, et me otsisime tühikut (`\s+`), millele järgneks üks või enam tähte (`\w+`), millele omakorda järgneks tühik (`\s+`) ja sellele omakorda ja-märk. Otsingu käigus salvestasime tähekombinatsioonid ja ja-märgid edasiseks kasutamiseks asendusoperatsioonis. Seejärel asendasime sobinud kohad tühikuga, millele järgneb const, millele järgneb tühik, millele järgneb meelde jäetud tähekombinatsioon (`\1`, millele järgneb tühik, millele järgneb meelde jäetud ja-märk (`\2`). Lihtne, eks ju?

  Pane tähele, et mõnel juhul oli täheühendiks String, mõnel juhul aga int, nii et märgiklassi `\w` ja kvantori `+` kasutamine oli väga mõistlik tegu.

    sort

- Valitud teksti või kogu dokumendi sortimine.

    natsort

- Valitud ridade või kogu dokumendi loomulik sortimine.

  ##### `sort` vs. `natsort`

  `sort(a10, a1, a2)` tagastab `a1, a10, a2`

  `natsort(a10, a1, a2)` tagastab `a1, a2, a10`

    moveLinesDown

- Valitud ridade liigutamine alla.

    moveLinesUp

- Valitud ridade liigutamine üles.

    uniq

- Topeltridade eemaldamine valitud tekstist või kogu dokumendist.

    rtrim

- Lõputühikute eemaldamine valitud tekstist või kogu dokumendist.

    ltrim

- Algustühikute eemaldamine valitud tekstist või kogu dokumendist.

    joinSTRING eraldaja

- Valitud ridade või kogu dokumendi ühendamine. Lisavõimalusena võib anda parameetri, mis defineerib eraldaja, näiteks: ``join` ', '`

    rmblank

- Kogu tühiruumi eemaldamine valitud tekstist või kogu dokumendist.

    unwrap

- Valitud teksti või kogu dokumendi reamurdmine.

    eachSTRING skript

- Argumendina antud JavaScripti funktsiooni väljakutsumine valitud ridade loendile ja nende asendamine väljakutse tagastatud väärtusega.

  ##### Valitud ridade ühendamine

  ``each` 'function(lines){return lines.join(", ")}'`

  Või lühemalt:

  ``each` 'lines.join(", ")'`

    filterSTRING skript

- Argumendina antud JavaScripti funktsiooni väljakutsumine valitud ridade loendile ja nende eemaldamine, kui väljakutse tagastab 'väär'.

  ##### Tühjade ridade eemaldamine

  ``filter` 'function(1){return 1.length > 0;}'`

  Või lühemalt:

  ``filter` 'line.length > 0'`

    mapSTRING skript

- Argumendina antud JavaScripti funktsiooni väljakutsumine valitud ridade loendile ja rea asendamine väljakutse väärtusega.

  ##### Tühjade ridade eemaldamine

  ``map` 'function(line){return line.replace(/^s+/,"");}'`

  Või lühemalt:

  ``map` 'line.replace(/^s+/,"")'`

    duplicateLinesUp

- Valitud ridade kloonimine aktiivse valiku kohal.

    duplicateLinesDown

- Valitud ridade kloonimine aktiivse valiku all.

#### Liikumiskäsud

    gotoTÄISARV rida

- Selle käsuga saab liikuda määratud reale.

    grep STRING muster

- Dokumendis regulaaravaldise `mustri` otsimine. Täpsemalt kõneleb sellest regular-expressions

    findSTRING muster

- Selle käsuga saab liikuda sinna, kus esimest korda esineb `muster`. Selle järgmisi esinemisi saab leida menüükäsuga Redigeerimine Otsi järgmine (vaikimisi kiirklahv F3).

  Otsimiskäsku saab täiendavalt seadistada, kui lisada koolon ja selle järele mõni võti, nii et käsk võtab kuju `find:võtmed muster`. Kasutada saab järgmisi võtmeid:

  `b`

- Otsing tagasisuunas

`c`

- Otsing alates kursori asukohast.

`e`

- Otsing ainult valikus.

`r`

- Regulaaravaldise otsing. Selle korral võid anda `\N`, kus N on arv, mis tähistab asendusstringi hõivet.

`s`

- Tõstutundlik otsing.

`w`

- Ainult täissõnade sobivus.

    ifindSTRING muster

- See käsk võimaldab otsimist lennult, see tähendab, otse kirjutamise ajal. Selle käitumist või otsingut saab seadistada käsule koolonit ja selle järele mõnda võtit lisades, nii et käsk võtaks kuju `ifind:võtmed muster`. Kasutada saab järgmisi võtmeid

  `b`

- Otsing tagasisuunas

`r`

- Regulaaravaldise otsing.

`s`

- Tõstutundlik otsing.

`c`

- Otsing alates kursori asukohast.

## Koodi voltimise kasutamine

Koodi voltimine võimaldab peita redaktoris dokumendi osi, muutes nii eriti suured dokumendid lihtsamini jälgitavaks.&kappname; arvutab voltimispiirkondi välja süntaksi esiletõstu definitsioonides antud reeglite põhjal, mistõttu see on kasutatav ainult teatud vormingutes - tavaliselt lähtekoodis, XML-märkekeeles ja muude selliste failide korral. Enamik koodivoltimist toetavaid esiletõstu definitsioone lubab ka kasutajal endal määrata voltimispiirkondi, mida tavaliselt tähistavad võtmesõnad `BEGIN` ja `END`.

Koodivoltimise kasutamiseks lülita sisse voltimismärgid käsuga Vaade Voltimismärkide näitamine. Voltimismärkide paneel vasakus servas näitab graafiliselt voltimispiirkondi, kolmnurgad osutavad antud piirkonnas võimalikele toimingutele: alla suunatud kolmnurk tähendab, et piirkond on avatud ning märgil klõpsamine suleb piirkonna, kusjuures selle asemel kuvatakse paremale osutavat kolmnurka.

Voltimispiirkondades saab kasutada 11 käsku, mida tutvustab lähemalt menüükäskude ülevaade.

Kokku keritud read peetakse faili sulgemisel meeles, nii et kui faili taas avad, on kokkukeritud sõlmed endiselt kokku keritud. See kehtib ka taaslaadimise kohta.

Kui sa ei soovi koodivoltimist kasutada, võid eemaldada märke valiku Voltimismärkide näitamine (kui võimalik) eest redaktori seadistuste välimuse kaardil.

## &kappname; laiendamine skriptidega

Alates &kappname; versioonist 3.4, mis tuleb koos KDE 4.4-ga, saab &kappname; redaktorikomponenti hõlpsalt laiendada skriptidega. Skriptikeeleks on ECMAScript (rohkem tuntud kui JavaScript). &kappname; toetab kaht laadi skripte: taande- ja käsureaskriptid.

### Taandeskriptid

Taandeskriptid või ka treppimisskriptid annavad lähtekoodile selle kirjutamise ajal automaatselt vajaliku taande. Näiteks Enter-klahvi vajutades koodi taandetase tihtipeale suureneb.

Järgnevates sektsioonides kirjeldame samm-sammult lihtsa taandeskripti loomist. Kõigepealt loo uus `*.js`-fail, näiteks `javascript.js` oma kohalikus kodukataloogi kataloogis `$KDEHOME/share/apps/katepart/script`.

#### Taandeskripti päis

Faili `javascript.js` on põimitud kommentaarina ning näeb välja selline:

    /* kate-script
     * name: JavaScript
     * author: Example Name <example.name@some.address.org>
     * license: BSD
     * revision: 1
     * kate-version: 3.4
     * type: indentation
     * required-syntax-style: javascript
     * indent-languages: javascript
     * priority: 0
     * i18n-catalog: mycatalog
     *
     * Rida ilma koolonita ':' peatab päise parsimise. See tähendab, et sa võid siia
     * lisada muud teksti, näiteks üksikasjaliku litsentsi.
     */

Allpool selgitatakse põhjalikult iga kirjet:

- `kate-script` [kohustuslik]: see tekstistring peab esinema `*.js`-faili esimesel real, vastasel juhul jätab &kappname; skripti lihtsalt vahele.

- `name` [kohustuslik]: see on taandeskripti nimi, nagu seda näeb menüüs Tööriistad Treppimine ja seadistustedialoogis.

- `author` [pole kohustuslik]: autori nimi ja kontaktteave.

- `license` [pole kohustuslik]: litsents lühidalt, näiteks BSD või LGPLv3.

- `revision` [kohustuslik]: skripti versioon. Seda arvu tuleb alati suurendada, kui skripti muudetakse.

- `kate-version` [kohustuslik]: &kappname; minimaalne nõutav versioon.

- `type` [kohustuslik]: tüüp peab olema `indentation`, vastasel juhul &kappname; lihtsalt jätab skripti vahele.

- `required-syntax-style` [pole kohustuslik]: komadega eraldatud nõutavate süntaksi esiletõstmise stiilide loend. See on oluline taandeskriptide puhul, mis toetuvad teatavale dokumendis leiduvale esiletõstmise teabele. Kui nõutav süntaksistiil on määratud, saab taandeskripti kasutada ainult siis, kui aktiivne on sobiv esiletõstmise skeem. See takistab sobimatut käitumist, mis võib tekkida, kui taandeskripti kasutatakse eeldatud esiletõstmise skeemita. Näiteks Ruby taandeskript kasutab sellist võimalust failides `ruby.js` ja `ruby.xml`.

- `indent-languages` [pole kohustuslik]: komadega eraldatud süntaksistiilide loend, mille puhul taandeskript suudab korrektselt treppimist rakendada, näiteks c++, java.

- `priority` [pole kohustuslik]: kui teatava esiletõstmisega faili puhul sobib mitu taandeskripti, siis prioriteet määrab, millist neist kasutatakse vaikimisi.

- `i18n-catalog` [pole kohustuslik]: täiendav tõlkesõnumite kataloog (`po`-fail), mis laaditakse kolmanda poole taandemääratluste tõlgete saamiseks.

&kappname; loeb kõik paarid `võti`:`väärtus`, kuni ei leia enam koolonit. See tähendab, et päis võib sisaldada suvalist teksti, näiteks litsentsi, nagu oli näha näites.

#### Taandeskripti lähtekood

Kui päis on defineeritud, siis siin osas saab aimu, kuidas töötab taandeskript ise. Põhimõtteliselt näeb see välja nii:

    triggerCharacters = "{}/:;";
    function indent(line, indentWidth, ch)
    {
        // called for each newline (ch == '\n') and all characters specified in
        // the global variable triggerCharacters. When calling ToolsAlign
        // the variable ch is empty, i.e. ch == ''.
        //
        // see also: Scripting API
        return -2;
    }

Funktsioonil `indent()` on kolm parameetrit:

- `line`: rida, mida asutakse treppima

- `indentWidth`: treppimise ehk taande laius tühimärkide hulgana

- `ch`: kas reavahetuse sümbol (`ch == '\n'`), käivitamissümbol, mille määrab kindlaks `triggerCharacters` või ka tühi, kui kasutaja kustub välja toimingu Tööriistad Joondamine.

Funktsiooni `indent()` tagastatav väärtus määrab, kuidas rida trepitakse. Kui tagastatud väärtus on lihtsalt täisarv, tõlgendatakse seda järgnevalt:

- tagastatud väärtus `-2`: ei tehta midagi

- tagastatud väärtus `-1`: säilitatakse taandus (otsitakse eelmist mittetühja rida)

- tagastatud väärtus `0`: arv >= 0 määrab taandesügavuse tühimärkide arvuna

Teise võimalusena tagastatakse kahest elemendist koosnev massiiv:

- `return [ indent, align ];`

Sel juhul on esimene element taandesügavus nagu ülal ja samade eriväärtustega. Teine element on aga absoluutväärtus, mis tähistab joonduse veergu. Kui see väärtus on suurem kui taande väärtus, tähistab nende erinevus tühimärkide arvu, mis tuleb lisada esimese parameetriga määratud taande järele. Muul juhul teist arvu eiratakse. Tabeldusmärkide ja tühimärkide kasutamist treppimisel nimetatakse sageli segarežiimiks.

Vaatame järgmist näidet. Eeldame, et treppimiseks kasutatakse tabeldusmärke ning nende laiuseks on määratud 4. <tab> tähistab tabeldusmärki ja '.' tühimärki:

    1: <tab><tab>foobar("hello",
    2: <tab><tab>......."world");

Teise taandega rea puhul tagastab funktsioon `indent()` [8, 15]. Seepärast lisatakse kaks tabeldusmärki veeru 8 treppimiseks ning 7 tühimärki teise parameetri joondamiseks esimese alla, et see oleks joondatud ka siis, kui faili vaadatakse mõne muu tabeldusmärgi laiusega.

KDE vaikimisi paigalduse puhul pakub &kappname; mitut taandeskripti. Vastava JavaScripti lähtekoodi leiab kataloogist `$KDEDIR/share/apps/katepart/script`.

Taandeskripti arendamiseks tuleb skriptid taaslaadida, et näha, kas muudatused, mida nad teevad, on korrektsed. Terve rakenduse taaskäivitamise asemel lülitu lihtsalt käsureale ja anna käsk `reload-scripts`.

Kui lood mõne kasuliku skripti, võiksid kaaluda selle annetamist ka &kappname; hüvanguks. Selleks võib ühendust võtta postiloendis.

### Käsureaskriptid

Et kõigi vajadusi on ühekorraga raske rahuldada, toetab &kappname; pisikesi abitööriistu teksti kiireks töötlemiseks sisseehitatud käsurea abil. Näiteks käsk `sort` on teostatud skriptina. Järgnevas osas selgitatakse, kuidas luua `*.js`-faile &kappname; laiendamiseks mis tahes abiskriptidega.

Käsureaskriptid paiknevad samas kataloogis taandeskriptidega. Niisiis, esimese sammuna loo uus `*.js`-fail nimega `myutils.js` kohalikus kodukataloogis `$KDEHOME/share/apps/katepart/script`.

#### Käsureaskripti päis

Kõigi käsureaskriptide päis on põimitud kommentaarina ning näeb välja selline:

    /* kate-script
     * author: Example Name <example.name@some.address.org>
     * license: BSD
     * revision: 1
     * kate-version: 3.4
     * type: commands
     * functions: sort, format-paragraph
     * i18n-catalog: mycatalog
     *
     * Rida ilma koolonita ':' peatab päise parsimise. See tähendab, et sa võid siia
     * lisada muud teksti, näiteks üksikasjaliku litsentsi.
     */

Allpool selgitatakse põhjalikult iga kirjet:

- `kate-script` [kohustuslik]: see tekstistring peab esinema `*.js`-faili esimesel real, vastasel juhul jätab &kappname; skripti lihtsalt vahele.

- `author` [pole kohustuslik]: autori nimi ja kontaktteave.

- `license` [pole kohustuslik]: litsents lühidalt, näiteks BSD või LGPLv3.

- `revision` [kohustuslik]: skripti versioon. Seda arvu tuleb alati suurendada, kui skripti muudetakse.

- `kate-version` [kohustuslik]: &kappname; minimaalne nõutav versioon.

- `type` [kohustuslik]: tüüp peab olema `commands`, vastasel juhul &kappname; lihtsalt jätab skripti vahele.

- `functions` [kohustuslik]: komadega eraldatud skripti käskude loend.

- `i18n-catalog` [pole kohustuslik]: täiendav tõlkesõnumite kataloog (`po`-fail), mis laaditakse kolmanda poole skriptide tõlgete saamiseks.

&kappname; loeb kõik paarid `võti`:`väärtus`, kuni ei leia enam koolonit. See tähendab, et päis võib sisaldada suvalist teksti, näiteks litsentsi, nagu ka eespool olnud näiteks. Võtme functions väärtus on komadega eraldatud käsureakäskude loend. See tähendab, et üks skript võib sisaldada suvalisel hulgal käsureakäske. Kõik funktsioonid on saadaval &kappname; sisseehitatud käsurea vahendusel.

#### Skripti lähtekood

Kõik päises osutatud funktsioonid tuleb skriptis teostada. Nii peab näiteks ülaltoodud näites esitatud skript teostama kaks funktsiooni: `sort` ja `format-paragraph`. Kõigil funktsioonidel on järgmine süntaks:

    function <nimi>(arg1, arg2, ...)
    {
        // ... implementation, see also: Scripting API
    }

Argumendid edastatakse käsureal funktsioonile kujul `arg1`, `arg2` jne. Kõigi käskude kohta dokumentatsiooni pakkumiseks teosta lihtsalt funktsioon '`help`':

    function help(cmd)
    {
        if (cmd == "sort") {
            return i18n("Sort the selected text.");
        } else if (cmd == "...") {
            // ...
        }
    }

Käsureal `help sort` käivitamine kutsub välja abifunktsiooni argumendiga `cmd`, mille väärtuseks on määratud antud käsk, s.t `cmd == "sort"`. &kappname; tagastab seejärel teksti kasutajale nähtava dokumentatsioonina. Kontrolli kindlasti, et ikka tõlgid stringid.

##### Kiirklahvid

Kiirklahvide omistamiseks peab skript pakkuma järgmisel moel funktsiooni `action`:

    function action(cmd)
    {
        var a = new Object();
        if (cmd == "sort") {
            a.text = i18n("Sort Selected Text");
            a.icon = "";
            a.category = "";
            a.interactive = false;
            a.shortcut = "";
        } else if (cmd == "moveLinesDown") {
            // same for next action
        }
        return a;
    }

Funktsiooni parameeter `cmd` määrab käsu, mille jaoks kiirklahv on mõeldud. Tagastatavas JavaScripti objektis tuleb määrata ära mitu välja:

- `a.text` [kohustuslik]: tekst, mida näeb menüüs Tööriistad Skriptid. Kontrolli, et kasutaksid tõlgete jaoks `i18n`.

- `a.icon` [pole kohustuslik]: ikoon, mida näeb menüüs teksti kõrval. Siin võib kasutada kõiki KDE ikooninimesid.

- `a.category` [pole kohustuslik]: kategooria määramisel näeb skripti alammenüüs. Kontrolli, et kasutaksid tõlgete jaoks `i18n`.

- `a.interactive`: kui skript vajab kasutajapoolset sisendit, tuleb selle väärtuseks määrata `true`.

- `a.shortcut` [pole kohustuslik]: siin määratud kiirklahv on vaikimisi kiirklahv. Näide: Ctrl+Alt+t. Täpsemalt kõneldakse sellest Qt dokumentatsioonis.

Käsureaskripti arendamiseks tuleb skriptid taaslaadida, et näha, kas muudatused, mida nad teevad, on korrektsed. Terve rakenduse taaskäivitamise asemel lülitu lihtsalt käsureale ja anna käsk `reload-scripts`.

Kui lood mõne kasuliku skripti, võiksid kaaluda selle annetamist ka &kappname; hüvanguks. Selleks võib ühendust võtta postiloendis.

### Skriptimise API

Allpool esitatud skriptimise API kehtib kõigi skriptide, s.t nii taande- kui ka käsureakäskude skriptide kohta. Enne skripti sisu laadimist lisab &kappname; kõigepealt skriptimiskontekstile mõned prototüübid ja funktsioonid. Seepärast sisaldabki API prototüüpe tekstikursorite ja tekstivahemike kujul ning neid võib leida kataloogis `$KDEDIR/share/apps/katepart/api`. Kõigi JavaScripti failide nimed vastavad järgmisele skeemile:

    <arv>_<nimi>.js

Arvul on kaks kohta, nimi aga on suvaline nimi, näiteks `myutils`. Arvude abil kontrollib &kappname; API täitmise järjekorda. Nii kutsutakse fail `05_cursor.js` välja enne faili `10_range.js`. (Samasugune käivitamise järjekord kehtib näiteks Linuxis käitustasemete puhul.)

Standardse skriptimise API laiendamiseks oma funktsioonide ja prototüüpidega loo lihtsalt uus fail KDE kohalikus seadistuste kataloogis `$KDEHOME/share/apps/katepart/api` ja kanna hoolt, et selle arv (täitmise järjekord) oleks suurem kui teistel `*.js`-failidel globaalses kataloogis `$KDEDIR/share/apps/katepart/api`. &kappname; otsib automaatselt mõlemast kataloogis `*.js`-faile ja käivitab need õiges järjekorras.

Olemasolevate prototüüpide, näiteks `Cursor` või `Range`, laiendamiseks ei ole soovitatav muuta globaalseid `*.js`-faile. Selle asemel loo `*.js`-fail kohalikus kataloogis, mis käivitatakse hiljem kui `05_cursor.js` ja seejärel muuda prototüüpi `Cursor` JavaScriptis.

#### Kursorid ja vahemikud

Kuna &kappname; on tekstiredaktor, siis on kogu skriptimise API aluseks, nii palju kui võimalik, kursorid ja vahemikud. Kursor kujutab endast lihtsat `(rida,veerg)` määratlust, mis näitab ära teksti asukoha dokumendis. Vahemik aga paneb paika tekstivahemiku kursori algasukohast selle lõppasukohani. API seletatakse üksikasjalikult lahti järgmistes lõikudes.

##### Kursori prototüüp

    Cursor();

- Konstruktor. Tagastab kursori asukohas `(0, 0)`.

  Näide: `var cursor = new Cursor();`

    Cursor(int rida, int veerg);

- Konstruktor. Tagastab kursori asukohas (rida, veerg).

  Näide: `var cursor = new Cursor(3, 42);`

    Cursor(Cursor other);

- Koopia konstruktor. Tagastab kursori koopia `other`.

  Näide: `var copy = new Cursor(other);`

    Cursor Cursor.clone();

- Tagastab kursori klooni.

  Näide: `var clone = cursor.clone();`

    bool Cursor.isValid();

- Kontrollib, kas kursor on korrektne. Kursor ei ole korrektne, kui rida ja/või veeru väärtuseks on määratud `-1`.

  Näide: `var valid = cursor.isValid();`

    Cursor Cursor.invalid();

- Tagastab uue ebakorrektse kursori asukohas `(-1, -1)`.

  Näide: `var invalidCursor = cursor.invalid();`

    int Cursor.compareTo(Cursor other);

- Võrdleb antud kursorit kursoriga `other`. Tagastab

  - `-1`, kui antud kursor paikneb enne kursorit `other`,

  - `0`, kui mõlemad kursorid on võrdsed,

  - `-+1`, kui antud kursor paikneb pärast kursorit `other`.

    bool Cursor.equals(Cursor other);

- Tagastab `true`, kui antud kursor ja kursor `other` on võrdsed, vastasel juhul `false`.

    String Cursor.toString();

- Tagastab kursori stringina kujul `Cursor(rida, veerg)`.

##### Vahemiku prototüüp

    Range();

- Konstruktor `new Range()` väljakutsumine tagastab vahemiku (0, 0) - (0, 0).

    Range(Cursor algus, Cursor lõpp);

- Konstruktor `new Range(`algus`, `lõpp`)` väljakutsumine tagastab vahemiku (`algus`, `lõpp`).

    Range(int algusRida, int algusVeerg, int lõppRida, int lõppVeerg);

- Konstruktor. `new Range(`algusRida`, `algusVeerg`, `lõppRida`, `lõppVeerg`)` tagastab vahemiku alates (`algusRida`, `algusVeerg`) kuni (`lõppRida`, `lõppVeerg`).

    Range(Range other);

- Koopia konstruktor. Tagastab vahemiku koopia `other`.

    Range Range.clone();

- Tagastab vahemiku klooni.

  Näide: `var clone = range.clone();`

    bool Range.isValid();

- Tagastab `true`, kui nii algus- kui ka lõppkursor on korrektsed, vastasel juhul `false`.

  Näide: `var valid = range.isValid();`

    bool Range.invalid();

- Tagastab vahemiku alates (-1, -1) kuni (-1, -1).

    bool Range.contains(Cursor kursor);

- Tagastab `true`, kui antud vahemik sisaldab kursori asukohta, vastasel juhul `false`.

    bool Range.contains(Range other);

- Tagastab `true`, kui antud vahemik sisaldab vahemikku `other`, vastasel juhul `false`.

    bool Range.containsColumn(int veerg);

- Tagastab `true`, kui `veerg` paikneb vahemikus `[start.column, end.column)`, vastasel juhul `false`.

    bool Range.containsLine(int rida);

- Tagastab `true`, kui `rida` paikneb vahemikus `[start.line, end.line)`, vastasel juhul `false`.

    bool Range.overlaps(Range other);

- Tagastab `true`, kui antud vahemikul ja vahemikul `other` on ühine piirkond, vastasel juhul `false`.

    bool Range.overlapsLine(int rida);

- Tagastab `true`, kui `rida` paikneb vahemikus `[start.line, end.line]`, vastasel juhul `false`.

    bool Range.overlapsColumn(int veerg);

- Tagastab `true`, kui `veerg` paikneb vahemikus `[start.column, end.column]`, vastasel juhul `false`.

    bool Range.equals(Range other);

- Tagastab `true`, kui antud vahemik ja vahemik `other` on võrdsed, vastasel juhul `false`.

    String Range.toString();

- Tagastab vahemiku stringina kujul `Range(Cursor(rida, veerg), Cursor(rida, veerg))`.

#### Globaalsed funktsioonid

See sektsioon loetleb kõik globaalsed funktsioonid.

##### Silumine

    void debug(String tekst);

- Näitab `tekst`i standardväljundis `stdout` samas konsoolis, kus rakendus käivitati.

##### Tõlkimine

Täieliku lokaliseerimise pakkumiseks on olemas mitu funktsiooni, mille abil tõlkida skriptide stringe, nimelt `i18n`, `i18nc`, `i18np` ja `i18ncp`. Need funktsioonid toimivad täpselt nii nagu KDE tõlkimisfunktsioonid.

Tõlkimisfunktsioonid tõlgivad tõlkimiseks määratud stringid KDE tõlkesüsteemi kaudu rakenduse kasutatavasse keelde. Ametlikus &kappname; lähtekoodis arendatud skriptide stringid hangitakse ja tõlgitakse automaatselt. See tähendab, et &kappname; arendajana ei ole vaja pead vaevata tõlkesõnumite saatusega. Kuid kolmanda poole skriptide puhul, mida arendatakse väljaspool KDE-d, tuleb sõnumid ise kätte saada ja tõlkida lasta. Skriptiga tuleb kaasa panna tõlkekataloog, mis sisaldab kõiki tõlgitavaid stringe. Lisaks peab skripti päises konkreetselt ära määrama laaditava kataloogi, milleks on mõeldud `i18n-catalog`.

    void i18n(String tekst, arg1, ...);

- Tõlgib `tekst`i rakenduse kasutatavasse keelde. Argumendid `arg1`, ... ei ole kohustuslikud ning neid kasutatakse kohatäitjate `%1`, `%2` jne. asendamiseks.

    void i18nc(String kontekst, String tekst, arg1, ...);

- Tõlgib `tekst`i rakenduse kasutatavasse keelde. Lisaks näevad tõlkijad stringi `kontekst`, mis aitab neil paremini leida õiget tõlkevastet. Argumendid `arg1`, ... ei ole kohustuslikud ning neid kasutatakse kohatäitjate `%1`, `%2` jne. asendamiseks.

    void i18np(String ainsus, String mitmus, int arv, arg1, ...);

- Tõlgib kas `ainsus`e või `mitmus`e rakenduse kasutatavasse keelde sõltuvalt määratud `arv`ust. Argumendid `arg1`, ... ei ole kohustuslikud ning neid kasutatakse kohatäitjate `%1`, `%2` jne. asendamiseks.

    void i18ncp(String kontekst, String ainsus, String mitmus, int arv, arg1, ...);

- Tõlgib kas `ainsus`e või `mitmus`e rakenduse kasutatavasse keelde sõltuvalt määratud `arv`ust. Lisaks näevad tõlkijad stringi `kontekst`, mis aitab neil paremini leida õiget tõlkevastet. Argumendid `arg1`, ... ei ole kohustuslikud ning neid kasutatakse kohatäitjate `%1`, `%2` jne. asendamiseks.

#### Vaate API

Skripti käivitamisel on alati olemas globaalne muutuja `view`, mis tähistab aktiivset redaktorivaadet. Järgnevalt on loetletud saadaolevad vaatefunktsioonid.

    Cursor view.cursorPosition()

- Tagastab aktiivse kursori asukoha vaates.

    void view.setCursorPosition(int rida, int veerg)
    void view.setCursorPosition(Cursor kursor)

- Tagastab aktiivse kursori asukoha vaates.

    void view.setCursorPosition(int rida, int veerg);
    void view.setCursorPosition(Cursor kursor);

- Määrab aktiivse kursori asukoha kas (rida, veerg) või määratud kursori järgi.

    Cursor view.virtualCursorPosition();

- Tagastab virtuaalse kursori asukoha tabeldusmärgis, arvestades tabeldusmärgile taande puhul määratud tühimärkide arvu.

    void view.setVirtualCursorPosition(int rida, int veerg);
    void view.setVirtualCursorPosition(Cursor kursor);

- Määrab aktiivse virtuaalse kursori asukoha kas (rida, veerg) või määratud kursori järgi.

    String view.selectedText();

- Tagastab valitud teksti. Kui teksti pole valitud, on tagastatav string tühi.

    bool view.hasSelection();

- Tagastab `true`, kui vaade sisaldab valitud teksti, vastasel juhul `false`.

    Range view.selection();

- Tagastab valitud teksti vahemiku. Tagastatud vahemik on vigane, kui teksti pole valitud.

    void view.setSelection(Range vahemik);

- Määrab valitud teksti valitud vahemikku.

    void view.removeSelectedText();

- Eemaldab valitud teksti. Kui vaates pole valitud teksti, ei tee midagi.

    void view.selectAll();

- Valib kogu dokumendi teksti.

    void view.clearSelection();

- Puhastab tekstivaliku ilma teksti eemaldamata.

#### Dokumendi API

Skripti käivitamisel on alati olemas globaalne muutuja `document`, mis tähistab aktiivset dokumenti. Järgnevalt on loetletud saadaolevad dokumendifunktsioonid.

    String document.fileName();

- Tagastab dokumendi failinime või tühja stringi salvestamata tekstipuhvri korral.

    String document.url();

- Tagastab dokumendi täieliku URL-i või tühja stringi salvestamata tekstipuhvri korral.

    String document.mimeType();

- Tagastab dokumendi MIME tüübi või MIME tüübi `application/octet-stream`, kui sobivat MIME tüüpi ei leita.

    String document.encoding();

- Tagastab faili salvestamisel kasutatava kodeeringu.

    String document.highlightingMode();

- Tagastab kogu dokumendis kasutatava globaalse esiletõstmise režiimi.

    String document.highlightingModeAt(Cursor asukoht);

- Tagastab dokumendi määratud asukohas kasutatava esiletõstmise režiimi.

    Array document.embeddedHighlightingModes();

- Tagastab dokumenti põimitud esiletõstmise režiimide massiivi.

    bool document.isModified();

- Tagastab `true`, kui dokument sisaldab salvestamata muudatusi, vastasel juhul `false`.

    String document.text();

- Tagastab kogu dokumendi sisu üheainsa tekstistringina. Reavahetusi tähistavad reavahetussümbolid `\n`.

    String document.text(int alatesReast, int alatesVeerust, int kuniReani, int kuniVeeruni);
    String document.text(Cursor alates, Cursor kuni);
    String document.text(Range vahemik);

- Tagastab teksti määratud vahemikust. Lähtekoodi parema loetavuse huvides on soovitatav kasutada kursorile ja vahemikule tuginevaid versioone.

    String document.line(int rida);

- Tagastab valitud teksti stringina. String on tühi, kui soovitud rida jääb vahemikust välja.

    String document.wordAt(int rida, int veerg);
    String document.wordAt(Cursor kursor);

- Tagastab sõna määratud kursori asukohas.

    String document.charAt(int rida, int veerg);
    String document.charAt(Cursor kursor);

- Tagastab sümboli määratud kursori asukohas.

    String document.firstChar(int rida);

- Tagastab määratud `rea`

    String document.lastChar(int rida);

- Tagastab määratud `rea` esimese märgi, mis ei ole tühimärk. Kui rida on tühi või sisaldab ainult tühimärke, on tagastatud string tühi.

    bool document.isSpace(int rida, int veerg);
    bool document.isSpace(Cursor kursor);

- Tagastab `true`, kui määratud kursori asukohas paiknev märk on tühimärk, vastasel juhul `false`.

    bool document.matchesAt(int rida, int veerg, int rida, String tekst);
    bool document.matchesAt(Cursor kursor, String tekst);

- Tagastab `true`, kui määratud `tekst` sobib tekstiga määratud kursori asukohas, vastasel juhul `false`.

    bool document.startsWith(int rida, String tekst, bool skipWhiteSpaces);

- Tagastab `true`, kui rida algab `tekstiga`, vastasel juhul `false`. Argument `skipWhiteSpaces` määrab, kas alustavaid tühimärke eiratakse või mitte.

    bool document.endsWith(int rida, String tekst, bool skipWhiteSpaces);

- Tagastab `true`, kui rida lõpeb `tekstiga`, vastasel juhul `false`. Argument `skipWhiteSpaces` määrab, kas lõpetavaid tühimärke eiratakse või mitte.

    bool document.setText(String tekst);

- Määrab kogu dokumendi teksti.

    bool document.clear();

- Eemaldab kogu dokumendi teksti.

    bool document.truncate(int rida, int veerg);
    bool document.truncate(Cursor kursor);

- Kärbib määratud rea määratud veeruga või kursori asukohaga. Tagastab `true` õnnestumise korral või `false`, kui määratud rida ei kuulu dokumendi vahemikku.

    bool document.insertText(int rida, int veerg, int rida, String tekst);
    bool document.insertText(Cursor kursor, String tekst);

- Lisab `teksti` määratud kursori asukohta. Tagastab `true` õnnestumise korral või `false`, kui dokument on kirjutuskaitstud.

    bool document.removeText(int alatesReast, int alatesVeerust, int kuniReani, int kuniVeeruni);
    bool document.removeText(Cursor alates, Cursor kuni);
    bool document.removeText(Range vahemik);

- Eemaldab teksti määratud vahemikus. Tagastab `true` õnnestumise korral või `false`, kui dokument on kirjutuskaitstud.

    bool document.insertLine(int rida, String tekst);

- Lisab teksti määratud reale. Tagastab `true` õnnestumise korral või `false`, kui dokument on kirjutuskaitstud või rida ei paikne dokumendi vahemikus.

    bool document.removeLine(int rida);

- Eemaldab määratud tekstirea. Tagastab `true` õnnestumise korral või `false`, kui dokument on kirjutuskaitstud või rida ei paikne dokumendi vahemikus.

    void document.joinLines(int algusRida, int lõppRida);

- Ühendab read alates `algusRida` to `lõppRida`. Kaht järjestikust tekstirida eraldab alati üks tühik.

    int document.lines();

- Tagastab dokumendi ridade arvu.

    int document.length();

- Tagastab dokumendi sümbolite arvu.

    int document.lineLength(int rida);

- Tagastab `rea` pikkuse.

    void document.editBegin();

- Alustab redigeerimisrühma tagasivõtmiste või uuestitegemiste rühmitamiseks. Kontrolli, et `editEnd()` oleks alati sama palju välja kutsutud kui `editBegin()`. `editBegin()` väljakutse kasutab seesmiselt referentsarvestit, s.t selle väljakutse korral on võimalik pesastamine.

    void document.editEnd();

- Lõpetab redigeerimisrühma. Viimane `editEnd()` väljakutse (s.t see, mis vastab esimesele `editBegin()` väljakutsele) lõpetab redigeerimisastme.

    int document.firstColumn(int rida);

- Tagastab määratud `rea` esimese mittetühimärgiga veeru. Kui real on ainult tühimärgid, tagastatakse `-1`.

    int document.lastColumn(int rida);

- Tagastab määratud `rea` viimase mittetühimärgiga veeru. Kui real on ainult tühimärgid, tagastatakse `-1`.

    int document.prevNonSpaceColumn(int rida, int veerg);
    int document.prevNonSpaceColumn(Cursor kursor);

- Tagastab mittetühimärkidega veeru alates aktiivsest kursori asukohast tagasisuunas otsides.

    int document.nextNonSpaceColumn(int rida, int veerg);
    int document.nextNonSpaceColumn(Cursor kursor);

- Tagastab mittetühimärkidega veeru alates aktiivsest kursori asukohast edasisuunas otsides.

    int document.prevNonEmptyLine(int rida);

- Tagastab järgmise mittetühimärkidega mittetühja rea, otsides tagasisuunas.

    int document.nextNonEmptyLine(int rida);

- Tagastab järgmise mittetühimärkidega mittetühja rea, otsides edasisuunas.

    bool document.isInWord(String sümbol, int atribuut);

- Tagastab `true`, kui määratud `sümbol` määratud `atribuudiga` võib olla sõna osa, vastasel juhul `false`.

    bool document.canBreakAt(String sümbol, int atribuut);

- Tagastab `true`, kui määratud `sümbol` määratud `atribuudiga` sobib reamurdmiseks, vastasel juhul `false`.

    bool document.canComment(int algusAtribuut, int lõppAtribuut);

- Tagastab `true`, kui määratud atribuudiga algav ja lõppev vahemik sobib kommenteerimiseks, vastasel juhul `false`.

    String document.commentMarker(int atribuut);

- Tagastab kommentaaritähise määratud `atribuudiga` üherealise kommentaari puhul.

    String document.commentStart(int atribuut);

- Tagastab kommentaaritähise määratud `atribuudiga` mitmerealise kommentaari alguse puhul.

    String document.commentEnd(int atribuut);

- Tagastab kommentaaritähise määratud `atribuudiga` mitmerealise kommentaari lõpu puhul.

    int document.attribute(int rida, int veerg);
    int document.attribute(Cursor kursor);

- Tagastab atribuudi määratud kursori asukohas.

    bool document.isAttribute(int rida, int veerg, int atribuut);
    bool document.isAttribute(Cursor kursor, int atribuut);

- Tagastab `true`, kui kursori asukohas paiknev atribuut on võrdne `atribuudiga`, vastasel juhul `false`.

    String document.attributeName(int rida, int veerg);
    String document.attributeName(Cursor kursor);

- Tagastab atribuudi nime inimloetava tekstina. See võrdub nimega `itemData` süntaksi esiletõstmise failides.

    bool document.isAttributeName(int rida, int veerg, String nimi);
    bool document.isAttributeName(Cursor kursor, String nimi);

- Tagastab `true`, kui kursori asukohas paikneva atribuudi nimi sobib määratud `nimega`, vastasel juhul `false`.

    String document.variable(String võti);

- Tagastab soovitud dokumendi muutuja `võti` väärtuse. Kui dokumendi muutujat ei ole olemas, tagastatakse tühi string.

    String document.setVariable(String võti, String väärtus);

- Soovitud dokumendi muutuja `võtme` väärtuse määramine. Tagastab määratud muutuja väärtuse.

  Vaata ka: Kate dokumendi muutujad

  Alates: KDE 4.8

    int document.firstVirtualColumn(int rida);

- Tagastab määratud rea esimese mittetühimärgi virtuaalse veeru või `-1`, kui rida on tühi või sisaldab ainult tühimärke.

    int document.lastVirtualColumn(int rida);

- Tagastab määratud rea viimase mittetühimärgi virtuaalse veeru või `-1`, kui rida on tühi või sisaldab ainult tühimärke.

    int document.toVirtualColumn(int rida, int veerg);
    int document.toVirtualColumn(Cursor kursor);
    Cursor document.toVirtualCursor(Cursor kursor);

- Teisendab määratud reaalse kursori asukoha virtuaalseks kursori asukohaks, tagastades täisarvu või objekti Cursor.

    int document.fromVirtualColumn(int rida, int virtuaalneVeerg);
    int document.fromVirtualColumn(Cursor virtuaalneKursor);
    Cursor document.fromVirtualCursor(Cursor virtuaalneKursor);

- Teisendab määratud virtuaalse kursori asukoha reaalseks kursori asukohaks. tagastades täisarvu või objekti Cursor.

    Cursor document.anchor(int rida, int veerg, Char sümbol);
    Cursor document.anchor(Cursor kursor, Char sümbol);

- Otsib määratud sümbolit tagasisuunas alates määratud kursorist. Kui näiteks '(' edastatakse sümbolina, tagastab see funktsioon avava '(' asukoha. Referentsarvestust, s.t teisi '(...)', eiratakse.

    Cursor document.rfind(int rida, int veerg, String tekst, int atribuut = -1);
    Cursor document.rfind(Cursor kursor, String tekst, int atribuut = -1);

- Otsib tagasisuunas määratud teksti sobiva `atribuudiga`. Argumenti `atribuut` eiratakse, kui selle väärtuseks on määratud `-1`. Tagastatud kursor on vigane, kui teksti ei leita.

    int document.defStyleNum(int rida, int veerg);
    int document.defStyleNum(Cursor kursor);

- Tagastab määratud kursori asukohas kasutatud vaikimisi stiili.

    bool document.isCode(int rida, int veerg);
    bool document.isCode(Cursor kursor);

- Tagastab `true`, kui määratud kursori asukohas paiknev atribuut ei ole võrdne kõigi järgnevate stiilidega: `dsComment`, `dsString`, `dsRegionMarker`, `dsChar`, `dsOthers`.

    bool document.isComment(int rida, int veerg);
    bool document.isComment(Cursor kursor);

- Tagastab `true`, kui kursori asukohas paikneva sümboli atribuut on `dsComment`, vastasel juhul `false`.

    bool document.isString(int rida, int veerg);
    bool document.isString(Cursor kursor);

- Tagastab `true`, kui kursori asukohas paikneva sümboli atribuut on `dsString`, vastasel juhul `false`.

    bool document.isRegionMarker(int rida, int veerg);
    bool document.isRegionMarker(Cursor kursor);

- Tagastab `true`, kui kursori asukohas paikneva sümboli atribuut on `dsRegionMarker`, vastasel juhul `false`.

    bool document.isChar(int rida, int veerg);
    bool document.isChar(Cursor kursor);

- Tagastab `true`, kui kursori asukohas paikneva sümboli atribuut on `dsChar`, vastasel juhul `false`.

    bool document.isOthers(int rida, int veerg);
    bool document.isOthers(Cursor kursor);

- Tagastab `true`, kui kursori asukohas paikneva sümboli atribuut on `dsOthers`, vastasel juhul `false`.