Kleurenthema's worden opgeslagen in bestanden in JSON-formaat, met de extensie .theme.

In de broncode van KSyntaxHighlighting zijn de JSON bestanden van ingebouwde thema's gelokaliseerd in de map data/themes/. Merk op dat in tekstbewerkers, de ingebouwde thema's gecompileerd zijn in de bibliotheek van KSyntaxHighlighting, de manier van toegang naar hen is via de broncode of door ze exporteren uit de GUI om thema's van KTextEditor te beheren.

Het is ook mogelijk om gemakkelijk extra of aangepaste thema's toe te voegen, die geladen worden uit het bestandssysteem. Bestanden met door de gebruiker aangepaste themabestanden zijn gelokaliseerd in de map org.kde.syntax-highlighting/themes/ in uw gebruikersmap, die u kunt vinden met het commando qtpaths --paths GenericDataLocation en zijn gewoonlijk $HOME/.local/share/ en /usr/share/.

Voor pakketten uit Flatpak en Snap zal de bovenstaande map niet werken omdat de gegevenslocatie verschillend is voor elke toepassing. In een Flatpak toepassing is de locatie van aangepaste themabestanden gewoonlijk $HOME/.var/app/flatpak-pakketnaam/data/org.kde.syntax-highlighting/themes/ en in een Snap toepassing is die locatie $HOME/snap/snap-pakketnaam/current/.local/share/org.kde.syntax-highlighting/themes/.

In Windows® zijn deze bestanden gelokaliseerd in %USERPROFILE%\AppData\Local\org.kde.syntax-highlighting\themes. %USERPROFILE% wordt gewoonlijk C:\Users\gebruikersnaam.

Samenvattend, voor de meeste configuraties is de aangepaste map met thema's als volgt:

Als meerdere themabestanden bestaan met dezelfde naam, zal het bestand met de hoogste revisie worden geladen.

De structuur van een JSON-bestand wordt uitgelegd op hun website. In de basis bestaat een JSON-bestandsformaat uit:

De naamgeving “sleutel”, “waarde”, “object” en “array” zullen in dit artikel gebruikt worden. Als dit uw eerste keer is van werken met JSON-bestanden, ze begrijpen is zo eenvoudig als naar de onderstaande voorbeelden kijken.

Het hoofdobject van het JSON-bestand met kleurenthema bevat de volgende schemasleutels:

De taal JSON ondersteunt geen commentaar. U kunt echter de optionele sleutel _comments in het hoofdobject gebruiken om commentaar te schrijven, bijvoorbeeld, als u een bestaand thema aanpast kunt u de URL van de originele opslagruimte er in zetten. De meest praktische manier is om een array van tekens te gebruiken.

Hier onder is een voorbeeldbestand voor het thema “Breeze Light”. U kunt zien dat, om te vermijden dat het voorbeeld te groot is, dat de kleuren van de bewerker en objecten met tekststijlen niet alle vereiste sleutels bevatten. U kunt het volledige archief van het thema “Breeze Light” zien in de opslagruimte KSyntaxHighlighting.

{
    "_comments": [
        "Dit is commentaar.",
        "Als dit thema een aanpassing is van een ander, zet de koppeling naar de originele opslagruimte hier."
    ],
    "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",
        De andere kleursleutels van de bewerker...

    },
    "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"
        },
        De andere tekststijlsleutels...

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

Het JSON-object van de metagegevens sleutel bevat relevante informatie over het thema. Dit object heeft de volgende sleutels:

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

Komt overeen met de kleuren van het tekstbewerkingsgebied.

In het JSON themabestand, heeft de respectievelijke sleutel editor-colors als waarde een object waar elke sleutel refereert naar een kleurattribuut van de tekstbewerker. Hier zijn alle beschikbare sleutels verplicht, hun waarden zijn tekenreeksen met hexadecimale kleurcodes, zoals “#00B5CF”.

In de GUI om thema's van KTextEditor te beheren kunnen deze attributen gewijzigd worden in het tabblad Kleuren.

De beschikbare sleutels zijn als volgt; de sleutels gebruikt in het JSON bestand staan in de lijst vet, de namen gebruikt in de GUI worden getoond in ronde haakjes.

De standaard stijlen voor tekst zijn dezelfde als de stijlen voor geaccentueerde tekst, waardoor de editor tekst op een hele consistente manier kan presenteren. Zo wordt bijvoorbeeld voor commentaartekst dezelfde stijl gebruikt in bijna alle opmaakprofielen die kunnen worden geaccentueerd door KSyntaxHighlighting.

In het JSON-bestand heeft de respectievelijke sleutel text-styles als waarde een object waar elke sleutel overeenkomt met de naam van een standaard tekststijl, die gelijk zijn aan die gebruikt in de definities voor syntaxisaccentuering. Hier zijn, alle beschikbare tekststijlsleutels verplicht, deze staan onderstaand in een lijst.

"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"
    },
    De andere tekststijlsleutels...
}

In de GUI om kleurenthema's van KTextEditor te beheren kunnen deze attributen gewijzigd worden in het tabblad Standaard teksttstijlen. De naam in de lijst met stijlen gebruikt de stijl geconfigureerd voor het item, waarmee u een onmiddellijk voorbeeld krijgt bij het configureren van een stijl. Elke stijl laat u gemeenschappelijke attributen selecteren evenals voor- en achtergrondkleuren. Om een achtergrondkleur niet in te stellen, klik rechts om het contextmenu te gebruiken.

De beschikbare tekststijlsleutels zijn als volgt; de sleutels gebruikt in het JSON bestand staan in de lijst vet, de namen gebruikt in de GUI worden getoond in ronde haakjes, als ze anders zijn.

Hier kunt u tekststijlen instellen voor een specifieke definitie voor syntaxisaccentuering, overschrijvend de standaard tekststijl beschreven in de vorige sectie.

In het JSON themabestand correspondeert dit met de sleutel custom-styles, waarvan de waarde een object is waar elke subschemasleutel overeenkomt met de naam van een definitie voor syntaxisaccentuering. Zijn waarde is een object waar elke sleutel refereert naar de stijlattribuutnaam gedefinieerd in de elementen itemData van het XML-bestand met syntaxisaccentuering en de respectievelijke waarde een sub-object is met de sleutels text-color, selected-text-color, bold, italic, underline, strike-through, background-color en selected-background-color, gedefinieerd in de vorige sectie. Elk van deze waarden zijn optioneel, omdat als ze niet aanwezig zijn, de stijl ingesteld in text-styles wordt beschouwd.

In dit stukje code, bijvoorbeeld, heeft de definitie voor “ISO C++” syntaxisaccentuering een speciale tekststijl voor de attributen “Type Modifiers” en “Standard Classes”. In het overeenkomstige XML-bestand “isocpp.xml” gebruikt het gedefinieerde attribuut “Standard Classes” de standaard stijl BuiltIn (of dsBuiltIn). In dit attribuut wordt alleen de waarde van text-color overschreven door de nieuwe kleur “#6431b3”.

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

In de GUI om thema's van KTextEditor te beheren kunnen deze attributen gewijzigd worden in het tabblad Tekststijlen voor accentueren. Standaard selecteert het module voor accentueren van het huidige document voor. U zult opmerken dat veel accentuering andere accentuering representeert door groepen in de lijst met stijlen. De meeste accentueringen importeren de accentuering “Alert” en veel broncodeformaten importeren de accentuering “Doxygen”.

Om een nieuw thema aan te maken is het eerst noodzakelijk om een bestaande te kopiëren. Selecteer een bestaand thema die u als basis wilt gebruiken, zoals “Breeze Light” of “Breeze Dark” en klik op Kopiëren. Schrijf daarna een naam voor het nieuwe thema.

Als u een ingebouwde of alleen-lezen thema wilt wijzigen, moet u het eerst kopiëren onder een andere naam.

U kunt een geselecteerd thema (inclusief ingebouwden) exporteren naar een JSON-bestand met extensie .theme, met de knop Exporteren. Dit zal een dialoog openen om het bestand op te slaan. Om een kleurenthema uit een extern JSON-bestand toe te voegen, druk gewoon op de knop Importeren en selecteer het bestand .theme uit de dialoog.

Een belangrijk aspect bij werken met kleurenthema's is een tekstcontrast te kiezen dat het gemakkelijk maakt om te lezen, speciaal in combinatie met de achtergrond.

De toepassing Kontrast is een controleur op kleurcontrast. Het vertelt dat de combinaties van tekstkleur en achtergrondkleur leesbaar en toegankelijk zijn, dit is dus een uitstekend hulpmiddel om u te helpen bij het maken van kleurenthema's.

U kunt Kontrast downloaden uit de website voor KDE toepassingen of uit het Flatpak pakket op Flathub (alleen in GNU/Linux).

De Contrast toepassing van GNOME is vergelijkbaar. U kunt het Flatpak pakket op Flathub downloaden (alleen in GNU/Linux).

Een python script in Opslagruimte voor syntaxisaccentuering laat u alle kleuren in een theme zien, evenals het contrast met de verschillende geconfigureerde achtergronden.

KSyntaxHighlighting omvat meer dan 300 definities voor syntaxisaccentuering, het is daarom ideaal dat u nagaat dat uw nieuwe thema er goed uitziet in alle definities voor syntaxisaccentuering. De ingebouwde kleurenthema's hebben de volgende te volgen gelijkenissen die aanbevolen zijn (maar niet verplicht) om een juiste weergave van alle definities voor syntaxisaccentuering te verkrijgen:

De meeste syntaxisaccentueringen zijn bedoeld om er goed uit te zien met de standaard thema's “Breeze Light” en “Breeze Dark”, een andere manier om consistentie te behouden is om soortgelijke kleuren in de tekststijlen te gebruiken, zoals groen voor “Preprocessor” en “Overigen”, blauw voor “Gegevenstype” en “Attribuut” of paars voor “Functie”.

Merk op dat deze aanbevelingen niet verplicht zijn bij aanmaken en publiceren van een thema.