&TC.Hollingsworth; &TC.Hollingsworth.mail;
Johan
Thelmén

    jth@home.se

Översättare

# Utöka &katepart;

## Inledning

Som alla avancerade editorer erbjuder &katepart; en mängd sätt att utöka dess funktionalitet. Du kan skriva enkla skript för att lägga till funktionalitet med &javascript;. Till sist, när du väl har utökat &katepart;, är du välkommen att gå med och dela med dig av dina förbättringar med hela världen.

## Arbeta med syntaxfärgläggning

### Översikt

Syntaxfärgläggning är det som gör att editorn automatiskt visar text med olika stilar/färger, beroende på strängens funktion i relation till filens syfte. Till exempel i programkällkod, så kan kontrollsatser visas i fetstil, medan datatyper och kommentarer får annorlunda färg än resten av texten. Det här ökar textens läsbarhet väsentligt, och hjälper på så sätt författaren att vara effektivare och mer produktiv.

En C++ funktion i Perl, återgiven med syntaxfärgläggning.

En C++ funktion i Perl, återgiven med syntaxfärgläggning.

Samma C++ funktion, utan syntaxfärgläggning.

Samma C++ funktion, utan syntaxfärgläggning.

Av de två exemplen, vilket är lättast att läsa?

&kappname; levereras med ett flexibelt, anpassningsbart och avancerat system för att göra syntaxfärgläggning, och standarddistributionen tillhandahåller definitioner för ett brett område av programspråk, formaterings- och skriptspråk samt andra textfilformat. Dessutom kan du tillhandahålla dina egna definitioner med enkla &XML;-filer.

&kappname; detekterar automatiskt de riktiga syntaxreglerna när du öppnar en fil, baserat på filens &MIME;-typ, som avgörs av dess filändelse, eller om den inte har någon, dess innehåll. Skulle du råka ut för ett dåligt val, kan du ställa in syntaxen som används för hand med menyn Verktyg Färgläggning.

Stilarna och färgerna som används av varje syntaxfärgläggningsläge kan anpassas under fliken Färgläggnińgstextstilar i inställningsdialogrutan, medan &MIME;-typerna och filändelserna det ska användas för hanteras under fliken Lägen och filtyper.

Syntaxfärgläggning finns för att förbättra läsbarheten för riktig text, men du kan inte lita på att den validerar din text. Att markera text för syntax kan vara svårt, beroende på formatet som du använder, och i vissa fall är upphovsmännen till syntaxreglerna stolta om 98 procent av texten visas korrekt, även om du behöver en ovanlig stil för att se de felaktiga 2 procenten.

### &kappname;s syntaxfärgläggningssystem

Det här avsnittet beskriver &kappname;s syntaxfärgläggningsmekanism i mer detalj. Det är avsett för dig, om du vill veta mer om den, eller om du vill skapa och ändra syntaxdefinitioner.

#### Hur det fungerar

Så fort du öppnar en fil, är en av de första sakerna som &kappname;-editorn gör att avgöra vilken syntaxdefinition som ska användas för filen. När filens text läses in, och medan du skriver i den, så analyserar syntaxfärgläggningssystemet texten enligt reglerna som definieras i syntaxdefinitionen och markerar var i den som olika sammanhang och stilar börjar och slutar.

När du skriver in text i dokumentet, så analyseras och markeras den nya texten i farten, så att om du tar bort ett tecken som markeras som början eller slutet på ett sammanhang, så ändras stilen på den omgivande texten i enlighet med detta.

Syntaxdefinitioner som används av &kappname;s syntaxfärgläggningssystem är &XML;-filer, som innehåller

- Regler för att detektera funktionen hos text, organiserade i sammanhangsblock

- Listor med nyckelord

- Definitioner av stilobjekt

När texten analyseras utvärderas detekteringsreglerna i den ordning som de definierades, och om början på den nuvarande strängen matchar en regel, så används motsvarande sammanhang. Startpunkten i texten flyttas till den sista punkten där regeln matchade, och en ny genomgång av reglerna sker, med början i sammanhanget som anges av den matchande regeln.

#### Regler

Detekteringsreglerna är centrala för färgläggningsdetekteringssystemet. En regel är en sträng, ett tecken eller ett reguljärt uttryck som texten som ska analyseras matchas mot. Den innehåller information om vilken stil som ska användas för den delen av texten som matchar. Den kan byta arbetssammanhanget för systemet, antingen till ett sammanhang som anges explicit, eller till det föregående sammanhanget som användes av texten.

Reglerna organiseras i sammanhangsgrupper. En sammanhangsgrupp används för de huvudsakliga koncepten i formatets text, till exempel textsträngar inom citationstecken eller kommentarblock i programkällkod. Det här försäkrar att färgläggningssystemet inte behöver gå igenom alla regler när det inte är nödvändigt, och att vissa teckensekvenser i texten kan hanteras annorlunda beroende på det nuvarande sammanhanget.

Sammanhang kan skapas dynamiskt för att till exempel tillåta användning av instansspecifik data i regler.

#### Sammanhangsstilar och nyckelord

I vissa programspråk, hanteras heltal annorlunda än flyttal av kompilatorn (programmet som översätter källkoden till körbart binärformat), och det kan finnas tecken som har en särskild mening i en sträng med citationstecken. I sådana fall är det vettigt att visa dem på ett annat sätt än omgivningen så att de är lätta att identifiera när texten läses. Så även om de inte representerar speciella sammanhang, så kan de betraktas som sådana av syntaxfärgläggningssystemet, så att de kan markeras för att visas på ett annorlunda sätt.

En syntaxdefinition kan innehålla så många stilar som krävs för att täcka koncepten i det format den används för.

I många format finns det en lista på ord som representerar ett speciellt koncept. Till exempel i programspråk, så är kontrollsatser ett koncept, namn på datatyper ett annat, och inbyggda funktioner i språket ett tredje. &kappname;s syntaxfärgläggningssystem kan använda sådana listor för att detektera och markera ord i texten för att visa koncepten för textformaten.

#### Standardstilar

Om du öppnar en C++ källkodsfil, en &Java; källkodsfil och ett &HTML;-dokument i &kappname;, så ser du att även om formaten är olika, och olika ord därför väljes för särskild behandling, så är färgerna som används samma. Det här beror på att &kappname; har en fördefinierad lista med standardstilar, som används av varje individuell syntaxdefinition.

Det här gör det lätt att känna igen liknande koncept i olika textformat. Kommentarer finns till exempel i nästa alla program-, skript- eller formateringsspråk, och när de visas med samma stil i alla språk, behöver du inte stanna och tänka efter för att identifiera dem i texten.

Alla stilar i en syntaxdefinition använder en av standardstilarna. Några få syntaxdefinitioner använder fler stilar än det finns som standard, så om du ofta använder ett format, kan det vara värt att titta i inställningsdialogrutan för att se om några koncept använder samma stil. Det finns till exempel bara en standardstil för strängar, men eftersom programspråket Perl hanterar två sorters strängar, kan du utöka färgläggningen genom att ställa in dessa så att de skiljer sig något. Alla tillgängliga standardstilar förklaras senare.

### &XML; formatet för syntaxfärgläggningsdefinitioner

#### Översikt

&kappname; använder ramverket för syntaxfärgläggning från KDE Ramverk. &XML;-standardfilen för färgläggning som levereras med &kappname; kompileras normalt i syntaxfärgläggningsbiblioteket.

Det här avsnittet är en översikt av färgläggningsdefinitionernas &XML;-format. Det beskriver huvudkomponenterna och deras betydelse och användning, och går djupare in i detaljerna för detekteringsreglerna.

Den formella definitionen, som också kallas XSD finns i arkivet för syntaxfärgläggning i filen `language.xsd`.

Egna `.xml` färgläggningsdefinitionsfiler finns i `org.kde.syntax-highlighting/syntax/` i användarkatalogen som hittas med ``qtpaths``--paths GenericDataLocation`` som oftast är ``$HOME`/.local/share/` och `/usr/share/`.

För Flatpak- och Snap-paket, fungerar inte ovanstående katalog eftersom dataplatsen är olika för varje program. I ett Flatpak-program, är platsen för anpassade &XML;-filer oftast ``$HOME`/.var/app/flatpak-paketnamn/data/org.kde.syntax-highlighting/syntax/` och i ett Snap-program är platsen ``$HOME`/snap/snap-paketnamn/current/.local/share/org.kde.syntax-highlighting/syntax/`.

På &Windows; är filerna placerade i `%USERPROFILE%\AppData\Local\org.kde.syntax-highlighting\syntax`. %USERPROFILE% som oftast expanderas till `C:\Users\user`.

Sammanfattningsvis, för de de flesta konfigurationer är katalogen för anpassade &XML;-filer följande:

För lokal användare | ``$HOME`/.local/share/org.kde.syntax-highlighting/syntax/`
För alla användare | `/usr/share/org.kde.syntax-highlighting/syntax/`
För Flatpak-paket | ``$HOME`/.var/app/flatpak-paketnamn/data/org.kde.syntax-highlighting/syntax/`
För Snap-paket | ``$HOME`/snap/snap-paketnamn/current/.local/share/org.kde.syntax-highlighting/syntax/`
På &Windows; | `%USERPROFILE%\AppData\Local\org.kde.syntax-highlighting\syntax`

Om flera filer finns för samma språk, läses filen med det största värdet på attributet `version` i elementet `language` in.

##### Huvudkomponenter i &kappname;s färgläggningsdefinitioner

En syntaxfärgläggningsfil innehåller ett huvud som anger &XML;-versionen:

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

Definitionsfilens rot är elementet `language`. Följande egenskaper är tillgängliga:

  Egenskaper som krävs:

  `name` anger språkets namn. Det visas senare i menyer och dialogrutor.

  `section` anger kategorin.

  `extensions` definierar filändelser, såsom "*.cpp;*.h".

  `version` anger aktuell version av definitionsfilen i form av ett heltal. När en definitionsfil för färgläggning ändras, försäkra dig om att talet ökas.

  `kateversion` anger senaste version av &kappname; som stöds.

  Valfria egenskaper:

  `mimetype` associerar filers &MIME;-typ.

  `casesensitive` definierar om nyckelord är skiftlägeskänsliga eller inte.

  `priority` krävs om en annan syntaxfärgläggningsfil använder samma filändelse. Den högsta prioriteten vinner.

  `author` innehåller författarens namn och e-postadress.

  `license` innehåller licensen, oftast MIT-licensen för nya syntaxfärgläggningsfiler.

  `stil` innehåller språket som tillhandahålls och används av indenterare för egenskapen `required-syntax-style`.

  `indenter` definierar vilken indenterare som normalt används. Tillgängliga indenterare är:ada, normal, cstyle, cmake, haskell, latex, lilypond, lisp, lua, pascal, python, replicode, ruby och xml.

  `hidden` definierar om namnet ska visas i &kappname;s menyer.

  Nästa rad kan alltså se ut så här:

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

Därefter kommer elementet `highlighting` som innehåller det valfria elementet `list` och det nödvändiga elementen `contexts` och `itemDatas`.

  `list` element innehåller en lista med nyckelord. I det här fallet är nyckelorden class och const. Du kan lägga till så många listor som du behöver.

  Sedan KDE Ramverk 5.53 kan en lista inkludera nyckelord från en annan lista, språk eller fil, genom att använda elementet `include` element.`##` är att separera listnamnet och språkdefinitionens namn, på samma sätt som regeln `IncludeRules`. Det är användbart för att undvika att duplicera nyckelordslistor, om du behöver inkludera nyckelorden från ett annat språk eller fil. Exempelvis innehåller listan annat-namn nyckelordet str och alla nyckelorden från listan types, vilken hör till språket ISO C++.

  Elementet `contexts` innehåller alla sammanhang. Det första sammanhanget är förvalt som start för färgläggningen. Det finns två regler i sammanhanget Normal Text som matchar listan av nyckelord med namnet något-namn och en regel som detekterar ett citationstecken och byter sammanhang till string. För att lära dig mer om regler, läs nästa kapitel.

  Den tredje delen är elementet `itemDatas`. Det innehåller alla färger och teckenstilar som behövs av sammanhangen och reglerna. I det här exemplet används `itemData` Normal Text, String och Keyword.

      <highlighting>
          <list name="något-namn">
            <item> class </item>
            <item> const </item>
          </list>
          <list name="annat-namn">
            <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="något-namn" />
              <DetectChar attribute="String" context="String="annat-namn" />
              <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>

Den sista delen av färgläggningsdefinitionen är den valfria sektionen `general`. Den kan innehålla information om nyckelord, kodvikning, kommentarer, indentering, tomma rader och stavningskontroll.

  Sektionen `comment` definierar den sträng som enradskommentarer inleds med. Du kan också definiera en flerradskommentar med multiLine och den ytterligare egenskapen end. Det är användbart när användaren trycker på snabbtangenten som motsvarar kommentera/avkommentera.

  Sektionen `keywords` definierar om listor med nyckelord är skiftlägeskänsliga eller inte. Andra egenskaper förklaras senare.

  Övriga sektioner, `folding`, `emptyLines` och `spellchecking`, behövs oftast inte och förklaras senare.

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

#### Sektionerna i detalj

Den här delen beskriver alla tillgängliga egenskaper för sammanhang, itemData, nyckelord, kommentarer, kodvikning och indentering.

Elementet `context` hör till gruppen `contexts`. Själva sammanhanget definierar sammanhangsspecifika regler, som vad som ska ske om färgläggningssystemet når slutet på en rad. Tillgängliga egenskaper är:

  `name` anger sammanhangets namn. Regler använder namnet för att ange sammanhanget att byta till om regeln matchar.

  `lineEndContext` definierar sammanhanget som färgläggningssystemet byter till om det når ett radslut. Det kan antingen vara namnet på ett annat sammanhang, `#stay` för att inte byta sammanhang (dvs. göra ingenting) eller `#pop` som gör att det lämnar sammanhanget. Det är till exempel möjligt att använda `#pop#pop#pop` för att återgå tre steg, eller till och med `#pop#pop!Annat_Sammanhang` för att återgå två steg och byta till sammanhanget som heter `Annat_Sammanhang`. Det är också möjligt att byta till ett sammanhang som hör till en annan språkdefinition, på samma sätt som för reglerna `IncludeRules`, t.ex. `Något_Sammanhang##JavaScript`. Observera att det inte går att använda det här sammanhangsbytet tillsammans med `#pop`, exempelvis är `#pop!Något_Sammanhang##JavaScript` inte giltigt. Sammanhangsbyten beskrivs också i .

  `lineEmptyContex` definierar sammanhanget om en tom rad påträffas. Terminologin för sammanhangsbyte är samma som tidigare beskrivits i lineEndContext. Förval: #stay.

  `fallthroughContext` anger nästa sammanhang att byta till om ingen regel matchar. Terminologin för sammanhangsbyte är samma som tidigare beskrivits i lineEndContext. Förval: #stay.

  `fallthrough` definierar om färgläggningssystemet byter till sammanhanget som anges i `fallthroughContext` om ingen regel matchar. Observera att sedan &kde; &frameworks; 5.62 avråds användning av egenskapen, använd istället `fallthroughContext`, eftersom om egenskapen `fallthroughContext` finns förstås implicit att värdet på `fallthrough` är true. Förval: false.

  `noIndentationBasedFolding` inaktiverar indenteringsbaserad vikning i sammanhanget. Om indenteringsbaserad vikning inte är aktiverad är egenskapen meningslös. Det definieras av elementet folding i gruppen general. Förval: false.

Elementet `itemData` är i gruppen `itemDatas`. Det definierar teckenstilen och färgerna. Det är alltså möjligt att definiera egna stilar och färger. Dock rekommenderar vi att du håller dig till standardstilarna om möjligt, så att användaren alltid ser samma färger använda i olika språk. Ibland finns det dock inget annat sätt, och det är nödvändigt att ändra färg- och teckenegenskaper. Egenskapens namn och defStyleNum krävs, övriga är valfria. Tillgängliga egenskaper är:

  `name` anger namnet på itemData. Sammanhang och regler använder namnet i egenskapen attribute för att referera till itemData.

  `defStyleNum` definierar vilken standardstil som ska användas. Tillgängliga standardstilar förklaras i detalj senare.

  `color` definierar en färg. Giltiga format är '#rrggbb' eller '#rgb'.

  `selColor` definierar markeringens färg.

  `italic` om true, är texten kursiv.

  `bold` om true, är texten i fetstil.

  `underline` om true, är texten understruken.

  `strikeout` om true, är texten överstruken.

  `spellChecking` om true, stavningskontrolleras texten.

Elementet `keywords` i gruppen `general` definierar nyckelordens egenskaper. Tillgängliga egenskaper är:

  `casesensitive` kan vara true eller false. Om det är true, matchas alla nyckelord skiftlägeskänsligt.

  `weakDeliminator` är en lista med tecken som inte fungerar som ordavgränsare. Punkt `'.'` är till exempel en ordavgränsare. Med antagandet att ett nyckelord i en `list` innehåller en punkt, matchar det bara om du anger att punkten är en svag avgränsare.

  `additionalDeliminator` definierar ytterligare avgränsare.

  `wordWrapDeliminator` definierar tecken som en radbrytning kan ske efter.

  Standardavgränsare och radbrytningsavgränsare är tecknen `.():!+,-<=>%&*/;?[]^{|}~\`, mellanslag (`' '`) och tabulator (`'\t'`).

Elementet `comment` i gruppen `comments` definierar kommentaregenskaper som används för Verktyg Kommentera, Verktyg Avkommentera och Verktyg Växla kommentar. Tillgängliga egenskaper är:

  `name` är antingen singleLine eller multiLine. Om du väljer multiLine krävs egenskaperna end och region. Om du väljer singleLine kan du lägga till den valfria egenskapen position.

  `start` definierar strängen som används för att inleda en kommentar. I C++ skulle det vara "/*". Egenskapen krävs för typerna multiLine och singleLine.

  `end` definierar strängen som används för att avslutar en kommentar. I C++ skulle det vara "*/". Egenskapen är bara tillgänglig för och krävs för kommentarer av typen multiLine.

  `region` ska vara namnet på den vikbara flerraderskommentaren. Med antagandet att du har beginRegion="Comment" ... endRegion="Comment" i dina regler, ska du använda region="Comment". På så sätt fungerar avkommentering även om du inte markerar all text i en flerraderskommentar. Markören måste bara vara inne i flerraderskommentaren. Egenskapen är bara tillgänglig för typen multiLine.

  `position` definierar var enraderskommentaren infogas. Normalt placeras enraderskommentaren i början av raden på kolumn 0, men om position="afterwhitespace" används infogas kommentaren efter inledande blanktecken, precis före det första tecknet som inte är ett blanktecken. Det är användbart för att placera kommentarer korrekt i språk där indentering är viktig, såsom Python eller YAML. Egenskapen är valfri och det enda möjliga värdet är afterwhitespace. Den är bara tillgänglig för typen singleLine.

Elementet `folding` i gruppen `general` definierar kodvikningsegenskaper. Tillgängliga egenskaper är:

  `indentationsensitive` om true läggs kodvikningsmarkörerna till baserat på indentering, som i skriptspråket Python. Oftast behöver du inte ange det, eftersom det har det förvalda värdet false.

Elementet `emptyLine` i gruppen `emptyLines` definierar vilka rader som ska behandlas som tomma rader. Det gör det möjligt att ändra beteendet hos egenskapen lineEmptyContext i elementets `context`. Tillgängliga egenskaper är:

  `regexpr` definierar ett reguljärt uttryck som behandlas som en tom rad. Normalt innehåller tomma rader inte några tecken, därför lägger det här till ytterligare tomma rader, om du exempelvis vill att rader med mellanslag också ska anses vara tomma rader. Dock behöver man inte ange den här egenskapen i de flesta syntaxdefinitioner.

Elementet `encoding` i gruppen`spellchecking` definierar en teckenkodning för stavningskontroll. Tillgängliga egenskaper:

  `char`är ett kodat tecken.

  `string` är en teckenföljd som kodas som tecknet char i stavningskontrollen. Exempelvis representerar strängen `\"{A}` tecknet `Ä` i språket Latex.

#### Tillgängliga standardstilar

Standardstilar har redan förklarats. En kort sammanfattning: Standardstilar är fördefinierade stilar för teckensnitt och färger.

Allmänna standardstilar:

  `dsNormal`, när ingen särskild färgläggning krävs.

  `dsKeyword`, nyckelord för inbyggda språk.

  `dsFunction`, funktionsanrop och definitioner.

  `dsVariable`, om tillämpligt: variabelnamn (t.ex. $enVariabel i PHP eller Perl).

  `dsControlFlow`, nyckelord för kontrollflöde såsom if, else, switch, break, return, yield, ...

  `dsOperator`, operatorer såsom + - * / :: < >

  `dsBuiltin`, inbyggda funktioner, klasser och objekt.

  `dsExtension`, vanliga ändelser såsom &Qt;-klasser och funktioner eller makron i C++ och Python.

  `dsPreprocessor`, preprocessorsatser eller makrodefinitioner.

  `dsAttribute`, anmärkningar som @override och __declspec(...).

Strängrelaterade standardstilar:

  `dsChar`, enstaka tecken såsom 'x'.

  `dsSpecialChar`, tecken med speciell betydelse i strängar som undantag, ersättningar eller operatorer i reguljära uttryck.

  `dsString`, strängar såsom "hej allihop".

  `dsVerbatimString`, ordagranna eller obehandlade strängar som 'raw \backlash' i Perl, CoffeeScript och skal, samt r'\raw' i Python.

  `dsSpecialString`, SQL-satser, reguljära uttryck, HERE-dokument, &latex;-matematikläge, ...

  `dsImport`, import, inkludering och require för moduler.

Nummerrelaterade standardstilar:

  `dsDataType`, inbyggda datatyper såsom int, void, u64.

  `dsDecVal`, decimala värden.

  `dsBaseN`, värden med en bas skild från 10.

  `dsFloat`, flyttalsvärden.

  `dsConstant`, inbyggda och användardefinierade konstanter såsom PI.

Kommentar- och dokumentationsrelaterade standardstilar:

  `dsComment`, kommentarer.

  `dsDocumentation`, /** dokumentationskommentarer */ eller """dokumentsträngar""".

  `dsAnnotation`, dokumentationskommandon som @param, @brief.

  `dsCommentVar`, variabelnamnen som används i ovanstående kommandon, som "exempel" i @param exempel.

  `dsRegionMarker`, områdesmarkeringar som //BEGIN, //END i kommentarer.

Andra standardstilar:

  `dsInformation`, anmärkningar och tips som @note i doxygen.

  `dsWarning`, varningar som @warning i doxygen.

  `dsAlert`, specialord som TODO, FIXME, XXXX.

  `dsError`, färgläggning av fel och felaktig syntax.

  `dsOthers`, när ingenting annat passar in.

### Regler för syntaxdetektering

Den här sektionen beskriver reglerna för syntaxdetektering.

Varje regel kan matcha noll eller flera tecken i början av strängen som de ska testas med. Om regeln matchar, så tilldelas de matchande tecknen stilen eller egenskapen som definieras av regeln. En regel kan också begära att det nuvarande sammanhanget byts.

En regel ser ut så här:

    <Regelnamn attribute="(identifierare)" context="(identifierare)" [regelspecifika egenskaper] />

Ordet attribute identifierar stilen som ska användas för tecken som matchar med namn eller index, och context identifierar sammanhanget som ska användas i fortsättningen.

Sammanhanget kan identifieras av:

- En identifierare, som är namnet på det andra sammanhanget.

- En ordning som talar om att färgläggningen ska stanna kvar i det nuvarande sammanhanget (`#stay`), eller gå tillbaka till det föregående sammanhanget som använts i strängen (`#pop`).

  För att gå tillbaka flera steg, kan nyckelordet #pop upprepas: `#pop#pop#pop`

- En ordning följd av ett utropstecken (!) och en identifierare, som gör att färgläggningen först följer ordningen och därefter byter till det andra sammanhanget, t.ex. `#pop#pop!Annat_sammanhang`.

- En identifierare, som är ett sammanhangsnamn, följd av två nummertecken (`##`) och en annan identifierare, som är namnet på en språkdefinition. Namngivningen liknar den som används i regeln `IncludeRules` och låter dig byta till ett sammanhang som hör till en annat syntaxfärgläggningsdefinition, t.ex. `Något_Sammanhang##JavaScript`. Observera att det inte går att använda det här sammanhangsbytet tillsammans med `#pop`, exempelvis är `#pop!Något_Sammanhang##JavaScript` inte giltigt.

Regelspecifika egenskaper varierar och beskrivs i följande avsnitt.

#### Gemensamma egenskaper

Alla regler har följande egenskaper gemensamma och är tillgängliga på alla ställen `(gemensamma egenskaper)` visas. Egenskaperna attribute och context är nödvändiga, alla övriga är valfria.

- attribute: En egenskap avbildas på en definierad itemData.

- context: Anger sammanhanget som färgläggningssystemet byter till om regeln matchar.

- beginRegion: Inled ett kodvikningsblock. Förval: unset.

- endRegion: Avsluta ett kodvikningsblock. Förval: unset.

- lookAhead: Om true behandlar inte färgläggningssystemet matchningens längd. Förval: false.

- firstNonSpace: Matcha bara om strängen är den första förutom blanktecken på raden. Förval: false.

- column: Matcha bara om kolumnen matchar. Förval: unset.

#### Dynamiska regler

Vissa regler tillåter den valfria egenskapen `dynamic` med Boolesk typ, som har förvalt värde false. Om dynamic är true, kan en regel använda platsmarkörer som representerar texten som matchas av en regel med ett reguljärt uttryck som byter till nuvarande sammanhang med sin egenskap `string` eller `char`. I en `string` ersätts platsmarkören %N (där N är ett tal) med motsvarande N i det anropande reguljära uttrycket med början på 1. I en `char` måste platsmarkören vara ett tal N och det ersätts med första tecknet i motsvarande N i det anropande reguljära uttrycket. Närhelst en regel tillåter den här egenskapen, innehåller den (dynamic).

- dynamic: kan vara (true | false).

`Hur det fungerar:`

I länken för reguljärt uttryck i `RegExpr` reglerna, lagras all text inom vanliga kurvparenteser i `(MÖNSTER)` och blir ihågkomna. Sådana platsmarkörer kan användas i sammanhanget som man går till i reglerna med egenskapen `dynamic` true, med %N (i String) eller N (i char).

Det är viktigt att nämna att en text lagrad i en `RegExpr` regel bara lagras för sammanhanget som man byter till, angivet i dess egenskap `context`.

- Om platsmarkörerna inte kommer att används, varken av dynamiska regler eller i samma reguljära uttryck, ska `icke-lagrande grupper` användas: `(?:MÖNSTER)`

  Grupperna framåtreferens eller bakåtreferens såsom `(?=MÖNSTER)`, `(?!MÖNSTER)` eller `(?<=MÖNSTER)` lagras inte. Se Reguljära uttryck för mer information.

- Lagringsgrupperna kan användas inom samma reguljära uttryck, använder \N istället för %N. För mer information, se Spara text som matchar (bakåtreferenser) under Reguljära uttryck.

Exempel 1:

I det här enkla exemplet lagras texten som matchas av det reguljära uttrycket `=*` och infogas med %1 i den dynamiska regeln. Det tillåter att kommentaren slutar med samma antal `=` som i början. Det matchar text som: `[[ comment ]]`, `[=[ comment ]=]` eller `[=====[ comment ]=====]`.

Dessutom är lagrad text bara tillgänglig i sammanhanget Multi-line Comment man byter till.

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

Exempel 2:

I den dynamiska regeln motsvarar %1 platsmarkörerna `#+`, och %2 till `&quot;+`. Det matchar text som: `#beteckning""""inne i sammanhanget""""#`.

Platsmarkörerna är inte tillgängliga i andra sammanhang som OtherContext, FindEscapes eller SomeContext.

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

Exempel 3:

Det matchar text som: `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>

#### Lokala avgränsare

Vissa regler tillåter de valfria egenskaperna `weakDeliminator` och `additionalDeliminator` som kombineras med egenskaper med samma namn i taggen `keywords`. När `'%'` exempelvis är en svag avgränsare i `keywords`, kan det bli en ordavgränsare för bara en regel genom att placera det i egenskapen `additionalDeliminator`. När en regel tillåter dessa egenskaper innehåller den (local deliminators).

- weakDeliminator: lista med tecken som inte fungerar som ordavgränsare.

- additionalDeliminator definierar ytterligare avgränsare.

#### Reglerna i detalj

DetectChar

  Detektera ett enda specifikt tecken. Används ofta för att till exempel hitta slutet på strängar inom citationstecken.

      <DetectChar char="(tecken)" (gemensamma egenskaper) (dynamisk) />

  Egenskapen `char` definierar tecknet som ska matchas.

Detect2Chars

  Detektera två angivna tecken i en definierad ordning.

      <Detect2Chars char="(tecken)" char1="(tecken)" (gemensamma egenskaper) />

  Egenskapen `char` definierar det första tecknet som ska matcha, `char1` det andra.

AnyChar

  Detektera ett tecken i en angiven teckenmängd.

      <AnyChar String="(sträng)" (gemensamma egenskaper) />

  Egenskapen `String` definierar teckenmängden.

StringDetect

  Detektera en sträng exakt.

      <StringDetect String="(sträng)" [insensitive="TRUE|FALSE;"] (gemensamma egenskaper) (dynamisk) />

  Egenskapen `String` definierar strängen som ska matcha. Egenskapen `insensitive` (okänslig) är normalt `FALSE` (FALSK) och skickas med till strängjämförelsefunktionen. Om värdet är `TRUE` (SANT) så används en jämförelse som inte bryr sig om skiftläge.

WordDetect

  Detektera en exakt sträng, men kräv dessutom ordgränser som en punkt `'.'` eller ett blanktecken i början och slutet av ordet. Betrakta `\b<string>\b` som ett reguljärt uttryck, men snabbare än regeln `RegExpr`.

      <WordDetect String="(sträng)" [insensitive="TRUE|FALSE;"] (gemensamma egenskaper) (lokala avgränsare)/>

  Egenskapen `String` definierar strängen som ska matcha. Egenskapen `insensitive` (okänslig) är normalt `FALSE` (FALSK) och skickas med till strängjämförelsefunktionen. Om värdet är `TRUE` (SANT) så används en jämförelse som inte bryr sig om skiftläge.

  Sedan: &kate; 3.5 (&kde; 4.5)

RegExpr

  Matchar med ett reguljärt uttryck.

      <RegExpr String="(sträng)" [insensitive="TRUE|FALSE;"] [minimal="TRUE| FALSE"] (gemensamma egenskaper) (dynamisk) />

  Egenskapen `String` definierar det reguljära uttrycket.

  Egenskapen `insensitive` (okänslig) är normalt `FALSE` (FALSK) och skickas med det reguljära uttrycket.

  Egenskapen `minimal` är normalt `FALSE` (FALSK) och skickas med det reguljära uttrycket.

  Eftersom reglerna alltid matchas mot början av den nuvarande strängen, så anger ett reguljärt uttryck som börjar med en hatt (`^`) att regeln bara ska matchas mot radens början.

  Se Reguljära uttryck för mer information om dem.

keyword

  Detektera ett nyckelord från en angiven lista.

      <keyword String="(listnamn)" (gemensamma egenskaper) (lokala avgränsare)/>

  Egenskapen `String` identifierar en lista på nyckelord med namn. En lista med det namnet måste finnas.

  Färgläggningssystemet behandlar nyckelordsregler på ett mycket optimerat sätt. Det gör det absolut nödvändigt att alla nyckelord som ska matchas måste omges med definierade avgränsare, antingen underförstått (standardavgränsare) eller explicit definierade inne i egenskapen additionalDeliminator i taggen keywords.

  Om ett nyckelord som ska matchas måste innehålla ett skiljetecken, måste detta tecken läggas till i egenskapen weakDeliminatori taggen keywords. Detta tecken förlorar då sin avgränsningsegenskap i alla regler med keyword. Det är också möjligt att använda egenskapen weakDeliminator i keyword så att ändringen bara gäller den regeln.

Int

  Detektera ett heltal (som det reguljära uttrycket: `\b[0-9]+`).

      <Int (gemensamma egenskaper) (lokala avgränsare) />

  Den här regeln har inga specifika egenskaper.

Float

  Detektera ett flyttal (som det reguljära uttrycket: `(\b[0-9]+\.[0-9]*|\.[0-9]+)([eE][-+]?[0-9]+)?`).

      <Float (gemensamma egenskaper) (lokala avgränsare) />

  Den här regeln har inga specifika egenskaper.

HlCOct

  Detektera en oktal talrepresentation (som det reguljära uttrycket: `\b0[0-7]+`).

      <HlCOct (gemensamma egenskaper) (lokala avgränsare) />

  Den här regeln har inga specifika egenskaper.

HlCHex

  Detektera en hexadecimal talrepresentation (som det reguljära uttrycket: `\b0[xX][0-9a-fA-F]+`).

      <HlCHex (gemensamma egenskaper) (lokala avgränsare) />

  Den här regeln har inga specifika egenskaper.

HlCStringChar

  Detektera ett undantaget tecken.

      <HlCStringChar (gemensamma egenskaper) />

  Den här regeln har inga specifika egenskaper.

  Det matchar bokstavsrepresentationer av osynliga tecken som ofta används i programkod, till exempel `\n` (nyrad) eller `\t` (tabulator).

  Följande tecken matchar om de följer ett bakstreck (`\`): `abefnrtv"'?`. Dessutom matchar undantagna hexadecimala tal, som till exempel `\xff` och undantagna oktala tal, till exempel `\033`.

HlCChar

  Detektera ett C-tecken.

      <HlCChar (gemensamma egenskaper) />

  Den här regeln har inga specifika egenskaper.

  Det matchar C-tecken omgivna av apostrofer (till exempel `'c'`). Apostroferna kan innehålla ett enkelt tecken eller en teckenföljd. Se HlCStringChar för matchade teckenföljder.

RangeDetect

  Detektera en sträng med definierade start- och sluttecken.

      <RangeDetect char="(tecken)"  char1="(tecken)" (gemensamma egenskaper) />

  `char` definierar tecknet som inleder intervallet, och `char1` tecknet som avslutar intervallet.

  Användbar för att till exempel detektera små strängar inom citationstecken och liknande, men observera att eftersom färgläggningen arbetar med en rad i taget, så hittar det inte strängar som fortsätter på nästa rad.

LineContinue

  Matchar ett angivet tecken vid radens slut.

      <LineContinue (gemensamma egenskaper) [char="\"] />

  Egenskapen `char` definierar valfritt tecken som ska matchas, förval är bakstreck (`'\'`). Ny sedan &kde; 4.13.

  Regeln är användbar för att byta sammanhang vid radslut. Det behövs till exempel i C/C++ för att fortsätta makron eller strängar.

IncludeRules

  Inkludera regler från ett annat sammanhang eller språk/fil.

      <IncludeRules context="sammanhangslänk" [includeAttrib="true|false"] />

  Egenskapen `context` definierar vilket sammanhang som ska inkluderas.

  Om den är en enkelt sträng innehåller den alla definierade regler i det nuvarande sammanhanget, till exempel:

      <IncludeRules context="annat-sammanhang" />

  Om strängen innehåller `##` letar färgläggningssystemet efter ett sammanhang från en annan språkdefinition med angivet namn, exempelvis skulle

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

  inkludera sammanhanget String från färgläggningsdefinitionen av C++.

  Om egenskapen `includeAttrib` är true, ändras målegenskapen till källans egenskap. Det krävs till exempel för att kommentarer ska fungera om text som matchas av det inkluderade sammanhanget har en annan färgläggning än värdsammanhanget.

DetectSpaces

  Detektera blanktecken.

      <DetectSpaces (gemensamma egenskaper) />

  Den här regeln har inga specifika egenskaper.

  Använd den här regeln om du vet att det kan finnas flera blanktecken framför, till exempel i början av indenterade rader. Regeln hoppar över alla blanktecken på en gång, istället för att prova flera regler och hoppa över en åt gången eftersom den inte matchar.

DetectIdentifier

  Detektera strängar för identifierare (som det reguljära uttrycket: `[a-zA-Z_][a-zA-Z0-9_]*`).

      <DetectIdentifier (gemensamma egenskaper) />

  Den här regeln har inga specifika egenskaper.

  Använd den här regeln för att hoppa över en sträng med ordtecken på en gång, istället för att testa den med flera regler och hoppa ett steg i taget beroende på att ingenting matchar.

#### Tips och trick

När du väl har förstått hur sammanhangsbyte fungerar blir det enkelt att skriva färgläggningsdefinitioner. Du bör ändå kontrollera noggrant vilken regel du väljer i vilken situation. Reguljära uttryck är mycket kraftfulla, men de är långsamma jämfört med andra regler. Du bör därför ta hänsyn till följande tips.

- Om du bara matchar två tecken, använd `Detect2Chars` istället för `StringDetect`. Samma sak gäller för `DetectChar`.

- Reguljära uttryck är enkla att använda, men oftast finns det ett annat mycket snabbare sätt att uppnå samma resultat. Antag att du bara vill matcha tecknet `'#'` om det är det första tecknet på en rad. En lösning baserad på reguljära uttryck skulle se ut så här:

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

  Du kan uppnå samma sak mycket snabbare med:

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

  Om du vill matcha det reguljära uttrycket `'^#'` kan du fortfarande använda `DetectChar` med egenskapen `column="0"`. Egenskapen `column` räknar tecken, så en tabulator är bara ett tecken.

- Använd egenskapen `column="0"` i `RegExpr` reglerna om mönstret `^MÖNSTER` kommer att användas för att matcha text i början av en rad. Det förbättrar prestanda, eftersom det undviker sökning efter matchningar i resten av kolumnerna.

- Använd icke-lagrande grupper `(?:MÖNSTER)` istället för lagrande grupper `(MÖNSTER)`, om platsmarkörerna inte kommer att användas i samma reguljära uttryck eller i dynamiska regler. Det undviker att platsmarkörer lagras i onödan.

- Du kan byta sammanhang utan att behandla tecken. Antag att du vill byta sammanhang när du stöter på strängen `*/`, men måste behandla denna sträng i nästa sammanhang. Regeln nedan matchar, och egenskapen `lookAhead` gör att färgläggningen behåller den matchade strängen för nästa sammanhang.

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

- Använd `DetectSpaces` om du vet att många blanktecken förekommer.

- Använd `DetectIdentifier` instället för ett reguljärt uttryck `'[a-zA-Z_]\w*'`.

- Använd standardstilar överallt du kan. På så sätt finner användaren en bekant miljö.

- Titta i andra &XML;-filer för att se hur andra implementerade knepiga regler.

- Det går att validera alla &XML;-filer genom att använda kommandot `validatehl.sh language.xsd min-syntax.xml`. Filerna `validatehl.sh` och `language.xsd` är tillgängliga i arkivet för syntaxfärgläggning.

- Om du mycket ofta upprepar komplexa reguljära uttryck kan du använda ENTITETER. Till exempel:

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

  Nu kan du använda &myref; istället för det reguljära uttrycket.

## Arbeta med färgteman

### Översikt

Färgteman definierar färgerna i textredigeringsområdet och syntaxfärgläggningen. Ett färgtema omfattar följande:

- Textstilen, använd för syntaxfärgläggning via förvalda stilegenskaper. Exempelvis textfärgen och den markerade textfärgen.

- Textredigeringsområdets bakgrund, inklusive textmarkeringen och aktuell rad.

- Textområdets ikonkant: deras bakgrund, separationslinjen, radnumren, markörerna för radbrytning, de modifierade radmarkörerna och kodvikningen.

- Textdekorationer såsom sökmarkörerna, indenteringen och radmarkörer för tabulator och mellanslag, parentesmatchningen och stavningskontrollen.

- Bokmärken och textsnuttar

För att undvika förvirring, följande är omfattas inte:

- Teckensnittstypen och teckenstorleken.

- Textredigeringsprogrammets färger, såsom rullningslistens avbildning, menyerna, flikraden, fönsterfärgen, etc. I &kde;-program, såsom &kate; eller &kdevelop; definieras de här färgerna av `&kde; &plasma; globala färgschema`, som ställs in i modulen Färger i systeminställningarna eller från programmet själv i menyn Inställningar Färgschema.

Breeze Light och Breeze mörk färgteman med C++ syntaxfärgläggning.

Breeze Light och Breeze mörk färgteman med C++ syntaxfärgläggning.

### Färgteman i KSyntaxHighlighting

Ramverket KSyntaxHighlighting, som är gränssnittet för syntaxfärgläggning, är biblioteket som `tillhandahåller och hanterar färgteman`. Det är en del av &kde; Ramverk och används i &kde;:s texteditorer såsom &kate;, &kwrite;, &kile; och &kdevelop;. Beroendet ser ut på följande sätt:

Beroende av texteditorer i &kde; Ramverk 5 biblioteken.

Beroende av texteditorer i &kde; Ramverk biblioteken.

KSyntaxHighlighting inkluderar ett antal inbyggda teman som visas på sidan Färgteman på Kate editorns webbplats.

Ramverket KTextEditor, som är textredigeringsgränssnittet, tillhandahåller ett användargränssnitt för att skapa och redigera färgteman, inklusive ett verktyg för att exportera och importera teman. Det är det enklaste sättet att skapa och redigera dem, och du kan komma åt det från dialogrutan Anpassa i texteditorn. Mer detaljerad information finns i .

Grafiskt användargränssnitt för att hantera färgteman i &kate;s inställningar.

Grafiskt användargränssnitt för att hantera färgteman i &kate;s inställningar.

Det är viktigt att nämna att i &kde; texteditorer som &kate; eller &kdevelop;, används KSyntaxHighlighting färgteman sedan &kde; Ramverk 5.75, utgivet 10:e oktober, 2020. Tidigare, användes &kate;s färgscheman (KConfig baserad schemainställning) och avråds nu från. Dock är det möjligt att konvertera de gamla &kate; schema till KSyntaxHighlighting färgteman. Arkivet KSyntaxHighlighting inkluderar skriptet `utils/kateschema_to_theme_converter.py` och verktyget `utils/schema-converter/` i det syftet.

### &JSON;-format för färgteman

#### Översikt

Färgteman lagras i filer med &JSON;-format, med filändelsen `.theme`.

I källkoden för KSyntaxHighlighting, finns &JSON;-filerna för inbyggda teman i katalogen `data/themes/`. Observera att i texteditorer kompileras inbyggda teman i biblioteket KSyntaxHighlighting, därför är sättet att komma åt dem via källkoden eller genom att exportera dem från det grafiska användargränssnittet för att hantera teman i KTextEditor.

Det är också möjligt att enkelt lägga till ytterligare eller egna teman, som läses in från filsystemet. Användaranpassade temafiler finns i katalogen `org.kde.syntax-highlighting/themes/` i användarkatalogen, som hittas med kommandot ``qtpaths``--paths GenericDataLocation`` och som oftast är ``$HOME`/.local/share/` och `/usr/share/`.

För Flatpak- och Snap-paket, fungerar inte ovanstående katalog eftersom dataplatsen är olika för varje program. I ett Flatpak-program, är platsen för anpassade temafiler oftast ``$HOME`/.var/app/flatpak-paketnamn/data/org.kde.syntax-highlighting/themes/` och i ett Snap-program är platsen ``$HOME`/snap/snap-paketnamn/current/.local/share/org.kde.syntax-highlighting/themes/`.

På &Windows; är filerna placerade i `%USERPROFILE%\AppData\Local\org.kde.syntax-highlighting\themes`. %USERPROFILE% expanderas oftast till `C:\Users\användarnamn`.

Sammanfattningsvis, för de de flesta konfigurationer är den egna temakatalogen följande:

För lokal användare | ``$HOME`/.local/share/org.kde.syntax-highlighting/themes/`
För alla användare | `/usr/share/org.kde.syntax-highlighting/themes/`
För Flatpak-paket | ``$HOME`/.var/app/flatpak-paketnamn/data/org.kde.syntax-highlighting/themes/`
För Snap-paket | ``$HOME`/snap/snap-paketnamn/current/.local/share/org.kde.syntax-highlighting/themes/`
På &Windows; | `%USERPROFILE%\AppData\Local\org.kde.syntax-highlighting\themes`

Om flera temafiler finns med samma namn, läses filen med största `revision` in.

#### &JSON;-strukturen

Strukturen för en &JSON;-fil förklaras på deras webbplats. I huvudsak består en &JSON;-formaterad fil av:

- Samlingar av nyckel-värde par, åtskilda av kommatecken och grupperade inom `{ }`, som vi kallar objekt.

- Ordnade listor av värden, åtskilda av kommatecken och grupperade inom `[ ]`, vilket vi kallar fält.

Terminologin nyckel, värde, objekt och fält används i det här avsnittet. Om det är första gången du arbetar med &JSON;-filer, är det enkelt nog att förstå dem genom att titta på exemplen nedan.

#### Huvudsektionerna i &JSON;-färgtemafiler

Färgtemats rotobjekt i &JSON;-filer innehåller följande schemanycklar:

- `metadata`: Det är nödvändigt. Värdet är ett objekt med temats metadata, såsom ett namn, revision och licens.

  Det beskrivs detaljerat i .

- `editor-colors`: Det är nödvändigt. Värdet är ett objekt med färgerna i textredigeringsområdet, såsom bakgrunden, ikonkanten och textdekorationen.

  Det beskrivs detaljerat i .

- `text-styles`: De är nödvändiga. Värdet är ett objekt med egenskapen förvald textstil för syntaxfärgläggningen. Varje egenskap definierar exempelvis sin textfärg, sin markerad textfärg, eller om den är fetstil eller kursiv. Textstilar kan refereras från egenskaperna i syntaxdefinitionens &XML;-filer.

  Det beskrivs detaljerat i .

- `custom-styles`: De är valfria. Definierar textstilar för egenskaperna av specifika syntaxfärgläggningsdefinitioner. Exempelvis, i en färgläggningsdefinition såsom `Python` eller `Markdown` kan man ange en annorlunda textstil som överskrider förval definierade av `text-styles`.

  Det beskrivs detaljerat i .

&JSON;-språket stöder inte kommentarer. Dock kan du använda den valfria nyckeln `_comments` i rotobjektet för att skriva kommentarer. Om du exempelvis anpassar ett befintligt tema kan du lägga till webbadressen för originalarkivet. Det mest praktiska sättet är att använda ett fält av strängar.

Nedan finns en exempelfil för temat Breeze Light. Du kanske märker att för att undvika att exemplet blir för stort, innehåller inte objekten `editor-colors` och `text-styles` alla nödvändiga nycklar. Du hittar hela arkivet av temat Breeze Light i arkivet för KSyntaxHighlighting.

    {
        "_comments": [
            "Det här är en kommentar.",
            "Om temat är en anpassning av ett annat, ange länken till originalarkivet."
        ],
        "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",
            Andra färgnycklar för editorn ...

        },
        "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"
            },
            Nycklar för andra textstilar...

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

#### Metadata

&JSON;-objektet för nyckeln `metadata` innehåller relevant information om temat. Objektet har följande nycklar:

- `name`: Det är en sträng som anger språkets namn. Det visas senare i menyer och dialogrutor. Det är nödvändigt.

- `revision`: Det är ett heltal som anger aktuell version av temafilen. När du uppdaterar en färgtemafil, säkerställ att talet ökas. Det är nödvändigt.

- `license`: Det är en sträng som definierar temats licens, som använder identifieraren `SPDX-License-Identifier` från standarden SPDX license communication format. Det är valfritt.

  Du kan se hela listan med SPDX-licensidentifierare här.

- `copyright`: Det är ett fält av strängar som anger temats upphovsman, och använder identifieraren `SPDX-FileCopyrightText` från standarden SPDX license communication format. Det är valfritt.

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

### Färger i detalj

Det här avsnittet beskriver alla tillgängliga färgegenskaper och tillgängliga färginställningar i detalj.

#### Editorns färger

Motsvarar färgerna i textredigeringsområdet.

I &JSON;-temafiler, respektive nyckel `editor-colors` har ett värde, ett object, där varje nyckelreferens refererar till en egenskapsfärg i texteditorn. Här är `alla tillgängliga nycklar nödvändiga`, och deras värden är `strängar` med hexadecimala färgkoder, som #00B5CF.

I det grafiska användargränssnitt för att hantera teman i KTextEditor, kan egenskaperna ändras under fliken `Färger`.

Följande nycklar är tillgängliga: nycklarna använda i &JSON;-filen listas med fetstil, och namnen använda i det grafiska användargränssnittet visas inom parentes.

Editorns bakgrundsfärger
  `BackgroundColor` (Textområde)

    Det här är förvald bakgrund för redigeringsområdet. Det kommer att vara den dominerande färgen i redigeringsområdet.

  `TextSelection` (Markerad text)

    Det är bakgrunden för markerad text.

  `CurrentLine` (Aktuell rad)

    Ställ in färgen för aktuell rad. Att ställa in den något annorlunda jämfört med den normala textbakgrunden hjälper till att hålla fokus på den aktuella raden.

  `SearchHighlight` (Sökfärgläggning)

    Ställ in färgen på texten som matchar den senaste sökningen.

  `ReplaceHighlight` (Ersättningsfärgläggning)

    Ställ in färgen på texten som matchar den senaste ersättningsåtgärden.

Ikonkant
  `IconBorder` (Bakgrundsområde)

    Den här färgen används för markeringar, radnummer och vikmarkörkanter till vänster i redigeringsvyn när de visas.

  `LineNumbers` (Radnummer)

    Den här färgen används för att visa radnummer till vänster i vyn när de visas.

  `CurrentLineNumber` (Aktuellt radnummer)

    Deh här färgen används för att återge den aktuella radens radnummer, på vänster sida om vyn när det visas. Att ställa in det lite annorlunda från LineNumbers hjälper till att fokusera på den aktuella raden.

  `Separator` (Separator)

    Den här färgen används för att återge den vertikala linjen som separerar ikonkanten från textområdets bakgrund.

  `WordWrapMarker` (Radbrytningsmarkör)

    Den här färgen används för att rita ett mönster till vänster om rader med dynamisk radbrytning när de är vertikalt justerade, samt för statiska radbrytningsmarkörer.

  `CodeFolding` (Kodvikning)

    Den här färgen används för att markera delen av koden som skulle kodvikas när du klickar på kodvikningspilen till vänster om ett dokument För mer information, se dokumentationen av kodvikning.

  `ModifiedLines` (Ändrade rader)

    Den här färgen används för att färglägga rader som har ändrats men inte ännu sparats till vänster om ett dokument. För mer information se .

  `SavedLines` (Sparade rader)

    Den här färgen används för att färglägga rader som har ändrats under den här sessionen och sparats till vänster om ett dokument. För mer information se .

Textdekorationer
  `SpellChecking` (Rad med stavfel)

    Den här färgen används för att indikera stavfel.

  `TabMarker` (Tabulator- och mellanslagsmarkörer)

    Den här färgen används för att visa indikering av blanktecken, när de är aktiverade.

  `IndentationLine` (Indenteringslinje)

    Den här färgen används för att rita en linje till vänster om indenterade block, om funktionen är aktiverad.

  `BracketMatching` (Färglägg parenteser)

    Den här färgen används för att markera bakgrunden för matchande parenteser.

Markeringsfärger
  `MarkBookmark` (Bokmärke)

    Den här färgen används för att ange bokmärken. Observera att färgen har ogenomskinlighet 22 % (33 % för den aktuella raden). För mer information, se .

  `MarkBreakpointActive` (Aktiv brytpunkt)

    Den här färgen används av GDB-insticksprogrammet för att ange en aktiv brytpunkt. Observera att färgen är ogenomskinlig mot bakgrunden. För mer information, se dokumentationen av GDB-insticksprogrammet.

  `MarkBreakpointReached` (Nådd brytpunkt)

    Den här färgen används av GDB-insticksprogrammet för att ange en brytpunkt du har nått under avlusning. Observera att färgen är ogenomskinlig mot bakgrunden. För mer information, se dokumentationen av GDB-insticksprogrammet.

  `MarkBreakpointDisabled` (Inaktiv brytpunkt)

    Den här färgen används av GDB-insticksprogrammet för att ange en inaktiv brytpunkt. Observera att färgen är ogenomskinlig mot bakgrunden. För mer information, se dokumentationen av GDB-insticksprogrammet.

  `MarkExecution` (Körning)

    Den här färgen används av GDB-insticksprogrammet för raden som för närvarande körs. Observera att färgen är ogenomskinlig mot bakgrunden. För mer information, se dokumentationen av GDB-insticksprogrammet.

  `MarkWarning` (Varning)

    Den här färgen används av bygginsticksprogrammet för att ange en rad som har orsakat en kompilatorvarning. Observera att färgen är ogenomskinlig mot bakgrunden. För mer information, se dokumentationen av bygginsticksprogrammet.

  `MarkError` (Fel)

    Den här färgen används av bygginsticksprogrammet för att ange en rad som har orsakat ett kompilatorfel. Observera att färgen är ogenomskinlig mot bakgrunden. För mer information, se dokumentationen av bygginsticksprogrammet.

Textmallar och snuttar
  `TemplateBackground` (Bakgrund)

    Den här färgen används av &kate;s insticksprogram för textsnuttar för att markera bakgrunden för en textsnutt. För mer information, se dokumentationen av &kate;s textsnuttar.

  `TemplatePlaceholder` (Redigerbar platsmarkör)

    Den här färgen används av &kate;s insticksprogram för textsnuttar för att markera en platsmarkör som du kan klicka för att redigera manuellt. För mer information, se dokumentationen av &kate;s insticksprogram för textsnuttar.

  `TemplateFocusedPlaceholder` (Fokuserad redigerbar platsmarkör)

    Den här färgen används av &kate;s insticksprogram för textsnuttar för att markera en platsmarkör som du för närvarande redigerar. För mer information, se dokumentationen av &kate;s insticksprogram för textsnuttar.

  `TemplateReadOnlyPlaceholder` (Icke-redigerbar platsmarkör)

    Färgen används av &kate;s insticksprogram för textsnuttar för att markera en platsmarkör som inte kan redigeras manuellt, såsom en som fylls i automatiskt. För mer information, se dokumentationen av &kate;s insticksprogram för textsnuttar.

#### Förvalda textstilar

De förvalda textstilarna ärvs av färgläggningstextstilarna, vilket gör det möjligt för editorn att visa text på ett mycket konsekvent sätt, till exempel använder kommentartext samma stil i nästan alla textformat som KSyntaxHighlighting kan färglägga.

Textstilarna kan refereras till från `default styles` använda i &XML;-definitionsfilerna för syntaxfärgläggning, exempelvis egenskapen Normal är ekvivalent med dsNormal i &XML;-filer, och DataType är ekvivalent med dsDataType. Se i dokumentationen av syntaxfärgläggning.

Säkerställ att läsbara färger med god kontrast väljes, särskilt i kombination med `editorns färger`. Se .

I &JSON;-filen har respektive `text-styles` nyckel värdet object där varje nyckel motsvarar namnet på en förvald textstil, som är ekvivalent med de som används i syntaxfärgläggningsdefinitioner. Här `är alla tillgängliga nycklarna för textstilar nödvändiga`, och de listas nedan.

    "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"
        },
        Nycklar för andra textstilar...
    }

Varje nyckel för en förvald textstil har ett &JSON;-objekt som sitt värde, där värden såsom color, bold, italic, etc. anges. Nycklarna är följande:

  `text-color`: Det är en sträng med textfärg i hexadecimal färgkod. Det här nyckel/värdet är nödvändigt.

  `selected-text-color`: Textfärg när den är markerat är i allmänhet samma värde som text-color. När texten är markerad, definieras bakgrunden av värdet TextSelection i editorns färger, så du måste säkerställa att texten har god kontrast och är läsbar med den bakgrunden. Värdet är en sträng med en hexadecimal färgkod. Det här nyckel/värdet är nödvändigt.

  `bold`: Det är en boolean som bestämmer om texten är i fetstil. Nyckeln är valfri, och förvalt värde är `false`.

  `italic`: Det är en boolean som bestämmer om texten är kursiv. Nyckeln är valfri, och förvalt värde är `false`.

  `underline`: Det är en boolean som bestämmer om texten är understruken. Nyckeln är valfri, och förvalt värde är `false`.

  `strike-through`: Det är en boolean som bestämmer om texten är överstruken. Nyckeln är valfri, och förvalt värde är `false`.

  `background-color`: Bestämmer textens bakgrund, exempelvis används för varningar i kommentarer. Värdet är en sträng med en hexadecimal färgkod. Nyckeln är valfri, normalt finns ingen bakgrund.

  `selected-background-color`: Bestämmer textens bakgrund när den är markerad. Värdet är en sträng med en hexadecimal färgkod. Nyckeln är valfri, normalt finns ingen bakgrund.

De här egenskaperna kan ändras i det grafiska användargränssnittet för att hantera färgteman i KTextEditor, under fliken`Förvalda textstilar`. Namnet i listan över stilar använder stilen inställd för det objektet, vilket ger dig en omedelbar förhandsgranskning när en stil anpassas. Varje stil låter dig välja vanliga egenskaper samt förgrunds- och bakgrundsfärger. För att välja bort en bakgrundsfärg, högerklicka för att använda den sammanhangsberoende menyn.

Följande nycklar för textstil är tillgängliga: nycklarna använda i &JSON;-filen listas med fetstil, och namnen använda i det grafiska användargränssnittet visas inom parentes om de är annorlunda.

Normal text och källkod

  `Normal`: Förvald textstil för normal text och källkod utan speciell färgläggning.

  `Keyword`: Textstil för inbyggda nyckelord i språket.

  `Function`: Textstil för funktionsdefinitioner och funktionsanrop.

  `Variable`: Textstil för variabler, om tillämplig. Exempelvis variabler i PHP/Perl typiskt börjar med `$`, så alla identifierare som följer mönstret `$exempel` färgläggs som variabler.

  `ControlFlow` (Kontrollflöde): Textstil för kontrollflödesnyckelord, såsom if, then, else, return, switch, break, yield, continue, etc.

  `Operator`: Textstil för operatorer, såsom `+`, `-`, `*`, `/`, `%`, etc.

  `BuiltIn` (Inbyggda): Textstil för inbyggda språkklasser, funktioner och objekt.

  `Extension`: Textstil för välkända ändelser såsom &Qt;-klasser och funktioner eller makron i C++ och Python eller boost.

  `Preprocessor`: Textstil för preprocessorsatser eller makrodefinitioner.

  `Attribute`: Textstilar för anmärkningar eller attribut för funktioner eller objekt, t.ex. `@override` i Java, eller `__declspec(...)` och `__attribute__((...))` i C++.

Tal, typer och konstanter

  `DataType` (Datatyp): Textstilar för inbyggda datatyper såsom int, char, float, void, u64, etc.

  `DecVal` (Decimal/Värde): Textstil för decimala värden.

  `BaseN` (Bas-N heltal): Textstil för nummer med en bas som skiljer sig från 10.

  `Float` (Flyttal): Textstil för flyttal.

  `Constant`: Textstil för språkkonstanter och användardefinierade konstanter, t.ex. True, False, None i Python eller nullptr i C/C++, eller matematiska konstanter som PI.

Strängar och tecken

  `Char` (Tecken): Textstil för enstaka tecken såsom `'x'`.

  `SpecialChar` (Specialtecken): Textstil för undantagna tecken i strängar, t.ex. `hej\n`, och andra tecken med specialmening i strängar, såsom ersättningar eller operatorer i reguljära uttryck.

  `String`: Textstil som strängar såsom `hej allesamman`.

  `VerbatimString` (Ordagrann sträng): Textstil för ordagranna eller obehandlade strängar som `'obehandlad \bakstreck'` i Perl, CoffeeScript och skal, samt `r'\obehandlad'` i Python, eller sådant som HERE-dokument.

  `SpecialString` (Specialsträng): Textstil för specialsträng, såsom reguljära uttryck i ECMAScript, &latex; matematikläge, SQL, etc.

  `Import` (Importer, Moduler, Inkluderade filer): Textstil för inkluderade filer, importer, moduler eller &latex;-paket.

Kommentarer och dokumentation

  `Comment`: Textstil för normala kommentarer.

  `Dokumentation`: Textstil för kommentarer som anger dokumentation av programmeringsgränssnitt, såsom `/** doxygen-kommentarer */` eller `"""docstrings"""`.

  `Annotation`: Textstilar för anmärkningar i kommentarer eller dokumentationskommandon, såsom `@param` i Doxygen eller JavaDoc.

  `CommentVar` (Kommentarvariabel): Textstil som refererar till variabelnamn använda i kommandona ovan i en kommentar, såsom `exempel` i `@param exempel`, i Doxygen eller JavaDoc.

  `RegionMarker` (Områdesmarkering): Textstil för områdesmarkeringar, ofta definierade av `//BEGIN` och `//END` i kommentarer.

  `Information`: Textstil för information, anteckningar och tips, såsom nyckelordet `@note` i Doxygen.

  `Warning`: Textstil för varningar, såsom nyckelordet `@warning` i Doxygen.

  `Alert`: Textstil för speciella ord i kommentarer, såsom `TODO`, `FIXME`, `XXXX` och `WARNING`.

Diverse

  `Error`: Textstil som anger felmarkering och felaktig syntax.

  `Others`: Textstil för egenskaper som inte motsvarar någon av de andra förvalda stilarna.

#### Egna färgläggningstextstilar

Här kan du etablera textstilar för en specifik syntaxfärgläggningsdefinition, och överskrida `förvald textstil` beskriven i föregående avsnitt.

i &JSON;-temafilen motsvarar det nyckeln `custom-styles` vars värde är ett objekt där varje delschemanyckel motsvarar `namnet på en syntaxfärgläggningsdefinition`. Dess värde är ett objekt där en nyckel refererar till `stilens egenskapsnamn` definierat i elementen `itemData` i &XML;-filens syntaxfärgläggning, och respektive värde är ett delobjekt med nycklarna text-color, selected-text-color, bold, italic, underline, strike-through, background-color och selected-background-color, definierade i föregående avsnitt. Vart och ett av värdena är valfritt, eftersom om de inte anges, beaktas stilen angiven i `text-styles`.

Exempelvis, i det här kodavsnittet, har ISO C++ syntaxfärgläggningsdefinition en särskild textstil för egenskaperna Type Modifiers och Standard Classes. I motsvarande &XML;-fil isocpp.xml använder den definierade egenskapen Standard Classes förvald stil `BuiltIn` (eller dsBuiltIn). I denna egenskap överskrids bara värdet `text-color` av den nya färgen #6431b3.

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

- Du bör ta hänsyn till att de här textstilarna hör ihop med egenskapsnamnen definierade i &XML;-filerna för syntaxfärgläggning. Om en XML-fil uppdateras och namnet ändras på vissa egenskaper eller de tas bort, gäller inte längre den egna stilen definierad i temat.

- Syntaxfärgläggningsdefinitioner inkluderar ofta andra definitioner. Exempelvis inkluderar QML-färgläggningen JavaScript-färgläggning, eftersom de delar funktionaliteten i färgläggning.

I det grafiska användargränssnitt för att hantera teman i KTextEditor, kan egenskaperna ändras under fliken `Färgläggningstextstilar`. Normalt väljer editorn färgläggningen av det aktuella dokumentet i förväg. Du kommer att märka att många färgläggningar innehåller andra färgläggningar som representeras av grupper i stillistan. Exempelvis importerar de flesta färgläggningar Alert, och många källkodsformat importerar Doxygen.

### Det grafiska användargränssnittet för färgteman

Det enklaste sättet att skapa och redigera färgteman är via det grafiska användargränssnittet i dialogrutan Anpassa som tillhandahålls av KTextEditor. För att komma åt det, välj Inställningar Anpassa program... i texteditorns menyrad. Det visar dialogrutan Anpassa. Välj där Färgteman i sidopanelen.

&kate;s inställningsdialogruta med färgtemahantering.

&kate;s inställningsdialogruta med färgtemahantering.

I den här dialogrutan kan du ställa in alla färgerna i de teman du har, samt skapa/kopiera nya teman, ta bort dem, exportera dem till `.theme`-filer med &JSON;-format eller importera dem från externa `.theme`-filer. Varje tema har inställningar för textfärger och stilar.

Inbyggda teman kan normalt inte ändras. För att göra det måste du kopiera dem och ge dem nya namn.

För att använda ett tema permanent i din texteditor måste du välja det i kombinationsrutan med beteckningen Standardtema för program längst ner i dialogrutan och klicka på Verkställ eller Ok. Normalt är alternativet `Automatiskt val` aktivt, vilket väljer ett lämpligt färgtema enligt det &kde; &plasma; färgschema som används i textredigeringsprogrammet. Det väljer oftast mellan Breeze Light och Breeze mörk beroende på om schemat är ljust eller mörkt.

Du kan justera &kde;:s globala färgschema i modulen Färger i systeminställningarna. Du kan också ändra det individuellt i vissa program, såsom &kate; eller &kdevelop;, i menyn Inställningar Färgschema.

#### Skapa ett nytt tema

För att skapa ett nytt tema är det först nödvändigt att kopiera ett befintligt. Välj ett befintligt tema som du vill använda som grund, såsom Breeze Light eller Breeze mörk, och klicka på Kopiera. Skriv sedan in ett namn på det nya temat.

Om du vill ändra en inbyggt eller skrivskyddat tema, måste det först kopieras till ett annat namn.

#### Importera eller exportera &JSON;-temafiler

Du kan exportera ett valt tema (inklusive inbyggda) till en &JSON;-fil med filändelsen `.theme`, med knappen Exportera. Det visar en dialogruta för att spara filen. För att lägga till ett färgtema från en extern &JSON;-fil, klicka helt enkelt på knappen Importera och välj `.theme`-filen i dialogrutan.

- Som nämnts ovan, lagras användaranpassade temafiler i katalogen `org.kde.syntax-highlighting/themes/`. När du kopierar eller skapar ett tema hamnar det automatiskt där. Dessutom, är import eller tillägg av ett tema ekvivalent med att kopiera en extern `.theme`-fil till katalogen. KSyntaxHighlighting hämtar automatiskt färgtemafiler från den här katalogen.

- Om du vill publicera ett tema du skapar, är det ytterst viktigt att kontrollera metadata-objektet i &JSON;-filen, lägga till respektive licens och kontrollera revisionsnumret.

#### Redigera färgteman

##### Färger

Här justerar färgerna i textredigeringsområdet. De beskrivs detaljerat i .

##### Förvalda textstilar

De förvalda textstilarna ärvs av färgläggningstextstilarna, vilket gör det möjligt för editorn att visa text på ett mycket konsekvent sätt, till exempel använder kommentartext samma stil i nästan alla textformat som KSyntaxHighlighting kan färglägga.

Namnet i listan med stilar använder stilen som är inställd för objektet, vilket ger en omedelbar förhandsgranskning när en stil ställs in.

Varje stil låter dig välja gemensamma egenskaper samt förgrunds- och bakgrundsfärger. För att inte använda en bakgrundsfärg, högerklicka och använd den sammanhangsberoende menyn.

Det här områdets egenskaper beskrivs detaljerat i .

##### Färgläggningstextstilar

Här kan du redigera textstilarna som används av en viss färgläggningsdefinition. Editorn väljer färgläggningen som används av aktuellt dokument i förväg. För att arbeta med en annan färgläggning, välja en i kombinationsrutan ovanför listan med stilar.

Namnet i listan med stilar använder stilen som är inställd för objektet, vilket ger en omedelbar förhandsgranskning när en stil ställs in.

Varje stil låter dig välja gemensamma egenskaper samt förgrunds- och bakgrundsfärger. För att inte använda en bakgrundsfärg, högerklicka och använd den sammanhangsberoende menyn. Dessutom kan du se om en stil är samma som den förvalda stilen för objektet, och ställa in den till det om den inte är det.

Du märker att många färgläggningar innehåller andra färgläggningar representerade av grupper i stillistan. De flesta färgläggningar importerar till exempel färgläggningen Alerts, och många källkodsformat importerar färgläggningen Doxygen. Redigering av färger i grupperna påverkar bara stilarna när de används i det redigerade färgläggningsformatet.

### Tips och trick

#### Textfärgernas kontrast

En viktig aspekt vid arbete med färgteman är att välja en textkontrast som gör det lättare att läsa, särskilt i kombination med bakgrunden.

Programmet `Kontrast` är ett verktyg för kontroll av färgkontrast. Det talar om för dig att kombinationen av textfärg och bakgrundsfärg är läsbara och handikappanpassade, så det är ett utmärkt verktyg för att hjälpa dig skapa färgteman.

Du kan ladda ner `Kontrast` från webbplatsen för &kde; program eller från Flatpak-paketet på Flathub (bara i GNU/Linux).

GNOME-programmet `Contrast` är liknande. Du kan ladda ner Flatpak-paketet på Flathub (bara på GNU/Linux).

#### Förslag för konsekvent syntaxfärgläggning

KSyntaxHighlighting inkluderar mer än 300 syntaxfärgläggningsdefinitioner, och därför är det idealiskt att du säkerställer att ditt nya tema ser bra ut i alla syntaxfärgläggningsdefinitioner. De inbyggda färgteman har följande likheter som det rekommenderas (men inte krävs) att du följer för att åstadkomma korrekt visning av alla syntaxfärgläggningsdefinitioner:

- Använd fetstil för textstilarna Keyword och ControlFlow.

- Använd inte bakgrundsfärg i någon textstil, utom Alert och RegionMarker.

De flesta av syntaxfärgläggningarna är avsedda att se bra ut med standardteman Breeze Light och Breeze mörk, därför är ett annat sätt att behålla likformighet att använda liknande färger textstilar, som grön för Preprocessor och Others, blå för DataType och Attribute, eller violett för Function.

Observera att rekommendationerna inte är obligatoriska när ett tema skapas och publiceras.

## Skapa skript med &javascript;

&kappname;s editorkomponent kan enkelt utökas genom att skriva skript. Skriptspråket är ECMAscript (känt överallt som &javascript;). &kappname; stöder två sorters skript: intenterings- och kommandoradskript.

### Indenteringsskript

Indenteringsskript, som också kallas indenterare, indenterar automatiskt källkoden medan texten skrivs in. Som ett exempel, efter att ha tryckt på returtangenten ökar ofta indenteringsnivån.

Följande avsnitt beskriver steg för steg hur skelettet för en enkel indenterare skapas. Som ett första steg, skapa en ny `*.js`-fil, som t.ex. heter `javascript.js` i den lokala hemkatalogen `$`XDG_DATA_HOME`/katepart5/script/indentation`. I detta expanderas miljövariabeln `XDG_DATA_DIRS` typiskt antingen som `~/.local` eller `~/.local/share`.

På &Windows; är filerna placerade i `%USERPROFILE%\AppData\Local\katepart5\script\indentation`. %USERPROFILE% expanderas oftast till `C:\\Users\\användare`.

#### Indenteringsskriptets huvud

Huvudet i filen `javascript.js` är inbäddat som &JSON; i början av dokumentet enligt följande:

    var katescript = {
        "name": "JavaScript",
        "author": "Exempelnamn <exempel.namn@någon.adress.org>",
        "license": "BSD-licens",
        "revision": 1,
        "kate-version": "5.1",
        "required-syntax-style": "javascript",
        "indent-languages": ["javascript"],
        "priority": 0,
    }; // kate-script-header, måste finnas i början av filen utan kommentarer

Varje post förklaras nu i detalj:

- `name` [krävs]: Detta är indenterarens namn som visas i menyn Verktyg Indentering och i inställningsdialogrutan.

- `author` [valfri]: Upphovsmannens namn och kontaktinformation.

- `license` [valfri]: Kort form av licensen, såsom BSD-licensen eller LGPLv3.

- `revision` [krävs]: Skriptets utgåva. Numret ska ökas så fort skriptet ändras.

- `kate-version` [krävs]: Lägsta version av &kappname; som krävs.

- `required-syntax-style` [valfri]: Syntaxstilen som krävs, som matchar angiven `stil` i syntaxfärgläggningsfiler. Det är viktigt för indenterare som förlitar sig på specifik syntaxfärgläggningsinformation i dokumentet. Om en krävd syntaxstil specificeras, är bara indenteraren tillgänglig när lämplig syntaxfärgläggning är aktiv. Det förhindrar odefinierat beteende orsakat av att använda indenteraren utan den förväntade färgläggningsmetoden. Exempelvis använder sig Ruby-indenteraren sig av det i filen `ruby.js` och `ruby.xml`.

- `indent-languages` [valfri]: &JSON;-fält av syntaxstilar som indenteraren kan indentera korrekt, t.ex. `["c++", "java"]`.

- `priority` [valfri]: Om flera indenterare är lämpliga för en viss färglagd fil, bestämmer prioriteten vilken indenterare som väljes som standardindenterare.

#### Indenteringens källkod

Efter att ha specificerat huvudet, förklarar det här avsnittet hur själva indenteringsskriptet fungerar. Det grundläggande skelettet för implementeringen ser ut så här:

    // nödvändiga katepart js bibliotek, t.ex. range.js om Range används
    require ("range.js");

    triggerCharacters = "{}/:;";
    function indent(line, indentWidth, ch)
    {
        // anropas för varje nyrad (ch == '\n') och alla tecken angivna i
        // den globala variabeln triggerCharacters. Vid anrop av VerktygJustera
        // är variabeln ch tom, dvs. ch == ''.
        //
        // se också: Programmeringsgränssnittet för skripthantering
        return -2;
    }

Funktionen `indent()` har tre parametrar:

- `line`: raden som ska indenteras

- `indentWidth`: indenteringsbredden i antal mellanslag

- `ch`: antingen ett nyradstecken (`ch == '\n'`), avtryckartecknet angivet i `triggerCharacters` eller tom om användaren utförde åtgärden Verktyg Justera.

Returvärdet från funktionen `indent()` anger hur raden kommer att indenteras. Om returvärdet är ett enkelt heltal, tolkas det på följande sätt:

- returvärde `-2`: gör ingenting

- returvärde `-1`: behåll indentering (söker efter föregående icke tomma rad)

- returvärde `0`: tal >= 0 anger indenteringsdjupet i mellanslag

Som alternativ kan ett fält med två element returneras.

- `return [ indent, align ];`

I detta fall är det först elementet indenteringsdjupet ovan med samma betydelse för specialvärden. Det andra elementet är dock ett absolutvärde som representerar en kolumn för justering. Om värdet är större än indenteringsvärdet, representerar skillnaden ett antal mellanslag att lägga till efter indentering av den första parametern. Annars ignoreras det andra numret. Att använda tabulator och mellanslag för indentering kallas ofta blandat läge.

Betrakta följande exempel: Antag att tabulator används för indentering, och tabulatorbredden är inställd till 4. Här representerar <tab> en tabulator, och '.' ett mellanslag.

    1: <tab><tab>anropa("Hej",
    2: <tab><tab>......."allesamman");

Vid indentering av rad 2, returnerar funktionen `indent()` [8, 15]. Som resultat infogas två tabulatorer för att indentera till kolumn 8, och 7 mellanslag läggs till för att justera den andra parametern under den första, så att den förblir justerad om filen visas med en annan tabulatorbredd.

En standardinstallation av &kde; levererar &kappname; med flera indenterare. Den motsvarande &javascript;-koden finns i `$`XDG_DATA_DIRS`/katepart5/script/indentation`.

På &Windows; är filerna placerade i `%USERPROFILE%\AppData\Local\katepart5\script\indentation`. %USERPROFILE% expanderas oftast till `C:\\Users\\användare`.

Att utveckla en indenterare kräver att skript läses in igen för att se om ändringar beter sig lämpligt. Istället för att starta om programmet, byt helt enkelt till kommandoraden och utför kommandot `reload-scripts`.

Om du utvecklar användbara skript, fundera på att bidra med det till &kappname;-projektet genom att kontakta e-postlistan.

### Kommandoradskript

Eftersom det är svårt att uppfylla allas behov, stöder &kappname; små hjälpverktyg för snabb textbehandling via den inbyggda kommandoraden. Exempelvis är kommandot `sort` implementerat som ett skript. Det här avsnittet förklarar hur man skapar `*.js`-filer för att utöka &kappname; med godtyckliga hjälpskript.

Kommandoradskript är placerade i samma katalog som indenteringsskript. Som ett första steg, skapa alltså en ny `*.js`-fil som heter `mina_verktyg.js` i den lokala hemkatalogen `$`XDG_DATA_HOME`/katepart5/script/commands`. I detta expanderas miljövariabeln `XDG_DATA_DIRS` typiskt antingen som `~/.local` eller `~/.local/share`.

På &Windows; är filerna placerade i `%USERPROFILE%\AppData\Local\katepart5\script\commands`. %USERPROFILE% expanderas oftast till `C:\\Users\\användare`.

#### Kommandoradskriptets huvud

Huvudet för varje kommandoradskript är inbäddat som &JSON; i början av skriptet enligt följande:

    var katescript = {
        "author": "Exempelnamn <exempel.namn@någon.adress.org>",
        "license": "LGPLv2+",
        "revision": 1,
        "kate-version": "5.1",
        "functions": ["sort", "moveLinesDown"],
        "actions": [
            {  "function": "sort",
                "name": "Sortera markerad text",
                "category": "Editing",
                "interactive": "false"
            },
            {   "function": "moveLinesDown",
                "name": "Flytta rader neråt",
                "category": "Editing",
                "shortcut": "Ctrl+Shift+Down",
                "interactive": "false"
            }
        ]
    }; // kate-script-header, måste finnas i början av filen utan kommentarer

Varje post förklaras nu i detalj:

- `author` [valfri]: Upphovsmannens namn och kontaktinformation.

- `license` [valfri]: Kort form av licensen, såsom BSD-licensen eller LGPLv2.

- `revision` [krävs]: Skriptets utgåva. Numret ska ökas så fort skriptet ändras.

- `kate-version` [krävs]: Lägsta version av &kappname; som krävs.

- `functions` [krävs]: &JSON;-fält av kommandon i skriptet.

- `actions` [valfri]: Ett &JSON;-fält av &JSON;-objekt som definierar åtgärderna som visas i programmenyn. Detaljerad information tillhandahålls i avsnittet Tilldela genvägar.

Eftersom värdet på `functions` är ett &JSON;-fält, kan ett enda skript innehålla godtyckligt antal kommandon för kommandoraden. Varje funktion är tillgänglig via &kappname;s inbyggda kommandorad.

#### Skriptets källkod

Alla funktioner specificerade i huvudet måste implementeras i skriptet. Exempelvis måste skriptfilen i exemplet ovan implementera de två funktionerna `sort` och `moveLinesDown`. Alla funktioner har följande syntax:

    // nödvändiga katepart.js bibliotek, t.ex. range.js om Range används
    require ("range.js");

    function <namn>(arg1, arg2, ...)
    {
        // ... implementering, se också: Programmeringsgränssnittet för skripthantering
    }

Argument på kommandoraden skickas till funktionen som `arg1`, `arg2`, etc. För att ge dokumentation av varje kommando, implementera helt enkelt funktionen '`help`' på följande sätt:

    function help(cmd)
    {
        if (cmd == "sort") {
            return "Sortera markerad text.";
        } else if (cmd == "...") {
            // ...
        }
    }

Att utföra `help sort` på kommandoraden anropar hjälpfunktionen med argumentet `cmd` inställd till det givna kommandot, dvs. `cmd == "sort"`. &kappname; visar därefter den returnerade texten som dokumentation för användaren. Försäkra dig om att översätta strängarna.

Att utveckla ett kommandoradskript kräver att skript läses in igen för att se om ändringar beter sig lämpligt. Istället för att starta om programmet, byt helt enkelt till kommandoraden och utför kommandot `reload-scripts`.

##### Tilldela genvägar

För att göra det möjligt att komma åt skripten i programmenyn och tilldela genvägar, måste skriptet tillhandahålla ett lämpligt skripthuvud. I exemplet ovan, visas båda funktionerna `sort` och `moveLinesDown` i menyn på grund a följande del av skripthuvudet:

    var katescript = {
        ...
        "actions": [
            {   "function": "sort",
                "name": "Sortera markerad text",
                "icon": "",
                "category": "Editing",
                "interactive": "false"
            },
            {   "function": "moveLinesDown",
                "name": "Flytta rader neråt",
                "icon": "",
                "category": "Editing",
                "shortcut": "Ctrl+Shift+Down",
                "interactive": "false"
            }
        ]
    };

Fälten för en åtgärd är följande:

- `function` [krävs]: Funktionen som ska visas i menyn Verktyg Skript.

- `name` [krävs]: Texten visas i skriptmenyn.

- `icon` [valfri]: Ikonen visas intill texten i menyn. Alla &kde;:s ikonnamn kan användas här.

- `category` [valfri]: Om en kategori anges, visas skriptet i en undermeny.

- `shortcut` [valfri]: Genvägen som anges här är förvald genväg. Exempel: `Ctrl+Alt+t`. Se &Qt;:s dokumentation för ytterligare detaljinformation.

- `interactive` [valfri]: Om skriptet kräver användarinmatning via kommandoraden, ange det här som `true`.

Om du utvecklar användbara skript, fundera på att bidra med det till &kappname;-projektet genom att kontakta e-postlistan.

### Programmeringsgränssnittet för skripthantering

Programmeringsgränssnittet för skripthantering som presenteras här är tillgängligt i alla skript, dvs. indenteringsskript och kommandon för kommandoraden. Klasserna `Cursor` och `Range` tillhandahålls av biblioteksfiler i `$`XDG_DATA_DIRS`/katepart5/libraries`. Om du vill använda dem i skriptet, vilket behöver använda vissa av funktionerna i `Document` eller `View` , inkludera det nödvändiga biblioteket med:

    // nödvändiga katepart.js bibliotek, t.ex. range.js om Range används
    require ("range.js");

För att utöka det vanliga skriptprogrammeringsgränssnittet med egna funktioner och prototyper, skapa helt enkelt en ny fil i &kde;:s lokala inställningskatalog `$`XDG_DATA_HOME`/katepart5/libraries` och inkludera den i skriptet med:

    require ("mitt_skriptnamn.js");

På &Windows; är filerna placerade i `%USERPROFILE%\AppData\Local\katepart5\libraries`. %USERPROFILE% expanderas oftast till `C:\\Users\\användare`.

För att utöka befintliga prototyper som `Cursor` eller `Range`, är det rekommenderade sättet inte att ändra den globala `*.js`-filen. Ändra istället prototypen för `Cursor` i &javascript; efter att `cursor.js` har inkluderats i skriptet via `require`.

#### Markörer och intervall

Eftersom &kappname; är en texteditor är alla programmeringsgränssnitt baserade på markörer och intervall om det är möjligt. En markör (Cursor) är ett enkelt par `(rad, kolumn)`, som representerar en textposition i dokumentet. Ett intervall (Range) omfattar text från en markörs startposition till en markörs slutposition. Programmeringsgränssnittet förklaras i detalj i följande avsnitt.

##### Prototypen för Cursor

    Cursor();

  Konstruktor. Returnerar en markör på position `(0, 0)`.

  Exempel: `var cursor = new Cursor();`

    Cursor(int rad, int kolumn);

  Konstruktor. Returnerar en markör på position (rad, kolumn).

  Exempel: `var cursor = new Cursor(3, 42);`

    Cursor(Cursor annan);

  Kopieringskonstruktor. Returnerar en kopia av markören annan.

  Exempel: `var copy = new Cursor(other);`

    Cursor Cursor.clone();

  Returnerar en klon av markören.

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

    Cursor.setPosition(int rad, int kolumn);

  Ställer in markörens position till rad och kolumn.

  Sedan: &kde; 4.11

    bool Cursor.isValid();

  Kontrollera om markören är giltig. Markören är ogiltig om rad och/eller kolumn har värdet `-1`.

  Exampel: `var valid = cursor.isValid();`

    Cursor Cursor.invalid();

  Returnerar en ny ogiltig markör placerad på `(-1, -1)`.

  Exempel: `var invalidCursor = cursor.invalid();`

    int Cursor.compareTo(Cursor annan);

  Jämför den här markören med markören annan. Returnerar

  - `-1`, om den här markören är placerad innan markören annan,

  - `0`, om båda markörerna är lika, och

  - `+1`, om den här markören är placerad efter markören annan.

    bool Cursor.equals(Cursor annan);

  Returnerar `sant` om den här markören och markören annan är lika, annars `falskt`.

    String Cursor.toString();

  Returnerar markören som en sträng på formen `Cursor(rad, kolumn)`.

##### Prototyp för Range

    Range();

  Konstruktor. Att anropa `new Range()` returnerar intervallet (0, 0) - (0, 0).

    Range(Cursor start, Cursor slut);

  Konstruktor. Att anropa `new Range(start, slut)` returnerar intervallet (start, slut).

    Range(int startrad, int startkolumn, int slutrad, int slutkolumn);

  Constructor. Calling `new Range(startrad, startkolumn, slutrad, slutkolumn)` returnerar intervallet från (startrad, startkolumn) to (startrad, slutkolumn).

    Range(Range annat);

  Kopieringskonstruktor. Returnerar en kopia av intervallet annat.

    Range Range.clone();

  Returnerar en klon av intervallet.

  Exempel: `var clone = range.clone();`

    bool Range.isEmpty();

  Returnerar `sant` om både start- och slutmarkörerna är lika.

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

  Sedan: &kde; 4.11

    bool Range.isValid();

  Returnerar `sant` om både start- och slutmarkörerna är giltiga, annars `falskt`.

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

    Range Range.invalid();

  Returnerar intervallet från (-1, -1) till (-1, -1).

    bool Range.contains(Cursor markör);

  Returnerar `true` om intervallet innehåller markörpositionen, annars `false`.

    bool Range.contains(Range annat);

  Returnerar `sant` om det här intervallet innehåller intervallet annat, annars `falskt`.

    bool Range.containsColumn(int kolumn);

  Returnerar `sant` om kolumn är i det halvöppna intervallet `[startkolumn, slutkolumn)`, annars `falskt`.

    bool Range.containsLine(int rad);

  Returnerar `sant` om rad är i det halvöppna intervallet `[startrad, slutrad)`, annars `falskt`.

    bool Range.overlaps(Range annat);

  Returnerar `sant` om det här intervallet och intervallet annat delar ett gemensamt område, annars `falskt`.

    bool Range.overlapsLine(int rad);

  Returnerar `sant` om rad är i intervallet `[startrad, slutrad]`, annars `falskt`.

    bool Range.overlapsColumn(int kolumn);

  Returnerar `sant` om kolumn är i intervallet `[startkolumn, slutkolumn]`, annars `falskt`.

    bool Range.onSingleLine();

  Returnerar `sant` om intervallet startar och slutar på samma rad, dvs. om Range.start.line == Range.end.line.

  Sedan: &kde; 4.9

    bool Range.equals(Range annan);

  Returnerar `sant` om det här intervallet och intervallet annat är lika, annars `falskt`.

    String Range.toString();

  Returnerar intervallet som en sträng på formen `Range(Cursor(rad, kolumn), Cursor(rad, kolumn))`.

#### Globala funktioner

Det här avsnittet listar alla globala funktioner.

##### Att läsa och inkludera filer

    String read(String fil);

  Söker efter angiven fil relativt i förhållande till katalogen `katepart5/script/files` och returnerar innehållet som en sträng.

    void require(String fil);

  Söker efter angiven fil relativt i förhållande till katalogen `katepart5/script/libraries` och utvärdera den. Internt skyddas `require` från att samma fil inkluderas flera gånger.

  Sedan: &kde; 4.10

##### Felsökning

    void debug(String text);

  Skriver ut text på `standardutmatningen` i terminalen som startade programmet.

##### Översättning

För att stödja fullständig landsanpassning, finns det flera funktioner för att översätta strängar i skript, närmare bestämt `i18n`, `i18nc`, `i18np` och `i18ncp`. Funktionerna beter sig exakt likadant som &kde;:s översättningsfunktioner.

Översättningsfunktionerna översätter strängarna de omger via &kde;:s översättningssystem till det språk som används i programmet. Strängar i skript som utvecklas i &kappname;s officiella källkod extraheras automatiskt och är översättningsbara. Med andra ord, som utvecklare av &kappname; behöver man inte bry dig om att extrahera och översätta meddelanden. Observera dock att översättningen bara fungerar inne i &kde;:s infrastruktur, nya strängar i skript från tredjepart som utvecklas utanför &kde;, översätts inte. Överväg därför gärna att bidra med dina skript till &kate; så att en passande översättning blir möjlig.

    void i18n(String text, arg1, ...);

  Översätter text till språket som används av programmet. Parametrarna arg1, ... , är valfria och används för att ersätta platsmarkörerna `%1`, `%2`, etc.

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

  Översätter text till språket som används av programmet. Dessutom är strängen sammanhang synlig för översättare, så att de kan tillhandahålla en bättre översättning. Parametrarna arg1, ... , är valfria och används för att ersätta platsmarkörerna `%1`, `%2`, etc.

    void i18np(String singularis, String pluralis, int antal, arg1, ...);

  Översätter antingen singularis eller pluralis till språket som används av programmet, beroende på angivet antal. Parametrarna arg1, ... , är valfria och används för att ersätta platsmarkörerna `%1`, `%2`, etc.

    void i18ncp(String sammanhang, String singularis, String pluralis, int antal, arg1, ...);

  Översätter antingen singularis eller pluralis till språket som används av programmet, beroende på angivet antal. Dessutom är strängen sammanhang synlig för översättare, så att de kan tillhandahålla en bättre översättning. Parametrarna arg1, ... , är valfria och används för att ersätta platsmarkörerna `%1`, `%2`, etc.

#### Programmeringsgränssnittet för vyn

När ett skript håller på att köras, finns det en global variabel `view` som representerar den för närvarande aktiva editorvyn. Det följande är en lista med alla tillgängliga funktioner i View.

    void view.copy()

  Kopiera markeringen om det finns någon, annars aktuell rad om alternativet `[ ] Kopiera eller klipp ut nuvarande rad om markering saknas` är aktiverat.

  Sedan: KDE Ramverk 5.79

    void view.cut()

  Klipp ut markeringen om det finns någon, annars aktuell rad om alternativet `[ ] Kopiera eller klipp ut nuvarande rad om markering saknas` är aktiverat.

  Sedan: KDE Ramverk 5.79

    void view.paste()

  Klistra in klippbordets innehåll.

  Sedan: KDE Ramverk 5.79

    Cursor view.cursorPosition()

  Returnerar den nuvarande markörpositionen i vyn.

    void view.setCursorPosition(int rad, int kolumn);
    void view.setCursorPosition(Cursor markör);

  Ställ in den nuvarande markörpositionen till antingen (rad, kolumn) eller till den givna markören.

    Cursor view.virtualCursorPosition();

  Returnerar den virtuella markörpositionen, där varje tabulator räknas som motsvarande antal mellanslag, beroende på nuvarande tabulatorbredd.

    void view.setVirtualCursorPosition(int rad, int kolumn);
    void view.setVirtualCursorPosition(Cursor markör);

  Ställ in den nuvarande virtuella markörpositionen till (rad, kolumn) eller till den givna markören.

    String view.selectedText();

  Returnerar den markerade texten. Om ingen text är markerad, är den returnerade strängen tom.

    bool view.hasSelection();

  Returnerar `true` om vyn har markerad text, annars `false`.

    Range view.selection();

  Returnerar det markerade textintervallet. Det returnerade intervallet är ogiltigt om det inte finns någon markerad text.

    void view.setSelection(Range intervall);

  Ställer in markerad text till angivet intervall.

    void view.removeSelectedText();

  Tar bort den markerade texten. Om vyn inte har någon markerad text, händer ingenting.

    void view.selectAll();

  Markerar hela texten i dokumentet.

    void view.clearSelection();

  Rensar textmarkeringen utan att ta bort texten.

    object view.executeCommand(String kommando,
                               String argument,
                               Range intervall);

  Kör kommandoradskommandot kommando med de valfria argumenten argument och ett valfritt intervall. Returnerat objekt har den Booleska egenskapen objekt.ok som anger om körning av kommando lyckades. I händelse av fel, innehåller strängen objekt.status ett felmeddelande.

  Sedan: KDE Ramverk 5.50

#### Programmeringsgränssnittet för dokumentet

När ett skript håller på att köras, finns det en global variabel `document` som representerar det för närvarande aktiva dokumentet. Det följande är en lista med alla tillgängliga funktioner i Document.

    String document.fileName();

  Returnerar dokumentets filnamn eller en tom sträng för osparade textbuffrar.

    String document.url();

  Returnerar dokumentets fullständiga webbadress eller en tom sträng för osparade textbuffrar.

    String document.mimeType();

  Returnerar dokumentets Mime-typ eller &MIME;-typen `application/octet-stream` om ingen lämplig &MIME;-typ kunde hittas.

    String document.encoding();

  Returnerar den nuvarande kodningen använd för att spara filen.

    String document.highlightingMode();

  Returnerar det allmänna färgläggningsläget som används för hela dokumentet.

    String document.highlightingModeAt(Cursor pos);

  Returnerar färgläggningsläget som används på den givna positionen i dokumentet.

    Array document.embeddedHighlightingModes();

  Returnerar ett fält med färgläggningslägen inbäddade i det här dokumentet.

    bool document.isModified();

  Returnerar `true` om dokumentet har osparade ändringar (är modifierat), annars `false`.

    String document.text();

  Returnerar dokumentets hela innehåll i en enda textsträng. Nya rader är markerade med nyradstecknet `\n`.

    String document.text(int från_rad, int från_kolumn, int till_rad, int till_kolumn);
    String document.text(Cursor från, Cursor till);
    String document.text(Range intervall);

  Returnerar texten i det angivna intervallet. Det rekommenderas att använda markör- och intervallbaserade versioner för bättre läsbarhet hos källkoden.

    String document.line(int rad);

  Returnerar den givna textraden som en sträng. Strängen är tom om den begärda raden är utanför tillgängligt intervall.

    String document.wordAt(int rad, int kolumn);
    String document.wordAt(Cursor markör);

  Returnerar ordet på den angivna markörposition.

    Range document.wordRangeAt(int rad, int kolumn);
    Range document.wordRangeAt(Cursor markör);

  Returnerar intervallet för ordet på den givna markörpositionen. Det returnerade intervallet är ogiltigt (se Range.isValid()) om textpositionen är efter ett radslut. Om det inte finns något ord vid den givna markörpositionen returneras ett tomt intervall.

  Sedan: &kde; 4.9

    String document.charAt(int rad, int kolumn);
    String document.charAt(Cursor markör);

  Returnerar tacknet på den angivna markörpositionen.

    String document.firstChar(int rad);

  Returnerar det första tecknet på angiven rad som inte är ett blanktecken. Det första tecknet finns på kolumn 0. Om raden är tom, eller bara innehåller blanktecken, är den returnerade strängen tom.

    String document.lastChar(int rad);

  Returnerar det sista tecknet på angiven rad som inte är ett blanktecken. Om raden är tom, eller bara innehåller blanktecken, är den returnerade strängen tom.

    bool document.isSpace(int rad, int kolumn);
    bool document.isSpace(Cursor markör);

  Returnerar `sant` om tecknet på den givna markörpositionen är ett blanktecken, annars `falskt`.

    bool document.matchesAt(int rad, int kolumn, String text);
    bool document.matchesAt(Cursor markör, String text);

  Returnerar `sant` om given text matchar på den motsvarande markörpositionen, annars `falskt`.

    bool document.startsWith(int rad, String text, bool hoppa_över_blanktecken);

  Returnerar `sant` om raden börjar med text, annars `falskt`. Argumentet hoppa_över_blanktecken bestämmer om inledande blanktecken ignoreras.

    bool document.endsWith(int rad, String text, bool hoppa_över_blanktecken);

  Returnerar `sant` om raden slutar med text, annars `falskt`. Argumentet hoppa_över_blanktecken bestämmer om inledande blanktecken ignoreras.

    bool document.setText(String text);

  Anger hela dokumentets text.

    bool document.clear();

  Tar bort hela texten i dokumentet.

    bool document.truncate(int rad, int kolumn);
    bool document.truncate(Cursor markör);

  Avkortar den givna raden på den givna kolumnen eller markörpositionen. Returnerar `sant` om det lyckas, eller `falskt` om den givna raden inte ingår i dokumentets intervall.

    bool document.insertText(int rad, int kolumn, String text);
    bool document.insertText(Cursor markör, String text);

  Infogar text på den givna markörpositionen. Returnerar `sant` om det lyckas, eller `falskt` om dokumentet är skrivskyddat.

    bool document.removeText(int från_rad, int från_kolumn, int till_rad, int till_kolumn);
    bool document.removeText(Cursor från, Cursor till);
    bool document.removeText(Range intervall);

  Tar bort text i det givna intervallet. Returnerar `sant` om det lyckas, eller `falskt` om dokumentet är skrivskyddat.

    bool document.insertLine(int rad, String text);

  Infogar text på den givna raden. Returnerar `sant` om det lyckas, eller `falskt` om dokumentet är skrivskyddat eller raden inte ingår i dokumentets intervall.

    bool document.removeLine(int rad);

  Tar bort den givna textraden. Returnerar `sant` om det lyckas, eller `falskt` om dokumentet är skrivskyddat eller raden inte ingår i dokumentets intervall.

    bool document.wrapLine(int rad, int kolumn);
    bool document.wrapLine(Cursor markör);

  Radbryter raden vid den givna markörpositionen. Returnerar `sant` om det lyckas, eller `falskt`, t.ex. om rad < 0.

  Sedan: &kde; 4.9

    void document.joinLines(int startrad, int slutrad);

  Sammanfogar rader från startrad till slutrad. Två på varandra följande rader åtskiljs alltid med exakt ett mellanslag.

    int document.lines();

  Returnerar antal rader i dokumentet.

    bool document.isLineModified(int rad);

  Returnerar `sant` om rad för närvarande innehåller osparad data.

  Since: &kde; 5.0

    bool document.isLineSaved(int rad);

  Returnerar `sant` om rad har ändrats, men dokumentet har sparats. Sålunda innehåller raden för närvarande ingen osparad data.

  Since: &kde; 5.0

    bool document.isLineTouched(int rad);

  Returnerar `sant` om rad för närvarande innehåller osparad data eller tidigare har ändrats.

  Since: &kde; 5.0

    bool document.findTouchedLine(int startrad, bool ner);

  Sök efter nästa ändrade rad med början på rad. Sökningen utförs antingen uppåt eller neråt beroende på sökriktningen angiven med ner.

  Since: &kde; 5.0

    int document.length();

  Returnerar antal tecken i dokumentet.

    int document.lineLength(int rad);

  Returnerar längden på rad.

    void document.editBegin();

  Startar en redigeringsgrupp för gruppering av ångra/gör om. Försäkra dig om att alltid anropa `editEnd()` lika många gånger som du anropar `editBegin()`. Att anropa `editBegin()` använder en referensräknare internt, dvs. anropet kan nästlas.

    void document.editEnd();

  Avslutar en redigeringsgrupp. Det sista anropet av `editEnd()` (dvs. det för det första anropet till `editBegin()`) avslutar redigeringssteget.

    int document.firstColumn(int rad);

  Returnerar det första tecknet som inte är ett blanktecken på given rad. Om det bara finns blanktecken på raden, är returvärdet `-1`.

    int document.lastColumn(int rad);

  Returnerar det sista tecknet som inte är ett blanktecken på given rad. Om det bara finns blanktecken på raden, är returvärdet `-1`.

    int document.prevNonSpaceColumn(int rad, int kolumn);
    int document.prevNonSpaceColumn(Cursor markör);

  Returnerar kolumnen med ett tecken som inte är ett blanktecken med början på given markörposition genom att söka bakåt.

    int document.nextNonSpaceColumn(int rad, int kolumn);
    int document.nextNonSpaceColumn(Cursor markör);

  Returnerar kolumnen med ett tecken som inte är ett blanktecken med början på given markörposition genom att söka framåt.

    int document.prevNonEmptyLine(int rad);

  Returnerar nästa rad som inte är tom och som innehåller tecken som inte är blanktecken, genom att söka bakåt.

    int document.nextNonEmptyLine(int rad);

  Returnerar nästa rad som inte är tom och som innehåller tecken som inte är blanktecken, genom att söka framåt.

    bool document.isInWord(String tecken, int egenskap);

  Returnerar `sant`, om givet tecken med given egenskap kan vara en del av ett ord, annars `falskt`.

    bool document.canBreakAt(String tecken, int egenskap);

  Returnerar `sant`, om givet tecken med given egenskap är lämpat att bryta en rad, annars `falskt`.

    bool document.canComment(int startegenskap, int slutegenskap);

  Returnerar `sant` om ett intervall som börjar och slutar med den givna egenskapen är lämpat att kommenteras bort, annars `falskt`.

    String document.commentMarker(int egenskap);

  Returnerar kommentarmarkören för enraderskommentarar för en given egenskap.

    String document.commentStart(int egenskap);

  Returnerar kommentarmarkören för början av flerraderskommentarer för en given egenskap.

    String document.commentEnd(int egenskap);

  Returnerar kommentarmarkören för slutet av flerraderskommentarer för en given egenskap.

    Range document.documentRange();

  Returnerar ett intervall som omfattar hela dokumentet.

    Cursor documentEnd();

  Returnerar en markör placerad på den sista radens sista kolumn i dokumentet.

    bool isValidTextPosition(int rad, int kolumn);
    bool isValidTextPosition(Cursor markör);

  Returnerar `sant` om den angivna markörpositionen är placerad på en giltig textposition. En textposition är bara giltig om den finns i början av, mitten av eller slutet av en giltig rad. Dessutom är en textposition ogiltig om den är placerad i ett Unicode-surrogat.

  Since: &kde; 5.0

    int document.attribute(int rad, int kolumn);
    int document.attribute(Cursor markör);

  Returnerar egenskapen på den angivna markörpositionen.

    bool document.isAttribute(int rad, int kolumn, int egenskap);
    bool document.isAttribute(Cursor markör, int egenskap);

  Returnerar `sant` om egenskapen på den givna markörpositionen är lika med egenskap, annars `falskt`.

    String document.attributeName(int rad, int kolumn);
    String document.attributeName(Cursor markör);

  Returnerar egenskapsnamnet som läsbar text. Det är lika med namnet `itemData` i syntaxfärgläggningsfilerna.

    bool document.isAttributeName(int rad, int kolumn, String namn);
    bool document.isAttributeName(Cursor markör, String namn);

  Returnerar `sant` om egenskapsnamnet på en viss markörposition motsvara givet namn, annars `falskt`.

    String document.variable(String nyckel);

  Returnerar värdet på den begärda dokumentvariabeln nyckel. Om dokumentvariabeln inte finns, är returvärdet en tom sträng.

    void document.setVariable(String nyckel, String värde);

  Ställ in värdet på den begärda dokumentvariabeln nyckel.

  Se också: Kate-dokumentvariabler

  Sedan: &kde; 4.8

    int document.firstVirtualColumn(int rad);

  Returnerar den virtuella kolumnen för det första tecknet som inte är ett blanktecken på den givna raden, eller `-1` om raden är tom eller bara innehåller blanktecken.

    int document.lastVirtualColumn(int rad);

  Returnerar den virtuella kolumnen för det sista tecknet som inte är ett blanktecken på den givna raden, eller `-1` om raden är tom eller bara innehåller blanktecken.

    int document.toVirtualColumn(int rad, int kolumn);
    int document.toVirtualColumn(Cursor markör);
    Cursor document.toVirtualCursor(Cursor markör);

  Konverterar den givna verkliga markörpositionen till en virtuell markörposition, och returnerar antingen ett heltal eller ett markörobjekt.

    int document.fromVirtualColumn(int rad, int virtuell_kolumn);
    int document.fromVirtualColumn(Cursor virtuell_markör);
    Cursor document.fromVirtualCursor(Cursor virtuell_markör);

  Konverterar den givna virtuella markörpositionen till en verklig markörposition, och returnerar antingen ett heltal eller ett markörobjekt.

    Cursor document.anchor(int rad, int kolumn, Char tecken);
    Cursor document.anchor(Cursor markör, Char tecken);

  Söker bakåt efter det givna tecknet med början på den givna markören. Om exempelvis '(' anges som tecken, returnerar funktionen positionen på ett inledande '('. Det sker med referensräkning, dvs. andra '(...)' ignoreras.

    Cursor document.rfind(int rad, int kolumn, String text, int egenskap = -1);
    Cursor document.rfind(Cursor markör, String text, int egenskap = -1);

  Söker bakåt efter den givna texten med lämplig egenskap. Argumentet egenskap ignoreras om det anges som `-1`. Den returnerade markören är ogiltig om texten inte kunde hittas.

    int document.defStyleNum(int rad, int kolumn);
    int document.defStyleNum(Cursor markör);

  Returnerar standardstilen som används på den givna markörpositionen.

    bool document.isCode(int rad, int kolumn);
    bool document.isCode(Cursor markör);

  Returnerar `sant` om egenskapen på given markörposition inte är lika med någon av följande stilar: `dsComment`, `dsString`, `dsRegionMarker`, `dsChar`, `dsOthers`.

    bool document.isComment(int rad, int kolumn);
    bool document.isComment(Cursor markör);

  Returnerar `sant`, om egenskapen för tecknet på markörpositionen är `dsComment`, annars `falskt`.

    bool document.isString(int rad, int kolumn);
    bool document.isString(Cursor markör);

  Returnerar `sant`, om egenskapen för tecknet på markörpositionen är `dsString`, annars `falskt`.

    bool document.isRegionMarker(int rad, int kolumn);
    bool document.isRegionMarker(Cursor markör);

  Returnerar `sant`, om egenskapen för tecknet på markörpositionen är `dsRegionMarker`, annars `falskt`.

    bool document.isChar(int rad, int kolumn);
    bool document.isChar(Cursor markör);

  Returnerar `sant`, om egenskapen för tecknet på markörpositionen är `dsChar`, annars `falskt`.

    bool document.isOthers(int rad, int kolumn);
    bool document.isOthers(Cursor markör);

  Returnerar `sant`, om egenskapen för tecknet på markörpositionen är `dsOthers`, annars `falskt`.

#### Programmeringsgränssnittet för editorn

Förutom dokumentet och programmeringsgränssnittet för vyn, finns ett generellt programmeringsgränssnitt för editorn som tillhandahåller funktioner för allmän redigeringsskriptfunktionalitet.

    String editor.clipboardText();

  Returnerar texten som för närvarande finns i det globala klippbordet.

  Sedan: KDE Ramverk 5.50

    String editor.clipboardHistory();

  Editorn har en klippbordshistorik som innehåller upp till tio klippbordsposter. Funktionen returnerar alla poster som för närvarande finns i klippbordshistoriken.

  Sedan: KDE Ramverk 5.50

    void editor.setClipboardText(String text);

  Ställ in klippbordets innehåll till text. text läggs till i klippbordshistoriken.

  Sedan: KDE Ramverk 5.50