Archived

Difference between revisions of "Upgrading a Joomla 1.5 template to Joomla 2.5"

From Joomla! Documentation

(Added the Discovery section.)
(→‎Template Manifest File: Added note about closing tag.)
Line 28: Line 28:
  
 
== Template Manifest File ==
 
== Template Manifest File ==
Two other important changes to the templateDetails.xml file include:
+
There are important changes to the ''templateDetails.xml'' file:
# adding the new 1.6 Doctype
+
# Add the new 1.6 Doctype
# changing the <install> tag to <extension> as shown below.
+
# Change the ''<install>'' tag to ''<extension>'' as shown below.
 
<pre>
 
<pre>
 
<?xml version="1.0" encoding="utf-8"?>
 
<?xml version="1.0" encoding="utf-8"?>
Line 37: Line 37:
 
</pre>
 
</pre>
 
Notice the additional new ''client'' attribute which is set to ''site'' for a front-facing template and ''administrator'' for an back-end template.
 
Notice the additional new ''client'' attribute which is set to ''site'' for a front-facing template and ''administrator'' for an back-end template.
 +
 +
Be sure to change the closing tag from ''</install>'' to ''</extension>''.
  
 
== Objects and Methods ==
 
== Objects and Methods ==

Revision as of 19:12, 2 March 2012

This page has been archived. This page contains information for an unsupported Joomla! version or is no longer relevant. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

This page provides feedback on the process of upgrading or converting a Joomla 1.5 template for use with Joomla 1.6 and later versions from those who have already attempted it. This is intended to be a living document that can be added to as more experience is gained and is likely to be reorganised periodically. If you have encountered a problem when upgrading a template, or if you have any information that you think will help smooth the way for others who will follow then please add your comments initially on the Talk page. We will then collate the information and incorporate it into this page.

Chris Davenport prepared slides for a presentation at the JoomlaDay UK 2010 event which explain the changes in templates for Joomla! 1.6.

Template Parameters[edit]

In Joomla! 1.5, 1.6 and later versions, the template parameters are defined in templateDetails.xml.

Whereas in 1.5 parameters are defined as part of the <params> section, and each parameter is defined as a <param>, in 1.6 and later template parameters are contained in the <config> section and treated as a <field> nested within the <fieldset> and <fields> tags, as illustrated below.

<config>
    <fields name="params">
        <fieldset name="basic">
            <field name="" type=" default="" label="" description="">
                <option value="1">On</option>
                <option value="0">Off</option>
            </field>
            <field name="" type="" default="" label="e" description="" />
        </fieldset>
    </fields>
</config>

<fieldset name="basic"> wraps the parameters in a grouping element. Using name="basic" labels that element as "Basic Options" and name="advanced" labels it as "Advanced Options".

The name, type, default, label and description attributes still apply.

Template Manifest File[edit]

There are important changes to the templateDetails.xml file:

  1. Add the new 1.6 Doctype
  2. Change the <install> tag to <extension> as shown below.
<?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">
<extension version="1.7" type="template" client="site">

Notice the additional new client attribute which is set to site for a front-facing template and administrator for an back-end template.

Be sure to change the closing tag from </install> to </extension>.

Objects and Methods[edit]

Sitename[edit]

  • <?php echo $mainframe->getCfg('sitename');?> is now $app->getCfg('sitename'); Where $app = JFactory::getApplication();

Error Codes[edit]

  • $this->error->code is replaced by $this->error->getCode();
  • $this->error->message is replaced by $this->error->getMessage();

Discovery[edit]

In some cases your converted template may not be shown in the Template Manager even though all coding appears to be correct. Verify that your template files are installed in the /templates directory. Then run the Discover process as follows.

  1. Go to Administrator > Extensions > Extension Manager > Discover
  2. Click the Discover icon.
  3. If your template appears on the list, select it and then click the Install icon.

Layout Overrides[edit]

com_content[edit]

If you have used the Beez overrides, or code derived from the Beez overrides, in your 1.5 template, you may encounter a JHtml::icon not supported. File not found. error when migrating the template to Joomla 1.6 and later. To fix this, simply add the following statement near the top of the template html/com_content/article/default.php file:

JHtml::addIncludePath( JPATH_COMPONENT . '/helpers' );