Funkcje pliku templateDetails.xml

Plik templateDetails.xml do instalacji i konfiguracji szablonu.

Plik templateDetails.xml integruje szablon z Joomla!, przechowuje dane o szablonie oraz instrukcje instalacyjne i konfiguracyjne, jest wykorzystywany przez komponent zaplecza Instalator oraz Szablony.

W Joomla 1.0 plik templateDetails.xml:

• instruuje instalatora, gdzie i jakie pliki umieścić podczas instalacji,
• udostępnia szablon – umieszcza go na liście szablonów do wyboru,
• udostępnia administratorom witryny informacje o szablonie.

W Joomla 1.5 zwiększono konfiguracyjne funkcje pliku templateDetails.xml. Poza zadaniami wymienionymi powyżej plik ten:

• definiuje pozycje modułów,
• może definiować parametry i kontrolki umożliwiające ich ustawianie.

Plik templateDetails.xml jest skryptem napisanym w języku XML. Poniższe objaśnienia pomogą rozpoznawać różne sekcje pliku. Dla czytelności pliku każda sekcja jest wyróżniona graficznie, poprzez wcięcia, które jednak dla funkcji pliku nie mają żadnego znaczenia.

W strukturze pliku templateDetails.xml można wyszczególnić kilka sekcji, które zawierają:

• dane szablonu,
• katalogi i pliki szablonu,
• pliki językowe,
• pozycje modułów,
• parametry konfiguracyjne.

Podstawowe szczegóły

Na stronie startowej komponentu zaplecza Szablony wyświetlana jest lista zainstalowanych szablonów z kilkoma szczegółowymi informacjami o każdym nich. Informacji o szablonie pobierane są z pliku templateDetails.xml.

<install version="1.5" type="template">
    <name>rhuk_milkyway</name>
    <creationDate>11/20/06</creationDate>
    <author>Andy Miller</author>
    <authorEmail>rhuk@rockettheme.com.com</authorEmail>
    <authorUrl>http://www.rockettheme.com</authorUrl>
    <copyright></copyright>
    <license>GNU/GPL</license>
    <version>1.0.2</version>
    <description>TPL_RHUK_MILKYWAY</description>

Struktura katalogu

Wszystkie pliki szablonu są wyszczególnione. Każdy plik oznaczony jest pełną informacją o ścieżce rozpoczynającej się w początkowym katalogu szablonu. Informacje te wykorzystuje jedynie instalator szablonu podczas instalacji. Dla działania szablonu nie mają one znaczenia.

Niewielki fragment listy plików w szablonie rhuk_milkyway przedstawiamy poniżej.

    <files>
	<filename>index.php</filename>
	<filename>templateDetails.xml</filename>
	<filename>template_thumbnail.png</filename>
	<filename>params.ini</filename>
	<filename>images/arrow.png</filename>
	<filename>images/indent1.png</filename>
    <files>

Języki

Niektóre szablony mogą zawierać pliki językowe, umożliwiające tłumaczenie stałych umieszczonych w szablonie napisów - etykiet, komunikatów, nazw parametrów. W poniższym przykładzie zadeklarowane są dwa pliki językowe. Pierwszy odnosi się do napisów, które pojawią się na witrynie, a więc będą widoczne dla użytkowników. Drugi, umieszczony w znaczniku <administration>, zawiera etykiety i komunikaty ekranowe, jakie zobaczy administrator w edytorze własności szablonu.

    <languages>
	<language tag="en-GB">en-GB.tpl_beez.ini</language>
    </languages>
    <administration>
	<languages folder="admin">
	    <language tag="en-GB">en-GB.tpl_beez.ini</language>
	</languages>
    </administration>

Pozycje modułów

Możliwe do wykorzystania Pozycje modułów definiowane są następująco.

    <positions>
	<position>breadcrumb</position>
	<position>left</position>
	<position>right</position>
	<position>top</position>
	<position>user1</position>
	<position>user2</position>
	<position>user3</position>
	<position>user4</position>
	<position>footer</position>
	<position>debug</position>
	<position>syndicate</position>
    </positions>

Parametry

Szablon może oferować opcje wyświetlania, które ustawiamy (wybieramy) w edytorze właściwości szablonu. Na przykład szablon rhuk_milkyway umożliwia administratorom wybór wariantu kolorystycznego, ustalenie koloru tła, ustalenie szerokości szablonu.

Przykład dodawania parametru i jego wartości przedstawiamy poniżej:

    <params>
	<param name="colorVariation" type="list" default="white" label="Color Variation" description="Wariant kolorystyczny">
	    <option value="blue">Niebieski</option>
	    <option value="red">Czerwony</option>
	    <option value="green">Zielony</option>
	    <option value="orange">Pomarańczowy</option>
	    <option value="black">Czarny</option>
	    <option value="white">Biały</option>
	</param>
    </params>

Więcej informacji na temat wykorzystania parametrów:

Definiowanie parametrów w templateDetails.xml

Pobieranie wartości parametrów w pliku szablonu