&Anders.Lund; &Anders.Lund.mail;
&Dominik.Haumann; &Dominik.Haumann.mail;
Thomas
Diehl

    thd@kde.org

GUI-Übersetzung
Matthias
Schulz

    matthias.schulz@kdemail.net

Deutsche Übersetzung

# Weiterentwickelte Editierwerkzeuge

## Kommentar/Kommentar entfernen

Die Befehle Kommentar und Kommentar entfernen im Menü Bearbeiten erlauben das Hinzufügen oder Entfernen von Kommentarzeichen zur Auswahl, oder der aktuellen Textzeile, wenn kein Text markiert wurde. Diese Funktionen stehen nur zur Verfügung, wenn das benutzte Textformat Kommentare unterstützt.

Die Regeln für Kommentare werden in den Definitionen für die Syntax festgelegt, wenn Hervorhebungen für Syntax nicht benutzt werden, ist die Nutzung der Befehle also nicht möglich.

Einige Formate nutzen Kommentarzeichen für einzelne Zeilen, manche nutzen Kommentarzeichen für mehrere Zeilen, manche beides. Wenn Kommentarzeichen für mehrere Zeilen nicht verfügbar sind, kann eine Auswahl nicht auskommentiert werden, deren letzte Zeile nicht vollständig in die Auswahl einbezogen ist.

Wenn Kommentarzeichen für einzelne Zeilen definiert sind, werden diese bevorzugt eingesetzt, dies hilft, Probleme mit eingebetteten Kommentaren zu vermeiden.

Wenn Sie Kommentarzeichen entfernen, sollte nur kommentierter Text ausgewählt sein. Wenn mehrzeilige Kommentare entfernt werden, werden Leerzeichen und Tabulatoren (whitespaces) außerhalb der Kommentarzeichen ignoriert.

Um Kommentarzeichen einzufügen, wählen Sie im Menü Extras Kommentar oder das Tastenkürzel, hier standardmäßig &Ctrl;D.

Zum Entfernen von Kommentarzeichen wählen Sie im Menü Bearbeiten Kommentar entfernen oder das Tastenkürzel, hier standardmäßig &Ctrl;&Shift;D.

## Die integrierte Befehlszeile im Editor

&kate;s Editor hat eine interne Befehlszeile, von der aus Sie verschiedene Aktionen ausführen können. Die Befehlszeile ist ein Texteingabefeld am unteren Rand des Editorbereichs. Sie können diese einblenden, indem Sie im Menü Ansicht Auf Befehlszeile umschalten wählen oder das Tastenkürzel verwenden (standardmäßig ist F7 eingestellt). Der Editor stellt einige Befehle bereit, die nachfolgend beschrieben werden. Außerdem können Erweiterungen (Plugins) weitere Befehle bereitstellen.

Um einen Befehl auszuführen, geben Sie diesen in die Befehlszeile ein und drücken Sie Eingabetaste. Der Befehl gibt aus, ob die Ausführung erfolgreich war, eventuell wird noch eine Mitteilung ausgegeben. Wenn Sie den Befehl durch Drücken des Tastenkürzels F7 eingegeben haben, wird die Befehlszeile nach einigen Sekunden ausgeblendet. Um die Mitteilung zu löschen und einen neuen Befehl einzugeben, drücken Sie das Tastenkürzel F7 noch einmal.

Die Befehlszeile hat ein eingebautes Hilfesystem, das durch den Befehl `help` aufgerufen wird. Der Befehl `help list` zeigt eine Liste aller verfügbaren Befehle an, Hilfe zu einem speziellen Befehl erhalten Sie durch Eingabe von `help befehl`.

Die Befehlszeile hat eine eingebauten Verlaufsspeicher, sodass Sie bereits eingegebene Befehle wiederverwenden können. Um aus den bisherigen Befehlen auszuwählen, benutzen Sie die Tasten Nach oben und Nach unten. Wenn bisherige Befehle angezeigt werden, dann ist automatisch der Teil des Befehls, der die Argumente enthält, markiert, sodass Sie die Argumente sofort überschreiben können.

### Standardbefehle der Befehlszeile

#### Befehle zum Einrichten des Editors

Diese Befehle werden von der Editorkomponente bereitgestellt und gestatten das Einrichten des Editors für die aktuelle Ansicht des aktuellen Dokuments. Dies ist hilfreich, wenn Sie von den Standardeinstellungen abweichende Einstellungen, &eg; für Einrückungen benutzen wollen.

##### Typen der Argumente

BOOLEAN

  Dieser Typ wird mit Befehlen benutzt, die Dinge ein- und ausschalten. Zulässige Werte sind `on`, `off`, `true`, `false`, `1` oder `0`.

INTEGER

  Eine ganze Zahl

STRING

  Eine Zeichenkette

    set-tab-widthINTEGER Weite

  Setzt die Tabulatorweite auf `Weite`

    set-indent-widthINTEGER Weite

  Setzt die Einrückungsweite auf `Weite`. Dieser Wert wird nur benutzt, wenn Sie Leerzeichen zum Einrücken verwenden.

    set-word-wrap-columnINTEGER Weite

  Setzt die Zeilenlänge für den harten Zeilenumbruch auf `Weite`. Dieser Wert wird nur benutzt, wenn Sie den automatischen Zeilenumbruch benutzen.

    set-icon-borderBOOLEAN enable

  Schaltet die Anzeige des Symbolrandes ein und aus.

    set-folding-markersBOOLEAN enable

  Schaltet die Markierungen für die Code-Ausblendung ein und aus.

    set-line-numbersBOOLEAN enable

  Schaltet die Zeilennummerierung ein und aus.

    set-replace-tabsBOOLEAN enable

  Wenn eingeschaltet, werden Tab's durch Leerzeichen ersetzt.

    set-remove-trailing-spaceBOOLEAN enable

  Wenn eingeschaltet, werden Leerzeichen und andere Zwischenräume am Zeilenanfang entfernt, wenn der Cursor eine Zeile verlässt.

    set-show-tabsBOOLEAN enable

  Wenn eingeschaltet, werden Tab's und vorangestellte Leerzeichen durch kleine Punkte dargestellt.

    set-indent-spacesBOOLEAN enable

  Wenn eingeschaltet, werden Leerzeichen in der mit `indent-width` eingestellten Anzahl für jedes Einrückungsniveau benutzt und nicht Tab's.

    set-mixed-indentBOOLEAN enable

  &kate; benutzt eine Mischung aus Tabulatoren und Leerzeichen zum Einrücken wenn diese Option eingeschaltet ist. Jedes Einrückungsniveau ist `indent-width` breit, es werden möglichst viele Leerzeichen durch Tabulatoren ersetzt.

  Wenn dieser Befehl ausgeführt wird, wird außerdem das Einrücken mit Leerzeichen eingeschaltet und wenn die Einrückungsbreite noch nicht festgelegt ist, dann wird diese auf die Hälfte von `tab-width` für dieses Dokument zum Ausführungszeitpunkt gesetzt.

    set-word-wrapBOOLEAN enable

  Schaltet dynamischen Zeilenumbruch ein oder aus.

    set-replace-tabs-saveBOOLEAN enable

  Wenn eingeschaltet, werden Tab's durch Leerzeichen ersetzt, wenn das Dokument gespeichert wird.

    set-remove-trailing-space-saveBOOLEAN enable

  Wenn eingeschaltet, werden am Anfang der Zeile stehende Leerzeichen oder Tab's entfernt, wenn das Dokument gespeichert wird.

    set-indent-modename

  Setzt den Einrückungsmodus auf `name`. Wenn `name` nicht angegeben ist oder ein ungültiger Name verwendet wurde, wird der Modus ‚Kein(none)‘ gesetzt. Verfügbare Modes sind: ‚cstyle‘, ‚csands‘, ‚xml‘, ‚python‘, ‚varindent‘ und ‚none‘.

    set-highlighthighlight

  Setzt den Hervorhebungsmodus für das aktuelle Dokument. Das Argument muss ein gültiger Name für einen Hervorhebungsmodus sein. Die gültigen Modi findet man unter Extras Hervorhebungen.Dieser Befehl zeigt eine Liste der möglichen Argumente an, wenn die ersten Zeichen des Argumentes eingegeben wurden.

#### Befehle zum Bearbeiten

Diese Befehle bearbeiten und verändern das aktuelle Dokument.

    indent

  Rückt markierten Text oder die aktuelle Zeile ein.

    unindent

  Hebt die Einrückung für die markierten Zeilen oder die aktuelle Zeile auf.

    cleanindent

  Setzt die Einrückungen in den markierten Zeilen oder in der aktuellen Zeile in den Grundzustand zurück. Hierzu werden die Einstellungen für das aktuelle Dokument verwendet.

    comment

  Setzt Kommentarzeichen um die markierten Zeilen oder die aktuelle Zeile zu Kommentaren zu machen. Es wird das Kommentarzeichen aus der Hervorhebungsdefinition für das aktuelle Textformat benutzt.

    uncomment

  Entfernt Kommentarzeichen von den markierten Zeilen oder der aktuellen Zeile. Es wird das Kommentarzeichen aus der Hervorhebungsdefinition für das aktuelle Textformat benutzt.

    kill-line

  Löscht die aktuelle Zeile

    replacesuchtextreplacement

  Ersetzt den mit `suchtext` übereinstimmenden Text durch `replacement`. Wenn Sie Leerzeichen oder Tabulatoren im `suchtext` verwenden wollen, dann müssen Sie sowohl `suchtext` als auch `replacement` in einfache oder doppelte Anführungszeichen einschließen. Wenn Worte nicht in Anführungszeichen eingeschlossen sind, wird das erste Wort als `suchtext` und der Rest als `replacement` benutzt. Wenn `replacement` nicht angegeben ist, dann wird jedes Auftreten von `suchtext` gelöscht.

  Sie können bestimmte Einstellungen für die Suche vornehmen, indem Sie einen Doppelpunkt, gefolgt von einem oder mehreren Buchstaben - die die Einstellungen enthalten - anfügen. Die Form der Eingabe ist dann: `replace:options suchtext replacement`. Folgende Einstellungen sind verfügbar:

  `b`

    Rückwärts suchen.

  `c`

    Suchen ab Cursorposition.

  `e`

    Suchen nur in markiertem Text.

  `r`

    Suche nach einem regulären Ausdruck. Wenn diese Einstellung verwendet wird, können Sie `\N` im replacement string verwenden, die Anzahl, wie oft der Suchtext gefunden wurde, wird dann in den replacement string eingefügt.

  `s`

    Suche unter Berücksichtigung von Groß- und Kleinschreibung.

  `p`

    Nachfragen vor Ersetzen des nächsten Auftretens.

  `w`

    Nur ganze Wörter erfüllen die Suchbedingung.

    dateformat

  Setzt das aktuelle Datum und die aktuelle Uhrzeit im durch `format` eingestellten Format ein. Wenn kein Format eingestellt wurde, wird das Format yyyy-MM-dd hh:mm:ss als Standard benutzt. Die folgenden Übersetzungen werden vorgenommen, wenn `format` ausgewertet wird:

  `d` | Tag als Ziffer ohne führende Null (1-31).
  `dd` | Tag als Ziffer mit führender Null (01-31).
  `ddd` | Tag als abgekürzter Name in Landessprache (&eg; ‚Mon‘..‚Son‘).
  `dddd` | Tag als langer Name in Landessprache (&eg; ‚Montag‘..‚Sonntag‘).
  `M` | Monat als Ziffer ohne führende Null (1-12).
  `MM` | Monat als Ziffer mit führender Null (01-12).
  `MMM` | Monat als abgekürzter Name in Landessprache (&eg;‚Jan‘..‚Dez‘).
  `yy` | Das Jahr als zweistellige Ziffer (00-99).
  `yyyy` | Das Jahr als vierstellige Ziffer (1752-8000).
  `h` | Stunde ohne führende Null (0..23 oder 1..12 wenn AM/PM verwendet wird).
  `hh` | Stunde mit führender Null (00..23 oder 00..12 wenn AM/PM verwendet wird).
  `m` | Minute ohne führende Null (0.59).
  `mm` | Minute mit führender Null (00..59).
  `s` | Sekunde ohne führende Null (0.59).
  `ss` | Sekunde mit führender Null (00.59).
  `z` | Millisekunden ohne führende Null (0..999).
  `zzz` | Millisekunden mit führender Null (000..999).
  `AP` | Benutze die Anzeige mit AM/PM AP wird entweder von AM oder PM ersetzt.
  `ap` | Benutze die Anzeige mit am/pm ap wird durch am oder pm ersetzt.

    charidentifier

  Dieser Befehl erlaubt das Einsetzen von Zeichen in Text durch die Eingabe Ihrer Kodierung in dezimaler, oktaler oder hexadezimaler Form. Rufen Sie die Befehlszeile auf, schreiben Sie in das Eingabefeld das Wort `char:[nummer]` und klicken Sie auf OK.

  ##### Beispiele zu `char`

  Eingabe: `char:234`

  Ausgabe: `ê`

  Eingabe: `char:0x1234`

  Ausgabe: `ሴ`

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

  Dieser Befehl führt Suchen/Ersetzen auf der aktuellen Zeile oder in der gesamten Datei aus (`%s///`).

  Kurz gesagt, der Text wird nach dem Suchtext, dem regulären Ausdruck zwischen dem ersten und dem zweiten Schrägstrich, durchsucht und wenn der Suchtext gefunden wurde, wird der übereinstimmende Teil des Textes durch den Ausdruck zwischen dem mittleren und dem hinterem Schrägstrich ersetzt. Runde Klammern im Suchtext erzeugen Referenzen, die dann später dazu benutzt werden, die Zeichenketten wiederzuverwenden. Diese Referenzen werden wie folgt aufgerufen: `\1` für die erste Referenz, `\2` für die zweite und so weiter.

  Um nach einem Sonderzeichen, `(` oder `)`, zu suchen, müssen Sie dieses durch einen Rückwärtsschrägstrich kenntlich machen. `\(\)`

  Wenn Sie ein `i` an das Ende des Ausdruckes anhängen, wird beim Suchen nicht nach Groß- und Kleinbuchstaben unterschieden. Das Anhängen eines `g` legt fest, dass alle Vorkommen des Suchtextes ersetzt werden, normalerweise wird nur das erste Vorkommen ersetzt.

  ##### Ersetzen von Text in der aktuellen Zeile

  Ihr lieber Computer verweigerte gerade die Ausführung eines Programms, mit der Bemerkung, dass die Klasse `myClass`, die in der Zeile 3902 im Quelltext verwendet wird, nicht definiert ist.

  "Natürlich!", denken Sie, das muss `MyClass` heißen. Sie gehen zur Zeile 3092, rufen den Bearbeitungsbefehl auf, geben `s/myclass/MyClass/i` ein und klicken auf OK, Speichern die Datei und kompilieren – ohne Fehlermeldungen.

  ##### Ersetzen von Text in der gesamten Datei

  Stellen Sie sich vor, Sie hätten eine Datei, in der eine Miss Jensen einige Male erwähnt wird. Jemand kommt zur Tür herein und erzählt Ihnen, dass sie gerade Mr Jones geheiratet hat. Sie stehen nun vor der Aufgabe, jedes Miss Jensen durch Ms Jones zu ersetzen.

  Rufen Sie die Befehlszeile auf, geben Sie `%s/Miss Jensen/Ms Jones/` ein drücken Sie die Eingabetaste - fertig.

  ##### Ein etwas komplizierteres Beispiel

  Dieses Beispiel benutzt Referenzen und auch eine Wortklasse (wenn Sie nicht wissen, was das bedeutet, sehen Sie bitte in der unten angegebenen Dokumentation nach).

  Stellen Sie sich vor, Sie hätten folgende Zeile:

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

  Sie erkennen, dass dies nicht gut lesbar ist und entscheiden, das Schlüsselwort `const` für alle address of-Argumente zu verwenden (diese sind durch den vorangestellten Operator & gekennzeichnet). Außerdem wollen Sie die Zwischenräume vereinfachen, sodass nur noch ein Leerzeichen zwischen den Wörtern steht.

  Rufen Sie den Bearbeitungsbefehl auf, geben Sie `s/\s+(\w+)\s+(&)/ const \1 \2/g` und klicken Sie auf OK. Das `g` am Ende des regulären Ausdrucks bewirkt, dass der reguläre Ausdruck jedesmal neu kompiliert wird, um die Referenz zu sichern.

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

  Erledigt! Was passierte hier? Es wurde nach Leerzeichen (`\s+`) gefolgt von einem oder mehreren alphanumerischen Zeichen (`\w+`) gefolgt von einem oder mehreren Leerzeichen (`\s+`) gefolgt von einem Ampersand (&) gesucht und dabei der alphanumerische Abschnitt und das Ampersand (&) gesichert, um diese beim Ersetzen wiederzuverwenden. Dann haben wir den übereinstimmenden Teil der Zeile ersetzt durch ein Leerzeichen gefolgt von const gefolgt von einem Leerzeichen gefolgt vom gesicherten Abschnitt (`\1`) gefolgt von einem Leerzeichen gefolgt vom gesicherten Ampersand (&) (`\2`).

  In einigen Fällen war war der gesicherte Abschnitt String, in einigen int, sodass das Benutzen der Wortklasse `\w` und des `+`-Zeichens zum Angeben von ein oder mehrere sich als wertvoll erwies.

#### Befehle zur Bewegung im Dokument

    gotoINT line

  Dieser Befehl setzt den Cursor auf die angegebene Zeile.

    findSuchtext

  Dieser Befehl setzt den Cursor auf das erste Auftreten des `Suchtext` entsprechend der Einstellungen. Weitere Fundstellen werden durch Bearbeiten Weitersuchen oder Drücken des Tastenkürzels (Standard ist F3) gefunden.

  Der Befehl `find` kann durch das Anhängen eines Doppelpunktes und eines oder mehrerer Buchstaben in der Form `find:options pattern` ergänzt werden. Die folgenden Einstellungen sind verfügbar:

  `b`

    Rückwärts suchen.

  `c`

    Suchen ab Cursorposition.

  `e`

    Suchen nur in markiertem Text.

  `r`

    Suche nach einem regulären Ausdruck. Wenn diese Einstellung verwendet wird, können Sie `\N` im replacement string verwenden, die Anzahl, wie oft der Suchtext gefunden wurde, wird dann in den replacement string eingefügt.

  `s`

    Suche unter Berücksichtigung von Groß- und Kleinschreibung.

  `w`

    Nur ganze Wörter erfüllen die Suchbedingung.

    ifindsuchtext

  Dieser Befehl sucht schon beim Eingeben nach dem Suchtext. Sie können auch hier die Suche durch Anhängen eines Doppelpunktes und eines oder mehrerer Buchstaben in ihrem Verhalten anpassen. Die Eingabe muss dann in der Form: `ifind:options suchtext` erfolgen. Die folgenden Einstellungen stehen zur Verfügung:

  `b`

    Rückwärts suchen.

  `r`

    Suche nach einem regulären Ausdruck.

  `s`

    Suche unter Berücksichtigung von Groß- und Kleinschreibung.

  `c`

    Suchen ab Cursorposition.

## Benutzen von Code-Ausblendung

Code-Ausblendung dient zum Verstecken von Teilen des Dokuments im Editor, sodass große Dokumente einfacher zu lesen sind. In &kate; werden die ausblendbaren Abschnitte unter Zugrundelegung der Hervorhebungsregeln ermittelt und demzufolge sind Code-Ausblendungen nur in manchen Formaten verfügbar. Dies sind besonders Quelltexte in Programmiersprachen, XML und Ähnliches. Die meisten Hervorhebungsregeln, die Code-Ausblendungen bereitstellen, lassen auch die manuelle Festlegung von ausblendbaren Abschnitten zu, üblicherweise werden dazu die Schlüsselwörter `BEGIN` und `END` benutzt.

Um die Funktion Code-Ausblendung zu benutzen, wählen Sie im Menü Ansicht Markierungen für Code-Ausblendungen anzeigen. Es wird dann am linken Rand des Editorfensters ein grauer Rand eingeblendet, der eine grafische Darstellung der ausblendbaren Abschnitte enthält. In diesen Markierungen sind Symbole enthalten, die die möglichen Operationen anzeigen. Wenn zum Beispiel ein Dreieck mit der Spitze nach unten angezeigt wird, kann dieser Abschnitt ausgeblendet werden, ein nach rechts zeigendes Dreieck dagegen zeigt, dass hier ein Abschnitt ausgeblendet wurde. Dieser kann durch Klicken auf das Dreiecksymbol wieder eingeblendet werden.

Vier Befehle sind im Menü enthalten, die die Code-Ausblendung beeinflussen, sehen Sie in der Menü-Dokumentation für weitere Einzelheiten nach.

Wenn Sie keine Code-Ausblendung benutzen wollen, dann können Sie die Funktion Markierung für Code-Ausblendungen anzeigen auf der Seite Erscheinungsbild in den Einstellungen komplett ausschalten.

## &kate; mit Skripten erweitern

Seit &kate; Version 3.4 in KDE 4.4 kann die Editorkomponente durch Skripte erweitert werden. Als Skriptsprache wird ECMAScript verwendet, das auch unter dem Namen JavaScript bekannt ist. In &kate; können zwei Arten von Skripten benutzt werden: Einrückungs- und Befehlszeilenskripte.

### Einrückungsskripte

Mit Einrückungsskripten wird der Quelltext automatisch bei der Eingabe eingerückt. Nach Drücken der Eingabetaste wird die Einrückungstiefe zum Beispiel oft vergrößert.

Die folegenden Abschnitte beschreiben Schritt für Schritt, wie das Gerüst für ein einfaches Einrückungsskript entsteht. Zuerst wird eine neue `*.js`-Datei mit dem Namen `javascript.js` im persönlichen Ordner `$KDEHOME/share/apps/katepart/script`erzeugt.

#### Der Vorspann des Einrückungsskripts

Der Vorspann der Datei `javascript.js` ist in einem Kommentar eingebettet und hat folgende Form:

    /* 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
     *
     * Eine Zeile ohne Doppelpunkt (':') beendet das Einlesen des Vorspanns. Damit kann hier zusätzlicher
     * Text wie zum Beispiel ein ausführlicher Lizenztext eingefügt werden
     */

Jede Zeile wird jetzt im Detail erklärt:

- `kate-script` [erforderlich]: Dieser Text muss in der ersten Zeile der Datei `*.js` stehen, sonst überspringt &kate; dieses Skript.

- `name` [erforderlich]: Dies ist der Name des Skripts, der im Menü Extras Einrückung und im Einrichtungsdialog angezeigt wird.

- `author` [optional]: Der Name des Autors und weitere Kontaktinformationen.

- `license` [optional]: Kurzform der Lizenz, wie zum Beispiel BSD oder LGPLv3.

- `revision` [erforderlich]: Die Version des Skripts, sie sollte bei jeder Änderung des Skripts erhöht werden.

- `kate-version` [required]: Minimal erforderliche &kate;-Version.

- `type` [erforderlich]: Als Typ muss `indentation` verwendet werden, sonst überspringt &kate; dieses Skript.

- `required-syntax-style` [optional]: Durch Kommata getrennte Liste der erforderlichen Syntaxhervorhebungsstile. Dies ist wichtig für Einrückungsskripte, die besondere Informationen über die Hervorhebung im Dokument benötigen. Wenn ein erforderlicher Syntaxstil angegeben ist, ist das Einrückungsskript nur verfügbar, wenn auch die zugehörige Hervorhebung aktiviert ist. Dies verhindert ein nicht definiertes Verhalten beim Verwenden einer Einrückung ohne das erwartete Hervorhebungschema. Ein Beispiel dafür ist das Einrückungsskript für Ruby, das diese Option in den Dateien `ruby.js` und `ruby.xml` benutzt.

- `indent-languages` [optional]: Durch Kommata getrennte Liste von Syntaxstilen, die das Skript richtig einrücken kann, &eg;: c++, java.

- `priority` [optional]: Wenn es mehrere Einrückungsskripte für eine bestimmte hervorgehobenen Datei gibt, bestimmt die Priorität, welches Skript als Standard verwendet wird.

- `i18n-catalog` [optional]: Zusätzlicher Katalog mit Meldungen (`po`-Datei) für die Übersetzung von &kde;-fremden Einrückungsskripten.

&kate; liest alle Wertepaare in der Form schlüssel:wert bis zum letzten Doppelpunkt ein. Dann kann ein zusätzlicher Text wie im oben genannten Beispiel eine Lizenz im Vorspann folgen.

#### Der Quelltext des Einrückungsskripts

Nachdem der Vorspann beschrieben wurde, erklärt dieser Abschnitt wie das Einrückungsskript selbst funktioniert. Die Basisvorlage für den Quelltext sieht so aus:

    triggerCharacters = "{}/:;";
    function indent(line, indentWidth, ch)
    {
        // wird für jedem Zeilenumbruch (ch == '\n') und alle in der
        // globalen Variable triggerCharacters festgelegten Zeichen aufgerufen. Wenn ExtrasAusrichten
        // gewählt wird, ist die Variable ch leer, d. h. ch == ''.
        //
        // siehe auch: Skript-API
        return -2;
    }

Die Funktion `indent()` hat drei Argumente:

- `line`: die Zeile die eingerückt werden soll

- `indentWidth`: die Einrückungstiefe mit der Anzahl der Leerzeichen

- `ch`: entweder das Zeichen für Zeilenumbruch (`ch == '\n'`), ein in `triggerCharacters` festgelegtes Zeichen oder ein leeres Zeichen, wenn der Benutzer die Aktion Extras Ausrichten aufgerufen hat.

Der Rückgabewert der Funktion `indent()` bestimmt, wie die Zeile eingerückt wird. Ist dieser Wert eine Ganze Zahl, wird sie wie folgt interpretiert:

- Rückgabewert `-2`: keine Aktion

- Rückgabewert `-1`: Einrückung beibehalten (sucht nach vorherigen nicht leeren Zeilen)

- Rückgabewert `0`: eine Zahl >= 0 gibt die Anzahl der Leerzeichen zum Einrücken an

Alternativ kann ein Feld mit zwei Elementen zurückgegeben werden:

- `Rückgabewert [ indent, align ];`

In diesem Fall ist das erste Element die Einrückungstiefe wie oben mit derselben Bedeutung spezieller Werte. Das zweite Element ist ein absoluter Wert für die Spalte der Ausrichtung. Ist dieser Wert größer als der Einrückungswert, legt die Differenz der Werte die Anzahl von Leerzeichen fest, die zum ersten Wert für die gesamte Einrückung hinzuaddiert werden. Andernfalls wird der zweite Rückgabewert ignoriert. Die Benutzung von Tabulator- und Leerzeichen wird oft als Mischmodus bezeichnet.

Betrachen Sie das folgende Beispiel: Angenommen das Tabulatorzeichen wird zur Einrückung verwendet und die Tabulatorweite beträgt 4. Hier steht <tab> for den Tabulator und '.' für ein Leerzeichen:

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

Beim Einrücken der Zeile 2 gibt die Funktion `indent()` [8, 15] zurück. Daher werden zwei Tabulatoren für das Einrücken bis Spalte 8 und noch zusätzlich 7 Leerzeichen hinzugefügt. Dadurch steht der zweite Parameter unter dem ersten und bleibt auch so ausgerichtet, wenn die Datei mit einer anderen Tabulatorweite angezeigt wird.

In der Standardinstallation von KDE wird &kate; mit einigen Einrückungsskripten installiert. Die entsprechenden JavaScript-Quelltexte finden Sie unter `$KDEDIR/share/apps/katepart/script`.

Bei der Entwicklung eines Einrückungsskripts muss das Skript wieder neu geladen werden, um testen zu können, ob es richtig funktioniert. Anstatt das ganze Programm neu zu starten, wechseln Sie zur Befehlszeile und geben `reload-scripts` ein.

Wenn Sie nützliche Skripte entwickelt haben, sollten Sie darüber nachdenken, sie zum &kate;-Projekt hinzufügen. Schreiben Sie dazu an die Mailingliste.

### Befehlszeilenskripte

Da nicht alle gewünschten Funktionen in &kate; eingebaut werden können, ist es möglich, kleine Hilfsskripte für die schnelle Änderung von Textes mit der eingebauten Befehlszeile auszuführen. Der Befehl `sort` ist zum Beispiel als Skript geschrieben. Dieser Abschnitt erklärt, wie `*.js`-Dateien erstellt werden, um die Fähigkeiten von &kate; mit beliebigen Hilfsskripten zu erweitern.

Befehlszeilenskripte werden im gleichen Ordner wie Einrückungsskripte gespeichert. Zuerst erstellen eine neue `*.js`-Datei namens `myutils.js` im lokalen persönlichen Ordner `$KDEHOME/share/apps/katepart/script`.

#### Der Vorspann des Befehlszeilenskripts

Der Vorspann jedes Befehlszeilenskripts ist in einem Kommentar eingebettet und hat folgende Form:

    /* 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
     *
     * Eine Zeile ohne Doppelpunkt (':') beendet das Einlesen des Vorspanns. Damit kann hier zusätzlicher
     * Text wie zum Beispiel ein ausführlicher Lizenztext eingefügt werden.
     */

Jede Zeile wird jetzt im Detail erklärt:

- `kate-script` [erforderlich]: Dieser Text muss in der ersten Zeile der Datei `*.js` stehen, sonst überspringt &kate; dieses Skript.

- `author` [optional]: Der Name des Autors und weitere Kontaktinformationen.

- `license` [optional]: Kurzform der Lizenz, wie zum Beispiel BSD oder LGPLv3.

- `revision` [erforderlich]: Die Version des Skripts, sie sollte bei jeder Änderung des Skripts erhöht werden.

- `kate-version` [required]: Minimal erforderliche &kate;-Version.

- `type` [erforderlich]: Als Typ muss `commands` verwendet werden, sonst überspringt &kate; dieses Skript.

- `functions` [erforderlich]: Eine durch Kommata getrennte Liste der Befehle im Skript.

- `i18n-catalog` [optional]: Zusätzlicher Katalog mit Meldungen (`po`-Datei) für die Übersetzung von &kde;-fremden Skripten.

&kate; liest alle Wertepaare in der Form schlüssel:wert bis zum letzten Doppelpunkt ein. Dann kann ein zusätzlicher Text wie im oben genannten Beispiel eine Lizenz im Vorspann folgen. Der Wert des Schlüssels ist eine durch Kommata getrennte Liste von Befehlen für die eingebaute Befehlszeile. Daher kann jedes Skript eine beliebige Anzahl von Befehlen enthalten. Jede Funktion ist in der eingebauten Befehlszeile von &kate; verfügbar.

#### Der Quelltext des Skripts

Alle im Vorspann aufgeführten Funktionen müssen im Skript implementiert werden. Im oben gezeigten Skript müssen zum Beispiel die beiden Funktionen `sort` und `format-paragraph` implementiert werden. Alle Funktionen haben folgende Syntax:

    function <name>(arg1, arg2, ...)
    {
        // ... Implementierung, siehe auch: Skript-API
    }

Argumente in der Befehlszeile werden der Funktion als `arg1`, `arg2`, &etc; übergeben. Um für jeden Befehl eine Dokumentation zu Verfügung zu stellen, verwenden Sie die Funktion „`help`“ wie im folgenden Beispiel:

    function help(cmd)
    {
        if (cmd == "sort") {
            return i18n("Sortiert den ausgewählten Text.");
        } else if (cmd == "...") {
            // ...
        }
    }

Durch den Aufruf von `help sort` auf der Befehlszeile wird dann diese Hilfefunktion mit dem Argument `cmd` für den verwendeten Befehl benutzt, &ie; mit `cmd == "sort"`. zeigt &kate; den zurückgegebenen Text als Hilfe für den Benutzer an. Denken Sie daran, die Texte zu übersetzen .

##### Kurzbefehle festlegen

Kurzbefehle werden festgelegt, indem ein Skript die Funktion `action` wie folgt bereitstellt:

    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;
    }

Der Parameter `cmd` der Funktion gibt den Befehl an, für den der Kurzbefehl erzeugt werden soll. Es gibt einige Felder, die im zurückgegebenen Javascript-Objekt angegeben werden müssen:

- `a.text` [erforderlich]: Der Text, der im Menü Extras Scripte erscheint. Stellen Sie sicher, dass `i18n` für die Übersetzung verwendet wird.

- `a.icon` [optional]: Dieses Symbol erscheint neben dem Text im &kde;-Menü. Alle &kde;-Symbolnamen können hier benutzt werden.

- `a.category` [optional]: Wenn eine Kategorie angegeben ist, dann erscheint das Skript in einem Untermenü. Stellen Sie sicher, dass `i18n` für die Übersetzung verwendet wird.

- `a.interactive` [optional]: Wenn das Skript Nutzereingaben braucht, dann setzen Sie diesen Parameter auf `true`.

- `a.shortcut` [optional]: Der hier angegebene Kurzbefehl ist der Standard. Beispiel: Ctrl+Alt+T. Sehen Sie in der Qt-Dokumentation für weitere Einzelheiten nach.

Bei der Entwicklung eines Befehlszeilenskripts muss das Skript wieder neu geladen werden, um testen zu können, ob es richtig funktioniert. Anstatt das ganze Programm neu zu starten, wechseln Sie zur Befehlszeile und geben `reload-scripts` ein.

Wenn Sie nützliche Skripte entwickelt haben, sollten Sie darüber nachdenken, sie zum &kate;-Projekt hinzufügen. Schreiben Sie dazu an die Mailingliste.

### Skript-API

Die hier vorgestellte Skript-API kann in allen Skripten genutzt werden, sowohl in Einrückungsskripten wie auch in Befehlszeilenskripten. Ehe der Quelltext eines Skripts geladen wird, fügt &kate; zuerst mehrere Prototypen und Funktionen zum Skriptkontext hinzu. Diese allgemeine API enthält Prototypen wie Textcursor und Textbereiche und wird im Ordner `$KDEDIR/share/apps/katepart/api` gespeichert. Die Namen jeder JavaScript-Datei folgen dabei folgendem Namensschema:

    <zahl>_<name>.js

Die Zahl ist zweistellig und der Name ist beliebig wie zum Beispiel `meinscript`. Die Zahlen bestimmen die Reihenfolge der Ausführung der API. D. h. eine Datei `05_cursor.js` wird vor der Datei `10_range.js` geladen. Das entspricht der Startreihenfolge des runlevel/init-System in Linux.

Um die Standard-Skript-API mit eigenen Funktionen und Prototypen zu erweitern, erzeugen Sie eine neue Datei im lokalen Einrichtungsordner für KDE `$KDEHOME/share/apps/katepart/api` und geben der Datei eine größere Zahl (spätere Ausführung) im Namen als die anderen `*.js`-Dateien im globalen Ordner `$KDEDIR/share/apps/katepart/api`. &kate; sucht in beiden Ordnern nach `*.js`-Dateien und führt sie in der richtigen Reihenfolge aus.

Um vorhandene Prototypen wie `Cursor` oder `Range` zu erweitern, wird empfohlen, nicht die globalen `*.js`-Dateien zu ändern. Erstellen Sie stattdessen eine `*.js`-Datei im lokalen Ordner, die nach der Datei `05_cursor.js` ausgeführt wird und ändern Sie darin den `Cursor`-Prototyp in JavaScript.

#### Cursor und Bereiche

Da &kate; ein Texteditor ist, basiert die Skript-API soweit möglich auf Cursor und Bereichen. Ein Cursor ist ein einfaches Tupel `(zeile, spalte)` für eine Textposition m Dokument. Ein Bereich umfasst Text von Start bis zum Ende der Cursorposition. Die Programmschnittstelle wird in den nächsten Abschnitten im einzelnen erläutert.

##### Der Cursor-Prototyp

    Cursor();

  Konstruktor. Gibt einen Cursor an der Position `(0, 0)` zurück.

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

    Cursor(int zeile, int spalte);

  Konstruktor. Gibt einen Cursor an der Position `(zeile, spalte)` zurück.

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

    Cursor(Cursor cursor);

  Kopierkonstruktor. Gibt die Kopie des Cursors cursor zurück.

  Beispiel: `var copy = new Cursor(cursor);`

    Cursor Cursor.clone();

  Gibt einen Klon des Cursors zurück.

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

    bool Cursor.isValid();

  Überprüft, ob der Cursor gültig ist. Ein Cursor ist ungültig, wenn die Zeile und oder die Spalte den Wert `-1` haben.

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

    Cursor Cursor.invalid();

  Gibt einen neuen ungültigen Cursor an der Position `(-1, -1)` zurück.

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

    int Cursor.compareTo(Cursor cursor);

  Vergleicht diesen Cursor mit dem Cursor cursor. Gibt folgende Werte zurück:

  - `-1`, wenn dieser Cursor sich vor dem Cursor other befindet,

  - `0`, wenn beide Cursor an der gleichen Stelle stehen und

  - `+1`, wenn dieser Cursor sich hinter dem Cursor other befindet.

    bool Cursor.equals(Cursor cursor);

  Gibt `true` zurück, wenn dieser Cursor und der Cursor other gleich sind, sonst `false`.

    String Cursor.toString();

  Gibt den Cursor als Zeichenkette in der Form `Cursor(zeile, spalte)` zurück.

##### Der Bereich-Prototyp

    Range();

  Konstruktor. Der Aufruf `new Range()` gibt einen Bereich von (0, 0) - (0, 0) zurück.

    Range(Cursor start, Cursor ende);

  Konstruktor. Der Aufruf `new Range(start, end)` gibt einen Bereich von (start, ende) zurück.

    Range(int startZeile, int startspalte, int endZeile, int endSpalte);

  Konstruktor. Der Aufruf von `new Range(startZeile, startSpalte, endZeile, endSpalte)`. Gibt den Bereich von (startZeile, startSpalte) bis (endZeile, endSpalte) zurück.

    Range(Range other);

  Kopierkonstruktor. Gibt eine Kopie von Range other zurück.

    Range Range.clone();

  Gibt einen Klon des Bereichs zurück.

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

    bool Range.isValid();

  Gibt `true` zurück, wenn sowohl Start- als auch End-Cursor gültig sind, sonst `false`.

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

    bool Range.invalid();

  Gibt den Bereich von (-1, -1) bis (-1, -1) zurück.

    bool Range.contains(Cursor cursor);

  Gibt `true` zurück, wenn dieser Bereich die Cursorposition enthält, sonst `false`.

    bool Range.contains(Range other);

  Gibt `true` zurück, wenn dieser Bereich den Bereich other enthält, sonst `false`.

    bool Range.containsColumn(int spalte);

  Gibt `true` zurück, wenn spalte in dem halboffenen Interval `[start.spalte, end.spalte)` liegt, sonst `false`.

    bool Range.containsLine(int zeile);

  Gibt `true` zurück, wenn zeile in dem halboffenen Intervall `[start.zeile, end.zeile)` liegt, sonst `false`.

    bool Range.overlaps(Range other);

  Gibt `true` zurück, wenn dieser Bereich und der Bereich other sich überlappen, sonst `false`.

    bool Range.overlapsLine(int zeile);

  Gibt `true` zurück, wenn zeile in dem Intervall `[start.zeile, end.zeile]` liegt, sonst `false`.

    bool Range.overlapsColumn(int spalte);

  Gibt `true` zurück, wenn spalte in dem Intervall `[start.spalte, end.spalte]` liegt, sonst `false`.

    bool Range.equals(Range other);

  Gibt `true` zurück, wenn dieser Bereich und der Bereich other gleich sind, sonst `false`.

    String Range.toString();

  Gibt den Bereich als Zeichenkette in der Form `Range(Cursor(zeile, spalte), Cursor(zeile, spalte))` zurück.

#### Globale Funktionen

Dieser Abschnitt listet alle globalen Funktionen auf.

##### Fehlersuche

    void debug(String text);

  Gibt den text auf der Standarausgabe `stdout` in der Konsole aus, von der das Programm gestartet wurde.

##### Übersetzung

Die Lokalisierung wird durch einige Funktionen zum Übersetzen von Zeichenketten in Skripten unterstützt, so durch `i18n`, `i18nc`, `i18np` und `i18ncp`. Diese Funktionen arbeiten genau wie auf der Seite KDE's Übersetzungsfunktionen beschrieben.

Die Übersetzungsfunktionen übersetzen die eingepackten Zeichenketten durch &kde;'s Übersetzungssystem in die Sprache, die in der Anwendung benutzt wird. Zeichenketten in Skripten, die in den offiziellen &kate; Quellen entwickelt werden, werden automatisch extrahiert und sind übersetzbar. Anders gesagt, müssen Sie sich als Entwickler von &kate; nicht um das Extrahieren und Übersetzen kümmern. Allerdings müssen Sie für Skripte, die von Anderen ausserhalb von &kde; entwickelt werden, diese Arbeiten selbst tun. Zusammen mit den von Ihnen entwickelten Skripten müssen Sie auch den Übersetzungskatalog verteilen, der alle übersetzten Zeichenketten enthält. Ausserdem muss der Kopf Ihres Skriptes explizit im Parameter `i18n-catalog` angeben, welcher Katalog geladen werden muss.

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

  Übersetzt text in die von der Anwendung benutzte Sprache. Die Argumente arg1, ..., sind optional und werden benutzt, um die Platzhalter `%1`, `%2` usw. zu ersetzen.

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

  Übersetzt text in die von der Anwendung benutzte Sprache. Zusätzlich ist die Zeichenkette context sichtbar, so dass Übersetzer bessere Übersetzungen anfertigen können. Die Argumente arg1, ..., sind optional und werden benutzt, um die Platzhalter `%1`, `%2` usw. zu ersetzen.

    void i18np(String singular, String plural, int number, arg1, ...);

  Übersetzt entweder singular oder plural in die von der Anwendung benutzte Sprache. Dies ist abhängig von der angegebenen number. Die Argumente arg1, ..., sind optional und werden benutzt, um die Platzhalter `%1`, `%2` usw. zu ersetzen.

    void i18ncp(String context, String singular, String plural, int number, arg1, ...);

  Übersetzt entweder singular oder plural in die von der Anwendung benutzte Sprache. Dies ist abhängig von der angegebenen number. Zusätzlich ist die Zeichenkette context sichtbar, so dass Übersetzer bessere Übersetzungen anfertigen können. Die Argumente arg1, ..., sind optional und werden benutzt, um die Platzhalter `%1`, `%2` usw. zu ersetzen.

#### Die Programmschnittstelle zur Ansicht

Für jedes ausgeführte Skript gibt es eine globale Variable `view`, für die aktuelle Editoransicht. Im Folgenden finden Sie eine Liste aller verfügbaren Funktionen für eine Ansicht.

    Cursor view.cursorPosition()

  Gibt die aktuelle Position des Cursors in der Ansicht zurück.

    void view.setCursorPosition(int zeile, int spalte)
    void view.setCursorPosition(Cursor cursor)

  Gibt die aktuelle Position des Cursors in der Ansicht zurück.

    void view.setCursorPosition(int zeile, int spalte);
    void view.setCursorPosition(Cursor cursor);

  Setzt die aktuelle Position des Cursors entweder auf (zeile, spalte) oder auf den angegebenen Cursor.

    Cursor view.virtualCursorPosition();

  Gibt die virtuelle Cursorposition zurück, dabei wird jeder Tabulator mit der Anzahl der Leerzeichen entsprechend der aktuellen Tabulatorweite berechnet.

    void view.setVirtualCursorPosition(int zeile, int spalte);
    void view.setVirtualCursorPosition(Cursor cursor);

  Setzt die aktuelle Position des virtuellen Cursors entweder auf (zeile, spalte) oder auf den angegebenen Cursor.

    String view.selectedText();

  Gibt den ausgewählten Text zurück. Ist kein Text ausgewählt, wird eine leere Zeichenkette zurückgegeben.

    bool view.hasSelection();

  Gibt `true` zurück, wenn die Ansicht ausgewählten Text enthält, sonst `false`.

    Range view.selection();

  Gibt den ausgewählten Textbereich zurück. Der zurückgegebene Bereich ist ungültig, wenn kein Text ausgewählt ist.

    void view.setSelection(Range range);

  Setzt den ausgewählten Text zum angegebenen Bereich.

    void view.removeSelectedText();

  Entfernt den ausgewählten Text. Wenn in der Ansicht kein Text ausgewählt ist, passiert nichts.

    void view.selectAll();

  Wählt den gesamten Text im Dokument aus.

    void view.clearSelection();

  Löscht die Textauswahl, aber nicht den Text selbst.

#### Die Programmschnittstelle zum Dokument

Für jedes ausgeführte Skript gibt es eine globale Variable `document`, die das aktuelle Dokument verweist. Im Folgenden finden Sie eine Liste aller verfügbaren Funktionen für ein Dokument.

    String document.fileName();

  Gibt den Dateinamen des Dokumentes zurück oder eine leere Zeichenkette für nicht gespeicherte Textpuffer.

    String document.url();

  Gibt die vollständige URL des Dokumentes zurück oder eine leere Zeichenkette für nicht gespeicherte Textpuffer.

    String document.mimeType();

  Gibt den Mimetyp des Dokuments zurück oder `application/octet-stream`, wenn kein passender Mimetyp gefunden wurde.

    String document.encoding();

  Gibt die aktuell verwendete Kodierung zum Speichern der Datei zurück.

    String document.highlightingMode();

  Gibt den globalen Hervorhebungsmodus für das gesamte Dokument zurück.

    String document.highlightingModeAt(Cursor pos);

  Gibt den Hervorhebungsmodus an der angegebenen Cursorposition im Dokument zurück.

    Array document.embeddedHighlightingModes();

  Gibt ein Feld von Hervorhebungsmodi zurück, die in diesem Dokument eingebettet sind..

    bool document.isModified();

  Gibt `true` zurück, wenn das Dokument ungespeicherte Änderungen enthält, sonst `false`.

    String document.text();

  Gibt den gesamten Inhalt des Dokuments in einer einzigen Zeichenkette zurück. Zeilenumbrüche werden mit dem zugehörigen Zeichen `\n` markiert.

    String document.text(int vonZeile, int vonSpalte, int bisZeile, int bisSpalte);
    String document.text(Cursor von, Cursor bis);
    String document.text(Range range);

  Gibt den Text im angegebenen Bereich zurück. Es wird empfohlen, die Cursor- und Bereichsbasierte Version zu benutzen, dadurch der Quelltext besser lesbar.

    String document.line(int zeile);

  Gibt die angegebene Textzeile als Zeichenkette zurück. Die Zeichenkette ist leer, wenn die angeforderte Zeile außerhalb des Bereichs liegt.

    String document.wordAt(int zeile, int spalte);
    String document.wordAt(Cursor cursor);

  Gibt das Wort an der aktuellen Cursorposition zurück.

    String document.charAt(int zeile, int spalte);
    String document.charAt(Cursor cursor);

  Gibt das Zeichen an der aktuellen Cursorposition zurück.

    String document.firstChar(int zeile);

  Gibt in der angegebenen zeile das erste Zeichen zurück, das kein Leerraumzeichen ist. Wenn die Zeile leer ist oder nur Leerraumzeichen enthält, wird eine leere Zeichenkette zurückgegeben.

    String document.lastChar(int zeile);

  Gibt in der angegebenen zeile das letzten Zeichen zurück, das kein Leerraumzeichen ist. Wenn die Zeile leer ist oder nur Leerraumzeichen enthält, wird eine leere Zeichenkette zurückgegeben.

    bool document.isSpace(int zeile, int spalte);
    bool document.isSpace(Cursor cursor);

  Gibt `true` zurück, wenn das Zeichen an der angegebenen Cursorposition ein Leerraumzeichen ist, sonst `false`.

    bool document.matchesAt(int zeile, int spalte, int zeile, String text);
    bool document.matchesAt(Cursor cursor, String text);

  Gibt `true` zurück, wenn der angegebene text mit der zugehörigen Cursorposition übereinstimmt, sonst `false`.

    bool document.startsWith(int zeile, String text, bool skipWhiteSpaces);

  Gibt `true`, wenn die Zeile mit text beginnt, sonst `false`. Das Argument skipWhiteSpaces bestimmt, ob führende Leerraumzeichen ignoriert werden.

    bool document.endsWith(int zeile, String text, bool skipWhiteSpaces);

  Gibt `true`, wenn die Zeile mit text endet, sonst `false`. Das Argument skipWhiteSpaces bestimmt, ob angehängte Leerraumzeichen ignoriert werden.

    bool document.setText(String text);

  Setzt den Text für das gesamte Dokument.

    bool document.clear();

  Löscht den gesamten Text im Dokument.

    bool document.truncate(int zeile, int spalte);
    bool document.truncate(Cursor cursor);

  Schneidet die angegeben Zeile an der Spalte oder an der Cursorposition ab. War das erfolgreich, wird `true` zurückgegeben, oder `false`, wenn die angegeben Zeile nicht im Bereich des Dokuments.

    bool document.insertText(int zeile, int spalte, int zeile, String text);
    bool document.insertText(Cursor cursor, String text);

  Fügt den text an der angegebenen Cursorposition ein. War das erfolgreich, wird `true` zurückgegeben, oder `false`, wenn das Dokument im Nur-Lesen-Modus geöffnet wurde.

    bool document.removeText(int vonZeile, int vonSpalte, int bisZeile, int bisSpalte);
    bool document.removeText(Cursor von, Cursor bis);
    bool document.removeText(Range bereich);

  Löscht den Text im angegebenen Bereich. War das erfolgreich, wird `true` zurückgegeben, oder `false`, wenn das Dokument im Nur-Lesen-Modus geöffnet wurde.

    bool document.insertLine(int zeile, String text);

  Fügt Text in einer angegebenen Zeile ein. War das erfolgreich, wird `true` zurückgegeben, oder `false`, wenn das Dokument im Nur-Lesen-Modus geöffnet wurde oder die Zeile nicht mehr im Bereich des Dokuments liegt.

    bool document.removeLine(int zeile);

  Löscht die angegebene Textzeile. War das erfolgreich, wird `true` zurückgegeben, oder `false`, wenn das Dokument im Nur-Lesen-Modus geöffnet wurde oder die Zeile nicht mehr im Bereich des Dokuments liegt.

    void document.joinLines(int startZeile, int endZeile);

  Verbindet die Zeilen von startZeile bis endZeile. Zwei aufeinanderfolgende Textzeilen werden immer mit einem einzelnen Leerzeichen getrennt.

    int document.lines();

  Gibt die Zeilenanzahl des Dokuments zurück.

    int document.length();

  Gibt die Anzahl der Zeichen des Dokuments zurück.

    int document.lineLength(int zeile);

  Gibt die Länge der zeile zurück.

    void document.editBegin();

  Beginnt eine Bearbeitungsgruppe für die Gruppierung von Rückgängig/Wiederherstellen. Achten Sie darauf, `editEnd()` immer genauso oft wie `editBegin()` zu benutzen. Der Aufruf von `editBegin()` verwendet intern einen Referenzzähler, &ie; diese Aufrufe können geschachtelt werden.

    void document.editEnd();

  Beendet eine Bearbeitungsgruppe. Der letzte Aufruf von `editEnd()` (&ie; der Aufruf zum ersten Aufruf von `editBegin()`) beendet den Bearbeitungsschritt.

    int document.firstColumn(int zeile);

  Gibt die erste Spalte in der angegebenen zeile zurück, die kein Leerraumzeichen enthält. Besteht die Zeile nur aus Leerraumzeichen, wird `-1` zurückgegeben.

    int document.lastColumn(int zeile);

  Gibt die letzte Spalte in der angegebenen zeile zurück, die kein Leerraumzeichen enthält. Besteht die Zeile nur aus Leerraumzeichen, wird `-1` zurückgegeben.

    int document.prevNonSpaceColumn(int zeile, int spalte);
    int document.prevNonSpaceColumn(Cursor cursor);

  Gibt die Spalte zurück, die keine Leerraumzeichen enthält. Die Suche beginnt an der angegebenen Cursorposition und erfolgt dabei rückwärts.

    int document.nextNonSpaceColumn(int zeile, int spalte);
    int document.nextNonSpaceColumn(Cursor cursor);

  Gibt die Spalte zurück, die keine Leerraumzeichen enthält. Die Suche beginnt an der angegebenen Cursorposition und erfolgt dabei vorwärts.

    int document.prevNonEmptyLine(int zeile);

  Gibt die nächste nicht leere Zeile zurück, die keine Leerraumzeichen enthält. Die Suche erfolgt dabei rückwärts.

    int document.nextNonEmptyLine(int zeile);

  Gibt die nächste nicht leere Zeile zurück, die keine Leerraumzeichen enthält. Die Suche erfolgt dabei vorwärts.

    bool document.isInWord(String zeichen, int attribut);

  Gibt `true` zurück, wenn das angegebene zeichen mit den angegebenen attribut Teil eines Wortes sein kann, sonst `false`.

    bool document.canBreakAt(String zeichen, int attribut);

  Gibt `true` zurück, wenn die Zeile an dem angegebenen zeichen mit den angegebenen attribut umgebrochen werden kann, sonst `false`.

    bool document.canComment(int startAttribut, int endAttribut);

  Gibt `true` zurück, wenn ein mit dem angegebenen Attribut beginnender und endender Bereich auskommentiert werden kann, sonst `false`.

    String document.commentMarker(int attribut);

  Gibt das Kommentarzeichen für einzeilige Kommentare für ein angegebenes attribut zurück.

    String document.commentStart(int attribut);

  Gibt das Kommentarzeichen für den Beginn von mehrzeiligen Kommentaren für ein angegebenes attribut zurück.

    String document.commentEnd(int attribut);

  Gibt das Kommentarzeichen für das Ende von mehrzeiligen Kommentaren für ein angegebenes attribut zurück.

    int document.attribute(int zeile, int spalte);
    int document.attribute(Cursor cursor);

  Gibt das Attribut an der aktuellen Cursorposition zurück.

    bool document.isAttribute(int zeile, int spalte, int attribut);
    bool document.isAttribute(Cursor cursor, int attribut);

  Gibt `true` zurück, wenn das Attribut an der angegebenen Cursorposition gleich attribut ist, sonst `false`.

    String document.attributeName(int zeile, int spalte);
    String document.attributeName(Cursor cursor);

  Gibt den Attributnamen als lesbaren Text zurück. Dies entspricht dem Namen `itemData` in den Syntaxhervorhebungs-Dateien.

    bool document.isAttributeName(int zeile, int spalte, String name);
    bool document.isAttributeName(Cursor cursor, String name);

  Gibt `true` zurück, wenn der Attributname an der angegebenen Cursorposition gleich name ist, sonst `false`.

    String document.variable(String key);

  Gibt den Wert der angefragten Dokumentvariablen key zurück. Existiert diese Variable nicht, wird eine leere Zeichenkette zurückgegeben.

    int document.firstVirtualColumn(int zeile);

  Gibt in der angegebenen Zeile die virtuelle Spalte des ersten Zeichens zurück, das kein Leerraumzeichen ist, oder `-1`, wenn die Zeile leer ist oder nur Leerraumzeichen enthält.

    int document.lastVirtualColumn(int zeile);

  Gibt in der angegebenen Zeile die virtuelle Spalte des letzten Zeichens zurück, das kein Leerraumzeichen ist, oder `-1`, wenn die Zeile leer ist oder nur Leerraumzeichen enthält.

    int document.toVirtualColumn(int zeile, int spalte);
    int document.toVirtualColumn(Cursor cursor);
    Cursor document.toVirtualCursor(Cursor cursor);

  Wandelt die angegebene realeCursorposition in eine virtuelle Cursorposition um und gibt entweder ein „int“-Wert oder ein Cursorobjekt zurück.

    int document.fromVirtualColumn(int zeile, int virtuelleSpalte);
    int document.fromVirtualColumn(Cursor virtuellerCursor);
    Cursor document.fromVirtualCursor(Cursor virtuellerCursor);

  Wandelt die angegebene virtuelle Cursorposition in eine reale Cursorposition um und gibt entweder ein „int“-Wert oder ein Cursorobjekt zurück.

    Cursor document.anchor(int zeile, int spalte, Char zeichen);
    Cursor document.anchor(Cursor cursor, Char zeichen);

  Sucht rückwärts nach dem angebenen Zeichen und beginnt dabei an dem angegebenen Cursor. Wenn zum Beispiel „(“ als Zeichen ist, gibt diese Funktion die Position der öffnenden Klammer „(“. Dabei wird das Vorkommen mitgezählt, &ie; andere Klammern „(...)“ werden ignoriert.

    Cursor document.rfind(int zeile, int spalte, String text, int attribut = -1);
    Cursor document.rfind(Cursor cursor, String text, int attribut = -1);

  Sucht rückwärts nach dem angegeben Text mit dem passenden attribut. Ein Attribut mit dem Wert `-1`wird dabei ignoriert. Es wird ein ungültiger Cursor zurückgegeben, wenn der Text nicht gefunden wurde.

    int document.defStyleNum(int zeile, int spalte);
    int document.defStyleNum(Cursor cursor);

  Gibt den Standardstil zurück, der an der angegebenen Cursorposition benutzt wird.

    bool document.isCode(int zeile, int spalte);
    bool document.isCode(Cursor cursor);

  Gibt `true`zurück , wenn das Attribut an der angegeben Cursorposition nicht den folgenden Stilen entspricht: `dsComment`, `dsString`, `dsRegionMarker`, `dsChar`, `dsOthers`.

    bool document.isComment(int zeile, int spalte);
    bool document.isComment(Cursor cursor);

  Gibt `true` zurück, wenn das Attribut des Zeichens an der Cursorposition `dsComment` ist, sonst `false`.

    bool document.isString(int zeile, int spalte);
    bool document.isString(Cursor cursor);

  Gibt `true` zurück, wenn das Attribut des Zeichens an der Cursorposition `dsString` ist, sonst `false`.

    bool document.isRegionMarker(int zeile, int spalte);
    bool document.isRegionMarker(Cursor cursor);

  Gibt `true` zurück, wenn das Attribut des Zeichens an der Cursorposition `dsRegionMarker` ist, sonst `false`.

    bool document.isChar(int zeile, int spalte);
    bool document.isChar(Cursor cursor);

  Gibt `true` zurück, wenn das Attribut des Zeichens an der Cursorposition `dsChar` ist, sonst `false`.

    bool document.isOthers(int zeile, int spalte);
    bool document.isOthers(Cursor cursor);

  Gibt `true` zurück, wenn das Attribut des Zeichens an der Cursorposition `dsOthers` ist, sonst `false`.