J1.5:Creating custom template parameter types

This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Custom XML Parameter Type

XML parameter types allow the user to modify or change certain parts of a template, plugin, module, or component without having to edit any code - as long as these parameters are implemented by the developer of the Joomla! extension.

The XML File

Within every Joomla! extension, there is an XML file used for installation purposes. This file lists all the contents of the package, as well as various items used in the Joomla! extension.

Editing the XML File

The XML file will have contents which look similar to this (except filled with the extension's details):

<?xml version="1.0" encoding="utf-8"?>
<install type="module" version="1.5.0">
	<name></name>
	<author></author>
	<creationDate></creationDate>
	<copyright></copyright>
	<license></license>
	<authorEmail></authorEmail>
	<authorUrl></authorUrl>
	<version></version>
	<description></description>
	<files>
		<filename module="mod_blog_calendar"></filename>
	</files>
	<languages>
                <language></language>
	</languages>
	<params>
	</params>
</install>

Find the <params> tag first. This will be the focus of XML parameters in Joomla!.

Adding Parameters

After finding the <params> tag, place an opening (<param>) and closing (</param>) tag for the parameter.

After placing the opening and closing tags, choose whether you want one of the following types of parameters:

• List Parameters (parameters are changed in a drop down list)
• Radio Parameters (parameters are changed a check-box style input)
• Text Parameters (parameters are changed through direct text input)

List Parameters

List parameters are changed through a drop-down style list. List parameters are useful when there are multiple options or selections available to the end user of a Joomla! extension. To implement List parameters, use the following code in between the <params> and </params> tags:

<param name="Enter the name of the parameter here" type="list" default="Set the default value for the parameter here" label="Label the parameter here" description="Put a description of the parameter here">

To add selectable items for the parameter list,