# Geavanceerde hulpmiddelen voor bewerking

## Commentaar toevoegen/verwijderen

Met de commando's "Commentaar" en "Commentaar verwijderen" in het menu Hulpmiddelen kunt u commentaarmarkering aan geselecteerde regels toevoegen of eruit verwijderen, mits commentaren door het bestandsformaat waar u aan werkt worden ondersteund. Als er geen tekst geselecteerd is wordt de huidige regel gebruikt.

De regels over de wijze waarop commentaar ingevoegd wordt, zijn vastgelegd in de syntaxisdefinities. Als syntaxisaccentuering niet gedefinieerd is, zal commentaar invoegen/verwijderen niet mogelijk zijn.

Sommige syntaxisdefinities definiëren commentaarmarkeringen per regel, sommige definiëren markeringen die over meedere regels kunnen lopen, en sommige definiëren beide. Indien er per regel gemarkeerd wordt, is het niet mogelijk om een selectie te markeren waarvan de laatste regel niet volledig is geselecteerd.

Wanneer commentaarmarkering per regel mogelijk is, dan zal dit de voorkeur hebben. Het voorkomt namelijk problemen met genest commentaar (commentaar binnen commentaar).

Wanneer commentaar verwijderd wordt, mogen er geen regels geselecteerd zijn die geen commentaar bevatten. Wanneer er commentaar dat over meerdere regels loopt verwijderd wordt, zullen eventuele spaties aan het begin en einde genegeerd worden.

Om een gedeelte te markeren als commentaar kiest u het menu Hulpmiddelen Commentaar. U kunt ook de sneltoetsen &Ctrl;D gebruiken.

Om commentaar te verwijderen kiest u het menu Hulpmiddelen Commentaar verwijderen. U kunt ook de sneltoetsen &Ctrl;&Shift; D gebruiken.

## De commandoregel in de editor

De editor-component van &kappname; beschikt over een interne commandoregel, zodat u diverse commando's direct, zonder uitgebreide GUI, kunt uitvoeren. De commandoregel bevindt zich onder het editor-gedeelte. Om hiermee te werken gebruikt u het menu Beeld Overschakelen naar commandoregel of drukt u op F7. De commando's van de editor worden hieronder beschreven, extra commando's kunnen door plugins geleverd worden.

Om een commando uit te voeren, typt u het commando en daarna drukt u op de Enter-toets. Op de commandoregel verschijnt een melding over het al dan niet slagen van de opdracht. Als u de commandoregel via F7 geopend hebt, zal deze automatisch na een paar seconden verdwijnen. Om de melding te verwijderen en een nieuw commando te typen drukt u nogmaals op F7.

Typ `help` om de ingebouwde help van de commandoregel te zien. Typ `help list` om een lijst met beschikbare commando's te zien. Om de help voor een specifiek commando te zien, typt u `help `commando``.

De commandoregel houdt de geschiedenis van ingetypte commando's bij in een lijst, zodat u eerder getypte commando's opnieuw kunt gebruiken. Gebruik de toetsen Pijl omhoog en Pijl omlaag om door de lijst te navigeren. Wanneer een commando uit de lijst getoond wordt, is het argument-gedeelte geselecteerd, zodat u dit gemakkelijk kunt overschrijven.

### Standaard commandoregel opdrachten

### Argumenttypen

BOOLEAN

- Dit wordt gebruikt met commando's die iets aan- of uitzetten. Toegestane waarden zijn `on`, `off`, `true`, `false`, `1` of `0`.

INTEGER

- Een geheel getal

STRING

- Een tekenreeks

#### Commando's voor de basis bewerkingsfuncties

    w

- Het huidige document opslaan.

    wa

- Alle huidige geopende documenten opslaan.

    q

- Het huidige document sluiten.

    qa

- Sluit alle geopende documenten.

    wq

- Het huidige document opslaan en sluiten.

    wqa

- Alle huidige documenten opslaan en sluiten.

    x

- Het huidige document alleen opslaan en sluiten als het is gewijzigd.

    x

- Alleen alle huidige geopende documenten opslaan en sluiten als ze zijn gewijzigd.

    bp

- Naar het vorige document in de documentenlijst gaan.

    bn

- Naar het volgende document in de documentenlijst gaan.

    new

- Een nieuw document openen in horizontaal gesplitste weergave.

    vnew

- Een nieuw document openen in verticaal gesplitste weergave.

    e

- Het huidige document herladen als het op de schijf is gewijzigd.

    enew

- Een nieuw document bewerken.

    print

- Het printerdialoogvenster openen om het huidige document af te drukken.

#### commando's om de editor in te stellen

Deze commando's worden door de editor-component geleverd en maken het mogelijk om instellingen voor het actieve document en het beeld te maken. Dit kan nuttig zijn als u andere dan de standaardinstellingen wilt gebruiken, bijvoorbeeld voor het inspringen.

    set-tab-widthINTEGER width

- Stelt de tablengte in op `width`

    set-indent-widthINTEGER width

- Stelt de breedte voor het inspringen in op `width`. Gebruik dit alleen als u met spaties inspringt.

    set-word-wrap-columnINTEGER width

- Stelt de regellengte in op `width`. Dit wordt gebruikt als u tekst automatisch laat afbreken.

    set-icon-borderBOOLEAN enable

- Toont of verbergt de pictogramrand.

    set-folding-markersBOOLEAN enable

- Toont of verbergt de vouwmarkeringen.

    set-line-numbersBOOLEAN enable

- Toont of verbergt de regelnummering.

    set-replace-tabsBOOLEAN enable

- Als deze optie ingeschakeld is, worden tabs door spaties vervangen terwijl u typt.

    set-remove-trailing-spaceBOOLEAN enable

- Als deze optie ingeschakeld is, worden spaties aan het einde van de egel verwijderd als de cursor naar een andere regel gaat.

    set-show-tabsBOOLEAN enable

- Als deze optie ingeschakeld is, worden tabs en spaties aan het einde van de regel zichtbaar gemaakt door middel van een punt.

    set-show-indentBOOLEAN enable

- Als deze optie ingeschakeld is, wordt inspringen zichtbaar gemaakt door middel van een verticale lijn van puntjes.

    set-indent-spacesBOOLEAN enable

- Als deze optie ingeschakeld is, zal de editor elk inspringniveau met `indent-width` spaties laten inspringen in plaats van met tabs.

    set-mixed-indentBOOLEAN enable

- Als deze optie ingeschakeld is, zal &kappname; tabs en spaties gebruiken voor het inspringen. Elk inspringniveau zal het aantal spaties hebben dat bij `indent-width` is ingesteld en meerdere inspringniveaus zullen geoptimaliseerd worden door zoveel mogelijk tabs te gebruiken.

  Wanneer dit commando uitgevoerd wordt, zal ook het inspringen met spaties ingeschakeld worden. Als de inspringbreedte niet gespecificeerd is, zal deze op de helft van `tab-width` voor het document ingesteld worden.

    set-word-wrapBOOLEAN enable

- Schakelt dynamische regelafbreking in of uit, afhankelijk van `enable`.

    set-replace-tabs-saveBOOLEAN enable

- Als deze optie ingeschakeld is, zullen tabs vervangen worden door spaties zodra het document opgeslagen wordt.

    set-remove-trailing-space-saveBOOLEAN enable

- Als deze optie ingeschakeld is, zullen spaties aan het einde van elke regel verwijderd worden zodra het document opgeslagen wordt.

    set-indent-modeSTRING name

- Stelt de automatische inspringmodus in op `naam`. Als `naam` onbekend is, wordt "none" (geen) gebruikt. Geldige modi zijn 'none', 'normal', 'cstyle', 'haskell', 'lilypond', 'lisp', 'python', 'ruby' en 'xml'.

    set-auto-identBOOLEAN name

- Automatisch inspringen in- of uitschakelen.

    set-highlightSTRING highlight

- Stelt de accentuering van syntaxis in voor het document. Het argument moet een geldige naam zijn, zoals die in het menu Hulpmiddelen Accentueringmodus staat. Bij dit commando is automatische aanvulling beschikbaar voor het argument.

    reload-scripts

- Alle door Kate gebruikte JavaScript-scripts herladen, inclusief indenteerders en commandoregelscripts.

    set-wrap-cursorBOOLEAN enable

- Afbreekcursor in- of uitschakelen.

    set-modeBOOLEAN enable

- Het bestandstypeschema voor het huidige document kiezen.

    nn[oremap]STRING original STRING mapped

- Laat de `originele` toetsenreeks overeenkomen met de `overeenkomstige`.

#### Bewerkcommando's

Deze commando's wijzigen het huidige document.

    indent

- Laat de geselecteerde regels of de huidige regel inspringen.

    unindent

- Verwijdert de inspringing van de geselecteerde regels of van de huidige regel.

    cleanindent

- Schoont de inspringing van de geselecteerde regels of van de huidige regels op, in overeenstemming met de instellingen in het document.

    comment

- Voegt commentaarmarkeringen aan de geselecteerde regels of aan de huidige regel toe, in overeenstemming met de tekstopmaak zoals die gedefinieerd is voor de syntaxisaccentuering van het document.

    uncomment

- Verwijdert commentaarmarkeringen van de geselecteerde regels of van de huidige regel, in overeenstemming met de tekstopmaak zoals die gedefinieerd is voor de syntaxisaccentuering van het document.

    kill-line

- Verwijdert de huidige regel.

    replace STRING pattern STRING replacement

- Vervangt tekst die overeenkomt met `pattern` door `replacement`. Als u spaties in `pattern` wilt gebruiken, moet u om `pattern` en om `replacement` enkele of dubbele aanhalingstekens zetten. Als er geen aanhalingstekens om de argumenten staan, wordt het eerste woord als `pattern` gebruikt en de rest als `replacement`. Als `replacement` geen tekens bevat, wordt elk gevonden `pattern` verwijderd.

  U kunt extra opties aan de zoekopdracht meegeven door een dubbele punt toe te voegen, gevolgd door één of meer letters die elk een optie vertegenwoordigen. De zoekopdracht krijgt de vorm `replace:options pattern replacement`. Beschikbare opties zijn:

  `b`

- Zoek achterwaarts.

`c`

- Zoek vanaf de cursorpositie.

`e`

- Zoek alleen in de geselecteerde tekst.

`r`

- Gebruik een reguliere expressie in de zoekopdracht. In dit geval kunt u ook `N` gebruiken, N is een getal dat het aantal overeenkomsten in de vervangende tekenreeks vertegenwoordigt.

`s`

- De zoekopdracht is hoofdlettergevoelig.

`p`

- Vraag om toestemming om de volgende overeenkomst te vervangen.

`w`

- Zoek alleen naar hele woorden.

    dateSTRING format

- Voegt een datum/tijd in volgens de gespecificeerde `format`, of in de opmaak yyyy-MM-dd hh:mm:ss als er geen opmaak gespecificeerd is. De mogelijke vormen van `format` en de resulterende interpretatie:

  `d` | De dag als een getal zonder voorloopnul (1-31).
  `dd` | De dag als een getal met voorloopnul (01-31).
  `ddd` | De verkorte gelokaliseerde dagnaam ('Ma'..'Zo').
  `dddd` | De lange gelokaliseerde dagnaam ('Maandag'..'Zondag').
  `M` | De maand als een getal zonder voorloopnul (1-12).
  `MM` | De maand als een getal met voorloopnul (01-12).
  `MMM` | De verkorte gelokaliseerde maandnaam ('Jan'..'Dec').
  `yy` | Het jaar als een getal van twee cijfers (00-99).
  `yyyy` | Het jaar als een getal van vier cijfers (1752-8000).
  `h` | Het uur zonder voorloopnul (0..23 of 1..12 als AM/PM gebruikt wordt).
  `hh` | Het uur met voorloopnul (00..23 of 01..12 als AM/PM gebruikt wordt).
  `m` | De minuut zonder voorloopnul (0..59).
  `mm` | De minuut met voorloopnul (00..59).
  `s` | De seconde zonder voorloopnul (0..59).
  `ss` | De seconde met voorloopnul (00..59).
  `z` | De milliseconden zonder voorloopnul (0..999).
  `zzz` | De milliseconden met voorloopnul (000..999).
  `AP` | Gebruik AM/PM. AP wordt vervangen door "AM" of "PM".
  `ap` | Gebruik am/pm. ap wordt vervangen door "am" of "pm".

    charSTRING identifier

- Met behulp van dit commando kunt u tekens invoegen door het intypen van een decimaal, octaal of hexadecimaal getal. Open het dialoogvenster "Bewerkcommando's" en typ `char: [number]` in het invoerveld, klik daarna op OK.

  ##### `char` voorbeelden

  Invoer: `char:234`

  Uitvoer: `ê`

  Invoer: `char:0x1234`

  Uitvoer: `ሴ`

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

- Dit commando voert een zoeken/vervangen-opdracht op de manier van sed uit op de huidige regel of in het gehele bestand (`%s///`).

  Kort gezegd gebeurt er het volgende: In de tekst wordt naar de eerstvolgende overeenkomst met de search pattern gezocht, de reguliere expressie tussen de eerste en de tweede slash, en wanneer een overeenkomst gevonden is, wordt het overeenkomende gedeelte van de tekst vervangen door de expressie tussen het middelste en het laatste gedeelte van de tekenreeks. Haakjes in het zoekpatroon (search pattern) vertegenwoordigen terugverwijzingen, dit betekent dat het commando onthoudt welk gedeelte overeenkomt met het gedeelte tussen de haakjes; deze tekenreeksen kunnen opnieuw in de vervangende tekst gebruikt worden, `\1` verwijst naar het eerste set haakjes, `\2` naar het tweede set, enzovoort.

  Om naar een `(` of `)` te zoeken moet u het teken vooraf laten gaan door een backslash: `\(\)`

  Als u een `i` aan het einde van de expressie toevoegt, maakt de zoekopdracht geen verschil tussen hoofd- en kleine letters. Als u een `g` aan het einde toevoegt, worden alle overeenkomsten met het zoekpatroon vervangen, anders wordt alleen de eerste overeenkomst in een regel vervangen.

  ##### Tekst vervangen in de huidige regel

  Uw aardige compiler is zojuist gestopt met de mededeling dat de class `myClass` in regel 3902 in uw bronbestand niet gedefinieerd is.

  "Kreukels nog an toe!" denkt u, het is natuurlijk `MyClass`. U gaat naar regel 3902 en in plaats van te proberen het woord in de tekst te vinden, opent u het dialoogvenster "Bewerkcommando's", u typt `s/myclass/MyClass/i`, klikt op OK, slaat het bestand op en compileert – ditmaal zonder fouten.

  ##### Tekst vervangen in het gehele bestand

  Stel dat u aan een bestand werkt waarin de naam Anna Jensen verscheidene keren voorkomt. Dan hoort u van iemand dat ze pasgeleden getrouwd is met Harry Jones. U wilt natuurlijk overal in het bestand Anna Jensen vervangen door Anna Jones-Jensen.

  Open de commandoregel en typ `%s/Anna Jensen/Anna Jones-Jensen/` en druk op de Enter-toets; dat was alles.

  ##### Een iets ingewikkelder voorbeeld

  In dit voorbeeld gebruiken we zowel terugverwijzingen als teken-class (als u niet weet wat dit is, lees dan de uitleg hieronder).

  Stel dat u de volgende regel hebt:

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

  U bedenkt dat dit geen nette code is en besluit dat u het sleutelwoord `const` wilt gebruiken voor alle adressen van argumenten, herkenbaar aan de operator & voor de naam van het argument. U wilt ook de witruimte (de spaties of tabs) aanpassen, zodat er overal slechts één witruimteteken tussen de woorden staat.

  Open het dialoogvenster "Bewerkcommando's" en typ: `s/\s+(\w+)\s+(&)/ const \1 \2/g`, klik daarna op OK. De `g` aan het einde van de expressie zorgt ervoor dat de reguliere expressie voor elke overeenkomst opnieuw opgebouwd wordt om de terugverwijzingen te behouden.

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

  Taak volbracht! Wat is er nu gebeurd? We hebben gezocht naar witruimte (`\s+`) gevolgd door één of meer lettertekens (`\w+`) gevolgd door nog meer witruimte (`\s+`) gevolgd door een ampersand, en tegelijkertijd hebben we de lettertekens en de ampersand opgeslagen voor hergebruik bij het vervangen. Daarna hebben we het overeenkomende gedeelte van de regel vervangen door één spatie gevolgd door const gevolgd door één spatie gevolgd door de opgeslagen lettertekens (`\1`) gevolgd door één spatie gevolgd door de opgeslagen ampersand (`\2`).

  Nu waren de lettertekens op sommige plaatsen String, op andere plaatsen int, het gebruik van de tekenklasse `\w` en het bepalingsteken `+` bleek een handig hulpmiddel.

    sort

- De geselecteerde tekst of het gehele document sorteren.

    natsort

- De geselecteerde regels of het gehele document op een natuurlijke manier sorteren.

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

  `sort(a10, a1, a2)` resulteert in `a1, a10, a2`

  `natsort(a10, a1, a2)` resulteert in `a1, a2, a10`

    moveLinesDown

- Geselecteerde regels omlaag verplaatsen.

    moveLinesUp

- Geselecteerde regels omhoog verplaatsen.

    uniq

- Dubbele regels uit de geselecteerde tekst of het gehele document verwijderen.

    rtrim

- Spaties aan het eind van de regel uit de geselecteerde tekst of het gehele document verwijderen.

    ltrim

- Spaties aan het begin van de regel uit de geselecteerde tekst of het gehele document verwijderen.

    joinSTRING separator

- Geselecteerde regels of het gehele document samenvoegen. Neemt optioneel een parameter die een scheidingsteken definieert, bijvoorbeeld: ``join` ', '`

    rmblank

- Alle spaties uit de geselecteerde tekst of het gehele document verwijderen.

    unwrap

- Alle regelafbrekingen uit de geselecteerde tekst of het gehele document ongedaan maken.

    eachSTRING script

- Met een JavaScript-functie als argument, roep die aan voor de lijst met geselecteerde regels en vervang ze met de terugkeerwaarde van die aanroep.

  ##### Geselecteerde regels samenvoegen

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

  Of, korter:

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

    filterSTRING script

- Met een JavaScript-functie als argument, roep die aan voor de lijst met geselecteerde regels en verwijder ze als de terugkeerwaarde van die aanroep 'false' is.

  ##### Blanco regels verwijderen

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

  Of, korter:

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

    mapSTRING script

- Met een JavaScript-functie als argument, roep die aan voor de lijst met geselecteerde regels en vervang de regel met de terugkeerwaarde van die aanroep.

  ##### Blanco regels verwijderen

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

  Of, korter:

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

    duplicateLinesUp

- De geselecteerde regels boven de huidige selectie dupliceren.

    duplicateLinesDown

- De geselecteerde regels onder de huidige selectie dupliceren.

#### Navigatiecommando's

    gotoINT line

- Dit commando plaatst de cursor op de gespecificeerde regel.

    grep STRING pattern

- Search the document for the regular expression `pattern`. For more information, see regular-expressions

    findSTRING pattern

- Dit commando plaatst de cursor bij de eerstgevonden overeenkost met `pattern`, afhankelijk van de eventuele opties. Volgende overeenkomsten kunnen gevonden worden door het menu Bewerken Volgende zoeken te gebruiken of door op F3 te drukken.

  Het gedrag van de zoekopdracht kan ingesteld worden door een dubbele punt gevolgd door één of meer opties aan het commando toe te voegen: `find:options pattern`. De volgende opties kunnen gebruikt worden:

  `b`

- Zoek achterwaarts.

`c`

- Zoek vanaf de cursorpositie.

`e`

- Zoek alleen in de geselecteerde tekst.

`r`

- Gebruik een reguliere expressie in de zoekopdracht. In dit geval kunt u ook `N` gebruiken, N is een getal dat het aantal overeenkomsten in de vervangende tekenreeks vertegenwoordigt.

`s`

- De zoekopdracht is hoofdlettergevoelig.

`w`

- Zoek alleen naar hele woorden.

    ifindSTRING pattern

- Met behulp van dit commando kunt u zoeken terwijl-u-typt. Het gedrag van de zoekopdracht kan ingesteld worden door een dubbele punt gevolgd door één of meer opties aan het commando toe te voegen: `ifind:options patroon`. De volgende opties kunnen gebruikt worden:

  `b`

- Zoek achterwaarts.

`r`

- Gebruik een reguliere expressie in de zoekopdracht.

`s`

- De zoekopdracht is hoofdlettergevoelig.

`c`

- Zoek vanaf de cursorpositie.

## Code-invouwing gebruiken

Code invouwen stelt u in staat om delen van een document in de editor te verbergen, waarmee het gemakkelijker is om overzicht te houden over grote documenten. In &kappname; worden de invouwbare gebieden berekend met regels gedefinieerd in de definities van syntaxis accentuering en zijn daarom alleen beschikbaar in sommige formaten - typisch broncode van programma's, XML-markup en vergelijkbaar. De meeste definities voor accentuering met ondersteuning van code invouwen laten u ook handmatig invouwbare gebieden definiëren, typisch met de `BEGIN` en `END` sleutelwoorden.

Om de functie codeinvouwen te gebruiken, activeert u de invouwmarkering met het menu-item Beeld Invouwmarkeringen tonen als ze nog niet zichtbaar zijn. Het paneel voor invouwmarkeringen links op het scherm toont een grafische weergave van de invouwgebieden, met driehoekssymbolen om de mogelijke bewerking op een gegeven gebied aan te geven: een naar beneden gerichte driehoek geeft aan dat het gebied niet is ingevouwen, erop klikken zal het gebied invouwen en een naar rechts wijzende driehoek zal in plaats daarvan worden getoond.

Er zijn elf commando's die de status van invouwgebieden veranderen, zie de menudocumentatie.

De ingevouwen regels worden herinnerd wanneer een bestand wordt gesloten, dus bij het opnieuw openen van het bestand zullen de ingevouwen nodes nog steeds ingevouwen zijn. Dit is ook van toepassing bij herladen.

Als u geen gebruik wilt maken van code invouwen, dan kunt u de optie Invouwmarkering tonen (indien beschikbaar) in de pagina Uiterlijk van de editorconfiguratie.

## &kappname; met scripts uitbreiden

Sinds &kappname; 3.4 in KDE 4.4 is de &kappname; editor-component eenvoudig uit te breiden met scripts. De scripttaal is ECMAScript (breed bekend als JavaScript). &kappname; ondersteunt twee soorten scripts: inspringen en commandoregelscripts.

### Inspringscripts

Inspringscripts - ook genoemd indenteerders - laten de broncode inspringen bij het typen van tekst. Na het indrukken van de Enter-toets zal bij code het inspringniveau vaak toenemen.

De volgende secties beschrijven stap voor stap hoe het skelet voor een eenvoudige indenteerder te maken. Als eerste stap, maak een nieuw `*.js` bestand aan bijv. met de naam `javascript.js` in de lokale thuismap aan `$KDEHOME/share/apps/katepart/script`.

#### De kop van het inspringscript

De kop van het bestand `javascript.js` is ingebed in commentaar en heeft de volgende vorm

    /* kate-script
     * name: JavaScript
     * author: Voorbeeldnaam <voorbeeld.naam@een.adres.org>
     * license: BSD
     * revision: 1
     * kate-version: 3.4
     * type: indentation
     * required-syntax-style: javascript
     * indent-languages: javascript
     * priority: 0
     * i18n-catalog: mycatalog
     *
     * Een regel zonder dubbelepunt ':' stopt het ontleden van de kop. Dwz. u kunt
     * hier optioneel tekst zoals een gedetailleerde licentie toevoegen.
     */

Elk item wordt nu in detail uitgelegd:

- `kate-script` [vereist]: Deze tekenreeks moet in de eerste regel van het `*.js` bestand staan, anders slaat &kappname; het script over.

- `name` [vereist]: Dit is de naam van de indenteerder die in het menu Hulpmiddelen Inspringen verschijnt en in de configuratiedialoog.

- `author` [optioneel]: De naam van de auteur en contactinformatie.

- `license` [optioneel]: Korte vorm van de licentie, zoals BSD of LGPLv3.

- `revision` [vereist]: De revisie van het script. Dit getal moet verhoogd worden wanneer het script wordt gewijzigd.

- `kate-version` [vereist]: Minimaal vereiste versie van &kappname;.

- `type` [vereist]: Het type moet zijn `indentation`, anders zal &kappname; dit script overslaan.

- `required-syntax-style` [optioneel]: Komma-gescheiden lijst met vereiste stijlen voor accentuering van de syntaxis. Dit is belangrijk voor indenteerders die vertrouwen op specifieke informatie voor accentuering in het document. Als een vereiste syntaxisstijl is gespecificeerd, zal de indenteerder alleen beschikbaar zijn wanneer het juiste programma voor accentuering actief is. Dit voorkomt ongedefinieerd gedrag veroorzaakt door de indenteerder te gebruiken zonder het verwachte schema voor accentuering. De Ruby indenteerder, bijvoorbeeld, maakt hier gebruik van in de bestanden `ruby.js` en `ruby.xml`.

- `indent-languages` [optioneel]: Kommagescheidenlijst van syntaxis stijlen die de indenteerder correct kan laten inspringen, bijv.: c++, java.

- `priority` [optioneel]: Als verschillende indenteerders geschikt zij voor een bepaald bestand om te accentueren, dan bepaalt de prioriteit welke indenteerder als standaard wordt gekozen.

- `i18n-catalog` [optioneel]: Extra catalogus voor berichten (`po` bestand) geladen voor vertaling van indenteerders van derden.

&kappname; leest alle paren van de vorm `sleutelwoord`:`waarde` totdat het geen dubbelepunt meer kan vinden. Dit houdt in dat de kop willekeurige tekst, zoals een licentie kan bevatten zoals in het voorbeeld getoond.

#### De broncode van de indenteerder

Nadat de header is gespecificeerd, legt deze sectie uit hoe het script voor inspringen zelf werkt. Het basis sjabloon van de inhoud ziet er uit als volgt:

    triggerCharacters = "{}/:;";
    function indent(line, indentWidth, ch)
    {
        // aangeroepen voor elk teken nieuwe-regel (ch == '\n') en alle tekens gespecificeerd in
        // de globale variabele triggerCharacters. Bij het aanroepen van HulpmiddelenUitlijnen
        // is de variabele ch leeg, i.e. ch == ''.
        //
        // zie ook: Scripting API
        return -2;
    }

De functie `indent()` heeft drie parameters:

- `line`: de regel die moet inspringen

- `indentWidth`: de inspringbreedte in aantal spaties

- `ch`: of een teken nieuwe-regel (`ch == '\n'`), het activeringsteken gespecificeerd in `triggerCharacters` of leeg als de gebruiker de actie Hulpmiddelen Uitlijnen heeft gestart.

De terugkeerwaarde van de functie `indent()` specificeert hoe de regel zal worden ingesprongen. Als de terugkeerwaarde een eenvoudig geheel getal is, wordt deze geïnterpreteerd als volgt:

- terugkeerwaarde `-2`: niets doen

- terugkeerwaarde `-1`: behoudthet inspringen (zoekt naar voorgaande niet-blanko regel)

- terugkeerwaarde `0`: getallen >= 0 specificeer de insringdiepte in spaties

Alternatief, een reeks van twee elementen kan worden teruggegeven:

- `geef [ indent, align ] terug;`

In dit geval is het eerste element de inspringdiepte zoals hierboven met dezelfde betekenis van de speciale waarden. Het tweede element is een absolute waarde die een kolom aangeeft voor uitlijning. Als deze waarde groter is dan de inspringwaarde, dan is het verschil een aantal spaties dat na het inspringen van de eerste parameter moet worden toegevoegd. Anders wordt het tweede getal genegeerd. Tabs en spaties voor inspringen gebruiken wordt vaak gemengde modus genoemd.

beschouw het volgende voorbeeld: Neem aan dat tabs worden gebruikt voor inspringen en tabbreedte is ingesteld op 4. <tab> vertegenwoordigt hier een tab-teken en '.' een spatie:

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

Bij inspringen van regel 2 zal de functie `indent()` [8, 15] als terugkeerwaarde geven. Als resultaat worden hier twee tabs ingevoegd om in te springen tot kolom 8 en worden 7 spaties toegevoegd om de tweede parameter uit te lijnen onder de eerste, zodat het uitgelijnd blijft als het bestand wordt bekeken met een andere tabbreedte.

Een standaard KDE installatie levert bij &kappname; verschillende indenteerders. De overeenkomstige JavaScript broncode kan worden gevonden in `$KDEDIR/share/apps/katepart/script`.

Ontwikkeling van een indenteerder vereist herladen van de scripts om te zien of de wijzigingen zich netjes gedragen. In plaats van het opnieuw opstarten van de toepassing, schakel eenvoudig om naar de commandoregel en start het commando `reload-scripts`.

Als u bruikbare scripts ontwikkeld overweeg dan deze aan het &kappname;-project bij te dragen door kontact op te nemen via de e-maillijst.

### Commandoregelscripts

Omdat het moeilijk is om aan de noden van iedereen te voldoen, ondersteunt &kappname; kleine hulpmiddelen voor snelle tekstmanipulatie via de ingebouwde commandoregel. Het commando `sort` is bijvoorbeeld geïmplementeerd als script. Deze sectie legt uit hoe `*.js` bestanden aan te maken om &kappname; uit te breiden met willekeurige hulpscripts.

Commandoregelscripts staan in dezelfde map als inspringscripts. Dus als eerste stap maakt u een nieuw `*.js` bestand aan genaamd `myutils.js` in de lokale map `$KDEHOME/share/apps/katepart/script`.

#### De kop van het commandoregelscript

De kop van elk commandoreglscript is ingebed in commentaar en heeft de volgende vorm

    /* 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
     *
     * Een regel zonder dubbelepunt ':' stopt het ontleden van de kop. Dat
     * betekent dat u hier optioneel tekst kan toevoegen, zoals een
     * gedetailleerde licentie.
     */

Elk item wordt nu in detail verklaard:

- `kate-script` [vereist]: Deze tekenreeks moet in de eerste regel van het `*.js` bestand staan, anders slaat &kappname; het script over.

- `author` [optioneel]: De naam van de auteur en contactinformatie.

- `license` [optioneel]: Korte vorm van de licentie, zoals BSD of LGPLv3.

- `revision` [vereist]: De revisie van het script. Dit getal moet verhoogd worden wanneer het script wordt gewijzigd.

- `kate-version` [vereist]: Minimaal vereiste versie van &kappname;.

- `type` [vereist]: Het type moet `commands` zijn, anders slaat &kappname; dit script over.

- `functions` [vereist]: Komma-gescheiden lijst met commando's in het script.

- `i18n-catalog` [optioneel]: Extra catalogus met meldingen (`po` bestand) dat wordt geladen voor vertaling van scripts van derden.

&kappname; leest alle paren van de vorm `sleutel`:`waarde` totdat het geen dubbelepunt meer kan vinden. Dit betekent dat de kop willekeurige tekst kan bevatten zoals een licentie, zoals in het voorbeeld is te zien. De waarde van de sleutel functions is een komma-gescheiden lijst met commandoregel-commando's. Dit betekent dat een enkel script een willekeurig aantal command0regel-commando's kan bevatten. Elke functie is beschikbaar via de ingebouwde commandoregel van &kappname;.

#### De broncode van het script

Alle in de kop gespecificeerde functies moeten worden geïmplementeerd in het script. Het script-bestand uit het bovenstaande voorbeeld moet de twee functies `sort` en `format-paragraph` implementeren. Alle functies hebben de volgende syntaxis:

    function <naam>(arg1, arg2, ...)
    {
        // ... implementatie, zie ook: Scripting API
    }

De argumenten in de commandoregel worden doorgegeven naar de functie als `arg1`, `arg2`, etc. Om documentatie voor elk commando te leveren, implementeert u eenvoudig de functie '`help`' als volgt:

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

uitvoeren van `help sort` in de commandoregel roept deze help-functie op met het argument `cmd` ingesteld op het gegeven commando, i.e. `cmd == "sort"`. &kappname; laat dan de teruggeleverde tekst zien als documentatie voor de gebruiker. Zorg er voor dat de tekenreeksen vertaald zijn.

##### Koppelen van sneltoetsen

Om in staat te zijn sneltoetsen toe te kennen, moet het script een functie genaamd `action` als volgt leveren:

    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") {
            // hetzelfde voor de volgende actie
        }
        return a;
    }

De parameter `cmd` van de functie specificeert het commando waarvoor een sneltoets wordt gevraagd. Er zijn verschillende velden die u moet specificeren in het teruggegeven javascript-object:

- `a.text` [vereist]: De tekst verschijnt in het menu Hulpmiddelen Scripts. Zorg er voor om `i18n` voor vertaling te gebruiken.

- `a.icon` [optioneel]: Het pictogram verschijnt naast de tekst in het menu. Alle pictogramnamen van KDE kunnen hier worden gebruikt.

- `a.category` [optioneel]: Als een categorie wordt gespecificeerd, verschijnt het script in een submenu. Zorg er voor om `i18n` voor vertaling te gebruiken.

- `a.interactive` [optioneel]: Als het script invoer van de gebruiker nodig heeft, zet dit dan op `true`.

- `a.shortcut` [optioneel]: De hier gegeven sneltoets is de standaard sneltoets. Voorbeeld: Ctrl+Alt+t. Zie de Qt documentatie voor verdere details.

Ontwikkeling van een commandoregelscript vereist herladen van de scripts om te zien of de wijzigingen zich netjes gedragen. In plaats van het opnieuw opstarten van de toepassing, schakel eenvoudig om naar de commandoregel en start het commando `reload-scripts`.

Als u bruikbare scripts ontwikkeld overweeg dan deze aan het &kappname;-project bij te dragen door kontact op te nemen via de e-maillijst.

### API voor scripts

De API voor scripts die hier gepresenteerd wordt is beschikbaar in alle scripts, dwz. scripts voor inspringen en commando's voor de commandoregel. Alvorens de inhoud van een script wordt geladen, voegt &kappname; eerst verschillende prototypen en functies toe aan de context van het script. Deze API voor het gemak bevat prototypen zoals tekstcursors en tekstreeksen en bevindt zich in de map `$KDEDIR/share/apps/katepart/api`. De bestandsnamen van elk JavaScript-bestand daar houdt zich aan het volgende naamschema:

    <nummer>_<naam>.js

Het nummer heeft twee cijfers en de naam is een willekeurige naam zoals `myutils`. &kappname; stuurt via het nummer de volgorde van uitvoering van de API. Dwz., het bestand net de naam `05_cursor.js` wordt aangeroepen voor het bestand `10_range.js`. (Dit is overeenkomstig de volgorde bij het starten van het runlevel/init systeem in Linux).

Om de standaard API voor scripting uit te breiden met eigen functies en prototypen, maak gewoon een nieuw bestand aan in de lokale configuratiemap van KDE `$KDEHOME/share/apps/katepart/api` en controleer dat het een hoger nummer (volgorde van uitvoeren) heeft dan de andere `*.js` bestanden in de globale map `$KDEDIR/share/apps/katepart/api`. &kappname; doorzoekt automatisch beide mappen naar `*.js` bestanden en voert ze uit in de juiste volgorde.

Om bestaande prototypes zoals `Cursor` of `Reeks` uit te breiden, os de aanbevolen manier om niet de globale `*.js` bestanden te wijzigen. In plaats daarvan maakt u een `*.js` bestand in de lokale map aan die later wordt uitgevoerd dan `05_cursor.js` en dan het `Cursor` prototype in JavaScript te wijzigen.

#### Cursors en bereiken

Omdat &kappname; is een tekstbewerker is, is alles voor de API voor scripting, waar mogelijk, gebaseerd op cursors en reeksen. Een cursor is een eenvoudig een paar `(regel, kolom)` die een tekstpositie in het document weergeeft. Een reeks omspant tekst van een begincursorpositie tot een eincursorpositie. De API wordt in de volgende secties in detail uitgelegd.

##### Het prototype van cursor

    Cursor();

- Constructor. Levert een cursor terug op positie `(0, 0)`.

  Voorbeeld: `var cursor = new Cursor();`

    Cursor(int regel, int kolom);

- Constructor. Levert een cursor terug op positie (regel, kolom).

  Voorbeeld: `var cursor = new Cursor(3, 42);`

    Cursor(Cursor andere);

- Constructor kopiëren. Geeft een kopie van de cursor `andere` terug.

  Voorbeeld:`var copy = nieuwe cursor(andere);`

    Cursor Cursor.clone();

- Geeft een kloon van de cursor terug.

  Voorbeeld: `var clone = cursor.clone();`

    bool Cursor.isValid();

- Controleert of de cursor geldig is. De cursor is ongeldig indien lijn en/of kolom ingesteld zijn op `-1`.

  Voorbeeld: `var valid = cursor.isValid();`

    Cursor Cursor.invalid();

- Geeft een nieuwe ongeldige cursor op locatie `(-1, -1)`.

  Voorbeeld:`var invalidCursor = cursor.invalid();`

    int Cursor.compareTo(Cursor andere);

- Vergelijkt deze cursor met de cursor `andere`. Geeft terug

  - `-1`, indien deze cursor zich bevindt voor de cursor `andere`,

  - `0`, indien beide cursors gelijk zijn

  - `+1`, als deze cursor gelokaliseerd is na de cursor `andere`.

    bool Cursor.equals(Cursor andere);

- Geeft `true` terug, als deze cursor en de cursor `andere` gelijk zijn, anders `false`.

    String Cursor.toString();

- Geeft de cursor terug als een tekenreeks met de vorm `Cursor(regel, kolom)`.

##### Het prototype bereik

    Range();

- Constructor. Aanroepen van `new Range()` geeft een Reeks op (0, 0) - (0, 0) terug.

    Range(Cursor begin, Cursor eind);

- Constructor. Aanropen van `new Range(`begin`, `eind`)` geeft de Reeks (`begin`, `eind`) terug.

    Range(int beginRegel, int beginKolom, int eindRegel, int eindKolom);

- Constructor. Aanroepen van `new Range(`beginRegel`, `beginKolom`, `eindeRegel`, `eindKolom`)` geeft de Reeks van (`beginRegel`, `beginKolom`) tot (`eindeRegel`, `eindKolom`).

    Range(Range andere);

- Constructor kopiëren. Geeft een kopie terug van Range `andere`.

    Reeks Range.clone();

- Geeft een kloon van de reeks terug.

  Voorbeeld: `var clone = range.clone();`

    bool Range.isValid();

- Geeft `true` terug, als zowel begin als einde cursor geldig zijn, anders `false`.

  Voorbeeld: `var valid = range.isValid();`

    bool Range.invalid();

- Geeft de Reeks van (-1, -1) tot (-1, -1) terug.

    bool Range.contains(Cursor cursor);

- Geeft `true` terug, als de reeks de cursorpositie bevat, anders `false`.

    bool Range.contains(Range andere);

- Geeft `true` terug, als deze reeks de Reeks`andere` bevat, anders `false`.

    bool Range.containsColumn(int kolom);

- Geeft `true` terug, als `kolom` zich in het half open interval `[start.column, end.column)` bevindt, anders `false`.

    bool Range.containsLine(int regel);

- Geeft `true` terug, als `regel` zich in het half open interval `[start.line, end.line)` bevindt, anders `false`.

    bool Range.overlaps(Range overig);

- Geeft `true` terug, als deze reeks en de reeks`overig` een gebied delen, anders `false`.

    bool Range.overlapsLine(int regel);

- Geeft `true` terug, als `regel` zich in het interval `[start.line, end.line)` bevindt, anders `false`.

    bool Range.overlapsColumn(int kolom);

- Geeft `true` terug, als `kolom` zich in het interval `[start.column, end.column)` bevindt, anders `false`.

    bool Range.equals(Range overig);

- Geeft `true` terug, als deze reeks de Reeks `andere` gelijk zijn, anders `false`.

    String Range.toString();

- Geeft de reeks terug als een tekenreeks van de vorm `Range(Cursor(lijn, kolom), Cursor(lijn, kolom))`.

#### Globale functies

Deze sectie geeft een lijst met alle globale functies.

##### Foutopsporing

    void debug(String tekst);

- Stuurt `tekst` naar `stdout` in de console na het starten van de toepassing.

##### Vertaling

Om to volledige localisatie te ondersteunen zijn er verschillende functies om tekenreeksen in scripts te vertalen, namelijk `i18n`, `i18nc`, `i18np` en `i18ncp`. Deze functies gedragen zich op precies dezelfde manier zoals in Vertalingsfuncties van KDE.

De vertalingfuncties vertalen de omwikkelde tekenreeksen via het vertalingssysteem van KDE naar de in de toepassing gebruikte taal. Tekenreeksen in scripts die worden ontwikkeld in de officiële broncode van &kappname; worden automatisch geëxtraheerd en vertaalbaar gemaakt. Met andere woorden, als ontwikkelaar van &kappname; hoeft u zich niet bezig te houden met extraheren en vertalen. Voor derden echter, met scripts ontwikkeld buiten KDE, moet u zelf berichten extraheren en vertalen. Samen met uw scripts moet u ook een vertalingsbestand distribueren, die alle vertaalde tekenreeksen bevat. Verder moet de scriptkop dan expliciet het te laden bestand aangeven door `i18n-catalog` te specificeren.

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

- Vertaalt `text` in de taal die wordt gebruikt door de toepassing. De argumenten `arg1`, ..., zijn optioneel en worden gebruikt om plaatshouders `%1`, `%2`, etc. te vervangen.

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

- Vertaalt `text` in de taal die wordt gebruikt door de toepassing. Bovendien is de tekenreeks `context` zichtbaar voor de vertalers, zodat zij een betere vertaling kunnen produceren. De argumenten `arg1`, ..., zijn optioneel en worden gebruikt om plaatshouders `%1`, `%2`, etc. te vervangen.

    void i18np(String enkelvoud, String meervoud, int nummer, arg1, ...);

- Vertaalt ofwel `enkelvoud` of `meervoud` in de taal die wordt gebruikt door de toepassing, afhankelijk van het gegeven `nummer`. De argumenten `arg1`, ..., zijn optioneel en worden gebruikt om plaatshouders `%1`, `%2`, etc. te vervangen.

    void i18ncp(String context, String eenvoud, String meervoud, int nummer, arg1, ...);

- Vertaalt `enkelvoud` of`meervoud` in de taal die wordt gebruikt door de toepassing, afhankelijk van het gegeven nummer. Bovendien is de tekenreeks `context` zichtbaar voor de vertalers, zodat zij een betere vertaling kunnen produceren. De argumenten `arg1`, ..., zijn optioneel en worden gebruikt om plaatshouders `%1`, `%2`, etc. te vervangen.

#### De API voor weergave

Wanneer een script wordt uitgevoerd, dan is er een globale variabele `view` die de huidige actieve editor-view representeert. Het volgende is een lijst met alle beschikbare weergavefuncties.

    Cursor view.cursorPosition()

- Geeft de huidige cursorpositie in het beeld terug.

    void view.setCursorPosition(int line, int column)
    void view.setCursorPosition(Cursor cursor)

- Geeft de huidige cursorpositie in het beeld terug.

    void view.setCursorPosition(int line, int column);
    void view.setCursorPosition(Cursor cursor);

- Stelt de huidige cursorpositie in op ofwel (regel, kolom) of op de gegeven cursor.

    Cursor view.virtualCursorPosition();

- Geeft de virtuele cursorpositie terug waarin elke tab telt voor de overeenkomstige hoeveelheid spaties afhankelijk van de huidige tabbreedte.

    void view.setVirtualCursorPosition(int line, int column);
    void view.setVirtualCursorPosition(Cursor cursor);

- Stelt de huidige virtuele cursorpositie in op (regel, kolom) of op de gegeven cursor.

    String view.selectedText();

- Geeft de geselecteerde tekst terug. Als er geen tekst is geselecteerd dan is de tekenreeks leeg.

    bool view.hasSelection();

- Geeft `true` terug, als het beeld geselecteerde tekst heeft, anders `false`.

    Range view.selection();

- Geeft de geselecteerde tekstreeks terug. Als er geen tekst is geselecteerd dan is de tekenreeks ongeldig.

    void view.setSelection(Range reeks);

- Stelt de geselecteerde tekst in op de gegeven reeks.

    void view.removeSelectedText();

- Verwijder de geselecteerde tekst. Als het beeld geen geselecteerde tekst bevat, dan doet dit niets.

    void view.selectAll();

- Selecteert de gehele tekst in het document.

    void view.clearSelection();

- Wist de tekstselectie zonder de tekst te verwijderen.

#### De API van Document

Wanneer een script uitgevoerd wordt is er een globale variabele `document` die het huidige actieve document representeert. Het volgende is een lijst met alle beschikbare documentfuncties.

    String document.fileName();

- Geeft de bestandsnaam van het document terug of een lege tekenreeks voor niet opgeslagen tekstbuffers.

    String document.url();

- Geeft de volledige url van het document terug of een lege tekenreeks voor niet opgeslagen tekstbuffers.

    String document.mimeType();

- Geeft het mime-type van het document terug of het mime-type `application/octet-stream` als er geen toepasselijk mime-type gevonden kan worden.

    String document.encoding();

- Geeft de nu gebruikte codering terug om het bestand op te slaan.

    String document.highlightingMode();

- Geeft de gebruikte globale accentueringmodus terug voor het gehele document.

    String document.highlightingModeAt(Cursor pos);

- Geeft de gebruikte accentueringmodus terug op de gegeven positie in het document.

    Array document.embeddedHighlightingModes();

- Geeft een reeks van accentueringmodi terug ingebed in dit document.

    bool document.isModified();

- Geeft `true` terug, als het document niet opgeslagen wijzigingen heeft(gemodificeerd), anders `false`.

    String document.text();

- Geef de gehele inhoud van het document terug in een enkele tekenreeks. Nieuwe regels zijn gemarkeerd met het teken nieuw-regel `\n`.

    String document.text(int vanafRegel, int vanafKolom, int totRegel, int totKolom);
    String document.text(Cursor vanaf, Cursor tot);
    String document.text(Range bereik);

- Geeft de tekst terug in het gegeven bereik. Het is aanbevolen de cursor te gebruiken en een versie gebaseerd op bereik voor betere leesbaarheid van de broncode.

    String document.line(int regel);

- Geeft de gegeven tekstregel terug als tekenreeks. De tekenreeks is leeg als de gevraagde regel buiten het bereik ligt.

    String document.wordAt(int regel, int kolom);
    String document.wordAt(Cursor cursor);

- Geeft het woord terug op de gegeven cursorpositie.

    String document.charAt(int regel, int kolom);
    String document.charAt(Cursor cursor);

- Geeft het teken terug op de gegeven cursorpositie.

    String document.firstChar(int regel);

- Geeft het eerste teken in de gegeven `regel` terug die geen witruimte is. Het eerste teken is in kolom 0. Als de regel leeg of alleen witruimte bevat, dan is de teruggegeven tekenreeks leeg.

    String document.lastChar(int regel);

- Geeft het laatste teken in de gegeven `regel` terug die geen witruimte is. Als de regel leeg of alleen witruimte bevat, dan is de teruggegeven tekenreeks leeg.

    bool document.isSpace(int regel, int kolom);
    bool document.isSpace(Cursor cursor);

- Geeft `true` terug, als het teken op de gegeven cursorpositie gelijk is aan een witruimte, anders `false`.

    bool document.matchesAt(int regel, int kolom, int regel, String tekst);
    bool document.matchesAt(Cursor cursor, String tekst);

- Geeft `true` terug, als de gegeven `tekst` overeenkomt met de overeenkomstige cursorpositie, anders `false`.

    bool document.startsWith(int regel, String tekst, bool witRuimteOverslaan);

- Geeft `true` terug als de regel begint met `tekst`, anders `false`. Het argument `witRuimteOverslaan` bepaalt of voorloopwitruimte genegeerd worden.

    bool document.endsWith(int regel, String tekst, bool witRuimteOverslaan);

- Geeft `true` terug als de regel eindigt met `tekst`, anders `false`. Het argument `witRuimteOverslaan` bepaalt of witruimte achteraan genegeerd wordt.

    bool document.setText(String tekst);

- Stelt de gehele documenttekst in.

    bool document.clear();

- Verwijdert de gehele tekst uit het document.

    bool document.truncate(int regel, int kolom);
    bool document.truncate(Cursor cursor);

- kap de gegeven regel op de gegeven kolom of cursorpositie af. Geeft `true` terug bij succes of `false` als de gegeven regel geen deel is van het documentbereik.

    bool document.insertText(int regel, int kolom, int regel, String tekst);
    bool document.insertText(Cursor cursor, String tekst);

- Voeg de `tekst` op de cursorpositie in. Geeft `true` terug bij succes of `false`, als het document alleen-lezen is.

    bool document.removeText(int vanafRegel, int vanafKolom, int totRegel, int totKolom);
    bool document.removeText(Cursor vanaf, Cursor tot);
    bool document.removeText(Range bereik);

- Verwijdert de tekst in het gegeven bereik. Geeft `true` terug bij succes of `false`, als het document alleen-lezen is.

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

- Voegt tekst in de gegeven regel in. Geeft `true` terug bij succes of `false`, als het document alleen-lezen is of de regel niet in het documentbereik ligt.

    bool document.removeLine(int regel);

- Verwijdert de gegeven tekstregel. Geeft `true` terug bij succes of `false`, als het document alleen-lezen is of de regel niet in het documentbereik ligt.

    void document.joinLines(int beginRegel, int eindRegel);

- Voegt de regels vanaf `beginRegel` tot `eindRegel` samen. Twee elkaar opvolgende tekstregels worden altijd gescheiden door een enkele spatie.

    int document.lines();

- Geeft het aantal regels in het document terug.

    int document.length();

- Geeft het aantal tekens in het document terug.

    int document.lineLength(int regel);

- Geeft de lengte van de `regel` terug.

    void document.editBegin();

- Begint een bewerkingsgroep voor groepering van ongedaan maken/opnieuw doen. Controleer altijd of `editEnd()` is aangeroepen als u `editBegin()` aanroept. Aanroepen van `editBegin()` gebruikt intern een referentieteller, let op deze aanroep kan genest worden.

    void document.editEnd();

- Beëindigt een bewerkingsgroep. De laatst aanroep van `editEnd()` (dwz. diegene voor de eerste aanroep van `editBegin()`) beëindigt de bewerkingsstap.

    int document.firstColumn(int regel);

- Geeft de eerste niet-witruimte kolom in de gegeven `regel` terug. Als er alleen witruimte in de regel bevindt, dan is de terugkeerwaarde `-1`.

    int document.lastColumn(int regel);

- Geeft de laatste niet-witruimte kolom in de gegeven `regel` terug. Als er alleen witruimte in de regel bevindt, dan is de terugkeerwaarde `-1`.

    int document.prevNonSpaceColumn(int regel, int kolom);
    int document.prevNonSpaceColumn(Cursor cursor);

- Geeft de kolom terug met een niet-witruimte teken beginnend bij de gegeven cursorpositie en achterwaarts zoeken.

    int document.nextNonSpaceColumn(int regel, int kolom);
    int document.nextNonSpaceColumn(Cursor cursor);

- Geeft de kolom terug met een niet-witruimte teken beginnend bij de gegeven cursorpositie en voorwaarts zoeken.

    int document.prevNonEmptyLine(int regel);

- Geeft de volgende niet-lege regel terug met een niet-witruimte teken en achterwaarts zoeken.

    int document.nextNonEmptyLine(int regel);

- Geeft de volgende niet-lege regel terug met een niet-witruimte teken en voorwaarts zoeken.

    bool document.isInWord(String teken, int attribuut);

- Geeft `true` terug, als het gegeven `teken` met het gegeven `attribuut` deel van een woord kan zijn, anders `false`.

    bool document.canBreakAt(String teken, int attribuut);

- Geeft `true` terug, als het gegeven `teken` met het gegeven `attribuut` geschikt is om een regel af te breken, anders `false`.

    bool document.canComment(int beginAttribuut, int eindAttribuut);

- Geeft `true` terug, als een bereik beginnend en eindigend met de gegeven attributen geschikt is om als commentaar te worden aangemerkt, anders `false`.

    String document.commentMarker(int attribuut);

- Geeft de markeerder voor commentaar terug voor commentaar op een enkele regel voor een gegeven `attribuut`.

    String document.commentStart(int attribuut);

- Geeft de markeerder voor commentaar terug voor begin van commentaar over meerdere regels voor een gegeven `attribuut`.

    String document.commentEnd(int attribuut);

- Geeft de markeerder voor commentaar terug voor het einde van commentaar over meerdere regels voor een gegeven `attribuut`.

    int document.attribute(int regel, int kolom);
    int document.attribute(Cursor cursor);

- Geeft het attribuut terug op de gegeven cursorpositie.

    bool document.isAttribute(int regel, int kolom, int attribuut);
    bool document.isAttribute(Cursor cursor, int attribuut);

- Geeft `true` terug, als het attribuut op de gegeven cursorpositie gelijk is aan `attribuut`, anders `false`.

    String document.attributeName(int regel, int kolom);
    String document.attributeName(Cursor cursor);

- Geeft de attribuutnaam terug als leesbare tekst. Dit is gelijk aan de `itemData`-naam in de syntaxis-accentuering-bestanden.

    bool document.isAttributeName(int regel, int kolom, String naam);
    bool document.isAttributeName(Cursor cursor, String naam);

- Geeft `true` terug, als de attribuutnaam op een bepaalde cursorpositie overeenkomt met de gegeven `naam`, anders `false`.

    String document.variable(String sleutel);

- Geeft de waarde terug van de gevraagde documentvariabele `sleutel`. Als de documentvariabele niet bestaat, wordt een lege tekenreeks teruggegeven.

    String document.setVariable(String sleutel, String waarde);

- Stelt de waarde in van de gevraagde documentvariabele `sleutel`. Geeft de ingestelde waarde van de variabele terug.

  Zie ook: Documentvariabelen van Kate

  Sinds: KDE 4.8

    int document.firstVirtualColumn(int regel);

- Geeft de virtuele kolom terug van het eerste niet-witruimte-teken in de gegeven regel of `-1`, als de regel leeg is of alleen witruimte-tekens bevat.

    int document.lastVirtualColumn(int regel);

- Geeft de virtuele kolom terug van het laatste niet-witruimte-teken in de gegeven regel of `-1`, als de regel leeg is of alleen witruimte-tekens bevat.

    int document.toVirtualColumn(int regel, int kolom);
    int document.toVirtualColumn(Cursor cursor);
    Cursor document.toVirtualCursor(Cursor cursor);

- Converteert de gegeven echte cursorpositie naar een virtuele cursorpositie, geeft ofwel een int terug of een cursor-object.

    int document.fromVirtualColumn(int regel, int virtueleKolom);
    int document.fromVirtualColumn(Cursor virtueleCursor);
    Cursor document.fromVirtualCursor(Cursor virtueleCursor);

- Converteert de gegeven virtuele cursorpositie naar een echte cursorpositie, geeft ofwel een int terug of een cursor-object.

    Cursor document.anchor(int regel, int kolom, Char teken);
    Cursor document.anchor(Cursor cursor, Char teken);

- Zoekt achterwaarts naar het gegeven teken te beginnen vanaf de gegeven cursor. Als voorbeeld, als '(' als teken wordt meegegeven, dan geeft deze functie de positie terug van de openingings '('. Dit houdt rekening met aantallen, dwz. andere '(...)' worden genegeerd.

    Cursor document.rfind(int regel, int kolom, String tekst, int attribuut = -1);
    Cursor document.rfind(Cursor cursor, String tekst, int attribuut = -1);

- Zoek de gegeven tekst achterwaarts met het juiste `attribuut`. Het argument `attribuut` wordt genegeerd als het is ingesteld op `-1`. De teruggegeven cursor is ongeldig, als de tekst niet is gevonden.

    int document.defStyleNum(int regel, int kolom);
    int document.defStyleNum(Cursor cursor);

- Geeft de standaard stijl terug op de gegeven cursorpositie.

    bool document.isCode(int regel, int kolom);
    bool document.isCode(Cursor cursor);

- Geeft `true` terug, als het attribuut op de gegeven cursorpositie niet gelijk is aan alle volgende stijlen: `dsComment`, `dsString`, `dsRegionMarker`, `dsChar`, `dsOthers`.

    bool document.isComment(int regel, int kolom);
    bool document.isComment(Cursor cursor);

- Geeft `true` terug, als het attribuut van het teken op de cursorpositie gelijk is aan `dsComment`, anders `false`.

    bool document.isString(int regel, int kolom);
    bool document.isString(Cursor cursor);

- Geeft `true` terug, als het attribuut van het teken op de cursorpositie gelijk is aan `dsString`, anders `false`.

    bool document.isRegionMarker(int regel, int kolom);
    bool document.isRegionMarker(Cursor cursor);

- Geeft `true` terug, als het attribuut van het teken op de cursorpositie gelijk is aan `dsRegionMarker`,anders `false`.

    bool document.isChar(int regel, int kolom);
    bool document.isChar(Cursor cursor);

- Geeft `true` terug, als het attribuut van het teken op de cursorpositie gelijk is aan `dsChar`, anders `false`.

    bool document.isOthers(int regel, int kolom);
    bool document.isOthers(Cursor cursor);

- Geeft `true` terug, als het attribuut van het teken op de cursorpositie gelijk is aan `dsOthers`, anders `false`.