Die templateDetails.xml

  • Gelesen 55500 mal
Artikel bewerten
(15 Stimmen)

Hier erfahrt ihr mehr über das Multitalent templateDetails.xml und vor allem, wie ihr sie gezielt einsetzt um dein Joomla Template Problemlos in das Joomla-Backend zu installieren.

 

Unsere fertige Datei

Die Unterschiede der Joomla Versionen sind zwar gering, aber es gibt Sie. Auf dieser Seite im unteren Teil findest du nochmals die Änderungen im einzelnen.

Joomla 3.0

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE install PUBLIC "-//Joomla! 1.6//DTD template 1.0//EN" "http://www.joomla.org/xml/dtd/1.6/template-install.dtd"> 
<!-- MUSS Seit Joomla 1.6 ist der Installer universell. Also wichtig, version="2.5" type="template" client="site" angeben -->
<extension
	version="3.0"
	type="template"
	client="site"> 
  <!-- SOLLTE, Der Annzeige-Name in Joomla -->
  <name>test_template</name>
  <title>test_template</title>
  <!--SOLLTE Erstellungsdatum -->
  <creationDate>11.04.13</creationDate>
  <!-- SOLLTE, Wer ist der Urheber -->
  <author>Joomla-Templates</author>
  <!-- SOLLTE, für ausgelieferte Templates immer eine Kontakt-E-Mail-Adressse -->
  <authorEmail>info(at)joomla-templates.de</authorEmail>
  <!-- SOLLTE, klar, die Webseite gehört dazu -->
  <authorUrl>http://www.joomla-templates.de</authorUrl>
  <!-- SOLLTE, die eigene Versionsnummer des Templates -->
  <version>1.0.0</version>
  <!-- SOLLTE, Die Template-Beschreibung wird hier als Joomla language mit einem Platzhalter versehen. In diesem Template-Ordner befindet sich die Sprachdatei in der TPL_TEST_TEMPLATE_XML_DESCRIPTION hinterlegt ist -->
  <description>TPL_TEST_TEMPLATE_XML_DESCRIPTION</description>
  <!-- MUSS, der Files-Tag bezeichnet den Block mit den Dateien und Ordnern die mit installiert werden -->
  <files> 
    <!-- Der Folder-Tag weist Joomla an, den Ordner bspw. html samt dem Inhalt im Template-Ordner zu Speichern -->
    <folder>html</folder>
    <folder>css</folder>
    <folder>images</folder>
    <folder>language</folder>
    <folder>js</folder>
    <!-- MUSS, die Hauptdatei für die Ausgabe des Templates -->
    <filename>index.php</filename>
    <!-- MUSS, jeder Ordner in Joomla ist mit einer Dummy-Html ausgestattet, so werden Server Fehlermeldungen verhindert, falls sich doch ein Webseitenbesucher in ein Verzeichnis verirrt -->
    <filename>index.html</filename>
    <!-- SOLLTE, das Browser-Tab icon macht sich immer gut -->
    <filename>favicon.ico</filename>
    <!-- MUSS, diese Datei muss natürlich mit installiert werden -->
    <filename>templateDetails.xml</filename>
    <!--SOLLTE, im Joomla Backend in der Template-Verwaltung wird dieses Bild vom Layout angezeigt. Am besten einen Screenshot der Webseiten Vorlage einfügen oder wenn die Seite fertig ist ein Browser-Screeensho -->
    <filename>template_thumbnail.png</filename>
    <!-- SOLLTE, in dieser Datei kann eine individuelle Fehlerseite erstellt werden (404) -->
    <filename>error.php</filename>
  </files>
  <!-- MUSS, das sind letztendlich die Positionen an die die Module geschickt werden-->
  <positions>
    <position>meine-topposition</position>
    <position>linke-position</position>
    <position>brotkrumen</position>
    <position>zu-guter-letzt</position>
    <position>so-soll-die-positon-heissen</position>
    <position>neuigkeiten</position>
    <!-- <position>ich-kann-später-noch-weitere-positionen-einfügen</position> --> 
  </positions>
  <!--Sollte, Sollten unterschiedliche Sprachen genutzt werden, ist hier der richtige Platz um diese zu installieren-->
  <languages folder="language">
  	<language tag="de-DE">de-DE/de-DE.tpl_test_template.sys.ini</language>
  	<language tag="de-DE">de-DE/de-DE.tpl_test_template.ini</language>
  	<language tag="de-DE">en-GB/en-GB.tpl_test_template.sys.ini</language>
  	<language tag="de-DE">en-GB/en-GB.tpl_test_template.ini</language>
  </languages>
  <!-- Parameter Block start -->
  <config>
    <fields name="params">
      <fieldset name="advanced">
      <field name="unser_header_bild"
					type="media" 
					default=""
					label="TPL_TEST_TEMPLATE_FIELD_UNSER_HEADER_BILD_LABEL"
					description="TPL_TEST_TEMPLATE_FIELD_UNSER_HEADER_BILD_DESC"
					filter="string" 
					/>
      </fieldset>
    </fields>
  </config>
  <!-- Parameter Block ende --> 
</extension>

 

der Kopfteil

Diese vielen Kommentare benötigen wir nur für diese Tutorial, sie können später ganz entfernt werden. Zu einem ordentlichen Template sollten die Tags von bis <name> bis </version> mit den persönlichen Daten gefüllt werden. Dieser Teil gehört zu "good practice".

 

der Installationsteil

Dann zu den Ordnern <files> plural

  • html hier kommen die Template-Overrides hinein
  • css klar hier kommen die css-Dateien hinein, auch die für den IE
  • images die Bilder und Sprites, die wir ausschließlich für dieses Template benötigen
  • language der Sprachordner für diese Template
  • js wer Javascript verwendet sollte die .js Dateien hier einfügen

Bitte immer eine "leere" index.html in die Ordner einfügen auch wenn beispielsweise keine .js Datei sich im Ordner /js befindet.

Die einzelnen Dateien, die sich direkt in diesem Template-Ordner befinden, werden mit öffnendem und schließendem <filename> ... </filename> bezeichnet.

Im Gegensatz zum <folder>, in den man eine beliebige Anzahl von Dateien packen kann, müssen bei <filename> die Dateien auch wirklich existieren. Andernfalls würde Joomla dies bei der Installation mit einer Fehlermeldung "Datei konnte nicht gefunden werden" quittieren.

 

der Template-Positionsteil

Den eigentlichen Installationsbereich in der templateDetails.xml haben wir soweit abgeschlossen und das Template ist installierbar. Wir haben allerdings die Geschichte mit den <positions> nicht geklärt. Dazu komme ich ein wenig später.

 

Update von Vorgängerversionen

Wie sich oben anhand der gesamten templateDetails.xml schon erahnen lässt, sind die Änderungen der templateDetails.xml sehr gering.

Seit Joomla 1.6 ist der Installer für die nachfolgenden Versionen bis einschließlich Joomla 3.0 universell.

Joomla 1.6 bis Joomla 3.0

<extension> ... <extension>
Ausserdem wird neben der Version und dem Typ nun auch der Client abgefragt.

Joomla 1.6 bis Joomla 3.0

<extension
	version="1.6"
    type="template"
    client="site" >
Parameter wurden bis Joomla 1.5 noch als Params Beschrieben. Dies gehört seit Joomla 1.6 der Vergangenheit an.

Joomla 1.6 bis Joomla 3.0

  <!-- Parameter Block start -->
  <config>
    <fields name="params">
      <fieldset name="advanced">
      <field name="unser_header_bild"
					type="media" 
					default=""
					label="TPL_TEST_TEMPLATE_FIELD_UNSER_HEADER_BILD_LABEL"
					description="TPL_TEST_TEMPLATE_FIELD_UNSER_HEADER_BILD_DESC"
					filter="string" 
					/>
      </fieldset>
    </fields>
  </config>
  <!-- Parameter Block ende --> 
Letzte Änderung am Montag, 23 September 2013 13:48