set-tab-width {ENTER amplada}

Estableix l'amplada de la pestanya al número amplada.

set-indent-width {ENTER amplada}

Estableix l'amplada del sagnat al número amplada. Només s'utilitza si esteu sagnant amb espais.

set-word-wrap-column {ENTER amplada}

Estableix l'amplada per a l'ajust de línia al número amplada. Només s'utilitza si teniu l'ajust de línia automàtic.

set-icon-border {BOOLEÀ enable}

Estableix la visibilitat de la vora de les icones.

set-folding-markers {BOOLEÀ enable}

Estableix la visibilitat de la subfinestra de les marques de plegat.

set-line-numbers {BOOLEÀ enable}

Estableix la visibilitat de la subfinestra dels números de línia.

set-replace-tabs {BOOLEÀ enable}

Si està activat, se substitueixen els espais de tabulació per espais normals mentre aneu escrivint.

set-remove-trailing-space {BOOLEÀ enable}

Si està activat, els espais en blanc finals seran eliminats en el moment en què el cursor surti d'una línia.

set-show-tabs {BOOLEÀ enable}

Si està activat, els caràcters de tabulació i espais en blanc finals es veuran com un punt petit.

set-show-indent {BOOLEÀ enable}

Si està activat, el sagnat es veurà com una línia puntejada vertical.

set-indent-spaces {BOOLEÀ enable}

Si està activat, l'editor farà un sagnat amb indent-width espais per a cada nivell de sagnat, en comptes d'un caràcter de tabulació.

set-mixed-indent {BOOLEÀ enable}

Si està activat, la KatePart utilitzarà una barreja de tabulacions i espais per al sagnat. Cada nivell de sagnat serà d'amplada indent-width, i els diferents nivells de sagnat s'optimitzaran utilitzant el màxim de caràcters de tabulació com sigui possible.

Quan s'executa, aquesta ordre activa el sagnat amb espais, i si no s'especifica l'amplada se li assignarà un valor igual que la meitat de tab-width per al document en temps d'execució.

set-word-wrap {BOOLEÀ enable}

Activa l'ajust dinàmic de la línia d'acord amb el valor enable.

set-replace-tabs-save {BOOLEÀ enable}

Quan està activat, les tabulacions seran substituïdes amb espais en blanc en desar el document.

set-remove-trailing-space-save {BOOLEÀ enable}

Quan està activat, els espais finals seran eliminats de cada línia en desar el document.

set-indent-mode {CADENA nom}

Estableix el mode de sagnat automàtic a nom. Si nom és desconegut, el mode seleccionat serà «none». Els modes vàlids són «none», «normal», «cstyle», «haskell», «lilypond», «lisp», «python», «ruby» i «xml».

set-auto-ident {BOOLEÀ script}

Activa o desactiva el sagnat automàtic.

set-highlight {CADENA ressaltat}

Estableix el sistema de ressaltat de la sintaxi per al document. L'argument haurà de ser un nom de ressaltat vàlid, com aquells que es poden veure en el menú Eines → Ressaltat. Aquesta ordre proveeix una llista de compleció automàtica per als seus arguments.

reload-scripts

Torna a carregar tots els scripts en JavaScript emprats pel Kate, inclosos els scripts de sagnat i de línia d'ordres.

set-mode {CADENA mode}

Tria l'esquema del tipus de fitxer per al document actual.

nn[oremap] {CADENA original} {CADENA mapped}

Mapa de la seqüència de tecles original a mapped.

indent

Sagna les línies seleccionades o la línia actual.

unindent

Treu el sagnat de les línies seleccionades o la línia actual.

cleanindent

Treu el sagnat de les línies seleccionades o la línia actual d'acord amb la configuració de sagnat que teniu establerts al document.

comment

Insereix marques de comentari fent que la selecció, les línies seleccionades o la línia actual siguin un comentari d'acord amb el format de text que s'hagi definit al ressaltat de la sintaxi per al document.

uncomment

Elimina les marques de comentari de la selecció, de les línies seleccionades o la línia actual, d'acord amb el format del text tal com és definit per la definició de ressaltat de la sintaxi per al document.

kill-line

Elimina la línia actual.

replace {CADENA patró} {CADENA substitució}

Substitueix el text en què coincideixi el patró amb el valor de substitució. Si voleu incloure espais en blanc en el patró, haureu de posar entre cometes tant el patró com la substitució amb cometes simples o dobles. Si els arguments no es troben entre cometes, s'utilitzarà la primera paraula com a patró i la resta com a substitució. Si la substitució està buida, cada ocurrència del patró serà eliminada.

Podeu establir etiquetes per a configurar la cerca afegint dos punts, seguits d'una o més lletres cadascuna de les quals representa una configuració, quedant de la forma replace:opcions patró substitució. Les opcions disponibles són:

b

Cerca enrere.

c

Cerca des de la posició del cursor.

e

Cerca només en el text seleccionat.

r

Cerca utilitzant una expressió regular. Si està establerta, podeu utilitzar \N a on N serà un número per a representar captures en la cadena de substitució.

s

Cerca distingint entre majúscules i minúscules.

p

Demana permís per a substituir la següent ocurrència.

w

Només coincidiran paraules senceres.

date {CADENA format}

Insereix una cadena de data/hora definida d'acord amb el format, o si aquest no s'especifica s'utilitzarà el format «aaaa-MM-dd hh:mm:ss». La interpretació del format serà la següent:

d	El dia com a número sense zeros a l'esquerra (1-31).
dd	El dia com a número amb dos dígits (01-31).
ddd	L'abreujament del nom del dia segons la localització (p. ex., «Dl»..«Dg»).
dddd	El nom llarg del dia segons la localització (p. ex., «Dilluns»..«Diumenge»).
M	El mes com a número sense zeros a l'esquerra (1-31).
MM	El mes com a número amb dos dígits (01-31).
MMMM	El nom llarg del mes segons la localització (p. ex., «Gener»..«Desembre»).
MMM	El nom abreujat del mes segons la localització (p. ex., «Gen»..«Dec»).
yy	L'any amb un número de dos dígits (00-99).
yyyy	L'any amb un número de quatre dígits (1752-8000).
h	L'hora sense zeros a l'esquerra (0..23 o 1..12 si es mostra AM/PM).
hh	L'hora amb dos dígits (00..23 o 01..12 si es mostra AM/PM).
m	Els minuts sense zeros a l'esquerra (0..59).
mm	Els minuts amb dos dígits (00..59).
s	Els segons sense zeros a l'esquerra (0..59).
ss	Els segons amb dos dígits (00..59).
z	Els mil·lisegons sense zeros a l'esquerra (0..999).
zzz	Els mil·lisegons amb tres dígits (000..999).
AP	S'usa per a mostrar AM/PM. AP serà substituït per «AM» o «PM».
ap	S'usa per a mostrar am/pm. ap serà substituït per «am» o «pm».

char {CADENA identificador}

Aquesta ordre permet inserir caràcters literals pel seu identificador numèric, en format decimal, octal o hexadecimal. Per a utilitzar-la llanceu el diàleg Ordre d'edició i escriviu char:[número] en el quadre d'entrada, després premeu D'acord.

Exemple 5.1. Exemples de char

Entrada: char:234

Eixida: ê

Entrada: char:0x1234

Eixida: ሴ

s///[ig] %s///[ig]

Aquesta ordre realitzarà una operació de cerca/substitució similar a les de «sed» sobre la línia actual o en tot el fitxer (%s///).

Abreujat, se cerca en el text alguna cadena que coincideixi amb el patró de cerca, l'expressió regular entre la primera i la segona barra, i quan es troba una coincidència, la part coincident del text és substituïda per l'expressió continguda entre les barres segona i última. Els parèntesis en el patró de cerca creen referències enrere, és a dir, que l'ordre recorda quina part de la cadena es correspon amb els parèntesis; aquestes cadenes es poden tornar a utilitzar en el patró de substitució, referint-se a elles com a \1 per al primer conjunt de parèntesis, \2 per al segon i així successivament.

Per a fer una cerca literal de ( o ), haureu d'escapar el caràcter emprant un altre caràcter de barra inversa: \(\)

Si poseu una i al final de l'expressió, les coincidències distingiran majúscules i minúscules. Si poseu una g al final, se substituiran totes les ocurrències del patró, en qualsevol altre cas només se substituirà la primera ocurrència.

Exemple 5.2. Substitució de text en la línia actual

El vostre bon amic l'ordinador s'ha aturat, dient que la classe myClass mencionada en la línia 3902 del fitxer font no està definida.

«Llamps i trons!» Pensareu. Per descomptat és MyClass. Anireu fins a la línia 3902 i en comptes d'intentar cercar la paraula en el text, obrireu el diàleg Ordre d'edició, introduireu s/myclass/MyClass/i, premereu el botó D'acord, desareu el fitxer i tornareu a compilar aquesta vegada sense l'error.

Exemple 5.3. Substitució de text en tot el fitxer

Imagineu que teniu un fitxer, en el que mencioneu a «Miss Jensen» diverses vegades, quan resulta que algú ve i us diu que s'acaba de casar amb «Mr Jones». Per descomptat, voldreu substituir cada ocurrència de «Miss Jensen» per «Ms Jones».

Entreu a la línia d'ordres, escriviu l'ordre %s/Miss Jensen/Ms Jones/, una vegada premeu Retorn ja estarà fet.

Exemple 5.4. Un exemple més avançat

Aquest exemple fa ús de referències enrere així com d'una classe de caràcter (si no sabeu què és això, si us plau, consulteu la documentació mencionada a sota).

Suposeu que teniu la següent línia:

void MyClass::DoStringOps( String      &foo, String &bar, String *p, int  &a, int &b )

Però us adoneu que aquest codi no està bé i decidiu que voleu utilitzar la paraula clau const per a tots els arguments «adreça de», que es caracteritzen per tenir un operador & al davant del nom de l'argument. També voldreu simplificar l'espai en blanc, de manera que només n'hi hagi un entre cada paraula.

Obriu el diàleg Ordre d'edició i introduïu: s/\s+(\w+)\s+(&)/ const \1 \2/g, i després premeu el botó D'acord. La g al final de l'expressió fa que l'expressió regular recompili cada coincidència per a desar les referències enrere.

Eixida: void MyClass::DoStringOps( const String &foo, const String &bar, String *p, const int &a, const int &b )

Missió completada! Ara, què ha passat? Vaja, hem cercat algun espai en blanc (\s+) seguit d'un o més caràcters alfabètics (\w+) seguits d'algun espai en blanc (\s+) seguit del símbol «&», i en el procés hem desat el bloc alfabètic i el caràcter «&» per a tornar a emprar-los en l'operació de substitució. Aleshores hem substituït la part coincident de la nostra línia per un espai en blanc seguit de «const» seguit d'un espai en blanc seguit del nostre bloc alfabètic (\1) seguit d'un espai en blanc seguit del nostre caràcter «&» emmagatzemat (\2)

En alguns casos el bloc alfabètic era «String», en d'altres «int», de manera que emprant la classe de caràcter \w i el quantificador + ens ha proveït d'un valuós actiu.

sort

Ordena el text seleccionat o tot el document.

natsort

Ordena el text seleccionat o tot el document de forma natural.

Exemple 5.5. sort vs. natsort

sort(a10, a1, a2) resulta en a1, a10, a2

natsort(a10, a1, a2) resulta en a1, a2, a10

moveLinesDown

Mou cap avall les línies seleccionades.

moveLinesUp

Mou cap amunt les línies seleccionades.

uniq

Elimina les línies duplicades del text seleccionat o de tot el document.

rtrim

Elimina els espais finals del text seleccionat o de tot el document.

ltrim

Elimina els espais al començament del text seleccionat o de tot el document.

join [separador CADENA]

Uneix les línies seleccionades o tot el document. De manera opcional pren un paràmetre definint un separador, per exemple: join ', '

rmblank

Elimina tots els espais en blanc del text seleccionat o de tot el document.

alignon

Aquesta ordre alinea les línies del bloc seleccionat o de tot el document a la columna indicada per una expressió regular proporcionada com a argument.

Si proporcioneu un patró buit, s'alinearà al primer caràcter no blanc de manera predeterminada.

Si el patró té una captura, se sagnarà en la coincidència capturada.

Exemples:

alignon - inserirà espais abans del primer «-» de cada línia per a alinear-les totes a la mateixa columna.

alignon :\\s+(.) inserirà espais abans del primer caràcter no blanc que hi hagi després de dos punts (:) per a alinear-les totes a la mateixa columna.

unwrap

Ajusta les línies del text seleccionat o de tot el document.

each {CADENA script}

Dona una funció de JavaScript com un argument, aquesta crida a la llista de línies seleccionades i les substitueix pel valor retornat per aquesta crida.

Exemple 5.6. Unir les línies seleccionades

each 'function(lines){return lines.join(", ")}'

O, més curt:

each 'lines.join(", ")'

filter {CADENA script}

Dona una funció de JavaScript com un argument, aquesta crida a la llista de línies seleccionades i elimina les que el valor retornat és «false».

Exemple 5.7. Elimina les línies buides

filter 'function(1){return 1.length > 0;}'

O, més curt:

filter 'line.length > 0'

map {CADENA script}

Dona una funció de JavaScript com un argument, aquesta crida a la llista de línies seleccionades i substitueix la línia amb el valor de la crida.

Exemple 5.8. Elimina les línies buides

map 'function(line){return line.replace(/^s+/,"");}'

O, més curt:

map 'line.replace(/^s+/,"")'

duplicateLinesUp

Duplica les línies seleccionades per sobre de la selecció actual.

duplicateLinesDown

Duplica les línies seleccionades per sota de la selecció actual.

goto {ENTER línia}

Aquesta ordre va a la línia especificada.

grep {CADENA patró}

Cercar al document per al patró d'expressió regular. Per a més informació, vegeu Apèndix A, Expressions regulars.

find {CADENA patró}

Aquesta ordre navega fins a la primera ocurrència del patró d'acord amb la configuració. Les següents ocurrències es poden trobar utilitzant Edita → Cerca la següent (la drecera predeterminada és F3).

L'ordre «find» pot configurar-se afegint dos punts seguits per una o més opcions, el format serà find:opcions patró. Estan suportades les següents opcions:

b

Cerca enrere.

c

Cerca des de la posició del cursor.

e

Cerca només en el text seleccionat.

r

Cerca utilitzant una expressió regular. Si està establerta, podeu utilitzar \N a on N serà un número per a representar captures en la cadena de substitució.

s

Cerca distingint entre majúscules i minúscules.

w

Només coincidiran paraules senceres.

ifind {CADENA patró}

Aquesta ordre proveeix cerca «quan-escriviu». Podeu configurar-ne el comportament o la cerca afegint dos punts seguits per a una o més opcions, de forma similar a: ifind:patró d'opcions. Les opcions permeses són:

b

Cerca enrere.

r

Cerca mitjançant expressions regulars.

s

Cerca distingint entre majúscules i minúscules.

c

Cerca des de la posició del cursor.

w

Desa el document actual.

wa

Desa tots els documents oberts.

q

Tanca el document actual.

qa

Tanca tots els documents oberts.

wq

Tanca i desa el document obert.

wqa

Tanca i desa tots els documents oberts.

x

Desa el document actual només si ha canviat i després el tanca.

x

Desa tots els documents oberts només si han canviat i després els tanca.

bp

Va al document anterior en la llista de documents.

bn

Va al document següent en la llista de documents.

new

Obre un document nou en una vista dividida horitzontal.

vnew

Obre un document nou en una vista dividida vertical.

e

Torna a carregar el document actual si ha canviat al disc.

enew

Edita un document nou.

print

Obre el diàleg d'impressió per a imprimir el document actual.

Principals seccions dels fitxers de definició del ressaltat de la KatePart

Tots els fitxers de ressaltat contenen una capçalera que estableix la versió XML:

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

La part principal del fitxer de la definició és l'element language. Els atributs disponibles són:

Atributs requerits:

name estableix el nom del llenguatge. Després apareixerà als menús i als diàlegs.

section especifica la categoria.

extensions defineix les extensions dels fitxers, com "*.cpp;*.h"

version especifica la versió actual del fitxer de definició en termes d'un nombre enter. Sempre que es canvia un fitxer de definició del ressaltat, assegureu-vos d'augmentar aquest número.

kateversion especifica l'última versió implementada de la KatePart.

Atributs opcionals:

mimetype fitxers associats amb el tipus MIME.

casesensitive defineix quan les paraules clau distingeixen o no les majúscules i minúscules.

priority és necessària si una altra definició de ressaltat utilitza les mateixes extensions. S'emprarà la de major prioritat.

author conté el nom de l'autor i la seva adreça de correu electrònic.

license conté la llicència, normalment la llicència del MIT per a fitxers nous de ressaltat de la sintaxi.

style conté el llenguatge proporcionat i és utilitzat pels sagnadors per a l'atribut required-syntax-style.

indenter defineix quin sagnat emprar de manera predeterminada. Els atributs disponibles són: ada, normal, cstyle, cmake, haskell, latex, lilypond, lisp, lua, pascal, python, replicode, ruby i xml.

hidden defineix quan hauria d'aparèixer el nom en els menús de la KatePart.

De manera que la línia següent pot tenir un aspecte similar a:

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

A continuació estaria l'element highlighting, el qual conté l'element opcional list i els elements requerits contexts i itemDatas.

Els elements list contenen una llista de paraules clau. En aquest cas les paraules clau són class i const. Podeu afegir tantes llistes com us calguin.

Des del Frameworks del KDE 5.53, una llista pot incloure paraules clau d'una altra llista o llenguatge/fitxer, utilitzant l'element include. Els caràcters ## s'utilitzen per a separar el nom de la llista i el nom de la definició del llenguatge, de la mateixa manera que a la regla IncludeRules. Això és útil per a evitar la duplicació de llistes de paraules clau, si necessiteu incloure les paraules clau d'un altre llenguatge/fitxer. Per exemple, la llista altre_nom conté la paraula clau str i totes les paraules clau de la llista types, la qual pertany al llenguatge C++ de l'ISO.

L'element contexts conté tots els contexts. El primer és l'emprat de manera predeterminada i amb aquest s'iniciarà el ressaltat. Hi ha dues regles en el context text_normal, el qual farà coincidir la llista de paraules clau amb el nom algun_nom i una regla que detecta una cometa i canvia el context a cadena. Per a aprendre més sobre les regles llegiu el següent capítol.

La tercera part és l'element itemDatas. Conté tots els colors i tipus de lletra que necessiten els contexts i les regles. En aquest exemple, s'utilitzen itemData text_normal, cadena i paraula_clau.

<highlighting>
    <list name="algun_nom">
      <item>class</item>
      <item>const</item>
    </list>
    <list name="altre_nom">
      <item>str</item>
      <include>types##ISO C++</include>
    </list>
    <contexts>
      <context attribute="text_normal" lineEndContext="#pop" name="text_normal" >
        <keyword attribute="paraula_clau" context="#stay" String="algun_nom" />
        <keyword attribute="paraula_clau" context="#stay" String="altre_nom" />
        <DetectChar attribute="cadena" context="cadena" char="&quot;" />
      </context>
      <context attribute="cadena" lineEndContext="#stay" name="cadena" >
        <DetectChar attribute="cadena" context="#pop" char="&quot;" />
      </context>
    </contexts>
    <itemDatas>
      <itemData name="text_normal" defStyleNum="dsNormal" />
      <itemData name="paraula_clau" defStyleNum="dsKeyword" />
      <itemData name="cadena" defStyleNum="dsString" />
    </itemDatas>
  </highlighting>

L'última part de la definició del ressaltat és la secció opcional general. Pot contenir informació sobre paraules clau, plegat del codi, comentaris, sagnat, línies buides i verificació de l'ortografia.

La secció comment defineix amb quina cadena s'introdueix un comentari en una línia senzilla. També podeu definir un comentari en múltiples línies utilitzant multiLine amb l'atribut addicional end. Això s'empra si l'usuari prem la drecera corresponent per a comenta/descomenta.

La secció keywords defineix si les llistes de paraules clau distingeixen les majúscules i minúscules o no. Més endavant s'explicaran altres atributs.

Les altres seccions, folding, emptyLines i spellchecking, normalment no són necessàries i s'expliquen més endavant.

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

L'element context pertany al grup contexts. Un context defineix les regles específiques de context que s'han de seguir quan el sistema de ressaltat abasta el final d'una línia. Els atributs disponibles són:

name estableix el nom del context. Les regles utilitzaran el nom per a especificar el context al qual canviar si les regles coincideixen.

lineEndContext defineix el context al qual canviarà el sistema de ressaltat si abasta el final de la línia. Pot ser un nom o un altre context, #stay permetrà que no es canviï el context (p. ex., no fer res) o #pop farà que deixi aquest context. És possible utilitzar, per exemple #pop#pop#pop per a sortir tres vegades, o fins i tot #pop#pop!AltreContext perquè aparegui dues vegades i canviar a un context anomenat AltreContext. També és possible canviar a un context que pertanyi a una altra definició de llenguatge, de la mateixa manera que en les regles IncludeRules, p. ex., AlgunContext##JavaScript. Cal tenir en compte que no és possible utilitzar aquest canvi de context en combinació amb #pop, p. ex., #pop!AlgunContext##JavaScript no és vàlid. Els canvis de context també es descriuen a «Regles de detecció del ressaltat».

lineEmptyContext defineix el context si es troba una línia buida. La nomenclatura dels commutadors de context és la mateixa que s'ha descrit anteriorment a lineEndContext. De manera predeterminada: #stay.

fallthroughContext especifica el context següent al que canviar si no coincideix cap regla. La nomenclatura dels commutadors de context és la mateixa que s'ha descrit anteriorment a lineEndContext. De manera predeterminada: #stay.

fallthrough defineix si el sistema de ressaltat canviarà al context especificat a fallthroughContext si no coincideix cap regla. Cal tenir en compte que, des dels Frameworks 5.62 del KDE, aquest atribut està en desús a favor de fallthroughContext, ja que si està present aquest atribut, s'entendrà implícitament que el valor de fallthrough és true (cert). De manera predeterminada: false (fals).

noIndentationBasedFolding inhabilita el plegat basat en el sagnat dintre del context. Si el plegat basat en el sagnat no està activat, aquest atribut és inútil. Això es defineix en l'element folding del grup general. De manera predeterminada a: false.

L'element itemData es troba en el grup itemDatas. Defineix l'estil i els colors dels tipus de lletra. Per tant és possible definir els vostres propis estils i colors. Encara que recomanem utilitzar els estils predeterminats, atès que així l'usuari veurà colors homogenis per als diferents llenguatges. Si bé, algunes vegades no hi ha altres possibilitats i és necessari canviar el color i els atributs dels tipus de lletra. Els atributs «name» i «defStyleNum» són necessaris, els altres són opcionals. Els atributs disponibles són:

name estableix el nom del «itemData». Els contexts i les regles utilitzaran aquest nom en els seus atributs attribute per a fer referència a un «itemData».

defStyleNum defineix quin estil s'emprarà de manera predeterminada. Més endavant s'explicaran els estils predeterminats disponibles.

color defineix un color. Els formats vàlids són «#rrggbb» o «#rgb».

selColor defineix el color de la selecció.

italic si està a true, el text es mostrarà en cursiva.

bold si està a true, el text es mostrarà en negreta.

underline si està a true, el text es mostrarà subratllat.

strikeout si està a true, el text es mostrarà taxat.

spellChecking si està a true, el text es mostrarà amb la verificació ortogràfica.

L'element keywords en el grup general defineix les propietats «keyword». Els atributs disponibles són:

casesensitive pot ser true o false. Si està a true, totes les paraules clau distingiran les majúscules i minúscules.

weakDeliminator és una llista de caràcters que no actuen com a delimitadors de paraules (delimitador feble). Per exemple, el punt «.» és un delimitador de paraula. Si tenim una paraula clau en una list que conté un punt, tan sols la trobareu si especifiqueu el punt com a delimitador feble.

additionalDeliminator defineix delimitadors addicionals.

wordWrapDeliminator defineix els caràcters al darrere dels quals pot ocórrer un ajust de la línia.

Els delimitadors predeterminats i els d'ajust de la línia són els caràcters .():!+,-<=>%&*/;?[]^{|}~\, espai (« ») i tabulació («\t»).

L'element comment en el grup comments defineix les propietats dels comentaris emprats per a Eines → Comenta, Eines → Descomenta i Eines → Commuta els comentaris. Els atributs disponibles són:

name pot ser singleLine o multiLine. Si escolliu multiLine es necessiten els atributs end i region. Si escolliu singleLine podreu afegir l'atribut opcional position.

start defineix la cadena que s'utilitza per a iniciar un comentari. En C++ seria "/*" en comentaris multilínia. Aquest atribut és requerit per als tipus multiLine i singleLine.

end defineix la cadena utilitzada per a tancar un comentari. En C++ seria "*/". Només està disponible aquest atribut i es necessita per als comentaris del tipus multiLine.

region serà el nom amb el qual es desarà el comentari multilínia. Si assumim que tenim una regió beginRegion="Comentari" ... endRegion="Comentari" en les regles, haureu d'emprar region="Comentari". D'aquesta manera es descomentarà fins i tot si no heu seleccionat tot el text en un comentari multilínia. El cursor només haurà d'estar dins del comentari multilínia. Només està disponible aquest atribut i es necessita per als comentaris del tipus multiLine.

position defineix on s'insereix el comentari d'una sola línia. De manera predeterminada, el comentari d'una sola línia es col·loca al començament de la línia a la columna 0, però si utilitzeu position="afterwhitespace", el comentari s'insereix a la dreta després dels espais en blanc inicials, abans del primer caràcter que no sigui un espai en blanc. Això és útil per a posar comentaris correctament en llenguatges on la sagnia és important, com el Python o YAML. Aquest atribut és opcional i l'únic valor possible és afterwhitespace. Només està disponible per als tipus singleLine.

L'element folding en el grup general defineix les propietats de plegat del codi. Els atributs disponibles són:

indentationsensitive si està a true, els marcadors de plegat del codi seran afegits al sagnat, com en el llenguatge per a la creació de scripts en Python. Normalment no caldrà establir-lo, ja que de manera predeterminada és false.

L'element emptyLine pertany al grup emptyLines defineix quines línies s'hauran de tractar com a línies buides. Això permet modificar el comportament de l'atribut lineEmptyContext en els elements context. Els atributs disponibles són:

regexpr defineix una expressió regular que es tractarà com una línia buida. De manera predeterminada, les línies buides no contenen cap caràcter, per tant, això afegirà línies buides addicionals, per exemple, si voleu que les línies amb espais també es consideren com a línies buides. No obstant això, en la majoria de les definicions de la sintaxi no caldrà establir aquest atribut.

L'element encoding en el grup spellchecking defineix una codificació de caràcters per a la verificació ortogràfica. Els atributs disponibles són:

char, és un caràcter codificat.

string és una seqüència de caràcters que es codificaran com el caràcter char a la verificació ortogràfica. Per exemple, en el llenguatge LaTeX, la cadena \"{A} representa el caràcter Ä.

Estils predeterminats en general:

dsNormal, quan no es requereix un ressaltat especial.

dsKeyword, paraules clau incloses.

dsFunction, crides a funcions i definicions.

dsVariable, si és aplicable: noms de les variables (p. ex., $algunaVar als llenguatges PHP/Perl).

dsControlFlow, controla el flux de paraules clau com «if», «else», «switch», «break», «return», «yield»...

dsOperator, operadors com + - * / :: < >

dsBuiltIn, funcions, classes i objectes inclosos.

dsExtension, extensions comunes, com les classes de les Qt™ i les funcions/macros en els llenguatges C++ i Python.

dsPreprocessor, declaracions del preprocessador o de definicions de macros.

dsAttribute, anotacions com «@override» i «__declspec(...)».

Estils predeterminats relacionats amb les cadenes:

dsChar, caràcters sols, com ara «x».

dsSpecialChar, caràcters amb un significat especial en cadenes com escapades, substitucions o els operadors d'expressions regulars.

dsString, cadenes com «hello world».

dsVerbatimString, cadenes literals o sense processar com «raw \backlash» en els llenguatges Perl, CoffeeScript i intèrprets d'ordres, així com «r'\raw'» en llenguatge Python.

dsSpecialString, SQL, expressions regulars, documentació HERE, mode matemàtic de L^AT_EX...

dsImport, importar, incloure o requerir mòduls.

Estils predeterminats relacionats amb números:

dsDataType, tipus de dades incloses com «int», «void», «u64».

dsDecVal, valors decimals.

dsBaseN, valors en una base diferent de 10.

dsFloat, valors de coma flotant.

dsConstant, definicions incloses i definides per l'usuari com PI.

Estils predeterminats relacionats amb la documentació i els comentaris:

dsComment, comentaris.

dsDocumentation, «/** Comentaris de documentació */» o «"""cadenes_de_documentació"""».

dsAnnotation, ordres de la documentació com «@param», «@brief».

dsCommentVar, els noms de les variables utilitzades en les ordres anteriors, com «foobar» a «@param foobar».

dsRegionMarker, marcadors de regió com els comentaris «//BEGIN», «//END».

Altres estils predeterminats:

dsInformation, notes i consells com «@note» al doxygen.

dsWarning, avisos com «@warning» al doxygen.

dsAlert, paraules especials com «Per fer», «TODO», «FIXME», «XXXX».

dsError, errors de ressaltat i sintaxi incorrecta.

dsOthers, quan res més s'hi ajusti.

DetectChar

Detecta un únic caràcter específic. Normalment s'utilitza per a trobar el final de les cadenes entre cometes.

<DetectChar char="(caràcter)" (atributs comuns) (dinàmic) />

L'atribut char defineix el caràcter a comparar.

Detect2Chars

Detecta dos caràcters especificats en l'ordre definit.

<Detect2Chars char="(caràcter)" char1="(caràcter)" (atributs comuns) />

L'atribut char defineix el primer caràcter a comparar, char1 el segon.

AnyChar

Detecta un caràcter d'un conjunt de caràcters especificats.

<AnyChar String="(cadena)" (atributs comuns) />

L'atribut String defineix el conjunt de caràcters.

StringDetect

Detecta una cadena exacta.

<StringDetect String="(cadena)" [insensitive="true|false"] (atributs comuns) (dinàmic) />

L'atribut String defineix la cadena a comparar. L'atribut insensitive predeterminat és false i es passa a la funció de comparació de la cadena. Si el valor és true la comparació no distingirà les majúscules i minúscules.

WordDetect

Detectar una cadena exacta requereix límits de paraula com un punt «.» o un espai en blanc al començament i al final de la paraula. Penseu en \b<cadena>\b en termes d'una expressió regular, però és més ràpid que la regla RegExpr.

<WordDetect String="(cadena)" [insensitive="true|false"] (atributs comuns) (delimitadors locals) />

L'atribut String defineix la cadena a comparar. L'atribut insensitive predeterminat és false i es passa a la funció de comparació de la cadena. Si el valor és true la comparació no distingirà les majúscules i minúscules.

Des del: Kate 3.5 (KDE 4.5)

RegExpr

Cerca la coincidència amb una expressió regular.

<RegExpr String="(cadena)" [insensitive="true|false"] [minimal="true|false"] (atributs comuns) (dinàmic) />

L'atribut String defineix l'expressió regular.

insensitive de manera predeterminada és false i és passada al motor d'expressions regulars.

minimal de manera predeterminada és false i és passada al motor d'expressions regulars.

Atès que les regles coincideixen amb el començament de la cadena actual, una expressió regular que comenci amb l'accent circumflex (^) indica que la regla tan sols s'haurà de comparar amb el començament d'una línia.

Per a obtenir més informació, vegeu la secció sobre expressions regulars.

keyword

Detecta una paraula clau des d'una llista especificada.

<keyword String="(nom de la llista)" (atributs comuns) (delimitadors locals) />

L'atribut String identifica la llista de paraules clau pel seu nom. Haurà d'existir una llista amb aquest nom.

El sistema de ressaltat processa les regles de paraules clau d'una manera molt optimitzada. Això fa que sigui una necessitat absoluta que qualsevol paraula clau que coincideixi necessitarà estar envoltada pels delimitadors definits, ja sigui implícitament (els delimitadors predeterminats), o explícitament especificat dins la propietat additionalDeliminator de l'etiqueta keywords.

Si una paraula clau coincideix haurà de contenir un caràcter de delimitador, aquest caràcter respectiu haurà d'afegir-se a la propietat weakDeliminator de l'etiqueta keywords. Aquest caràcter perdrà la seva propietat delimitadora en totes les regles keyword. També és possible utilitzar l'atribut weakDeliminator de la keyword perquè aquesta modificació només s'apliqui a aquesta regla.

Int

Detecta un nombre enter (com l'expressió regular: \b[0-9]+).

<Int (atributs comuns) (delimitadors locals) />

Aquesta regla no té atributs específics.

Decimals

Detecta un nombre decimal (com l'expressió regular: (\b[0-9]+\.[0-9]*|\.[0-9]+)([eE][-+]?[0-9]+)?).

<Float (atributs comuns) (delimitadors locals) />

Aquesta regla no té atributs específics.

HlCOct

Detecta una representació numèrica d'un nombre octal (com l'expressió regular: \b0[0-7]+).

<HlCOct (atributs comuns) (delimitadors locals) />

Aquesta regla no té atributs específics.

HlCHex

Detecta una representació numèrica d'un nombre hexadecimal (com una expressió regular: \b0[xX][0-9a-fA-F]+).

<HlCHex (atributs comuns) (delimitadors locals) />

Aquesta regla no té atributs específics.

HlCStringChar

Detecta un caràcter escapat.

<HlCStringChar (atributs comuns) />

Aquesta regla no té atributs específics.

Localitza representacions literals de caràcters que habitualment s'utilitzen en el codi de programació, per exemple \n (línia nova) o \t (tabulació).

Els següents caràcters coincideixen amb la regla si segueixen a una barra inversa (\): abefnrtv"'?\. A més seran vàlids els nombres hexadecimals escapats com per exemple \xff, i els nombres octals escapats, per exemple \033.

HlCChar

Detecta un caràcter C.

<HlCChar (atributs comuns) />

Aquesta regla no té atributs específics.

Localitza caràcters C tancats en una marca (Exemple: 'c'). La marca pot ser un caràcter simple o un caràcter escapat. Vegeu «HICStringChar» per a localitzar seqüències de caràcters escapats.

RangeDetect

Detecta una cadena amb caràcters d'inici i de final definits.

<RangeDetect char="(caràcter)"  char1="(caràcter)" (atributs comuns) />

char defineix el caràcter que inicia l'interval, char1 el caràcter que finalitza l'interval.

És molt útil per a detectar, per exemple, petites cadenes entre cometes i similars, però teniu en compte que el motor de ressaltat només pot treballar amb una línia a la vegada, de manera que no es detectaran les cadenes que estiguin dividides en dues línies o més.

LineContinue

Coincideix amb un caràcter específic al final d'una línia.

<LineContinue (atributs comuns) [char="\"] />

L'atribut char defineix un caràcter opcional a comparar, de manera predeterminada és la barra inversa ('\'). Nou des del KDE 4.13.

Aquesta regla és pràctica per a canviar el context al final de la línia. Això és necessari per exemple en C/C++ per a continuar macros o cadenes.

IncludeRules

Inclou regles des d'un altre context o llenguatge/fitxer.

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

L'atribut context defineix el context a incloure.

Si és una cadena simple, inclourà totes les regles definides en el context actual, exemple:

<IncludeRules context="anotherContext" />

Si la cadena conté un ## el sistema de ressaltat cercarà un context d'una altra definició del llenguatge amb el nom indicat, per exemple,

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

inclouria el context String des de la definició de ressaltat en C++.

Si l'atribut includeAttrib està a true, canvia l'atribut de destinació per un altre de la font. Això és necessari, per exemple, per al treball de comentar, si el text coincideix amb el context inclòs s'utilitzarà un ressaltat diferent que amb el context amfitrió.

DetectSpaces

Detecta els espais en blanc.

<DetectSpaces (atributs comuns) />

Aquesta regla no té atributs específics.

Utilitzeu aquesta regla si sabeu que hi poden haver diversos espais en blanc al davant, per exemple, al començament de les línies sagnades. Aquesta regla ometrà tots els espais en blanc a la vegada, en comptes de comprovar múltiples regles i saltar coincidències.

DetectIdentifier

Detecta identificadors de cadenes (com l'expressió regular: [a-zA-Z_][a-zA-Z0-9_]*).

<DetectIdentifier (atributs comuns) />

Aquesta regla no té atributs específics.

Utilitzeu aquesta regla per a saltar d'una vegada una cadena de paraula de caràcters, en comptes de comprovar múltiples regles a la vegada i saltar coincidències.