# Szablony plików

## Wprowadzenie

Wtyczka "Szablony Plików Kate" pozwala na tworzenie nowych dokumentów bazujących na zdefiniowanym wzorcu. Jako szablon może służyć dowolny plik tekstowy (będzie on skopiowany do zawartości nowego dokumentu) lub specjalny plik szablonu zawierający makro polecenia pozwalające na wprowadzenie do pliku informacji takich jak np. nazwisko, adres email, data, itp. oraz umożliwiające ustawienia kursora w zdefiniowanej pozycji w nowo utworzonym pliku.

Wszystkie szablony zlokalizowane w katalogu programu będą widoczne jako pozycje w menu Plik Nowy z szablonu.

Wtyczka ta pozwala również w prosty sposób utworzyć nowy szablon na podstawie otwartego dokumentu.

Katalogi z szablonami wchodzą w skład systemu plików środowiska &kde; i są one następujące:KDEDIR/share/applications/kate/plugins/katefiletemplates/templates orazKDEHOME/share/applications/kate/plugins/katefiletemplates/templates. Jeżeli w zmiennej środowiskowej KDEDIRS zdefiniowano kilka dodatkowych katalogów, to wszystkie są one sprawdzane w poszukiwaniu podobnego podkatalogu. Jeżeli znalezione zostaną szablony o identycznych nawach to wybierany jest ten znajdujący się w głównym katalogu środowiska &kde; zdefiniowanym przez zmienną KDEHOME.

## Pozycje menu

Plik Nowy z szablonu Dowolny plik...

- Wyświetla okno dialogowe otwierania plików, pozwalające na wybór dowolnego wskazanego pliku jako szablonu dokumentu. Jeżeli wybrany plik posiada rozszerzenie `katetemplate` to zostaną zinterpretowane zawarte w nim makra i informacje o szablonie.

Plik Nowy z szablonu Użyj ostatniego

- Wyświetla listę ostatnio wykorzystywanych szablonów podając ich adres &URL;.

Plik Nowy z szablonu

- Otwiera menu podrzędne zawierające listę szablonów. Kliknięcie na wybranej pozycji tworzy plik na podstawie odpowiadającego jej szablonu.

Ustawienia Zarządzaj szablonami...

- Wyświetla okno dialogowe zawierające listę wszystkich szablonów dostępnych w katalogach programu &kate;, oraz opcje pozwalające na dodawanie, zmianę i usuwanie szablonów.

## Korzystanie z szablonów w &kate;

Przy tworzeniu pliku na podstawie szablonu zawierającego makro polecenia, niektóre z tych makro poleceń pojawiają się jako pola w tekście, które można edytować. Są one zaznaczane przez &kate; za pomocą podkreślenia ich.

Pierwsza zmienna będzie aktywna i możliwe będzie edycja jej zawartości. Jeżeli w dokumencie znajduje się kilka odwołań do tej samej zmiennej, to ich zawartość również będzie zmieniana w trakcie jej edycji. Przejście do następnej zmiennej odbywa się za pomocą klawisza TAB. Po osiągnięciu ostatniej zmiennej na liście, zostaje ona zwinięta, a normalne działanie klawisza TAB zostaje przywrócone.

## Tworzenie własnych szablonów

Aby utworzyć nowy szablon, wybierz z menu Ustawienia Zarządzaj szablonami..., co spowoduje otworzenie okna zarządzania szablonami. W tym oknie, naciśnij przycisk Nowy..., aby uruchomić asystenta tworzenia szablonu. Asystent poprosi o wskazanie pliku, który ma zostać zamieniony na szablon, oraz o podanie ustawień szablonu, a następnie szablon zostanie utworzony.

Innym sposobem jest ręczne utworzenie szablonu poprzez dodanie pól informacyjnych, tekstu i makro poleceń do dowolnego pliku tekstowego i zapisanie go w pliku z rozszerzeniem `katetemplate`.

Menu z listą szablonów jest aktualizowane automatycznie w momencie zapisania go na dysku w odpowiednim katalogu z szablonami &kate;.

## Modyfikacja szablonów

Aby zmienić szablon, wybierz z menu Ustawienia Zarządzaj szablonami.... Następnie wybierz szablon, który chcesz zmienić i naciśnij przycisk Zmień..., aby otworzyć szablon. Zamknij okno dialogowe, zmień szablon według swojego upodobania i zamknij go.Zmiany w szablonach są widoczne od razu. Możesz uruchomić szablon zaraz po zapisaniu, aby to sprawdzić.

## Format pliku z szablonem dokumentu &kate;

Jeżeli otwierane są pliki z rozszerzeniem `katetemplate` to są one przetwarzane w poszukiwaniu informacji o szablonie, makro poleceniach i pozycji kursora.

### Informacje o szablonie

W trakcie odczytu pliku program poszukuje wierszy rozpoczynających się od napisu `katetemplate:` i poszukuje w nich informacji o szablonie zapisanych w formacie NAZWAZMIENNEJ=WARTOŚĆ. Pierwszy wiersz tekstu, w którym brak jest napisu `katetemplate:` stanowi początek zawartości szablonu.Wartością może być dowolny znak lub ciąg znaków z wyjątkiem znaku równości (=). Dopuszczalne są następujące nazwy zmiennych:

`Template`

- Nazwa szablonu, która będzie wyświetlana jako pozycja w menu Plik Nowy z szablonu.

`Group`

- Nazwa grupy tematycznej wykorzystywana do grupowania listy szablonów w menu Plik Nowy z szablonu.

`Name`

- Definiuje nazwę dokumentu, wyświetlaną na liście plików i pasku tytułowym okna. Jeżeli nazwa zawiera napis `%N` to będzie on zamieniany na kolejny numer dokumentu podczas tworzenia dokumentów o tej samej nazwie.

`Highlight`

- Ten parametr powoduje ustawienie trybu podświetlania dla nowo tworzonego dokumentu. Wartość parametru powinna być taka sama jak nazwa reguły podświetlania widoczna w menu Narzędzia Podświetlenie .

`Description`

- Krótki opis charakteryzujący szablon. Jest wykorzystywany do wyświetlania informacji "Co to jest?" dla odpowiedniej pozycji menu, może być też wykorzystywany w innych celach w przyszłości.

Author

- Napis identyfikujący autora, na przykład w formie `Nazwisko Imię <adres email>`. Jest wykorzystywany do wyświetlania informacji "Co to jest?" dla odpowiedniej pozycji menu, może być też wykorzystywany w innych celach w przyszłości.

### Makro polecenia stosowane w szablonach

Podczas przetwarzania szablonu, makro polecenia zapisane w formie `%{NAME}` lub `${NAME}` będą wstawiane do tekstu. Jeżeli znakiem poprzedzającym polecenie jest `$` to tekst będzie traktowany jako zmienna, którą można modyfikować po utworzeniu nowego dokumentu na podstawie szabonu, jeżeli zaś użyty będzie znak `%` to edycja nie będzie możliwa (no chyba że operacja wstawiania się nie powiodła).

Dostępne są następujące makro polecenia:

time

- Wprowadza bieżący czas w formacie zdefiniowanym przez ustawienia lokalne.

date

- Wprowadza do dokumentu bieżącą datę w zapisie krótkim.

datetime

- Wprowadza bieżącą datę i czas jako napis sformatowany zgodnie z ustawieniami lokalnymi.

year

- Wprowadza bieżący rok w postaci 4 cyfr.

month

- Pełna nazwa bieżącego miesiąca, zgodna z ustawieniami lokalnymi systemu.

day

- Wprowadza bieżący dzień miesiąca.

hostname

- Wprowadza nazwę komputera zdefiniowaną w zmiennej środowiskowej: 'hostname'.

index

- Wprowadza znak 'i'.

fullname

- Wstawia imię i nazwisko zalogowanego użytkownika, zdefiniowany w książce adresowej środowiska &kde;.

firstname

- Wstawia imię zalogowanego użytkownika, zdefiniowany w książce adresowej środowiska &kde;.

lastname

- Wstawia nazwisko zalogowanego użytkownika, zdefiniowany w książce adresowej środowiska &kde;.

email

- Wstawia adres email zalogowanego użytkownika, zdefiniowany w książce adresowej środowiska &kde;.

Każde inne (nie znajdujące się na powyższej liście) makro polecenie, traktowane jest jako zmienna, którą można modyfikować niezależnie od dodanego prefiksu. Jeżeli taka sama zmienna występuje w kilku miejscach dokumentu, to jej edycja w jednym miejscu uzupełni wszystkie pozostałe wystąpienia przy tworzeniu dokumentu na podstawie szablonu.

### Ustawianie pozycji kursora

Specjalne makro polecenie zapisane jako `${cursor}` będzie zamieniona na poziomą linię dodaną na końcu listy modyfikowalnych zmiennych, niezależnie od ich położenia w tekście.

## Podziękowania i licencje

Wtyczka Szablony plików &kate; - prawa autorskie (c) 2004 &Anders.Lund; &Anders.Lund.mail;.

Prawa autorskie do dokumentacji (c) 2004 &Anders.Lund;

Krzysztof Woźniak wozniakk@ceti.pl

&underGPL;