Tutorial: Vaststelling van een parameter in templateDetails.xml

Afdrukken PDF
Geschreven door Remco op vrijdag 09 januari 2009 23:00, in: Templates (1.5.x)

Defineer een parameter in templateDetails.xml

Het templateDetails.xml bestand dient altijd in de root map van de template te staan. Zoals bijvoorbeeld, voor het Beez template zal het volledige pad lijken op: [pad-naar--Joomla]/templates/beez/templateDetails.xml

Let op het hoofdletter gebruik op een hoofdletter-gevoelig systeem zoals Linux. U kunt gebruik maken van een standaard tekst-editor (geen word processor) of een XML-editor om dit bestand te wijzigen

Zoek het

element, meestal tegen het einde van het bestand, op. Als er geen element is moet u er een toevoegen. Dit dient onmiddellijk onder het element in het XML-element hiërarchie te staan. Vergeet niet om het element met een -tag af te sluiten.

Merk op dat vanaf Joomla 1.6 de tag is vervallen ten gunste van .

  • Zie Een basis templateDetails.xml bestand voor een introductie voor het maken van een templateDetails.xml vanaf niets.
  • Zie Specificatie van templateDetails.xml voor een gedetailleerde specificatie van dit bestand.

Voor elke parameter die u wilt definiëren, voegt u een

element toe. Dit element heeft een aantal verplichte en optionele argumenten die afhangen van het soort argument. De enige echt verplicht argument is het type, maar naam, standaard, omschrijving en label zijn de meeste gebruikte bij een parameter en de naam is verplicht wanneer zij zich voordoet. Deze verplichte/gebruikelijke argumenten zijn:
  • type specificeert het type van HTML-formulier controle gebruikt in de Template Parameters scherm in de Administrator backend, om de gebruiker de waarde van de parameter te laten veranderen.
  • naam is de unieke naam van de parameter. U zult naar deze naam verwijzen bij het ophalen van de parameter waarde in de template code.
De volgende argumenten zijn optioneel, maar gebruikelijk voor bijna alle parameter types:
  • Standaard is de standaard waarde van de parameter.
  • Beschrijving is tekst die wordt weergegeven als een tooltip voor het veld in het Template Parameters scherm in de Administrator. Dit is een vertaalbare string.
  • Label is de beschrijvende titel van het veld dat wordt getoond aan de gebruiker in het Template Parameters scherm in de Administrator. Dit is een vertaalbare string. Als het label argument wordt weggelaten wordt deze standaard ingesteld op de waarde die wordt gegeven door het naam argument.
De optionele argumenten hangen af van het parameter type. Elk van de parameter type wordt in detail beschreven in de standaardversie parameter types. Voor een ontwikkelaar is het ook mogelijk om uw eigen aangepaste parameter types te gebruiken

Bijvoorbeeld, in het volgende uitreksel is een sectie gedefiniëerd van twee parameters: een voor een drop-down lijst van template kleurvariaties, de andere voor een radio-knop waarmee de gebruiker een auteur copyright bericht kan tonen of verbergen.

<params>
<param name="templateColour" type="list" default="blue"
label="Templatekleur" description="Kies de templatekleur.">
<option value="blue">Blauw</option>
<option value="red">Rood</option>
<option value="green">Groen</option>
<option value="black">Zwart</option>
</param>
<param name="authorCopyright" type="radio" default="1"
label="Auteursrecht" description="Toon/verberg auteursrecht.">
<option value="0">Toon</option>
<option value="1">Verberg</option>
</param>
</params>

De Template Parameters van dit voorbeeld zien er dan als volgt uit:

Merk op dat Groeps Parameter op dit moment niet ondersteund worden.