Podręcznik użytkownika dla wtyczek do programu Kate
Copyright © 2001, 2002
Dozwolone jest kopiowanie, dystrybucja i/lub modyfikacja tego dokumentu na zasadach licencji GNU Free Documentation License, w wersji 1.1 lub dowolnej późniejszej wersji, opublikowanej przez Free Software Foundation; bez Sekcji Niezmiennych, bez Tekstu Początkowego i bez tekstu Końcowego. Kopia tej licencji znajduje się w sekcji zatytułowanej "GNU Free Documentation License".
Niniejszy podręcznik dotyczy wtyczek do Kate zaawansowanego edytora tekstu dla środowiska KDE.
Spis treści
Wtyczki w programie Kate zwiększają funkcjonalność edytora. Mogą powodować dodanie nowej pozycji menu i skrótu klawiszowego. Można dowolną liczbę wtyczek zainstalować i włączyć lub wyłączyć w zależności od potrzeb użytkownika za pomocą okna konfiguracji Kate. Aby tego dokonać należy wybrać menu ->. W oknie konfiguracji trzeba wybrać pozycję -> i wybrać potrzebne do pracy z programem wtyczki.
Więcej informacji dotyczących Kate i sposobu włączania w nim wtyczek znajduje się w podręczniku programu Kate.
Podręcznik zawiera opis następujących wtyczek:
Wtyczka ta powoduje wyświetlanie podpowiedzi o dostępnych w danej pozycji edytowanego pliku XML elementach, zgodnie z określonym dla tego pliku szablonem DTD. Wyświetlana będzie lista elementów, atrybutów, wartości atrybutów lub encji, w zależności od pozycji kursora (np. wszystkie encje będą wyświetlone jeżeli znakiem na lewo od kursora jest„&”). Jedną z funkcji jest także zamykanie najbliższego, znajdującego się po lewej stronie kursora, otwartego znacznika.
Szablon dokumentu XML DTD musi istnieć i być określony w formacie generowanym przez polecenie Perla dtdparse. Szablon w tym formacie jest nazywany „meta szablonem DTD”. Wraz z wtyczką zainstalowane jest kilka meta szablonów DTD w katalogu: $KDEDIR/share/apps/katexmltools/, który jest katalogiem domyślnym przy wywoływaniu funkcji . Aby stworzyć własne meta szablony DTD należy skorzystać z programu dtdparse dostępnego na stronach: http://dtdparse.sourceforge.net.
Należy uruchomić program Kate i otworzyć okno dialogowe konfiguracji za pomocą menu ->. Następnie należy zaznaczyć opcję Uzupełnianie składni XML znajdującą się w karcie Program/Wtyczki. Po włączeniu wtyczki i zamknięciu okna, należy wybrać z menu pozycję ->. Jeżeli edytowany dokument nie posiada elementu „DOCTYPE” lub jeżeli jest on nieznany to należy wskazać meta szablon DTD znajdujący się na dysku. W przeciwnym wypadku zostanie automatycznie załadowany meta szablon DTD odpowiadający elementowi DOCTYPE bieżącego dokumentu.
Od tego momentu można już korzystać z wtyczki podczas edycji naciskając następujące klawisze:
Wyświetli listę dostępnych elementów (tagów). Klawisz działa tylko jeżeli kursor znajduje się poza znacznikiem. Należy zauważyć iż nie można użyć tego klawisze do wstawiania elementów najwyższego poziomu ( jak np.: „<html>”).
Klawisz wyświetli listę dostępnych wartości atrybutów (jeżeli występują). Klawisz działa jeżeli kursor znajduje się wewnątrz znacznika.
Naciśnięcie tego klawisza wyświetli listę dostępnych atrybutów dla bieżącego elementu. Klawisz działa jeżeli kursor znajduje się wewnątrz znacznika.
Klawisz wywoła listę dostępnych encji.
Użytkownik może przetestować wszystkie funkcje i ograniczenia wtyczki wczytując plik $KDEDIR/share/apps/katexmltools/testcases.xml i postępując zgodnie z zawartymi tam instrukcjami. Należy zaznaczyć iż praca z kilkoma widokami tego samego dokumentu nie jest jeszcze poprawnie obsługiwana przez tą wtyczkę.
Would you like to make a comment or contribute an update to this page?
Send feedback to the KDE Docs Team
Otwiera okno dialogowe pozwalające na wstawienie znacznika XML. Znaki <, > oraz znacznik zamykający będą dołączone automatycznie. Jeżeli przed wybraniem tej opcji w dokumencie był zaznaczony fragment tekstu, to zostanie on umieszczony pomiędzy znacznikiem otwierającym i zamykającym. W oknie dialogowym działa również funkcja autouzupełniania nazw znaczników oraz elementów, które można umieścić w bieżącej pozycji kursora zgodnie ze zdefiniowanym za pomocą meta szablonem DTD.
Spowoduje przeszukanie dokumentu w poszukiwaniu znacznika, który jeszcze nie został zamknięty i zamknięcie go poprzez wstawienie odpowiedniego znacznika zamykającego. Poszukiwanie rozpoczyna się od pozycji kursora w lewą stronę. Jeżeli żaden otwarty znacznik nie zostanie znaleziony to nic nie zostanie wstawione.
Pozwala na wskazanie pliku DTD, który powinien zostać użyty dla bieżącego dokumentu. Przyporządkowanie to nie zostanie zapisane, należy je ponowić przy każdym następnym uruchomieniu Kate.
Would you like to make a comment or contribute an update to this page?
Send feedback to the KDE Docs Team
Wtyczka Kate „Uzupełnianie składni XML”. Prawa autorskie (c) 2001,2002 Daniel Naber (daniel.naber AT t-online.de).
Prawa autorskie do dokumentacji (c) 2001,2002 Daniel Naber
Krzysztof Woźniak (wozniakk AT ceti.pl)
Ten program jest rozprowadzany na zasadach Licencji GNU General Public License.
Would you like to make a comment or contribute an update to this page?
Send feedback to the KDE Docs Team
Would you like to make a comment or contribute an update to this page?
Send feedback to the KDE Docs Team
Wtyczka sprawdza poprawność bieżącego dokumentu. Lista ostrzeżeń i błędów pojawi się dolnej części głównego okna Kate. Kliknięcie na wybrany komunikat błędu spowoduje przeskok do odpowiadającej mu linii dokumentu. Jeżeli dany plik posiada zdefiniowany parametr „DOCTYPE” to do sprawdzania poprawności będzie użyty odpowiadający mu plik szablonu DTD. Poszukiwanie pliku DTD jest przeprowadzane względem katalogu w którym znajduje się bieżący dokument. Jeżeli np. szablon odnosi się do rodzaju dokumentu XML: „DTD/xhtml1-transitional.dtd” a edytowanym plikiem jest /home/peter/test.xml to szablon DTD powinien być umieszczony w katalogu /home/peter/DTD/xhtml1-transitional.dtd. Obsługiwane są również zdalne szablony DTD, do którym można się odwoływać poprzez http.
Jeżeli dla danego pliku nie znaleziono definicji składni 'doctype' to będzie on sprawdzany jedynie pod kątem formalnym.
Więcej informacji na temat XML znajduje się na oficjalnych stronach W3C XML.
Wtyczka wykorzystuje polecenie xmllint, będące częścią pakietu libxml2. Jeżeli polecenie to nie jest poprawnie zainstalowane w systemie to wtyczka nie będzie działać.
Program w czasie działania tworzy plik tymczasowy w tym samym katalogu co plik dokumentu. Konieczne jest więc zapewnienie odpowiednich uprawnień zapisu w tym katalogu.
Włączenie wtyczki odbywa się w oknie konfiguracyjnym Kate wywoływanym przez menu ->. Należy wybrać pozycję Sprawdzanie poprawności XML-a znajdującą się w karcie Program/Wtyczki.
Wtyczka Kate „Sprawdzanie poprawności XML'a”. Prawa autorskie (c) 2002 Daniel Naber (daniel.naber AT t-online.de).
Prawa autorskie do dokumentacji (c) 2002 Daniel Naber
Krzysztof Woźniak (wozniakk AT ceti.pl)
Ten program jest rozprowadzany na zasadach Licencji GNU General Public License.
Would you like to make a comment or contribute an update to this page?
Send feedback to the KDE Docs Team
Would you like to make a comment or contribute an update to this page?
Send feedback to the KDE Docs Team
Wtyczka „Polecenie wstawiania do Kate” pozwala na wstawienie do edytowanego w Kate dokumentu tekstu będącego wyjściem dowolnego polecenia powłoki.
Najpierw należy włączyć wtyczkę „Polecenie wstawiania Kate” korzystając z menu -> i zaznaczając w karcie konfiguracji opcję Polecenie wstawiania Kate w sekcji konfiguracyjnej: Program Wtyczki.
Aby skorzystać z wtyczki należy wybrać pozycję z menu . Pojawi się małe okno dialogowe pozwalające na wprowadzenie polecenia powłoki do uruchomienia, wybranie katalogu roboczego i wybranie wyjścia błędów polecenia (STDERR) zamiast wyjścia standardowego (STDOUT). Można również spowodować wprowadzenie do dokumentu tekstu z wykonanym przez powłokę poleceniem przed wygenerowaną treścią wyjścia.
Wtyczka może przechowywać pewną liczbę ostatnio używanych poleceń, których ilość można ustawić w oknie konfiguracji. Lista ostatnio wykonanych poleceń jest wykorzystywana przy działaniu funkcji automatycznego uzupełniania i można ją wywołać za pomocą rozwijanej listy w polu wprowadzania polecenia.
Domyślnie polecenia uruchamiane są w katalogu roboczym właściwym dla procesu programu Kate, którym z reguły jest katalog domowy użytkownika. Zachowanie to może być zmienione w oknie konfiguracji wtyczki.
Należy pamiętać że polecenia powłoki wymagające akcji użytkownika (np. polecenie passwd) lub korzystające z interfejsu 'ncurses' itp. (np. polecenie top) nie będą prawidłowo działać z tą wtyczką.
Aby dokonać konfiguracji wtyczki „Polecenie wstawiania Kate” należy otworzyć okno konfiguracyjne programu za pomocą menu -> oraz wybranie pozycji +Wstaw polecenie .
Dostępne są następujące opcje konfiguracyjne:
Wartość jest przedstawiona w polu numerycznym pozwalającym na określenie liczby zapamiętywanych poleceń. Dopuszczalne są wartości z przedziału od 0 do 99. Wartością domyślną jest 20.
To ustawienie zawiera zestaw przycisków opcji pozwalających na określenie, który katalog będzie roboczym katalogiem dla wykonywanego polecenia. Do wyboru są następujące opcje: Katalog roboczy programu Kate (zwykle jest to katalog domowy użytkownika); Katalog dokumentu (jeżeli istnieje i jest dostępny, w przeciwnym wypadku użyty zostanie poprzednie katalog); Ostatnio używany katalog roboczy, w którym uruchomiane były polecenia.
Would you like to make a comment or contribute an update to this page?
Send feedback to the KDE Docs Team
Wtyczka „Polecenie wstawiania do Kate”. Prawa autorskie do programu (c) 2001 Anders Lund (anders AT alweb.dk).
Prawa autorskie do dokumentacji (c) 2001 Anders Lund (anders AT alweb.dk)
Krzysztof Woźniak (wozniakk AT ceti.pl)
Ten program jest rozprowadzany na zasadach Licencji GNU General Public License.
Would you like to make a comment or contribute an update to this page?
Send feedback to the KDE Docs Team
Would you like to make a comment or contribute an update to this page?
Send feedback to the KDE Docs Team
Wtyczka otwiera okno dialogowe, w którym należy wprowadzić nazwę znacznika HTML. Parametry, które występują w znaczniku otwierającym należy wpisywać tak: nazwa-parametru="wartość"
Wtyczka „Narzędzia HTML do Kate”. Prawa autorskie do programu (c) 2002 Joseph Wenninger (kde AT jowenn.at).
Prawa autorskie do dokumentacji (c) 2005 Francis Giannaros
Krzysztof Woźniak (wozniakk AT ceti.pl)
Ten program jest rozprowadzany na zasadach Licencji GNU General Public License.
Would you like to make a comment or contribute an update to this page?
Send feedback to the KDE Docs Team
Would you like to make a comment or contribute an update to this page?
Send feedback to the KDE Docs Team
Wtyczka Kate „Otwarcie pliku nagłówkowego” w chwili obecnej nie posiada dokumentacji. Jeżeli jesteś zainteresowany/a poprawieniem tej sytuacji proszę się skontaktować z Lauri Watts (lauri AT kde.org) która jest koordynatorem zespołu odpowiedzialnego za dokumentację dla środowiska KDE.
Would you like to make a comment or contribute an update to this page?
Send feedback to the KDE Docs Team
Wtyczka Kate „Filtr tekstu” w chwili obecnej nie posiada dokumentacji. Jeżeli jesteś zainteresowany/a poprawieniem tej sytuacji proszę się skontaktować z Lauri Watts (lauri AT kde.org) która jest koordynatorem zespołu odpowiedzialnego za dokumentację dla środowiska KDE.
Would you like to make a comment or contribute an update to this page?
Send feedback to the KDE Docs Team
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 ->.
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.
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.
Wyświetla listę ostatnio wykorzystywanych szablonów podając ich adres URL.
Otwiera menu podrzędne zawierające listę szablonów. Kliknięcie na wybranej pozycji tworzy plik na podstawie odpowiadającego jej szablonu.
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.
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.
Would you like to make a comment or contribute an update to this page?
Send feedback to the KDE Docs Team
Aby utworzyć nowy szablon, wybierz z menu ->, co spowoduje otworzenie okna zarządzania szablonami. W tym oknie, naciśnij przycisk , 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.
Would you like to make a comment or contribute an update to this page?
Send feedback to the KDE Docs Team
Aby zmienić szablon, wybierz z menu ->. Następnie wybierz szablon, który chcesz zmienić i naciśnij przycisk , 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ć.
Would you like to make a comment or contribute an update to this page?
Send feedback to the KDE Docs Team
Jeżeli otwierane są pliki z rozszerzeniem katetemplate to są one przetwarzane w poszukiwaniu informacji o szablonie, makro poleceniach i pozycji kursora.
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:
TemplateNazwa szablonu, która będzie wyświetlana jako pozycja w menu ->.
GroupNazwa grupy tematycznej wykorzystywana do grupowania listy szablonów w menu ->.
NameDefiniuje 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.
HighlightTen 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 ->.
DescriptionKró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.
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.
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:
Wprowadza bieżący czas w formacie zdefiniowanym przez ustawienia lokalne.
Wprowadza do dokumentu bieżącą datę w zapisie krótkim.
Wprowadza bieżącą datę i czas jako napis sformatowany zgodnie z ustawieniami lokalnymi.
Wprowadza bieżący rok w postaci 4 cyfr.
Pełna nazwa bieżącego miesiąca, zgodna z ustawieniami lokalnymi systemu.
Wprowadza bieżący dzień miesiąca.
Wprowadza nazwę komputera zdefiniowaną w zmiennej środowiskowej: 'hostname'.
Wprowadza znak 'i'.
Wstawia imię i nazwisko zalogowanego użytkownika, zdefiniowany w książce adresowej środowiska KDE.
Wstawia imię zalogowanego użytkownika, zdefiniowany w książce adresowej środowiska KDE.
Wstawia nazwisko zalogowanego użytkownika, zdefiniowany w książce adresowej środowiska KDE.
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.
Would you like to make a comment or contribute an update to this page?
Send feedback to the KDE Docs Team
Wtyczka „Szablony plików Kate” - prawa autorskie (c) 2004 Anders Lund (anders AT alweb.dk).
Prawa autorskie do dokumentacji (c) 2004 Anders Lund
Krzysztof Woźniak (wozniakk AT ceti.pl)
Ten program jest rozprowadzany na zasadach Licencji GNU General Public License.
Would you like to make a comment or contribute an update to this page?
Send feedback to the KDE Docs Team
Would you like to make a comment or contribute an update to this page?
Send feedback to the KDE Docs Team
Dokumentacja poszczególnych wtyczek zawiera informacje o prawach autorskich do nich.
Ta dokumentacja jest rozprowadzana na zasadach Licencji GNU Free Documentation License.
Ten program jest rozprowadzany na zasadach Licencji GNU General Public License.
Would you like to make a comment or contribute an update to this page?
Send feedback to the KDE Docs Team
Would you like to make a comment or contribute an update to this page?
Send feedback to the KDE Docs Team
Would you like to make a comment or contribute an update to this page?
Send feedback to the KDE Docs Team