# Etendante &katepart;

## Enkonduko

Kiel ajna altnivela tekstredaktilo, &katepart; proponas diversajn manierojn etendi ĝian funkciecon. Vi povas skribi simplajn skriptojn por aldoni funkciojn per &javascript;. Fine, post kiam vi etendis &katepart;, vi bonvenas aliĝu al ni kaj kunhavigi viajn plibonigojn kun la mondo!

## Laborante kun Syntax Highlighting

### Superrigardo

Sintakso Highlighting estas tio, kio igas la redaktilon aŭtomate montri tekston en malsamaj stiloj/koloroj, depende de la funkcio de la ĉeno rilate al la celo de la dosiero. En programa fontkodo ekzemple, kontroldeklaroj povas esti grasigitaj, dum datumtipoj kaj komentoj ricevas malsamajn kolorojn de la resto de la teksto. Tio multe plibonigas la legeblecon de la teksto, kaj tiel helpas la aŭtoron esti pli efika kaj produktiva.

C++-funkcio, bildita kun sintaksa reliefigo.

C++-funkcio, bildita kun sintaksa reliefigo.

La sama C++-funkcio, sen reliefigo.

La sama C++-funkcio, sen reliefigo.

El la du ekzemploj, kiu estas plej facile legebla?

&kappname; venas kun fleksebla, agordebla kaj kapabla sistemo por fari sintaksan reliefigon, kaj la norma distribuo disponigas difinojn por larĝa gamo de programado, skriptlingvoj kaj markado kaj aliaj tekstdosierformatoj. Krome vi povas provizi viajn proprajn difinojn en simpla &XML; dosierojn.

&kappname; aŭtomate detektos la ĝustajn sintaksajn regulojn kiam vi malfermas dosieron, surbaze de la &MIME; Tipo de la dosiero, determinita de ĝia etendaĵo, aŭ, se ĝi ne havas, la enhavo. Se vi spertas malbonan elekton, vi povas mane agordi la sintakson por uzi el la menuo Iloj Emstarigado .

La stiloj kaj koloroj uzataj de ĉiu sintaksa emfaza difino povas esti agorditaj uzante la langeton Elstarigante Tekstajn Stilojn de la Agorda Dialogo, dum la &MIME; Tipoj kaj dosier-etendoj por kiuj ĝi estu uzata estas pritraktataj de la langeto Reĝimoj & Dosiertipoj.

La sintaksa reliefigo estas tie por plibonigi la legeblecon de ĝusta teksto, sed vi ne povas fidi ĝin por validigi vian tekston. Marki tekston por sintakso estas malfacila depende de la formato, kiun vi uzas, kaj en iuj kazoj la aŭtoroj de la sintaksaj reguloj fieros se 98% de teksto estas ĝuste bilditaj, kvankam plej ofte vi bezonas maloftan stilon por vidi la malĝustajn 2% .

### La &kappname; Sintakso Highlight System

Ĉi tiu sekcio diskutos pri la &kappname; sintaksa reliefiga mekanismo pli detale. Ĝi estas por vi, se vi volas scii pri ĝi, aŭ se vi volas ŝanĝi aŭ krei sintaksajn difinojn.

#### Kiel ĝi Funkcias

Kiam ajn vi malfermas dosieron, unu el la unuaj aferoj la &kappname; redaktilo faras estas detekti kiun sintaksan difinon uzi por la dosiero. Dum legado de la teksto de la dosiero, kaj dum vi tajpas en ĝi, la sintaksa emfaza sistemo analizos la tekston uzante la regulojn difinitajn de la sintaksa difino kaj markos en ĝi kie komenciĝas kaj finiĝas malsamaj kuntekstoj kaj stiloj.

Kiam vi tajpas la dokumenton, la nova teksto estas analizita kaj markita sur la flugo, tiel ke se vi forigas signon kiu estas markita kiel la komenco aŭ fino de kunteksto, la stilo de ĉirkaŭa teksto ŝanĝiĝas laŭe.

La sintaksaj difinoj uzataj de la &kappname; Sintakso Highlighting System estas &XML; dosieroj, enhavantaj

- Reguloj por detekti la rolon de teksto, organizitaj en kuntekstblokojn

- Listo de ŝlosilvortoj

- Stilo Item-difinoj

Kiam oni analizas la tekston, la detektaj reguloj estas taksitaj en la ordo en kiu ili estas difinitaj, kaj se la komenco de la nuna ĉeno kongruas kun regulo, la rilata kunteksto estas uzata. La komenca punkto en la teksto estas movita al la fina punkto ĉe kiu tiu regulo kongruis kaj nova buklo de la reguloj komenciĝas, komencante en la kunteksto fiksita per la kongrua regulo.

#### Reguloj

La detektaj reguloj estas la koro de la reliefiga detektsistemo. Regulo estas ĉeno, signo aŭ regula esprimo kontraŭ kiu kongrui la analizitan tekston. Ĝi enhavas informojn pri kiu stilo uzi por la kongrua parto de la teksto. Ĝi povas ŝanĝi la laborkuntekston de la sistemo aŭ al eksplicite menciita kunteksto aŭ al la antaŭa kunteksto uzata de la teksto.

Reguloj estas organizitaj en kuntekstaj grupoj. Kunteksta grupo estas uzata por ĉefaj tekstokonceptoj ene de la formato, ekzemple cititaj tekstoĉenoj aŭ komentblokoj en programfontokodo. Ĉi tio certigas, ke la emfaza sistemo ne bezonas trapasi ĉiujn regulojn kiam ĝi ne estas necesa, kaj ke iuj signosekvencoj en la teksto povas esti traktataj malsame depende de la nuna kunteksto.

Kuntekstoj povas esti generitaj dinamike por permesi la uzon de instancospecifaj datenoj en reguloj.

#### Kuntekstaj Stiloj kaj Ŝlosilvortoj

En kelkaj programlingvoj, entjeraj nombroj estas traktataj alimaniere ol glitkomaj fare de la kompililo (la programo kiu konvertas la fontkodon al binara efektivigebla), kaj povas ekzisti signoj havantaj specialan signifon ene de citita ĉeno. En tiaj kazoj, estas senco redoni ilin alimaniere de la ĉirkaŭaĵo por ke ili estu facile identigeblaj dum legado de la teksto. Do eĉ se ili ne reprezentas specialajn kuntekstojn, ili povas esti viditaj kiel tiaj per la sintaksa reliefigsistemo, tiel ke ili povas esti markitaj por malsama bildigo.

Sintaksa difino povas enhavi tiom da stiloj kiom necesas por kovri la konceptojn de la formato por kiu ĝi estas uzata.

En multaj formatoj, ekzistas listoj de vortoj kiuj reprezentas specifan koncepton. Ekzemple, en programlingvoj, kontroldeklaroj estas unu koncepto, datumtipnomoj alia, kaj konstruitaj en funkcioj de la lingvo triono. La &kappname; Syntax Highlighting System povas uzi tiajn listojn por detekti kaj marki vortojn en la teksto por emfazi konceptojn de la tekstoformatoj.

#### Defaŭltaj Stiloj

Se vi malfermas fontdosieron C++, &Java; fontdosiero kaj &HTML; dokumenton en &kappname;, vi vidos ke kvankam la formatoj estas malsamaj, kaj tiel malsamaj vortoj estas elektitaj por speciala traktado, la koloroj uzataj estas la samaj. Ĉi tio estas ĉar &kappname; havas antaŭdifinitan liston de Defaŭltaj Stiloj, kiuj estas uzataj de la individuaj sintaksaj difinoj.

Ĉi tio faciligas rekoni similajn konceptojn en malsamaj tekstoformatoj. Ekzemple, komentoj ĉeestas en preskaŭ ajna programado, skripto aŭ markadlingvo, kaj kiam ili estas prezentitaj uzante la saman stilon en ĉiuj lingvoj, vi ne devas halti kaj pensi identigi ilin en la teksto.

Ĉiuj stiloj en sintaksa difino uzas unu el la defaŭltaj stiloj. Kelkaj sintaksaj difinoj uzas pli da stiloj ol estas defaŭltaj, do se vi uzas formaton ofte, eble indas lanĉi la agordan dialogon por vidi ĉu iuj konceptoj uzas la saman stilon. Ekzemple, ekzistas nur unu defaŭlta stilo por ĉenoj, sed ĉar la Perl programlingvo funkcias kun du specoj de ĉenoj, vi povas plibonigi la reliefigon agordante tiujn por esti iomete malsamaj. Ĉiuj disponeblaj defaŭltaj stiloj estos klarigitaj poste.

### La Marka Difino &XML; Formato

#### Superrigardo

&kappname; uzas la kadron Syntax-Highlighting de &kde-frameworks;. La defaŭlta reliefigo &XML; dosieroj senditaj kun &kappname; estas kompilitaj en la bibliotekon Syntax-Highlighting defaŭlte.

Ĉi tiu sekcio estas superrigardo de la Highlight Definition &XML; formato. Surbaze de malgranda ekzemplo ĝi priskribos la ĉefajn komponantojn kaj ilian signifon kaj uzadon. La sekva sekcio eniros en detalojn kun la plej elstaraj detektaj reguloj.

La formala difino, ankaŭ konata kiel la XSD, kiun vi trovas en Syntax Highlighting-deponejo en la dosiero `language.xsd`

Propraj `.xml` elstaraj difindosieroj troviĝas en `org.kde.syntax-highlighting/syntax/` en via uzanto dosierujo trovita kun ``qtpaths``--paths GenericDataLocation`` kiuj kutime estas ``$HOME`/.local/share/` kaj `/usr/share/`.

En Flatpak kaj Snap-pakaĵoj, ĉi-supra dosierujo ne funkcios ĉar la datuma loko estas malsama por ĉiu aplikaĵo. En aplikaĵo de Flatpak, la loko de propra &XML; dosieroj estas kutime ``$HOME`/.var/app/`flatpak-package-name`/data/org.kde.syntax-highlighting/syntax/` kaj en Snap-aplikaĵo tiu loko estas ``$HOME`/snap/`snap-package-name`/ current/.local/share/org.kde.syntax-highlighting/syntax/`.

Sur &Windows; ĉi tiuj dosieroj troviĝas `%USERPROFILE%\AppData\Local\org.kde.syntax-highlighting\syntax`. `%USERPROFILE%` kutime vastiĝas al `C:\Users\`uzanto``.

Resume, por plej multaj agordoj la dosierujo de propra &XML; dosieroj estas kiel sekvas:

Por loka uzanto | ``$HOME`/.local/share/org.kde.syntax-highlighting/syntax/`
Por ĉiuj uzantoj | `/usr/share/org.kde.syntax-highlighting/syntax/`
Por Flatpak-pakaĵoj | ``$HOME`/.var/app/`flatpak-package-name`/data/org.kde.syntax-highlighting/syntax/`
Por Snap-pakaĵoj | ``$HOME`/snap/`snap-package-name`/current/.local/share/org.kde.syntax-highlighting/syntax/`
Sur &Windows; | `%USERPROFILE%\AppData\Local\org.kde.syntax-highlighting\syntax`

Se ekzistas pluraj dosieroj por la sama lingvo, la dosiero kun la plej alta `versio` atributo en la elemento `lingvo` estos ŝargita.

#### Ĉefaj sekcioj de &kappname; Emfazaj Difindosierojn

Elstariga dosiero enhavas kaplinion kiu fiksas la &XML; versio:

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

La radiko de la difindosiero estas la elemento `lingvo`. Disponeblaj atributoj estas:

- Bezonataj atributoj:

  `nomo` fiksas la nomon de la lingvo. Ĝi aperas poste en la menuoj kaj dialogoj.

  `sekcio` specifas la kategorion.

  `etendoj` difinas dosierajn etendaĵojn, kiel "*.cpp;*.h"

  `versio` specifas la nunan revizion de la difindosiero laŭ entjera nombro. Kiam ajn vi ŝanĝas elstaran difindosieron, certigu pliigi ĉi tiun nombron.

  `kateversion` specifas la plej lastan subtenatan &kappname; versio.

  Laŭvolaj atributoj:

  `mimetype` asocias &MIME;-tipon al dosieroj.

  `majusklesendebla` difinas ĉu la ŝlosilvortoj distingas minusklecon aŭ ne.

  `prioritato` estas necesa se alia elstara difindosiero uzas la samajn etendaĵojn. La pli alta prioritato venkos.

  `aŭtoro` enhavas la nomon de la aŭtoro kaj lian retadreson.

  `licenco` enhavas la permesilon, kutime la MIT-licencon por novaj sintaksaj eminentaj dosieroj.

  `stilo` enhavas la provizitan lingvon kaj estas uzata de la indentistoj por la atributo `required-syntax-style`.

  `indentor` difinas kiun indentigilo estos uzata defaŭlte. Disponeblaj indentiloj estas: ada, normala, cstyle, cmake, haskell, latex, lilypond, lisp, lua, pascal, python, replicode, ruby kaj xml.

  `kaŝita` difinas ĉu la nomo aperu en la menuoj de &kappname;.

  Do la sekva linio povas aspekti jene:

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

Poste venas la elemento `markigo`, kiu enhavas la laŭvolan elementon `list` kaj la postulatajn elementojn `kuntekstoj` kaj `itemDatas`.

- `listo` elementoj enhavas liston de ŝlosilvortoj. Ĉi-kaze la ŝlosilvortoj estas klaso kaj konst. Vi povas aldoni tiom da listoj kiom vi bezonas.

  Ekde &kde-frameworks; 5.53, listo povas inkluzivi ŝlosilvortojn de alia listo aŭ lingvo/dosiero, uzante la elementon `include`. `##` estas uzata por apartigi la listonomon kaj la lingvodifinnomon, same kiel en la regulo `Inkludi Regulojn`. Ĉi tio estas utila por eviti duobligi ŝlosillistojn, se vi bezonas inkluzivi la ŝlosilvortojn de alia lingvo/dosiero. Ekzemple, la listo alianomo enhavas la ŝlosilvorton str kaj ĉiujn ŝlosilvortojn de la listo tipoj, kiu apartenas al la ISO C++ lingvo.

  La elemento `kuntekstoj` enhavas ĉiujn kuntekstojn. La unua kunteksto estas defaŭlte la komenco de la reliefigo. Estas du reguloj en la kunteksto Normala Teksto, kiuj kongruas kun la listo de ŝlosilvortoj kun la nomo iunomo kaj regulo, kiu detektas citilon kaj ŝanĝas la kuntekston al ĉeno. Por lerni pli pri reguloj legu la sekvan ĉapitron.

  La tria parto estas la elemento `itemDatas`. Ĝi enhavas ĉiujn kolorojn kaj tiparstilojn bezonatajn de la kuntekstoj kaj reguloj. En ĉi tiu ekzemplo, la `itemData` Normala Teksto, String kaj Ŝlosilvorto estas uzataj.

      <highlighting>
          <list name="iunomo">
            <item>class</item>
            <item>const</item>
          </list>
          <list name="alianomo">
            <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="iunomo" />
              <keyword attribute="Keyword" context="#stay" String="alianomo" />
              <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>

La lasta parto de elstara difino estas la laŭvola sekcio `ĝenerala`. Ĝi povas enhavi informojn pri ŝlosilvortoj, kodfaldado, komentoj, deŝovo, malplenaj linioj kaj literuma kontrolo.

- La sekcio `komento` difinas per kia ĉeno unulinia komento estas enkondukita. Vi ankaŭ povas difini plurlinian komenton uzante multiLine kun la kroma atributo end. Ĉi tio estas uzata se la uzanto premas la respondan ŝparvojon por comment/uncomment.

  La sekcio `keywords` difinas ĉu ŝlosilvortlistoj distingas usklecon aŭ ne. Aliaj atributoj estos klarigitaj poste.

  La aliaj sekcioj, `folding`, `emptyLines` kaj `spellchecking`, kutime ne necesas kaj estas klarigitaj poste.

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

#### La Sekcioj en Detalo

Ĉi tiu parto priskribos ĉiujn disponeblajn atributojn por kuntekstoj, itemDatoj, ŝlosilvortoj, komentoj, kodo-faldado kaj indentaĵo.

La elemento `context` apartenas al la grupo `contexts`. Kunteksto mem difinas kunteksto-specifajn regulojn kiel ekzemple kio devus okazi se la elstara sistemo atingas la finon de linio. Disponeblaj atributoj estas:

- `name` deklaras la kuntekstan nomon. Reguloj uzos ĉi tiun nomon por specifi la kuntekston por ŝanĝi, se la regulo kongruas.

  `attribute` identigas la stilon por uzi por signo kiam neniu regulo kongruas aŭ kiam regulo ne specifas atributon. En ĉi-lasta kazo, estos uzata attribute de la kunteksto specifita en la context de la regulo.

  `lineEndContext` difinas la kuntekston, al kiu la emfazsistemo ŝanĝas se ĝi atingas la finon de linio. Ĉi tio povas aŭ esti nomo de alia kunteksto, `#stay` por ne ŝanĝi la kuntekston (⪚. fari nenion) aŭ `#pop` kiu igos ĝin forlasi ĉi tiun kuntekston. Eblas uzi ekzemple `#pop#pop#pop` por krevi trifoje, aŭ eĉ `#pop#pop!OtherContext` por krevi dufoje kaj ŝanĝi al la kunteksto nomata `Alia Kunteksto`. Eblas ankaŭ ŝanĝi al kunteksto, kiu apartenas al alia lingvodifino, same kiel en la reguloj `Inkluzi Reguloj`, ⪚, `IuKunteksto##JavaScript`. Kuntekstŝaltiloj ankaŭ estas priskribitaj en kate-highlight-rules-detailled. Defaŭlto: #stay.

  `lineEmptyContext` difinas la kuntekston se malplena linio estas renkontita. La nomenklaturo de kuntekstŝaltiloj estas la sama kiel antaŭe priskribita en lineEndContext. Defaŭlto: #stay.

  `fallthroughContext` specifas la sekvan kuntekston por ŝanĝi se neniu regulo kongruas. La nomenklaturo de kuntekstŝaltiloj estas la sama kiel antaŭe priskribita en lineEndContext. Defaŭlto: #stay.

  `fallthrough` difinas ĉu la emfazsistemo ŝanĝas al la kunteksto specifita en `fallthroughContext` se neniu regulo kongruas. Notu ke ekde &kde; &frameworks; 5.62 ĉi tiu atributo estas malrekomendita favore al `fallthroughContext`, ĉar se la atributo `fallthroughContext` ĉeestas, estas implicite komprenite, ke la valoro de `fallthrough` estas true. Defaŭlto: false.

  `noIndentationBasedFolding` malŝaltas indent-bazitan faldadon en la kunteksto. Se indent-bazita faldado ne estas aktivigita, ĉi tiu atributo estas senutila. Ĉi tio estas difinita en la elemento folding de la grupo general. Defaŭlto: false.

La elemento `itemData` estas en la grupo `itemData`. Ĝi difinas la tiparstilon kaj kolorojn. Do eblas difini viajn proprajn stilojn kaj kolorojn. Tamen, ni rekomendas vin alteni la defaŭltajn stilojn se eble, por ke la uzanto ĉiam vidu la samajn kolorojn uzatajn en malsamaj lingvoj. Tamen, foje ne ekzistas alia maniero kaj necesas ŝanĝi kolorojn kaj tipatributojn. La atributoj name kaj defStyleNum estas postulataj, la aliaj estas laŭvolaj. Disponeblaj atributoj estas:

- `name` fiksas la nomon de la itemData. Kuntekstoj kaj reguloj uzos ĉi tiun nomon en sia atributo attribute por referenci elementon.

  `defStyleNum` difinas kiun defaŭltan stilon uzi. Disponeblaj defaŭltaj stiloj estas klarigitaj detale poste.

  `color` difinas koloron. Validaj formatoj estas '#rrggbb' aŭ '#rgb'.

  `selColor` difinas la elektokoloron.

  `italic` se true, la teksto estos kursiva.

  `bold` se true, la teksto estos grasa.

  `underline` se true, la teksto estos substrekita.

  `strikeout` se true, la teksto estos forstrekita.

  `spellChecking` se true, la teksto estos literumkontrolita.

La elemento `keywords` en la grupo `general` difinas ŝlosilvortojn. Disponeblaj atributoj estas:

- `casesensitive` povas esti true aŭ false. Se true, ĉiuj ŝlosilvortoj estas kongruaj majuskle.

  `weakDeliminator` estas listo de signoj, kiuj ne funkcias kiel vortlimigiloj. Ekzemple, la punkto `'.'` estas vortlimigilo. Supozu, ke ŝlosilvorto en `listo` enhavas punkton, ĝi nur kongruos se vi specifigas la punkton kiel malfortan limigilon.

  `additionalDeliminator` difinas kromajn limigilojn.

  `wordWrapDeliminator` difinas signojn post kiuj povas okazi linivolviĝo.

  Defaŭltaj limigiloj kaj vortvolvaĵlimigiloj estas la signoj `.():!+,-<=>%&*/;?[]^{|}~\`, spaceto (`' '`) kaj tabeligilo (`'\t'`).

La elemento `komento` en la grupo `komentoj` difinas komentajn trajtojn, kiuj estas uzataj por Iloj Komento, Iloj Malkomenti kaj Iloj Baskuligi Komenton. Disponeblaj atributoj estas:

- `nomo` estas aŭ unuLinio aŭ multlinio. Se vi elektas multLinio la atributoj fino kaj regiono estas postulataj. Se vi elektas unuLinio vi povas aldoni la laŭvolan atributon pozicio.

  `komenco` difinas la ĉenon uzatan por komenci komenton. En C++ ĉi tio estus "/*" en plurliniaj komentoj. Ĉi tiu atributo estas postulata por tipoj multiLine kaj singleLine.

  `end` difinas la ĉenon uzatan por fermi komenton. En C++ ĉi tio estus "*/". Ĉi tiu atributo estas nur disponebla kaj necesas por komentoj de tipo multiLine.

  `regiono` devus esti la nomo de la faldebla plurlinia komento. Supozu, ke vi havas beginRegion="Comment" ... endRegion="Comment" en viaj reguloj, vi devus uzi region="Comment". Tiel malkomentado funkcias eĉ se vi ne elektas la tutan tekston de la plurlinia komento. La kursoro nur devas esti en la plurlinia komento. Ĉi tiu atributo disponeblas nur por tipo multilinio.

  `position` difinas kie la unulinia komento estas enmetita. Defaŭlte, la unulinia komento estas metita komence de la linio ĉe kolumno 0, sed se vi uzas position="afterwhitespace" la komento estas enmetita post gvidado de blankspacoj dekstre, antaŭ la unua ne-blankspaca signo. Ĉi tio estas utila por meti komentojn ĝuste en lingvoj kie deŝoviĝo estas grava, kiel Python aŭ YAML. Ĉi tiu atributo estas nedeviga kaj la nura ebla valoro estas afterwhitespace. Ĉi tio disponeblas nur por tipo singleLine.

La elemento `folding` en la grupo `general` difinas kodfaldajn ecojn. Disponeblaj atributoj estas:

- `indentationsensitive` se true, la kodaj faldmarkoj estos aldonitaj deŝovo bazitaj, kiel en la skriptlingvo Python. Kutime vi ne bezonas agordi ĝin, ĉar ĝi defaŭlte estas false.

La elemento `emptyLine` en la grupo `emptyLines` difinas kiuj linioj estu traktataj kiel malplenaj linioj. Ĉi tio permesas modifi la konduton de la atributo lineEmptyContext en la elementoj `context`. Disponeblaj atributoj estas:

- `regexpr` difinas regulan esprimon, kiu estos traktata kiel malplena linio. Defaŭlte, malplenaj linioj enhavas neniujn signojn, tial ĉi tio aldonas pliajn malplenajn liniojn, ekzemple, se vi volas, ke linioj kun spacoj ankaŭ estu konsiderataj malplenaj linioj. Tamen, en la plej multaj sintaksaj difinoj vi ne bezonas agordi ĉi tiun atributon.

La elemento `encoding` en la grupo `spellchecking` difinas signan kodigon por literumkontrolo. Disponeblaj atributoj:

- `char` estas kodita signo.

  `ĉeno` estas sinsekvo de signoj kiuj estos kodita kiel la signo char en la literuma kontrolo. Ekzemple, en la lingvo LaTeX, la ĉeno `\"{A}` reprezentas la signon `Ä`.

#### Disponeblaj Defaŭltaj Stiloj

Defaŭltaj Stiloj estis jam klarigitaj, kiel mallonga resumo: Defaŭltaj stiloj estas antaŭdifinitaj tiparo kaj kolorstiloj.

Ĝeneralaj defaŭltaj stiloj:

- `dsNormal`, kiam ne necesas speciala reliefigo.

  `dsKeyword`, enkonstruitaj lingvaj ŝlosilvortoj.

  `dsFunction`, funkciovokoj kaj difinoj.

  `dsVariable`, se aplikebla: variablo-nomoj (⪚ $someVar en PHP/Perl).

  `dsControlFlow`, kontrolfluaj ŝlosilvortoj kiel se, else, ŝaltilo, rompo, reveno, rendimento, ...

  `dsOperator`, operatoroj kiel + - * / :: < >

  `dsBuiltIn`, enkonstruitaj funkcioj, klasoj kaj objektoj.

  `dsExtension`, oftaj etendaĵoj, kiel &Qt; klasoj kaj funkcioj/makrooj en C++ kaj Python.

  `dsPreprocessor`, antaŭprocesoraj deklaroj aŭ makrodifinoj.

  `dsAttribute`, komentarioj kiel @override kaj __declspec(...).

Defaŭltaj stiloj rilataj al ĉenoj:

- `dsChar`, unuopaj signoj, kiel 'x'.

  `dsSpecialChar`, signoj kun speciala signifo en ĉenoj kiel eskapoj, anstataŭaĵoj aŭ regex operatoroj.

  `dsString`, ĉenoj kiel "saluton mondo".

  `dsVerbatimString`, laŭvortaj aŭ krudaj ĉenoj kiel 'raw \backslash' en Perl, CoffeeScript, kaj ŝeloj, same kiel r'\raw' en Python.

  `dsSpecialString`, SQL, regeksoj, TIE dokumentoj, &latex; matematika reĝimo, ...

  `dsImport`, importi, inkluzivi, postuli de moduloj.

Nombro-rilataj defaŭltaj stiloj:

- `dsDataType`, enkonstruitaj datumtipoj kiel int, void, u64.

  `dsDecVal`, decimalaj valoroj.

  `dsBaseN`, valoroj kun bazo alia ol 10.

  `dsFloat`, glitkomaj valoroj.

  `dsConstant`, konstantoj enkonstruitaj kaj uzantodifinitaj kiel PI.

Komento kaj dokumentar-rilataj defaŭltaj stiloj:

- `dsComment`, komentoj.

  `dsDocumentation`, /** Dokumentaj komentoj */ aŭ """docstrings""".

  `dsAnnotation`, dokumentaj komandoj kiel @param, @brief.

  `dsCommentVar`, la variablonomoj uzataj en supraj komandoj, kiel "foobar" en @param foobar.

  `dsRegionMarker`, regionmarkoj kiel //BEGIN, //END en komentoj.

Aliaj defaŭltaj stiloj:

- `dsInformation`, notoj kaj konsiloj kiel @note en doxygen.

  `dsWarning`, avertoj kiel @warning en doksigeno.

  `dsAlert`, specialaj vortoj kiel TODO, FIXME, XXXX.

  `dsError`, erara reliefigo kaj malĝusta sintakso.

  `dsOthers`, kiam nenio alia taŭgas.

### Emfazodetektaj Reguloj

Ĉi tiu sekcio priskribas la sintaksdetektajn regulojn.

Ĉiu regulo povas kongrui kun nul aŭ pli da signoj ĉe la komenco de la ĉeno kontraŭ kiu ili estas testitaj. Se la regulo kongruas, la kongruaj signoj ricevas la stilon aŭ attribute difinitan de la regulo, kaj regulo povas peti ke la nuna kunteksto estas ŝanĝita.

Regulo aspektas jene:

    <RegulNomo attribute="(identigilo)" context="(identigilo)" [specifaj atributoj de la regulo] />

La attribute identigas la stilon uzi por kongruaj signoj laŭ nomo, kaj la context identigas la kuntekston uzi de ĉi tie.

La context povas esti identigita per:

- identigilo, kiu estas la nomo de la alia kunteksto.

- order ordonanta al la motoro resti en la nuna kunteksto (`#stay`), aŭ reiri al antaŭa kunteksto uzata en la ĉeno (`#pop`). Malplena aŭ forestanta kunteksto ekvivalentas al `#stay`.

  Por retroiri pliajn paŝojn, la #pop ŝlosilvorto povas esti ripetita: `#pop#pop#pop`

- ordo sekvata de ekkria signo (!) kaj identigilo, kiuj igos la motoron unue sekvi la ordon kaj poste ŝanĝi al la alia kunteksto, ⪚ `#pop#pop!AliaKunteksto`.

- identigilo, kiu estas kunteksta nomo, sekvata de du kradoj (`##`) kaj alia identigilo, kiu estas la nomo de lingvodifino . Ĉi tiu nomado estas simila al tiu uzata en reguloj de `Inkluzi Reguloj` kaj ebligas al vi ŝanĝi al kunteksto apartenanta al alia sintaksa emfaza difino, ekz. `IomKunteksto##JavaScript`.

Regulaj specifaj atributoj varias kaj estas priskribitaj en la sekvaj sekcioj.

### Komunaj atributoj

Ĉiuj reguloj havas la jenajn atributojn komunaj kaj disponeblas kiam ajn `(common attributes)` aperas. Ĉiuj atributoj estas laŭvolaj.

- attribute: Atributo mapiĝas al difinita itemData. Defaŭlto: attribute el la kunteksto specifita en context atributo.

- context: Specifu la kuntekston, al kiu la reliefiga sistemo ŝanĝas se la regulo kongruas. Defaŭlto: #stay.

- beginRegion: Komenci kodan faldblokon. Defaŭlto: malŝaltita.

- endRegion: Fermi kodan faldblokon. Defaŭlte: malŝaltita.

- lookAhead: Se true, la emfaza sistemo ne prilaboros la kongruan longon. Defaŭlte: false.

- firstNonSpace: Kongruas nur, se la ĉeno estas la unua neblankspaco en la linio. Defaŭlte: false.

- column: Kongruas nur, se la kolumno kongruas. Defaŭlte: malŝaltita.

### Dinamikaj reguloj

Iuj reguloj permesas la laŭvolan atributon `dynamic` de tipo bulea kiu defaŭlte estas false. Se dynamic estas true, regulo povas uzi anstataŭaĵojn reprezentantajn la tekston kongruan per regula esprimo kiu ŝanĝis al la nuna kunteksto en sia `string` aŭ `char` atributoj. En `string`, la lokokupilo `%N` (kie N estas nombro) estos anstataŭigita per la responda kapto `N` de la voka regula esprimo, komencante de 1. En `char` la lokokupilo devas esti nombro `N` kaj ĝi estos anstataŭigita per la unua signo de la responda kapto `N` de la voka regula esprimo. Kiam ajn regulo permesas ĉi tiun atributon ĝi enhavos (dynamic).

- dynamic: povas esti (true|false).

`Kiel ĝi funkcias:`

En la regulaj esprimoj de la reguloj `RegExpr`, ĉio teksto ene de simplaj kurbaj krampoj `(PATTERN)` estas kaptita kaj memorita. Tiuj ĉi kaptoj povas esti uzataj en la kunteksto al kiu ĝi estas ŝanĝita, en la reguloj kun la atributo `dynamic` true, per `%N` (en String) aŭ `N` (en char).

Gravas mencii, ke teksto kaptita en regulo `RegEx` estas nur konservita por la ŝanĝita kunteksto, specifita en ĝia `context`-atributo.

- Se la kaptoj ne estos uzataj, kaj laŭ dinamikaj reguloj kaj en la sama regula esprimo, oni uzu `nekaptajn grupojn`: `(?:PATTERN)`

  La rigardo aŭ malantaŭen grupoj kiel `(?=PATTERN)`, `(?!PATTERN)` aŭ `(?<=PATTERN)` ne estas kaptitaj. Vidu Regulaj esprimoj por pliaj informoj.

- La kaptogrupoj povas esti uzataj ene de la sama regula esprimo, uzante `\N` anstataŭ `%N` respektive. Por pliaj informoj, vidu Kapti kongruan tekston (malantaŭaj referencoj) en Regulaj Esprimoj.

Ekzemplo 1:

En ĉi tiu simpla ekzemplo, la teksto kongrua per la regula esprimo `=*` estas kaptita kaj enmetita en `%1` en la dinamika regulo. Tio ebligas al la komento finiĝi kun la sama kvanto de `=` kiel ĉe la komenco. Ĉi tio kongruas kun teksto kiel: `[[ komento ]]`, `[=[ komento ]=]` aŭ `[=====[ komento ]===== ]`.

Krome, la kaptoj disponeblas nur en la ŝanĝita kunteksto Multlinia Komento.

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

Ekzemplo 2:

En la dinamika regulo, `%1` respondas al la kapto, kiu kongruas kun `#+`, kaj `%2` al `&"+`. Ĉi tio kongruas kun teksto kiel: `#label""""en la kunteksto""""#`.

Tiuj ĉi kaptoj ne estos disponeblaj en aliaj kuntekstoj, kiel AliaKunteksto, FindEscapes aŭ IuKunteksto.

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

Ekzemplo 3:

Ĉi tio kongruas kun teksto kiel: `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>

### Lokaj limigiloj

Iuj reguloj permesas la laŭvolajn atributojn `weakDeliminator` kaj `additionalDeliminator` kiuj estas kombinitaj kun samnomaj atributoj de `keywords`-etikedo. Ekzemple, kiam `'%'` estas malforta limigilo de `keywords`, ĝi povas fariĝi vortlimigilo nur por regulo metante ĝin en sian atributon `additionalDeliminator`. Kiam ajn regulo permesas ĉi tiujn atributojn ĝi enhavos (lokaj limigiloj).

- malfortaDeliminilo: listo de signoj, kiuj ne funkcias kiel vortlimigiloj.

- aldonaDeliminilo: difinas kromajn limilojn.

#### La Reguloj en Detalo

DetectChar

- Detekti ununuran specifan signon. Ofte uzata ekzemple por trovi la finojn de cititaj ĉenoj.

      <DetectChar char="(signo)" (komunaj atributoj) (dinamika) />

  La atributo `char` difinas la signon por kongrui.

Detekti2Chars

- Detekti du specifajn signojn en difinita ordo.

      <Detect2Chars char="(signo)" char1="(signo)" (oftaj atributoj) />

  La atributo `char` difinas la unuan signon kongruan, `char1` la duan.

  Ĉi tiu regulo ĉeestas pro historiaj kialoj kaj por legebleco estas preferinde uzi `StringDetect`.

AnyChar

- Detekti unu signon de aro de specifitaj signoj.

      <AnyChar String="(ĉeno)" (komunaj atributoj) />

  La atributo `String` difinas la aron de signoj.

StringDetect

- Detekti precizan ĉenon.

      <StringDetect String = "(ĉeno)" [insensitive="true|false"] (oftaj atributoj) (dinamika) />

  La atributo `String` difinas la ĉenon kongruan. La atributo `insensitive` defaŭlte estas false kaj estas transdonita al la ĉena kompara funkcio. Se la valoro estas true ne-usklecdistinga komparo estas uzata.

WordDetect

- Detektu precizan ĉenon sed aldone postulas vortlimojn kiel punkton `'.'` aŭ blankspacon ĉe la komenco kaj la fino de la vorto. Pensu pri `\b<string>\b` laŭ regula esprimo, sed ĝi estas pli rapida ol la regulo `RegExpr`.

      <WordDetect String="(ĉeno)" [insensitive="true|false"] (oftaj atributoj) (lokaj limigiloj) />

  La atributo `String` difinas la ĉenon kongruan. La atributo `insensitive` defaŭlte estas false kaj estas transdonita al la ĉena kompara funkcio. Se la valoro estas true ne-usklecdistinga komparo estas uzata.

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

RegEx

- Kongruas kontraŭ regula esprimo.

      <RegExpr String="(ĉeno)" [insensitive="true|false"] [minimal="true|false"] (oftaj atributoj) (dynamic) />

  La atributo `String` difinas la regulan esprimon.

  `insensitive` defaŭlte al false kaj estas transdonita al la regula esprimo-motoro.

  `minimuma` defaŭlte al false kaj estas transdonita al la regula esprimo-motoro.

  Ĉar la reguloj ĉiam kongruas kontraŭ la komenco de la nuna ĉeno, regula esprimo komencanta per signo (`^`) indikas ke la regulo devus esti egalita nur kontraŭ la komenco de linio.

  Vidu Regulaj esprimoj por pliaj informoj pri tiuj.

keyword

- Detekti ŝlosilvorton el difinita listo.

      <keyword String="(listnomo)" (komunaj atributoj) (lokaj limigiloj) />

  La atributo `String` identigas la ŝlosilvortliston laŭ nomo. Listo kun tiu nomo devas ekzisti.

  La elstara sistemo prilaboras ŝlosilvortajn regulojn en tre optimumigita maniero. Ĉi tio igas absolutan neceson, ke ĉiuj ŝlosilvortoj kongruaj devas esti ĉirkaŭitaj de difinitaj limigiloj, aŭ implicitaj (la defaŭltaj limigiloj), aŭ eksplicite specifitaj ene de la eco additionalDeliminator de la keyword etikedo.

  Se kongruota ŝlosilvorto enhavas limigan signon, ĉi tiu respektiva signo devas esti aldonita al la eco weakDeliminator de la etikedo keyword. Ĉi tiu signo tiam perdos sian limigilon en ĉiuj reguloj de keyword. Eblas ankaŭ uzi la atributon weakDeliminator de keyword tiel ke ĉi tiu modifo nur validu por ĉi tiu regulo.

Int

- Detekti entjeron (kiel la regula esprimo: `\b[0-9]+`).

      <Int (komunaj atributoj) (lokaj limigiloj) />

  Ĉi tiu regulo ne havas specifajn atributojn.

Float

- Detekti glitkoman nombron (kiel la regula esprimo: `(\b[0-9]+\.[0-9]*|\.[0-9]+)([eE][- +]?[0-9]+)?`).

      <Float (komunaj atributoj) (lokaj limigiloj) />

  Ĉi tiu regulo ne havas specifajn atributojn.

HlCOct

- Detekti okuman punktonombro-reprezenton (kiel la regula esprimo: `\b0[0-7]+`).

      <HlCOct (komunaj atributoj) (lokaj limigiloj) />

  Ĉi tiu regulo ne havas specifajn atributojn.

HlCHex

- Detekti deksesuman nombro-reprezenton (kiel regula esprimo: `\b0[xX][0-9a-fA-F]+`).

      <HlCHex (komunaj atributoj) (lokaj limigiloj) />

  Ĉi tiu regulo ne havas specifajn atributojn.

HlCStringChar

- Detektu eskapintan signon.

      <HlCStringChar (komunaj atributoj) />

  Ĉi tiu regulo ne havas specifajn atributojn.

  Ĝi kongruas laŭvortajn prezentojn de signoj kutime uzataj en programkodo, ekzemple `\n` (novlinio) aŭ `\t` (TAB).

  La sekvaj signoj kongruos se ili sekvas malantaŭan oblikvon (`\`): `abefnrtv"'?\`. Aldone, eskapintaj deksesumaj nombroj kiel ekzemple `\xff` kaj eskapintaj okumaj nombroj, ekzemple `\033` kongruos.

HlCChar

- Detekti C-signon.

      <HlCChar (komunaj atributoj) />

  Ĉi tiu regulo ne havas specifajn atributojn.

  Ĝi kongruas kun C-signoj enfermitaj en apostrofo (Ekzemplo: `'c'`). La apostrofoj povas esti simpla signo aŭ eskapita signo. Vidu HlCStringChar por egalitaj eskapintaj signosekvencoj.

RangeDetect

- Detekti ĉenon kun difinitaj komencaj kaj finaj signoj.

      <RangeDetect char="(signo)" char1="(signo)" (oftaj atributoj) />

  `char` difinas la signon komencantan la intervalon, `char1` la signon finantan la intervalon.

  Utila por detekti ekzemple malgrandajn cititajn ĉenojn kaj similajn, sed rimarku, ke ĉar la reliefiga motoro funkcias sur unu linio samtempe, ĉi tio ne trovos ĉenojn etendantajn super liniorompo.

LinioDaŭrigi

- Kongruas kun specifita signo ĉe la fino de linio.

      <LineContinue (komunaj atributoj) [char="\"] />

  `char` laŭvola signo por kongrui, defaŭlta estas malantaŭa oblikvo (`'\'`). Nova ekde &kde; 4.13.

  Ĉi tiu regulo estas utila por ŝanĝi kuntekston ĉe fino de linio. Ĉi tio necesas ekzemple en C/C++ por daŭrigi makroojn aŭ ĉenojn.

Inkluzivi Regulojn

- Enmeti regulojn de alia kunteksto aŭ lingvo/dosiero.

      <IncludeRules context="contextlink" [includeAttrib="true|false"] />

  La atributo `context` difinas kiun kuntekston inkluzivi.

  Se ĝi estas simpla ĉeno, ĝi inkluzivas ĉiujn difinitajn regulojn en la nunan kuntekston, ekzemple:

      <IncludeRules context="aliaKunteksto" />

  Se la ĉeno enhavas `##` la reliefigsistemo serĉos kuntekston el alia lingvodifino kun la persona nomo, ekzemple

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

  inkluzivus la kuntekston String el la C++-reliefiga difino.

  Se la atributo `includeAttrib` estas true, ŝanĝi la cel-atributon al tiu de la fonto. Ĉi tio estas bezonata por ke, ekzemple, komentu funkciu, se teksto kongrua per la inkluzivita kunteksto estas malsama kulminaĵo de la gastiga kunteksto.

DetectSpaces

- Detekti blankspacojn.

      <DetectSpaces (komunaj atributoj) />

  Ĉi tiu regulo ne havas specifajn atributojn.

  Uzu ĉi tiun regulon se vi scias, ke povas esti pluraj blankspacoj antaŭe, ekzemple en la komenco de indentitaj linioj. Ĉi tiu regulo preterlasos ĉiujn blankspacojn samtempe, anstataŭ testi plurajn regulojn kaj preterlasi unu samtempe pro neniu kongruo.

DetektiIdentigilo

- Detekti identigajn ĉenojn (kiel la regula esprimo: `[a-zA-Z_][a-zA-Z0-9_]*`).

      <DetectIdentifier (komunaj atributoj) />

  Ĉi tiu regulo ne havas specifajn atributojn.

  Uzu ĉi tiun regulon por preterlasi ĉenon de vortsignoj samtempe, anstataŭ provi kun pluraj reguloj kaj salti unuope pro neniu kongruo.

#### Konsiloj & Trukoj

Post kiam vi komprenis kiel funkcias la kuntekstoŝanĝo, estos facile skribi elstarajn difinojn. Tamen vi devas zorge kontroli kian regulon vi elektas en kiu situacio. Regulaj esprimoj estas tre potencaj, sed ili estas malrapidaj kompare kun la aliaj reguloj. Do vi povas konsideri la sekvajn konsiletojn.

- Regulaj esprimoj estas facile uzeblaj sed ofte ekzistas alia multe pli rapida maniero atingi la saman rezulton. Konsideru, ke vi volas kongrui kun la signo `'#'` nur se ĝi estas la unua signo en la linio. Solvo bazita en regula esprimo aspektus jene:

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

  Vi povas atingi la samon multe pli rapide uzante :

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

  Se vi volas kongrui kun la regula esprimo `'^#'` vi ankoraŭ povas uzi `DetectChar` kun la atributo `column="0"`. La atributo `column` nombras signojn, do tabelilo estas nur unu signo.

- En reguloj `RegExpr`, uzu la atributon `column="0"` se la ŝablono `^PATTERN` estos uzata por kongrui tekston komence de linion. Ĉi tio plibonigas rendimenton, ĉar ĝi evitos serĉi kongruojn en la ceteraj kolumnoj.

- En regulaj esprimoj, uzu nekaptajn grupojn `(?:PATTERN)` anstataŭ kapti grupojn `(PATTERN)`, se la kaptoj ne estos uzataj en la sama regula esprimo aŭ en dinamikaj reguloj. Ĉi tio evitas konservi kaptojn nenecese.

- Vi povas ŝanĝi kuntekstojn sen prilabori signojn. Supozu, ke vi volas ŝanĝi kuntekston kiam vi renkontas la ĉenon `*/`, sed bezonas prilabori tiun ĉenon en la sekva kunteksto. La suba regulo kongruos, kaj la atributo `lookAhead` igos la reliefigilon konservi la kongruan ĉenon por la sekva kunteksto.

      <StringDetect attribute="Comment" context="#pop" String="*/" lookAhead="true" />

- Uzu `Detekti Spacojn` se vi scias ke multaj blankspacoj okazas.

- Uzu `DetectIdentifier` anstataŭ la regula esprimo `'[a-zA-Z_]\w*'`.

- Uzu defaŭltajn stilojn kiam ajn vi povas. Tiel la uzanto trovos konatan medion.

- Rigardu aliajn &XML; dosierojn por vidi kiel aliaj homoj efektivigas malfacilajn regulojn.

- Vi povas validigi ĉiun &XML;-dosieron per la komando `validatehl.sh mySyntax.xml`. La dosiero `validatehl.sh` uzas `language.xsd` kiuj ambaŭ estas disponeblaj en Deponejo pri sintaksa reliefigo.

- Se vi ripetas kompleksan regulan esprimon tre ofte, vi povas uzi ENTOJN. Ekzemplo:

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

  Nun vi povas uzi &miaref; anstataŭ la regula esprimo.

- En Kate Editor, vi povas reŝargi sintaksojn uzante la enkonstruitan komandlinion (`F7` ŝparvojo defaŭlte) kaj la komandon `reload-highlighting`.

- Vi povas uzi la komandlinian ilon nomitan `ksyntaxhighlighter6` (`kate-syntax-highlighter` ĉe pli malnovaj versioj) por testi sintakson kaj montri la stilon kaj regionojn asociitajn kun ĉiu parto de teksto.

  Rezulto de `ksyntaxhighlighter6 --output-format=ansi --syntax-trace=format test.cpp`.

  Rezulto de `ksyntaxhighlighter6 --output-format=ansi --syntax-trace=format test.cpp`.

  Uzu `ksyntaxhighlighter6 -h` por pliaj opcioj.

## Laborante kun Koloraj Etosoj

### Superrigardo

Koloretosoj difinas la kolorojn de la tekstredakta areo kaj la sintaksreliefigo. Koloretoso ampleksas la jenon:

- La teksta stilo, uzata por sintaksa reliefigo per la defaŭltaj stilaj atributoj. Ekzemple, la tekstokoloro kaj la elektita tekstokoloro.

- La fono de la teksta redakta areo, inkluzive de la tekstoelekto kaj la aktuala linio.

- La piktograma rando de la teksta areo: ilia fono, la apartlinio, la linionumeroj, la liniaj vortvolvaj markiloj, la modifitaj linimarkoj kaj la koda faldado.

- Tekstaj dekoraciistoj kiel ekzemple la serĉsignoj, la indentaĵo kaj tab-/spac-liniomarkoj, la kongruo de krampoj kaj la literuma kontrolo.

- Legosignoj kaj fragmentoj.

Por eviti konfuzon, la jena estas ekstere de amplekso:

- La tiparo kaj la tipa grandeco.

- La koloroj de la tekstredakta aplikaĵo, kiel la rulumbreta mapo, la menuoj, la langetobreto, la fenestrokoloro, ktp. En &kde;-aplikoj, kiel &kate; aŭ &kdevelop;, ĉi tiuj koloroj estas difinitaj per la `&kde; &plasma; ĉiea kolorskemo`, kiuj estas fiksitaj en la modulo Koloroj en &systemsettings; aŭ de la aplikaĵo mem en la menuo Agordoj Kolorskemo.

Breeze Light kaj Breeze Dark koloretosoj kun la sintaksa reliefigo de C++.

Breeze Light kaj Breeze Dark koloretosoj kun la sintaksa reliefigo de C++.

### La KSyntaxHighlighting Koloraj Etosoj

La KSyntaxHighlighting kadro, kiu estas la sintaksreliefigo-motoro, estas la biblioteko kiu `provizas kaj administras la koloretosojn`. Ĉi tio estas parto de &kde; &frameworks; kaj estas uzata en &kde; tekstredaktiloj kiel &kate;, &kwrite;, &kile; kaj &kdevelop;. Ĉi tiu dependeco aspektas kiel jena:

Dependeco de &kde; &frameworks; 5 bibliotekoj pri tekstoredaktiloj.

Dependeco de &kde; &frameworks; bibliotekoj pri tekstoredaktiloj.

KSyntaxHighlighting inkluzivas diversajn enkonstruitajn etosojn kiuj estas montritaj sur la paĝo Koloraj Etosoj de la retejo de Kate-redaktilo. .

La kadro KTextEditor, kiu estas la tekstoredaktadmotoro, disponigas uzantinterfacon por krei kaj redakti koloretosojn , inkluzive de ilo por importi kaj eksporti etosojn. Ĉi tio estas la plej simpla maniero krei kaj redakti ilin, vi povas aliri ĝin de la Agordi dialogo de la tekstredaktilo. Pliaj detaloj en color-themes-gui.

La &GUI; por administri koloretosojn en la agordoj de &kate;.

La &GUI; por administri kolorajn etosojn en la agordoj de &kate;.

Estas grave mencii ke, en la &kde; tekstredaktiloj kiel &kate; aŭ &kdevelop;, la koloretosoj de KSyntaxHighlighting estas uzataj ekde &kde; &frameworks; 5.75, publikigita la 10-an de oktobro 2020. Antaŭe, la kolorskemoj de &kate; (skem-agordo bazita en KConfig) estis uzataj kaj nun estas malrekomenditaj. Tamen, eblas konverti la malnovan &kate; skemoj al la koloretosoj de KSyntaxHighlighting. La KSyntaxHighlighting-deponejo inkluzivas la `utils/kateschema_to_theme_converter.py` skripton kaj la `utils/schema-converter/` ilo por tiu celo.

### La Koloraj Etosoj &JSON; Formato

#### Superrigardo

Koloraj etosoj estas konservitaj en JSON; formataj dosieroj, kun la etendo `.theme`.

En la KSyntaxHighlighting fontkodo, la &JSON; dosieroj de enkonstruitaj etosoj troviĝas en la dosierujo `data/themes/`. Notu, ke en tekstredaktiloj, la enkonstruitaj etosoj estas kompilitaj en la bibliotekon KSyntaxHighlighting, tial la maniero aliri ilin estas per la fontkodo aŭ per eksportante ilin el la &GUI; por administri etosojn de KTextEditor.

Ankaŭ eblas facile aldoni pliajn aŭ proprajn etosojn, kiuj estas ŝargitaj de la dosiersistemo. Uzant-personigitaj etosdosieroj troviĝas en la dosierujo `org.kde.syntax-highlighting/themes/` en via uzantdosierujo, kiun vi povas trovi per la komando ``qtpaths``--paths GenericDataLocation`` kaj estas kutime ``$HOME`/.local/share/` kaj `/usr/share/`.

En Flatpak kaj Snap-pakaĵoj, ĉi-supra dosierujo ne funkcios ĉar la datuma loko estas malsama por ĉiu aplikaĵo. En Flatpak-aplikaĵo, la loko de propraj etosdosieroj estas kutime ``$HOME`/.var/app/`flatpak-package-name` /data/org.kde.syntax-highlighting/themes/` kaj en Snap-aplikaĵo tiu loko estas ``$HOME`/snap/`snap-package-name`/current/.local/share/org.kde.syntax-highlighting/themes/`.

Sur &Windows; ĉi tiuj dosieroj troviĝas `%USERPROFILE%\AppData\Local\org.kde.syntax-highlighting hemes`. `%USERPROFILE%` kutime vastiĝas al `C:\Users\`uzantnomo``.

Resume, por la plej multaj agordoj la propraj etosoj dosierujo estas jena:

Por loka uzanto | ``$HOME`/.local/share/org.kde.syntax-highlighting/themes/`
Por ĉiuj uzantoj | `/usr/share/org.kde.syntax-highlighting/themes/`
Por Flatpak-pakaĵoj | ``$HOME`/.var/app/`flatpak-package-name`/data/org.kde.syntax-highlighting/themes/`
Por Snap-pakaĵoj | ``$HOME`/snap/`snap-package-name`/current/.local/share/org.kde.syntax-highlighting/themes/`
Sur &Windows; | `%USERPROFILE%\AppData\Local\org.kde.syntax-highlighting hemes`

Se ekzistas pluraj etosodosieroj kun la sama nomo, la dosiero kun la plej alta `revizio` estos ŝargita.

#### La &JSON; Strukturo

La strukturo de &JSON; dosiero estas klarigita en ilia retejo. Esence, &JSON; formato dosiero konsistas el:

- Kolektoj de ŝlosilaj/valoraj paroj, apartigitaj per komoj kaj grupigitaj en `{ }` kiujn ni nomos objektoj.

- Ordigitaj valorlistoj, apartigitaj per komoj kaj grupigitaj en `[ ]` kiun ni nomos tabelo.

La nomenklaturo ŝlosilo, valoro, objekto kaj tabelo estos uzataj en ĉi tiu artikolo. Se ĉi tio estas via unua fojo laboranta kun &JSON; dosierojn, kompreni ilin estas tiel simple kiel rigardi la ekzemplojn sube.

#### Ĉefaj Sekcioj de la &JSON; Koloraj Etosoj Dosieroj

La radika objekto de la koloretoso &JSON; dosiero enhavas la sekvajn skemajn ŝlosilojn:

- `metadatenoj`: Ĝi estas deviga. La valoro estas objekto kun la metadatenoj de la etoso, kiel nomo, revizio kaj permesilo.

  Ĉi tio estas detala en color-themes-json-metadata.

- `editor-colors`: Ĝi estas deviga. La valoro estas objekto kun la koloroj de la teksta redakta areo, kiel la fono, la piktogramo kaj la teksta ornamado.

  Ĉi tio estas detala en color-themes-editor-colors.

- `teksto-stiloj`: Ĝi estas deviga. La valoro estas objekto kun la defaŭlta tekstostilo atributoj de la sintaksa reliefigo. Ĉiu eco difinas sian tekstokoloron, ĝian elektitan tekstokoloron, aŭ ĉu ĝi ekzemple grasa aŭ kursiva. La tekstostiloj povas esti referencitaj de la atributoj de la sintaksdifinaj &XML;-dosieroj.

  Ĉi tio estas detala en color-themes-text-styles.

- `personaj stiloj`: Ĝi estas laŭvola. Difinas tekstajn stilojn por la atributoj de specifaj sintakso elstarigante difinojn. Ekzemple, en reliefiga difino kiel `Python` aŭ `Markdown` vi povas specifi malsaman tekstostilon, kiu anstataŭas la defaŭltan difinitan en `teksto-stiloj`.

  Ĉi tio estas detala en color-themes-custom-styles.

La &JSON; lingvo ne subtenas komentojn. Tamen, vi povas uzi la laŭvolan klavon `_comments` en la radika objekto por skribi komentojn, ekzemple, se vi adaptas ekzistantan etoson vi povas meti la URL de la originala deponejo. La plej praktika maniero estas uzi tabelon de ĉenoj.

Malsupre estas ekzempla dosiero por la etoso Breeze Light. Vi povas rimarki ke, por eviti ke la ekzemplo estu tro granda, la objektoj `editor-colors` kaj `text-stiloj` ne enhavas ĉiujn postulatajn ŝlosilojn. Vi povas vidi la plenan arkivon de la Breeze Light etoso en la KSyntaxHighlighting-deponejo.

    {
        "_comments": [
            "Ĉi tio estas komento.",
            "Se ĉi tiu etoso estas adapto de alia, metu la ligilon al la origina deponejo."
        ],
        "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",
            La aliaj redaktilaj kolorklavoj...

        },
        "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"
            },
            La aliaj tekstaj stilklavoj...

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

#### Metadatenoj

La &JSON; objekto de la ŝlosilo `metadata` enhavas koncernajn informojn pri la etoso. Ĉi tiu objekto havas la sekvajn ŝlosilojn:

- `nomo`: Ĝi estas ĉeno fiksas la nomon de la lingvo. Ĝi aperas poste en la menuoj kaj dialogoj. Ĝi estas deviga.

- `revizio`: Ĝi estas entjera nombro kiu specifas la nunan revizion de la etosodosiero. Kiam ajn vi ĝisdatigas koloretosan dosieron, certigu pliigi ĉi tiun nombron. Ĝi estas deviga.

- `licenco`: Ĝi estas ĉeno kiu difinas la permesilon de la etoso, uzante la identigilon `SPDX-License-Identifier` el la norma SPDX-licenca komunikformato. Ĝi estas laŭvola.

  Vi povas vidi la plenan liston de SPDX-licencaj identigiloj ĉi tie.

- `kopirajto`: Ĝi estas tabelo de ĉenoj kiu specifas la aŭtorojn de la etoso, uzante la identigilon `SPDX-FileCopyrightText` de la norma SPDX-licenca komunika formato. Ĝi estas laŭvola.

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

### Koloroj en Detalo

Ĉi tiu sekcio detaligas ĉiujn disponeblajn kolorajn atributojn kaj disponeblajn kolorajn agordojn.

#### Redaktilaj Koloroj

Korespondas al la koloroj de la tekstredakta areo.

En la &JSON; etosodosiero, la respektiva klavo `editor-colors` havas kiel valoron objekton kie ĉiu ŝlosilo referencas al atributokoloro de la tekstredaktilo. Ĉi tie, `ĉiuj disponeblaj ŝlosiloj estas devigaj`, iliaj valoroj estas `ĉenoj` kun deksesuma kolorkodoj, kiel #00B5CF.

En la &GUI; por administri etosojn de KTextEditor, ĉi tiuj atributoj povas esti modifitaj en la langeto `Koloroj`.

La disponeblaj ŝlosiloj estas la jenaj; la ŝlosiloj uzataj en la &JSON; dosiero estas listigitaj en grasa, la nomoj uzataj en la &GUI; estas montritaj inter krampoj.

Redaktilaj Fonkoloroj

- `BackgroundColor` (Teksta Areo)

- Ĉi tio estas la defaŭlta fono por la redaktila areo, ĝi estos la domina koloro sur la redaktilareo.

`TextSelection` (Elektita Teksto)

- Ĉi tio estas la fono por elektita teksto.

`CurrentLine` (Nuna Linio)

- Agordu la koloron por la nuna linio. Agordi ĉi tion iom diferenca de la Normala tekstfono helpas konservi fokuson sur la nuna linio.

`SearchHighlight` (Serĉa Reliefigo)

- Agordu la koloron por la teksto, kiu kongruas kun via lasta serĉo.

`ReplaceHighlight` (Anstataŭiga Reliefigo)

- Agordu la koloron por la teksto, kiu kongruas kun via lasta anstataŭiga operacio.

Piktograma Bordo

- `IconBorder` (Fona Areo)

- Ĉi tiu koloro estas uzata por la markoj, lininumeroj kaj faldmarkilaj bordoj en la maldekstra flanko de la redaktora vido kiam ili estas montrataj.

`LineNumbers` (Linionumeroj)

- Ĉi tiu koloro estas uzata por desegni la linionumerojn sur la maldekstra flanko de la vido kiam estas montrata.

`CurrentLineNumber` (Aktuala Linionumero)

- Ĉi tiu koloro estas uzata por desegni la linionumeron de la nuna linio, sur la maldekstra flanko de la vido kiam montrata. Agordi ĉi tion iom diferenca de Linenumeroj helpas konservi fokuson sur la nuna linio.

`Apartilo` (Apartilo)

- Ĉi tiu koloro estas uzata por desegni la vertikalan linion, kiu apartigas la piktograman bordon de la fono de la tekstareo.

`WordWrapMarker` (WordWrap Marker)

- Ĉi tiu koloro estas uzata por desegni ŝablonon maldekstre de dinamike envolvitaj linioj kiam tiuj estas vicigitaj vertikale, same kiel por la senmova vortvolva markilo.

`CodeFolding` (Kodofaldado)

- Ĉi tiu koloro estas uzata por reliefigi la sekcion de kodo, kiu estus faldita kiam vi alklakas la kodan faldsagon maldekstre de dokumento. Por pliaj informoj, vidu la dokumentadon pri kodfaldo.

`Modifitaj Linioj` (Modifitaj Linioj)

- Ĉi tiu koloro estas uzata por reliefigi maldekstre de dokumento linioj kiuj estis modifitaj sed ankoraŭ ne konservitaj. Por pliaj informoj, vidu kate-part-line-modification.

`SavedLines` (Konservitaj Linioj)

- Ĉi tiu koloro estas uzata por reliefigi maldekstre de dokumentlinioj kiuj estis modifitaj ĉi tiun sesion kaj konservitaj. Por pliaj informoj, vidu kate-part-line-modification.

Tekstaj Dekoracioj

- `SpellChecking` (Literuma Erarlinio)

- Ĉi tiu koloro estas uzata por indiki literumajn erarojn.

`TabMarker` (Tabaj kaj Spacetaj Markiloj)

- Ĉi tiu koloro estas uzata por desegni blankspacajn indikilojn, kiam ili estas ebligitaj.

`IndentLine` (Deŝova Linio)

- Ĉi tiu koloro estas uzata por desegni linion maldekstre de deŝovitaj blokoj, se tiu funkcio estas ebligita.

`BracketMatching` (Kramp-Elstarigo)

- Ĉi tiu koloro estas uzata por desegni la fonon de kongruaj krampoj.

Markilaj Koloroj

- `MarkBookmark` (Legomarki)

- Ĉi tiu koloro estas uzata por indiki legosignojn. Notu, ke ĉi tiu koloro havas opakecon de 22% (kaj 33% por la nuna linio) rilate al la fono. Por pliaj informoj, vidu kate-part-bookmarks.

`MarkBreakpointActive` (Aktiva Paŭzpunkto)

- Ĉi tiu koloro estas uzata de la GDB-kromaĵo por indiki aktivan paŭzpunkton. Rimarku, ke ĉi tiu koloro havas opakecon al la fono. Por pliaj informoj, vidu la dokumentaron pri GDB-Aldonaĵo.

`MarkBreakpointReached` (Atingita Paŭzopunkto)

- Ĉi tiu koloro estas uzata de la GDB-kromaĵo por indiki rompopunkton, kiun vi atingis dum senararigado. Rimarku, ke ĉi tiu koloro havas opakecon al la fono. Por pliaj informoj, vidu la dokumentaron pri GDB-Aldonaĵo.

`MarkBreakpointDisabled` (Malŝaltita Breakpoint)

- Ĉi tiu koloro estas uzata de la GDB-kromaĵo por indiki neaktivan rompopunkton. Rimarku, ke ĉi tiu koloro havas opakecon al la fono. Por pliaj informoj, vidu la dokumentaron pri GDB-Aldonaĵo.

`MarkExecution` (Efektivigo)

- Ĉi tiu koloro estas uzata de la GDB-kromaĵo por la linio aktuale efektiviĝanta. Rimarku, ke ĉi tiu koloro havas opakecon al la fono. Por pliaj informoj, vidu la dokumentaron pri GDB-Aldonaĵo.

`MarkWarning` (Averto)

- Ĉi tiu koloro estas uzata de la konstrukromaĵo por indiki linion, kiu kaŭzis kompililan averton. Rimarku, ke ĉi tiu koloro havas opakecon al la fono. Por pliaj informoj, vidu la dokumentaron pri Konstrua Kromaĵo.

`MarkError` (Eraro)

- Ĉi tiu koloro estas uzata de la konstrukromaĵo por indiki linion, kiu kaŭzis kompililan eraron. Rimarku, ke ĉi tiu koloro havas opakecon al la fono. Por pliaj informoj, vidu la dokumentaron pri Konstrua Kromaĵo.

Tekstaj Ŝablonoj & Fragmentoj

- `Ŝablona Fono` (Fono)

- Ĉi tiu koloro estas uzata de la &kate; Kromaĵo de fragmentoj por marki la fonon de fragmento. Por pliaj informoj, vidu la &kate; Dokumentado pri fragmentoj.

`TemplatePlaceholder` (Redaktebla Lokokupilo)

- Ĉi tiu koloro estas uzata de la &kate; Aldonaĵo de fragmentoj por marki lokokupilon, kiun vi povas alklaki por redakti mane. Por pliaj informoj, vidu la &kate; Dokumentadon pri fragmentoj.

`TemplateFocusedPlaceholder` (Enfokusigita Redaktebla Lokokupilo)

- Ĉi tiu koloro estas uzata de la &kate; Aldonaĵo de fragmentoj por marki la lokokupilon, kiun vi nun redaktas. Por pliaj informoj, vidu la &kate; Dokumentado pri fragmentoj.

`TemplateReadOnlyPlaceholder` (Ne Redaktebla Lokokupilo)

- Ĉi tiu koloro estas uzata de la &kate; Aldonaĵo de fragmentoj por marki lokokupilon, kiu ne povas esti redaktita permane, kiel tiu, kiu estas aŭtomate plenigita. Por pliaj informoj, vidu la &kate; Dokumentado pri fragmentoj.

#### Defaŭltaj Tekstaj Stiloj

La defaŭltaj tekstaj stiloj estas hereditaj de la elstaraj tekstostiloj, permesante al la redaktilo prezenti tekston en tre konsekvenca maniero, ekzemple komenta teksto uzas la saman stilon en preskaŭ ĉiuj tekstformatoj kiujn KSyntaxHighlighting povas reliefigi.

Tiuj ĉi tekstostiloj povas esti referencitaj de la `defaŭltaj stiloj` uzataj en sintakso reliefigo difino &XML; dosierojn, ekzemple, la atributo Normala estas ekvivalenta al dsNormal en la &XML; dosieroj, kaj DataType estas ekvivalenta al dsDataType. Vidu kate-highlight-default-styles en la dokumentaro pri sintaksa reliefigo.

Nepre elektu legeblajn kolorojn kun bona kontrasto precipe en kombinaĵo kun la `Redaktilaj Koloroj`. Vidu color-themes-contrast.

En la &JSON; dosiero, la respektiva klavo `tekstaj stiloj` havas kiel valoron objekton kie ĉiu klavo respondas al la nomo de defaŭlta tekstostilo , kiuj estas ekvivalentaj al tiuj uzataj en la sintakso elstarigante difinojn. Ĉi tie, `ĉiuj disponeblaj tekststilaj klavoj estas devigaj`, ĉi tiuj estas listigitaj sube.

    "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"
        },
        La aliaj tekststilaj klavoj...
    }

Ĉiu ŝlosilo de defaŭlta teksta stilo havas &JSON; objekto kiel ĝia valoro, kie valoroj kiel koloro, grasa, kursivo, ktp. Ĉi tiuj klavoj estas kiel sekvas:

- `teksto-koloro`: Ĝi estas ĉeno kun la tekstkoloro en deksesuma kolorkodo. Ĉi tiu ŝlosilo/valoro estas postulata.

  `elektita-teksto-koloro`: La tekstokoloro kiam ĝi estas elektita estas ĝenerale la sama valoro kiel text-color. Kiam la teksto estas elektita, la fono estas difinita per la valoro de TextSelection en la Redaktilaj Koloroj, do vi devas certigi, ke la teksto havas bonan kontraston kaj estas legebla kun ĉi tiu fono. La valoro estas ĉeno kun deksesuma kolorkodo. Ĉi tiu ŝlosilo/valoro estas postulata.

  `grasa`: Ĝi estas bulea kiu determinas ĉu la teksto estas grasa. Ĉi tiu ŝlosilo estas laŭvola, la defaŭlta valoro estas `false`.

  `kursivo`: Ĝi estas bulea kiu determinas ĉu la teksto estas kurba. Ĉi tiu ŝlosilo estas laŭvola, la defaŭlta valoro estas `false`.

  `substreki`: Ĝi estas bulea kiu determinas ĉu la teksto estas substrekita. Ĉi tiu ŝlosilo estas laŭvola, la defaŭlta valoro estas `false`.

  `streko`: Ĝi estas bulea kiu determinas ĉu la teksto estas trastrekita. Ĉi tiu ŝlosilo estas laŭvola, la defaŭlta valoro estas `false`.

  `fono-koloro`: Determinas la fonon de la teksto, uzata ekzemple en atentigoj en komentoj. La valoro estas ĉeno kun deksesuma kolorkodo. Ĉi tiu ŝlosilo estas laŭvola, defaŭlte ne ekzistas fono.

  `elektita-fono-koloro`: Determinas la fonon de la teksto kiam ĝi estas elektita. La valoro estas ĉeno kun deksesuma kolorkodo. Ĉi tiu ŝlosilo estas laŭvola, defaŭlte ne ekzistas fono.

En la &GUI; por administri koloretosojn de KTextEditor, ĉi tiuj atributoj povas esti modifitaj en la langeto `Defaŭltaj Tekstaj Stiloj`. La nomo en la listo de stiloj uzas la stilon agordita por la ero, provizante al vi tujan antaŭrigardon dum agordado de stilo. Ĉiu stilo ebligas al vi elekti komunajn atributojn same kiel malfonojn kaj fonkolorojn. Por nuligi fonkoloron, dekstre alklaku por uzi la kuntekstan menuon.

La disponeblaj tekstostilaj ŝlosiloj estas la jenaj; la ŝlosiloj uzataj en la &JSON; dosiero estas listigitaj en grasa, la nomoj uzataj en la &GUI; estas montritaj inter krampoj se ili estas malsamaj.

Normala Teksto & Fonta Kodo

- `Normal`: Defaŭlta tekststilo por normala teksto kaj fontkodo sen speciala reliefigo.

  `Keyword`: Teksta stilo por enkonstruitaj lingvaj ŝlosilvortoj.

  `Function`: Teksta stilo por funkciodifinoj kaj funkciovokoj.

  `Variable`: Teksta stilo por variabloj, se aplikeble. Ekzemple, variabloj en PHP/Perl kutime komenciĝas per `$`, do ĉiuj identigiloj sekvantaj la ŝablonon `$foo` estas emfazitaj kiel variablo.

  `ControlFlow` (Control Flow): Tekstostilo por kontrolfluaj ŝlosilvortoj, kiel if, then, else, return, switch, break, yield, continue, ktp.

  `Operator`: Teksta stilo por operatoroj, kiel `+`, `-`, `*`, `/`, `%`, ktp.

  `BuiltIn` (Built-in): Teksta stilo por enkonstruitaj lingvoklasoj, funkcioj kaj objektoj.

  `Extension`: Teksta stilo por konataj etendaĵoj, kiel &Qt; klasoj, funkcioj/makrooj en C++ kaj Python aŭ boost.

  `Preprocessor`: Tekstostilo por antaŭprocesoraj deklaroj aŭ makrodifinoj.

  `Attribute`: Teksta stilo por komentarioj aŭ atributoj de funkcioj aŭ objektoj, ekz. `@override` en Java, aŭ `__declspec(...)` kaj `__attribute__((...))` en C++.

Nombroj, Tipoj & Konstantoj

- `DataType` (Data Type): Teksta stilo por enkonstruitaj datumtipoj kiel int, char, flosi, malplenigo, u64, ktp.

  `DecVal` (Decimal/Value): Teksta stilo por dekumaj valoroj.

  `BaseN` (Base-N Integer): Teksta stilo por nombroj kun bazo alia ol 10.

  `Float` (Floating Point): Teksta stilo por glitpunktaj nombroj.

  `Constant`: Teksta stilo por lingvaj konstantoj kaj uzant-difinitaj konstantoj, ekz. True, False, None en Python aŭ nullptr en C/C++; aŭ matematikaj konstantoj kiel PI.

Ĉenoj & Signoj

- `Char` (Signo): Teksta stilo por unuopaj signoj kiel `'x'`.

  `SpecialChar` (Speciala Signo): Tekstostilo por eskapintaj signoj en ĉenoj, ekz. `saluton\n`, kaj aliajn signojn kun speciala signifo en ĉenoj, kiel anstataŭaĵoj aŭ regex operatoroj.

  `String`: Teksta stilo por ĉenoj kiel `saluton mondo`.

  `VerbatimString` (Verbatim String): Tekstostilo por laŭvortaj aŭ krudaj ĉenoj kiel `'raw \backlash'` en Perl, CoffeeScript, kaj ŝeloj, kiel same kiel `r'\raw'` en Python, aŭ kiel ĈI TIE dokumentoj.

  `SpecialString` (Speciala Ĉeno): Teksta stilo por specialaj ĉenoj, kiel regulaj esprimoj en ECMAScript, la &latex; matematika reĝimo, SQL, ktp.

  `Import` (Importadoj, Moduloj, Inkludoj): Tekstostilo por inkludoj, importadoj, moduloj aŭ &latex; pakoj.

Komentoj & Dokumentado

- `Comment`: Teksta stilo por normalaj komentoj.

  `Documentation`: Teksta stilo por komentoj kiuj reflektas API-dokumentadon, kiel ekzemple `/** doxygen-komentoj */` aŭ `"""docstrings"""`.

  `Annotation`: Teksta stilo por komentoj en komentoj aŭ dokumentaj komandoj, kiel `@param` en Doxygen aŭ JavaDoc.

  `CommentVar` (Komenta Variablo): Tekstostilo kiu rilatas al variablo-nomoj uzataj en supraj komandoj en komento, kiel `foobar` en `@param foobar`, en Doxygen aŭ JavaDoc.

  `RegionMarker` (Regiona markilo): Teksta stilo por regionmarkoj, kutime difinita per `//BEGIN` kaj `//END` en komentoj.

  `Information`: Teksta stilo por informoj, notoj kaj konsiloj, kiel la ŝlosilvorto `@noto` en Doxygen.

  `Warning`: Teksta stilo por avertoj, kiel la ŝlosilvorto `@warning` en Doxygen.

  `Alert`: Teksta stilo por specialaj vortoj en komentoj, kiel `TODO`, `FIXME`, `XXXX` kaj `AVERTO` .

Diversaj

- `Error`: Teksta stilo indikanta eraran reliefigon kaj malĝustan sintakson.

  `Aliaj`: Teksta stilo por atributoj kiuj ne kongruas kun iu ajn el la aliaj defaŭltaj stiloj.

#### Propraj Reliefigaj Tekstostiloj

Ĉi tie vi povas establi tekstajn stilojn por specifa sintaksa emfaza difino, superregante la `defaŭltan tekstostilon` priskribitan en la antaŭa sekcio .

En la &JSON; etosodosiero, ĉi tio respondas al la ŝlosilo `personaj stiloj`, kies valoro estas objekto kie ĉiu subskema ŝlosilo respondas al la `nomo de sintaksa reliefigo-difino`. Ĝia valoro estas objekto kie ĉiu ŝlosilo referencas al la `nomo de stilaj atributoj` difinita en la `itemData` elementoj de la sintakso reliefiganta &XML; dosiero, kaj la respektiva valoro estas subobjekto kun la klavoj text-color, selected-text-color, grasa, kursivo, substreki, streko, fonkoloro kaj elektita fonkoloro, difinita en la antaŭa sekcio. Ĉiu el ĉi tiuj valoroj estas nedeviga, ĉar se ili ne ĉeestas, la stilo fiksita en `teksto-stiloj` estas konsiderata.

Ekzemple, en ĉi tiu kodo, la sintaksa emfaza difino de ISO C++ havas specialan tekstan stilon por la atributoj Tipo-Modifiloj kaj Normaj Klasoj. En la responda &XML; dosiero isocpp.xml, la difinita atributo Normaj Klasoj uzas la defaŭltan stilon `BuiltIn` (aŭ dsBuiltIn). En ĉi tiu eco, nur la valoro de `teksto-koloro` estas anstataŭita de la nova koloro #6431b3.

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

- Vi devus konsideri, ke ĉi tiuj tekstaj stiloj estas asociitaj kun la atributaj nomoj difinitaj en la sintaksa reliefigo &XML; dosierojn. Se XML-dosiero estas ĝisdatigita kaj iuj atributoj estas renomitaj aŭ forigitaj, la propra stilo difinita en la etoso ne plu aplikiĝos.

- Sintakso elstariganta difinojn ofte inkluzivas aliajn difinojn. Ekzemple, la markilo QML inkluzivas la markilon JavaScript, ĉar ili kunhavas funkciojn en reliefigo.

En la &GUI; por administri etosojn de KTextEditor, ĉi tiuj atributoj povas esti modifitaj en la langeto `Elstarigado de Tekstaj Stiloj`. Defaŭlte, la redaktilo antaŭelektas la reliefigon de la nuna dokumento. Vi rimarkos, ke multaj lumaĵoj enhavas aliajn lumaĵojn reprezentitajn de grupoj en la stillisto. Ekzemple la plej multaj elstaraĵoj importas la emfazon Atento, kaj multaj fontkodformatoj importas la elstaraĵon Doxygen.

### La Koloraj Etosoj &GUI;

La plej simpla maniero krei kaj redakti kolorajn etosojn estas per la &GUI; ene de la dialogo Agordu provizita de KTekstRedaktilo. Por aliri ĝin, elektu Agordoj Agordu `Apliko`... el la menubreto en via tekstredaktilo. Ĉi tio aperigas la dialogujon Agordu, tie elektu Koloraj Etosoj en la flanka panelo.

La agorda dialogujo de &kate; kun la kolora etoso-administrado.

La agorda dialogujo de &kate; kun la koloretoso-administrado.

En ĉi tiu dialogo vi povas agordi ĉiujn kolorojn en iu ajn etoso, kiun vi havas, kaj ankaŭ krei/kopii novajn etosojn, forigi ilin, eksporti ilin al `.theme` dosiero kun &JSON; formati aŭ importi ilin el eksteraj `.theme` dosieroj. Ĉiu etoso havas agordojn por tekstaj koloroj kaj stiloj.

La enkonstruitaj etosoj ne povas esti modifitaj defaŭlte. Por fari tion, vi devas kopii ilin kaj doni al ili novan nomon.

Por uzi etoson konstante en via tekstredaktilo, vi devas elekti ĝin en la kombinujo etikedita Defaŭlta etoso por `Apliko` ĉe la malsupro de la dialogo kaj premu Apliki aŭ Bone. Defaŭlte estas aktiva la opcio `Aŭtomata Elekto`, kiu elektas pli taŭgan koloretoson laŭ la &kde; &plasma; kolorskemo uzata en la tekstredakta aplikaĵo; ĝi kutime elektas inter Breeze Light kaj Breeze Dark se la skemo estas hela aŭ malhela, respektive.

Vi povas alĝustigi la &kde; ĉiea kolorskemo en la modulo Koloroj en &systemsettings;. Vi ankaŭ povas ŝanĝi ĝin en iuj aplikaĵoj individue kiel ekzemple &kate; aŭ &kdevelop;, el la menuo Agordoj Kolorskemo.

#### Krei novan etoson

Por krei novan etoson, unue necesas kopii ekzistantan. Elektu ekzistantan etoson, kiun vi volas uzi kiel bazon, kiel Breeze Light aŭ Breeze Dark, kaj alklaku Kopii. Poste skribu nomon por la nova etoso.

Se vi volas modifi enkonstruitan aŭ nurlegeblan etoson, vi unue devas kopii ĝin sub malsama nomo.

#### Importi aŭ eksporti &JSON; etosodosierojn

Vi povas eksporti elektitan etoson (inkluzive de enkonstruitaj) al &JSON; dosiero kun etendo `.theme`, per la butono Eksporti. Ĉi tio malfermos dialogon por konservi la dosieron. Por aldoni koloretoson de ekstera &JSON; dosiero, simple premu la butonon Importi kaj elektu la dosieron `.theme` el la dialogo.

- Kiel menciite supre, uzant-personigitaj etosdosieroj estas konservitaj en la `org.kde.syntax-highlighting /themes/` dosierujo. Kiam vi kopias aŭ kreas etoson, ĝi aŭtomate aperos tie. Ankaŭ, importi aŭ aldoni etoson estas ekvivalenta al kopiado de ekstera `.theme` dosiero en ĉi tiun dosierujon. KSyntaxHighlighting aŭtomate prenas koloretosajn dosierojn el ĉi tiu dosierujo.

- Se vi volas publikigi etoson kreitan de vi, estas nepre kontroli la objekton metadata de la &JSON; dosiero, aldonante la respektivan permesilon kaj kontrolante la revizian numeron.

#### Redaktado de koloraj etosoj

##### Koloroj

Ĉi tie la koloroj de la teksta redakta areo estas ĝustigitaj. Ĉi tiuj estas detalaj en color-themes-editor-colors.

##### Defaŭltaj Tekstaj Stiloj

La defaŭltaj tekstaj stiloj estas hereditaj de la elstaraj tekstostiloj, permesante al la redaktilo prezenti tekston en tre konsekvenca maniero, ekzemple komenta teksto uzas la saman stilon en preskaŭ ĉiuj tekstformatoj kiujn KSyntaxHighlighting povas reliefigi.

La nomo en la listo de stiloj uzas la stilon agordita por la ero, provizante al vi tujan antaŭrigardon dum agordado de stilo.

Ĉiu stilo ebligas al vi elekti komunajn atributojn same kiel malfonojn kaj fonkolorojn. Por nuligi fonkoloron, dekstre alklaku por uzi la kuntekstan menuon.

La atributoj de ĉi tiu areo estas detalaj en color-themes-text-styles.

##### Emfazante Tekstajn Stilojn

Ĉi tie vi povas redakti la tekstajn stilojn uzatajn de specifa elstara difino. La redaktilo antaŭelektas la lumaĵon uzatan de via nuna dokumento. Por labori pri malsama elstaraĵo, elektu unu en la kombinujo Reliefigi super la stillisto.

La nomo en la listo de stiloj uzas la stilon agordita por la ero, provizante al vi tujan antaŭrigardon dum agordado de stilo.

Ĉiu stilo ebligas al vi elekti komunajn atributojn same kiel malfonojn kaj fonkolorojn. Por nuligi fonkoloron, dekstre alklaku por uzi la kuntekstan menuon. Krome vi povas vidi ĉu stilo egalas al la defaŭlta stilo uzata por la ero, kaj agordi ĝin al tio se ne.

Vi rimarkos, ke multaj lumaĵoj enhavas aliajn lumaĵojn reprezentitajn de grupoj en la stillisto. Ekzemple la plej multaj elstaraĵoj importas la Alert-elstaraĵon, kaj multaj fontkodformatoj importas la Doxygen-reliefigon. Redakti kolorojn en tiuj grupoj nur influas la stilojn kiam uzataj en la redaktita elstarigformato.

### Konsiloj & Trukoj

#### Kontrasto de Tekstaj Koloroj

Grava aspekto kiam oni laboras kun koloretosoj estas elekti tekstan kontraston, kiu faciligas la legadon, precipe en kombinaĵo kun la fono.

La aplikaĵo `Kontrast` estas kolorkontrasta kontrolilo. Ĝi diras al vi, ke la tekstkoloro kaj fonkoloro-kombinaĵoj estas legeblaj kaj alireblaj, do ĉi tio estas bonega ilo por helpi vin krei kolorajn etosojn.

Vi povas elŝuti `Kontrast` de la &kde; Aplika retejo aŭ de la pako Flatpak sur Flathub (nur en GNU/Linukso) .

La aplikaĵo GNOME `Kontrasto` estas simila. Vi povas elŝuti la Flatpak-pakaĵon sur Flathub (nur en GNU/Linukso).

#### Sugestoj de Kohereco pri Sintaksreliefigo

KSyntaxHighlighting inkluzivas pli ol 300 sintaksajn difinojn, tial estas ideale, ke vi certigu, ke via nova etoso aspektas bone en ĉiuj sintaksreliefigaj difinoj. La enkonstruitaj koloretosoj havas la jenajn similecojn, kiujn rekomendindas (sed ne devige) sekvi por atingi ĝustan montradon de ĉiuj sintaksemfazaj difinoj:

- Uzu grase por la Keyword kaj ControlFlow tekstaj stiloj.

- Ne uzu fonkoloron en ajna teksta stilo, krom Alert kaj RegionMarker.

Plej multaj el la sintaksajemfaziloj estas intencitaj aspekti bone en la defaŭltaj etosoj Breeze Light kaj Breeze Dark, do alia maniero konservi koherecon estas uzi similajn kolorojn en la tekstaj stiloj, kiel verda por Antaŭprocesoro kaj Aliaj, blua por Datumtipo kaj Atributo, aŭ purpura por Funkcio.

Notu, ke ĉi tiuj rekomendoj ne estas devigaj dum kreado kaj publikigado de etoso.

## Skripto per &javascript;

La &kappname; redaktila komponanto estas facile etendebla skribante skriptojn. La skriptlingvo estas ECMAScript (vaste konata kiel &javascript;). &kappname; subtenas du specojn de skriptoj: deŝovajn kaj komandliniajn skriptojn.

### Deŝov-Skriptoj

Deŝovskriptoj - ankaŭ referencitaj kiel indentiloj - aŭtomate deŝovas la fontkodon dum tajpado de teksto. Ekzemple, post frapado de la revenklavo la deŝovnivelo ofte pliiĝas.

La sekvaj sekcioj priskribas paŝon post paŝo kiel krei la skeleton por simpla indentilo. Kiel unua paŝo, kreu novan `*.js` dosieron nomatan ⪚ `javascript.js` en la loka hejma dosierujo `$`XDG_DATA_HOME`/katepart5/script/indentation`. En tio, la mediovariablo `XDG_DATA_HOME` kutime vastiĝas al aŭ `~/.local` aŭ `~/.local/share`.

Sur &Windows; ĉi tiuj dosieroj troviĝas en `%USERPROFILE%\AppData\Local\katepart5\script\indentation`. `%USERPROFILE%` kutime vastiĝas al `C:\\Uzantoj\\`uzanto``.

#### La Deŝovskripta Kapo

La kaplinio de la dosiero `javascript.js` estas enigita kiel &JSON; komence de la dokumento jene:

    var katescript = {
        "name": "JavaScript",
        "author": "Ekzempla nomo <example.name@some.address.org>",
        "license": "BSD-Permesilo",
        "revision": 1,
        "kate-version": "5.1",
        "required-syntax-style": "javascript",
        "indent-languages": ["javascript"],
        "priority": 0,
    }; // kate-script-header, devas esti ĉe la komenco de la dosiero sen komentoj

Ĉiu eniro estas klarigita detale nun:

- `nomo` [bezonata]: Ĉi tiu estas la deŝovilnomo, kiu aperas en la menuo Iloj Deŝovo kaj en la agorda dialogo.

- `aŭtoro` [laŭvola]: La nomo de la aŭtoro kaj kontaktinformoj.

- `licenco` [laŭvola]: Mallonga formo de la permesilo, kiel BSD License aŭ LGPLv3.

- `revizio` [bezonata]: La revizio de la skripto. Ĉi tiu nombro devus esti pliigita kiam ajn la skripto estas modifita.

- `kate-version` [bezonata]: Minimuma bezonata &kappname; versio.

- `required-syntax-style` [laŭvola]: La bezonata sintaksa stilo, kiu kongruas kun la specifita `stilo` en sintaks-reliefigaj dosieroj. Ĉi tio estas grava por indentiloj, kiuj dependas de specifaj elstarig-informoj en la dokumento. Se bezonata sintaksa stilo estas specifita, la indentigilo disponeblas nur kiam la taŭga markilo estas aktiva. Ĉi tio malhelpas nedifinitan konduton kaŭzitan de uzado de la indentigilo sen la atendata reliefa skemo. Ekzemple, la Ruby-indentigilo uzas ĉi tion en la dosieroj `ruby.js` kaj `ruby.xml`.

- `indent-languages` [laŭvola]: &JSON; tabelo de sintaksaj stiloj kiujn la indentilo povas ĝuste deŝovi, ⪚: `["c++", "java"]`.

- `prioritato` [laŭvola]: Se pluraj indentigiloj taŭgas por certa reliefigita dosiero, la prioritato decidas kiu indentigilo estas elektita kiel defaŭlta.

#### La Deŝovila Fontkodo

Specifinte la kaplinion, ĉi tiu sekcio klarigas kiel funkcias la indentskripto mem. La baza skeleto de la korpo aspektas jene:

    // bezonataj katepart js-bibliotekoj, ⪚ range.js se vi uzas Range
    require ("range.js");

    triggerCharacters = "{}/:;";
    function indent(linio, indentLarĝo, ch)
    {
        // vokita por ĉiu novlinio (ch == '\n') kaj ĉiuj signoj specifitaj en
        // la ĉiea variablo triggerCharacters. Kiam oni vokas IlojFormatigi deŝovon
        // la variablo ch estas malplena, t.e. ch == ''.
        //
        // vidu ankaŭ: Scripting API
        return -2;
    }

La funkcio `indent()` havas tri parametrojn:

- `linio` : la linio, kiu devas esti indentigita

- `indentWidth`: la indentlarĝo en nombro da spacoj

- `ch`: ĉu novlinia signo (`ch == '\n'`), la ekigilo specifita en `triggerCharacters` aŭ malplenigi se la uzanto alvokis la agon Iloj Formatita indentaĵo.

La revena valoro de la `indent()` funkcio specifas kiel la linio estos indentigita. Se la liveraĵo estas simpla entjera nombro, ĝi estas interpretata jene:

- revenvaloro `-2`: faru nenion

- redona valoro `-1`: konservi indentaĵon (serĉas antaŭan nemalplenan linion)

- redonas valoron `0` : nombroj >= 0 precizigas la indentprofundecon en spacoj

Alternative, tabelo de du elementoj povas esti liverita:

- `return [ indent, align ];`

En ĉi tiu kazo, la unua elemento estas la indentprofundo kiel supre kun la sama signifo de la specialaj valoroj. Tamen, la dua elemento estas absoluta valoro reprezentanta kolumnon por aligno. Se ĉi tiu valoro estas pli alta ol la indenta valoro, la diferenco reprezentas kelkajn spacojn aldonotajn post la indentaĵo de la unua parametro. Alie, la dua nombro estas ignorita. Uzado de taboj kaj spacoj por indentaĵo estas ofte nomata miksita reĝimo.

Konsideru la sekvan ekzemplon: Supozu uzanta tabojn por indentigi, kaj tab-larĝo estas agordita al 4. Ĉi tie, <tab> reprezentas tabon kaj '.' spacon:

    1: <tab><tab>foobar("saluton",
    2: <tab><tab>......."mondo");

Kiam indentlinio 2, la funkcio `indent()` redonas [8, 15]. Kiel rezulto, du taboj estas enmetitaj por deŝovi al kolumno 8, kaj 7 spacoj estas aldonitaj por vicigi la duan parametron sub la unua, tiel ke ĝi restu vicigita se la dosiero estas rigardata kun malsama tab-larĝo.

Defaŭlta &kde; instalaĵo sendas &kappname; kun pluraj indentiloj. La responda &javascript; fontkodo troviĝas en `$`XDG_DATA_DIRS`/katepart5/script/indentation`.

Sur &Windows; ĉi tiuj dosieroj troviĝas en `%USERPROFILE%\AppData\Local\katepart5\script\indentation`. `%USERPROFILE%` kutime vastiĝas al `C:\\Uzantoj\\`uzanto``.

Evoluigi deŝovilon postulas reŝargi la skriptojn por vidi ĉu la ŝanĝoj kondutas taŭge. Anstataŭ rekomenci la aplikaĵon, simple ŝanĝu al la komandlinio kaj alvoku la komandon `reload-scripts`.

Se vi evoluigas utilajn skriptojn bonvolu konsideri kontribui al la &kappname; Projekto per kontaktante la dissendoliston.

### Komandoliniaj Skriptoj

Ĉar estas malfacile kontentigi ĉies bezonojn, &kappname; subtenas malgrandajn helpajn ilojn por rapida manipulado de teksto per la enkonstruita komandlinio. Ekzemple, la komando `sort` estas efektivigita kiel skripto. Ĉi tiu sekcio klarigas kiel krei dosierojn `*.js` por etendi &kappname; kun arbitraj helpaj skriptoj.

Komandliniaj skriptoj troviĝas en la sama dosierujo kiel deŝovilaj skriptoj. Do kiel unua paŝo, kreu novan dosieron `*.js` nomitan `myutils.js` en la loka hejma dosierujo `$`XDG_DATA_HOME`/katepart5 /script/commands`. En tio, la mediovariablo `XDG_DATA_HOME` kutime vastiĝas al aŭ `~/.local` aŭ `~/.local/share`.

Sur &Windows; ĉi tiuj dosieroj troviĝas en `%USERPROFILE%\AppData\Local\katepart5\script\commands`. `%USERPROFILE%` kutime vastiĝas al `C:\\Users\\`uzanto``.

#### La Komandlinioskripta Kapo

La kaplinio de ĉiu komandlinia skripto estas enigita en &JSON; komence de la skripto jene:

    var katescript = {
        "author": "Ekzempla nomo <example.name@some.address.org>",
        "license" : "LGPLv2+",
        "revision": 1,
        "kate-version": "5.1",
        "functions": ["sort", " moveLinesDown"],
        "actions": [
           { "function": "sort",
             "name": "Ordigi Elektitan Tekston",
             "category ": "Redaktado",
             "interactive": "false"
           },
           { "function": "moveLinesDown",
             "name": \ "Movi Liniojn Malsupren",
             "category": "Redaktado",
             "shortcut": "Ctrl+Shift+Down",
             "interactive": "false"
           }
        ]
    }; // kate-script-header, devas esti ĉe la komenco de la dosiero sen komentoj

Ĉiu eniro estas klarigita detale nun:

- `aŭtoro` [laŭvola]: La nomo de la aŭtoro kaj kontaktinformoj.

- `licenco` [laŭvola]: Mallonga formo de la permesilo, kiel BSD License aŭ LGPLv2.

- `revizio` [bezonata]: La revizio de la skripto. Ĉi tiu nombro devus esti pliigita kiam ajn la skripto estas modifita.

- `kate-version` [bezonata]: Minimuma bezonata &kappname; versio.

- `funkcioj` [bezonata]: &JSON; tabelo de komandoj en la skripto.

- `agoj` [laŭvola]: &JSON; Tabelo de &JSON; objektoj kiuj difinas la agojn kiuj aperas en la aplikaĵa menuo. Detalaj informoj estas provizitaj en la sekcio Ligaj Ŝparvojoj.

Ĉar la valoro de `funkcioj` estas &JSON; tabelo, ununura skripto kapablas enhavi arbitran nombron da komandliniaj komandoj. Ĉiu funkcio disponeblas per la enkonstruita komandlinio de &kappname;.

#### La Skripta Fontkodo

Ĉiuj funkcioj specifitaj en la kaplinio devas esti efektivigitaj en la skripto. Ekzemple, la skriptodosiero de la supra ekzemplo bezonas efektivigi la du funkciojn `sort` kaj `moveLinesDown`. Ĉiuj funkcioj havas la sekvan sintakson:

    // postulis katepart js-bibliotekojn, ⪚ range.js se vi uzas Range
    require ("range.js");

    function <nomo>(arg1, arg2, ...)
    {
     // ... efektivigo, vidu ankaŭ: Skripta API
    }

Argumentoj en la komandlinio estas transdonitaj al la funkcio kiel `arg1`, `arg2`, &etc; Por provizi dokumentadon por ĉiu komando, simple efektivigu la funkcion '`help`' jene:

    function help(cmd)
    {
        if (cmd == "sort" ) {
            return i18n("Ordigi la elektitan tekston.");
        } else if (cmd == "...") {
            // ...
        }
    }

Efektivigi `help sort` en la komandlinio tiam vokas ĉi tiun helpfunkcion kun la argumento `cmd` agordita al la donita komando, &ie; `cmd == "sort"`. &kappname; tiam prezentas la liveritan tekston kiel dokumentadon al la uzanto. Nepre traduki la ĉenojn.

Disvolvi komandlinian skripton postulas reŝargi la skriptojn por vidi ĉu la ŝanĝoj kondutas taŭge. Anstataŭ rekomenci la aplikaĵon, simple ŝanĝu al la komandlinio kaj alvoku la komandon `reload-scripts`.

##### Ligantaj Ŝparvojoj

Por igi la skriptojn alireblaj en la aplikaĵa menuo kaj atribui ŝparvojojn, la skripto devas provizi taŭgan skripton. En la ĉi-supra ekzemplo, ambaŭ funkcioj `ordigi` kaj `moveLinesDown` aperas en la menuo pro la sekva parto en la skriptkapo:

    var katescript = {
        ...
        "actions": [
            {   "function": "sort",
                "name": "Ordigi Elektitan Tekston",
                "icon": "",
                "category": "Redaktado",
                "interactive": "false"
            },
            {   "function": "moveLinesDown",
                "name": "Movi Liniojn Malsupren",
                "icon": "",
                "category": "Redaktado",
                "shortcut": "Ctrl+Shift+Down",
                "interactive": "false"
            }
        ]
    };

La kampoj por unu ago estas jenaj:

- `funkcio` [bezonata]: La funkcio kiu devus aperi en la menuo Iloj Skriptoj.

- `nomo` [bezonata]: La teksto aperas en la skriptmenuo.

- `pikono` [laŭvola]: La piktogramo aperas apud la teksto en la menuo. Ĉiuj &kde; piktogramnomoj povas esti uzataj ĉi tie.

- `kategorio` [laŭvola]: Se kategorio estas specifita, la skripto aperas en submenuo.

- `mallongigo` [laŭvola]: La ŝparvojo donita ĉi tie estas la defaŭlta ŝparvojo. Ekzemplo: `Ktrl+Alt+t`. Vidu la &Qt; dokumentado por pliaj detaloj.

- `interaga` [laŭvola]: Se la skripto bezonas enigon de uzanto en la komandlinio, agordu ĉi tion al `true`.

Se vi evoluigas utilajn skriptojn bonvolu konsideri kontribui al la &kappname; Projekto per kontaktante la dissendoliston.

### Skripta API

La scripting-API prezentita ĉi tie estas disponebla por ĉiuj skriptoj, &ie; deŝovskriptoj kaj komandliniaj komandoj. La klasoj `Cursor` kaj `Range` estas provizitaj de bibliotekaj dosieroj en `$`XDG_DATA_DIRS`/katepart5/libraries`. Se vi volas uzi ilin en via skripto, kiu bezonas uzi iujn el la funkcioj `Dokumento` aŭ `Vidi`, bonvolu inkluzivi la necesan bibliotekon uzante:

    // postulis katepart js-bibliotekojn, ⪚ range.js se vi uzas Range
    require ("range.js");

Por etendi la norman scripting API kun viaj propraj funkcioj kaj prototipoj simple kreu novan dosieron en la loka agorda dosierujo de &kde; `$`XDG_DATA_HOME`/katepart5/libraries` kaj enmetu ĝin en vian skripto uzante:

    require ("miaskriptnomoĉitie.js");

Sur &Windows; ĉi tiuj dosieroj troviĝas en `%USERPROFILE%\AppData\Local\katepart5\libraries`. `%USERPROFILE%` kutime vastiĝas al `C:\\Users\\`uzanto``.

Por etendi ekzistantajn prototipojn kiel `Cursor` aŭ `Range`, la rekomendinda maniero estas ne modifi la ĉieajn `*.js` dosierojn. . Anstataŭe, ŝanĝu la prototipon `Cursor` en &javascript; post kiam la `cursor.js` estas inkluzivita en vian skripton per `require`.

#### Kursoroj kaj Intervaloj

Ĉar &kappname; estas tekstredaktilo, la tuta scripting-API baziĝas sur kursoroj kaj intervaloj kiam ajn eblas. Kursoro estas simpla `(linio, kolumno)` opo reprezentanta tekstopozicion en la dokumento.Intervalo ampleksas tekston de komenca kursora pozicio ĝis fina kursora pozicio. La API estas klarigita detale en la sekvaj sekcioj.

##### La Profilo de Cursor

    Cursor();

- Konstruilo. Liveras Cursor ĉe pozicio `(0, 0)`.

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

    Cursor(int linio, int kolumno);

- Konstruilo. Liveras Cursor ĉe pozicio (linio, kolumno).

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

    Cursor(Cursor alia);

- Kopi-konstruilo. Liveras kopion de la kursoro `alia`.

  Ekzemplo: `var kopio = new Cursor(alia);`

    Cursor Cursor.clone();

- Liveras klonon de la kursoro.

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

    Cursor.setPosition(int linio, int kolumno);

- Agordas la pozicion de la kursoro al `linio` kaj `kolumno`.

  Ekde: &kde; 4.11

    bool Cursor.isValid();

- Kontrolu ĉu la kursoro validas. La kursoro estas nevalida, se linio kaj/aŭ kolumno estas agordita al `-1`.

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

    Cursor Cursor.invalid();

- Liveras novan nevalidan kursoron situantan ĉe `(-1, -1)`.

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

    int Cursor.compareTo(Cursor alia);

- Komparas ĉi tiun kursoron kun la kursoro `alia`. Revenoj

  - `-1`, se ĉi tiu kursoro troviĝas antaŭ la kursoro `alia`,

  - `0`, se ambaŭ kursoroj egalas kaj

  - `+1`, se ĉi tiu kursoro troviĝas post la kursoro `alia`.

    bool Cursor.equals(Cursor alia);

- Donas `true`, se ĉi tiu kursoro kaj la kursoro `alia` estas egalaj, alie `false`.

    String Cursor.toString();

- Liveras la kursoron kiel ĉeno de la formo `Cursor(linio, kolumno)`.

##### La Range-Prototipo

    Range();

- Konstruilo. Voki `new Range()` liveras Range ĉe (0, 0) - (0, 0).

    Range (Cursor komenco, Cursor fino);

- Konstruilo. Voki `new Range(`komenco`, `fino`)` redonas la Gamon (`komenco`, `fino` ).

    Range(int komencLinio, int startColumn, int endLinio parametro
    >, int endColumn);

- Konstruilo. Voki `new Range(`startLine`, `startColumn`, `endLine`, `endColumn`)` redonas la Gamon de (`komencLinio`, `komencKolumno`) al (`finLinio`, `finKolumno`).

    Range(Range alia);

- Kopi-konstruilo. Resendas kopion de Range `alia`.

    Range Range.clone();

- Liveras klonon de la intervalo.

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

    bool Range.isEmpty();

- Donas `true`, se la komencaj kaj finaj kursoroj estas egalaj.

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

  Ekde: &kde; 4.11

    bool Range.isValid();

- Donas `true`, se kaj komenca kaj fina kursoro validas, alie `false`.

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

    Range Range.invalid();

- Liveras la Range de (-1, -1) al (-1, -1).

    bool Range.contains(Cursor kursoro);

- Donas `true`, se ĉi tiu intervalo enhavas la kursoran pozicion, alie `false`.

    bool Range.contains(Range alia);

- Donas `true`, se ĉi tiu gamo enhavas la Gamon `alia`, alie `false`.

    bool Range.containsColumn(int kolumno);

- Donas `true`, se `kolumno` estas en la duonmalferma intervalo `[komenco.kolumno, fino.kolumno)`, alie `false`.

    bool Range.containsLine(int linio);

- Donas `true`, se `linio` estas en la duonmalferma intervalo `[komenco.linio, fino.linio)`, alie `false`.

    bool Range.overlaps(Range alia);

- Donas `true`, se ĉi tiu intervalo kaj la intervalo `alia` dividas komunan regionon, alie `false`.

    bool Range.overlapsLine(int linio);

- Donas `true`, se `linio` estas en la intervalo `[start.line, end.line]`, alie `false`.

    bool Range.overlapsColumn(int kolumno);

- Donas `true`, se `kolumno` estas en la intervalo `[komenco.kolumno, fino.kolumno]`, alie `false`.

    bool Range.onSingleLine();

- Donas `true`, se la intervalo komenciĝas kaj finiĝas ĉe la sama linio, &ie; if `Range.start.line == Range.end.line`.

  Ekde: &kde; 4.9

    bool Range.equals(Range alia);

- Donas `true`, se ĉi tiu gamo kaj la Range `alia` estas egalaj, alie `false`.

    String Range.toString();

- Liveras la intervalon kiel ĉeno de la formo `Range(Cursor(linio, kolumno), Cursor(linio, kolumno))`.

#### Ĉieaj Funkcioj

Ĉi tiu sekcio listigas ĉiujn ĉieajn funkciojn.

##### Legado & Inkluzivado de Dosieroj

    String read(String dosiero);

- Serĉos la donitan `dosieron` rilate al la dosierujo `katepart5/script/files` kaj liveros ĝian enhavon kiel ĉenon.

    void require(String dosiero);

- Serĉos la donitan `dosieron` rilate al la dosierujo `katepart5/script/libraries` kaj taksos ĝin. `require` estas interne protektita kontraŭ multoblaj inkludoj de la sama `dosiero`.

  Ekde: &kde; 4.10

##### Sencimigado

    void debug(String teksto);

- Presas `tekston` al `stdout` en la konzolo lanĉanta la aplikaĵon.

##### Traduko

Por subteni plenan lokalizon, ekzistas pluraj funkcioj por traduki ĉenojn en skriptoj, nome `i18n`, `i18nc`, `i18np` kaj `i18ncp`. Ĉi tiuj funkcioj kondutas ekzakte kiel la tradukfunkcioj de &kde;.

La tradukfunkcioj tradukas la envolvitajn ĉenojn per la traduksistemo de &kde; al la lingvo uzata en la aplikaĵo. Ĉenoj en skriptoj evoluantaj en la oficiala &kappname; fontoj estas aŭtomate ĉerpitaj kaj tradukeblaj. Alivorte, kiel &kappname; programisto vi ne devas ĝeni per eltiro kaj tradukado de mesaĝoj. Notu tamen, ke la traduko funkcias nur ene de la &kde; infrastrukturo, &ie;, novaj ĉenoj en triaj skriptoj disvolvitaj ekster &kde; ne estas tradukitaj. Tial bonvolu konsideri kontribui viajn skriptojn al &kate; tia ke taŭga tradukado estas ebla.

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

- Tradukas `tekston` al la lingvo uzata de la aplikaĵo. La argumentoj `arg1`, ..., estas nedevigaj kaj uzataj por anstataŭigi la anstataŭaĵojn `%1`, `%2`, &etc;

    void i18nc(String kunteksto, String teksto, arg1, ...) ;

- Tradukas `tekston` al la lingvo uzata de la aplikaĵo. Aldone, la ĉeno `kunteksto` estas videbla por tradukistoj por ke ili povu provizi pli bonan tradukon. La argumentoj `arg1`, ..., estas nedevigaj kaj uzataj por anstataŭigi la anstataŭaĵojn `%1`, `%2`, &etc;

    void i18np(String unuopa, String pluralo, int nombro, arg1, ...);

- Tradukas aŭ `singularo` aŭ `pluralo` en la lingvon uzatan de la aplikaĵo, depende de la donita `nombro`. La argumentoj `arg1`, ..., estas nedevigaj kaj uzataj por anstataŭigi la anstataŭaĵojn `%1`, `%2`, &etc;

    void i18ncp(String kunteksto , String unuopa, String pluralo, int nombro, arg1, ...);

- Tradukas aŭ `singularo` aŭ `pluralo` en la lingvon uzatan de la aplikaĵo, depende de la donita `nombro`. Aldone, la ĉeno `kunteksto` estas videbla por tradukistoj por ke ili povu provizi pli bonan tradukon. La argumentoj `arg1`, ..., estas nedevigaj kaj uzataj por anstataŭigi la anstataŭaĵojn `%1`, `%2`, &etc;

#### La View API

Kiam ajn skripto estas rulita, ekzistas ĉiea variablo `vido` reprezentanta la nunan aktivan redaktan vidon. La sekvanta estas listo de ĉiuj disponeblaj Vidaj funkcioj.

    void view.copy()

- Kopiu la elekton se ekzistas unu, alie la nunan linion se la opcio `[ ] Kopiu/Tranĉi la nunan linion se neniu elekto` estas agordita.

  Ekde: &kde-frameworks; 5.79

    void view.cut()

- Tranĉi la elekton se ekzistas unu, alie la aktuala linio se la opcio `[ ] Kopiu/Tranĉi la nunan linion se neniu elekto` estas agordita.

  Ekde: &kde-frameworks; 5.79

    void view.paste()

- Algluu la enhavon de la tondujo.

  Ekde: &kde-frameworks; 5.79

    Cursor view.cursorPosition()

- Liveras la aktualan kursoran pozicion en la vido.

    void view.setCursorPosition(int linio, int kolumno);
    void view.setCursorPosition(Cursor kursoro);

- Agordu la aktualan kursoron al aŭ (linio, kolumno) aŭ al la donita kursoro.

    Cursor vido.virtualCursorPosition ();

- Resendas la virtualan kursoran pozicion kun ĉiu tabo kalkulanta la respondan kvanton da spacoj depende de la nuna tab-larĝeco.

    void view.setVirtualCursorPosition(int linio, int kolumno);
    void view.setVirtualCursorPosition(Cursor kursoro);

- Agordu la nunan virtualan kursoran pozicion al (linio, kolumno) aŭ al la donita kursoro.

    String view.selectedText();

- Resendas la elektitan tekston. Se neniu teksto estas elektita, la liverita ĉeno estas malplena.

    bool view.hasSelection();

- Redonas `true`, se la vido elektis tekston, alie `false`.

    Range view.selection();

- Redonas la elektitan tekstan gamon. La redonita intervalo estas nevalida se ne estas elektita teksto.

    void view.setSelection(Range gamo);

- Agordu la elektitan tekston al la donita gamo.

    void view.removeSelectedText();

- Forigu la elektitan tekston. Se la vido ne havas ajnan elektitan tekston, tio faras nenion.

    void view.selectAll ();

- Elektas la tutan tekston en la dokumento.

    void vido.clearSelection();

- Purigas la teksto-elekton sen forigi la tekston.

    void view.setBlockSelection(bool on);

- Ŝalti aŭ malŝalti blokan elektoreĝimon.

    bool view.blockSelection();

- Redonas `true`, se blokelekta reĝimo estas ŝaltita, alie `false`.

    void view.align(Range gamo);

- Ĝuste reindentigas liniojn ene de `intervalo` laŭ aktualaj indentagordoj.

    void view.alignOn(Range gamo, String ŝablono = "");

- Vicigas liniojn en `gamo` sur la kolumno donita de la regula esprimo `ŝablono`. Kun malplena `ŝablono` ĝi viciĝos al la unua nemalplena signo defaŭlte. Se la ŝablono havas kapton, ĝi deŝovos sur la kaptita kongruo.

  Ekzemploj:

  `view.alignOn(document.documentRange(), '-');` enmetos spacojn antaŭ la unua `-` de ĉiu linioj por vicigi ilin ĉiujn sur la sama kolumno.

  `view.alignOn(document.documentRange(), ':\\s+(.)');` enmetos spacojn antaŭ la unua nemalplena signo kiu okazas post dupunkto por vicigi ilin ĉiujn. la sama kolumno.

    objekto view.executeCommand(String komando,
     String argoj,
     Range  intervalo);

- Efektigas la komandlinian komandon `komandon` kun la nedevigaj argumentoj `args` kaj la nedeviga `gamo`. La redonita `objekto` havas bulean econ `object.ok` kiu indikas ĉu plenumo de la `komando` sukcesis. En kazo de eraro, la ĉeno `object.status` enhavas erarmesaĝon.

  Ekde: &kde-frameworks; 5.50

    Range view.searchText(Range gamo,
                          String ŝablono,
                          bool malantaŭen = false);

- Serĉu la unuan aperon de `ŝablono` en `gamo` kaj liveras la kongruan intervalon. Serĉo estas farita malantaŭen se la laŭvola bulea parametro `malantaŭen` estas agordita al `true`.

  La redonita intervalo estas nevalida (vidu Range.isValid()) se `ŝablono` ne troviĝas en `intervalo`.

  Ekde: &kde-frameworks; 5.97

#### La Dokumenta API

Kiam ajn skripto estas rulita, estas ĉiea variablo `dokumento` reprezentanta la aktuale aktivan dokumenton. La sekvanta estas listo de ĉiuj disponeblaj Dokumentaj funkcioj.

    String document.fileName();

- Liveras la dosiernomon de la dokumento aŭ malplenan ĉenon por nekonservitaj tekstaj bufroj.

    String document.url();

- Liveras la plenan &URL; de la dokumento; aŭ malplena ĉeno por nekonservitaj tekstaj bufroj.

    String document.mimeType();

- Liveras la dokumentan &MIME;-tipon aŭ la &MIME;-tipon `application/octet-stream` se neniu taŭga &MIME;-tipo povus esti trovita.

    String document.encoding();

- Redonas la nuntempe uzatan kodigon por konservi la dosieron.

    String document.highlightingMode ();

- Liveras la ĉiean reliefigreĝimon uzatan por la tuta dokumento.

    String document.highlightingModeAt(Cursor pos);

- Redonas la emfazan reĝimon uzatan ĉe la donita pozicio en la dokumento.

    Array document.embeddedHighlightingModes ();

- Liveras tabelon de reliefaj modoj enigitaj en ĉi tiu dokumento.

    bool document.isModified();

- Redonas `true`, se la dokumento havas nekonservitajn ŝanĝojn (modifitajn), alie `false`.

    String document.text();

- Resendas la tutan enhavon de la dokumento en ununura tekstoĉeno. Novlinioj estas markitaj per la novlinia signo `\n`.

    String document.text(int deLinio, int deKolumno, int alLinio, int alKolumno);
    String document.text(Cursor de, Cursor al);
    String document.text(Range intervalo);

- Liveras la tekston en la donita gamo. Oni rekomendas uzi la kursoron kaj gamon bazitan version por pli bona legebleco de la fontkodo.

    String document.line(int linio);

- Liveras la donitan tekstlinion kiel ĉenon. La ĉeno estas malplena se la petita linio estas ekster intervalo.

    String document.wordAt(int linio, int kolumno);
    String document.wordAt(Cursor kursoro);

- Liveras la vorton ĉe la donita kursora pozicio.

    Range document.wordRangeAt(int linio, int kolumno);
    Range document.wordRangeAt(Cursor kursoro);

- Redonu la gamon de la vorto ĉe la donita kursora pozicio. La redonita intervalo estas nevalida (vidu Range.isValid()), se la tekstopozicio estas post la fino de linio. Se ne estas vorto ĉe la donita kursoro, malplena gamo estas liverita.

  Ekde: &kde; 4.9

    String document.charAt(int linio, int kolumno);
    String document.charAt(Cursor kursoro);

- Liveras la signon ĉe la donita kursora pozicio.

    String document.firstChar(int linio);

- Liveras la unuan signon en la donita `linio` kiu ne estas blankspaco. La unua signo estas ĉe kolumno 0. Se la linio estas malplena aŭ enhavas nur blankspacsignojn, la liverita ĉeno estas malplena.

    String document.lastChar(int linio);

- Liveras la lastan signon en la donita `linio` kiu ne estas blankspaco. Se la linio estas malplena aŭ enhavas nur blankspacsignojn, la liverita ĉeno estas malplena.

    bool document.isSpace(int linio, int kolumno);
    bool document.isSpace(Cursor kursoro);

- Donas `true`, se la signo ĉe la donita kursora pozicio estas blankspaco, alie `false`.

    bool document.matchesAt(int linio, int kolumno, String teksto);
    bool document.matchesAt(Cursor kursoro, String teksto );

- Donas `true`, se la donita `teksto` kongruas ĉe la responda kursora pozicio, alie `false`.

    bool document.startsWith(int linio, String teksto, bool skipWhiteSpaces);

- Donas `true`, se la linio komenciĝas per `teksto`, alie `false`. La argumento `skipWhiteSpaces` kontrolas ĉu gvidaj blankspacoj estas ignoritaj.

    bool document.endsWith(int linio, String teksto, bool skipWhiteSpaces);

- Redonas `true`, se la linio finiĝas per `teksto`, alie `false`. La argumento `skipWhiteSpaces` kontrolas ĉu postaj blankspacoj estas ignoritaj.

    bool document.setText(String teksto);

- Agordas la tutan dokumentan tekston.

    bool document.clear();

- Forigas la tutan tekston en la dokumento.

    bool document.truncate(int linio, int kolumno);
    bool document.truncate(Cursor kursoro);

- Detranĉu la donitan linion ĉe la donita kolumno aŭ kursora pozicio. Redonas `true` je sukceso, aŭ `false` se la donita linio ne estas parto de la dokumento-intervalo.

    bool document.insertText(int linio, int kolumno, String teksto);
    bool document.insertText(Cursor kursoro, String teksto);

- Enmetas la `tekston` ĉe la donita kursora pozicio. Redonas `true` je sukceso, aŭ `false`, se la dokumento estas en nurlegebla reĝimo.

    bool document.removeText(int deLinio, int deKolumno, int alLinio, int alKolumno);
    bool document.removeText(Cursor de, Cursor al);
    bool document.removeText(Range intervalo);

- Forigas la tekston en la donita gamo. Redonas `true` je sukceso, aŭ `false`, se la dokumento estas en nurlegebla reĝimo.

    bool document.insertLine(int linio, String teksto);

- Enmetas tekston en la donita linio. Redonas `true` je sukceso, aŭ `false`, se la dokumento estas en nurlegebla reĝimo aŭ la linio ne estas en la dokumento-intervalo.

    bool document.removeLine(int linio);

- Forigas la donitan tekstan linion. Redonas `true` je sukceso, aŭ `false`, se la dokumento estas en nurlegebla reĝimo aŭ la linio ne estas en la dokumento-intervalo.

    bool document.wrapLine(int linio, int kolumno);
    bool document.wrapLine(Cursor kursoro);

- Envolvas la linion ĉe la donita kursora pozicio. Redonas `true` je sukceso, alie `false`, ⪚ if linio < 0.

  Ekde: &kde; 4.9

    void document.joinLines(int startLine, int endLine);

- Kunigas la liniojn de `startLine` al `endLine`. Du sekvaj tekstlinioj ĉiam estas apartigitaj per ununura spaco.

    int dokumento.lines();

- Liveras la nombron da linioj en la dokumento.

    bool document.isLineModified(int linio);

- Donas `true`, se `linio` nuntempe enhavas nekonservitajn datumojn.

  Ekde: &kde; 5.0

    bool document.isLineSaved(int linio);

- Donas `true`, se `linio` estis ŝanĝita, sed la dokumento estis konservita. Tial, la linio nuntempe ne enhavas iujn ajn nekonservitajn datumojn.

  Ekde: &kde; 5.0

    bool document.isLineTouched(int linio);

- Donas `true`, se `linio` nuntempe enhavas nekonservitajn datumojn aŭ estis ŝanĝita antaŭe.

  Ekde: &kde; 5.0

    bool document.findTouchedLine(int startLinio, bool malsupren);

- Serĉu la sekvan tuŝitan linion komencante ĉe `linio`. La serĉo estas farita aŭ supren aŭ malsupren laŭ la serĉdirekto specifita en `malsupren`.

  Ekde: &kde; 5.0

    int dokumento.length();

- Liveras la nombron da signoj en la dokumento.

    int dokumento.lineLength(int linio);

- Liveras la longon de la `linio`.

    void dokumento.editBegin();

- Lanĉas redaktan grupon por malfari/refari grupigon. Certiĝu ĉiam voki `editEnd()` tiom ofte kiom vi vokas `editBegin()`. Voki `editBegin()` interne uzas referencan nombrilon, &ie;, ĉi tiu voko povas esti nestita.

    void dokumento.editEnd();

- Finas redaktan grupon. La lasta alvoko de `editEnd()` (&ie; tiu por la unua voko de `editBegin()`) finas la redaktan paŝon.

    int dokumento.unuaKolumno(int linio);

- Liveras la unuan ne-blankspackolumnon en la donita `linio`. Se estas nur blankspacoj en la linio, la liveraĵo estas `-1`.

    int dokumento.lastKolumno(int linio);

- Liveras la lastan ne-blankspackolumnon en la donita `linio`. Se estas nur blankspacoj en la linio, la liveraĵo estas `-1`.

    int document.prevNonSpaceColumn(int linio, int kolumno);
    int document.prevNonSpaceColumn(Cursor kursoro);

- Redonas la kolumnon kun ne-blankspaca signo komencanta ĉe la donita kursora pozicio kaj serĉanta malantaŭen.

    int document.nextNonSpaceColumn(int linio, int kolumno);
    int document.nextNonSpaceColumn(Cursor kursoro);

- Redonas la kolumnon kun ne-blankspaca signo komencanta ĉe la donita kursora pozicio kaj serĉante antaŭen.

    int document.prevNonEmptyLine(int linio);

- Liveras la sekvan nemalplenan linion enhavantan ne-blankspacsignojn serĉantajn malantaŭen.

    int dokumento.nextNonEmptyLine(int linio);

- Liveras la sekvan nemalplenan linion enhavantan ne-blankspacsignojn serĉantajn antaŭen.

    bool document.isInWord(String signo, int atributo);

- Donas `true`, se la donita `signo` kun la donita `atributo` povas esti parto de vorto, alie `false`.

    bool document.canBreakAt(String signo, int atributo);

- Donas `true`, se la donita `signo` kun la donita `atributo` taŭgas por envolvi linion, alie `false`.

    bool document.canComment(int startAtribute, int endAttribute);

- Donas `true`, se intervalo komencanta kaj finiĝanta per la donitaj atributoj taŭgas por esti komentita, alie `false`.

    String document.commentMarker(int atributo);

- Liveras la komentmarkilon por unuliniaj komentoj por donita `atributo`.

    String document.commentStart(int atributo);

- Liveras la komentmarkilon por la komenco de plurliniaj komentoj por donita `atributo`.

    String document.commentEnd(int atributo);

- Redonas la komentan markilon por la fino de plurliniaj komentoj por donita `atributo`.

    Range document.documentRange();

- Liveras gamon, kiu ampleksas la tutan dokumenton.

    Cursor documentEnd();

- Liveras kursoron poziciigitan ĉe la lasta kolumno de la lasta linio en la dokumento.

    bool isValidTextPosition(int linio, int kolumno);
    bool isValidTextPosition(Cursor kursoro );

- Donas `true`, se la donita kursora pozicio estas poziciigita ĉe valida tekstopozicio. Teksta pozicio validas nur se ĝi situas ĉe la komenco, en la mezo aŭ la fino de valida linio. Plue, tekstpozicio estas malvalida se ĝi troviĝas en Unikoda anstataŭaĵo.

  Ekde: &kde; 5.0

    int document.attribute(int linio, int kolumno);
    int document.attribute(Cursor kursoro);

- Liveras la atributon ĉe la donita kursora pozicio.

    bool document.isAttribute(int linio, int kolumno, int atributo);
    bool document.isAttribute(Cursor kursoro, int atributo);

- Donas `true`, se la atributo ĉe la donita kursora pozicio egalas `atributo`, alie `false`.

    String document.attributeName(int linio, int kolumno);
    String document.attributeName(Cursor kursoro);

- Donas la atributan nomon kiel homlegebla teksto. Ĉi tio estas egala al la nomo `itemData` en la sintaksa reliefaj dosieroj.

    bool document.isAttributeName(int linio, int kolumno, String nomo);
    bool document.isAttributeName(Cursor kursoro, String nomo);

- Redonas `true`, se la atributnomo ĉe certa kursorpozicio kongruas kun la donita `nomo`, alie `false`.

    String document.variable(String klavo);

- Liveras la valoron de la petita dokumentvariablo `ŝlosilo`. Se la dokumentvariablo ne ekzistas, la liveraĵo estas malplena ĉeno.

    void document.setVariable(String ŝlosilo, String valoro);

- Agordu la valoron de la petita dokumentvariablo `ŝlosilo`.

  Vidu ankaŭ: Kate-dokumentvariabloj

  Ekde: &kde; 4.8

    int dokumento.unuaVirtualaKolumno(int linio);

- Liveras la virtualan kolumnon de la unua ne-spaco en la donita linio aŭ `-1`, se la linio estas malplena aŭ enhavas nur blankspacsignojn.

    int dokumento.lastVirtualColumn(int linio);

- Liveras la virtualan kolumnon de la lasta ne-spaco en la donita linio aŭ `-1`, se la linio estas malplena aŭ enhavas nur blankspacsignojn.

    int document.toVirtualColumn(int linio, int kolumno);
    int document.toVirtualColumn(Cursor kursoro);
    Cursor document.toVirtualCursor(Cursor kursoro);

- Konvertas la donitan realan kursoran pozicion al virtuala kursora pozicio, ĉu liverante int aŭ Cursor-objekton.

    int document.fromVirtualColumn(int linio, int virtualaKolumno);
    int document.fromVirtualColumn(Cursor virtualaKursoro);
    Cursor document.fromVirtualCursor(Cursor virtualaKursoro);

- Konvertas la donitan virtualan kursoran pozicion al reala kursora pozicio, ĉu liverante int aŭ Cursor-objekton.

    Cursor document.anchor(int linio, int kolumno, Char signo);
    Cursor document.anchor(Cursor kursoro, Signo signo);

- Serĉas malantaŭen la donitan signon komencante de la donita kursoro. Ekzemple, se '(' estas pasigita kiel signo, ĉi tiu funkcio redonos la pozicion de la malfermaĵo '('. Ĉi tiu referenca nombrado, &ie; aliaj '(...)' estas ignoritaj.

    Cursor document.rfind(int linio, int kolumno, String teksto, int atributo = -1);
    Cursor document.rfind(Cursor kursoro, String teksto, int atributo = -1);

- Trovu serĉante malantaŭen la donitan tekston kun la taŭga `atributo`. La argumento `atributo` estas ignorata se ĝi estas agordita al `-1`. La redonita kursoro estas nevalida, se la teksto ne troviĝis.

    int document.defStyleNum(int linio, int kolumno);
    int document.defStyleNum(Cursor kursoro);

- Liveras la defaŭltan stilon uzatan ĉe la donita kursora pozicio.

    bool document.isCode(int linio, int kolumno);
    bool document.isCode(Cursor kursoro);

- Redonas `true`, se la atributo ĉe la donita kursora pozicio ne egalas al ĉiuj jenaj stiloj: `dsComment`, `dsString`, `dsRegionMarker` , `dsChar`, `dsOthers`.

    bool document.isComment(int linio, int kolumno);
    bool document.isComment(Cursor kursoro);

- Redonas `true`, se la eco de la signo ĉe la kursora pozicio estas `dsComment`, alie `false`.

    bool document.isString(int linio, int kolumno);
    bool document.isString(Cursor kursoro);

- Redonas `true`, se la atributo de la signo ĉe la kursora pozicio estas `dsString`, alie `false`.

    bool document.isRegionMarker(int linio, int kolumno);
    bool document.isRegionMarker(Cursor kursoro);

- Redonas `true`, se la eco de la signo ĉe la kursora pozicio estas `dsRegionMarker`, alie `false`.

    bool document.isChar(int linio, int kolumno);
    bool document.isChar(Cursor kursoro);

- Redonas `true`, se la eco de la signo ĉe la kursora pozicio estas `dsChar`, alie `false`.

    bool document.isOthers(int linio, int kolumno);
    bool document.isOthers(Cursor kursoro);

- Donas `true`, se la eco de la signo ĉe la kursora pozicio estas `dsOthers`, alie `false`.

    void document.indent(Range intervalo, int ŝanĝo);

- Indentigas ĉiujn liniojn en `intervalo` per `ŝanĝo` taboj aŭ `ŝanĝo` oble `tabSize` spacoj depende de la preferoj de la uzantoj. La parametro `ŝanĝo` povas esti negativa.

#### La Redaktilo API

Krom la dokumento kaj vido API, ekzistas ĝenerala redaktilo API kiu disponigas funkciojn por ĝenerala redaktilo skriptfunkcio.

    String editor.clipboardText();

- Liveras la tekston kiu nuntempe estas en la ĉiea tondujo.

  Ekde: &kde-frameworks; 5.50

    String editor.clipboardHistory();

- La redaktilo tenas historion de tondujo kiu enhavas ĝis 10 enskribojn de tondujo. Ĉi tiu funkcio liveras ĉiujn enskribojn kiuj nuntempe estas en la tondujohistorio.

  Ekde: &kde-frameworks; 5.50

    void editor.setClipboardText(String teksto);

- Agordu la enhavon de la tondujo al `teksto`. La `teksto` estos aldonita al la historio de la tondujo.

  Ekde: &kde-frameworks; 5.50