set-tab-width {INTEGER ширина}

Встановлює ширину табуляції у значення ширина.

set-indent-width {INTEGER ширина}

Встановлює відступ у значення кількості пробілів, визначене параметром ширина. Використовується, лише якщо увімкнено відступи з пробілів.

set-word-wrap-column {INTEGER довжина}

Встановлює для параметра максимальної довжини рядка для примусового перенесення значення довжина. Цей параметр використовується, якщо увімкнено автоматичне розбиття тексту на рядки.

set-icon-border {BOOLEAN вмикання}

Встановлює видимість бічної смужки піктограм.

set-folding-markers {BOOLEAN вмикання}

Встановлює значення видимості позначок панелі згортання.

set-line-numbers {BOOLEAN вмикання}

Встановлює значення видимості панелі номерів рядків.

set-replace-tabs {BOOLEAN вмикання}

Якщо має значення «true», введені вами знаки табуляції буде замінено пробілами.

set-remove-trailing-space {BOOLEAN вмикання}

Якщо цей параметр буде увімкнено, після переведення курсора на інших рядок пробіли наприкінці поточного рядка вилучатимуться.

set-show-tabs {BOOLEAN вмикання}

Якщо буде увімкнено цей параметр, символи табуляції і пробіли наприкінці рядка буде показано у вигляді маленьких крапок.

set-show-indent {BOOLEAN вмикання}

Якщо буде увімкнено цей параметр, відступи буде показано вертикальною крапчастою лінією.

set-indent-spaces {BOOLEAN вмикання}

Якщо буде увімкнено цей параметр, редактор робитиме відступ на indent-width пробілів, замість символу табуляції, під час переходу на наступний рівень відступу.

set-mixed-indent {BOOLEAN вмикання}

Якщо буде увімкнено цей параметр, KatePart використовуватиме суміш з символів табуляції і пробілів для додавання відступів. Ширина кожного з рівнів відступу визначатиметься значенням параметра indent-width, загальний же відступ буде оптимізовано так, щоб у ньому використовувалася максимальна кількість символів табуляції.

Після виконання цієї команди буде увімкнено створення відступів пробілами, якщо ширину відступу не було вказано, буде встановлено значення ширини відступу у половину значення параметра документа tab-width на час виконання команди.

set-word-wrap {BOOLEAN вмикання}

Встановлює значення для динамічного перенесення слів у вмикання (true або false)

set-replace-tabs-save {BOOLEAN вмикання}

Якщо увімкнути цей параметр, під час збереження документа символи табуляції буде замінено на пробіли.

set-remove-trailing-space-save {BOOLEAN вмикання}

Якщо увімкнути цей параметр, під час збереження документа пробіли наприкінці рядків документа будуть вилучатися.

set-indent-mode {STRING назва}

Встановлює режим автоматичного встановлення відступів у значення назва. Якщо програмі не вдасться розпізнати параметр назва, буде встановлено режим 'none'. Коректними значеннями режиму є «none», «normal», «cstyle», «haskell», «lilypond», «lisp», «python», «ruby» і «xml».

set-auto-ident {BOOLEAN скрипт}

Увімкнути або вимкнути автоматичне встановлення відступів.

set-highlight {STRING підсвічування}

Визначає систему підсвічування синтаксису для поточного документа. Параметром команди має бути коректна назва підсвічування у тому вигляді, у якому ця система фігурує у меню Інструменти → Підсвічування. У цій команді передбачено автоматичне доповнення параметра за списком.

reload-scripts

Перезавантажити всі скрипти JavaScript, використані Kate, зокрема скрипти встановлення відступів та скрипти командного рядка.

set-mode {STRING режим}

Вибрати схему типів файлів для поточного документа.

nn[oremap] {STRING початкова} {STRING відображена}

Відобразити послідовність символів початкова на послідовність відображена.

indent

Додає відступ у позначені рядки або поточний рядок.

unindent

Вилучає початковий відступ з позначених рядків або поточного рядка.

cleanindent

Вилучає відступи для позначених рядків або поточного рядка відповідно до параметрів відступів поточного документа.

comment

Додає позначки коментаря, які роблять позначений фрагмент тексту, позначені рядки або поточний рядок коментарями, відповідно до формату тексту, який визначено у параметрах підсвічування синтаксису поточного документа.

uncomment

Вилучає позначки коментаря, які роблять позначений фрагмент тексту, позначені рядки або поточний рядок коментарями, відповідно до формату тексту, який визначено у параметрах підсвічування синтаксису поточного документа.

kill-line

Вилучає поточний рядок.

replace { STRING шаблон} {STRING замінник}

Замінює текст, що відповідає шаблону, на текст, вказаний у заміннику. Якщо вам потрібно включити пробіл у шаблон, вам слід взяти як шаблон, так і замінник у одинарні або подвійні лапки. Якщо у команді не буде лапок, перше зі слів-параметрів вважатиметься шаблоном, а решта — замінником. Якщо параметр замінник буде порожнім, всі рядки, які відповідають шаблону буде вилучено з тексту.

Ви можете вказати прапорці налаштування пошуку за допомогою додавання двокрапки, за якою слід вказати одну або декілька літер, кожна з яких відповідатиме за налаштування. Команда викладатиме так: replace:параметри шаблон замінник. Можливі параметри:

b

Пошук назад.

c

Шукати від позиції курсора.

e

Шукати лише у позначеному фрагменті.

r

Пошук за формальним виразом. Якщо встановлено цей прапорець, ви зможете використовувати параметр \N, де N — номер підрядка у рядку «замінник».

s

Виконати пошук з врахуванням регістру.

p

Запитувати про дозвіл на заміну наступного елемента.

w

Шукати лише цілі слова.

date {STRING формат}

Вставляє дату/час у форматі, визначеному параметром формат, або у форматі «yyyy-MM-dd hh:mm:ss», якщо рядок формату не буде вказано. Під час обробки рядка формат буде використано такі перетворення:

d	Номер дня без початкового нуля (1-31).
dd	Номер дня з початковим нулем (01-31).
ddd	Скорочена локалізована назва дня тижня (наприклад «пн» або «нд»).
dddd	Довга локалізована назва дня (наприклад «понеділок» або «неділя»).
M	Номер місяця без початкового нуля (1-12).
MM	Номер місяця з початковим нулем (01-12).
MMMM	Повна локалізована назва місяця (наприклад, «січень» або «грудень»).
MMM	Скорочена локалізована назва місяця (наприклад «січ» або «гру»).
yy	Рік як двоцифрове значення (00-99).
yyyy	Рік як чотирицифрове значення (1752-8000).
h	Години без початкового нуля (0..23 або 1..12 з показом до опівдня/після опівдня).
hh	Години з початковим нулем (00..23 або 01..12 з показом до опівдня/після опівдня).
m	Хвилини без початкового нуля (0..59).
mm	Хвилини з початковим нулем (00..59).
s	Секунди без початкового нуля (0..59).
ss	Секунди з початковим нулем (00..59).
z	Мілісекунди без початкових нулів (0..999).
zzz	Мілісекунди з початковими нулями (000..999).
AP	Використовувати показ у форматі AM/PM (до опівдня/після опівдня). AP буде замінено на рядок «AM» або рядок «PM».
ap	Використовувати показ у форматі am/pm (до опівдня/після опівдня). ap буде замінено на рядок «am» або рядок «pm».

char {STRING ідентифікатор}

За допомогою цієї команди можна вводити символи за їх числовими ідентифікаторами у десятковій, вісімковій або шістнадцятковій формі. Щоб скористатися нею, відкрийте діалогове вікно редагування команди і введіть команду char: [число] у поле для введення, а потім натисніть кнопку Гаразд.

Приклад 5.1. Приклади команди char

Ввід: char:234

Вивід: ê

Ввід: char:0x1234

Вивід: ሴ

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

За допомогою цієї команди можна виконати дію з пошуку або заміни у стилі sed у поточному рядку або у всьому файлі (%s///).

Якщо коротко, у тексті буде виконано пошук за шаблоном пошуку, формальним виразом між першою і другою навскісними рисками, якщо буде знайдено відповідний фрагмент тексту, його буде замінено на вираз між середньою і останньою навскісними рисками у рядку. За допомогою круглих дужок можна створювати зворотні посилання: команда запам’ятає частину виразу, яка відповідає рядку між дужками і використає рядки, які будуть у пам’яті для шаблону заміни, — посилання на ці рядки можна вказати як \1 для першого набору у дужках, \2 для другого тощо.

Щоб знайти символ ( або символ ), вам слід екранувати ці символи за допомогою зворотної навскісної риски: \(\)

Якщо ви додасте ключ i в кінець виразу, під час пошуку буде враховано регістр символів. Якщо в кінець виразу додати g, буде замінено всі рядки, які відповідають шаблону, у іншому випадку буде замінено лише перший з цих рядків.

Приклад 5.2. Заміна тексту у поточному рядку

Припустімо, компілятор, яким ви збирали вашу програму, повідомив вам про те, що клас myClass, який згадується у рядку 3902 коду вашої програми не визначено.

Ви подумаєте: «Оце тобі, то це ж має бути мій клас MyClass». Ви переходите до рядка 3902 і, замість спроб знайти потрібне слово у тексті, відкриваєте діалогове вікно редагування команди, вводите у нього s/myclass/MyClass/i, натискаєте кнопку Гаразд, зберігаєте файл і компілюєте його ще раз, — все, помилки немає.

Приклад 5.3. Заміна тексту у всьому файлі

Припустімо тепер, що у вас є файл, у якому ви згадуєте «пані Іванченко» декілька разів, і тут вам стає відомо, що ця особа нещодавно вийшла заміж за «пана Петренка». Ну і, звісно ж, вам потрібно тепер замінити всі рядки з «пані Іванченко» на «пані Петренко».

Відкрийте вікно командного рядка і введіть туди команду %s/пані Іванченко/пані Петренко/, а потім натисніть клавішу Enter, — решту зробить програма.

Приклад 5.4. Складніший приклад

У цьому прикладі ми познайомилися з використанням зворотніх посилань, а також класу символів (якщо вам не знайомі ці терміни, будь ласка, зверніться до відповідної документації, посилання на яку ви зможете знайти далі за текстом).

Припустімо, що у вас є такий рядок:

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

Тепер вам здається, що цей код виглядає кострубато: ви вирішили скористатися ключовим словом const для всіх параметрів «address of», у яких назві аргументу передує оператор &. Ви також бажаєте вилучити зайві пробіли так, щоб між будь-якими двома словами був лише один символ пробілу.

Відкрийте діалогове вікно редагування команди і введіть таку команду: s/\s+(\w+)\s+(&)/ const \1 \2/g. Натисніть кнопку Гаразд. Літера g наприкінці виразу наказує програмі перебудовувати формальний вираз для кожного зі знайдених елементів, щоб зберегти зворотні посилання.

Вивід: void MyClass::DoStringOps( const String &foo, const String &bar String *p, const int &a, const int &b )

Справу зроблено! Що ж сталося? Гаразд, було виконано пошук інтервалу з пробілів (\s+), за яким слідує один або декілька символів абетки (\w+), за якими слідують ще пробіли (\s+), за якими слідує символ амперсанда. У процесі пошуку було збережено ланцюжок символів абетки і амперсанд для подальшого використання під час операції з заміни. Після цього було виконано заміну знайденого відповідника нашого рядка на рядок з пробілом, за яким слідує слово «const», за яким слідує пробіл, за яким слідує наш ланцюжок символів абетки (\1), за яким слідує один пробіл, за яким слідує збережений нами символ амперсанда (\2)

Крім того, у деяких випадках ланцюжок символів абетки міг мати значення «String», у деяких «int», цього було досягнуто використанням класу \w і лічильника +.

sort

Впорядковує позначений фрагмент тексту або весь текст у документі.

natsort

Впорядковує позначені рядки або увесь документ у природному порядку.

Приклад 5.5. sort порівняно з natsort

sort(a10, a1, a2) виведе a1, a10, a2

sort(a10, a1, a2) виведе a1, a10, a2

moveLinesDown

Пересунути позначені рядки нижче.

moveLinesUp

Пересунути позначені рядки вище.

uniq

Вилучити рядки-дублікати з позначеного фрагмента тексту або всього документа.

rtrim

Вилучити кінцевий пробіл з позначеного фрагмента тексту або всього документа.

ltrim

Вилучити початковий пробіл з позначеного фрагмента тексту або всього документа.

join [STRING роздільник]

Об’єднати позначені рядки або рядки у всьому документі. Додатково можна визначити роздільник, наприклад: join ', '

rmblank

Вилучити всі пробіли з позначеного фрагмента тексту або всього документа.

alignon

Ця команда вирівнює рядки позначеного блоку або усього документа до позиції, яку вказано формальним виразом-аргументом.

Якщо буде вказано порожній взірець, вирівнювання типово відбудеться за першим непорожнім символом.

Якщо у взірці буде вказано блок захоплення, вирівнювання відбудеться за захопленим блоком.

Приклади:

alignon - вставить пробіли до першого «-» у кожному з рядків для вирівнювання усіх дефісів за вказаною позицією.

alignon :\s+(.) вставить пробіли до першого непорожнього символу, який стоїть після двокрапки, для вирівнювання усіх таких символів за однаковою позицією.

unwrap

Скасувати перенесення рядків у позначеному фрагменті тексту або всьому документі.

each {STRING скрипт}

Викликати вказану як аргумент функцію JavaScript для обробки списку (позначених) рядків і замінити їх повернутим значенням виклику.

Приклад 5.6. Об’єднати позначені рядки

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

Або коротше:

each 'lines.join(", ")'

filter {STRING скрипт}

Викликати вказану як аргумент функцію JavaScript для обробки списку (позначених) рядків і вилучити ті з них, для яких буде повернуто false.

Приклад 5.7. Вилучити порожні рядки

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

Або коротше:

filter 'line.length > 0'

map {STRING скрипт}

Викликати вказану як аргумент функцію JavaScript для обробки списку (позначених) рядків і замінити рядок значенням, яке буде повернуто у відповідь на виклик.

Приклад 5.8. Вилучити порожні рядки

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

Або коротше:

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

duplicateLinesUp

Здублювати позначені рядки над поточним позначеним фрагментом.

duplicateLinesDown

Здублювати позначені рядки під поточним позначеним фрагментом.

goto {INT рядок}

За допомогою цієї команди можна перейти до вказаного рядка.

grep {STRING шаблон}

Знайти у документі рядки, що відповідають формальному виразу шаблон. Щоб дізнатися більше, зверніться до розділу Додаток A, Формальні вирази.

find {STRING шаблон}

За допомогою цієї команди можна перейти до першого відповідника рядка шаблон у тексті, відповідно до налаштувань. Перейти до наступних відповідників можна за допомогою пункту меню Зміни → Знайти далі (типовим клавіатурним скороченням є F3).

Команду пошуку можна налаштувати додаванням двокрапки, за якою можна вказати один або декілька параметрів, у формі find:параметри шаблон. Серед можливих параметрів:

b

Пошук назад.

c

Шукати від позиції курсора.

e

Шукати лише у позначеному фрагменті.

r

Пошук за формальним виразом. Якщо встановлено цей прапорець, ви зможете використовувати параметр \N, де N — номер підрядка у рядку «замінник».

s

Виконати пошук з врахуванням регістру.

w

Шукати лише цілі слова.

ifind {STRING шаблон}

За допомогою цієї команди можна виконати «інтерактивний» пошук. Ви можете налаштувати пошук додаванням одного або декількох параметрів після символу двокрапки, ось так: ifind:параметри шаблон. Серед можливих параметрів:

b

Пошук назад.

r

Виконати пошук за вказаним формальним виразом.

s

Виконати пошук з врахуванням регістру.

c

Шукати від позиції курсора.

w

Зберегти поточний документ.

wa

Зберегти всі поточні відкриті документи.

q

Закрити поточний документ.

qa

Закрити всі відкриті документи.

wq

Зберегти і закрити поточний документ.

wqa

Зберегти і закрити всі поточні відкриті документи.

x

Зберегти і закрити поточний документ, лише якщо його було змінено.

x

Зберегти і закрити всі поточні відкриті документ, лише якщо до них було внесено зміни.

bp

Перейти до попереднього документа у списку документів.

bn

Перейти до наступного документа у списку документів.

new

Відкрити новий документ на новій панелі, створеній горизонтальним поділом поточної панелі редагування.

vnew

Відкрити новий документ на новій панелі, створеній вертикальним поділом поточної панелі редагування.

e

Перезавантажити поточний документ, якщо його було змінено на диску.

enew

Редагувати новий документ.

print

Відкрити діалогове вікно друку, за допомогою якого ви зможете надрукувати поточний документ.

Головні розділи файлів визначення підсвічування KatePart

Файл підсвічування містить заголовок, у якому встановлюється версія XML:

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

Кореневим елементом файла визначення є елемент language. Серед можливих атрибутів:

Обов’язкові атрибути:

name визначає назву мови. Цю назву буде згодом показано у пунктах меню та діалогових вікнах програми.

section визначає категорію.

extensions визначає суфікси назв файлів, на зразок "*.cpp;*.h"

version визначає поточну модифікацію файла визначень у форматі цілого числа. Кожного разу, коли ви вноситимете зміни до файла визначень правил підсвічування, вам слід збільшувати це число.

kateversion визначає найостаннішу з підтримуваних версій KatePart.

Необов’язкові атрибути:

mimetype прив’язує файли на основі типу MIME.

casesensitive визначає, чи розрізнятимуться ключові слова за регістром символів, чи ні.

priority потрібно вказати, якщо у іншому файлі визначення підсвічування використовуються ті самі суфікси файлів. Для підсвічування буде використано правила з вищим пріоритетом.

author повинен містити ім’я і адресу електронної пошти автора.

license повинен містити назву ліцензії нового файла підсвічування, зазвичай, MIT.

style має містити дані щодо мови програмування і використовується засобами додавання відступів для атрибута required-syntax-style.

indenter визначає, який із засобів додавання відступів у рядки буде використано типово. Доступні засоби додавання відступів: ada, normal, cstyle, cmake, haskell, latex, lilypond, lisp, lua, pascal, python, replicode, ruby та xml.

hidden визначає, чи має бути показано назву підсвічування у меню KatePart.

Отже, наступний рядок має виглядати десь так:

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

Наступним елементом є highlighting, у цьому елементі міститься необов’язковий елемент list і обов’язкові елементи contexts і itemDatas.

Елементи list містять список ключових слів. У цьому випадку ключовими словами будуть class і const. У разі потреби ви можете додати довільну кількість списків.

Починаючи з KDE Frameworks 5.53, до списку можна включати ключові слова з іншого списку або мови чи файла за допомогою елемента include. Для відокремлення назви списку та назви визначення мови слід використовувати ## у той самий спосіб, що і у правилі IncludeRules. Ця можливість є корисною для уникнення дублювання списків ключових слів, якщо вам потрібно включити ключові слова з іншої мови або файла. Наприклад, у списку othername міститься ключове слово str і усі ключові слова списку types, який належить до мови програмування ISO C++.

У елементі contexts містяться всі контексти. Типово, першим контекстом є початок діапазону підсвічування. У контексті Normal Text існує два правила: перше визначає список ключових слів з назвою somename і правило для визначення лапок і перемикання контексту на контекст string. Докладніше правила буде розглянуто у наступній главі.

Третя частина складається з елемента itemDatas. У цьому елементі містяться всі кольори і гарнітури шрифтів, потрібні для контекстів і правил. У нашому випадку було використано itemData Normal Text, String і Keyword.

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

Останньою частиною визначення підсвічування є необов’язковий розділ general. У ньому можуть міститися відомості щодо ключових слів, згортання коду, коментарів, відступів, порожніх рядків та перевірки правопису.

У розділі comment визначається послідовність символів, за допомогою якої можна додати однорядковий коментар. Крім того, ви можете визначати багаторядкові коментарі за допомогою елемента multiLine з додатковим атрибутом end. Ці визначення буде використано за виконання користувачем дій закоментувати/розкоментувати.

У розділі keywords визначається те, чи слід враховувати регістр символів у списку ключових слів, чи ні. Інші атрибути буде описано далі за текстом.

В інших розділах, folding, emptyLines і spellchecking, зазвичай, потреби немає. Пояснення щодо цих розділів наведено нижче.

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

Елемент context належить до групи contexts. Цей елемент визначає специфічні для контексту правила, на зразок того, що має трапитися, якщо система підсвічування досягне кінця рядка. Серед можливих атрибутів:

name — назва контексту. За допомогою цієї назви правила визначатимуть контекст, на який слід перемкнутися у випадку виявлення відповідника правила.

lineEndContext визначає контекст, на який має перемкнутися система підсвічування у разі досягнення кінця рядка. Значенням може бути назва іншого контексту, #stay означатиме, що контекст не слід перемикати (тобто нічого не робити), або #pop означатиме, що слід вийти з контексту. Наприклад, можна скористатися значенням #pop#pop#pop для того, щоб система після виходу піднялася на три контексти вище, або навіть #pop#pop!ІншийКонтекст, щоб піднятися на два контексти вище і перемкнутися на контекст з назвою ІншийКонтекст. Також можна перемкнутися на контекст, який належить визначенню іншої мови, так само, як у правилах IncludeRules, наприклад, ЯкийсьКонтекст##JavaScript. Зауважте, що цей перемикач контексту не можна використовувати у поєднанні із #pop. Наприклад, #pop!ЯкийсьКонтекст##JavaScript є некоректним. Перемикачі контексту також описано у розділі «Правила визначення способу підсвічування».

lineEmptyContext визначає контекст, якщо буде знайдено порожній рядок. Номенклатура перемикань контексту є такою самою, як і раніше описано для lineEndContext. Типове значення: #stay.

fallthroughContext вказує наступний контекст для перемикання, якщо жодне з правил не є відповідним. Номенклатура перемикань контексту є такою самою, як і раніше описано для lineEndContext. Типове значення: #stay.

fallthrough визначає, чи перемикатиметься система підсвічування на контекст, визначений у fallthroughContext, якщо жодне з правил не буде визнано відповідним. Зауважте, що з версії KDE Frameworks 5.62 цей атрибут є застарілим. Замість нього слід використовувати fallthroughContext, оскільки якщо вказано атрибут fallthroughContext, неявним чином припускатиметься значення fallthrough рівне true. Типове значення: false.

noIndentationBasedFolding вимикає згортання на основі відступів у контексті. Якщо згортання на основі відступів не увімкнено, цей атрибут не має сенсу. Цей атрибут визначається у елементі folding групи general. Типове значення: false.

Елемент itemData знаходиться у групі itemDatas. За його допомогою визначаються тип шрифту і кольори. Таким чином можна визначати власні типи шрифтів і кольори, але ми рекомендуємо, за можливості, використовувати лише типові стилі так, щоб користувач завжди бачив однакові кольори у файлах різних форматів. Все ж іноді іншого способу не існує, і вам доведеться змінити колір і атрибути шрифту. Обов’язковими атрибутами є name і defStyleNum, інші атрибути є необов’язковими. Серед можливих атрибутів:

name визначає назву itemData. Цю назву буде використано у контекстах і правилах для посилання на itemData у атрибуті attribute.

defStyleNum визначає, який тип слід використовувати типово. Докладний перелік можливих типових стилів ви знайдете нижче.

color визначає колір. Можливі формати: '#rrggbb' і '#rgb'.

selColor визначає колір виділеного тексту.

italic, якщо має значення true, шрифт буде курсивним.

bold, якщо має значення true, шрифт тексту буде напівжирним.

underline: якщо цей атрибут має значення true, текст буде підкреслено.

strikeout, якщо цей параметр має значення true, текст буде перекреслено.

spellChecking: якщо цей атрибут має значення true, правопис тексту буде перевірено.

Елемент keywords у групі general визначає властивості ключових слів. Серед можливих атрибутів:

casesensitive, може приймати значення true або false. Якщо має значення true, пошук ключових слів відбуватиметься з врахуванням регістру символів.

weakDeliminator — це список символів, які не є символами відокремлення слів. Наприклад, крапка «.» є символом відокремлення слів. Припустімо тепер, що ключове слово у list містить крапку, тоді це слово буде задіяно, лише якщо ви вкажете крапку серед значень цього аргументу.

additionalDeliminator визначає додаткові символи розмітки.

wordWrapDeliminator визначає символи, після яких можна розривати рядок.

Типовими символами розмітки і символами відокремлення слів є символи .():!+,-<=>%&*/;?[]^{|}~\, пробіл (' ') і символ табуляції ('\t').

Елемент comment у групі comments визначає властивості коментаря, які буде використано для дій за пунктами меню Інструменти → Закоментувати, Інструменти → Розкоментувати and Інструменти → Додати або вилучити коментування. Серед доступних атрибутів:

name: може мати значення singleLine або multiLine. Якщо буде обрано варіант multiLine, слід буде також вказати атрибути end і region. Якщо ви виберете singleLine, ви зможете додати необов'язковий атрибут position.

start визначає рядок, який використовується для позначення початку коментаря. У C++ цим рядком для багаторядкових коментарів є "/*". Цей атрибут є обов'язковим для типів multiLine і singleLine.

end визначає рядок, яким завершуватиметься коментар. У C++ цим рядком буде "*/". Цей атрибути є доступним лише для коментарів типу multiLine і є для них обов'язковим.

Атрибут region повинен мати значення назви придатного для згортання багаторядкового коментаря. Припустімо, що у правилах вказано beginRegion="Comment" ... endRegion="Comment", тоді вам слід взяти значення region="Comment". За допомогою цього атрибута можна користуватися дією з розкоментування, навіть якщо було виділено не весь текст багаторядкового коментаря. Потрібно лише, щоб курсор знаходився всередині цього багаторядкового коментаря. Цей атрибут є доступним лише для типу multiLine.

position визначає місце вставлення однорядкового коментування. Типово, однорядкове коментування буде вставлено на початку рядка у позиції 0, але якщо ви скористаєтеся записом position="afterwhitespace", коментування буде вставлено праворуч після першого пробільного блоку, перед першим непробільним символом. Ця можливість є корисною для мов, де важливими є відступи у рядках, зокрема Python та YAML. Цей атрибут є необов'язковим, його єдиним можливим значенням є afterwhitespace. Цей атрибут є доступним лише для типу singleLine.

Елемент folding у групі general призначено для визначення властивостей згортання коду. Серед можливих атрибутів:

indentationsensitive: якщо має значення true, позначки згортання коду буде додано на основі відступів, так, як це робиться у скриптовій мові Python. Зазвичай, вам не потрібно буде встановлювати цей атрибут, оскільки його типовим значенням є false.

Елемент emptyLine у групі emptyLines визначає, які з рядків слід вважати порожніми. За його допомогою можна змінити поведінку атрибута lineEmptyContext в елементах context. Наявні атрибути:

regexpr визначає формальний вираз, відповідник якого вважатиметься порожнім рядком. Типово, порожні рядки не містять жодних символів, тому цей формальний вираз додає «порожні» рядки, наприклад, якщо ви хочете вважати рядки з пробілів порожніми. Втім, здебільшого, для визначення синтаксису у цьому атрибуті немає потреби.

Елемент encoding у групі spellchecking визначає кодування символів для перевірки правопису. Наявні атрибути:

char — кодований символ.

string — послідовність символів, яку буде закодовано як символ char при перевірці правопису. Наприклад, якщо виконується обробка коду мовою LaTeX, рядок \"{A} відповідатиме символу Ä.

Загальні типові стилі:

dsNormal, якщо непотрібне спеціальне підсвічування.

dsKeyword, вбудовані ключові слова мови.

dsFunction, виклики і визначення функцій.

dsVariable, якщо застосовне: назви змінних (наприклад $someVar у PHP/Perl).

dsControlFlow, ключові слова керування обробкою, зокрема if, else, switch, break, return, yield, ...

dsOperator, оператори, зокрема + - * / :: < >

dsBuiltIn, вбудовані функції, класи і об’єкти.

dsExtension, загальні розширення, зокрема класи Qt™ та функції і макроси у C++ та Python.

dsPreprocessor, інструкції препроцесора або визначення макросів.

dsAttribute, анотації, зокрема @override та __declspec(...).

Типові стилі, пов’язані із рядками:

dsChar, окремі символи, зокрема 'x'.

dsSpecialChar, символи із спеціальним призначенням у рядках, зокрема символи екранування, замінники або оператори формальних виразів.

dsString, рядки, зокрема "hello world".

dsVerbatimString, буквальні або необроблювані рядки, зокрема «raw \backlash» у Perl, CoffeeScript та командних оболонках, а також r'\raw' у Python.

dsSpecialString, SQL, формальні вирази, документація HERE, математичний режим L^AT_EX...

dsImport, імпорт, включення або потреба у модулях.

Пов’язані із числами типові стилі:

dsDataType, вбудовані типи даних, наприклад int, void, u64.

dsDecVal, десяткові значення.

dsBaseN, величини у численні з основою, відмінною від 10.

dsFloat, значення із рухомою крапкою.

dsConstant, вбудовані та визначені користувачем сталі, наприклад PI.

Типові стилі, пов’язані із коментаріми та документацією:

dsComment, коментарі.

dsDocumentation, /** Коментарі у документації */ або """docstrings""".

dsAnnotation, команди документації, зокрема @param, @brief.

dsCommentVar, назви змінних, використаних у попередніх командах, зокрема «foobar» у @param foobar.

dsRegionMarker, позначки області, зокрема //BEGIN, //END у коментарях.

Інші типові стилі:

dsInformation, нотатки і підказки, наприклад @note у doxygen.

dsWarning, попередження, наприклад @warning у doxygen.

dsAlert, спеціальні слова, наприклад TODO, FIXME, XXXX.

dsError, підсвічування помилок та синтаксичних неточностей.

dsOthers, якщо інше не є застосовним.

DetectChar

Перевірка на рівність одному певному символу. Зазвичай, використовується для пошуку кінця рядків, взятих у лапки.

<DetectChar char="(символ)" (загальні атрибути) (dynamic) />

Атрибут char визначає символ, з яким відбуватиметься порівняння.

Detect2Chars

Перевірка на рівність двом певним символам у вказаному порядку.

<Detect2Chars char="(символ)" char1="(символ)" (загальні атрибути) />

Атрибут char визначає перший символ для порівняння, char1 — другий.

AnyChar

Перевірка на рівність одному з символів вказаного набору.

<AnyChar String="(рядок)" (загальні атрибути) />

Атрибут String визначає набір символів.

StringDetect

Перевірка на рівність вказаному рядку.

<StringDetect String="(рядок)" [insensitive="true|false"] (загальні атрибути) (dynamic) />

Атрибут String визначає рядок для порівняння. Типовим значенням атрибута insensitive є false, цей атрибут передається функції порівняння рядків. Якщо значенням атрибута буде true, порівняння відбуватиметься без врахування регістру.

WordDetect

Виявити рядок, але з додатковою вимогою щодо меж слів, зокрема крапки, '.', або пробілу на початку або у кінці слова. Обробка \b<рядок>\b відбувається подібно до формального виразу, але виконується швидше за обробку правила RegExpr.

<WordDetect String="(рядок)" [insensitive="true|false"] (загальні атрибути) (локальні роздільники) />

Атрибут String визначає рядок для порівняння. Типовим значенням атрибута insensitive є false, цей атрибут передається функції порівняння рядків. Якщо значенням атрибута буде true, порівняння відбуватиметься без врахування регістру.

Починаючи з Kate 3.5 (KDE 4.5)

RegExpr

Перевірка на збіг з формальним виразом.

<RegExpr String="(рядок)" [insensitive="true|false"] [minimal="true|false"] (загальні атрибути) (dynamic) />

Атрибут String визначає формальний вираз.

Типовим значенням атрибута insensitive є false, цей атрибут передається рушію пошуку за формальним виразом.

Типовим значенням атрибута minimal є false, цей атрибут буде передано рушієві пошуку за формальним виразом.

Оскільки пошук відповідників для застосування правила завжди відбувається на початку поточного рядка, формальний вираз, що починається з символу каретки (^) вказує на те, що пошук відповідника правила слід виконувати лише на початку рядка.

Щоб дізнатися більше, ознайомтеся з розділом Формальні вирази.

keyword

Перевірка на рівність ключовому слову з вказаного списку.

<keyword String="(назва списку)" (загальні атрибути) (локальні роздільники) />

Атрибут String визначає назву списку ключових слів. Список з вказаною назвою має існувати.

Система підсвічування обробляє правила ключових слів у дуже оптимізований спосіб. Тому абсолютно необхідно, щоб усі ключові слова, які слід знайти, було обмежено визначеними роздільниками, заздалегідь передбаченими (типовими роздільниками) або явно визначеними у властивості additionalDeliminator теґу keywords.

Якщо ключове слово, яке слід знайти, має містити символ роздільника, відповідний символ слід додати до властивості weakDeliminator теґу keywords. Після цього символ втратить властивість роздільності у всіх правилах keyword. Також можна скористатися атрибутом weakDeliminator теґу keyword так, щоб ці конкретні зміни застосовувалися лише до цього конкретного правила.

Int

Виявлення цілого числа (формальний вираз: \b[0-9]+).

<Int (загальні атрибути) (локальні роздільники) />

У цього правила немає особливих атрибутів.

Float

Виявлення числа із рухомою крапкою (формальний вираз: (\b[0-9]+\.[0-9]*|\.[0-9]+)([eE][-+]?[0-9]+)?).

<Float (загальні атрибути) (локальні роздільники) />

У цього правила немає особливих атрибутів.

HlCOct

Виявлення вісімкового представлення числа (формальний вираз: \b0[0-7]+).

<HlCOct (загальні атрибути) (локальні роздільники) />

У цього правила немає особливих атрибутів.

HlCHex

Виявлення шістнадцяткового представлення числа (формальний вираз: \b0[xX][0-9a-fA-F]+).

<HlCHex (загальні атрибути) (локальні роздільники) />

У цього правила немає особливих атрибутів.

HlCStringChar

Перевірка на відповідність символу керівної послідовності.

<HlCStringChar (загальні атрибути) />

У цього правила немає особливих атрибутів.

Перевірка на відповідність символам, які часто використовуються у коді програм, наприклад \n (перехід на новий рядок) або \t (табуляція).

Пошук буде виконуватися за переліченими далі символами, якщо ці символи стоять одразу за зворотною навскісною рискою (\): abefnrtv"'?\. Крім того, відповідними вважатимуться шістнадцяткові числа, наприклад \xff, і екрановані вісімкові числа, наприклад \033.

HlCChar

Перевірка на відповідність символу C.

<HlCChar (загальні атрибути) />

У цього правила немає особливих атрибутів.

Перевірка на відповідність символам C, взятим у одинарні лапки (Приклад: 'c'). Отже, у таких лапках може бути простий символ або екранований символ. Щоб дізнатися про пошук екранованих послідовностей символів, перегляньте пункт для HlCStringChar.

RangeDetect

Перевірка на відповідність рядку з вказаними початковим і кінцевим символами.

<RangeDetect char="(символ)"  char1="(символ)" (загальні атрибути) />

char визначає символ, який повинен починати діапазон символів, char1 — символ, який має завершувати діапазон.

Корисно для виявлення, наприклад, невеличких рядків у лапках, але зауважте, що, оскільки рушій підсвічування обробляє за раз лише один рядок, у такий спосіб неможливо знайти рядки у лапках, які розбито між декількома рядками документа.

LineContinue

Перевірка на відповідність вказаному символу наприкінці рядка.

<LineContinue (загальні атрибути) [char="\"] />

Необов’язковий для встановлення відповідності атрибут char, типовим значенням є символ зворотної риски ('\'). Впроваджено з KDE 4.13.

Це правило корисне для перемикання контексту наприкінці рядка. Це потрібно, зокрема, у коді мовами C/C++ для продовження макросів або рядків.

IncludeRules

Включити правила з іншого контексту або мови/файла.

<IncludeRules context="посилання на контекст" [includeAttrib="true|false"] />

Атрибут context визначає контекст, який слід включити.

Якщо значенням є простий рядок, у поточний контекст буде включено всі визначені правила, наприклад:

<IncludeRules context="anotherContext" />

Якщо у рядку міститься послідовність символів ##, система підсвічування шукатиме контекст у іншому визначенні мови з вказаною назвою. Приклад:

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

включить контекст String з визначення правил підсвічування для C++.

Якщо атрибут includeAttrib матиме значення true, атрибут призначення буде змінено на атрибут джерела. Це потрібно для того, щоб, наприклад, виконати коментування, якщо текст, що відповідає знайденому контексту, має інше підсвічування, ніж текст у основному контексті.

DetectSpaces

Пошук пробілів.

<DetectSpaces (загальні атрибути) />

У цього правила немає особливих атрибутів.

Цим правилом можна скористатися, якщо вам точно відомо, що перед текстом рядка має бути декілька пробілів, наприклад, на початку рядків з відступом. За допомогою цього правила можна пропустити одразу всі пробіли, замість послідовної перевірки на основі декількох правил, кожне з яких надаватиме змогу відкидати по одному пробілу за один прийом через невідповідність.

DetectIdentifier

Пошук рядків ідентифікаторів (зокрема формальних виразів: [a-zA-Z_][a-zA-Z0-9_]*).

<DetectIdentifier (загальні атрибути) />

У цього правила немає особливих атрибутів.

Це правило слід використовувати для пропуску рядка з символів, які складають слова, замість послідовної перевірки на основі декількох правил, кожне з яких надаватиме змогу відкидати по одному символу за один прийом через невідповідність.