Plik templateDetails.xml – własny szablon Joomla! 1.7 i 2.5

Ostatnio przygotowaliśmy sobie szkielet naszej nowej witryny. Dzisiaj już ostatnia, z koniecznych części, które pozwolą nam uruchomić swój własny szablon pod systemem Joomla! 1.7. Jeżeli zakończymy naszą naukę na tej lekcji, strona będzie działać poprawnie. W kolejnych częściach, pokazywać będę już tylko usprawnienia, które jedynie pomogą pracować nam bardziej wydajnie. Zapraszam do lektury.

Czym jest plik templateDetails? Otóż dzięki niemu Joomla! otrzymuje informacje o wszystkich szczegółach dot. szablonu. Plik jest wykorzystywany głównie przy instalacji. Zawarta w nim lista integralnych plików szablonu musi być zgodna z rzeczywistością. Każdy błąd, każda literówka spowodować może problem w działaniu. Znajdują się tutaj również informacje o autorze, jak i rzecz najważniejsza – z podstawowych – zapis wszystkich pozycji modułów, które będziemy mogli później wykorzystać.

Najbardziej okrojona wersja omawianego pliku składa się z 4 głównych części. Omówię teraz wszystkie po kolei.

Informacje systemowe

Tutaj ustalamy wersję, oraz kodowanie naszego dokumentu XML. Druga linijka mówi, z jakiego DOCTYPE będziemy korzystać – tutaj oczywiście dla Joomla! 1.7. Dalej otwieramy sekcję rozszerzenia.

Pierwszy parametr – version – ustala to, dla jakiej wersji Joomla! przygotowujemy szablon.
Type, ustawione jako template, oczywiście określa rozszerzenie jako szablon.
Client – czyli informacja o przeznaczeniu szablonu dla zaplecza administracyjnego lub frontu witryny.

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE install PUBLIC "-//Joomla! 1.7//DTD template 1.0//EN" "http://www.joomla.org/xml/dtd/1.7/template-install.dtd">
<extension version="1.7" type="template" client="site">

<?xml version="1.0" encoding="utf-8"?>

<!DOCTYPE install PUBLIC "-//Joomla! 1.7//DTD template 1.0//EN" "http://www.joomla.org/xml/dtd/1.7/template-install.dtd">

Informacje szczegółowe

Blok ten zawiera wszystkie potrzebne informacje, które widział będzie użytkownik naszego szablonu. W odpowiedniej kolejności są nimi:

Nazwa szablonu
Data stworzenia
Autor projektu
Adres e-mail autora
Strona www autora
Informacja o prawach autorskich
Rodzaj licencji, na zasadzie której udostępniamy szablon
Wersja
Opis

Możemy tutaj wpisać informacje, które nam odpowiadają. Dobrze jednak trzymać się obowiązujących reguł i dokładnie opisywać każdą rubrykę. Nigdy nie wiadomo, kto zajrzy do kodu.

<name>Szablon Joomla BLOG</name>
<creationDate>31-10-2011</creationDate>
<author>Michał Kortas</author>
<authorEmail>michal@kortas.info</authorEmail>
<authorUrl>https://webroad.pl</authorUrl>
<copyright>(C) Joomla BLOG- 2011</copyright>
<license>Free</license>
<version>1.0.0</version>
<description>Szablon na potrzeby kursu Joomla BLOG</description>

<name>Szablon Joomla BLOG</name>

<author>Michał Kortas</author>

<authorEmail>michal@kortas.info</authorEmail>

<authorUrl>http://webroad.pl</authorUrl>

<copyright>(C) Joomla BLOG- 2011</copyright>

<description>Szablon na potrzeby kursu Joomla BLOG</description>

Pliki i katalogi składowe

W trzeciej sekcji musimy dokładnie określić to, co znajdzie się w paczce instalacyjnej. Dla plików, które znajdują się bezpośrednio w folderze instalacyjnym, używamy tagów <filename></filename>. Nazwy katalogów zagnieżdżonych wystarczy zapisać w tagach <folder></folder>.

Jak to rozumieć? Jeżeli posiadamy folder (o nazwie np. grafika) z plikami graficznymi użytymi w szablonie, nie musimy podawać nazw wszystkich plików wewnątrz niego. Wystarczy w w/w tagu <folder></folder> podać jego nazwę. W porównaniu z zasadami budowania szablonów dla Joomla! 1.5 jest to spore udogodnienie.

Wszystkie ścieżki i nazwy plików obejmujemy w tagi <files></files>.

<files>
<folder>css</folder>
<folder>grafika</folder>
<filename>index.php</filename>
<filename>templateDetails.xml</filename>
<filename>template_preview.png</filename>
<filename>template_thumbnail.png</filename>
<filename>favicon.ico</filename>
</files>

<files>

<folder>grafika</folder>

<filename>index.php</filename>

<filename>templateDetails.xml</filename>

<filename>template_preview.png</filename>

<filename>template_thumbnail.png</filename>

<filename>favicon.ico</filename>

</files>

Pozycje modułów

Ostatnia, podstawowa, a zarazem bardzo ważna część pliku templateDetails. Jak na pewno dobrze pamiętamy, na poprzedniej lekcji zapisaliśmy sobie pozycje takie jak: naglowek, lewa, prawa i stopka. Teraz wystarczy, że zadeklarujemy je w odpowiedni sposób, używając tagów <position></position>.

Cały segment otaczamy tagami <positions></positions>, a na końcu zamykamy, otwarty wcześniej tag </extension>.

<positions>
<position>naglowek</position>
<position>lewa</position>
<position>prawa</position>
<position>stopka</position>
</positions>
</extension>

<position>naglowek</position>

<position>prawa</position>

<position>stopka</position>

</positions>

</extension>

Na zakończenie przedstawiam jeszcze cały, połączony listing kodu. Gotowy i zapisany plik dołączamy do naszego folderu.

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE install PUBLIC "-//Joomla! 1.7//DTD template 1.0//EN" "http://www.joomla.org/xml/dtd/1.7/template-install.dtd">

<extension version="1.7" type="template" client="site">

<name>Szablon Joomla BLOG</name>
<creationDate>31-10-2011</creationDate>
<author>Michał Kortas</author>
<authorEmail>michal@kortas.info</authorEmail>
<authorUrl>https://webroad.pl</authorUrl>
<copyright>(C) Joomla BLOG- 2011</copyright>
<license>Free</license>
<version>1.0.0</version>
<description>Szablon na potrzeby kursu Joomla BLOG</description>

<files>
<folder>css</folder>
<folder>grafika</folder>
<filename>index.php</filename>
<filename>templateDetails.xml</filename>
<filename>template_preview.png</filename>
<filename>template_thumbnail.png</filename>
<filename>favicon.ico</filename>
</files>

<positions>
<position>naglowek</position>
<position>lewa</position>
<position>prawa</position>
<position>stopka</position>
</positions>

</extension>