# Додаткові інструменти редагування

## Додавання/Вилучення позначок коментаря

За допомогою пунктів «Закоментувати» і «Розкоментувати» меню Інструменти ви зможете додавати або вилучати позначки коментарів до позначеного фрагмента або поточного рядка (у разі, якщо нічого не позначено), якщо коментарі підтримуються форматом файла, який ви редагуєте.

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

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

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

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

Щоб додати позначки коментарів, скористайтеся пунктом меню Інструменти Закоментувати або відповідною комбінацією клавіш, типовою комбінацією є &Ctrl;D.

Щоб вилучити позначки коментарів, скористайтеся пунктом меню Інструменти Розкоментувати або відповідною комбінацією клавіш, типовою комбінацією є &Ctrl;&Shift;D.

## Командний рядок компонента редактора

У компонент редактора &kappname; вбудовано інструмент для роботи з командним рядком, за допомогою якого ви зможете виконувати різноманітні дії за мінімального графічного інтерфейсу. Командний рядок — це текстова панель у нижній частині вікна редактора, щоб увімкнути показ цієї панелі скористайтеся пунктом меню Перегляд Перемкнутися до командного рядка або скористайтеся клавіатурним скороченням (типовим клавіатурним скороченням є F7). У редакторі передбачено набір команд, документацію з яких наведено нижче, та додаткові команди, за допомогою яких можна керувати додатками до програми.

Щоб виконати команду, введіть цю команду до командного рядка і натисніть клавішу &Enter;. За командним рядком ви зможете визначити, чи було виконано команду, у ньому ж можна переглянути повідомлення, яке могло бути виведено у відповідь на команду. Якщо ви вводили команду за після натискання клавіші F7, за декілька секунд панель командного рядка буде приховано. Щоб витерти виведене командою повідомлення і ввести нову команду, натисніть клавішу F7 ще раз.

У командний рядок вбудовано довідкову систему. Щоб розпочати роботу з довідкою, введіть команду `help`. Щоб переглянути список можливих команд, введіть команду `help list`. Щоб переглянути довідку з окремої команди, виконайте команду `help `назва_команди``.

Під час роботи з командним рядком ви можете скористатися вбудованим журналом команд, таким чином ви можете зменшити час доступу до команд, які вже раніше було введено. Для навігації журналом команд скористайтеся клавішами Стрілка вгору і Стрілка вниз. Під час показу команд з журналу буде позначено параметри команди, — це спростить вам перезапис параметрів команди.

### Стандартні команди командного рядка

### Типи аргументів

BOOLEAN

- Цей тип використовується для команд, які вмикають або вимикаю певні налаштування. Можливими значеннями таких параметрів є `on`, `off`, `true`, `false`, `1` і `0`

INTEGER

- Ціле число

STRING

- Рядок

#### Команди базового керування редактором

    w

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

    wa

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

    q

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

    qa

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

    wq

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

    wqa

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

    x

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

    x

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

    bp

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

    bn

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

    new

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

    vnew

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

    e

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

    enew

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

    print

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

#### Команди налаштування редактора

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

    set-tab-widthINTEGER ширина

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

    set-indent-widthINTEGER ширина

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

    set-word-wrap-columnINTEGER довжина

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

    set-icon-borderBOOLEAN вмикання

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

    set-folding-markersBOOLEAN вмикання

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

    set-line-numbersBOOLEAN вмикання

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

    set-replace-tabsBOOLEAN вмикання

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

    set-remove-trailing-spaceBOOLEAN вмикання

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

    set-show-tabsBOOLEAN вмикання

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

    set-show-indentBOOLEAN вмикання

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

    set-indent-spacesBOOLEAN вмикання

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

    set-mixed-indentBOOLEAN вмикання

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

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

    set-word-wrapBOOLEAN вмикання

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

    set-replace-tabs-saveBOOLEAN вмикання

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

    set-remove-trailing-space-saveBOOLEAN вмикання

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

    set-indent-modeSTRING назва

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

    set-auto-identBOOLEAN назва

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

    set-highlightSTRING підсвічування

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

    reload-scripts

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

    set-wrap-cursorBOOLEAN вмикання

- Увімкнути або вимкнути перехід курсора.

    set-modeBOOLEAN вмикання

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

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

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

#### Команди редагування

Наступні команди змінюють вміст поточного документа.

    indent

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

    unindent

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

    cleanindent

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

    comment

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

    uncomment

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

    kill-line

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

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

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

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

  `b`

- Пошук назад.

`c`

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

`e`

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

`r`

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

`s`

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

`p`

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

`w`

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

    dateSTRING формат

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

  `d` | Номер дня без початкового нуля (1-31).
  `dd` | Номер дня з початковим нулем (01-31).
  `ddd` | Скорочена локалізована назва дня тижня (наприклад «пн» або «нд»).
  `dddd` | Довга локалізована назва дня (наприклад «понеділок» або «неділя»).
  `M` | Номер місяця без початкового нуля (1-12).
  `MM` | Номер місяця з початковим нулем (01-12).
  `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».

    charSTRING ідентифікатор

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

  ##### Приклади команди `char`

  Ввід: `char:234`

  Вивід: `ê`

  Ввід: `char:0x1234`

  Вивід: `ሴ`

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

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

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

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

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

  ##### Заміна тексту у поточному рядку

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

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

  ##### Заміна тексту у всьому файлі

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

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

  ##### Складніший приклад

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

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

      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

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

  ##### `sort` порівняно з `natsort`

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

  `natsort(a10, a1, a2)` виведе `a1, a2, a10`

    moveLinesDown

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

    moveLinesUp

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

    uniq

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

    rtrim

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

    ltrim

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

    joinSTRING роздільник

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

    rmblank

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

    unwrap

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

    eachSTRING скрипт

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

  ##### Об’єднати позначені рядки

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

  Або коротше:

  ``each` 'lines.join(", ")'`

    filterSTRING скрипт

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

  ##### Вилучити порожні рядки

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

  Або коротше:

  ``filter` 'line.length > 0'`

    mapSTRING скрипт

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

  ##### Вилучити порожні рядки

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

  Або коротше:

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

    duplicateLinesUp

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

    duplicateLinesDown

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

#### Команди навігації

    gotoINT рядок

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

    grep STRING шаблон

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

    findSTRING шаблон

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

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

  `b`

- Пошук назад.

`c`

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

`e`

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

`r`

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

`s`

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

`w`

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

    ifindSTRING шаблон

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

  `b`

- Пошук назад.

`r`

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

`s`

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

`c`

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

## Використання обгортки коду

За допомогою згортання коду ви можете приховувати частини документа у вікні редактора: так легше працювати з великими документами. У &kappname; діапазони рядків, придатні для згортання, визначаються правилами підсвічування синтаксису, тому згортання можливе не для всіх форматів файлів, — типово, згортання працює у коді програм, розмітки XML та подібних форматів. Під час редагування коду визначення підсвічування також можна вручну визначати діапазони згортання, зазвичай, такі діапазони визначаються за допомогою ключових слів `BEGIN` і `END`.

Щоб скористатися можливостями згортання, слід задіяти позначки згортання за допомогою пункту меню Перегляд Показувати маркери згортання, якщо цих позначок ще не показано у вікні редактора. На панелі позначок згортання з лівого боку екрана буде показано у графічному вигляді діапазони рядків, які можна згорнути. Символи-трикутники позначатимуть можливі дії з вказаним діапазоном: трикутник, вершина якого вказує вниз, означатиме розгорнутий діапазон рядків, — натискання позначки трикутника призведе до згортання діапазону, — тепер програма показуватиме трикутник з вершиною, спрямованою праворуч.

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

Програма запам’ятовує згортання після закриття файла. Коли ви наступного разу відкриєте файл для редагування, згорнуті вузли залишатимуться згорнутими. Це також стосується і дій з перезавантаження даних файлів.

Якщо ви не бажаєте користуватися можливістю згортання коду, ви можете зняти позначку з пункту Показувати маркери згортання (якщо наявні) на сторінці Вигляд налаштування редактора.

## Розширення можливостей &kappname; за допомогою скриптів

Починаючи з версії &kappname; 3.4 у KDE 4.4, можливості компонента редактора &kappname; можна дуже просто розширити за допомогою написання скриптів. Для написання скриптів слід використовувати мову ECMAScript (широко відому як JavaScript). У &kappname; передбачено підтримку двох типів скриптів: скрипти встановлення відступів та скрипти командного рядка.

### Скрипти додавання відступів

Скрипти встановлення відступів, які також будемо називати інструментами відступів, автоматично встановлюють відступи у тексті під час його введення. Наприклад, після натискання клавіші &Enter; програма зазвичай збільшує відступ у наступному рядку.

У наступних розділах наведено покрокові настанови щодо створення основи простого інструменту відступів. На першому кроці вам слід створити файл `*.js` з назвою, наприклад, `javascript.js` у локальній домашній теці `$KDEHOME/share/apps/katepart/script`.

#### Заголовок скрипту додавання відступів

Заголовок файла `javascript.js` подається у межах закоментованого блоку і має таку форму

    /* kate-script
     * name: JavaScript
     * author: Example Name <example.name@some.address.org>
     * license: BSD
     * revision: 1
     * kate-version: 3.4
     * type: indentation
     * required-syntax-style: javascript
     * indent-languages: javascript
     * priority: 0
     * i18n-catalog: mycatalog
     *
     * A line without colon ':' stops header parsing. That is, you can add optional
     * text here such as a detailed license.
     */

Нижче ми зупинимося докладніше на кожному з записів заголовка.

- `kate-script` [обов’язковий запис]: цей текст слід додавати у першому рядку файла `*.js`, інакше &kappname; просто відмовиться обробляти скрипт.

- `name` [обов’язковий запис]: це назва інструменту відступів, яку буде показано у меню Інструменти Відступ і діалогових вікнах налаштування.

- `author` [необов’язковий запис]: ім’я автора та дані щодо способу встановлення з ним зв’язку.

- `license` [необов’язковий запис]: скорочена форма умов ліцензування, зокрема BSD або LGPLv3.

- `revision` [обов’язковий запис]: версія скрипту. Внесення змін до коду скрипту має призводити до збільшення його версії.

- `kate-version` [обов’язковий запис]: мінімальне значення версії &kappname;, у якій працюватиме скрипт.

- `type` [обов’язковий запис]: тут слід вказати значення `indentation`, інакше &kappname; просто відмовиться обробляти цей скрипт.

- `required-syntax-style` [необов’язковий запис]: відокремлений комами список потрібних для роботи скрипту стилів підсвічування синтаксичних конструкцій. Цей запис є важливим для інструментів відступів, які працюють на основі певних даних щодо підсвічування у документі. Якщо буде вказано стиль синтаксичних конструкцій, інструментом відступів можна буде скористатися, лише якщо буде задіяно відповідний інструмент підсвічування тексту. Таким чином можна запобігти «невизначеній поведінці», спричиненій використанням інструменту відступів без потрібної для його роботи схеми підсвічування. Наприклад, у такий спосіб налаштовано інструмент відступів Ruby у файлах `ruby.js` і `ruby.xml`.

- `indent-languages` [необов’язковий запис]: відокремлений комами список стилів синтаксичних конструкцій, які може обробляти інструмент відступів, наприклад c++, java.

- `priority` [необов’язковий запис]: якщо якомусь файлу з визначеним підсвічуванням синтаксичних конструкцій відповідає декілька інструментів відступів, за допомогою цього запису буде встановлено пріоритет застосування інструменту відступів.

- `i18n-catalog` [необов’язковий]: додатковий каталог повідомлень (файл `po`), завантажений для перекладу сторонніх інструментів відступів.

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

#### Код інструменту відступів

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

    triggerCharacters = "{}/:;";
    function indent(line, indentWidth, ch)
    {
        //скрипт буде викликано під час обробки символу нового рядка (ch == '\n') і всіх символів, вказаних у
        // загальній змінній triggerCharacters. Під час використання пункту меню ІнструментиВирівняти
        // змінна ch матиме порожнє значення, тобто ch == ''.
        //
        // див. також розділ «Інтерфейс (API) роботи зі скриптами»
        return -2;
    }

У функції `indent()` передбачено три параметри:

- `line`: рядок, у якому слід встановити відступ

- `indentWidth`: ширина відступу у пробілах

- `ch`: символ нового рядка (`ch == '\n'`), символ перемикання, вказаний за допомогою `triggerCharacters` або порожній рядок, якщо користувачем було обрано пункт меню Інструменти Вирівняти.

Значення, повернуте функцією `indent()`, визначатиме спосіб встановлення відступу у рядку. Якщо буде повернуто ціле число, його обробку буде виконано за такими варіантами:

- повернуто значення `-2`: нічого не робити

- повернуто значення `-1`: зберегти відступ (його буде визначено на основі попереднього непорожнього рядка)

- повернуто значення `0`: числа >= 0 визначають глибину відступу у пробілах

Крім того, може бути повернуто масив з двох елементів:

- `повернуто [ відступ, вирівнювання ];`

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

Розглянемо такий приклад: для встановлення відступів використовується символ табуляції, а ширину відступу визначено як 4 пробіли. У нашому прикладі, <таб> — це символ табуляції, а «.» — пробіл:

    1: <таб><таб>foobar("привіт",
    2: <таб><таб>......."світе");

Під час встановлення відступу для рядка 2 функція `indent()` повертає значення [8, 15]. У результаті буде додано два символи табуляції для встановлення відступу до стовпчика 8, а потім буде додано 7 пробілів для вирівнювання за другим параметром, більшим за перший, отже рядок залишатиметься вирівняним під час перегляду файла за будь-якої встановленої ширити відступу табуляції.

У типовому пакунку KDE для &kappname; передбачено декілька інструментів відступів. Код цих інструментів мовою JavaScript зберігається у каталозі `$KDEDIR/share/apps/katepart/script`.

Під час розробки скрипту встановлення відступів корисним буває перезавантаження скриптів для перевірки коректності поведінки під час встановлення відступів. Замість перезапуску програми достатньо просто перейти до командного рядка і виконати команду `reload-scripts`.

Якщо вами було створено якийсь корисний скрипт, ви зробити його вашим власним внеском до проекту розробки &kappname;. Будь ласка, повідомте про вашу розробку у списку листування програми.

### Скрипти командного рядка

Оскільки всі користувачі мають різні потреби, у &kappname; передбачено підтримку невеличких допоміжних інструментів для пришвидшення роботи з фрагментами тексту за допомогою вбудованого командного рядка. Наприклад, команду `sort` (впорядкувати) реалізовано саме за допомогою такого інструменту або скрипту. У цьому розділі ви знайдете пояснення щодо способу створення файлів `*.js`, які допоможуть вам розширити можливості &kappname; додаванням допоміжних скриптів.

Скрипти командного рядка зберігаються у одній теці зі скриптами встановлення відступів. Отже на першому кроці вам слід створити файл `*.js` з назвою `myutils.js` у локальній домашній теці `$KDEHOME/share/apps/katepart/script`.

#### Заголовок скрипту командного рядка

Заголовок файла `javascript.js` подається у межах закоментованого блоку і має таку форму

    /* kate-script
     * author: Example Name <example.name@some.address.org>
     * license: BSD
     * revision: 1
     * kate-version: 3.4
     * type: commands
     * functions: sort, format-paragraph
     * i18n-catalog: mycatalog
     *
     * A line without colon ':' stops header parsing. That is, you can add optional
     * text here such as a detailed license.
     */

Нижче наведено докладніший опис кожного з записів заголовка.

- `kate-script` [обов’язковий запис]: цей текст слід додавати у першому рядку файла `*.js`, інакше &kappname; просто відмовиться обробляти скрипт.

- `author` [необов’язковий запис]: ім’я автора та дані щодо способу встановлення з ним зв’язку.

- `license` [необов’язковий запис]: скорочена форма умов ліцензування, зокрема BSD або LGPLv3.

- `revision` [обов’язковий запис]: версія скрипту. Внесення змін до коду скрипту має призводити до збільшення його версії.

- `kate-version` [обов’язковий запис]: мінімальне значення версії &kappname;, у якій працюватиме скрипт.

- `type` [обов’язковий запис]: тут слід вказати значення `indentation`, інакше &kappname; просто відмовиться обробляти цей скрипт.

- `functions` [обов’язковий запис]: відокремлений комами список команд скрипту.

- `i18n-catalog` [необов’язковий]: додатковий каталог повідомлень (файл `po`), завантажений для перекладу сторонніх скриптів.

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

#### Код скрипту командного рядка

Всі оголошені у заголовку функції має бути реалізовано у тілі скрипту. Наприклад, у файлі скрипту з наведеного вище прикладу слід реалізувати дві функції, `sort` і `format-paragraph`. Всі функції має бути записано відповідно до таких синтаксичних правил:

    function <назва>(параметр1, параметр2, ...)
    {
        // ...реалізація, див. також: Інтерфейс (API) роботи зі скриптами
    }

Параметри у командному рядку передаються функції як `параметр1`, `параметр2` тощо. Щоб надати користувачам можливість ознайомлюватися з документацією щодо команди, просто реалізуйте функцію '`help`' у такий спосіб:

    function help(cmd)
    {
        if (cmd == "sort") {
            return i18n("Sort the selected text.");
        } else if (cmd == "...") {
            // ...
        }
    }

Після цього виконання команди `help sort` у командному рядку призведе до виклику відповідної функції довідки (help) з параметром `cmd` встановленим у назву вказаної команди, тобто, у нашому прикладі, `cmd == "sort"`. У відповідь на команду &kappname; покаже користувачеві визначений вами текст довідки.

##### Призначення клавіатурних скорочень

Призначення клавіатурних скорочень стане можливим, лише якщо у вашому скрипті є функція з назвою `action` у такому форматі:

    function action(cmd)
    {
        var a = new Object();
        if (cmd == "sort") {
            a.text = i18n("Sort Selected Text");
            a.icon = "";
            a.category = "";
            a.interactive = false;
            a.shortcut = "";
        } else if (cmd == "moveLinesDown") {
            // same for next action
        }
        return a;
    }

Параметр `cmd` цієї функції визначає команду, виконання якої буде пов’язано з клавіатурним скороченням. Для повернутого об’єкта javascript має бути визначено декілька значень полів:

- `a.text` [обов’язковий запис]: це текст пункту, який буде показано у меню Інструменти Скрипти. Не забудьте вказати `i18n` для перекладу.

- `a.icon` [необов’язковий запис]: піктограма, яку буде показано поряд з текстом пункту меню. Можна використовувати назву будь-якої з піктограм KDE.

- `a.category` [необов’язковий запис]: якщо буде вказано категорію, пункт скрипту буде додано у підменю. Не забудьте використати `i18n`, щоб уможливити переклад.

- `a.interactive` [необов’язковий]: якщо для роботи скрипту потрібні дані, введені користувачем, встановіть значення `true`.

- `a.shortcut` [необов’язковий запис]: клавіатурне скорочення, вказане за допомогою цього значення буде типовим. Приклад: Ctrl+Alt+t. Докладніше про можливі скорочення можна дізнатися з документації до Qt.

Під час розробки скрипту командного рядка корисним буває перезавантаження скриптів для перевірки коректності поведінки під час встановлення відступів. Замість перезапуску програми достатньо просто перейти до командного рядка і виконати команду `reload-scripts`.

Якщо вами було створено якийсь корисний скрипт, ви зробити його вашим власним внеском до проекту розробки &kappname;. Будь ласка, повідомте про вашу розробку у списку листування програми.

### Інтерфейс (API) роботи зі скриптами

Програмний інтерфейс роботи зі скриптами, про який ми тут говоритимемо, доступний у всіх скриптах, тобто у скриптах встановлення відступів та у скриптах командного рядка. Перед завантаженням вмісту скрипту &kappname; додає декілька прототипів і функцій до контексту роботи зі скриптами. У цьому програмному інтерфейсі, доданому для зручності, містяться прототипи, зокрема текстові курсори та описи діапазонів тексту. Файли цього інтерфейсу зберігаються у теці `$KDEDIR/share/apps/katepart/api`. Для файлів у цій теці встановлено таку схему іменування:

    <номер>_<назва>.js

Номер має складатися з двох цифр, а назва може бути довільною, наприклад `myutils`. За допомогою номера &kappname; встановлює послідовність виконання скриптів інтерфейсів. Таким чином, файл з назвою `05_cursor.js` буде виконано до файла з назвою `10_range.js`. (Ця схема подібна до порядку запуску або ініціалізації скриптів під час запуску Linux).

Щоб розширити стандартний програмний інтерфейс (API) для роботи зі скриптами власними функціями і прототипами просто створіть файл у локальній теці файлів налаштування KDE, `$KDEHOME/share/apps/katepart/api`, і переконайтеся, що у назві файла вказано порядковий номер виконання, більший за будь-який інший номер файлів `*.js` у загальній теці `$KDEDIR/share/apps/katepart/api`. &kappname; автоматично виконає пошук файлів `*.js` у обох теках і виконає їх у вказаному порядку.

Рекомендованим способом розширення можливостей прототипів, зокрема `Cursor` або `Range`, не є внесення змін до загальних файлів `*.js`. Для цього вам краще створити файл `*.js` у локальній теці, файли з якої виконуватимуться після `05_cursor.js`, а потім внести зміни до прототипу `Cursor` у JavaScript.

#### Курсори і діапазони

Оскільки &kappname; є текстовим редактором, весь програмний інтерфейс (API) за можливості засновано на курсорах та діапазонах тексту. Об’єкт Cursor (курсор) є простим кортежем `(line, column)` (рядок, стовпчик), що визначає позицію у тексті документа. Об’єкт Range (діапазон) це фрагмент тексту від початкової позиції курсора до кінцевої позиції курсора. Докладніше про програмний інтерфейс (API) ми поговоримо у наступних розділах.

##### Прототип Cursor (курсор)

    Cursor();

- Конструктор. Повертає об’єкт Cursor (курсор) у позиції `(0, 0)`.

  Приклад: `var cursor = new Cursor();`

    Cursor(int рядок, int стовпчик);

- Конструктор. Повертає об’єкт Cursor (курсор) у позиції (рядок, стовпчик).

  Приклад: `var cursor = new Cursor(3, 42);`

    Cursor(Cursor інший);

- Конструктор копіювання. Повертає копію курсора `інший`.

  Приклад: `var copy = new Cursor(other);`

    Cursor Cursor.clone();

- Повертає клон курсора.

  Приклад: `var clone = cursor.clone();`

    bool Cursor.isValid();

- Перевіряє, чи є курсор коректним. Курсор вважається некоректним, якщо значення його позицій у рядку і/або стовпчику дорівнюють `-1`.

  Приклад: `var valid = cursor.isValid();`

    Cursor Cursor.invalid();

- Повертає новий некоректний курсор, розташований у позиції `(-1, -1)`.

  Приклад: `var invalidCursor = cursor.invalid();`

    int Cursor.compareTo(Cursor інший);

- Порівнює поточний курсор з курсором `інший`. Повертає

  - `-1`, якщо поточний курсор розташовано перед курсором `інший`,

  - `0`, якщо курсори у однакових позиціях і

  - `+1`, якщо поточний курсор розташовано після курсора `інший`.

    bool Cursor.equals(Cursor інший);

- Повертає `true`, якщо цей курсор і курсор `інший` є однаковими. Якщо це не так, повертає `false`.

    String Cursor.toString();

- Повертає об’єкт курсора як рядок у формі `Cursor(line, column)`.

##### Прототип Range (діапазон)

    Range();

- Конструктор. Виклик `new Range()` повертає Range (діапазон) у (0, 0) - (0, 0).

    Range(Cursor початок, Cursor кінець);

- Конструктор. Виклик функції `new Range(`початок`, `кінець`)` повертає Range (діапазон)(`початок`, `кінець`).

    Range(int початковийРядок, int початковийСтовпчик, int кінцевийРядок, int кінцевийСтовпчик);

- Конструктор. Виклик функції `new Range(`початковийРядок`, `початковийСтовпчик`, `кінцевийРядок`, `кінцевийСтовпчик`)` повертає Range (діапазон) від позиції (`початковийРядок`, `початковийСтовпчик`) до позиції (`кінцевийРядок`, `кінцевийСтовпчик`).

    Range(Range інший);

- Конструктор копіювання. Повертає копію Range `інший`.

    Range Range.clone();

- Повертає клон діапазону.

  Приклад: `var clone = range.clone();`

    bool Range.isValid();

- Повертає `true`, якщо початкова і кінцева позиції курсора є коректними. Якщо це не так, повертає `false`.

  Приклад: `var valid = range.isValid();`

    bool Range.invalid();

- Повертає Range (діапазон) від (-1, -1) до (-1, -1).

    bool Range.contains(Cursor курсор);

- Повертає `true`, якщо позиція курсора міститься у діапазоні, у іншому випадку повертає `false`.

    bool Range.contains(Range інший);

- Повертає `true`, якщо поточний діапазон містить діапазон `інший`. Якщо це не так, повертає `false`.

    bool Range.containsColumn(int стовпчик);

- Повертає `true`, якщо `стовпчик` належить напіввідкритому інтервалу `[start.column, end.column)`. Якщо це не так, повертає `false`.

    bool Range.containsLine(int рядок);

- Повертає `true`, якщо `рядок` належить до напіввідкритого інтервалу `[start.line, end.line)`. Якщо це не так, повертає `false`.

    bool Range.overlaps(Range інший);

- Повертає `true`, якщо поточний діапазон і діапазон `інший` мають ненульовий перетин. Якщо це не так, повертає `false`.

    bool Range.overlapsLine(int рядок);

- Повертає `true`, якщо `рядок` належить до інтервалу `[start.line, end.line]`. Якщо це не так, повертає `false`.

    bool Range.overlapsColumn(int стовпчик);

- Повертає `true`, якщо `стовпчик` належить інтервалу `[start.column, end.column]`. Якщо це не так, повертає `false`.

    bool Range.equals(Range інший);

- Повертає `true`, якщо поточний діапазон і діапазон діапазон `інший` тотожні. Якщо це не так, повертає `false`.

    String Range.toString();

- Повертає діапазон у форматі `Range(Cursor(line, column), Cursor(line, column))`.

#### Загальні функції (Global Functions)

У цьому розділі наведено всі загальні функції.

##### Зневаджування (Debugging)

    void debug(String текст);

- Виводить `текст` до `stdout` у консоль, з якої запущено програму.

##### Переклад (Translation)

Повноцінна локалізація стане можливою лише за використання декількох функцій, призначених для перекладу рядків у скриптах, а саме `i18n`, `i18nc`, `i18np` і `i18ncp`. Робота цих функцій подібна до роботи функцій перекладу рядків у KDE.

За допомогою функцій перекладу і системи перекладу KDE вбудовані у скрипт рядки повідомлень може бути перекладено мовою інтерфейсу програми. Рядки у скриптах, які є частиною офіційної збірки &kappname; буде автоматично видобуто і подано для перекладу командами перекладачів KDE. Іншими словами, якщо ви є розробником основної гілки &kappname;, ви не маєте перейматися видобуванням повідомлень і їхнім перекладом. Якщо ж скрипт є стороннім, його розробка виконується поза межами KDE, вам слід подбати про видобування і переклад повідомлень власноруч. Разом зі скриптами вам слід поширювати і файли перекладів, які міститимуть всі придатні для перекладу рядки. Крім того, у заголовку вашого скрипту має бути явним чином вказано каталог перекладів, який слід завантажити. Зробити це можна за допомогою параметра `i18n-catalog`.

    void i18n(String текст, параметр1, ...);

- Перекладає `текст` мовою, використаною у інтерфейсі програми. Параметри `параметр1`, ... є необов’язковими. Вони є замінниками рядків `%1`, `%2` тощо.

    void i18nc(String контекст, String текст, параметр1, ...);

- Перекладає `текст` мовою, використаною у інтерфейсі програми. Крім того, перекладачі зможуть побачити рядок `контекст`. За допомогою контексту перекладачам буде простіше правильно перекласти рядок. Параметри `параметр1`, ... є необов’язковими. Вони є замінниками рядків `%1`, `%2` тощо.

    void i18np(String однина, String множина, int кількість, параметр1, ...);

- Перекладає `однину` або `множину` повідомлення мовою, використаною у інтерфейсі програми залежно від вказаного значення `кількість`. Параметри `параметр1`, ... є необов’язковими. Вони є замінниками рядків `%1`, `%2` тощо.

    void i18ncp(String контекст, String однина, String множина, int кількість, параметр1, ...);

- Перекладає `однину` або `множину` повідомлення мовою, використаною у інтерфейсі програми залежно від вказаного значення `кількість`. Крім того, перекладачі зможуть побачити рядок `контекст`. За допомогою контексту перекладачам буде простіше правильно перекласти рядок. Параметри `параметр1`, ... є необов’язковими. Вони є замінниками рядків `%1`, `%2` тощо.

#### Програмний інтерфейс `View`

Яким би чином не було запущено скрипт, він завжди користуватиметься загальною змінною `view`, що відповідає поточній активній панелі перегляду. Нижче наведено список всіх типових функцій об’єкта View.

    Cursor view.cursorPosition()

- Повертає поточну позицію курсора у області перегляду.

    void view.setCursorPosition(int рядок, int стовпчик)
    void view.setCursorPosition(Cursor курсор)

- Повертає поточну позицію курсора у області перегляду.

    void view.setCursorPosition(int рядок, int стовпчик);
    void view.setCursorPosition(Cursor курсор);

- Встановлює для поточного курсора позицію, вказану напряму (рядок, стовпчик), або позицію вказаного курсора.

    Cursor view.virtualCursorPosition();

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

    void view.setVirtualCursorPosition(int рядок, int стовпчик);
    void view.setVirtualCursorPosition(Cursor курсор);

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

    String view.selectedText();

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

    bool view.hasSelection();

- Повертає `true`, якщо у області перегляду позначено фрагмент тексту, інакше повертає `false`.

    Range view.selection();

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

    void view.setSelection(Range діапазон);

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

    void view.removeSelectedText();

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

    void view.selectAll();

- Позначає весь текст у документі.

    void view.clearSelection();

- Знімає позначення фрагменту тексту, не вилучаючи сам текст.

#### Програмний інтерфейс (API) `Document`

Яким би чином не було запущено скрипт, він завжди користуватиметься загальною змінною `document`, що відповідає поточній активній панелі перегляду. Нижче наведено список всіх типових функцій об’єкта Document.

    String document.fileName();

- Повертає назву файла документа або порожній рядок для незбережених буферів з текстом.

    String document.url();

- Повертає адресу URL документа повністю або порожній рядок для незбережених буферів з текстом.

    String document.mimeType();

- Повертає тип MIME документа або тип MIME `application/octet-stream`, якщо відповідного типу MIME встановити не вдасться.

    String document.encoding();

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

    String document.highlightingMode();

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

    String document.highlightingModeAt(Cursor позиція);

- Повертає режим підсвічування, використаний за вказаною позицією у тексті.

    Array document.embeddedHighlightingModes();

- Повертає масив режимів підсвічування, вбудованих до поточного документа.

    bool document.isModified();

- Повертає `true`, якщо у документі є незбережені зміни, інакше повертає `false`.

    String document.text();

- Повертає увесь вміст документа у формі єдиного рядка тексту. Розриви рядків буде позначено символом розриву рядка `\n`.

    String document.text(int зРядка, int зіСтовпчика, int доРядка, int доСтовпчика);
    String document.text(Cursor з, Cursor до);
    String document.text(Range діапазон);

- Повертає фрагмент тексту у вказаному діапазоні. Для того, щоб код було легше читати, ми рекомендуємо вам використовувати засновану на об’єктах Cursor і Range версію функції.

    String document.line(int рядок);

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

    String document.wordAt(int рядок, int стовпчик);
    String document.wordAt(Cursor курсор);

- Повертає слово за вказаною позицією курсора.

    String document.charAt(int рядок, int стовпчик);
    String document.charAt(Cursor курсор);

- Повертає символ за вказаною позицією курсора.

    String document.firstChar(int рядок);

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

    String document.lastChar(int рядок);

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

    bool document.isSpace(int рядок, int стовпчик);
    bool document.isSpace(Cursor курсор);

- Повертає `true`, якщо символ у вказаній позиції курсора є пробілом. Якщо це не так, повертає `false`.

    bool document.matchesAt(int рядок, int стовпчик, int рядок, String текст);
    bool document.matchesAt(Cursor курсор, String текст);

- Повертає `true`, якщо вказаний `текст` розташовано за відповідною позицією курсора. Якщо це не так, повертає `false`.

    bool document.startsWith(int рядок, String текст, bool пропускатиПробіли);

- Повертає `true`, якщо рядок з вказаним номером починається з фрагмента тексту `текст`. Якщо це не так, повертає `false`. За допомогою параметра `пропускатиПробіли` можна вказати програмі, чи слід ігнорувати пробіли.

    bool document.endsWith(int рядок, String текст, bool пропускатиПробіли);

- Повертає `true`, якщо рядок з вказаним номером завершується фрагментом тексту `текст`. Якщо це не так, повертає `false`. За допомогою параметра `пропускатиПробіли` можна вказати програмі, чи слід ігнорувати пробіли.

    bool document.setText(String текст);

- Замінює весь вміст документа на `текст`.

    bool document.clear();

- Вилучає з документа весь текст.

    bool document.truncate(int рядок, int стовпчик);
    bool document.truncate(Cursor курсор);

- Обрізає рядок з вказаним номером на вказаному стовпчику або позиції курсора. Повертає `true` у разі успіху або `false`, якщо рядка з вказаним номером у документі немає.

    bool document.insertText(int рядок, int стовпчик, int рядок, String текст);
    bool document.insertText(Cursor курсор, String текст);

- Вставляє фрагмент тексту `текст` у вказану позицію курсора. Повертає `true` у разі успіху або `false`, якщо документ відкрито у режимі лише для читання.

    bool document.removeText(int зРядка, int зіСтовпчика, int доРядка, int доСтовпчика);
    bool document.removeText(Cursor з, Cursor до);
    bool document.removeText(Range діапазон);

- Вилучає текст у вказаному діапазоні. Повертає `true` у разі успіху або `false`, якщо документ відкрито у режимі лише для читання.

    bool document.insertLine(int рядок, String текст);

- Вставляє вказаний фрагмент тексту до рядка з вказаним номером. Повертає `true` у разі успіху або `false`, якщо документ відкрито у режимі лише для читання або рядка з вказаним номером у документі немає.

    bool document.removeLine(int рядок);

- Вилучає рядок з вказаним номером. Повертає `true` у разі успіху або `false`, якщо документ відкрито у режимі лише для читання або рядка з вказаним номером у документі немає.

    void document.joinLines(int початковийРядок, int кінцевийРядок);

- Об’єднує рядки у діапазоні від`початковийРядок` до `кінцевийРядок`. Послідовні рядки тексту завжди відокремлюються одинарним пробілом.

    int document.lines();

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

    int document.length();

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

    int document.lineLength(int рядок);

- Повертає довжину рядка з номером `рядок`.

    void document.editBegin();

- Започатковує групу редагування для впорядкування операцій зі скасування або повторення дій. Не забувайте, що викликати `editEnd()` слід саме стільки разів, скільки разів було викликано `editBegin()`. Виклики `editBegin()` використовують вбудований лічильник, отже їх може бути вкладено один у оден.

    void document.editEnd();

- Завершує групу редагування. Останній виклик `editEnd()` (тобто відповідник першого виклику `editBegin()`) завершує крок з редагування.

    int document.firstColumn(int рядок);

- Повертає перший відмінний від пробілу стовпчик у вказаному за допомогою параметра номера, `рядок`, рядку. Якщо у рядку будуть лише пробіли, функція поверне значення `-1`.

    int document.lastColumn(int рядок);

- Повертає останній відмінний від пробілу стовпчик у вказаному за допомогою параметра номера, `рядок`, рядку. Якщо у рядку будуть лише пробіли, функція поверне значення `-1`.

    int document.prevNonSpaceColumn(int рядок, int стовпчик);
    int document.prevNonSpaceColumn(Cursor курсор);

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

    int document.nextNonSpaceColumn(int рядок, int стовпчик);
    int document.nextNonSpaceColumn(Cursor курсор);

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

    int document.prevNonEmptyLine(int рядок);

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

    int document.nextNonEmptyLine(int рядок);

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

    bool document.isInWord(String символ, int атрибут);

- Повертає `true`, якщо вказаний `символ` з вказаним параметром `атрибут` може бути частиною слова. Якщо це не так, повертає `false`.

    bool document.canBreakAt(String символ, int атрибут);

- Повертає `true`, якщо вказаний `символ` з вказаним параметром `атрибут` може бути використано для розбиття рядка. Якщо це не так, повертає `false`.

    bool document.canComment(int атрибутПочатку, int атрибутКінця);

- Повертає `true`, якщо діапазон тексту, початок і кінець якого визначаються на основі вказаних атрибутів, можна закоментувати. Якщо це не так, повертає `false`.

    String document.commentMarker(int атрибут);

- Повертає позначку коментаря для окремого рядка коментарів з вказаним параметром `атрибут`.

    String document.commentStart(int атрибут);

- Повертає позначку, якою має розпочинатися багаторядковий коментар для вказаного значення параметра `атрибут`.

    String document.commentEnd(int атрибут);

- Повертає позначку, якою має розпочинатися багаторядковий коментар для вказаного значення параметра `атрибут`.

    int document.attribute(int рядок, int стовпчик);
    int document.attribute(Cursor курсор);

- Повертає атрибут за вказаною позицією курсора.

    bool document.isAttribute(int рядок, int стовпчик, int атрибут);
    bool document.isAttribute(Cursor курсор, int атрибут);

- Повертає `true`, якщо атрибут за вказаною позицією курсора дорівнює значенню параметра `атрибут`. Якщо це не так, повертає `false`.

    String document.attributeName(int рядок, int стовпчик);
    String document.attributeName(Cursor курсор);

- Повертає назву атрибута придатну до читання. Ця назва відповідає назві `itemData` у файлах підсвічування синтаксичних конструкцій.

    bool document.isAttributeName(int рядок, int стовпчик, String назва);
    bool document.isAttributeName(Cursor курсор, String назва);

- Повертає `true`, якщо назва атрибута у певній позиції курсора відповідає вказаному значенню параметра `назва`. Якщо це не так, повертає `false`.

    String document.variable(String ключ);

- Повертає значення вказаної змінної документа `ключ`. Якщо змінної з вказаною назвою у документі не існує, повертає порожній рядок.

    String document.setVariable(String ключ, String значення);

- Встановлює значення відповідної змінної документа `ключ`. Повертає встановлене значення змінної.

  Див. також змінні документа Kate

  Актуальна версія: KDE 4.8

    int document.firstVirtualColumn(int рядок);

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

    int document.lastVirtualColumn(int рядок);

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

    int document.toVirtualColumn(int рядок, int стовпчик);
    int document.toVirtualColumn(Cursor курсор);
    Cursor document.toVirtualCursor(Cursor курсор);

- Перетворює вказану «реальну» позицію курсора на віртуальну позицію курсора, повертає або ціле значення (int), або об’єкт Cursor.

    int document.fromVirtualColumn(int line, int virtualColumn);
    int document.fromVirtualColumn(Cursor virtualCursor);
    Cursor document.fromVirtualCursor(Cursor віртуальнийКурсор);

- Перетворює вказану віртуальну позицію курсора на «реальну» позицію курсора, повертає або ціле значення (int), або об’єкт Cursor.

    Cursor document.anchor(int рядок, int стовпчик, Char символ);
    Cursor document.anchor(Cursor курсор, Char символ);

- Виконує пошук у напрямку початку документа, починаючи від вказаної позиції курсора, вказаного символу. Наприклад, якщо функції буде передано символ «(», функція поверне позицію початкової дужки «(». Відповідність дужок не враховуватиметься, тобто інші «(...)» буде проігноровано.

    Cursor document.rfind(int рядок, int стовпчик, String текст, int атрибут = -1);
    Cursor document.rfind(Cursor курсор, String текст, int атрибут = -1);

- Виконує пошук у напрямку початку документа вказаного фрагмента тексту з відповідним значенням параметра `атрибут`. Параметр `атрибут` буде проігноровано, якщо він матиме значення `-1`. Функція поверне значення некоректного курсора, якщо фрагмент тексту знайти не вдасться.

    int document.defStyleNum(int рядок, int стовпчик);
    int document.defStyleNum(Cursor курсор);

- Повертає типовий стиль курсора, використаний за вказаною позицією у тексті.

    bool document.isCode(int рядок, int стовпчик);
    bool document.isCode(Cursor курсор);

- Повертає `true`, якщо атрибут за вказаною позицією курсора не дорівнює жодному зі значень стилів: `dsComment`, `dsString`, `dsRegionMarker`, `dsChar`, `dsOthers`.

    bool document.isComment(int рядок, int стовпчик);
    bool document.isComment(Cursor курсор);

- Повертає `true`, якщо значенням атрибута символу у позиції курсора є `dsComment`. Якщо це не так, повертає `false`.

    bool document.isString(int рядок, int стовпчик);
    bool document.isString(Cursor курсор);

- Повертає `true`, якщо значенням атрибута символу у позиції курсора є `dsString`. Якщо це не так, повертає `false`.

    bool document.isRegionMarker(int рядок, int стовпчик);
    bool document.isRegionMarker(Cursor курсор);

- Повертає `true`, якщо значенням атрибута символу у позиції курсора є `dsRegionMarker`. Якщо це не так, повертає `false`.

    bool document.isChar(int рядок, int стовпчик);
    bool document.isChar(Cursor курсор);

- Повертає `true`, якщо значенням атрибута символу у позиції курсора є `dsChar`. Якщо це не так, повертає `false`.

    bool document.isOthers(int рядок, int стовпчик);
    bool document.isOthers(Cursor курсор);

- Повертає `true`, якщо значенням атрибута символу у позиції курсора є `dsOthers`. Якщо це не так, повертає `false`.