set-tab-width {INTEGER Weite}

Setzt die Tabulatorweite auf Weite.

set-indent-width {INTEGER Weite}

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

set-word-wrap-column {INTEGER Weite}

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

set-icon-border {BOOLEAN enable}

Schaltet die Anzeige des Symbolrandes ein und aus.

set-folding-markers {BOOLEAN enable}

Schaltet die Markierungen für die Quelltextausblendung ein und aus.

set-line-numbers {BOOLEAN enable}

Schaltet die Zeilennummerierung ein und aus.

set-replace-tabs {BOOLEAN enable}

Wenn eingeschaltet, werden Tabulatorzeichen durch Leerzeichen ersetzt.

set-remove-trailing-space {BOOLEAN enable}

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

set-show-tabs {BOOLEAN enable}

Wenn eingeschaltet, werden Tabulatorzeichen und vorangestellte Leerzeichen durch kleine Punkte dargestellt.

set-show-indent {BOOLEAN enable}

Wenn eingeschaltet, wird die Einrückung durch eine punktierte Linie dargestellt.

set-indent-spaces {BOOLEAN enable}

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

set-mixed-indent {BOOLEAN enable}

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

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

set-word-wrap {BOOLEAN enable}

Schaltet dynamischen Zeilenumbruch ein oder aus.

set-replace-tabs-save {BOOLEAN enable }

Wenn eingeschaltet, werden Tabulatorzeichen durch Leerzeichen ersetzt, wenn das Dokument gespeichert wird.

set-remove-trailing-space-save {BOOLEAN enable}

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

set-indent-mode {STRING name}

Setzt den Einrückungsmodus auf name. Wenn name nicht angegeben ist oder ein ungültiger Name verwendet wurde, wird der Modus ‚Kein(none)‘ gesetzt. Verfügbare Modi sind: 'none', 'normal', 'cstyle', 'haskell', 'lilypond', 'lisp', 'python', 'ruby' und 'xml'.

set-auto-ident {BOOLEAN script}

Aktiviert oder deaktiviert die automatische Einrückung.

set-highlight {STRING highlight}

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

reload-scripts

Lädt alle von Kate benutzten JavaScript-Skripte neu, einschließlich der Skripte für die Befehlszeile und Einrückung.

set-mode {STRING mode}

Setzt das Dateityp-Schema für das aktuelle Dokument.

nn[oremap] {STRING original} {STRING mapped}

Weist den Kurzbefehl original dem Kurzbefehl mapped zu.

indent

Rückt markierten Text oder die aktuelle Zeile ein.

unindent

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

cleanindent

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

comment

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

uncomment

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

kill-line

Löscht die aktuelle Zeile

replace { STRING suchtext} {STRING replacement}

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

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

b

Rückwärts suchen.

c

Suchen ab Cursor-Position.

e

Suchen nur in markiertem Text.

r

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

s

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

p

Nachfragen vor Ersetzen des nächsten Auftretens.

w

Nur ganze Wörter erfüllen die Suchbedingung.

date {STRING format}

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

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

char {STRING identifier}

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

Beispiel 5.1. Beispiele zu char

Eingabe: char:234

Ausgabe: ê

Eingabe: char:0x1234

Ausgabe: ሴ

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

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

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

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

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

Beispiel 5.2. Ersetzen von Text in der aktuellen Zeile

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

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

Beispiel 5.3. Ersetzen von Text in der gesamten Datei

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

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

Beispiel 5.4. Ein etwas komplizierteres Beispiel

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

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

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

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

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

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

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

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

sort

Sortiert den markierten Text oder das ganze Dokument.

natsort

Sortiert den markierten Text oder das ganze Dokument in natürlicher Reihenfolge.

Beispiel 5.5. sort vs. natsort

sort(a10, a1, a2) ergibt a1, a10, a2

natsort(a10, a1, a2) ergibt a1, a2, a10

moveLinesDown

Verschiebt die markierten Zeilen nach unten.

moveLinesUp

Verschiebt die markierten Zeilen nach oben.

uniq

Entfernt doppelte Zeilen aus dem markierten Text oder dem gesamten Dokument.

rtrim

Entfernt Leerzeichen am Zeilenende aus dem markierten Text oder dem gesamten Dokument.

ltrim

Entfernt Leerzeichen am Zeilenanfang aus dem markierten Text oder dem gesamten Dokument.

join [STRING separator]

Verbindet die ausgewählten Zeilen oder das gesamte Dokument. Wahlweise kann ein Parameter mit der Definition des Trennzeichens angegeben werden, zum Beispiel join ', '

rmblank

Entfernt alle Leerzeichen aus dem markierten Text oder dem gesamten Dokument.

unwrap

Entfernt den Zeilenumbruch aus dem markierten Text oder dem gesamten Dokument.

each {STRING script}

Mit einer JavaScript-Funktion als Argument wird diese Funktion für die Liste der ausgewählten Zeilen aufgerufen und die Zeilen mit dem Rückgabewert der Funktion ersetzt

Beispiel 5.6. Verbindet die ausgewählten Zeilen

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

Oder noch kürzer:

each 'lines.join(", ")'

filter {STRING script}

Mit einer JavaScript-Funktion als Argument wird diese Funktion für die ausgewählten Zeilen aufgerufen und die Zeilen werden entfernt, bei denen die Funktion den Wert Falsch zurück gibt

Beispiel 5.7. Entfernt leere Zeilen.

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

Oder noch kürzer:

filter 'line.length > 0'

map {STRING script}

Mit einer JavaScript-Funktion als Argument wird diese Funktion für die Liste der ausgewählten Zeilen aufgerufen und die Zeile mit dem Rückgabewert der Funktion ersetzt

Beispiel 5.8. Entfernt leere Zeilen.

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

Oder noch kürzer:

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

duplicateLinesUp

Verdoppelt die ausgewählten Zeilen oberhalb der aktuellen Auswahl.

duplicateLinesDown

Verdoppelt die ausgewählten Zeilen unterhalb der aktuellen Auswahl.

goto {INT line}

Dieser Befehl setzt den Cursor auf die angegebene Zeile.

grep {STRING pattern}

Sucht im Dokument nach dem regulären Ausdruck muster. Weitere Informationen finden Sie unter Anhang A, Reguläre Ausdrücke.

find {STRING pattern}

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

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

b

Rückwärts suchen.

c

Suchen ab Cursor-Position.

e

Suchen nur in markiertem Text.

r

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

s

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

w

Nur ganze Wörter erfüllen die Suchbedingung.

ifind {STRING pattern}

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

b

Rückwärts suchen.

r

Suche nach einem regulären Ausdruck.

s

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

c

Suchen ab Cursor-Position.

w

Speichert das aktuelle Dokument.

wa

Speichert alle gerade geöffneten Dateien.

q

Schließt das aktuelle Dokument.

qa

Schließt alle geöffneten Dokumente.

wq

Speichert und schließt das aktuelle Dokument.

wqa

Speichert und schließt alle geöffneten Dokumente.

x

Speichert und schließt das aktuelle Dokument nur, wenn es geändert wurde.

x

Speichert und schließt alle geöffneten Dokument nur, wenn sie geändert wurden.

bp

Geht zum vorherigen Dokument in der Dokumentliste.

bn

Geht zum nächsten Dokument in der Dokumentliste.

new

Öffnet ein neues Dokument in waagerecht geteilter Ansicht.

vnew

Öffnet ein neues Dokument in senkrecht geteilter Ansicht.

e

Lädt das aktuelle Dokument erneut, wenn es auf dem Datenträger geändert wurde.

enew

Bearbeitet ein neues Dokument.

print

Öffnet den Druckdialog, um das aktuelle Dokument zu drucken.

Hauptbestandteile der KatePart-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 z. B. "*.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 KatePart.

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 KatePart 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>

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, (z. B. 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, z. B. 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 „Hervorhebungs-Erkennungsregeln“ 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 Ä.

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 z. B. $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, L^AT_EX-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.

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. z. B.: \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.