# Zaawansowane narzędzia edycyjne

## Komentarz/Odkomentuj

Polecenia Komentarz i Odkomentuj dostępne z menu Narzędzia pozwalają na dodanie znaczników komentarza do zaznaczonego fragmentu tekstu (lub do bieżącego wiersza, gdy brak zaznaczenia). Bieżący format dokumentu musi obsługiwać możliwość komentowania tekstu.

Sposób komentowania jest określony w definicji reguł podświetlania składni. Jeżeli podświetlanie składni jest wyłączone, to polecenia Komentarz i Odkomentuj są nieaktywne.

Dla pewnych formatów dokumentów zdefiniowane są znaczniki komentowania wiersza, inne zaś zawierają znaczniki komentarzy jedno- i wielowierszowych. Jeżeli znaczniki komentarza wielowierszowego są niedostępne, to nie będzie się dało skomentować zaznaczenia nie zawierającego w sobie całości ostatniego wiersza.

Gdy dostępny jest znacznik komentarza dla całego wiersza kodu, to jego użycie jest preferowane, gdyż pozwala na uniknięcie problemów w przypadku zagnieżdżonych komentarzy.

Podczas usuwania znaczników komentarza nie należy zaznaczać tekstu nie będącego komentarzem. Jeżeli usuwany jest komentarz wielowierszowy z zaznaczenia, to wszystkie spacje znajdujące się poza znacznikami komentarza są ignorowane.

Aby skomentować fragment tekstu należy użyć menu Narzędzia Komentarz, lub skrótu klawiszowego &Ctrl;D.

Aby usunąć znaczniki komentarza z wybranego fragmentu tekstu, należy użyć menu Narzędzia Odkomentuj, lub skrótu klawiszowego &Ctrl; &Shift;D.

## Linia poleceń edytora

Komponent edytora w &kate; zawiera wbudowaną linię poleceń, pozwalającą na sterowanie pracą bez pośrednictwa graficznego interfejsu użytkownika. Linia poleceń znajduje sią w dolnej części okna edytora, aby ją włączyć należy wybrać z menu: Widok Przełącz do linii poleceń lub skorzystać ze skrótu klawiszowego (domyślnie jest to F7). Zestaw poleceń dostępnych w linii poleceń edytora opisany został poniżej. Może on ulec rozszerzeniu przez zastosowanie wtyczek.

Naciśnięcie klawisza ENTER uruchamia wprowadzone polecenie. Komunikat wyświetlony w linii poleceń pokaże informacje o wynikach polecenia lub ewentualnym błędzie. Jeżeli linia poleceń została wyświetlona za pomocą klawisza F7, to schowa się ona automatycznie po kilku sekundach. Ponowne naciśnięcie klawisza F7 usuwa komunikat i pozwala na wprowadzenie następnego polecenia.

Linia poleceń zawiera wbudowany system pomocy uruchamiany poleceniem `help`. Aby wyświetlić listę wszystkich dostępnych poleceń należy wpisać `help list`. Pomoc dotycząca wybranego polecenia dostępna jest po wpisaniu: `help `polecenie``.

Linia poleceń przechowuje historię poleceń pozwalając na ponowne użycie poleceń wcześniej już wpisanych. Dostęp i nawigacja w historii linii poleceń odbywa się za pomocą klawiszy strzałek w górę oraz w dół. Argumenty wywołanych z historii poleceń będą zaznaczone, pozwalając na łatwą ich zmianę.

### Polecenia standardowe

#### Polecenia konfiguracyjne edytora

Polecenia opisane poniżej dotyczą wbudowanego edytora i pozwalają na konfigurację bieżącego widoku i dokumentu. Może to być przydatne, gdy użytkownik chce wykorzystać ustawienia inne niż domyślne, np. dla automatycznych wcięć.

#### Typy argumentów

BOOLEAN

- Stosowane dla poleceń, które włączają lub wyłączają jakąś funkcję. Dopuszczalne wartości takiego argumentu to:`on`, `off`, `true`, `false`, `1` lub `0`

INTEGER

- Liczba całkowita

STRING

- Napis

    set-tab-widthINTEGER szerokość

- Ustawia szerokość tabulacji (w znakach) na wartość określoną przez argument `szerokość`.

    set-indent-widthINTEGER szerokość

- Ustawia szerokość wcięcia na wartość określoną przez argument `szerokość`. Polecenie odnosi się do trybu wcięć dokonywanych za pomocą znaku spacji.

    set-word-wrap-columnINTEGER szerokość

- Ustawia liczbę znaków w wierszu dla funkcji statycznego zawijania wyrazów na wartość określoną przez argument `szerokość`. Działa jedynie w przypadku włączonego automatycznego zawijania wyrazów.

    set-icon-borderBOOLEAN włącz

- Włącza lub wyłącza wyświetlanie paska ikon.

    set-folding-markersBOOLEAN włącz

- Włącza lub wyłącza wyświetlanie paska znaczników zwijania kodu.

    set-line-numbersBOOLEAN włącz

- Włącza lub wyłącza wyświetlanie paska z numerami wierszy.

    set-replace-tabsBOOLEAN włącz

- Włącza lub wyłącza zastępowanie znaków tabulacji znakami spacji w trakcie pisania.

    set-remove-trailing-spaceBOOLEAN włącz

- Włącza lub wyłącza usuwanie spacji końcowych po przejściu kursorem do innego wiersza.

    set-show-tabsBOOLEAN włącz

- Włącza lub wyłącza wyświetlanie małej kropki w miejscu znaków tabulacji oraz spacji kończących wiersz.

    set-indent-spacesBOOLEAN włącz

- Włącza lub wyłącza generowanie wcięć za pomocą zdefiniowanej przez parametr `indent-width` liczby spacji, dla każdego poziomu wcięcia. Wyłączenie opcji przywraca stosowanie znaku tabulacji do generowania wcięć.

    set-mixed-indentBOOLEAN włącz

- Włączenie tej opcji pozwala na jednoczesne użycie znaków tabulacji i spacji do generowania wcięć przez &kate;. Poziomy wcięć będą określane zgodnie z ustawieniami opcji `indent-width`, zaś wcięcia wielopoziomowe będą generowane za pomocą największej możliwej liczby znaków tabulacji.

  Po wykonaniu tego polecenia, dodatkowo włączona zostanie funkcja wcięć za pomocą spacji, a jeżeli szerokość wcięcia jest nieokreślona, to zostanie ustawiona na połowę wartości parametru `tab-width` określonego dla bieżącego dokumentu.

    set-word-wrapBOOLEAN włącz

- Włącza lub wyłącza funkcję dynamicznego zawijania wyrazów

    set-replace-tabs-saveBOOLEAN włącz

- Włącza lub wyłącza zamienianie znaków tabulacji na spacje przed zapisaniem dokumentu.

    set-remove-trailing-space-saveBOOLEAN włącz

- Włącza lub wyłącza usuwanie spacji kończących wiersze przed jego zapisaniem.

    set-indent-modenazwa

- Określa tryb automatycznych wcięć, możliwe `nazwy` trybów to: 'cstyle', 'csands', 'xml', 'python', 'varindent' oraz 'none'. Jeżeli wprowadzona nazwa jest nieznana to przyjęta zostanie wartość 'none'.

    set-highlightnazwa

- Wybiera zestaw reguł podświetlania składni dla dokumentu. Argument musi określać nazwę istniejącej reguły podświetlania. Dostępne nazwy widoczne są w menu: Narzędzia Podświetlenie. W trakcie wprowadzania polecenia, pojawi się pomocnicza lista automatycznego dopełniania nazwy.

#### Polecenia edycyjne

Ich wykonanie modyfikuje bieżący dokument.

    indent

- Generuje wcięcie w wybranych wierszach lub w bieżącym wierszu.

    unindent

- Usuwa wcięcie z zaznaczonego fragmentu lub bieżącego wiersza.

    cleanindent

- Wyrównuje wcięcia dla zaznaczonego fragmentu tekstu lub dla bieżącego wiersza, zgodnie z ustawionymi dla dokumentu regułami wcięć.

    comment

- Wprowadza znaczniki komentarza dla zaznaczonego fragmentu tekstu lub dla bieżącego wiersza, zgodnie z definicją reguł podświetlania składni wybraną dla bieżącego dokumentu.

    uncomment

- Usuwa znaczniki komentarza z zaznaczonego fragmentu tekstu lub bieżącego wiersza, zgodnie z definicją reguł podświetlania składni wybraną dla bieżącego dokumentu.

    kill-line

- Usuwa bieżący wiersz.

    replacewzorzeczastąpienie

- Zamienia tekst pasujący do napisu: `wzorzec` tekstem określonym w: `zastąpienie`. Jeżeli wzorzec lub zastąpienie zawiera spację, to oba argumenty należy podać w cudzysłowach (pojedynczych lub podwójnych). Jeżeli argument nie jest zamknięty w cudzysłowie, to pierwsze słowo traktowane jest jako `wzorzec`, a reszta tekstu jako `zastąpienie`. Jeżeli tekst `zastąpienie` nie zostanie podany, to każde wystąpienie `wzorca` zostanie usunięte.

  Parametry działania polecenia zamień mogą być dostosowywane poprzez dodanie dwukropka i jednej z dostępnych opcji. Polecenie przyjmuje wówczas postać: `replace:opcja wzorzec zastąpienie`. Dostępne są następujące opcje:

  `b`

- Szuka tekstu wstecz.

`c`

- Szuka począwszy od pozycji kursora.

`e`

- Szuka w ramach zaznaczonego fragmentu.

`r`

- Wykonuje polecenie szukania za pomocą wyrażenia regularnego. W przypadku użycia tej opcji, można w argumencie "zastąpienie" użyć parametru `\N`, gdzie N jest numerem podwyrażenia, które zostanie wstawione w zastępowanym tekście.

`s`

- Szuka zwracając uwagę na wielkość liter.

`p`

- Pyta się przed zastąpieniem kolejnego wystąpienia.

`w`

- Szuka dopasowując tylko całe wyrazy.

    dateformat

- Wprowadza do dokumentu bieżący czas i datę w formacie określonym przez: `format` lub w formacie yyyy-MM-dd hh:mm:ss gdy brak jest argumentu. Interpretacja treści argumentu `format` jest następująca:

  `d` | Dzień podany jako liczba bez wiodącego zera (1-31).
  `dd` | Dzień podany jako liczba z wiodącym zerem (01-31).
  `ddd` | Skrót zlokalizowanej nazwy dnia (np. 'Pon'..'Nie').
  `dddd` | Pełna zlokalizowana nazwa dnia (np.: 'Poniedziałek'..'Niedziela').
  `M` | Miesiąc jako liczba bez wiodącego zera (1-12).
  `MM` | Miesiąc jako liczba z wiodącym zerem (01-12).
  `MMM` | Skrót zlokalizowanej nazwy miesiąca (np. 'Sty'..'Gru').
  `yy` | Rok - dwucyfrowo (00-99).
  `yyyy` | Rok zapisany jako 4 cyfry (1752-8000).
  `h` | Godzina, zapisana bez wiodącego zera (0..23 lub 1..12 przy wyświetlanym AM/PM).
  `hh` | Godzina, zapisana z wiodącym zerem (00..23 lub 01..12 przy wyświetlanym AM/PM).
  `m` | Minuta, bez wiodącego zera (0..59).
  `mm` | Minuta z wiodącym zerem (00..59).
  `s` | Sekunda bez wiodącego zera (0..59).
  `ss` | Sekunda z wiodącym zerem (00..59).
  `z` | Milisekunda bez wiodącego zera (0..999).
  `zzz` | Milisekunda z wiodącym zerem (000..999).
  `AP` | Wyświetla symbol "AM" lub "PM" w zależności od pory dnia.
  `ap` | Wyświetla symbol "am" lub "pm" w zależności od pory dnia.

    charkod_znaku

- Polecenie pozwala na wstawianie do treści dokumentu znaku określonego przez wartość numeryczną w formie dziesiętnej, ósemkowej lub szesnastkowej.

  ##### Polecenie `char`, przykłady

  Wpisanie: `char 234`

  Wprowadzi do tekstu znak: `ê`

  Wpisanie: `char 0x1234`

  Wprowadzi do tekstu znak: `ሴ`

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

- To polecenie wykonuje operację znajdź/zamień analogicznie jak program "sed". Polecenie działa dla bieżącego wiersza lub dla całego dokumentu (`%s///`).

  Działanie polecenia polega na wyszukaniu w tekście wzorca wyszukiwania (określonego przez wyrażenie regularne pomiędzy pierwszym i drugim ukośnikiem). Po znalezieniu wzorca dopasowany tekst jest zamieniany na wyrażenie zawarte pomiędzy środkową i ostatnią częścią polecenia. Nawiasy we wzorcu wyszukiwania określają tzw.odwołania zwrotne, co oznacza iż program zapamiętuje wyszukany napis, który następnie może być użyty w definicji wyrażenia zastępującego. Odwołanie do zapamiętanego napisu odbywa się przez użycie `\1` dla pierwszego zestawu nawiasów, `\2` dla drugiego i tak dalej.

  Wyszukiwanie w tekście nawiasów `(` lub `)` wymaga zastosowania sekwencji specjalnych, z użyciem znaku odwrotnego ukośnika. Nawiasy będą reprezentowane przez napisy: `\(` oraz `\)`

  Użycie znaku `i` na końcu wyrażenia spowoduje, iż przy wyszukiwaniu nie będzie uwzględniana wielkość liter. Jeżeli na końcu wyrażenia wprowadzone zostanie `g` spowoduje to zamienienie wszystkich wystąpień poszukiwanego wzorca (w innym wypadku zamienione zostanie tylko pierwsze wystąpienie).

  ##### Zastępowanie tekstu w bieżącym wierszu

  Wyobraźmy sobie komunikat kompilatora informujący o następującym błędzie w wierszu 3902 edytowanego kodu programu: Klasa: `myClass` nie jest zdefiniowana.

  Zamiast przeszukiwania i edycji wiersza 3902, celem zamienienia złej nazwy klasy na poprawną (`MyClass`), wystarczy uruchomić linię poleceń, uruchomić polecenie `s/myclass/MyClass/i`, zapisać plik, a następnie już bez błędów skompilować program.

  ##### Zastępowanie tekstu w całym dokumencie

  Wyobraźmy sobie sytuację, że w trakcie edycji dokumentu, w którym często występuje napis Pani Nowak ktoś przychodzi i mówi, iż osoba ta wyszła za mąż za pana Kowalskiego. Należy oczywiście zamienić wszystkie wystąpienia Pani Nowak na Pani Kowalska.

  W linii poleceń wystarczy wprowadzić:`%s/Pani Nowak/Pani Kowalska/` i po naciśnięciu ENTER wszystko już będzie w porządku.

  ##### Przykłady zaawansowane

  W tym przykładzie zastosowano odwołanie zwrotne oraz mechanizm klas znaków (więcej informacji na ten temat znajduje się we wspomnianej poniżej dokumentacji).

  Dokument zawiera następujący wiersz kodu:

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

  Konieczne jest dodanie operatora `const` do wszystkich argumentów określonych przez referencję (reprezentowanych przez znak & na początku nazwy argumentu). Dodatkowo trzeba ujednolicić odstępy między słowami tak, aby była to tylko jedna spacja).

  Po uruchomieniu linii poleceń, należy wpisać: `s/\s+(\w+)\s+(&)/ const \1 \2/g` i nacisnąć ENTER. Znak `g` na końcu wyrażenia wymusza ponowną kompilacją wyrażenia regularnego po każdym dopasowaniu wyrażenia w tekście, co jest wymagane do poprawnego działania mechanizmu odwołań zwrotnych.

  Po wykonaniu polecenia wiersz przyjmie postać: `void MyClass::DoStringOps( const String &foo, const String &bar, String *p, const int &a, const int &b )`

  Interpretacja opisanego wyrażenia jest następujące. Najpierw wyszukuje ono spacje (`\s+`) po których wystąpił jeden lub więcej znaków alfanumerycznych (`\w+`) zakończonych kolejną spacją (`\s+`), za którą znajduje się znak &. Pełna treść tego dopasowania zostaje zachowana do dalszego wykorzystania przy wykonaniu zastąpienia tekstu. W drugiej części dopasowany fragment zostaje zastąpiony spacją i napisem const, po którym następuje kolejna spacja i zachowany wcześniej fragment tekstu (`\1`), a dalej spacja i kolejny fragment dopasowany po znaku & (`\2`)

  W powyższym przykładzie pierwszy dopasowany fragment mógł zawierać napis String lub też int, dlatego też zastosowanie klasy znakowej `\w` i operatora `+` dało wymagany efekt.

#### Komendy stosowane do nawigacji w tekście

    gotoINT wiersz

- Powoduje przejście do podanego numeru wiersza.

    findwzorzec

- Spowoduje przejście do pierwszego wystąpienia napisu `wzorzec` zgodnie z bieżącą konfiguracją funkcji wyszukiwania. Kolejne wystąpienia mogą zostać wyszukane za pomocą menu Edycja Znajdź następne (domyślny skrót klawiszowy to F3).

  Polecenie "find" może być skonfigurowane poprzez dodanie jednej lub więcej opcji po dwukropku w postaci: `find:opcje wzorzec`. Dostępne są następujące opcje:

  `b`

- Szuka tekstu wstecz.

`c`

- Szuka począwszy od pozycji kursora.

`e`

- Szuka w ramach zaznaczonego fragmentu.

`r`

- Wykonuje polecenie szukania za pomocą wyrażenia regularnego. W przypadku użycia tej opcji, można w argumencie "zastąpienie" użyć parametru `\N`, gdzie N jest numerem podwyrażenia, które zostanie wstawione w zastępowanym tekście.

`s`

- Szuka zwracając uwagę na wielkość liter.

`w`

- Szuka dopasowując tylko całe wyrazy.

    ifindwzorzec

- Polecenie wyszukuje tekst w trakcie pisania. Dodatkowo można skonfigurować zachowanie za pomocą opcji podanych po dwukropku w postaci: `ifind:opcje wzorzec`. Dostępne są następujące opcje:

  `b`

- Szuka tekstu wstecz.

`r`

- Wyszukaj za pomocą wyrażenia regularnego.

`s`

- Szuka zwracając uwagę na wielkość liter.

`c`

- Szuka począwszy od pozycji kursora.

## Korzystanie ze zwijania kodu źródłowego

Zwijanie kodu, pozwala na ukrywanie wydzielonych części tekstu, dzięki czemu łatwiej jest przeglądać duże fragmenty edytowanego kodu źródłowego. &kate; określa możliwość zwinięcia danej części na podstawie reguł określonych w definicji podświetlania składni. Zwijanie jest dostępne tylko dla niektórych formatów dokumentów, zwykle są to pliki XML, kod źródłowy, itp. Większość definicji podświetlania, obsługujących funkcję zwijania kodu, pozwala też na ręczne definiowanie zwijalnych fragmentów tekstu, zwykle za pomocą słów kluczowych `BEGIN` oraz `END`.

Aby włączyć funkcję zwijania kodu, należy skorzystać z menu Widok Pokaż znaczniki zwijania (jeżeli nie były one wcześniej widoczne). Pasek znaczników zwijania, widoczny po lewej stronie okna edycji menu, wyświetla graficzną reprezentację zwijalnych fragmentów kodu wraz ze znakami +/- wskazującymi na możliwe do wykonania na nim operacje. Naciśnięcie znaku "-" zwija dotyczący go fragment, zaś "+" rozwija go.

W menu dostępne są cztery dodatkowe polecenia pozwalające na manipulację zwiniętymi częściami tekstu, więcej informacji na ten temat dostępne jest w dokumentacji menu.

Jeżeli użytkownik nie chce korzystać z funkcji zwijania kodu, to może wyłączyć opcję Pokaż znaczniki zwijania (jeżeli dostępne) w karcie Edytor -> Wygląd w oknie konfiguracji.

## Wykorzystanie Javascript do sterowania pracą edytora

### Wprowadzenie

Począwszy od wersji 2.5, edytor &kate; umożliwia tworzenie skryptów w standardzie ECMA, znanym również jako JavaScript.

Ze skryptów można korzystać tylko za pomocą wbudowanej linii poleceń. Skrypt musi być zlokalizowany w katalogu, w którym &kate; może go odszukać wraz z opcjonalnym plikiem .desktop definiującym jego dodatkowe właściwości. Domyślnym katalogiem dla skryptów jest podkatalog `katepart/scripts` znajdujący się w katalogu z danymi środowiska &kde;. Ścieżka dostępu do katalogu z danymi środowiska jest wyświetlana za pomocą polecenia `kde-config `--path` `data``. Zwykle podczas instalacji systemu operacyjnego tworzone są katalogi danych: systemowy i użytkownika. Skrypty umieszczone w katalogu systemowym są dostępne dla wszystkich użytkowników, zaś w katalogu użytkownika dostępne są tylko dla tego użytkownika.

Ta funkcja programu ma charakter eksperymentalny i jej działanie może się zmienić w przyszłych wersjach programu.

W chwili obecnej nie jest możliwe dodawanie skryptów do menu lub przypisywanie im skrótów klawiszowych. W przyszłości ta możliwość może się pojawić.

Nie jest jeszcze możliwe przekazywanie do uruchamianego skryptu żadnych argumentów. Ta możliwość również w przyszłości się pojawi ;)

### Interfejs programisty (API) dla JavaScript w &kate;

Poniżej przedstawiono pełny zestaw funkcji i właściwości dostępnych dla obiektów `document` oraz `view`. Oczywiście możliwe jest korzystanie z innych obiektów standardowych Javascript takich jak np.: `Math`, `String` `Regex`, itd.

Podczas działania skryptu, obiekt `document` odnosi się do bieżącego dokumentu, a obiekt `view` odnosi się do bieżącego widoku.

Typy argumentów nie są w chwili obecnej stosowane w JavaScript, przedstawione są tylko dla zilustrowania jakiego rodzaju wartości dana funkcja oczekuje.

### Funkcje globalne

`debug( ``string``) [funkcja]`

- ### parametry

  - `string` napis do wypisania

  Przekazuje napis na standardowe wyjście STDERR wykorzystując funkcję `kdDebug()`. Wykorzystywany jest specjalnie przydzielony obszar do wyświetlania komunikatów, oznaczony przedrostkiem `Kate (KJS Scripts):`

### Charakterystyka interfejsu programisty (API) dla klasy `document`

`document.attribute( ``wiersz`` , ``kolumna`` ); [funkcja]`

- ### Parametry

  - `uint wiersz` Numer wiersza, dla którego będzie wyszukiwany atrybut.

  - `uint kolumna` Numer kolumny, dla której będzie poszukiwany atrybut.

  Zwraca kod ID atrybutu znajdującego się w określonej pozycji dokumentu [`wiersz`,`kolumna`]. Atrybut reprezentuje wygląd tekstu lub styl tekstu, i wykorzystywany jest do podświetlania składni określonego fragmentu tekstu, co jest wykorzystywane w formatach mieszanych takich jak np.: HTML lub PHP.

`document.canBreakAt( `Char c`, `uint atrybut` ); [funkcja]`

- ### Parametry

  - `c` Znak do sprawdzenia

  - `atrybut` Atrybut w pozycji znaku `c`.

  Zwraca informację, dotyczącą możliwości łamania wiersza dla znaku "c" i atrybutu "atrybut". Wynik działania funkcji zależy od reguł podświetlania, określających możliwość łamania wiersza dla danego znaku i atrybutu.

`document.canComment( `uint atrybut_początkowy`, `uint atrybut_końcowy` ); [funkcja]`

- ### Parametry

  - `atrybut_początkowy` Atrybut rozpoczynający obszar określony do przekształcenia w komentarz.

  - `atrybut_końcowy` Atrybut kończący obszar określony do przekształcenia w komentarz.

  Zwraca informację o tym, czy atrybut_początkowy i atrybut_końcowy są zgodne z bieżącymi regułami podświetlania składni. Jeżeli tak, to możliwe jest wtedy przekształcenie tego fragmentu w komentarz.

  #### Wykorzystanie funkcji canComment

      if ( document.canComment( document.attribute(1,0), document.attribute(5,0) ) ) {
          // 1,0 oraz 5,0 należą do tego samego systemu reguł podświetlania składni
      }

`document.clear(); [funkcja]`

- Usuwa zawartość dokumentu.

`document.commentStart( `uint atrybut` ); [funkcja]`

- ### Parametry

  - `atrybut` Atrybut tekstu, dla którego zostanie zwrócony napis rozpoczęcia komentarza.

  Zwraca napis wymagany do rozpoczęcia wielowierszowego komentarza dla tekstu o określonym atrybucie, lub napis pusty, jeżeli komentarze wielowierszowe nie są obsługiwane dla tego typu dokumentu.

`document.commentMarker( `uint atrybut` ); [funkcja]`

- ### Parametry

  - `atrybut` Atrybut tekstu, dla którego zostanie pobrany znacznik komentarza

  Zwraca napis, wykorzystywany do komentowania wiersza dokumentu, lub pusty napis jeżeli komentarze dla całych wierszy nie są dostępne dla tego typu dokumentu.

`document.commentEnd( `uint atrybut` ); [funkcja]`

- ### Parametry

  - `atrybut` Atrybut tekstu, dla którego zostanie zwrócony napis zakończenia komentarza

  Zwraca napis wymagany do zakończenia wielowierszowego komentarza dla tekstu o określonym atrybucie, lub napis pusty, jeżeli komentarze wielowierszowe nie są obsługiwane dla tego typu dokumentu.

`document.editBegin(); [funkcja]`

- Rozpoczyna grupę operacji edycyjnych. Wszystkie działania wykonane do momentu uruchomienia funkcji editEnd() będą zgrupowane w jedną operację cofania.

`document.editEnd(); [funkcja]`

- Kończy grupę operacji edycyjnych.

`document.highlightMode; [właściwość:tylko do odczytu]`

- Zawiera nazwę trybu reguł podświetlania dla bieżącego dokumentu (np. "JavaScript" lub "C++"). Jeżeli dokument nie ma zdefiniowanego trybu podświetlania składni, zostanie zwrócona wartość "None". Konieczne jest korzystanie z nazwy w języku angielskim, w przypadkach gdy różni się ona od nazwy przetłumaczonej.

`document.indentMode; [właściwość:tylko do odczytu]`

- Nazwa trybu automatycznych wcięć dla bieżącego dokumentu (np.:`normal` lub `cstyle`). Jeżeli tryb automatycznych wcięć jest wyłączony, to zwrócona zostanie wartość `none`.

`document.indentWidth; [właściwość:tylko do odczytu]`

- Szerokość wcięć ustawiona dla dokumentu, wykorzystywana jeżeli włączone są wcięcia za pomocą znaku spacji.

`document.insertLine( `uint wiersz`, `string tekst` ); [funkcja]`

- ### Parametry

  - `wiersz` numer wiersza dokumentu

  - `tekst` tekst do wprowadzenia

  Wstawia nowy wiersz o zawartości `tekst` w wierszu o numerze `wiersz`.

`document.insertText( `uint wiersz`, `uint kolumna`, `string tekst` ); [funkcja]`

- ### Parametry

  - `wiersz` numer wiersza dokumentu

  - `kolumna` numer kolumny w dokumencie

  - `tekst` tekst do wprowadzenia

  Wstawia do dokumentu `tekst` w wierszu `wiersz` i kolumnie `kolumna`.

document.length(); [funkcja]

- Zwraca rozmiar dokumentu w bajtach.

`document.lines(); [funkcja]`

- Zwraca liczbę wierszy w dokumencie.

document.mixedIndent; [właściwość:tylko do odczytu]

- Wartość prawda/fałsz informująca czy tryb mieszanych wcięć dla dokumentu jest włączony. Jeżeli tak, to wcięcia są optymalizowane, tak że zawierają mieszankę znaków tabulacji i spacji (podobnie jak w edytorze Emacs).

document.removeLine( `uint wiersz` ); [funkcja]

- ### Parametry

  - `wiersz` numer wiersza dokumentu

  Usuwa wiersz z dokumentu.

`document.removeText( `uint wiersz_początku`, `uint kolumna_początku`, `uint wiersz_końca`, `uint kolumna_końca` ); [funkcja]`

- ### Parametry

  - `wiersz_początku` określa początkowy wiersz dokumentu

  - `kolumna_początku` określa początkową kolumnę dokumentu

  - `wiersz_końca` określa ostatni wiersz

  - `kolumna_końca` określa ostatnią kolumnę

  Usuwa tekst w dokumencie od wiersza `wiersz_początku` i kolumny `kolumna_początku` do wiersza`wiersz_końca` i kolumny `kolumna_końca`.

`document.setText( `string tekst` ); [funkcja]`

- ### Parametry

  - `tekst` treść dokumentu

  Ustawia zawartość całego dokumentu na `tekst`.

`document.spaceIndent; [właściwość:tylko do odczytu]`

- Wartość prawda/fałsz określająca czy tryb wcinania spacjami jest włączony. Jeżeli tak, to wcięcia w dokumencie są generowane odpowiednią, zdefiniowaną przez "indentWidth", liczbą spacji. W przeciwnym wypadku, wcięcia dokonywane są za pomocą znaków tabulacji (jeden znak na jeden poziom wcięcia).

`document.textFull(); [funkcja]`

- Zwraca pełną zawartość dokumentu. Jeżeli dokument zawiera wiele wierszy, to rozdzielane są one znakiem końca wiersza: `\n`.

`document.textLine( uint wiersz ); [funkcja]`

- ### Parametry

  - `wiersz` numer wiersza

  Zwraca tekst wiersza o numerze `wiersz`.

`document.textRange( `uint wiersz_początku`, `uint kolumna_początku`, `uint wiersz_końca`, `uint kolumna_końca` ); [funkcja]`

- ### Parametry

  - `wiersz_początku` określa początkowy wiersz dokumentu

  - `kolumna_początku` określa początkową kolumnę dokumentu

  - `wiersz_końca` określa ostatni wiersz

  - `kolumna_końca` określa ostatnią kolumnę

  Zwraca zdefiniowany zakres tekstu dokumentu. Jeżeli zawiera on wiele wierszy, to rozdzielane są one znakiem końca wiersza: `\n`.

### Interfejs programisty (API) dla klasy `view`

`view.clearSelection(); [funkcja]`

- Usuwa zaznaczenie z tekstu.

`view.cursorColumn(); [funkcja]`

- Zwraca numer kolumny, w której znajduje się kursor (znaki tabulacji są rozwijane do odpowiedniej liczby spacji).

`view.cursorColumnReal(); [funkcja]`

- Zwraca rzeczywisty numer kolumny, w której znajduje się kursor (znaki tabulacji traktowane są jako jeden znak).

`view.cursorLine(); [funkcja]`

- Zwraca numer wiersza, w którym znajduje się kursor.

`view.hasSelection(); [funkcja]`

- Zwraca wartość `true` (logiczna prawda), jeżeli widok zawiera zaznaczenie, lub `false` (logiczny fałsz), gdy w widoku brak zaznaczenia.

`view.removeSelectedText(); [funkcja]`

- Usuwa zaznaczony fragment, w przypadku gdy zaznaczenie w tekście istnieje.

`view.selectAll(); [funkcja]`

- Zaznacza cały dokument.

`view.selection(); [funkcja]`

- Zwraca zaznaczony fragment. Jeżeli zawiera on wiele wierszy, to rozdzielane są one znakiem końca wiersza: `\n`.

`view.selectionEndColumn; [właściwość:tylko do odczytu]`

- Zwraca numer ostatniej kolumny zaznaczenia.

`view.selectionEndLine; [właściwość:tylko do odczytu]`

- Zwraca numer ostatniego wiersza zaznaczenia.

`view.selectionStartColumn; [właściwość:tylko do odczytu]`

- Zwraca numer pierwszej kolumny zaznaczenia.

`view.selectionStartLine; [właściwość:tylko do odczytu]`

- Zwraca numer pierwszego wiersza zaznaczenia.

`view.setCursorPosition( `uint wiersz`, `uint kolumna` ); [funkcja]`

- ### Parametry

  - `wiersz` numer wiersza pozycji kursora.

  - `kolumna` numer kolumny pozycji kursora.

  Ustawia kursor w widoku w pozycji [`wiersz`, `kolumna`]. Pozycja zostaje ustalona wizualnie, czyli znaki tabulacji rozwijane są na odpowiednią (określoną przez `tabwidth`) liczbę spacji w zależności od pozycji w wierszu. Kursor staje się widoczny. Parametry wiersz i kolumna rozpoczynają się od zera.

`view.setCursorPositionReal( `uint wiersz`, `uint kolumna` ); [funkcja]`

- ### Parametry

  - `wiersz` numer wiersza pozycji kursora.

  - `kolumna` numer kolumny pozycji kursora.

  Ustawia kursora w pozycji podanej przez `wiersz` i `kolumnę`. Argumenty określają pozycję w tekście, czyli znaki tabulacji traktowane są jako jeden znak. Kursor stanie się widoczny. Numery wiersza i kolumny rozpoczynają się od zera.

`view.setSelection( `uint wiersz_początku`, `uint kolumna_początku`, `uint wiersz_końca`, `uint kolumna_końca` ); [funkcja]`

- ### Parametry

  - `wiersz_początku` określa początkowy wiersz dokumentu

  - `kolumna_początku` określa początkową kolumnę dokumentu

  - `wiersz_końca` określa ostatni wiersz

  - `kolumna_końca` określa ostatnią kolumnę

  Zaznacza fragment tekstu począwszy od wiersza `wiersz_początku` i kolumny `kolumna_początku` do wiersza `wiersz_końca` i kolumny `kolumna_końca`.

#### Przykładowy skrypt

Przedstawiony poniżej skrypt, przerabia wszystkie litery w zaznaczonym fragmencie na duże. Pierwszym krokiem jest sprawdzenie istnienia zaznaczenia, następnie pobranie zaznaczonego tekstu, zamienienie wielkości znaków oraz wstawienie zmienionego tekstu do dokumentu. Zapis programu wygląda następująco:

    if ( view.hasSelection() )
    {
      // zmień na duże litery
      column = view.selectionStartColumn;
      line = view.selectionStartLine;

      selection = view.selection().toUpperCase();

      document.editBegin();
      view.removeSelectedText();
      document.insertText( line, column, selection );
      document.editEnd();
    }

Zgrupowanie poleceń edycyjnych tak, aby można je było wycofać jednym poleceniem Cofnij, polega na objęciu poleceń

    view.removeSelectedText()

i

    document.insertText()

poleceniami

    document.editBegin()

oraz

    document.editEnd()

.

#### Przykładowy plik `.desktop`

Poniżej przedstawiono zawartość przykładowego pliku .desktop powiązanego z powyższym skryptem.

    # Example of a .desktop file
    [Desktop Entry]
    Encoding=UTF-8
    Name=Kate Part JavaScript Uppercase
    Comment=Skrypt zamieniający treść zaznaczenia na duże litery
    X-Kate-Command=uppercase-selection
    X-Kate-Help=<p>Pomoc: <code>uppercase-selection</code></p>

W pliku tym, możliwe jest zdefiniowanie kodowania znaków (Encoding), nazwy skryptu (Name), komentarza (Comment), tekstu pomocy (X-Kate-Help) i polecenia linii poleceń (X-Kate-Command). Jeżeli plik .desktop znajdzie się w repozytoriach SVN środowiska KDE, to parametry: Name, Comment i X-Kate-Help będą automatycznie tłumaczone na inne języki przez zespoły tłumaczy KDE.

#### Wykorzystanie skryptów

Program &kate; przeszuka katalogi ze skryptami (patrz wyżej) w poszukiwaniu plików o nazwie `*.js`. Dla każdego znalezionego pliku sprawdzane jest istnienie odpowiadającego mu pliku `.desktop` (np. dla skryptu: uppercase.js, poszukiwany będzie plik uppercase.desktop).

Jeżeli plik `.desktop` nie zostanie znaleziony, to skrypt zostanie zarejestrowany przez linię poleceń edytora pod nazwą pliku bez rozszerzenia .js. W opisywanym przykładzie będzie to `uppercase`. Jeżeli taka nazwa skryptu odpowiada użytkownikowi oraz nie ma potrzeby korzystania z innych możliwości, jakie daje plik `.desktop`, to wtedy użycie pliku `.desktop` nie jest wymagane.

Jeżeli istnieje plik `.desktop`, edytor odczyta nazwę skryptu z tego pliku z pozycji X-Kate-Command, na przykład: X-Kate-Command=uppercase-selection.