Difference between revisions of "Creating a basic templateDetails.xml file"

From Joomla! Documentation

m (Fix the CSS filename. Should be style.css to match the instructions in the Template Tutorial)
m (Added the file component.php)
Line 18: Line 18:
 
<files>
 
<files>
 
<filename>index.php</filename>
 
<filename>index.php</filename>
 +
<filename>component.php</filename>
 
<filename>templateDetails.xml</filename>
 
<filename>templateDetails.xml</filename>
 
<filename>template_thumbnail.png</filename>
 
<filename>template_thumbnail.png</filename>

Revision as of 04:34, 4 May 2009

The templateDetails.xml file is essential. Without it, your template won't be seen by Joomla!. The file holds key "metadata" about the template.

Lets look at an example:

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE install PUBLIC "-//Joomla! 1.5//DTD template 1.0//EN"
 "http://dev.joomla.org/xml/1.5/template-install.dtd">
<install version="1.5" type="template">
	<name>mynewtemplate</name>
	<creationDate>2008-05-01</creationDate>
	<author>John Doe</author>
	<authorEmail>john@example.com</authorEmail>
	<authorUrl>http://www.example.com</authorUrl>
	<copyright>John Doe 2008</copyright>
	<license>GNU/GPL</license>
	<version>1.0.2</version>
	<description>My New Template</description>
	<files>
		<filename>index.php</filename>
		<filename>component.php</filename>
		<filename>templateDetails.xml</filename>
		<filename>template_thumbnail.png</filename>
		<filename>images/background.png</filename>
		<filename>css/style.css</filename>
	</files>
	<positions>
		<position>breadcrumb</position>
		<position>left</position>
		<position>right</position>
		<position>top</position>
		<position>user1</position>
		<position>user2</position>
		<position>user3</position>
		<position>user4</position>
		<position>footer</position>
	</positions>
</install>

So, as you can see, we have a set of information between markup tags ( the <thing> ). Your best approach is to cut and paste this into your "templateDetails.xml" file and change the relevant bits (such as <name> <author> ).

The <files> part should contain all the files that you use - you possibly don't know what they are called yet - don't worry update it later.

Leave the positions as they are - these are a common set so you will be able to switch easily from the standard templates.