Tworzenie pliku instalacyjnego
Transkrypt
Tworzenie pliku instalacyjnego
Pomoc Tworzenie pliku instalacyjnego Zmieniony 19.06.2007. 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:: - 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" ?> http://www.pomoc.joomla.pl Kreator PDF Utworzono 7 March, 2017, 06:35 Pomoc I ten również (wyraz bÅ‚Ä…d przed prologiem: bÅ‚Ä…d<?xml version="1.0" encoding="iso-8859-1" ?> - 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> - 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> - 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> - Wszystkie atrybuty muszÄ… być zamkniÄ™te znakami cudzysÅ‚owia lub apostrofu. PrzykÅ‚adowo nastÄ™pujÄ…cy zapis je 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> - 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"> - 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&task=bar"> Sub < menu 1</menu> - 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[© 2004 Me]]></copyright> Poniżej jest kilka narzÄ™dzi, z których możesz skorzystać, aby sprawdzić, czy plik XML jest poprawny. JednÄ… z meto 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: file:///C:/My%20Documents/test.xml Line Number 4, Column 3: </mosinstall> http://www.pomoc.joomla.pl Kreator PDF Utworzono 7 March, 2017, 06:35