Einstellungen mit Dokumentvariablen

KatePart Variablen sind KatePart Dokumentvariablen, ähnlich der Modelines in Emacs und Vi. In Katepart haben die Dokumentvariablen das folgende Format: kate: VARIABLENAME VALUE; [ VARIABLENAME VALUE; ... ]. Die Zeilen können natürlich auch in einem Kommentar stehen, wenn das Format des Dokuments Kommentare beinhaltet. Variablennamen sind einzelne Wörter ohne Zwischenräume und alles bis zum nächsten Semikolon sind Werte. Das Semikolon ist vorgeschrieben.

Hier ein Beispiel für eine Variablenzeile, die die Einrückung für Quelltext in C++, Java oder Javascript einschaltet:

// kate: replace-tabs on; indent-width 4; indent-mode cstyle;

Anmerkung

Nur die ersten und letzten 10 Zeilen eines Dokuments werden nach Dokumentvariablen durchsucht.

Zusätzlich können Dokumentvariablen in eine Datei mit dem Namen .kateconfig in jedem beliebigen Ordner geschrieben werden. Die Einstellungen dieser Dokumentvariablen werden so verwendet, als wenn sie als Modelines in jeder Datei im Ordner und allen Unterordnern eingefügt wären. Dokumentvariablen in .kateconfig verwenden die gleiche Syntax wie Modelines, aber mit zusätzlichen Optionen.

Es gibt Variablen für fast alle Einstellungen in KatePart. Außerdem können Module Variablen benutzen. In diesem Fall sind sie in der Dokumentation der Module dokumentiert.

KatePart kann Einstellungen aus .editorconfig-Dateien einlesen, wenn die Bibliothek editorconfig installiert ist. KatePart sucht immer automatisch nach einer Datei mit dem Namen .editorconfig, wenn Sie ein Dokument öffnen. Allerdings werden die Einstellungen aus .kateconfig-Dateien zuerst benutzt.

Wie KatePart Variablen benutzt

Beim Einlesen der Einstellungen werden von katepart

  • die globalen Einstellungen,

  • optionale Daten zur aktuellen Sitzung,

  • die Einstellungen zum Dateityp,

  • Dokumentvariablen in .kateconfig,

  • Variablen im Dokument selbst,

  • Einstellungen während der aktuellen Sitzung über das Menü oder die Befehlszeile

in der angegebenen Reihenfolge gelesen und angewendet. Wie Sie sehen, werden Dokumentvariablen nur durch Änderungen zur Laufzeit überschrieben. Immer wenn ein Dokument gespeichert wird, werden die Dokumentvariablen neu eingelesen und überschreiben dann von der Befehlszeile oder über das Menü vorgenommene Einstellungsänderungen.

Jede hier nicht beschriebene Variable ist im Dokument gespeichert und kann durch andere Objekte wie Erweiterungen abgefragt werden, die diese Variablen für ihre eigenen Zwecke setzen können. Zum Beispiel nutzt der Modus für die Variablenbasierte-Einrückung Dokumentvariablen zum Speichern der Einstellungen.

Die hier beschriebenen Variablen sind in KatePart Version 5.38 enthalten. Es werden in der Zukunft sicher weitere Variablen hinzugefügt werden. Es gibt drei Typen von Variablen mit den folgenden gültigen Werten:

  • BOOL - on|off|true|false|1|0

  • INTEGER - eine ganze Zahl

  • STRING - alles andere

Verfügbare Variablen

auto-brackets [BOOL]

Automatischen Einfügen von Klammern aktivieren.

auto-center-lines [INT]

Setzt die Anzahl der automatisch zentrierten Zeilen.

background-color [STRING]

Setzt die Hintergrundfarbe des Dokuments. Der Wert muss als gültige Farbe ausgewertet werden können, also z. B. #ff0000.

backspace-indents [BOOL]

Schaltet die Verringerung des Einrückens beim Drücken der Taste Rücktaste ein oder aus.

block-selection [BOOL]

Schaltet die Blockauswahl ein und aus.

bom | byte-order-mark | byte-order-marker [BOOL]

Schaltet die Markierung für die Bytereihenfolge (BOM) ein und aus, wenn Dokumente in einem Unicodeformat (utf8, utf16, utf32) gespeichert werden.

Ab Version: Kate 3.9 (KDE 4.9)

bracket-highlight-color [STRING]

Setzt die Hintergrundfarbe für die Hervorhebung von Klammern. Der Wert muss als gültige Farbe ausgewertet werden können, also z. B. #ff0000.

current-line-color [STRING]

Setzt die Farbe für die aktuelle Zeile. Der Wert muss als gültige Farbe ausgewertet werden können, also z. B. #ff0000.

default-dictionary [STRING]

Legt das Standardwörterbuch für die Rechtschreibprüfung fest.

Ab Version: Kate 3.9 (KDE 4.9)

dynamic-word-wrap [BOOL]

Schaltet den dynamischen Zeilenumbruch ein und aus.

eol | end-of-line [STRING]

Setzt das Format für das Zeilenende. Gültige Werte hierfür sind: unix, mac und dos.

folding-markers [BOOL]

Schaltet die Anzeige von Quelltextausblendungen ein und aus.

folding-preview [BOOL]

Vorschau der Text-Ausblendung am Editor-Rand anzeigen

font-size [INT]

Setzt die Schriftgröße des Dokuments.

font [STRING]

Setzt die Schriftart des Dokuments . Der Wert muss eine gültige Schriftart bezeichnen, also z. B. courier.

hl | syntax [STRING]

Setzt den Hervorhebungsmodus. Es können alle Namen, die auch in den Menüs vorhanden sind, verwendet werden. z.B für C++ benutzen Sie einfach C++.

icon-bar-color [STRING]

Setzt die Farbe des Symbolrandes. Der Wert muss als eine gültige Farbe übersetzt werden können, also z. B. #ff0000.

icon-border [BOOL]

Schaltet die Anzeige des Symbolrandes ein und aus.

indent-mode [STRING]

Setzt den Modus für das automatische Einrücken. Die Einstellungen normal, cstyle, haskell, lilypond, lisp, python, ruby und xml sind möglich. Sehen Sie unter Automatisches Einrücken benutzen für Einzelheiten nach.

indent-pasted-text [BOOL]

Aktiviert/deaktiviert die Anpassung der Einrückung von Text, der aus der Zwischenablage eingefügt wird

Ab Version: Kate 3.11 (KDE 4.11)

indent-width [INT]

Setzt die Breite der Einrückung.

keep-extra-spaces [BOOL]

Legt fest, ob zusätzliche Leerzeichen bei der Berechnung der Einrückungweite beibehalten werden.

line-numbers [BOOL]

Schaltet die Anzeige der Zeilennummern ein und aus.

newline-at-eof [BOOL]

Fügt beim Speichern des Dokuments eine leere Zeile am Ende der Datei (EOF) an.

Ab Version: Kate 3.9 (KDE 4.9)

overwrite-mode [BOOL]

Schaltet den Überschreibmodus ein und aus.

persistent-selection [BOOL]

Schaltet die durchgehende Auswahl ein und aus.

replace-tabs-save [BOOL]

Schaltet das Ersetzen von Tabulatoren durch Leerzeichen beim Speichern des Dokuments ein und aus.

replace-tabs [BOOL]

Schaltet das sofortige Ersetzen von Tabulatoren durch Leerzeichen ein und aus.

remove-trailing-spaces [STRING]

Entfernt Leerzeichen am Zeilenende beim Speichern des Dokuments. Gültige Optionen sind:

  • none, - or 0: Leerzeichen am Zeilenende nie entfernen.

  • modified, mod, + or 1: Leerzeichen am Zeilenende nur in geänderten Zeilen entfernen. Diese geänderten Zeilen werden durch das Zeilenänderungssystem gekennzeichnet.

  • all, * or 2: Leerzeichen am Zeilenende im gesamten Dokument entfernen.

Seit: KDE 4.10.

scrollbar-minimap [BOOL]

Textgrafik auf Bildlaufleiste anzeigen

scrollbar-preview [BOOL]

Vorschau an Bildlaufleiste anzeigen.

scheme [ZEICHENKETTE]

Setzt das Farbschema von Kate. Die Zeichenkette muss ein gültiger Name für ein Farbschema sein, sonst wird diese Einstellung ignoriert.

selection-color [STRING]

Setzt die Farbe für ausgewählten Text. Der Wert muss als gültige Farbe ausgewertet werden können, also z. B. #ff0000.

show-tabs [BOOL]

Schaltet die Anzeige von Tabulatorzeichen ein und aus.

smart-home [BOOL]

Schaltet die intelligente Funktion der Tasten Pos1 und Ende ein oder aus.

tab-indents [BOOL]

Schaltet das Einrücken mit der Tabtaste ein und aus.

tab-width [INT]

Setzt die angezeigte Weite für ein Tabulatorzeichen.

undo-steps [INT]

Setzt die Anzahl der gespeicherten Schritte für die Funktion Rückgängig.

Anmerkung: Ab Version Kate 3 in KDE4 wird diese Variable ignoriert. Die maximale Anzahl von Schritten für Rückgängig ist unbegrenzt.

word-wrap-column [INT]

Setzt die Zeilenlänge für den Statischen Zeilenumbruch.

word-wrap-marker-color [STRING]

Setzt die Farbe für Zeilenumbruchmarkierungen. Der Wert muss als gültige Farbe ausgewertet werden können, also z. B. #ff0000.

word-wrap [BOOL]

Schaltet den statischen Zeilenumbruch ein und aus.

Zusätzliche Optionen in .kateconfig-Dateien

KatePart sucht nach einer .kateconfig-Datei nur in lokalen Dateien, nicht in Dateien auf anderen Rechnern. Außerdem können Optionen für Platzhalter (Dateierweiterungen) wie folgt eingestellt werden:

kate: tab-width 4; indent-width 4; replace-tabs on;
kate-wildcard(*.xml): indent-width 2;
kate-wildcard(Makefile): replace-tabs off;

In diesem Beispiel wird für alle Dateien eine Tabulatorweite von vier Leerzeichen, eine Einrückungstiefe von vier Leerzeichen verwendet und Tabulatoren werden durch Leerzeichen ersetzt. Bei allen *.xml-Dateien wird jedoch eine Einrückungstiefe von zwei Leerzeichen benutzt., außerdem in Make-Dateien nur Tabulatoren, d. h. sie werden nicht durch Leerzeichen ersetzt.

Platzhalter werden durch Semikolon getrennt, d. h. Sie können auch mehrere Erweiterungen wie im nächsten Beispiel angeben:

kate-wildcard(*.json;*.xml): indent-width 2;

Weiterhin können Sie MIME-Typen auch zur Erkennung bestimmter Dateien benutzen. Um z. B. alle Dateien mit C++-Quelltexten mit vier Leerzeichen ein zu rücken, verwenden Sie:

kate-mimetype(text/x-c++src): indent-width 4;

Anmerkung

Außer in .kateconfig-Dateien können Dokumentvariablen mit Platzhaltern und MIME-Typen auch in Dateien direkt als Kommentare benutzt werden.