<para>&ksplash; wyświetla ekran powitalny pokazujący postęp uruchamiania programów środowiska &kde;. Wszelkie problemy i zgłaszanie nowych możliwości powinny być kierowane na listy mailingowe &kde;. Najważniejsze cechy programu &ksplash;: </para>
<para>Niniejszy podręcznik zawiera opis procedury tworzenia własnych tematów dla dostępnych w systemie wtyczek. Jeżeli żadna z dostępnych wtyczek nie zaspokaja potrzeb użytkownika, to możliwe jest stworzenie w języku C++ własnej wtyczki tak aby działanie &ksplash; w pełni odpowiadało jego gustom. </para>
<para>Aby skorzystać z tematów pobranych ze stron <ulink url="http://www.kde-look.org">KDE-Look</ulink>, należy je rozpakować do katalogu: <filename>~/.trinity/share/apps/ksplash/Themes/</filename> dla pojedynczego użytkownika, lub do katalogu <filename>$<envar>TDEDIR</envar>/share/apps/ksplash/Themes/</filename> co udostępni go dla wszystkich użytkowników systemu.</para>
<para>Automatyczne wykonanie tych czynności możliwa jest w module <guilabel>Ekran powitalny</guilabel> w menu <guilabel>Wygląd i motywy</guilabel> w centrum sterowania &kde;.</para>
<para>Moduł ten pozwala na instalację, testowanie i usuwanie tematów &ksplash;.</para>
<para>W dolnej części oka modułu, wyświetlona zostanie lista dostępnych tematów dla &ksplash;. Po wybraniu pozycji z listy, w głównej części okna wyświetlony zostanie podgląd tematu. Jeżeli wybrany już zostanie żadana pozycja, należy nacisnąć przycisk <guibutton>OK</guibutton> lub <guibutton>Zastosuj</guibutton>. Naciśnięcie <guibutton>Anuluj</guibutton> spowoduje zamknięcie okna bez akceptacji zmian, zaś naciśnięcie przycisku <guibutton>Domyślne</guibutton> przywróci standardowe ustawienia systemowe dla ekranu powitalnego.</para>
<para>Instalacja nowych tematów możliwa jest za pomocą przycisku <guibutton>Dodaj...</guibutton>. Pojawi się okno wyboru pliku, w którym odszukujemy pobrany plik tematu. Nie trzeba go wcześniej rozpakowywać. Instalacja nowego tematu nie spowoduje jego automatycznej aktywacji, aby tego dokonać należy nacisnąć przycisk <guibutton>OK</guibutton> lub <guibutton>Zastosuj</guibutton>.</para>
<para>Chociaż podgląd wybranego tematu jest widoczny w oknie konfiguracji tematów, to możliwy jest także podgląd działania tematu "na żywo" wraz z animacjami itp. Można go uruchomić wybierając temat z listy i naciskając przycisk<guibutton>Testuj</guibutton>,</para>
<para>Możliwe jest usuwanie niewykorzystywanych tematów za pomocą przycisku <guibutton>Usuń</guibutton>. Należy jednak pamiętać, iż zalogowany użytkownik może nie mieć uprawnień do usuwania tematów systemowych, dostępnych dla pozostałych użytkowników. Zaleca się również zachowanie tematu <guilabel>Domyślnego</guilabel>.</para>
<para>Utworzenie własnego tematu dla &ksplash; jest proste. Zachęcamy wszystkich użytkowników do przesyłania własnych tematów do <ulink url="http://www.kde-look.org">KDE-Look</ulink> aby inni mogli z nich również skorzystać.</para>
<para>Użytkownik chcący stworzyć temat o nazwie <literal>MojFajnyTemat</literal> musi umieścić go w katalogu <filename class="directory">MojFajnyTemat</filename> znajdującym się w katalogu <filename class="directory">~/.trinity/apps/ksplash/Themes/</filename>, tylko wtedy &ksplash; będzie mógł z niego korzystać. W katalogu powinien zostać utworzony plik <filename>Theme.rc</filename> zawierający ustawienia konfiguracyjne tematu. Dostępnych jest bardzo dużo opcji konfigurujących zachowanie tematu, rodzaj wykorzystywanej wtyczki, itp. Nie trzeba jednak ustawiać każdej dostępnej opcji, zwykle mają one pewne wartości domyślne. Zasady wprowadzania parametrów w pliku <filename>Theme.rc</filename> mają prostą postać: <literal>[opcja] = [wartość]</literal>. Poniżej opisane zostaną dostępne opcje konfiguracyjne tematów.</para>
<para>Po wprowadzeniu nazwy, opisu i autora tematu, należy wybrać silnik tematu (nazywany także wtyczką). Następnie należy określić parametry specyficzne dla tego silnika, poprzez wprowadzenie par klucz-wartość podobnie jak w przykładzie pokazanym powyżej.</para>
<para>Należy się upewnić czy katalog zawierający pliki tematu(<filename class="directory">~/.trinity/apps/ksplash/Themes/MojFajnyTemat</filename> w omawianym przykładzie) oraz jego identyfikator tematu (tutaj: <literal>[KSplash Theme: MojFajnyTemat]</literal>) w pliku <filename>Theme.rc</filename> są identyczne. W przeciwnym wypadku &ksplash; nie rozpozna tego tematu.</para>
<para>Podczas uruchamiania &ksplash; próbuje odnaleźć plik tła (jeżeli dana wtyczka go wymaga) dla bieżącej rozdzielczości ekranu. Nazwa pliku tła powinna być następująca: <filename>Background-<replaceable>WWWxHHH</replaceable>.png</filename>.</para>
<para>Przykładowo plik może nosić nazwę: <filename>Background-1024x768</filename>. Jeżeli program nie odnajdzie pliku tła o rozmiarach zgodnych z bieżącą rozdzielczością ekranu, nastąpi wtedy próba zmiany rozmiaru pliku oryginalnego tzn. <filename>Background.png</filename> lub pliku podanego w definicji tematu: <filename>Theme.rc</filename> i dopasowanie do bieżącej rozdzielczości. Taka zmiana zajmuje trochę czasu, dlatego też należy przygotować pliki tła dla najczęściej występujących rozdzielczości ekranu tzn: 1280x1024, 1024x768 oraz 800x600.</para>
<para>W tym rozdziale opisany jest sposób wykorzystania &ksplash; w programach tworzonych przez użytkownika. Jeżeli czytelnik nie tworzy programów dla środowiska &kde;, to może pominąć tą część.</para>
<para>Tworzona aplikacja &kde; musi wykorzystywać mechanizm &DCOP; tzn. technologię komunikacji pomiędzy programami w środowisku &kde;. W przypadku wykorzystania <ulink url="http://developer.kde.org">szkieletu aplikacji &kde;</ulink> dzieje się to automatycznie. Więcej informacji dotyczących &DCOP; i innych technologii środowiska &kde; dostępnych jest na stronach <ulink url="http://developer.kde.org">dla programistów i twórców &kde;</ulink>.</para>
<para>Zanim program użytkownika rozpocznie pracę obciążającą procesor lub przed rozpoczęciem jej ładowania itp. należy wywołać &ksplash; w sposób następujący:</para>
<para>W przykładzie przyjęto założenie, iż uruchomione zostało tylko jedno wystąpienie programu &ksplash;. Inne przypadki są bardziej złożone, a ich opis dostępny jest w dokumentacji mechanizmu &DCOP;.</para>
<para>Zanim wyświetlone zostaną jakiekolwiek komunikaty, należy określić ilość wyświetlanych etapów (kroków) uruchamiania. Na przykład procedura uruchamiania środowiska &kde; zawiera 7 kroków.</para>
<para>Każde wywołanie funkcji <constant>programStarted</constant>, zwiększa licznik kroków uruchamiania. Jeżeli program skończy się uruchamiać to poniższy kod zamyka ekran powitalny:</para>
<para>Tworzenie nowych wtyczek dla programu &ksplash; jest stosunkowo proste. W tym rozdziale, pokazana zostanie procedura tworzenia prostej wtyczki, która będzie naśladować ekran powitalny pewnego dobrze znanego systemu operacyjnego. Dla zrozumienia zawartości tego rozdziału użytkownik powinien znać podstawy języka C++ oraz zasady budowy aplikacji dla KDE/Qt.</para>
<para>Utworzona zostanie wtyczka o nazwie <literal>2k</literal>. Nazwa wtyczki wykorzystywana jest w wielu różnych miejscach, i ważne jest aby była konsekwentnie używana aby mogła zostać rozpoznana przez &ksplash;. Wtyczki &ksplash; są dynamicznie ładowanymi bibliotekami, których powinny być nazwane zgodnie z poniższą konwencją: </para>
<member>Biblioteka powinna mieś nazwę <filename>ksplash+nazwa_wtyczki_małymi_literami</filename>. W opisywanym przykładzie, będzie to nazwa <filename>ksplash2k</filename>.</member>
<member>Oprócz biblioteki, powinien istnieć odpowiadający jej plik desktop o nazwie <filename>ksplash+nazwa_wtyczki_małymi_literami.desktop</filename>. W opisywanym przykładzie, będzie to <filename>ksplash2k.desktop</filename>. </member>
<member>Obiekt zwracanym przez bibliotekę, powinien być klasą o nazwie <literal>Theme+nazwa_tematu</literal>. Tutaj będzie to <literal>Theme2k</literal>.</member>
<para>Jeżeli powyższe informacje wydają się niezrozumiałe, to nie należy się tym martwić. W dalszej części zostanie przedstawione więcej szczegółów na ten temat. Kolejnym istotnym wymaganiem jest to, aby klasa nowej wtyczki była potomna wobec klasy <literal>ThemeEngine</literal>. </para>
<para>Ponieważ wykorzystany zostanie standardowy szablon aplikacji &kde;, nie będzie konieczne tworzenie kodu uzależnionego od platformy sprzętowej, na której program będzie uruchamiany. Aby skorzystać z szablonu należy zainstalować pakiet <filename>tdesdk</filename>. Utworzenie szkieletu programu sprowadza się do uruchomienie polecenia <literal>kapptemplate</literal>, które utworzy główny katalog programu "2k" wraz z pewnymi typowymi plikami jak np. AUTHORS, itp. Najważniejsza część programu znajdzie się w podkatalogu <filename class="directory">2k</filename>. Należy przejść do niego oraz wykasować wszystkie znajdujące się tam pliki. W tym momencie szkielet aplikacji jest już gotowy. </para>
<para>Następnym krokiem jest utworzenie pliku <filename>.desktop</filename>, którego celem jest informowanie programu &ksplash; o dostępności tworzonej wtyczki. Należy stosować konsekwencję nazywania plików opisaną w <link linkend="basic-requirements">poprzedniej części</link> i utworzyć plik o nazwie <filename>ksplash2k.desktop</filename> w odpowiednim katalogu. Powinien mieć on następującą zawartość: </para>
<para>Parametry <literal>Encoding</literal>, <literal>Type</literal>, <literal>Comment</literal> oraz <literal>ServiceTypes</literal> są takie same jak we wszystkich innych wtyczkach. Nazwa wtyczki i nazwa biblioteki musi być zgodna z omawianą wcześniej konwencją nazewniczą. Parametr <literal>X-KSplash-Default</literal> zawiera wartość true lub false (prawda lub fałsz) określając czy wtyczka będzie widoczna w oknie modułu konfiguracji wtyczek. Poza bardzo wyjątkowymi sytuacjami, parametr ten powinien mieć wartość <constant>true</constant>. </para>
<para>Po zakończeniu prac przygotowawczych, należy przejść do najciekawszej części - stworzenia klasy z programem określającym wymagane przez użytkownika zachowanie. Mimo tego, iż użytkownik może nakazać programowi wykonanie dowolnych czynności, to powinien pamiętać o kilku ograniczeniach.</para>
<listitem><para>Klasa Plugin musi dziedziczyć klasę <constant>ThemeEngine</constant>.</para></listitem>
<listitem><para>Wtyczka musi być nazwana zgodnie z zasadą: <classname>Theme+Nazwa_Wtyczki</classname>.</para></listitem>
<listitem><para>Klasa powinna zawierać definicję statycznej funkcji typu o nazwie <function>names</function> zwracającej listę nazw używanych do uruchamiania wtyczki.</para></listitem>
<listitem><para>Jeżeli wtyczka ma być konfigurowana w module centrum sterowania, to kod programu powinien zawierać zdefiniowaną klasę bazującą na klasie <literal>ThemeEngineConfig</literal> umożliwiającą konfigurację wtyczki.</para></listitem>
<listitem><para>Aby wtyczka mogła funkcjonować, to jej klasa musi zawierać definicję - zastąpienie - co najmniej jednej z następujących funkcji wirtualnych: <function>slotSetText</function>, <function>slotSetPixmap</function>, <function>slotUpdateProgress</function> lub <function>slotUpdateSteps</function>.</para></listitem>
<listitem><para>Konstruktor powinien być następujący <literal>ThemeEngine( QWidget *parent, const char *name, const QStringList &args )</literal> tak aby mógł być wykorzystany przez klasę <classname>KGenericFactory</classname>.</para></listitem>
<para>Ostatnie wymaganie może wydawać się skomplikowane, jednak jak okaże się to poniżej, poprzez dodanie jednego wiersza to kodu programu, można go praktycznie zignorować.</para>
<para>Analizując zawartość powyższego kodu programu zauważyć można następujące elementy. Klasa <classname>Theme2k</classname> została nazwana zgodnie z omawianą wcześniej konwencją nazewniczą, jest potomna względem klasy <classname>ThemeEngine</classname>. Zawiera ona metodę <methodname>Theme2k::names()</methodname> oraz konstruktor obsługujący wymagane parametry wtyczki: <function>Theme2k( QWidget *, const char *, const QStringList& );</function> dodatkowo zdefiniowana została metoda <methodname>Theme2k::slotSetText()</methodname>.Na razie nie należy zwracać uwagi na klasę <classname>RotWidget</classname>, która udostępnia obsługę miłych dla oka elementów interfejsu użytkownika. Omawiana w przykładzie wtyczka jest bardzo prosta, nie wyświetla ona żadnych ikon czy też paska postępu. Jeżeli użytkownik chciałby wyświetlać ikony, to powinien zdefiniować funkcję <function>slotSetPixmap</function>. Istnieją również funkcje określające rozmiar - ilość kroków - paska postępu (<function>slotUpdateSteps</function>) oraz zwiększające pozycję na pasku (<function>slotUpdateProgress</function>) o jeden krok. </para>
<para>Omówione zostały tylko najważniejsze części implementacji. Pełny kod programu dostępny jest w załączniku. Pierwszą częścią jest zadeklarowanie wymaganych bibliotek:</para>
<para>Makro <constant>K_EXPORT_COMPONENT_FACTORY</constant> jest zdefiniowane w pliku <filename>kgenericfactory.h</filename>. Kontynuując, ponieważ jest to bardzo prosta wtyczka, to konstruktor klasy jest bardzo prosty.</para>
<para>Metoda <function>readSettings()</function> pokazuje właściwy sposób odczytywania ustawień tematu. (Jest to niezbędne gdy chcemy aby inni użytkownicy korzystali z tworzonej wtyczki przy tworzeniu własnych tematów)</para>
<para>Ponieważ należy dbać o użytkownika, ważne jest aby dopasować rozsądne wartości domyślne dla parametrów nie zdefiniowanych w pliku tematu. Należy pamiętać, aby zawsze ustawić grupę na "KSplash Theme: nazwa_tematu" aby zachować zgodność z przyszłymi możliwymi specyfikacjami tematów. Metoda <function>initUI()</function> nie jest zbyt interesująca, ponieważ jedynie tworzy elementy kontrolne interfejsu użytkownika. Więcej na ten temat w załączniku. </para>
<para>Ponieważ do kompilacji wtyczki wykorzystywane jest środowisko programistyczne &kde; to niezbędne jest utworzenie pliku <filename>Makefile.am</filename>. Powinien on wyglądać tak:</para>
<para>Więcej informacji dotyczących tworzenia plików <filename>Makefile.am</filename> dla programów środowiska &kde; znajduje się na <ulink url="http://developer.kde.org/documentation/other/makefile_am_howto.html"> stronach</ulink> deweloperów &kde;. Jedyną rzeczą o której należy pamiętać jest utworzenie domyślnego tematu bazującego na utworzonej wtyczce wraz z odpowiednim obrazkiem podglądu. W dobrym tonie jest również przygotowanie przykładowego pliku <filename>Theme.rc</filename> zawierającego komentarze ilustrujące działanie różnorodnych opcji konfiguracyjnych.</para>
<para>Prawdopodobnie nie zainstalowano właściwych wtyczek. Są one dostępne w pakiecie <literal>kde-artwork</literal>. Należy go pobrać, zainstalować i spróbować ponownie.</para>
<para>Plik <filename>Theme.rc</filename> zawiera ustawienia tematu. Więcej informacji dotyczących konfiguracji tematów zawiera część <link linkend="themes">Tworzenie tematów dla &ksplash;</link>. </para>
<para>Do poprawnego działania &ksplash; wymagane jest środowieko &kde; w wersji 3.2 lub wyższej. Niektóre tematy mogą wymagać specjalnych wtyczek, jeżeli dany temat nie działa, to należy się skontaktować z jego autorem i zorientować się gdzie można pozyskać właściwą wtyczkę.</para>
