Actions

Difference between revisions of "What is the typical template directory structure?"

From Joomla! Documentation

m (Added info about the file component.php)
m (formatting)
(One intermediate revision by one user not shown)
Line 1: Line 1:
 
===Typical Template Directory Structure===
 
===Typical Template Directory Structure===
It is most common for a template to have at the following files:
+
It is most common for a template to have at least the following files:
* index.php
+
* '''index.php'''
 
: Provides the logic for the display and positioning of modules and components.
 
: Provides the logic for the display and positioning of modules and components.
* component.php
+
* '''component.php'''
 
: Provides the logic for the display of the printer friendly page, "E-mail this link to a friend." etc.
 
: Provides the logic for the display of the printer friendly page, "E-mail this link to a friend." etc.
* template.css
+
* '''template.css'''
 
: Handles the presentational aspects of the template including specifications for margins, fonts, headings, image borders, list formatting, etc.
 
: Handles the presentational aspects of the template including specifications for margins, fonts, headings, image borders, list formatting, etc.
* templateDetails.xml
+
* '''templateDetails.xml'''
: Holds meta-information related to the template and used by the Installer and the Template Manager.
+
: Holds meta-information related to the template and is used by the Installer and the Template Manager.
* template_thumbnail.ext - replace .ext with the extension format of the image (.jpg, .png, .gif)
+
* '''template_thumbnail.ext''' - replace .ext with the extension format of the image (.jpg, .png, .gif)
 
: Generally a 200x150 pixel image that is shown when the cursor is held over the template name in the Template Manager.  This gives the Administrator a snapshot view of the template before applying it to the Site.
 
: Generally a 200x150 pixel image that is shown when the cursor is held over the template name in the Template Manager.  This gives the Administrator a snapshot view of the template before applying it to the Site.
  

Revision as of 00:36, 4 September 2009

Typical Template Directory Structure

It is most common for a template to have at least the following files:

  • index.php
Provides the logic for the display and positioning of modules and components.
  • component.php
Provides the logic for the display of the printer friendly page, "E-mail this link to a friend." etc.
  • template.css
Handles the presentational aspects of the template including specifications for margins, fonts, headings, image borders, list formatting, etc.
  • templateDetails.xml
Holds meta-information related to the template and is used by the Installer and the Template Manager.
  • template_thumbnail.ext - replace .ext with the extension format of the image (.jpg, .png, .gif)
Generally a 200x150 pixel image that is shown when the cursor is held over the template name in the Template Manager. This gives the Administrator a snapshot view of the template before applying it to the Site.


A typical template for Joomla! will include the following directories:

  • css - contains all the .css files
  • html - contains template override files for core output and module chrome
  • images - contains all images used by the template
  • language - contains additional language files used by the template

Depending on the complexity and design of the template is may also contain:

  • javascript - contains supporting JavaScript used by the template for added functionality

Example structure with files

Typical path of a template is <root>/public_html/domain-name/template/<name of your template> which will contain the following directories and files based on your template.

/css
/html
/images
/javascript
/language
component.php
error.php
favicon.ico
index.php
templateDetails.xml
template_preview.png
template_thumbnail.png