UWAGA: Strona zawiera materiały archiwalne. Większość artykułów dotyczy Joomla! 1.0
Start arrow Programowanie arrow Pakiety instalacyjne arrow Tworzenie pliku instalacyjnego
Tworzenie pliku instalacyjnego Drukuj Email
Joomla! dysponuje wygodnym, jednym, wspólnym instalatorem modułów, botów, komponentów i szablonów. Korzystając z instalatora administrator witryny może dodawać do systemu nowe funkcje i szablony, wczytując skompresowane pliki. Ten rozdział objaśnia, jak tworzyć niezbędne dla instalatora pliki instalacyjne botów, modułów, komponentów i szablonów.

Plik instalacyjny XML

Podczas instalacji instalator wymaga pliku instalacyjnego zapisanego w formacie XML. Plik XML definiuje instrukcje dla instalatora, określa wykaz plików, które mają być zainstalowane, informacje o autorze, itd. Aby tworzyć pliki instalacyjne, wystarczy podstawowa znajomość XML.

Każdy plik XML rozpoczyna się od prologu:

<?xml version="1.0" encoding="iso-8859-1" ?>

Od tego miejsca wszystkie sekcje muszą być umieszczone w elemencie głównym, między znacznikami:

<mosinstall>
...... 
<mosinstall>

Element <mosinstall> zawiera co najmniej dwa atrybuty: "type", który określa typ instalowanego rozszerzenia, oraz "version", określa wersję Joomla!, dla której został opracowany ten składnik. Trzeci atrybut, nazwany "client" używany jest tylko dla elementów zaplecza administracyjnego.

<?xml version="1.0" encoding="iso-8859-1" ?>
 <mosinstall type="installtype" version="1.0.0">
 . . .
 </mosinstall>

Wspólne elementy XML dla wszystkich typów plików instalacyjnych wymienione są poniżej:

  • <name>. Nazwa. Element <name> jest konieczny. Jest używany w menu, itp.
  • <creationDate>. Data utworzenia pliku XML lub składnika. Format daty nie jest ustalony. Może to być dowolny ciąg znaków, data wyrażona cyframi, słownie, itp.
  • <Author>: Autor komponentu, modułu, szablonu lub bota.
  • <copyright>: Informacja o prawach własności.
  • <license>: Nazwa licencji, na jakiej składnik jest wydany.
  • <authore-mail>: Adres poczty elektronicznej autora.
  • <authorUrl>: Adres strony internetowej autora.
  • <version>: Wersja pakietu.
  • <description>: Opis komponentu, modułu, szablonu lub bota.
  • <files>: Element opcjonalny, ale jeśli nie zostanie umieszczony, żaden plik nie będzie zainstalowany. Sekcja <files> informuje instalatora, jakie pliki winny być zainstalowane. Nie ma tutaj żadnych ograniczeń co do ilości elementów <filename>. Zależnie od typu instalatora pliki są kopiowane do katalogów /modules, /components/[nazwa_komponentu], /mambots/[typ_bota/ lub /templates/[nazwa_szablonu].

Parametry

Pliki instalacyjne mogą posiadać blok definiujący parametry konfiguracyjne. Na przykład:

<params>
    <param name="count" type="text" default="5" label="Ilość pozycji"
     description="Wpisz, ile pozycji wyświetlać." />
    </params>

Poprawność XML

Wszystkie pliki XML muszą być bezwzględnie poprawne. Parser XML używany przez Joomla! nie przetworzy niepoprawnego dokumentu XML. Istnieje wiele reguł określających zasady konstruowania plików XML. Poniżej znajduje się lista najważniejszych::

  1. Plik XML nie może zawierać białych znaków (spacji, znaków tabulacji, znaków powrotu karetki, nowego wiersza) ani żadnego innego znaku przed prologiem XML. Przykładowo, poprawny jest następujący początek pliku:
    <?xml version="1.0" encoding="iso-8859-1" ?>

    Poniżej znajduje się przykład niepoprawny (spacja przed prologiem):
    <?xml version="1.0" encoding="iso-8859-1" ?>

    I ten również (wyraz ’błąd’ przed prologiem:
    błąd<?xml version="1.0" encoding="iso-8859-1" ?>
  2. Zawartość każdego elementu jest opisana specjalnymi kodami określanymi jako znaczniki początkowe i znaczniki końcowe. Konieczne jest zarówno wpisanie znacznika początkowego, jak i końcowego. Uwaga: W XML rozróżniana jest wielkość znaków - w znaczniku początkowym i końcowym musza być użyte dokladnie takie same znaki. Najlepiej konsekwentnie używać małych liter. Oto przykład poprawnego i niepoprawnego kodu:
    <PoPrawNe>To jest OK!</PoPrawNe>
    <niepoprawne>To jest błędny zapis</NIEPOPRAWNE>
  3. W elementach XML mogą być zagnieżdżone inne elementy. Niedopuszczalne jest jednak pomieszanie znaczników początkowego i końcowego różnych elementów. Oto niepoprawny zapis:
    <name>Moje <author>Jan</name></author>
  4. Poprawny dokument XML może zawierać tylko jeden element główny. Wszystkie inne elementy muszą być zagnieżdżone w elemencie głównym (czyli między jego znacznikiem początkowym i końcowym). Poniższy dokument jest niepoprawny, ponieważ zawiera dwa główne elementy:
    <?xml version="1.0" encoding="iso-8859-1"?>
     <mosinstall type="module">
     <!-- definicje XML  - ⇒ 
     </mosinstall>
     <mosinstall type="component">
     <!-- definicje XML  - ⇒ 
     </mosinstall>
  5. Wszystkie atrybuty muszą być zamknięte znakami cudzysłowia lub apostrofu. Przykładowo następujący zapis jest niedopuszczalny, ponieważ opuszczono cudzysłowy, jak to się zdarza w dokumentach HTML, w których brak cudzysłowów lub apostrofów jest tolerowany:
    <mosinstall type=module>
  6. Element nie może zawierać wielu atrybutów tego samego typu - tak samo nazwanych. Przykładowo, następujący zapis jest niepoprawny:
    <mosinstall type="module" type="component">
  7. W zawartości elementu (w obszarze danych) i w atrybutach nie można umieszczać znaku mniejszości (<), znaku ampersand (&) oraz ciągu znaków ]]>. Znak mniejszości (<) i znak ampersand (&) mogą być umieszczone tylko za pomocą odwołań do tzw. encji predefiniowanych. Na przykład:
    <menu="option=com_foo&amp;task=bar">
       Sub &lt; menu 1</menu>
  8. Używając znaczników HTML w danych elementu, należy umieścić je w sekcji CDATA. Poniższy przykład objaśnia, jak umieścić znak © w elemencie copyright:
    <?xml version="1.0" encoding="iso-8859-1"?>
     <mosinstall type="template">
       <name>How flung</name>
       <copyright><![CDATA[&copy; 2004 Me]]></copyright>

Poniżej jest kilka narzędzi, z których możesz skorzystać, aby sprawdzić, czy plik XML jest poprawny. Jedną z metod jest otwarcie pliku w nowszych przeglądarkach. Jeśli plik zostanie odczytany i wyświetlony w całości, to najprawdopodobniej jest poprawny. Zobaczysz np. coś takiego (zwykle znacznie więcej):

- <mosinstall type="template">
  <name>How flung</name>
<mosinstall>

Niepoprawny plik zostanie odczytany np. tak:

XML Parsing Error: mismatched tag. Expected </name>.
Location: <a href="http://www.php.net/file">file</a>:///C:/My%20Documents/test.xml
Line Number 4, Column 3:
 </mosinstall>
Zmieniony ( 19.06.2007. )
 
następny artykuł »