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:

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

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

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.

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

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

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

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

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.

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.

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

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.

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-sXML-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"
        }
    }
}

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“.

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.

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.

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

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:

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.