&TC.Hollingsworth; &TC.Hollingsworth.mail;
Thomas
Diehl

    thd@kde.org

GUI-Übersetzung
Matthias
Schulz

    matthias.schulz@kdemail.net

Deutsche Übersetzung

# &katepart; erweitern

## Einführung

Wie jeder gute Texteditor bietet auch &katepart; verschiedene Möglichkeiten für Erweiterungen. Sie können Skripte in &javascript; schreiben, um Funktionen zu erweitern. Wenn Sie dann &katepart; erweitert haben, laden wir Sie ein, Ihre Verbesserungen mit der ganzen Welt zu teilen.

## Arbeiten mit Syntaxhervorhebungen

### Überblick

Syntaxhervorhebungen bewirken, dass der Editor den Text automatisch in verschiedenen Farben und Schriftstilen anzeigt, abhängig von der Funktion der Zeichenfolge in Beziehung zum Zweck des Dokuments. Zum Beispiel können in Quelltext Kontrollbefehle fett dargestellt werden, während Daten und Kommentare andere Farben als der Rest des Textes bekommen. Dies verbessert die Lesbarkeit des Textes erheblich und verhilft damit dem Autor zu mehr Effizienz und Produktivität.

Eine C++-Funktion, mit Hervorhebungen angezeigt.

Eine C++-Funktion, mit Hervorhebungen angezeigt.

Dieselbe C++-Funktion, ohne Hervorhebungen.

Dieselbe C++-Funktion, ohne Hervorhebungen.

Welche der beiden ist einfacher zu lesen?

&kappname; enthält ein flexibles, konfigurierbares und leistungsfähiges System für Syntaxhervorhebungen, und die Standarddistribution enthält bereits Definitionen für eine Anzahl von Programmiersprachen, Markup- und Skriptsprachen sowie andere Textformaten. Außerdem können Sie eigene Definitionen in einfachen &XML;-Dateien erstellen.

&kappname; erkennt auf Basis des &MIME;-Typs, der Dateiendung oder des Inhalts des Dokuments bereits beim Öffnen des Dokuments automatisch die richtigen Regeln für die Syntaxhervorhebungen. Wenn die automatische Auswahl nicht die richtigen Regeln ausgewählt hat, können Sie dies manuell korrigieren (Extras Hervorhebung).

Die Schriftstile und Farben, die von jeder Syntaxhervorhebungsdefinition benutzt werden, können auf der Seite Hervorhebungs-Schriftarten des Einrichtungsdialogs festgelegt werden, die Einrichtung der &MIME;-Typen und Dateierweiterung, auf die diese angewendet werden, ist auf der Seite Dateitypen möglich.

Syntaxhervorhebungen sind dazu gedacht die Lesbarkeit von Text zu verbessern, aber nicht dazu geeignet die Richtigkeit des Quelltextes zu überprüfen. Die Erstellung der Regeln für die Hervorhebungen ist kompliziert, abhängig davon, welches Format Sie benutzen. In manchen Fällen sind die Autoren der Regeln stolz, wenn 98 % des Textes korrekt hervorgehoben werden, meistens jedoch sehen Sie die nicht korrekten 2 % nur bei seltenen Konstruktionen.

### Das &kappname; Syntaxhervorhebungssystem

Dieser Abschnitt behandelt die Mechanismen des &kappname; Syntax-Hervorhebungssystems genauer. Wenn Sie selbst Definitionen erstellen oder verändern möchten, sollten Sie diesen genau lesen.

#### Wie es funktioniert

Immer, wenn Sie ein Dokument öffnen, ist eines der ersten Dinge, die &kappname; macht, festzustellen, welche Syntaxdefinition für dieses Dokument benutzt werden soll. Während Sie den Text lesen und neuen Text eingeben, analysiert das Syntaxhervorhebungssystem den Text anhand der Regeln in der Syntaxdefinition und markiert ihn dementsprechend.

Wenn Sie Text eingeben, wird der neue Text sofort analysiert und markiert.

Die Syntaxdefinitionen, die in &XML; benutzt werden, sind &XML;-Dateien, die Folgendes enthalten

- Regeln für das Erkennen von Text, organisiert in Kontextblöcken

- Listen mit Schlüsselworten

- Stildefinitionen

Beim Analysieren von Text werden die Erkennungsregeln in der Reihenfolge, in der sie definiert wurden, überprüft und wenn der Anfang des aktuellen Textes mit einer Definition übereinstimmt, wird der zugehörige Kontext benutzt. Der nächste Startpunkt wird nach dem Ende des erkannten Bereichs gesetzt und von dort aus wird eine neue Schleife für die Regeln mit dem Kontext der gerade gefundenen Regel gestartet.

#### Regeln

Die Erkennungsregeln sind das Herzstück des Syntaxhervorhebungssystems. Eine Regel besteht aus einer Zeichenfolge, einem Zeichen oder einem regulären Ausdruck. Mit diesen wird der zu analysierende Text verglichen. Sie enthalten Informationen, welche Darstellung für das erkannte Stück Text verwendet werden soll und ob entweder zu einem explizit angegebenem Kontext oder zum vorher vom Text benutzten Kontext gewechselt werden soll.

Die Regeln sind in Kontextgruppen organisiert. Eine Kontextgruppe wird für die grundlegenden Textkonzepte innerhalb des Formates benutzt, &eg; für Textteile in Anführungszeichen oder Kommentarblöcke in Programmquelltext. Dadurch wird sichergestellt, dass sich das Syntaxhervorhebungssystem nicht unnötig durch alle Regeln hindurch arbeiten muss und dass einige Zeichenfolgen im Text abhängig vom aktuellen Kontext unterschiedlich behandelt werden können.

Kontexte können dynamisch generiert werden, um das Benutzen von Daten in Regeln zu erlauben, die nur auf diese Instanz zutreffen.

#### Kontextstile und Schlüsselwörter

In einigen Programmiersprachen werden Ganze Zahlen durch den Compiler (das Programm, das den Quelltext in ein ausführbares Programm übersetzt) anders behandelt als Gleitkommazahlen, und es gibt Zeichen, die eine spezielle Bedeutung innerhalb einer in Anführungszeichen eingeschlossenen Zeichenfolge haben. In solchen Fällen ist es sinnvoll, diese unterschiedlich darzustellen, sodass sie beim Lesen einfach vom umgebenden Text zu unterscheiden sind. Auch wenn diese keine speziellen Kontexte repräsentieren, können sie durch das Syntaxhervorhebungssystem erkannt und anders dargestellt werden.

Eine Syntaxdefinition kann so viele verschiedene Stile beinhalten, wie für das Format notwendig sind.

In vielen Formaten gibt es Listen mit Wörtern, die einem speziellen Konzept zugehörig sind. In Programmiersprachen sind &eg; die Kontrollanweisungen ein Konzept, die Datentypen ein anderes und die eingebauten Funktionen ein drittes. Das Syntaxhervorhebungssystem von &kappname; kann benutzt werden, um solche Wörter anhand der Listen zu finden und zur Hervorhebung der Konzepte im Text zu markieren.

#### Standardstile

Wenn Sie eine C++-Quelltextdatei, eine &Java;-Quelltextdatei und eine &HTML;-Datei in &kappname; öffnen, sehen Sie dass auch in unterschiedlichen Formaten und damit unterschiedlichen Worten, die spezielle Behandlung bekommen, die benutzten Farben dieselben sind. Der Grund dafür ist, dass &kappname; vordefinierte Standardstile benutzt, die von den individuellen Syntaxdefinitionen verwendet werden.

Dadurch wird die Erkennung von ähnlichen Konzepten in verschiedenen Textformaten einfach. Kommentare &eg; gibt es in fast allen Programmiersprachen, Skripten und Markup-Sprachen; diese werden in allen Sprachen gleich dargestellt, sodass Sie sich auf die Arbeit konzentrieren können und nicht über den Zweck einzelner Einträge nachdenken müssen.

Alle Stile in einer Syntaxdefinition nutzen einen der Standardstile. Einige wenige Syntaxdefinitionen nutzen mehr Stile als Standardstile vorhanden sind. Wenn Sie ein Format sehr oft benutzen, kann es die Arbeit wert sein, den Einrichtungsdialog zu starten und nachzusehen, ob mehrere Konzepte dieselben Stile benutzen. In der Programmiersprache Perl &eg; gibt es zwei Typen von Zeichenfolgen, sodass Sie die Hervorhebung durch eine etwas andere Darstellung des zweiten Typs verbessern können. Alle verfügbaren Standardstile, werden weiter unten erklärt.

### Die Hervorhebungsdefinition für das &XML; Format

#### Überblick

&kappname; verwendet die Syntaxhervorhebungs-Bibliothek von &kde-frameworks;. Die in &kappname; enthaltenen Standard-&XML;-Hervorhebungsdateien werden in die Syntaxhervorhebungs-Bibliothek einkompiliert.

Dieser Abschnitt ist ein Überblick über die Hervorhebungsdefinition für das &XML;-Format.. Es beschreibt die Hauptbestandteile, deren Bedeutung und Verwendung. Im nächsten Kapitel werden die Erkennungsregeln detailliert beschrieben.

Die formale Definition XSD finden Sie im Syntax-Highlighting-Repository in der Datei `language.xsd`.

Eigene `.xml`-Dateien mit Definitionen zur Syntaxhervorhebung sind im Ordner `org.kde.syntax-highlighting/syntax/` in Ihrem persönlichen Ordner. Den Pfad zu diesem Ordner finden Sie mit ``qtpaths``--paths GenericDataLocation``. Normalerweise sind dies ``$HOME`/.local/share/` und `/usr/share/`.

Bei Flatpak- und Snap-Paketen funktioniert der obige Ordner nicht, da der Speicherort der Daten für jede Anwendung unterschiedlich ist. In einer Flatpak-Anwendung ist der Speicherort der benutzerdefinierten &XML;-Dateien normalerweise ``$HOME`/.var/app/flatpak-package-name/data/org.kde.syntax-highlighting/syntax/` und in einer Snap-Anwendung ist dieser Ort ``$HOME`/snap/snap-package-name/current/.local/share/org.kde.syntax-highlighting/syntax/`.

Auf &Windows;-Systemen finden Sie diese Dateien unter `%USERPROFILE%\AppData\Local\org.kde.syntax-highlighting\syntax`. Dabei ist %USERPROFILE% normalerweise `C:\Users\user`.

Zusammenfassend lässt sich sagen, dass bei den meisten Einrichtungen der Ordner der benutzerdefinierten &XML;-Dateien wie folgt aussieht

Für lokale Benutzer | ``$HOME`/.local/share/org.kde.syntax-highlighting/syntax/`
Für alle Benutzer | `/usr/share/org.kde.syntax-highlighting/syntax/`
Für Flatpak-Pakete | ``$HOME`/.var/app/flatpak-package-name/data/org.kde.syntax-highlighting/syntax/`
Für Snap-Pakete | ``$HOME`/snap/snap-package-name/current/.local/share/org.kde.syntax-highlighting/syntax/`
Unter &Windows; | `%USERPROFILE%\AppData\Local\org.kde.syntax-highlighting\syntax`

Wenn mehrere Dateien für dieselbe Sprache existieren, wird die Datei mit der höchsten `version`-Attribut im `language`-Element geladen.

##### Hauptbestandteile der &kappname;-Hervorhebungsdefinitionen

Eine Hervorhebungsdefinitionsdatei enthält einen Kopf mit der &XML;-Version:

      <?xml version="1.0" encoding="UTF-8"?>

Die Wurzel der Definitionsdatei ist das Element `language`. Verfügbare Eigenschaften sind:

  Notwendige Eigenschaften:

  `name` setzt den Namen der Sprache. Dieser erscheint nachher in Menüs und in Dialogen.

  Die Eigenschaft `section` definiert die Kategorie.

  `extensions` definiert die Erweiterungen für Dateinamen wie &eg; "*.cpp;*.h".

  `version` gibt die aktuelle Revision der Definitionsdatei als ganze Zahl an. Bei jeder Änderung einer Hervorhebungs-Datei sollte diese Zahl vergrößert werden.

  `kateversion` definiert die letzte unterstützte Version von &kappname;.

  Optionale Eigenschaften:

  `mimetype` ordnet Dateien basierend auf deren &MIME;-Type zu.

  `casesensitive` definiert, ob bei den Schlüsselwörtern Groß-/Kleinschreibung unterschieden wird oder nicht.

  `priority` ist notwendig, wenn eine andere Hervorhebungsdefinitionsdatei die gleichen Dateinamenerweiterung benutzt. Die Definitionsdatei mit der höheren Priorität wird dann benutzt.

  `author` enthält den Namen des Autors und dessen E-Mail-Adresse.

  `license` enthält die Lizenz der Datei, normalerweise wird hier die MIT-Lizenz für neue Dateien benutzt.

  `style` enthält die Programmiersprache, die mit der Definition zur Verfügung gestellt wird und wird durch das Einrückungsskript für die Eigenschaft `required-syntax-style` benutzt.

  `indenter` definiert die als Standard verwendetet Einrückung. Verfügbare Einrückungen sind: ada, normal, cstyle, cmake, haskell, latex, lilypond, lisp, lua, pascal, python, replicode, ruby und xml.

  `hidden` definiert, ob der Name in Menüs von &kappname; erscheinen soll.

  Die nächste Zeile könnte wie folgt aussehen:

      <language name="C++" version="1" kateversion="2.4" section="Sources" extensions="*.cpp;*.h" />

Als nächstes kommt das Element `highlighting`, das das optionale Element `list` und die notwendigen Elemente `contexts` und `itemDatas` enthält.

  `list`-Elemente enthalten eine Liste von Schlüsselwörtern. In diesem Fall sind die Schlüsselwörter class und const. Sie können so viele hinzufügen, wie Sie brauchen.

  Seit &kde-frameworks; 5.53 kann eine Liste Schlüsselwörter aus anderen Listen oder Sprachen bzw. Dateien enthalten. Dazu benutzen Sie das Element `include`. `##` wird auf die gleiche Art wie die Regel `IncludeRules` verwendet, um den Namen der Liste und der Sprachdefinition zu trennen. Dies ist nützlich, um doppelte Listen von Schlüsselwörtern zu vermeiden, wenn Sie Schlüsselwörter aus anderen Sprachen oder Dateien einschließen müssen. Die Liste othername zum Beispiel enthält das Schlüsselwort str und alle Schlüsselwörter der Liste types aus der Sprache ISO C++.

  Das Element `contexts` enthält alle Kontexte. Der erste Kontext ist Standard bei Start der Hervorhebungen. Es gibt zwei Regeln im Kontext Normal Text, die auf die Liste mit Schlüsselwörtern mit dem Namen somename und eine Regel, die Anführungszeichen entdeckt und zum Kontext string umschaltet. Weitere Informationen zu Regeln finden Sie im nächsten Kapitel.

  Der dritte Teil ist das Element `itemDatas`. Es enthält alle Farb- und Schriftartstile, die durch die Kontexte und Regeln benötigt werden. In diesem Beispiel werden `itemData`, Normal Text, String und Keyword benutzt.

      <highlighting>
          <list name="somename">
            <item>class</item>
            <item>const</item>
          </list>
          <list name="othername">
            <item>str</item>
            <include>types##ISO C++</include>
          </list>
          <contexts>
            <context attribute="Normal Text" lineEndContext="#pop" name="Normal Text" >
              <keyword attribute="Keyword" context="#stay" String="somename" />
              <keyword attribute="Keyword" context="#stay" String="othername" />
              <DetectChar attribute="String" context="string" char="&quot;" />
            </context>
            <context attribute="String" lineEndContext="#stay" name="string" >
              <DetectChar attribute="String" context="#pop" char="&quot;" />
            </context>
          </contexts>
          <itemDatas>
            <itemData name="Normal Text" defStyleNum="dsNormal" />
            <itemData name="Keyword" defStyleNum="dsKeyword" />
            <itemData name="String" defStyleNum="dsString" />
          </itemDatas>
        </highlighting>

Der letzte Teil der Hervorhebungsdefinition ist der optionale Abschnitt `general`. Dieser kann Informationen über Schlüsselwörter, Quelltextausblendungen, Leerzeilen und Rechtschreibprüfung enthalten.

  Der Abschnitt `comment` definiert, mit welcher Zeichenfolge eine einzelne Kommentarzeile beginnt. Sie können außerdem mehrzeilige Kommentare definieren, indem Sie multiLine mit der zusätzlichen Eigenschaft end benutzen. Diese werden benutzt, wenn Sie das Tastaturkürzel für Kommentar / Kommentar entfernen drücken.

  Der Abschnitt `keywords` definiert, ob in den Schlüsselwortlisten nach Groß- und Kleinschreibung unterschieden wird oder nicht. Andere Eigenschaften werden später erläutert.

  Die anderen Abschnitte `Quelltextausblendung`, `Leerzeilen` und `Rechtschreibprüfung` sind normalerweise nicht nötig und werden später erklärt.

      <general>
          <comments>
            <comment name="singleLine" start="#"/>
            <comment name="multiLine" start="###" end="###" region="CommentFolding"/>
          </comments>
          <keywords casesensitive="1"/>
          <folding indentationsensitive="0"/>
          <emptyLines>
            <emptyLine regexpr="\s+"/>
            <emptyLine regexpr="\s*#.*"/>
          </emptyLines>
          <spellchecking>
            <encoding char="á" string="\'a"/>
            <encoding char="à" string="\`a"/>
          </spellchecking>
        </general>
      </language>

#### Die Abschnitte im Einzelnen

Dieser Teil beschreibt alle verfügbaren Eigenschaften für Kontexte, itemDatas, Schlüsselwörter, Kommentare, Quelltextausblendungen und Einrückungen.

Das Element `context` gehört in die Gruppe `contexts`. Ein Kontext selbst definiert spezielle Regeln, wie zum Beispiel, was geschehen soll, wenn das Hervorhebungssystem ein Zeilenende erreicht. Die verfügbaren Eigenschaften sind:

  Der Kontextname `name`. Regeln benutzen diesen Namen, um festzulegen, zu welchem Kontext umgeschaltet wird, wenn die Regel zutrifft.

  Der Kontext `lineEndContext` definiert den Kontext, zu dem das Hervorhebungssystem umschaltet, wenn es ein Zeilenende erreicht. Das kann entweder der Name eines anderen Kontextes sein, `#stay` um den Kontext nicht umzuschalten, (&eg; tue nichts) oder `#pop` das bewirkt, dass der Kontext verlassen wird. Es ist möglich, zum Beispiel `#pop#pop#pop` zu verwenden, um drei Kontextebenen zu verlassen oder mit `#pop#pop!OtherContext` zwei Kontextebenen zu verlassen und in einen neuen Kontext zu springen. Es ist auch möglich zu einem Kontext zu wechseln, der zu einer anderen Sprachdefinition gehört, genauso wie in den `IncludeRules`-Regeln, &eg; `SomeContext##JavaScript`. Beachten Sie, dass es nicht möglich ist, diesen Kontextwechsel in Kombination mit `#pop` zu verwenden, zum Beispiel ist `#pop!SomeContext##JavaScript` nicht gültig. Kontextwechsel werden auch in beschrieben.

  `lineEmptyContext` definiert den Kontext, der in einer leeren Zeile verwendet wird. Die Bezeichnung der Kontextwechsel ist die gleiche wie zuvor in lineEndContext beschrieben. Standard hierfür ist: #stay.

  `fallthroughContext` legt den nächsten Kontext fest, zu dem gewechselt wird, wenn keine Regel passt. Die Bezeichnung der Kontextwechsel ist die gleiche wie zuvor in lineEndContext beschrieben. Voreinstellung: #stay.

  `fallthrough` definiert, ob das Hervorhebungssystem zu dem in `fallthroughContext` angegebenen Kontext wechselt, wenn keine Regel passt. Beachten Sie, dass seit &kde; &frameworks; 5.62 dieses Attribut zugunsten von `fallthroughContext` veraltet ist. Denn wenn das Attribut `fallthroughContext` vorhanden ist, wird stillschweigend angenommen, dass der Wert von `fallthrough` true ist. Voreinstellung: false.

  `noIndentationBasedFolding` deaktiviert das auf der Einrückung basierte Ausblenden von Text im Kontext. Wenn das Ausblenden nicht aktiviert ist, ist dieses Attribut nutzlos. Es wird im Element folding der Gruppe general definiert. Voreinstellung: false.

Das Element `itemData` ist in der Gruppe `itemDatas`. Es definiert die Schriftarten und Schriftfarben. So ist es möglich, Ihre eigenen Schriftarten und -farben festzulegen. Wir empfehlen jedoch, bei den vordefinierten Einstellungen zu bleiben, sodass in unterschiedlichen Sprachen trotzdem die gleichen Farben angezeigt werden. Manchmal ist es doch nötig, die Farben und Schriftarten zu ändern. Der Name der Eigenschaft und defStyleNum müssen angeben werden, alle anderen können verwendet werden, sind aber nicht unbedingt nötig. Die verfügbaren Eigenschaften sind:

  `name` setzt den Namen von itemData. Kontexte und Regel benutzen diesen Namen in ihrer Eigenschaft attribute, um den Bezug zum itemData herzustellen.

  `defStyleNum` definiert, welcher Stil standardmäßig benutzt wird. Die verfügbaren Stile werden später näher erläutert.

  `color` definiert eine Farbe. Erlaubte Formate hierfür sind: ‚#rrggbb‘ oder ‚#rgb‘.

  `selColor` definiert die Farbe für die Hervorhebung.

  `italic` Wenn true, dann wird der Text in Kursivschrift dargestellt.

  `bold` Wenn true, dann wird der Text in Fettschrift dargestellt.

  `underline` Wenn true, dann wird der Text unterstrichen dargestellt.

  `strikeout` Wenn true, dann wird der Text durchgestrichen dargestellt.

  `spellChecking` Wenn true, dann wird die Rechtschreibprüfung für den Text aktiviert.

Das Element `keywords` in der Gruppe `general` definiert Eigenschaften von Schlüsselwörtern. Verfügbare Eigenschaften sind:

  `casesensitive` kann true oder false sein. Wenn es true ist, dann wird bei allen Schlüsselwörtern die Groß- und Kleinschreibung beachtet.

  `weakDeliminator` ist eine Liste von Zeichen, die nicht als Wortbegrenzung wirken. Der Punkt `'.'` ist zum Beispiel eine Wortbegrenzung. Nehmen Sie an, ein Schlüsselwort in einer `list` enthält einen Punkt, diese Schlüsselwort kann nur dann erkannt werden, wenn Sie den Punkt als `weakDeliminator` festlegen.

  `additionalDeliminator` definiert zusätzliche Wortbegrenzungen.

  `wordWrapDeliminator` definiert Zeichen, nach denen ein Zeilenumbruch erfolgen kann.

  Standard für Wortbegrenzer und Zeilenumbruchbegrenzer sind die Zeichen `.():!+,-<=>%&*/;?[]^{|}~\`, Leerzeichen (`' '`) und der Tabulator (`'\t'`).

Das Element `comment` in der Gruppe `comments` definiert Eigenschaften für Kommentare, die für Extras Kommentar , Extras Kommentar entfernen und Tools Kommentar ein-/ausschalten benutzt werden. Verfügbare Eigenschaften hierfür sind:

  `name` ist entweder singleLine oder multiLine. Wenn Sie multiLine auswählen, müssen auch die Eigenschaften end und region benutzt werden. Bei singleLine können Sie das optionale Attribut position hinzufügen.

  `start` definiert die Zeichenfolge, die einen Kommentar beginnt. In C++ ist dies zum Beispiel "/*" in mehrzeiligen Kommentaren. Dieses Attribut ist für multiLine und singleLine nötig.

  `end` definiert die Zeichenfolge, die einen Kommentar beendet. In C++ ist dies zum Beispiel "*/". Diese Attribut ist nur für den Typ multiLine verfügbar und erforderlich.

  `region` sollte der Name von ausblendbaren Mehrzeilenkommentaren sein. Nehmen Sie an, Sie haben beginRegion=Comment ... endRegion=Comment in Ihren Regeln, dann sollten Sie region=Comment benutzen. Auf diesem Wege funktioniert das automatische Entfernen von Kommentaren auch dann, wenn Sie nicht den gesamten Text des mehrzeiligen Kommentars auswählen. Es muss nur der Cursor innerhalb des mehrzeiligen Kommentars stehen. diese Attribut ist nur für den Typ multiLine verfügbar.

  `position` definiert, wo der einzeilige Kommentar eingefügt wird. Standardmäßig wird der einzeilige Kommentar am Anfang der der Zeile bei Spalte 0 platziert, aber wenn Sie position="afterwhitespace" verwenden, wird der Kommentar nach führenden Leerraumzeichen rechts eingefügt, vor dem ersten Nicht-Leerraumzeichen. Dies ist nützlich für das korrekte Einfügen von Kommentaren in Sprachen, in denen die Einrückung wichtig ist, wie z. B. in Python oder YAML. Dieses Attribut ist optional und der einzig mögliche Wert ist afterwhitespace. Dies ist nur verfügbar für den Typ singleLine.

Das Element `folding` in der Gruppe `general` definiert Eigenschaften für ausblendbaren Quelltext. Verfügbare Eigenschaften sind:

  `indentationsensitive` Wenn true, werden die Markierungen für Quelltextausblendungen basiert auf Einrückungen gesetzt, wie zum Beispiel in der Skriptsprache Python. Normalerweise brauchen Sie dies nicht zu setzen, Standard ist false.

Das Element `emptyLine` in der Gruppe `emptyLines` definiert, welche Zeilen als Leerzeilen behandelt werden sollen. Damit lässt sich das Verhalten des Attributs lineEmptyContext in den Elementen `Kontext` ändern. Verfügbare Attribute sind:

  `regexpr` definiert einen regulären Ausdruck, der als eine leere Zeile behandelt wird. Standardmäßig enthalten leere Zeilen keine Zeichen, daher werden hier zusätzliche Leerzeilen hinzugefügt, z. B. wenn Zeilen mit Leerzeichen als Leerzeilen betrachtet werden sollen. In den meisten Syntaxdefinitionen brauchen Sie dieses Attribut jedoch nicht zu setzen.

Das Element `encoding` in der Gruppe `spellchecking` definiert eine Zeichenkodierung für die Rechtschreibprüfung. Verfügbare Eigenschaften sind:

  `char` ist ein kodiertes Zeichen.

  `string` ist eine Folge von Zeichen, die in der Rechtschreibprüfung als das Zeichen char kodiert wird. In der Sprache LaTeX repräsentiert beispielsweise die Zeichenfolge `\"{A}` das Zeichen `Ä`.

#### Verfügbare Standardstile

Standardstile wurden als kurze Zusammenfassung bereits erklärt. Standardstile sind vordefinierte Schriftarten und -farben.

Allgemeine Standardstile:

  `dsNormal`, wenn keine spezielle Hervorhebung benötigt wird

  `dsKeyword`, benutzt für eingebaute Sprach-Schlüsselwörter.

  `dsFunction`, benutzt für Funktionsaufrufe und -definitionen.

  `dsVariable`, falls zutreffend Variablennamen &eg; $someVar in PHP/Perl.

  `dsControlFlow`, Kontrollfluss-Schlüsselwörter wie if, else, switch, break, return, yield, ...

  `dsOperator`, Operatoren wie + - * / :: < >

  `dsBuiltIn`, eingebaute Funktionen, Klassen und Objekte.

  `dsExtension`, allgemeine Erweiterungen wie zum Beispiel &Qt;-Klassen und Funktionen/Makros in C++ und Python.

  `dsPreprocessor`, Präprozessor-Anweisungen oder Makro-Definitionen.

  `dsAttribute`, Anmerkungen wie @override und __declspec(...).

Standardstile für Zeichenfolgen:

  `dsChar`, benutzt für einzelne Buchstaben wie „X“.

  `dsSpecialChar`, Zeichen mit besonderer Bedeutung in Zeichenfolgen wie Escape-Sequenzen, Ersetzungen oder Operatoren für reguläre Ausdrücke.

  `dsString`, benutzt für Zeichenfolgen wie „Hallo Welt“.

  `dsVerbatimString`, wörtliche oder unveränderte Zeichenfolgen wie „raw \backlash“ in Perl, CoffeeScript und Shells wie auch r'\raw' in Python.

  `dsSpecialString`, SQL, Reguläre Ausdrücke, HERE-Dokumente, &latex;-Mathematikmodus, ...

  `dsImport`, import, include, erforderliche Module.

Standardstile für Zahlen:

  `dsDataType`, benutzt für eingebaute Datentypen wie int, void, u64.

  `dsDecVal`, benutzt für Dezimalwerte.

  `dsBaseN`, benutzt für Werte mit einer anderen Zahlenbasis als 10.

  `dsFloat`, benutzt für Gleitkommawerte.

  `dsConstant`, eingebaute und benutzerdefinierte Konsonanten wie Pi.PI.

Standardstile für Kommentare und Dokumentation:

  `dsComment`, benutzt für Kommentare.

  `dsDocumentation`, /** Dokumentation-Kommentare */ oder """docstrings""".

  `dsAnnotation`, Dokumentations--Befehle wie @param, @brief.

  `dsCommentVar`, die in den vorher genannten Befehlen verwendeten Variablennamen wie „foobar“ in @param foobar.

  `dsRegionMarker`, benutzt für Markierungen von Bereichen wie //BEGIN, //END in Kommentaren.

Andere Standardstile:

  `dsInformation`, Notizen und Hinweise wie @note in doxygen.

  `dsWarning`, Warnungen wie @warning in doxygen.

  `dsAlert`, besondere Wörter wie TODO, FIXME, XXXX.

  `dsError`, benutzt für Hervorhebungen von Fehlern und für fehlerhafter Syntax.

  `dsOthers`, wenn nichts anderes passt.

### Hervorhebungs-Erkennungsregeln

Dieser Abschnitt beschreibt die Hervorhebungs-Erkennungsregeln

Jede Regel kann auf Null oder mehrere Zeichen am Anfang der untersuchten Zeichenfolge zutreffen. Wenn eine Übereinstimmung gefunden wird, wird den erkannten Zeichen der Stil oder die Eigenschaft, die durch die Regel festgelegt wurde, zugeordnet, Außerdem kann die Regel ein Umschalten des aktuellen Kontexts anfordern.

Eine Regel sieht wie folgt aus:

    <RuleName attribute="(identifier)" context="(identifier)" [rule specific attributes] />

Die attribute (Eigenschaft) legt den Namen des Stils fest, der für die erkannten Zeichen benutzt werden soll und der context (Kontext) legt den Kontext fest, der ab hier benutzt werden soll.

Der context (Kontext) kann durch Folgendes identifiziert werden:

- Einen identifier, der der Name eines anderen Kontextes ist.

- Eine Anweisung, die vorgibt, im aktuellen Kontext zu bleiben (`#stay`), oder zu einem vorher in der Zeichenfolge benutzten Kontext zurückzuspringen (`#pop`).

  Zum Zurückgehen über mehrere Schritte kann das Schlüsselwort #pop wiederholt werden: `#pop#pop#pop`

- Eine Anweisung order, die von einem Ausrufezeichen (!) und einem identifier gefolgt wird, veranlasst &kate; erst die Anweisung order auszuführen und dann in den anderen Kontext umzuschalten, &eg; `#pop#pop!OtherContext`.

- Ein identifier ist ein Kontextname gefolgt von zwei Doppelkreuzen (`##`) und einem weiteren identifier für den Name einer Sprachdefinition. Diese Namensgebung ist ähnlich wie bei den Regeln `IncludeRules` und ermöglicht den Wechsel zu einem Kontext, der zu einer anderen Syntaxhervorhebungsdefinition gehört, z. B. `SomeContext##JavaScript`. Beachten Sie, dass es nicht möglich ist, diesen Kontextwechsel in Kombination mit `#pop` zu verwenden, z. B. `#pop!SomeContext##JavaScript` ist nicht gültig.

Regelspezifische Eigenschaften sind unterschiedlich und werden im Folgenden beschrieben.

#### Gemeinsame Eigenschaften

Alle Regeln haben die folgenden Eigenschaften gemeinsam und sind immer verfügbar, wenn `(common attributes)` erscheint. attribute und context sind notwendige Eigenschaften, alle anderen sind optional, müssen also nicht benutzt werden.

- attribute: Eine Eigenschaft zeigt auf ein bestimmtes itemData-Element.

- context: Legt den Kontext fest, zu dem das Hervorhebungssystem umschaltet, wenn die Regel als zutreffend erkannt wird.

- beginRegion: Beginnt einen Quelltextausblendungsblock. Standard ist: unset.

- endRegion: Beendet eine Quelltextausblendungsblock. Standard ist: unset.

- lookAhead: Wenn true, dann wird das Hervorhebungssystem die Länge der Übereinstimmung nicht verarbeiten. Standard ist: false.

- firstNonSpace: Trifft nur dann zu, wenn die Zeichenfolge als erstes nach Zwischenräumen in der Zeile erkannt wird. Standard ist: false.

- column: Trifft nur dann zu, wenn die Spalte zutrifft. Standard ist: unset.

#### Dynamische Regeln

Einige Regeln erlauben die Benutzung der optionalen Eigenschaft `dynamic`, Standard ist hier false.Wenn diese Eigenschaft auf true gesetzt wird, kann eine Regel in ihren Eigenschaften `string` oder `char` Platzhalter verwenden, die den zutreffenden Text aus einer als regulärem Ausdruck formulierten Regel enthält. Diese Regel muss direkt in den gegenwärtigen Kontext umgeschaltet haben. In einem `string` wird der Platzhalter %N (wobei N eine Zahl sein muss) ersetzt durch das Ergebnis für N aus dem aufrufenden regulären Ausdruck, startend mit 1. In einem `char` muss der Platzhalter auch eine Zahl N sein und wird durch das erste Zeichen aus dem Ergebnis für N aus dem aufrufenden regulären Ausdruck ersetzt. Immer wenn eine Regel diese Eigenschaft erlaubt, dann enthält diese ein (dynamic).

- dynamic: kann (true oder false) sein.

`Wie es funktioniert:`

In den regulären Ausdrücken der der `RegExpr`-Regeln wird der gesamte Text innerhalb einfacher runder Klammern `(PATTERN)` erfasst und behalten. Diese Erfassungen können in dem Kontext verwendet werden, in den gewechselt wird, in den Regeln mit dem Attribut `dynamic` true, durch %N (in String) oder N (in char).

Ein Text, der in einer `RegExpr`-Regel erfasst wird, nur für den gewechselten Kontext behalten wird, der in seinem Attribut `Kontext` angegeben ist.

- Wenn die Erfassung nicht verwendet werden sollen, sowohl durch dynamische Regeln als auch im gleichen regulären Ausdruck, sollte `nicht-erfassende Gruppen` verwendet werden verwendet werden: `(?:PATTERN)`

  Die Gruppen Vorwärtsreferenz oder Rückwärtsreferenz wie `(?=PATTERN)`, `(?!PATTERN)` oder `(?<=PATTERN)` werden nicht erfasst. Weitere Informationen fingen Sie im Abschnitt Reguläre Ausdrücke.

- Die Erfassungs-Gruppen können innerhalb desselben regulären Ausdrucks verwendet werden, indem \N anstelle von %N verwendet wird. Für weitere Informationen siehe Erfassen von passendem Text (Rückwärtsreferenz) in AbschnittReguläre Ausdrücke.

Beispiel 1:

In diesem einfachen Beispiel wird der Text, der mit dem regulären Ausdruck `=*` übereinstimmt, erfasst und für %1 in die dynamische Regel eingefügt. Dadurch kann der Kommentar mit der gleiche Zahl von Gleichheitszeichen `=` wie am Anfang beendet werden. Dies passt auf Text wie: `[[ Kommentar ]]`, `[=[ Kommentar ]=]` oder `[=====[ Kommentar ]=====]`.

Außerdem sind die Erfassungen nur im gewechselten Kontext mehrzeiligen Kommentaren verfügbar.

    <context name="Normal" attribute="Normal Text" lineEndContext="#stay">
      <RegExpr context="Multi-line Comment" attribute="Comment" String="\[(=*)\[" beginRegion="RegionComment"/>
    </context>
    <context name="Multi-line Comment" attribute="Comment" lineEndContext="#stay">
      <StringDetect context="#pop" attribute="Comment" String="]%1]" dynamic="true" endRegion="RegionComment"/>
    </context>

Beispiel 2:

In der dynamischen Regel entspricht %1 der Erfassung, die auf `#+` passt und %2 auf `&quot;+`. Dies trifft auf Text wie `#label""""inside the context""""#` zu.

Diese Erfassungen sind in anderen Kontexten wie z. B. OtherContext, FindEscapes oder SomeContext nicht verfügbar.

    <context name="SomeContext" attribute="Normal Text" lineEndContext="#stay">
      <RegExpr context="#pop!NamedString" attribute="String" String="(#+)(?:[\w-]|[^[:ascii:]])(&quot;+)"/>
    </context>
    <context name="NamedString" attribute="String" lineEndContext="#stay">
      <RegExpr context="#pop!OtherContext" attribute="String" String="%2(?:%1)?" dynamic="true"/>
      <DetectChar context="FindEscapes" attribute="Escape" char="\"/>
    </context>

Beispiel 3:

Die passt auf Text wie: `Class::function<T>( ... )`.

    <context name="Normal" attribute="Normal Text" lineEndContext="#stay">
      <RegExpr context="FunctionName" lookAhead="true"
                  String="\b([a-zA-Z_][\w-]*)(::)([a-zA-Z_][\w-]*)(?:&lt;[\w\-\s]*&gt;)?(\()"/>
    </context>
    <context name="FunctionName" attribute="Normal Text" lineEndContext="#pop">
      <StringDetect context="#stay" attribute="Class" String="%1" dynamic="true"/>
      <StringDetect context="#stay" attribute="Operator" String="%2" dynamic="true"/>
      <StringDetect context="#stay" attribute="Function" String="%3" dynamic="true"/>
      <DetectChar context="#pop" attribute="Normal Text" char="4" dynamic="true"/>
    </context>

#### Lokale Begrenzungszeichen

Einige Regeln erlauben die optionalen Attribute `weakDeliminator` und `additionalDeliminator`, die mit gleichnamigen Attributen des `Schlüsselworts` kombiniert werden. Wenn zum Beispiel `'%'` ein schwacher Wortbegrenzer des `Schlüsselworts` ist, kann es in einer Regel nur zum Wortbegrenzer werden, indem man es dem Attribut `additionalDeliminator` hinzufügt. Wann immer eine Regel diese Attribute zulässt, enthält sie lokale Begrenzungszeichen.

- weakDeliminator: Liste der Zeichen, die nicht als Wortbegrenzungen fungieren.

- additionalDeliminator definiert zusätzliche Wortbegrenzungen.

#### Die Regeln im Einzelnen:

DetectChar

  Findet ein einzelnes bestimmtes Zeichen. Häufig zum Finden des Endes von Zeichenfolgen in Anführungszeichen benutzt.

      <DetectChar char="(character)" (common attributes) (dynamic) />

  Die Eigenschaft `char` definiert das zu erkennende Zeichen.

Detect2Chars

  Findet zwei bestimmte Zeichen in einer bestimmten Reihenfolge.

      <Detect2Chars char="(character)" char1="(character)" (common attributes) />

  Die Eigenschaft `char` definiert das erste zu erkennende Zeichen, `char1` das zweite.

AnyChar

  Findet ein Zeichen aus einem bestimmten Satz von Zeichen.

      <AnyChar String="(string)" (common attributes) />

  Die Eigenschaft `String` definiert den Satz der Zeichen.

StringDetect

  Findet eine bestimmte Zeichenfolge.

      <StringDetect String="(string)" [insensitive="true|false"] (common attributes) (dynamic) />

  Die Eigenschaft `String` definiert die zu erkennende Zeichenfolge. Die Eigenschaft `insensitive` ist standardmäßig auf false gesetzt und wird an die Zeichenfolgen-Vergleichsfunktion übergeben. Wenn der Wert auf true gesetzt wird, wird Groß- und Kleinschreibung ignoriert.

WordDetect

  Findet eine Zeichenfolge, aber zusätzlich werden die Wortgrenzen wie ein Punkt `'.'` oder ein Leerzeichen am Anfang und Ende des Wortes beachtet. Dies funktioniert wie der reguläre Ausdruck `\b<string>\b`, ist aber schneller als die Regel `RegExpr`.

      <WordDetect String="(string)" [insensitive="true|false"] (common attributes) (local deliminators) />

  Die Eigenschaft `String` definiert die zu erkennende Zeichenfolge. Die Eigenschaft `insensitive` ist standardmäßig auf false gesetzt und wird an die Zeichenfolgen-Vergleichsfunktion übergeben. Wenn der Wert auf true gesetzt wird, wird Groß- und Kleinschreibung ignoriert.

  Ab Version: &kate; 3.5 (&kde; 4.5)

RegExpr

  Prüft die Übereinstimmung mit einem regulären Ausdruck.

      <RegExpr String="(string)" [insensitive="true|false"] [minimal="true|false"] (common attributes) (dynamic) />

  Die Eigenschaft `String` definiert den regulären Ausdruck.

  Die Eigenschaft `insensitive` ist standardmäßig auf false gesetzt und wird an die Funktion zur Auswertung des regulären Ausdrucks übergeben.

  Die Eigenschaft `minimal` ist standardmäßig auf false gesetzt und wird an die Funktion zur Auswertung des regulären Ausdrucks übergeben.

  Weil die Regeleinhaltung immer am Anfang der aktuellen Zeichenfolge geprüft wird, kann mit dem Hochzeichen (`^`) angegeben werden, dass die Regeleinhaltung nur am Anfang der Zeile untersucht werden soll.

  Sehen Sie unter Reguläre Ausdrücke für weitere Informationen zu diesen nach.

keyword

  Erkennt ein Schlüsselwort aus einer angegebenen Liste.

      <keyword String="(list name)" (common attributes) (local deliminators) />

  Die Eigenschaft `String` definiert die Schlüsselwortliste durch deren Name. Eine Liste mit diesem Namen muss vorhanden sein.

  Das Hervorhebungssystem verarbeitet die Regeln mit sehr stark optimierten Methoden. Deswegen ist es absolut notwendig, dass alle Schlüsselworte, die gefunden werden sollen, durch definierte Begrenzer eingeschlossen werden. Das können entweder die Standardbegrenzer sein oder Begrenzer, die mit der Eigenschaft additionalDeliminator des Tags keywords festgelegt wurden.

  Wenn ein Schlüsselwort ein Begrenzerzeichen enthalten soll, dann muss dieses Zeichen zur Eigenschaft weakDeliminator des Tags keywords hinzugefügt werden. Dieses Zeichen verliert damit seine Funktion als Begrenzer in allen keyword-Regeln. Es ist auch möglich, das weakDeliminator Attribut vom keyword zu verwenden, so dass diese Änderung nur für diese Regel gilt.

Int

  Erkennt eine ganze Zahl wie im regulären Ausdruck `\b[0-9]+`).

      <Int (common attributes) (local deliminators) />

  Diese Regel hat keine speziellen Eigenschaften.

Float

  Erkennt eine Dezimalzahl wie im regulären Ausdruck `\b[0-9]+)\.[0-9]*|\.][-+]?[0-9]+)?`).

      <Float (common attributes) (local deliminators) />

  Diese Regel hat keine speziellen Eigenschaften.

HlCOct

  Erkennt eine Oktalzahl wie im regulären Ausdruck `\b0[0-7]+`.

      <HlCOct (common attributes) (local deliminators) />

  Diese Regel hat keine speziellen Eigenschaften.

HlCHex

  Erkennt eine hexadezimale Zahl wie im regulären Ausdruck `\b0[xX][0-9a-fA-F]+`.

      <HlCHex (common attributes) (local deliminators) />

  Diese Regel hat keine speziellen Eigenschaften.

HlCStringChar

  Findet ein Steuerzeichen.

      <HlCStringChar (common attributes) />

  Diese Regel hat keine speziellen Eigenschaften.

  Solche Zeichen sind durch druckbare Zeichen dargestellte nicht druckbare Zeichen, die in Programmquelltexten häufig benutzt werden. &eg;: `\n` (Zeilenvorschub) oder `\t` (TAB)

  Die folgenden Zeichen werden erkannt, wenn sie einem Linksschrägstrich `\` folgen: `abefnrtv"'?`. Zusätzlich werden auch hexadezimale (`\xff`) oder oktale (`\033`) Zahlen nach einem `\` erkannt.

HlCChar

  Findet ein C Zeichen.

      <HlCChar (common attributes) />

  Diese Regel hat keine speziellen Eigenschaften.

  Trifft zu, wenn C Zeichen in einfachen Anführungszeichen (Beispiel: `'c'`) vorkommen. In den Anführungszeichen kann ein einfaches Zeichen oder Sonderzeichen (Beispiel: `' '`) stehen. Für Zeichenfolgen von Sonderzeichen sehen Sie unter HlCStringChar nach.

RangeDetect

  Findet eine Zeichenfolge mit definierten Anfangs- und Endzeichen.

      <RangeDetect char="(character)"  char1="(character)" (common attributes) />

  `char` definiert das Zeichen am Anfang des Bereichs, `char1` das Zeichen am Ende des Bereichs.

  Diese Regel ist für das Finden von kleinen Zeichenfolgen in Anführungszeichen nützlich, kann aber wegen der verwendeten Funktion keine über mehrere Zeilen gehenden Zeichenfolgen finden.

LineContinue

  Trifft auf ein angegebenes Zeichen an einem Zeilenende zu.

      <LineContinue (common attributes) [char="\"] />

  Die Eigenschaft `char` definiert das optionale zu erkennende Zeichen, Standard ist der Rückstrich `'\'`. Neu seit &kde; 4.13.

  Diese Regel wird zum Umschalten des Kontextes am Ende einer Zeile benutzt. Dies wird in C/C++ zum Fortsetzen von Makros oder Zeichenfolgen gebraucht.

IncludeRules

  Schließt Regeln aus einem anderen Kontext, einer anderen Sprache oder einer anderen Datei ein.

      <IncludeRules context="contextlink" [includeAttrib="true|false"] />

  Die Eigenschaft `context` definiert, welcher Kontext eingeschlossen werden soll.

  Wenn dies eine einfache Zeichenfolge ist, dann werden alle definierten Regeln in den gegenwärtigen Kontext eingeschlossen. Beispiel:

      <IncludeRules context="anotherContext" />

  Wenn die Zeichenfolge eine `##`-Nutzereingabe enthät, dann wird das Hervorhebungssystem einen Kontext aus einer anderen Sprachdefinition mit dem angegebenen Namen suchen, zum Beispiel:

      <IncludeRules context="String##C++" />

  schliesst den Kontext String aus der Sprachdefinition für C++ ein.

  Wenn die Eigenschaft `includeAttrib` true ist, dann wird die Zieleigenschaft zu der aus der Quelle geändert. Dies wird zum Beispiel für Kommentare gebraucht, wenn der Text, der durch den eingeschlossenen Kontext anders hervorgehoben wird, als im gegenwärtigen Kontext.

DetectSpaces

  Finde Zwischenräume.

      <DetectSpaces (common attributes) />

  Diese Regel hat keine speziellen Eigenschaften.

  Benutzen Sie diese Regel, wenn Sie wissen, dass jetzt mehrere Zwischenräume folgen, zum Beispiel am Anfang von eingerückten Zeilen. Diese Regel überspringt mehrere Zwischenräume mit einem Mal, ohne diese einzeln auf die Einhaltung von anderen Regeln zu testen und dann nach Nichtzutreffen einzeln zu überspringen.

DetectIdentifier

  Finde Zeichenfolgen als Bezeichner (als regulärer Ausdruck: `[a-zA-Z_][a-zA-Z0-9_]*`).

      <DetectIdentifier (common attributes) />

  Diese Regel hat keine speziellen Eigenschaften.

  Benutzen Sie diese Regel zum Überspringen von Wörtern mit einem Mal, ohne die Zeichen im Wort einzeln auf die Einhaltung von anderen Regeln zu testen und dann nach Nichtzutreffen zu überspringen.

#### Tipps & Tricks

Wenn Sie einmal verstanden haben, wie das Umschalten zwischen Kontexten funktioniert, dann ist es einfach Hervorhebungsdefinitionen zu schreiben. Sie sollten jedoch sorgfältig entscheiden, welche Regel in welcher Situation Sie verwenden. Reguläre Ausdrücke sind sehr leistungsfähig, aber verglichen mit einfachen Regeln langsam. Sie sollten daher die folgenden Tipps beachten.

- Wenn Sie nur zwei Zeichen vergleichen, dann benutzen Sie `Detect2Chars` an Stelle von `StringDetect`. Das Gleiche gilt für `DetectChar`.

- Reguläre Ausdrücke sind einfach zu benutzen, aber oft gibt es einen anderen viel schnelleren Weg, um das gleiche Ergebnis zu erreichen. Nehmen Sie an, Sie wollen feststellen, ob das Zeichen `'#'` das erste Zeichen einer Zeile ist. Ein regulärer Ausdruck dafür wäre:

      <RegExpr attribute="Macro" context="macro" String="^\s*#" />

  Sie können aber auch die wesentlich schnellere Lösung:

      <DetectChar attribute="Macro" context="macro" char="#" firstNonSpace="true" />

  benutzen. An Stelle des regulären Ausdrucks `'^#'` können Sie `DetectChar` mit der Eigenschaft `column="0"` benutzen. Die Eigenschaft `column` zählt Zeichenbasiert, sodass auch ein Tabulator nur ein Zeichen ist.

- Verwenden Sie in `RegExpr`-Regeln das Attribut `column="0"`, wenn mit dem Muster `^PATTERN` Text am Anfang einer Zeile gefunden werden soll. Dies ist schneller, da nicht mehr in den restlichen Spalten der Zeile nach Übereinstimmungen gesucht wird.

- Verwenden Sie in regulären Ausdrücken nicht-erfassende Gruppen `(?:PATTERN)` anstelle von erfassenden Gruppen `(PATTERN)`, wenn die Erfassungen nicht in demselben regulären Ausdruck oder in dynamischen Regeln verwendet werden. Dadurch wird das unnötige Speichern von Erfassungen vermieden.

- Sie können zwischen Kontexten umschalten, ohne Zeichen zu verarbeiten. Angenommen, Sie wollen den Kontext umschalten, wenn Sie die Zeichenfolge `*/` finden, aber Sie müssen diese Zeichenfolge im nächsten Kontext verarbeiten. Die folgende Regel trifft zu und die Eigenschaft `lookAhead` sorgt dafür, dass die zutreffende Zeichenfolge für den folgenden Kontext bereitgehalten wird.

      <Detect2Chars attribute="Comment" context="#pop" char="*" char1="/" lookAhead="true" />

- Benutzen Sie `DetectSpaces`, wenn Sie wissen, dass mehrere Zwischenräume vorkommen.

- Benutzen Sie `DetectIdentifier` an Stelle des regulären Ausdrucks `'[a-zA-Z_]\w*'`.

- Benutzen Sie Standardstile wann immer das möglich ist. Die Benutzer finden dadurch eine vertraute Umgebung vor.

- Sehen Sie in anderen &XML;-Dateien nach, wie andere Benutzer komplizierte Regeln geschrieben haben.

- Sie können die Gültigkeit jeder &XML;-Datei mit dem Befehl `validatehl.sh language.xsd mySyntax.xml` überprüfen. Die Dateien `validatehl.sh` und `language.xsd` finden Sie im Syntax-Highlighting-Repository.

- Wenn Sie komplexe reguläre Ausdrücke oft wiederholen, können Sie ENTITIES benutzen. Beispiel:

      <?xml version="1.0" encoding="UTF-8"?>
      <!DOCTYPE language SYSTEM "language.dtd"
      [
              <!ENTITY myref    "[A-Za-z_:][\w.:_-]*">
      ]>

  Nun können Sie &myref; an Stelle des regulären Ausdrucks benutzen.

## Arbeiten mit Farbschemata

### Überblick

Farbschemata definieren die Farben des Text-Editierbereichs und der Syntaxhervorhebung. Ein Farbschema umfasst die folgenden Punkte:

- Der Textstil für die Syntaxhervorhebung durch die Standard-Stilattribute. Zum Beispiel die Textfarbe und die ausgewählte Textfarbe.

- Der Hintergrund des Textbearbeitungsbereichs, einschließlich der Textauswahl und der aktuellen Zeile.

- Die Symbolumrandung des Textbereichs, deren Hintergrund, die Trennlinie, die Zeilennummern, die Zeilenumbruchmarkierungen, die geänderten Zeilenmarkierungen und die Quelltextausblendung.

- Textmarkierungen wie die Suchmarkierungen, die Einrückung und die Zeilenmarkierungen für Tabulator-/Leerzeichen, zusammengehörende Klammern und die Rechtschreibprüfung.

- Lesezeichen und Textbausteine.

Um Verwechslungen zu vermeiden, liegt das Folgende außerhalb des Anwendungsbereichs:

- Die Schriftart und Schriftgröße.

- Die Farben der Textbearbeitung, wie z. B. die Textgrafik auf der Bildlaufleiste, die Menüs, die Unterfensterleiste, die Fensterfarbe usw. In &kde; Anwendungen, wie &kate; oder &kdevelop;, werden diese Farben durch das `globale &kde; &plasma;,Farbschema` definiert, die im Modul Farben in den &systemsettings; oder von der Anwendung selbst im Menü Einstellungen Farbschema festgelegt werden.

Die Farbschemata Breeze-Hell und Breeze-Dunkel mit der Syntaxhervorhebung für C++.

Die Farbschemata Breeze-Hell und Breeze-Dunkel mit der Syntaxhervorhebung für C++.

### Farbschemata für KSyntaxHighlighting

Das Framework KSyntaxHighlighting enthält die Syntax-Highlighting-Engine und ist eine Bibliothek, die `die Farbschemata bereitstellt und verwaltet`. Die Bibliothek ist Teil von von &kde;-&frameworks; und wird in &kde;-Texteditoren wie &kate;, &kwrite;, &kile; und &kdevelop; verwendet. Diese Abhängigkeit sieht wie folgt aus:

Abhängigkeit von &kde;-&frameworks; 5 Bibliotheken von Texteditoren.

Abhängigkeit von &kde;-&frameworks;-Bibliotheken von Texteditoren.

KSyntaxHighlighting enthält eine Vielzahl von eingebauten Schemata, die auf der Seite Farbschemata der Webseite des Kate-Editors zu finden sind.

Das Framework KTextEditor enthält eine Benutzeroberfläche zum Erstellen und Bearbeiten von Farbschemata und ermöglicht das Importieren und Exportieren von Schemata. Sie können diesen Dialog in den Einstellungen des Texteditors öffnen. Weitere Informationen finden Sie im Abschnitt .

Die &GUI; zur Bearbeitung von Farbschemata in den Einstellungen von &kate;.

Die &GUI; zur Bearbeitung von Farbschemata in den Einstellungen von &kate;.

In den &kde;-Texteditoren wie &kate; oder &kdevelop; werden die Farbschemata von KSyntaxHighlighting seit &kde; &frameworks; 5.75 vom 10. Oktober 2020 verwendet. Zuvor wurden die Farbschemata von &kate; (KConfig-basierte Schema-Einstellungen) verwendet und die sind nun veraltet. Es ist jedoch möglich, die alten &kate;-Schemata in die KSyntaxHighlighting-Farbschemata umzuwandeln. Das KSyntaxHighlighting-Quelltextarchiv enthält das Skript `utils/kateschema_to_theme_converter.py` und den Ordner `utils/schema-converter/` mit weiteren Hilfsprogrammen für diesen Zweck.

### Das &JSON;-Format der Farbschemata

#### Überblick

Farbschemata werden in Dateien im &JSON;-Format mit der Dateierweiterung `.theme` gespeichert.

Im KSyntaxHighlighting-Quelltext befinden sich die &JSON;-Dateien der eingebauten Schemata im Ordner `data/themes/`. Die eingebauten Schemata werden in die Bibliothek KSyntaxHighlighting kompiliert, daher ist der Zugriff auf sie über den Quelltext oder durch Exportieren aus der &GUI; zur Verwaltung der Schemata von KTextEditor möglich.

Sie können auch auf einfache Weise zusätzliche oder benutzerdefinierte Schemata hinzuzufügen, die aus dem Dateisystem geladen werden. Benutzerdefinierte Schemadateien befinden sich im Ordner `org.kde.syntax-highlighting/themes/` in Ihrem persönlichen Ordner, den Sie mit dem Befehl ``qtpaths``--paths GenericDataLocation`` finden können, üblicherweise ``$HOME`/.local/share/` und `/usr/share/`.

Bei Flatpak- und Snap-Paketen funktioniert der obige Ordner nicht, da der Speicherort der Daten für jede Anwendung unterschiedlich ist. In einer Flatpak-Anwendung ist der Speicherort der benutzerdefinierten Schemadateien normalerweise ``$HOME`/.var/app/flatpak-package-name/data/org.kde.syntax-highlighting/themes/` und in einer Snap-Anwendung ist dieser Ort ``$HOME`/snap/snap-package-name/current/.local/share/org.kde.syntax-highlighting/themes/`.

Auf &Windows;-Systemen finden Sie diese Dateien unter `%USERPROFILE%\AppData\Local\org.kde.syntax-highlighting\themes`. %USERPROFILE%. Dabei ist %USERPROFILE% normalerweise `C:\Users\user-name`.

Zusammenfassend lässt sich sagen, dass der Ordner für benutzerdefinierte Schemata bei den meisten Einrichtungen wie folgt aussieht:

Für lokale Benutzer | ``$HOME`/.local/share/org.kde.syntax-highlighting/themes/`
Für alle Benutzer | `/usr/share/org.kde.syntax-highlighting/themes/`
Für Flatpak-Pakete | ``$HOME`/.var/app/flatpak-package-name/data/org.kde.syntax-highlighting/themes/`
Für Snap-Pakete | ``$HOME`/snap/snap-package-name/current/.local/share/org.kde.syntax-highlighting/themes/`
Unter &Windows; | `%USERPROFILE%\AppData\Local\org.kde.syntax-highlighting\themes`

Wenn mehrere Schemadateien mit demselben Namen existieren, wird die Datei mit der höchsten `Revision` geladen.

#### Dit &JSON;-Struktur

Der Aufbau einer &JSON;-Datei wird auf dieser Webseite erläutert. Grundsätzlich besteht eine Datei im &JSON;-Format aus:

- Sammlungen von Schlüssel/Wert-Paaren, getrennt durch Kommas und gruppiert in `{ }`, auch Objekte genannt.

- Sortierte Listen von Werten, getrennt durch Kommas und gruppiert in `[ ]`, auch Feld genannt.

Die Bezeichnungen Schlüssel, Wert, Objekt und Feld werden hier verwendet. Falls Sie zum ersten Mal mit &JSON;-Dateien arbeiten, helfen die folgenden Beispiele beim Verständnis.

#### Hauptabschnitte der &JSON;-Farbschemadateien

Das Basisobjekt der Farbschemadateien im &JSON;-Format enthält die folgenden Schema-Schlüssel:

- `metadata`: Dies ist obligatorisch. Der Wert ist ein Objekt mit den Metadaten des Schemas wie Name, Revision und Lizenz.

  Ausführliche Informationen dazu unter .

- `Editor-Farben`: Dies ist obligatorisch. Der Wert ist ein Objekt mit den Farben des Textbearbeitungsbereichs wie dem Hintergrund, dem Symbolrand und der Textdekoration.

  Ausführliche Informationen dazu unter .

- `Textstile`: Dies ist obligatorisch. Der Wert ist ein Objekt mit dem AttributStandard-Textstil der Syntaxhervorhebung. Jedes Attribut definiert seine Textfarbe, seine gewählte Textfarbe, oder ob es zum Beispiel fett oder kursiv sein soll. Die Textstile können aus den Attributen der Syntaxdefinitionsdateien referenziert werden.

  Ausführliche Informationen dazu unter .

- `custom-styles`: Ist optional. Definiert Textstile für die Attribute bestimmter Definitionen von Syntaxhervorhebungen. In einer Hervorhebungsdefinition wie `Python` oder `Markdown` können Sie einen anderen Textstil angeben, der den in `text-styles` definierten Standard überschreibt.

  Ausführliche Informationen dazu unter .

Die Sprache &JSON; unterstützt keine Kommentare. Sie können jedoch mit dem optionalen Schlüssel `_comments` im Basisobjekt Kommentare schreiben. Wenn sie zum Beispiel ein bestehendes Schema anpassen, können Sie die URL des ursprünglichen Archivs angeben. Der praktischste Weg ist die Verwendung eines Felds mit Zeichenfolgen.

Nachfolgend finden Sie eine Beispieldatei für das Schema Breeze-Hell-. Um das Beispiel nicht zu lang werden zu lassen, enthalten die Objekte `editor-colors` und `text-styles` nicht alle alle erforderlichen Schlüssel. Sie können die vollständige Datei des Schemas Breeze-Hell aus dem KSyntaxHighlighting-Quelltextarchiv herunterladen.

    {
        "_comments": [
            "This is a comment.",
            "If this theme is an adaptation of another, put the link to the original repository."
        ],
        "metadata": {
            "name" : "Breeze Light",
            "revision" : 5,
            "copyright": [
                "SPDX-FileCopyrightText: 2016 Volker Krause <vkrause@kde.org>",
                "SPDX-FileCopyrightText: 2016 Dominik Haumann <dhaumann@kde.org>"
            ],
            "license": "SPDX-License-Identifier: MIT"
        },
        "editor-colors": {
            "BackgroundColor" : "#ffffff",
            "CodeFolding" : "#94caef",
            "BracketMatching" : "#ffff00",
            "CurrentLine" : "#f8f7f6",
            "IconBorder" : "#f0f0f0",
            "IndentationLine" : "#d2d2d2",
            "LineNumbers" : "#a0a0a0",
            "CurrentLineNumber" : "#1e1e1e",
            The other editor color keys...

        },
        "text-styles": {
            "Normal" : {
                "text-color" : "#1f1c1b",
                "selected-text-color" : "#ffffff",
                "bold" : false,
                "italic" : false,
                "underline" : false,
                "strike-through" : false
            },
            "Keyword" : {
                "text-color" : "#1f1c1b",
                "selected-text-color" : "#ffffff",
                "bold" : true
            },
            "Function" : {
                "text-color" : "#644a9b",
                "selected-text-color" : "#452886"
            },
            "Variable" : {
                "text-color" : "#0057ae",
                "selected-text-color" : "#00316e"
            },
            The other text style keys...

        },
        "custom-styles": {
            "ISO C++": {
                "Data Type": {
                    "bold": true,
                    "selected-text-color": "#009183",
                    "text-color": "#00b5cf"
                },
                "Keyword": {
                    "text-color": "#6431b3"
                }
            },
            "YAML": {
                "Attribute": {
                    "selected-text-color": "#00b5cf",
                    "text-color": "#00b5cf"
                }
            }
        }
    }

#### Metadaten

Das &JSON; Objekt des Schlüssels `metadata` enthält die wichtigsten Informationen über das Schema. Dieses Objekt hat die folgenden Schlüssel:

- `Name`: Dies ist eine Zeichenfolge mit dem Name der Sprache. Dies wird in den Menüs und Dialogen angezeigt und ist verpflichtend.

- `revision`: Es ist eine ganze Zahl. die die aktuelle Revision der Schemadatei angibt. Wann immer Sie eine Farbschemadatei aktualisieren, müssen Sie diese Zahl vergrößern. Diese Wert ist erforderlich.

- `Lizenz`: Eine Zeichenfolge, die die Lizenz des Schemas definiert, unter Verwendung des Lizenzbezeichner `SPDX-License-Identifier` aus dem Standard SPDX-Lizenzkommunikationsformat. Dies ist optional.

  Die vollständige Liste der SPDX-Lizenzbezeichner können Sie hier einsehen.

- `copyright`: Ein Feld mit Zeichenfolgen, das die Autoren des Schemas angibt, mit `SPDX-FileCopyrightText` aus dem Standard SPDX-Lizenzkommunikationsformat. Dies ist optional.

    "metadata": {
        "name" : "Breeze Light",
        "revision" : 5,
        "copyright": [
            "SPDX-FileCopyrightText: 2016 Volker Krause <vkrause@kde.org>",
            "SPDX-FileCopyrightText: 2016 Dominik Haumann <dhaumann@kde.org>"
        ],
        "license": "SPDX-License-Identifier: MIT"
    }

### Farben im Detail:

In diesem Abschnitt werden all verfügbaren Attribute und Einstellungen für Farben aufgeführt:

#### Editor-Farben

Entspricht den Farben im Editorbereichs.

In der &JSON;-Schemadatei ist der Wert des entsprechenden Schlüssels `editor-colors` ein object wobei jeder Schlüssel auf eine Attribut-Farbe des des Texteditors verweist. Hier sind `alle verfügbaren Schlüssel notwendig`, ihre Werte sind `Zeichenfolgen` mit hexadezimalen Farbcodes wie #00B5CF.

In der &GUI; zum Verwalten von Schemata für KTextEditor können diese Attribute auf der Karteikarte `Farben` ändern.

Folgende Schlüssel sind verfügbar: Die Schlüssel aus der &JSON;-Datei sind fett, die Namen in der &GUI; sind in Klammern angegeben.

Hintergrundfarben des Editors
  `BackgroundColor` (Textbereich)

    Dies ist die Standardhintergrundfarbe für den Editorbereich, die vorherrschende Farbe im Editorbereich.

  `TextSelection` (Ausgewählter Text)

    Dies ist die Hintergrundfarbe für ausgewählten Text.

  `CurrentLine` (Aktuelle Zeile)

    Setzt die Farbe für die aktuelle Zeile. Die Farbe ist ein klein wenig anders als die normale Hintergrundfarbe, sodass Sie die aktuelle Zeile schnell wiederfinden.

  `SearchHighlight` (Suchen-Hervorhebung)

    Die Farbe für den Text, der bei der letzten Suche gefunden wurde.

  `ReplaceHighlight` (Ersetzen-Hervorhebung)

    Die Farbe für den Text, der bei der letzten Suche gefunden wurde.

Symbolrand
  `IconBorder` (Hintergrundbereich)

    Diese Farbe wird für den Hintergrund des Symbolrandes und des Zeilennummerrandes an der linken Seite des Editorfensters verwendet.

  `LineNumbers` (Zeilennummern)

    Diese Farbe wird für die Zeilennummern am linken Rand des Editorbereiches verwendet.

  `CurrentLineNumber` (Aktuelle Zeilennummer)

    Diese Farbe wird verwendet, um die Zeilennummer der aktuellen Zeile darzustellen und wird auf der linken Seite der Ansicht eingeblendet. Wenn Sie dies etwas anders als fürLineNumbers einstellen, erleichtert das die aktuellen Zeile im Blick zu behalten.

  `Separator` (Trennlinie)

    Diese Farbe wird verwendet, um die senkrechte Linie zu zeichnen, die den Symbolrand vom Hintergrund des Textbereichs trennt.

  `WordWrapMarker` (Markierungen für Zeilenumbrüche)

    Diese Farbe wird benutzt, wenn am linken Rand angezeigt wird, dass Zeilen dynamisch umgebrochen und eingerückt sind, sowie auch für die Markierung von festen Zeilenumbrüchen.

  `CodeFolding` (Quelltextausblendung)

    Mit dieser Farbe wird der Abschnitt des Quelltextes hervorgehoben, der beim Klicken auf den Pfeil zur Quelltextausblendung am linken Rand des Dokuments ausgeblendet wird Weitere Informationen finden Sie im Abschnitt Quelltextausblendung.

  `ModifiedLines` (Geänderte Zeilen)

    Mit dieser Farbe werden links neben dem Dokument Zeilen hervorgehoben, die in dieser Sitzung geändert wurden aber noch nicht gespeichert sind. Weitere Informationen finden Sie unter .

  `SavedLines` (Gespeicherte Zeilen)

    Mit dieser Farbe werden links neben dem Dokument Zeilen hervorgehoben, die in dieser Sitzung geändert wurden und bereits gespeichert sind. Weitere Informationen finden Sie unter .

Textdekorationen
  `SpellChecking` (Linie für Rechtschreibfehler)

    Dies legt die Farbe der Linie fest, die zum Markieren von Rechtschreibfehlern verwendet wird.

  `TabMarker` (Markierungen für Tabulatoren und Leerzeichen)

    Diese Farbe wird für dir Markierung von Tabulatoren und Leerzeichen verwendet, wenn Symbole für Wortzwischenräume angezeigt werden.

  `IndentationLine` (Einrückungslinie)

    Diese Farbe wird verwendet,um eine Linie links von eingerückten Textblöcken anzuzeigen, wenn diese Funktion aktiviert ist.

  `BracketMatching` (Hervorhebung für Klammern)

    Diese Farbe wird für den Hintergrund von zusammengehörenden Klammern verwendet.

Markierungsfarben
  `MarkBookmark` (Lesezeichen)

    Mit dieser Farbe werden Lesezeichen angezeigt. Beachten Sie, dass diese Farbe eine Deckkraft von 22 % (und 33 % für die aktuelle Zeile) in Bezug auf den Hintergrund hat. Weitere Informationen finden Sie unter .

  `MarkBreakpointActive` (Aktiver Haltepunkt)

    In dieser Farbe wird vom GDB-Modul ein aktiver Haltepunkt angezeigt, Beachten Sie, dass diese Farbe eine Deckkraft gegenüber dem Hintergrund hat. Weitere Informationen finden Sie in der Dokumentation zum GDB-Modul.

  `MarkBreakpointReached` (Erreichter Haltepunkt)

    In dieser Farbe wird vom GDB-Modul ein Haltepunkt angezeigt, der bei der Fehlersuche erreicht wurde. Beachten Sie, dass diese Farbe eine Deckkraft gegenüber dem Hintergrund hat. Weitere Informationen finden Sie in der Dokumentation zum GDB-Modul.

  `MarkBreakpointDisabled` (Nicht aktiver Haltepunkt)

    In dieser Farbe wird vom GDB-Modul ein nicht aktiver Haltepunkt angezeigt, Beachten Sie, dass diese Farbe eine Deckkraft gegenüber dem Hintergrund hat. Weitere Informationen finden Sie in der Dokumentation zum GDB-Modul.

  `MarkExecution` (Ausführung)

    In dieser Farbe wird vom GDB-Modul die zur Zeit ausgeführte Zeile angezeigt, Beachten Sie, dass diese Farbe eine Deckkraft gegenüber dem Hintergrund hat Weitere Informationen finden Sie in der Dokumentation zum GDB-Modul.

  `MarkWarning` (Warnung)

    Mit dieser Farbe wird vom Erstellen-Modul eine Zeile eingefärbt, für die Compiler eine Warnung ausgegeben hat. Beachten Sie, dass diese Farbe eine Deckkraft gegenüber dem Hintergrund hat. Weitere Informationen finden Sie in der Dokumentation zum Erstellen-Modul.

  `MarkError` (Fehler)

    Mit dieser Farbe wird vom Erstellen-Modul eine Zeile eingefärbt, für die Compiler einen Fehler ausgegeben hat Beachten Sie, dass diese Farbe eine Deckkraft gegenüber dem Hintergrund hat. Weitere Informationen finden Sie in der Dokumentation zum Erstellen-Modul.

Textvorlagen & Textbausteine
  `TemplateBackground` (Hintergrund)

    In dieser Farbe wird der Hintergrund eines Textbausteins in &kate; angezeigt. Weitere Informationen dazu finden Sie in der Dokumentation zu &kate;-Textbausteinen.

  `TemplatePlaceholder` (Editierbarer Platzhalter)

    In dieser Farbe wird ein Platzhalter eines Textbausteins in &kate; angezeigt, den Sie zur manuellen Bearbeitung anklicken können. Weitere Informationen dazu finden Sie in der Dokumentation zu &kate;-Textbausteinen.

  `TemplateFocusedPlaceholder` (Editierbarer Platzhalter mit Fokus)

    In dieser Farbe wird der gerade bearbeitete Platzhalter eines Textbausteins in &kate; angezeigt Weitere Informationen dazu finden Sie in der Dokumentation zu &kate;-Textbausteinen.

  `TemplateReadOnlyPlaceholder` (Nicht editierbarer Platzhalter)

    Diese Farbe wird im Textbausteinmodul von &kate; verwendet, um Platzhalter zu kennzeichnen, der nicht manuell editiert werden kann und zum Beispiel automatisch ausgefüllt wird. Weitere Informationen finden Sie in der Dokumentation zu &kate;-Textbausteinen.

#### Standardtextstile

Die Stile für Standardtext sind von den Stilen für Hervorhebungen abgeleitet, sodass der Editor Texte immer in der gleichen Form anzeigen kann. So sind zum Beispiel Kommentare unabhängig vom Textformat oder der Programmiersprache des Quelltextdokuments immer in der gleichen Farbe gekennzeichnet.

Diese Textstile können von den `Standardstilen` in den Definitionen der &XML;-Dateien zur Syntaxhervorhebung referenziert werden. Zum Beispiel entspricht das Attribut Normal dem Attribut dsNormal in den &XML;-Dateien, und DataType entspricht dsDataType. Weitere Informationen finden Sie in der Dokumentation zur Syntaxhervorhebung.

Achten Sie darauf, lesbare Farben mit gutem Kontrast zu wählen, besonders in Kombination mit dem `Editor-Farben`. Siehe auch .

In der &JSON;-Datei, hat der jeweilige Schlüssel `text-styles` als Wert ein Objekt, wobei jeder Schlüssel dem Namen eines Standard-Textstils in den in den Definitionen für die Syntaxhervorhebung entspricht. Hier sind `alle verfügbaren Stil-Schlüsselwörter für Text obligatorisch` , diese sind unten aufgeführt.

    "text-styles": {
        "Normal" : {
            "text-color" : "#1f1c1b",
            "selected-text-color" : "#ffffff",
            "bold" : false,
            "italic" : false,
            "underline" : false,
            "strike-through" : false
        },
        "Keyword" : {
            "text-color" : "#1f1c1b",
            "selected-text-color" : "#ffffff",
            "bold" : true
        },
        "Function" : {
            "text-color" : "#644a9b",
            "selected-text-color" : "#452886"
        },
        The other text style keys...
    }

Jeder Schlüssel des Standardtextstils enthält ein &JSON;-Objekt als Wert, in dem Werte wie color, bold, italic, usw. angegeben werden. Es gibt folgende Schlüssel:

  `text-color`: Eine Zeichenfolge mit der Textfarbe im hexadezimalen Farbcode. Dieser Schlüssel/Wert ist erforderlich.

  `selected-text-color`: Die Textfarbe für ausgewählten Text hat in der Regel den gleichen Wert wie text-color. Wenn der Text ausgewählt ist, wird der Hintergrund durch den Wert von TextSelection in der Editor-Farben definiert, daher sollte der Text einen guten Kontrast haben und mit diesem Hintergrund gut lesbar ist. Der Wert ist eine Zeichenfolge mit einem hexadezimalen Farbcode. Dieser Schlüssel/Wert muss angegeben werden.

  `bold`: Ein Boolescher Wert, der festlegt, ob der Text in Fettschrift angezeigt wird. Dieser Schlüssel ist optional, der Standardwert ist `false`.

  `italic`: Ein Boolescher Wert, der festlegt, ob der Text kursiv angezeigt wird. Dieser Schlüssel ist optional, der Standardwert ist `false`.

  `underline`: Ein Boolescher Wert, der festlegt, ob der Text in unterstrichen angezeigt wird. Dieser Schlüssel ist optional, der Standardwert ist `false`.

  `strike-through`: Ein Boolescher Wert, der festlegt, ob der Text in durchgestrichen angezeigt wird. Dieser Schlüssel ist optional, der Standardwert ist `false`.

  `background-color`: Bestimmt die Hintergrundfarbe von Text und wird zum Beispiel in Warnungen (Alerts) in Kommentaren verwendet. Der Wert ist eine Zeichenfolge mit einem hexadezimalen Farbcode. Dieser Schlüssel ist optional, als Voreinstellung gibt es keine Hintergrundfarbe.

  `selected-background-color`: Bestimmt die Hintergrundfarbe von ausgewähltem Text. Der Wert ist eine Zeichenfolge mit einem hexadezimalen Farbcode. Dieser Schlüssel ist optional, als Voreinstellung gibt es keine Hintergrundfarbe.

In der &GUI; zur Verwaltung der Farbthemen von KTextEditor können diese Attribute auf der Karteikarte `Standardtextstile` geändert werden. Der Name in der Liste der Stile verwendet den für das Element eingerichteten Stil, so dass Sie beim Ändern eines Stils sofort eine Vorschau erhalten. Jeder Stil ermöglicht die Auswahl gemeinsamer Attribute sowie von Vorder- und Hintergrundfarben. Um eine Hintergrundfarbe zu deaktivieren, klicken Sie mit der rechten Maustaste, um das Kontextmenü zu verwenden.

Folgende Schlüssel für Textstile sind verfügbar: Die Schlüssel aus der &JSON;-Datei sind fett geschrieben, die Namen in der &GUI; sind in Klammern angegeben, falls sie anders sind.

Normaltext & Quelltext

  `Normal`: Standard-Textstil für normalen Text und Quelltext ohne besondere Hervorhebung.

  `Keyword`: Textstil für eingebaute Sprach-Schlüsselwörter.

  `Function`: Textstil für Funktionsaufrufe und -definitionen.

  `Variable`: Textstil für Variablen, falls zutreffend. Zum Beispiel beginnen Variablen in PHP/Perl typischerweise mit einem `$`, also werden alle Bezeichner mit dem Muster `$foo` als Variable hervorgehoben.

  `ControlFlow` (Kontrollfluss): Textstile für Schlüsselwörter den Programmablauf wie zum Beispiel if, then, else, return, switch, break, yield, continue, usw.

  `Operator`: Textstil für Operatoren wie `+`, `-`, `*`, `/`, `%` usw.

  `BuiltIn` > (Built-in): Textstil eingebaute Funktionen, Klassen und Objekte.

  `Extension`: Textstil für bekannte Erweiterungen wie zum Beispiel &Qt;-Klassen und Funktionen/Makros in C++ und Python oder Boost.

  `Preprocessor`Textstil für Präprozessor-Anweisungen oder Makro-Definitionen.

  `Attribute`: Textstil für Anmerkungen oder Attribute von Funktionen oder Objekten wie zum Beispiel `@override` in Java oder `__declspec(...)` und `__attribute__((...))` in C++.

Zahlen, Typen & Konstanten

  `DataType` (Datentyp): Textstil für eingebaute Datentypen wie int, char, float, void, u64 usw.

  `DecVal` (Dezimal/Wert): Textstil für Dezimalwerte.

  `BaseN` (Base-N Integer): Textstil für Werte mit einer anderen Zahlenbasis als 10.

  `Float` (Fließkommazahl): Textstil für Gleitkommawerte.

  `Constant`: Textstile für Konstanten in Sprachen oder für benutzerdefinierte Konstanten wie zum Beispiel True, False, None in Python oder nullptr in C/C++; oder mathematische Konstanten wie PI.

Zeichenfolgen & Zeichen

  `Char` ( Zeichen): Textstil für einzelne Zeichen wie `'x'`.

  `SpecialChar` (Sonderzeichen): Textstil für maskierte Zeichen in Zeichenfolgen, z.B. `hello` , und andere Zeichen mit besonderer Bedeutung in Zeichenfolgen, z. B. Ersetzungen oder Regex-Operatoren.

  `String`:Textstil für Zeichenfolgen wie `Hallo Welt`.

  `VerbatimString` (Wörtliche Zeichenfolge): Textstile für wörtliche oder unveränderte Zeichenfolgen wie `raw \backlash` in Perl, CoffeeScript und Shells wie auch `r'\raw'` in Python oder wie in HERE-Dokumenten.

  `SpecialString` (Besondere Zeichenfolge): Textstil für besondere Zeichenfolgen wie reguläre Ausdrücke in ECMAScript, im &latex;-Mathematikmodus, SQL, usw.

  `Import` (Importe, Module, Includes): Textstil für Includes, Importe, Module oder &latex;-Pakete.

Kommentare & Dokumentation

  `Comment`: Textstile für normale Kommentare.

  `Documentation`: Textstil für Kommentare zur API-Dokumentation wie z. B. `/** doxygen comments */` oder `"""docstrings"""`.

  `Annotation`: Textstil für Anmerkungen in Kommentaren oder Dokumentationsbefehle wie `@param` in Doxygen oder JavaDoc.

  `KommentarVar` (Kommentar-Variable): Textstil, der auf Variablennamen verweist, die in obigen Befehlen in einem Kommentar verwendet werden, wie z. B. `foobar` in `@param foobar` in Doxygen oder JavaDoc.

  `RegionMarker` (Bereichsmarkierungr): Textstil für das Markieren von Bereichen, typischerweise definiert durch`//BEGIN` und `//END` in Kommentaren.

  `Information`:Textstil für Notizen und Hinweise wie zum Beispiel Schlüsselwörter wie `@note` in Doxygen.

  `Warning`: Textstil für Warnungen wie das Schlüsselwort `@warning` in Doxygen.

  `Alert`: Textstil für spezielle Wörter in Kommentaren wie `TODO`, `FIXME`, `XXXX` und `WARNING`.

Verschiedenes

  `Error`: Textstil für Hervorhebungen von Fehlern und für fehlerhafter Syntax.

  `Others`: Textstile für Attribute, die nicht für einen der anderen Standardstile zutreffen.

#### Benutzerdefinierte Textstile für Hervorhebungen

Hier können Sie Textstile für eine bestimmte Syntaxhervorhebung festlegen Definition festlegen und damit den `Standard-Textstil` überschreiben wie in dem vorherigen Abschnitt beschrieben.

In der &JSON;-Schemadatei entspricht dies dem Schlüssel `custom-styles`, dessen Wert ein ein Objekt ist, wobei jeder Unterschema-Schlüssel mit dem `Name einer Syntaxhervorhebungsdefinition` korrespondiert. Sein Wert ist ein Objekt, bei dem jeder Schlüssel auf den `Name des Stilattributs` verweist, der in den `itemData`-Elementen der der Syntaxhervorhebung-s&XML;-Datei definiert ist. Der jeweilige Wert ist ein Unterobjekt mit den Schlüsseln text-color, selected-text-color, bold, italic, underline, strike-through, background-color und selected-background-color, definiert im vorherigen Abschnitt. Jeder dieser Werte ist optional, denn wenn sie nicht vorhanden sind, wird der in `text-styles` eingestellte Stil berücksichtigt.

Zum Beispiel hat die Syntaxhervorhebungsdefinition für ISO C++ in diesem Quelltext einen speziellen Textstil für die Attribute Type Modifiers und Standard Classes. In der zugehörigen &XML;-Datei isocpp.xml verwendet das definierte Attribut Standard Classes den Standardstil `BuiltIn` (oder dsBuiltIn). In diesem Attribut wird nur der Wert von `text-color` durch die neue Farbe #6431b3 überschrieben .

    "custom-styles": {
        "ISO C++": {
            "Standard Classes": {
                "text-color": "#6431b3"
            },
            "Type Modifiers": {
                "bold": true,
                "selected-text-color": "#009183",
                "text-color": "#00b5cf"
            }
        }
    }

- Sie sollten beachten, dass diese Textstile den Attributnamen zugeordnet sind, die in den &XML; -Syntaxhervorhebungsdateien definiert sind. Wenn eine XML-Datei aktualisiert und einige Attribute umbenannt oder entfernt werden, ist der im eigenen Schema definierte Stil nicht mehr gültig.

- Definitionen für Syntaxhervorhebung enthalten oft andere Definitionen. Die Syntaxhervorhebung für QML zum Beispiel enthält die Syntaxhervorhebung für JavaScript, da beide die gleichen Funktionen für die Hervorhebung verwenden.

In der &GUI; zum Verwalten von Schemata von KTextEditor können Sie diese Attribute auf der Karteikarte `Textstile für Hervorhebungen` verwalten. Als Voreinstellung wird die Hervorhebung des aktuellen Dokuments vom Editor eingestellt. Sie werden feststellen, dass viele Hervorhebungen andere Hervorhebungen enthalten, die durch Gruppen in der Stilliste repräsentiert werden. Zum Beispiel importieren die meisten Hervorhebungen die Hervorhebung Alert und viele Quelltextformate importieren die Hervorhebung Doxygen.

### Die &GUI; der Farbschemata

Farbschemata lassen sich am einfachsten über die &GUI; im Einrichtungs-Dialog von KTextEditorerstellen und bearbeiten. .Um diesen Dialog zu öffnen, wählen Sie Einstellungen Anwendung einrichten ... aus der Menüleiste in Ihrer Textverarbeitung. Wählen Sie dann Farbschema in der Seitenleiste.

&kate;s Einrichtungsdialog mit der Bearbeitung von Farbschemata.

&kate;s Einrichtungsdialog mit der Bearbeitung von Farbschemata.

In diesem Dialog können Sie alle alle Farben in einem beliebigen Schema einstellen, neue Schemata erstellen/kopieren, löschen, sie in eine `.theme`-Datei im &JSON; Format exportieren oder aus externen `.theme`-Dateien importieren. Jedes Schema hat Einstellungen für Textfarben und Stile.

Die eingebauten Schemata können als Voreinstellung nicht geändert werden. Dazu müssen Sie sie unter einem neuen Namen kopieren.

Um ein Farbschema dauerhaft in im Texteditor zu verwenden, müssen Sie es im Kombinationsfeld mit der Bezeichnung Standardschema für Anwendung am unteren Rand des Dialogs auswählen und dann Anwenden oder OK drücken. Standardmäßig wird die `Automatische Auswahl` aktiviert. Damit wird ein geeigneteres Farbschema passend zum &kde; &plasma;-Farbschema für die Textbearbeitung gewählt. Normalerweise wird zwischen Breeze-Hellt und Breeze-Dunkel gewählt.

Sie können das globale Farbschema für &kde; im Modul Farben in den &systemsettings; anpassen. Für einzelne Anwendungen wie &kate; und &kdevelop; können Sie ein Schema auch mit Einstellungen Farbschema ändern.

#### Ein neues Schema erstellen

Um ein neues Farbschema zu erstellen, müssen Sie zuerst ein vorhandenes Schema kopieren, Wählen Sie ein vorhandenes Schema aus, das Sie als Grundlage verwenden möchten wie Breeze-Hell oder Breeze-Dunkel. Klicken Sie dann auf Kopieren und geben den Namen für das neue Schema ein.

Möchten Sie ein eingebautes oder nur lesbares Schema verändern, müssen Sie es zuerst unter einem anderen Namen kopieren.

#### &JSON;-Schemadateien importieren oder exportieren

Mit Exportieren können Sie ein ausgewähltes Schema einschließlich der eingebauten Schemata in eine &JSON;-Datei mit der Dateierweiterung `.theme` exportieren. Damit öffnen Sie einen Dialog zum Speichern der Datei. Um eine Farbschema aus einer externen &JSON;-Datei hinzuzufügen, drücken Sie den Knopf Importieren und wählen dann die `.theme`-Datei im Dialog.

- Wie oben erwähnt, werden benutzerdefinierte Farbschema-Dateien im Ordner `org.kde.syntax-highlighting/themes/` abgelegt. Wenn Sie ein Farbschema kopieren oder neu erstellen, wird es automatisch dort gespeichert. Auch das Importieren oder Hinzufügen eines Farbschemas entspricht dem Kopieren einer externen `.theme`-Datei in diesen Ordner. KSyntaxHighlighting holt sich automatisch Schemadateien aus diesem Ordner.

- Wenn Sie ein von Ihnen erstelltes Schema veröffentlichen wollen, ist es unbedingt erforderlich, das Metadaten-Objekt der &JSON; Datei zu prüfen, eine passende Lizenz hinzuzufügen und die Revisionsnummer zu überprüfen.

#### Bearbeitung von Farbschemata

##### Farben

Hier können die Farben des Editorbereichs angepasst werden. Mehr Informationen dazu finden Sie in .

##### Standardtextstile

Die Stile für Standardtext sind von den Stilen für Hervorhebungen abgeleitet, sodass der Editor Texte immer in der gleichen Form anzeigen kann. So sind zum Beispiel Kommentare unabhängig vom Textformat oder der Programmiersprache des Quelltextdokuments immer in der gleichen Farbe gekennzeichnet.

Der Name in der Liste der Stile wird so wie Elemente im Dokument mit diesem Kontext angezeigt. So erhalten Sie sofort eine Vorschau beim Bearbeiten.

Zu jedem Stil können Sie Eigenschaften sowie Vordergrund- und Hintergrundfarbe einstellen. Um eine Hintergrundfarbe zu löschen, benutzen Sie die &RMB;, um das Kontextmenü aufzurufen.

Die Attribute in diesem Bereich werden in erläutert.

##### Textstile für Hervorhebungen

Hier können Sie die Textstile für bestimmte Hervorhebungsdefinitionen einstellen. Der Editor startet diese Seite mit der Hervorhebung für das aktuelle Dokument. Wenn Sie an einer anderen Hervorhebungsdefinition Veränderungen vornehmen wollen, dann wählen Sie diese mit dem Auswahlfeld Hervorhebung aus.

Der Name in der Liste der Stile wird so wie Elemente im Dokument mit diesem Kontext angezeigt. So erhalten Sie sofort eine Vorschau beim Bearbeiten.

Zu jedem Stil können Sie Eigenschaften sowie Vordergrund- und Hintergrundfarbe einstellen. Um eine Hintergrundfarbe zu löschen, benutzen Sie die &RMB;, um das Kontextmenü aufzurufen. Zusätzlich gibt es noch ein Feld, das anzeigt, ob der eingestellte Stil der Standarddefinition entspricht - wenn nicht klicken Sie einfach auf dieses Feld, um die Standardeinstellungen herzustellen.

Sie werden feststellen, dass viele Hervorhebungen andere Hervorhebungen enthalten, die in Untergruppen geordnet sind. So werden zum Beispiel die Hervorhebungen für Warnungen (Alerts) in die meisten Hervorhebungen importiert, viele Quelltexte importieren außerdem die Hervorhebungen für Doxygen. Wenn Sie Änderungen an den importierten Hervorhebungen vornehmen, dann werden nur die Stile im bearbeiteten Format beeinflusst. Andere Formate, die die gleichen Hervorhebungen importiert haben, werden nicht beeinflusst.

### Tipps & Tricks

#### Kontrast von Textfarben

Ein wichtiger Aspekt bei der Arbeit mit Farbschemata ist die Wahl eines Textkontrasts, der die Lesbarkeit des Textes erleichtert, insbesondere in Kombination mit dem Hintergrund.

`Kontrast` ist eine Anwendung zur Überprüfung von Farbkontrasten. Damit erkennen Sie, ob die Kombinationen aus Textfarbe und Hintergrundfarbe lesbar und zugänglich sind, daher ist dies ein ausgezeichnetes Werkzeug für die Erstellung von Farbschemata.

Sie können `Kontrast` von der &kde;-Webseite mit Anwendungen oder als Flatpak-Paket auf Flathub herunterladen (nur für GNU/Linux).

Die GNOME-Anwendung `Contrast` funktioniert ähnlich. Sie können sie als Flatpak-Paket auf Flathub herunterladen (nur für GNU/Linux).

#### Vorschläge zur Konsistenz bei der Syntaxhervorhebung

KSyntaxHighlighting enthält mehr als 300 Definitionen für Syntaxhervorhebung, daher sollten Sie dafür sorgen, dass Ihr neues Schema in allen Definitionen der Syntaxhervorhebung gut aussieht. Die eingebauten Farbschemata haben folgende Gemeinsamkeiten, die Sie beachten sollten, um eine eine korrekte Darstellung aller Definitionen der Syntaxhervorhebung zu erhalten:

- Verwenden Sie Fettschrift für Keyword und ControlFlow als Textstile.

- Benutzen Sie keine Hintergrundfarbe in einem Textstil, außer bei Alert und RegionMarker.

Die meisten der Syntaxhervorhebungen sind für die Standarddesigns Breeze-Hell und Breeze-Dunkel optimiert.Daher sollten Sie für die Einheitlichkeit ähnlicher Farben verwenden wie in den Textstilen, wie grün für Präprozessor und Andere, blau für Datentyp und Attribut oder purpur für Funktion.

Beachten Sie, dass diese Empfehlungen nicht zwingend für das Erstellen und Veröffentlichen eines Schemas sind.

## Scripting mit &javascript;

Die Editorkomponente von &kappname; kann durch Skripte erweitert werden. Als Skriptsprache wird ECMAScript verwendet, das auch unter dem Namen &javascript; bekannt ist. In &kappname; 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 folgenden Abschnitte beschreiben Schritt für Schritt, wie das Gerüst für ein einfaches Einrückungsskript entsteht. Zuerst wird eine neue `*.js`-Datei &eg; mit dem Namen `$`XDG_DATA_HOME`/katepart5/script/indentation` erzeugt. Darin wird die Umgebungsvariable `XDG_DATA_HOME` normalerweise entweder zu `~/.local` oder `~/.local/share` erweitert.

Auf &Windows;-Systemen finden Sie diese Dateien unter `%USERPROFILE%\AppData\Local\katepart5\indentation`. Dabei ist %USER% normalerweise `C:\\Users\\user`.

#### Der Vorspann des Einrückungsskripts

Der Vorspann der Datei `javascript.js` ist als &JSON; am Anfang des Dokumentes eingebettet und hat folgende Form:

    var katescript = {
        "name": "JavaScript",
        "author": "Example Name <example.name@some.address.org>",
        "license": "BSD License",
        "revision": 1,
        "kate-version": "5.1",
        "required-syntax-style": "javascript",
        "indent-languages": ["javascript"],
        "priority": 0,
    }; // kate-script-header, muss am Anfang der Datei stehen und darf keine Kommentare enthalten

Jede Zeile wird jetzt im Detail erklärt:

- `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-Lizenz oder LGPLv3.

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

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

- `required-syntax-style` [optional]: Der erforderliche Sytaxstil, der zum angebenen `style` in Syntaxhervorhebungs-Stildateien passt. 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]: &JSON;-Feld von Syntaxstilen, die das Skript richtig einrücken kann, &eg;: `["c++", "java"]`.

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

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

    // benötigt die Bibliothek „katepart js“ &eg; range.js wenn Range benutzt wird
    require ("range.js");

    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. Anderenfalls wird der zweite Rückgabewert ignoriert. Die Benutzung von Tabulator- und Leerzeichen wird oft als Mischmodus bezeichnet.

Betrachten Sie das folgende Beispiel: Angenommen das Tabulatorzeichen wird zur Einrückung verwendet und die Tabulatorweite beträgt 4. Hier steht <tab> für 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 &kappname; mit einigen Einrückungsskripten installiert. Die entsprechenden &javascript;-Quelltexte finden Sie unter `$`XDG_DATA_DIRS`/katepart5/script/indentation`.

Auf &Windows;-Systemen finden Sie diese Dateien unter `%USERPROFILE%\AppData\Local\katepart5\indentation`. Dabei ist %USER% normalerweise `C:\\Users\\user`.

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 &kappname;-Projekt hinzufügen. Schreiben Sie dazu an die Mailingliste.

### Befehlszeilenskripte

Da nicht alle gewünschten Funktionen in &kappname; 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 &kappname; mit beliebigen Hilfsskripten zu erweitern.

Befehlszeilenskripte werden im gleichen Ordner wie Einrückungsskripte gespeichert. Zuerst erstellen Sie eine neue `*.js`-Datei namens `myutils.js` im lokalen persönlichen Ordner `$`XDG_DATA_HOME`/katepart5/script/commands`. Darin wird die Umgebungsvariable `XDG_DATA_HOME` normalerweise entweder zu `~/.local` oder `~/.local/share` erweitert.

Auf &Windows;-Systemen finden Sie diese Dateien unter `%USERPROFILE%\AppData\Local\katepart5\commands`. Dabei ist %USERPROFILE% normalerweise `C:\\Users\\user`.

#### Der Vorspann des Befehlszeilenskripts

Der Vorspann jedes Befehlszeilen-Skripts ist in der &JSON;-Datei am Anfang des Skripts so eingebettet:

    var katescript = {
        "author": "Example Name <example.name@some.address.org>",
        "license": "LGPLv2+",
        "revision": 1,
        "kate-version": "5.1",
        "functions": ["sort", "moveLinesDown"],
        "actions": [
            {   "function": "sort",
                "name": "Sort Selected Text",
                "category": "Editing",
                "interactive": "false"
            },
            {   "function": "moveLinesDown",
                "name": "Move Lines Down",
                "category": "Editing",
                "shortcut": "Ctrl+Shift+Down",
                "interactive": "false"
            }
        ]
    }; // kate-script-header, muss am Anfang der Datei stehen und darf keine Kommentare enthalten

Jede Zeile wird jetzt im Detail erklärt:

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

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

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

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

- `functions` [erforderlich]: &JSON;-Feld der Befehle im Skript.

- `actions` [optional]: &JSON;-Feld mit &JSON;-Objekten, das die Aktionen festlegt, die im Anwendungsmenü erscheinen sollen. Weitergehende Informationen finden Sie im Abschnitt Kurzbefehle festlegen.

Da der Inhalt von `functions` ein &JSON;-Feld ist, kann ein einzelnes Skript eine beliebige Anzahl von Befehlen für die Befehlszeile enthalten. Jede Funktion ist durch die eingebaute Befehlszeile in &kappname; 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 `moveLinesDown` implementiert werden. Alle Funktionen haben folgende Syntax:

    // benötigt die Bibliothek „katepart js“ &eg; range.js wenn Range benutzt wird
    require ("range.js");
    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 .

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.

##### Kurzbefehle festlegen

Das Skript braucht einen passenden Skript-Header, der die Skripte über das Anwendungsmenü verfügbar macht. Im Beispiel erscheinen die Funktionen `sort` und `moveLinesDown` im Menü. Das wird durch den folgenden Skript-Header erreicht:

    var katescript = {
        ...
        "actions": [
            {   "function": "sort",
                "name": "Sort Selected Text",
                "icon": "",
                "category": "Editing",
                "interactive": "false"
            },
            {   "function": "moveLinesDown",
                "name": "Move Lines Down",
                "icon": "",
                "category": "Editing",
                "shortcut": "Ctrl+Shift+Down",
                "interactive": "false"
            }
        ]
    };

Die Felder für eine Aktion lauten wie folgt:

- `function` [erforderlich]: Die Funktion, die im Menü Extras Skripte erscheint.

- `name` [erforderlich]: Der Text, der im Menü Skript angezeigt wird.

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

- `category` [optional]: Wenn eine Kategorie angegeben ist, dann erscheint das Skript in einem Untermenü.

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

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

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

### Skript-API

Die hier vorgestellte Programmierschnittstelle (API) ist in allen Skripten verfügbar, &ie; in Einrückungs- und Befehlszeilenskripten. Die Klassen `Cursor` und `Range` werden durch die Bibliotheksdateien in `$`XDG_DATA_DIRS`/katepart5/libraries` bereit gestellt. Wenn Sie sie in Ihren Skripten verwenden möchten, was für einige der Funktionen `Document` oder `View` erforderlich ist, fügen Sie bitte die benötigte Bibliothek wie folgt ein:

    // benötigt die Bibliothek „katepart js“ &eg; range.js wenn Range benutzt wird
    require ("range.js");

Um die Standard-Skript-API mit eigenen Funktionen und Prototypen zu erweitern, erzeugen Sie eine neue Datei im lokalen Einrichtungsordner für &kde; `$`XDG_DATA_HOME`/katepart5/libraries` und schließen Sie sie in Ihr Skript mit folgendem Befehl ein:

    require ("myscriptnamehere.js");

Auf &Windows;-Systemen finden Sie diese Dateien unter `%USERPROFILE%\AppData\Local\katepart5\libraries`. Dabei ist %USERPROFILE% normalerweise `C:\\Users\\user`.

Um vorhandene Prototypen wie `Cursor` oder `Range` zu erweitern, wird empfohlen, nicht die globalen `*.js`-Dateien zu ändern. Ändern Sie stattdessen den `Cursor`-Prototyp in &javascript;, nachdem `cursor.js` in Ihrem Skript mit `require` eingefügt ist.

#### Cursor und Bereiche

Da &kappname; 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 im Dokument. Ein Bereich umfasst Text vom Start bis zum Ende der Cursor-Position. 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 other);

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

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

    Cursor Cursor.clone();

  Gibt einen Klon des Cursors zurück.

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

    Cursor.setPosition(int zeile, int spalte);

  Setzt die Cursor-Position auf zeile und spalte.

  Since: &kde; 4.11

    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 other);

  Vergleicht diesen Cursor mit dem Cursor other. 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 other);

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

    String Cursor.toString();

  Gibt den Cursor als Zeichenfolge 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.isEmpty();

  Gibt `true` zurück, wenn der Start- und der End-Cursor gleich sind.

  Beispiel: `var empty = range.isEmpty();`

  Since: &kde; 4.11

    bool Range.isValid();

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

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

    Range 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 Cursor-Position 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 Intervall `[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.onSingleLine();

  Gibt `true` zurück, wenn der Bereich in der gleichen Zeile beginnt und endet, &ie; wenn Range.start.line == Range.end.line ist.

  Seit: &kde; 4.9

    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 Zeichenfolge in der Form `Range(Cursor(zeile, spalte), Cursor(zeile, spalte))` zurück.

#### Globale Funktionen

Dieser Abschnitt listet alle globalen Funktionen auf.

##### Lesen & Einfügen von Dateien

    String read(String datei);

  Sucht nach der angegebenen datei relativ zum Ordner `katepart/script/files` und gibt den Inhalt der Datei als String zurück.

    void require(String datei);

  Sucht die angegebene datei relativ zum Ordner `katepart/script/libraries` und wertet sie aus. `require` verhindert intern, dass die gleiche datei mehrfach eingeschlossen wird.

  Seit: &kde; 4.10

##### Fehlersuche

    void debug(String text);

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

##### Übersetzung

Die Lokalisierung wird durch einige Funktionen zum Übersetzen von Zeichenfolgen 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 Zeichenfolgen durch &kde;'s Übersetzungssystem in die Sprache, die in der Anwendung benutzt wird. Zeichenfolgen in Skripten, die in den offiziellen &kappname;-Quellen entwickelt werden, werden automatisch extrahiert und sind übersetzbar. Anders gesagt, müssen Sie sich als Entwickler von &kappname; nicht um das Extrahieren und Übersetzen kümmern. Achtung, diese Funktionalität gibt es nur innerhalb der &kde;-Infrastruktur. Neue Texte in Skripten, die von Anderen ausserhalb von &kde; entwickelt wurden, werden nicht automatisch übersetzt. Bitte denken Sie darüber nach, solche Skripte an &kde; zu geben, so dass die korrekte Übersetzung möglich wird.

    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` &etc; zu ersetzen.

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

  Übersetzt text in die von der Anwendung benutzte Sprache. Zusätzlich ist die Zeichenfolge context sichtbar, so dass Übersetzer bessere Übersetzungen anfertigen können. Die Argumente arg1, ..., sind optional und werden benutzt, um die Platzhalter `%1`, `%2` &etc;. 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` &etc;. 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 Zeichenfolge context sichtbar, so dass Übersetzer bessere Übersetzungen anfertigen können. Die Argumente arg1, ..., sind optional und werden benutzt, um die Platzhalter `%1`, `%2` &etc;. 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.

    void view.copy()

  Kopiert eine vorhandene Auswahl, ansonsten die aktuelle Zeile, wenn die Einstellung `[ ] Die aktuelle Zeile kopieren/ausschneiden, wenn keine Markierung vorliegt` aktiviert ist.

  Seit &kde-frameworks; 5.79

    void view.cut()

  Schneidet eine vorhandene Auswahl, ansonsten die aktuelle Zeile aus, wenn die Einstellung `[ ] Die aktuelle Zeile kopieren/ausschneiden, wenn keine Markierung vorliegt` aktiviert ist.

  Seit &kde-frameworks; 5.79

    void view.paste()

  Inhalt der Zwischenablage einfügen.

  Seit &kde-frameworks; 5.79

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

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

    Cursor view.virtualCursorPosition();

  Gibt die virtuelle Cursor-Position 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 Zeichenfolge 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.

    object view.executeCommand(String command,
                               String args,
                               Range range);

  Führt den Befehl command mit den optionalen Argumenten args und range aus. Das zurückgegebene objecthat die boolesche Eigenschaft object.ok, mit der angegeben wird, ob der Befehl command erfolgreich ausgeführt wurde. Bei einem Fehler enthält object.status die Fehlermeldung.

  Seit &kde-frameworks; 5.50

#### 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 Dokuments zurück oder eine leere Zeichenfolge für nicht gespeicherte Textpuffer.

    String document.url();

  Gibt die vollständige &URL; des Dokuments zurück oder eine leere Zeichenfolge für nicht gespeicherte Textpuffer.

    String document.mimeType();

  Gibt den &MIME;-Typ des Dokuments zurück oder `application/octet-stream`, wenn kein passender &MIME;-Typ 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 Cursor-Position 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 Zeichenfolge 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 ist der Quelltext besser lesbar.

    String document.line(int zeile);

  Gibt die angegebene Textzeile als Zeichenfolge zurück. Die Zeichenfolge 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 angegebenen Cursor-Position zurück.

    Range document.wordRangeAt(int zeile, int spalte);
    Range document.wordRangeAt(Cursor cursor);

  Gibt den Bereich des Wortes an der angegebenen Cursor-Position zurück. Der zurückgegebene Bereich ist ungültig (siehe Range.isValid()), wenn die Textposition nach dem Zeilenende liegt. Befindet sich an der angegebenen Cursor-Position kein Wort, wird ein leere Bereich zurückgegeben.

  Seit: &kde; 4.9

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

  Gibt das Zeichen an der aktuellen Cursor-Position 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 Zeichenfolge 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 Zeichenfolge zurückgegeben.

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

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

    bool document.matchesAt(int line, int column, String text);
    bool document.matchesAt(Cursor cursor, String text);

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

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

  Gibt `true` zurück, 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` zurück, 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 angegebene Zeile an der Spalte oder an der Cursor-Position ab. War das erfolgreich, wird `true` zurückgegeben, oder `false`, wenn die angegeben Zeile nicht im Bereich des Dokuments liegt.

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

  Fügt den text an der angegebenen Cursor-Position 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.

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

  Bricht die Zeile an der angegebenen Cursor-Position um. War das erfolgreich, wird `true` zurückgegeben, ansonsten `false`, &eg; wenn die angegeben Zeilennummer < 0 ist.

  Seit: &kde; 4.9

    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.

    bool document.isLineModified(int zeile);

  Gibt `true` zurück, wenn die zeile noch nicht gespeicherte Daten enthält.

  Seit: &kde; 5.0

    bool document.isLineSaved(int zeile);

  Gibt `true` zurück, wenn zeile geändert und das Dokument gespeichert wurde. Folglich enthält die aktuelle Zeile keine ungesicherten Daten.

  Seit: &kde; 5.0

    bool document.isLineTouched(int zeile);

  Gibt `true` zurück, wenn zeile ungesicherte Daten enthält oder geändert wurde.

  Seit: &kde; 5.0

    void document.findTouchedLine(int startZeile, bool nach unten);

  Suche nach der nächsten Zeile, die ungesicherte Daten enthält oder geändert wurde. Die Suche wird in der startZeile begonnen und in der Richtung durchgeführt, die in nach unten angegeben ist.

  Seit: &kde; 5.0

    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 Cursor-Position 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 Cursor-Position 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.

    Range document.documentRange();

  Gibt einen Bereich zurück, der dass gesamte Dokument umfasst.

    Cursor documentEnd();

  Gibt einen Cursor zurück, der an der letzten Spalte in der letzten Zeile des Dokuments positioniert ist.

    bool isValidTextPosition(int zeile, int spalte);
    bool isValidTextPosition(Cursor cursor);

  Gibt `true` zurück, wenn der Cursor an eine gültigen Position innerhalb eines Textes positioniert ist. Eine Textposition ist nur dann gültig, wenn der Cursor am Anfang, in der Mitte oder am Ende einer gültigen Zeile positioniert ist. Weiterhin ist eine Textposition ungültig, wenn diese in einem Unicode-Surrogat liegt.

  Seit: &kde; 5.0

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

  Gibt das Attribut an der aktuellen Cursor-Position 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 Cursor-Position 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 Cursor-Position 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 Zeichenfolge zurückgegeben.

    void document.setVariable(String key, String value);

  Setzt den Wert der angefragten Dokumentvariablen key.

  Siehe auch: Kate-Dokumentvariable

  Seit: &kde; 4.8

    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 reale Cursor-Position in eine virtuelle Cursor-Position um und gibt entweder einen „int“-Wert oder ein Cursor-Objekt zurück.

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

  Wandelt die angegebene virtuelle Cursor-Position in eine reale Cursor-Position um und gibt entweder einen „int“-Wert oder ein Cursor-Objekt zurück.

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

  Sucht rückwärts nach dem angegebenen 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 Cursor-Position benutzt wird.

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

  Gibt `true` zurück, wenn das Attribut an der angegeben Cursor-Position 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 Cursor-Position `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 Cursor-Position `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 Cursor-Position `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 Cursor-Position `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 Cursor-Position `dsOthers` ist, sonst `false`.

#### Die Programmschnittstelle zum Editor

Zusätzlich zur Programmierschnittstelle für das Dokument und die Ansicht gibt es eine weitere Schnittstelle mit Funktionen für Skripte des Editors.

    String editor.clipboardText();

  Gibt den aktuellen Text aus der globalen Zwischenablage zurück.

  Seit &kde-frameworks; 5.50

    String editor.clipboardHistory();

  Der Editor enthält den Verlauf der Zwischenablage mit bis zu 10 Eintragen. Diese Funktion gibt alle Einträge zurück, die aktuell im Verlauf der Zwischenablage vorhanden sind.

  Seit &kde-frameworks; 5.50

    void editor.setClipboardText(String text);

  Setzt den Inhalt der Zwischenablagen auf den Wert text, der auch zum Verlauf hinzugefügt wird.

  Seit &kde-frameworks; 5.50