Joomla!WikiPL

Plik templateDetails.xml jest zawsze umieszczony w macierzystym katalogu szablonu. Przykładowo, pełna ścieżka do tego pliku w szablonie Beez wygląda tak: [sciezka_do_Joomla]/templates/beez/templateDetails.xml. Uwaga: W systemach *NIX wielkość znaków w nazwach katalogów i plików ma znaczenie - druga część nazwy pliku pisana jest wielką literą.

Plik templateDetails.xml można modyfikować w dowolnym edytorze tekstu, edytorze HTML czy XML (ale raczej nie w procesorach typu MS Word czy OpenOffice - w takich przypadkach należy je zapisywać w formacie .txt!; odradzamy też wykorzystywanie do tego celu Notatnika z systemu Windows - ten edytor umieszcza na początku pliku znacznik BOM, ktory może powodować problemy z odczytywaniem takich plików.)

Sekcja <params> umieszczona jest zwykle jako jedna z ostatnich w pliku. Jeśli nie ma takiej sekcji, można ją dodać. Musi być umieszczona przed kończącym dokument znacznikiem </install>. Nie zapomnij o znaczniku zamykającym </params>. Uwaga: W Joomla 1.6 znacznik <install> zostanie wycofany, zastąpi go znacznik <extension>.

• Zapoznaj się z podstawowym plikiem templateDetails.xml oraz wprowadzeniem o tworzeniu pliku templateDetails.xml
• Zapoznaj się ze specyfikacją templateDetails.xml i szczegółami specyfikacji tego pliku

Dla każdego parametru, jaki chcesz zdefiniować, dodajemy element <param>. Element może zawierać kilka wymaganych bądź nieobowiązkowych argumentów zależnie od typu parametru. Obowiązkowym jest w gruncie rzeczy tylko argument type, ale argumenty name, default, description oraz label są wspólne dla większości parametrów, a name jest obowiązkowy zawsze, jeśli występuje którykolwiek z nich.

Oto obowiązkowe/powszechne argumenty:

• type – określa rodzaj kontrolki HTML umożliwiającej wybór opcji w edytorze własności szablonu na zapleczu w sekcji Parametry szablonu (pole tekstowe: text, przycisk opcji: radio, lista lub pole wyboru: list)
• name – jednoznaczne, niepowtarzalne oznaczenie - nazwa parametru, dowolna, zdefiniowana w kodzie szablonu;do tej nazwy odwołuje się kod Joomla!.

Poniższe argumenty są opcjonalne, ale wspólne dla prawie wszystkich typów parametrów:

• default – domyślne ustawienie parametru.
• description – opis, instrukcja dla użytkownika, wyświetlana jako wskazówka w dymku na stronie edytora szablonu w sekcji Parametry szablonu. Może być napisem tłumaczonym; zapoznaj się z Lokalizacja szablonu, aby uzyskać więcej informacji o tym, jak dodać tłumaczenie tego napisu.
• label - treść etykiety, tytuł opisujący pole parametru na stronie edytora szablonu w sekcji Parametry szablonu. Może być napisem tłumaczonym; zapoznaj się z Lokalizacja szablonu, aby uzyskać więcej informacji o tym, jak dodać tłumaczenie tego napisu. Jeśli etykieta zostanie pominięta, w jej roli zostanie wykorzystana wartość argumentu name.

Element param może zawierać opcje wyboru – elementy option, każdy z argumentem value – wartością wyrażoną liczbą albo nazwą – zależnie od deklaracji zmiennych zastosowanych w kodzie szablonu.

Argumenty nieobowiązkowe zależą od typu parametru. Każdy typ parametru jest szczegółowo opisany w artykule Standardowe typy parametrów. Jeśli jesteś projektantem, możesz stworzy swoje własne typy parametrów; zapoznaj się z Tworzenie własnych typów parametrów szablonu, aby uzyskać więcej informacji.

Na przykład w poniższym fragmencie kodu widać sekcję <params> definiującą dwa parametry - jeden to lista rozwijana z wariantami kolorystycznymi szablonu, a drugi to pola opcji, umożliwiające decyzję, czy wyświetlać notę o autorstwie i prawach własności szablonu.

Parametry szablonu umożliwiają przesyłanie zmiennych konfigurujących szablon. Element <params> zawiera podelementy dla każdego parametru, który można ustawić w szablonie. Administrator witryny może zmieniać wartości parametrów w sekcji Parametry szablonu na stronie Rozszerzenia -> Szablony -> [nazwa_szablonu] - > przycisk Zmień.

Na przykład, poniżej ustawiamy dwa parametry (Warianty kolorystyczne szablonu oraz Pokaż/Ukryj Autora i Prawa własności)

<params>
    <param name="templateColour" type="list" default="blue" 
            label="Template Colour" description="Choose the template colour.">
        <option value="blue">Blue</option>
        <option value="red">Red</option>
        <option value="green">Green</option>
        <option value="black">Black</option>
    </param>
    <param name="authorCopyright" type="radio" default="1" 
            label="Author Copyright" description="Show/Hide author copyright.">
        <option value="0">hide</option>
        <option value="1">show</option>
    </param>
</params>

Na stronie Rozszerzenia -> Szablony -> [szablon] - > [Zmień], którą teraz zobaczysz, sekcja "Parametry" będzie mieć dwa zdefiniowane przed chwilą ustawienia. Aby dowiedzieć się więcej, jak w pliku szablonu pobierać wartości parametrów, przeczytaj Pobieranie wartości parametrów w pliku szablonu

Sekcja Parametry szablonu na stronie zaplecza wygląda tak, jak na ilustracji poniżej.

Uwaga: Aktualnie szablony nie obsługują grupowania parametrów!

Wskazówka: Aby w pliku XML umieszczać znaczniki HTML, niektóre znaki specjalne muszą być kodowane, jak poniżej:

Znak	Opis - znaczenie	Kod
&	Ampersand	&
“	Podwójny apostrof	"
'	Pojedynczy apostrof	'
<	Mniejsze od	&lt;
>	Większe od	&gt;

Plik params.ini

Żeby parametry działały, w katalogu szablonu musi znajdować się plik params.ini udostępniony do zapisu. Ten plik jest wykorzystywany przez Joomla! do przechowywania ustawień parametrów. Może to być pusty plik, ale z prawami do zapisu, aby możliwe było zachowanie ustawień dokonanych przez administratorów.

Przykłady z pliku powyżej wyglądać tak, jak poniżej:

templateColor=blue
authorCopyright=1

Dziękujemy za wkład

» Stefan Wajda [zwiastun],